diff options
Diffstat (limited to 'lib/enca/devel-docs/tmpl')
| -rw-r--r-- | lib/enca/devel-docs/tmpl/analyser.sgml | 291 | ||||
| -rw-r--r-- | lib/enca/devel-docs/tmpl/auxiliary.sgml | 83 | ||||
| -rw-r--r-- | lib/enca/devel-docs/tmpl/encodings.sgml | 156 | ||||
| -rw-r--r-- | lib/enca/devel-docs/tmpl/enums.sgml | 102 | ||||
| -rw-r--r-- | lib/enca/devel-docs/tmpl/internal.sgml | 533 | ||||
| -rw-r--r-- | lib/enca/devel-docs/tmpl/libenca-unused.sgml | 104 |
6 files changed, 0 insertions, 1269 deletions
diff --git a/lib/enca/devel-docs/tmpl/analyser.sgml b/lib/enca/devel-docs/tmpl/analyser.sgml deleted file mode 100644 index 44f6460502..0000000000 --- a/lib/enca/devel-docs/tmpl/analyser.sgml +++ /dev/null @@ -1,291 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Analyser - -<!-- ##### SECTION Short_Description ##### --> - -Basic analyser interface. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Basically you want to allocate an analyser with enca_analyser_alloc() for some -language, use enca_analyse() (or enca_analyse_const()) on a buffer to find its -encoding, and interpret the results with something like enca_charset_name(). -The analyser then can be used for another buffer. Once you no longer need -it, call enca_analyser_free() to release it. -</para> - -<para> -A single working example is better than a hundred pages of reference manual. -</para> - -<example> -<title>A minimal Enca library application – Czech encoding -detector.</title> -<programlisting> -#include <stdio.h> -#include <enca.h> - -int -main(void) -{ - EncaAnalyser analyser; - EncaEncoding encoding; - unsigned char buffer[4096]; - size_t buflen; - - buflen = fread(buffer, 1, 4096, stdin); - analyser = enca_analyser_alloc("cs"); - encoding = enca_analyse(analyser, buffer, buflen); - printf("Charset: %%s\n", enca_charset_name(encoding.charset, - ENCA_NAME_STYLE_HUMAN)); - enca_analyser_free(analyser); - - return 0; -} -</programlisting> -</example> - -<para> -The analyser has plenty of options, but generally you don't need to fiddle -with them, except enca_set_termination_strictness(). -</para> - -<para> -All names prefixed with <function>ENCA_</function>, -<function>Enca</function>, <function>_Enca</function>, -or <function>enca_</function> should be treated as reserved and not used for -application function/variable/type/macro names. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION enca_analyser_alloc ##### --> -<para> - -</para> - -@langname: -@Returns: - - -<!-- ##### FUNCTION enca_analyser_free ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_analyse ##### --> -<para> - -</para> - -@analyser: -@buffer: -@size: -@Returns: - - -<!-- ##### FUNCTION enca_analyse_const ##### --> -<para> - -</para> - -@analyser: -@buffer: -@size: -@Returns: - - -<!-- ##### FUNCTION enca_errno ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_strerror ##### --> -<para> - -</para> - -@analyser: -@errnum: -@Returns: - - -<!-- ##### FUNCTION enca_double_utf8_check ##### --> -<para> - -</para> - -@analyser: -@buffer: -@size: -@Returns: - - -<!-- ##### FUNCTION enca_double_utf8_get_candidates ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_multibyte ##### --> -<para> - -</para> - -@analyser: -@multibyte: - - -<!-- ##### FUNCTION enca_get_multibyte ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_interpreted_surfaces ##### --> -<para> - -</para> - -@analyser: -@interpreted_surfaces: - - -<!-- ##### FUNCTION enca_get_interpreted_surfaces ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_ambiguity ##### --> -<para> - -</para> - -@analyser: -@ambiguity: - - -<!-- ##### FUNCTION enca_get_ambiguity ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_filtering ##### --> -<para> - -</para> - -@analyser: -@filtering: - - -<!-- ##### FUNCTION enca_get_filtering ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_garbage_test ##### --> -<para> - -</para> - -@analyser: -@garabage_test: - - -<!-- ##### FUNCTION enca_get_garbage_test ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_termination_strictness ##### --> -<para> - -</para> - -@analyser: -@termination_strictness: - - -<!-- ##### FUNCTION enca_get_termination_strictness ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_significant ##### --> -<para> - -</para> - -@analyser: -@significant: -@Returns: - - -<!-- ##### FUNCTION enca_get_significant ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_set_threshold ##### --> -<para> - -</para> - -@analyser: -@threshold: -@Returns: - - -<!-- ##### FUNCTION enca_get_threshold ##### --> -<para> - -</para> - -@analyser: -@Returns: - - diff --git a/lib/enca/devel-docs/tmpl/auxiliary.sgml b/lib/enca/devel-docs/tmpl/auxiliary.sgml deleted file mode 100644 index 5145f5aa57..0000000000 --- a/lib/enca/devel-docs/tmpl/auxiliary.sgml +++ /dev/null @@ -1,83 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Auxiliary functions - -<!-- ##### SECTION Short_Description ##### --> -Variouis auxiliary functions and informations about libenca. - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION enca_charset_has_ucs2_map ##### --> -<para> - -</para> - -@charset: -@Returns: - - -<!-- ##### FUNCTION enca_charset_ucs2_map ##### --> -<para> - -</para> - -@charset: -@buffer: -@Returns: - - -<!-- ##### FUNCTION enca_number_of_charsets ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION enca_analyser_language ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### FUNCTION enca_get_languages ##### --> -<para> - -</para> - -@n: -@Returns: - - -<!-- ##### FUNCTION enca_language_english_name ##### --> -<para> - -</para> - -@lang: -@Returns: - - -<!-- ##### FUNCTION enca_get_language_charsets ##### --> -<para> - -</para> - -@langname: -@n: -@Returns: - - diff --git a/lib/enca/devel-docs/tmpl/encodings.sgml b/lib/enca/devel-docs/tmpl/encodings.sgml deleted file mode 100644 index 66e1b6d5c4..0000000000 --- a/lib/enca/devel-docs/tmpl/encodings.sgml +++ /dev/null @@ -1,156 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Charsets and Surfaces - -<!-- ##### SECTION Short_Description ##### --> -Functions and macros for getting something sensible from #EncaEncoding. - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION enca_charset_name ##### --> -<para> - -</para> - -@charset: -@whatname: -@Returns: - - -<!-- ##### FUNCTION enca_get_charset_aliases ##### --> -<para> - -</para> - -@charset: -@n: -@Returns: - - -<!-- ##### FUNCTION enca_get_surface_name ##### --> -<para> - -</para> - -@surface: -@whatname: -@Returns: - - -<!-- ##### FUNCTION enca_parse_encoding_name ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION enca_charset_natural_surface ##### --> -<para> - -</para> - -@charset: -@Returns: - - -<!-- ##### FUNCTION enca_charset_properties ##### --> -<para> - -</para> - -@charset: -@Returns: - - -<!-- ##### MACRO enca_charset_is_7bit ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_8bit ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_16bit ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_32bit ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_fixed ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_variable ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_binary ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_regular ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_multibyte ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### MACRO enca_charset_is_known ##### --> -<para> - -</para> - -@cs: - - diff --git a/lib/enca/devel-docs/tmpl/enums.sgml b/lib/enca/devel-docs/tmpl/enums.sgml deleted file mode 100644 index 42792ffe8c..0000000000 --- a/lib/enca/devel-docs/tmpl/enums.sgml +++ /dev/null @@ -1,102 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Typedefs and Constants - -<!-- ##### SECTION Short_Description ##### --> -Enca library typedefs, enums and constants. - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EncaEncoding ##### --> -<para> - -</para> - -@charset: -@surface: - -<!-- ##### MACRO ENCA_CS_UNKNOWN ##### --> -<para> - -</para> - - - -<!-- ##### ENUM EncaSurface ##### --> -<para> - -</para> - -@ENCA_SURFACE_EOL_CR: -@ENCA_SURFACE_EOL_LF: -@ENCA_SURFACE_EOL_CRLF: -@ENCA_SURFACE_EOL_MIX: -@ENCA_SURFACE_EOL_BIN: -@ENCA_SURFACE_MASK_EOL: -@ENCA_SURFACE_PERM_21: -@ENCA_SURFACE_PERM_4321: -@ENCA_SURFACE_PERM_MIX: -@ENCA_SURFACE_MASK_PERM: -@ENCA_SURFACE_QP: -@ENCA_SURFACE_REMOVE: -@ENCA_SURFACE_UNKNOWN: -@ENCA_SURFACE_MASK_ALL: - -<!-- ##### ENUM EncaCharsetFlags ##### --> -<para> - -</para> - -@ENCA_CHARSET_7BIT: -@ENCA_CHARSET_8BIT: -@ENCA_CHARSET_16BIT: -@ENCA_CHARSET_32BIT: -@ENCA_CHARSET_FIXED: -@ENCA_CHARSET_VARIABLE: -@ENCA_CHARSET_BINARY: -@ENCA_CHARSET_REGULAR: -@ENCA_CHARSET_MULTIBYTE: - -<!-- ##### ENUM EncaNameStyle ##### --> -<para> - -</para> - -@ENCA_NAME_STYLE_ENCA: -@ENCA_NAME_STYLE_RFC1345: -@ENCA_NAME_STYLE_CSTOCS: -@ENCA_NAME_STYLE_ICONV: -@ENCA_NAME_STYLE_HUMAN: -@ENCA_NAME_STYLE_MIME: - -<!-- ##### ENUM EncaErrno ##### --> -<para> - -</para> - -@ENCA_EOK: -@ENCA_EINVALUE: -@ENCA_EEMPTY: -@ENCA_EFILTERED: -@ENCA_ENOCS8: -@ENCA_ESIGNIF: -@ENCA_EWINNER: -@ENCA_EGARBAGE: - -<!-- ##### MACRO ENCA_NOT_A_CHAR ##### --> -<para> - -</para> - - - diff --git a/lib/enca/devel-docs/tmpl/internal.sgml b/lib/enca/devel-docs/tmpl/internal.sgml deleted file mode 100644 index d83abc824b..0000000000 --- a/lib/enca/devel-docs/tmpl/internal.sgml +++ /dev/null @@ -1,533 +0,0 @@ -<!-- ##### SECTION Title ##### --> -internal - -<!-- ##### SECTION Short_Description ##### --> - -<para> -internal functions -</para> - -<!-- ##### SECTION Long_Description ##### --> -<para> -Do not use outside Enca library. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EncaAnalyserOptions ##### --> -<para> - -</para> - -@const_buffer: -@min_chars: -@threshold: -@multibyte_enabled: -@interpreted_surfaces: -@ambiguous_mode: -@filtering: -@test_garbageness: -@termination_strictness: - -<!-- ##### STRUCT EncaAnalyserState ##### --> -<para> - -</para> - -@lang: -@ncharsets: -@charsets: -@gerrno: -@size: -@buffer: -@result: -@counts: -@bin: -@up: -@ratings: -@order: -@size2: -@buffer2: -@utfch: -@utfbuf: -@pair2bits: -@bitcounts: -@pairratings: -@lcbits: -@ucbits: -@options: - -<!-- ##### STRUCT EncaCharsetInfo ##### --> -<para> - -</para> - -@enca: -@rfc1345: -@cstocs: -@iconv: -@mime: -@human: -@flags: -@nsurface: - -<!-- ##### STRUCT EncaLanguageInfo ##### --> -<para> - -</para> - -@name: -@humanname: -@ncharsets: -@csnames: -@weight_sum: -@hook: -@eolhook: -@lcuchook: -@ratinghook: - -<!-- ##### STRUCT EncaLanguageHookData1CS ##### --> -<para> - -</para> - -@name: -@size: -@cs: - -<!-- ##### STRUCT EncaLanguageHookDataEOL ##### --> -<para> - -</para> - -@name: -@eol: -@cs: - -<!-- ##### USER_FUNCTION EncaHookFunc ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### USER_FUNCTION EncaGuessFunc ##### --> -<para> - -</para> - -@analyser: -@Returns: - - -<!-- ##### STRUCT EncaUTFCheckData ##### --> -<para> - -</para> - -@rating: -@size: -@result: -@ucs2: -@weights: - -<!-- ##### MACRO ELEMENTS ##### --> -<para> - -</para> - -@array: -@Returns: - - -<!-- ##### MACRO MAKE_HOOK_LINE ##### --> -<para> - -</para> - -@name: - - -<!-- ##### MACRO EPSILON ##### --> -<para> - -</para> - - - -<!-- ##### MACRO FILL_NONLETTER ##### --> -<para> - -</para> - - - -<!-- ##### MACRO LF ##### --> -<para> - -</para> - - - -<!-- ##### MACRO CR ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION enca_malloc ##### --> -<para> - -</para> - -@size: -@Returns: - - -<!-- ##### FUNCTION enca_realloc ##### --> -<para> - -</para> - -@ptr: -@size: -@Returns: - - -<!-- ##### MACRO enca_free ##### --> -<para> - -</para> - -@ptr: - - -<!-- ##### MACRO NEW ##### --> -<para> - -</para> - -@type: -@n: -@Returns: - - -<!-- ##### MACRO RENEW ##### --> -<para> - -</para> - -@ptr: -@type: -@n: -@Returns: - - -<!-- ##### FUNCTION enca_strdup ##### --> -<para> - -</para> - -@s: -@Returns: - - -<!-- ##### FUNCTION enca_strstr ##### --> -<para> - -</para> - -@haystack: -@needle: -@Returns: - - -<!-- ##### FUNCTION enca_stpcpy ##### --> -<para> - -</para> - -@dest: -@src: -@Returns: - - -<!-- ##### FUNCTION enca_strconcat ##### --> -<para> - -</para> - -@str: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION enca_strappend ##### --> -<para> - -</para> - -@str: -@Varargs: -@Returns: - - -<!-- ##### MACRO enca_csname ##### --> -<para> - -</para> - -@cs: - - -<!-- ##### FUNCTION enca_name_to_charset ##### --> -<para> - -</para> - -@csname: -@Returns: - - -<!-- ##### FUNCTION enca_name_to_surface ##### --> -<para> - -</para> - -@sname: -@Returns: - - -<!-- ##### FUNCTION enca_language_init ##### --> -<para> - -</para> - -@analyser: -@langname: -@Returns: - - -<!-- ##### FUNCTION enca_language_destroy ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_get_charset_similarity_matrix ##### --> -<para> - -</para> - -@lang: -@Returns: - - -<!-- ##### FUNCTION enca_charsets_subset_identical ##### --> -<para> - -</para> - -@charset1: -@charset2: -@counts: -@Returns: - - -<!-- ##### FUNCTION enca_filter_boxdraw ##### --> -<para> - -</para> - -@analyser: -@fill_char: -@Returns: - - -<!-- ##### FUNCTION enca_language_hook_ncs ##### --> -<para> - -</para> - -@analyser: -@ncs: -@hookdata: -@Returns: - - -<!-- ##### FUNCTION enca_language_hook_eol ##### --> -<para> - -</para> - -@analyser: -@ncs: -@hookdata: -@Returns: - - -<!-- ##### FUNCTION enca_guess_init ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_guess_destroy ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_eol_surface ##### --> -<para> - -</para> - -@buffer: -@size: -@counts: -@Returns: - - -<!-- ##### FUNCTION enca_find_max_sec ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### VARIABLE ENCA_LANGUAGE_BE ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_BG ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_CS ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_ET ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_HR ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_HU ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_LT ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_LV ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_PL ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_RU ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_SK ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_SL ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE ENCA_LANGUAGE_UK ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION enca_double_utf8_init ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_double_utf8_destroy ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_pair_init ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_pair_destroy ##### --> -<para> - -</para> - -@analyser: - - -<!-- ##### FUNCTION enca_pair_analyse ##### --> -<para> - -</para> - -@analyser: -@Returns: - - diff --git a/lib/enca/devel-docs/tmpl/libenca-unused.sgml b/lib/enca/devel-docs/tmpl/libenca-unused.sgml deleted file mode 100644 index 04dd25de7f..0000000000 --- a/lib/enca/devel-docs/tmpl/libenca-unused.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!-- ##### SECTION ./tmpl/enca.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/enca.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/enca.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/enca.sgml:Title ##### --> -enca - - -<!-- ##### SECTION ./tmpl/libenca.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/libenca.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/libenca.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/libenca.sgml:Title ##### --> -libenca - - -<!-- ##### MACRO BEGIN_C_DECLS ##### --> -<para> - -</para> - - -<!-- ##### MACRO ENCA_STMT_END ##### --> -<para> - -</para> - - -<!-- ##### MACRO ENCA_STMT_START ##### --> -<para> - -</para> - - -<!-- ##### MACRO END_C_DECLS ##### --> -<para> - -</para> - - -<!-- ##### STRUCT EncaLanguageHookData2CS ##### --> -<para> - -</para> - -@size: -@name1: -@name2: -@id1: -@id2: -@list1: -@list2: - -<!-- ##### FUNCTION enca_analyser_langage ##### --> -<para> - -</para> - -@analyser: -@Returns: - -<!-- ##### FUNCTION enca_language_hook_2cs ##### --> -<para> - -</para> - -@analyser: -@hookdata: -@Returns: - -<!-- ##### FUNCTION enca_language_hook_discard ##### --> -<para> - -</para> - -@analyser: -@csname: -@csid: -@Returns: - |