diff options
author | Bernd Kuhls <bernd.kuhls@t-online.de> | 2015-03-23 18:34:30 +0100 |
---|---|---|
committer | Bernd Kuhls <bernd.kuhls@t-online.de> | 2015-03-23 18:34:30 +0100 |
commit | 8b0c8720e8ce08c9362e4eae570411d64c7e80a1 (patch) | |
tree | 83e9bc08534d9578e3dfe4fb24a3bddb642be118 /lib/enca/devel-docs | |
parent | 264773be9ef0966ab2f060a2a7b17f057ea3c734 (diff) |
Remove lib/enca/
Second try to remove lib/enca/, let´s test whether
project/VS2010Express/XBMC for Windows.sln really needs libenca ;)
Forum thread for discussion
http://forum.kodi.tv/showthread.php?tid=221837
Diffstat (limited to 'lib/enca/devel-docs')
41 files changed, 0 insertions, 8768 deletions
diff --git a/lib/enca/devel-docs/Makefile.am b/lib/enca/devel-docs/Makefile.am deleted file mode 100644 index 51c90b43a4..0000000000 --- a/lib/enca/devel-docs/Makefile.am +++ /dev/null @@ -1,206 +0,0 @@ -# @(#) $Id: Makefile.am,v 1.8 2004/05/27 17:17:15 yeti Exp $ -## Process this file with automake to produce Makefile.in - -# This is a blank Makefile.am for using gtk-doc. -# Copy this to your project's API docs directory and modify the variables to -# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples -# of using the various options. - -# The name of the module, e.g. 'glib'. -DOC_MODULE = libenca - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR = ${top_srcdir}/lib - -# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj. -SCANOBJ_OPTIONS = - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS = - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS = - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS = - -# Used for dependencies. -HFILE_GLOB = $(DOC_SOURCE_DIR)/*.h -CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c - -# Header files to ignore when scanning. -IGNORE_HFILES = - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS = -GTKDOC_LIBS = - -GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in the -# $(DOC_MODULE)-overrides.txt file and uncomment the second line here. -DOC_OVERRIDES = -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt - - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals \ - $(DOC_MODULE).prerequisites \ - $(DOC_MODULE).intefraces - -if ENABLE_GTK_DOC -docs: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj $(SCANOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building XML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml $(MKDB_OPTIONS) - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \ - $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp $(DESTDIR)$(TARGET_DIR); \ - fi) - -uninstall-local: - (installfiles=`cd $(srcdir)/html >/dev/null && echo *.html`; \ - if test "$$installfiles" = '*.html'; \ - then echo '-- Nothing to uninstall' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Removing '$$i ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$$i; \ - done; \ - echo '-- Removing index.sgml' ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \ - echo '-- Removing $(DOC_MODULE).devhelp' ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp; \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/xml - mkdir $(distdir)/html - cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - cp $(srcdir)/xml/*.xml $(distdir)/xml - cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/$(DOC_MODULE).devhelp $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : dist-hook-local diff --git a/lib/enca/devel-docs/Makefile.in b/lib/enca/devel-docs/Makefile.in deleted file mode 100644 index 4ab03e877b..0000000000 --- a/lib/enca/devel-docs/Makefile.in +++ /dev/null @@ -1,574 +0,0 @@ -# Makefile.in generated by automake 1.11 from Makefile.am. -# @configure_input@ - -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. -# This Makefile.in is free software; the Free Software Foundation -# gives unlimited permission to copy and/or distribute it, -# with or without modifications, as long as this notice is preserved. - -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY, to the extent permitted by law; without -# even the implied warranty of MERCHANTABILITY or FITNESS FOR A -# PARTICULAR PURPOSE. - -@SET_MAKE@ - -# @(#) $Id: Makefile.am,v 1.8 2004/05/27 17:17:15 yeti Exp $ - -# This is a blank Makefile.am for using gtk-doc. -# Copy this to your project's API docs directory and modify the variables to -# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples -# of using the various options. -VPATH = @srcdir@ -pkgdatadir = $(datadir)/@PACKAGE@ -pkgincludedir = $(includedir)/@PACKAGE@ -pkglibdir = $(libdir)/@PACKAGE@ -pkglibexecdir = $(libexecdir)/@PACKAGE@ -am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd -install_sh_DATA = $(install_sh) -c -m 644 -install_sh_PROGRAM = $(install_sh) -c -install_sh_SCRIPT = $(install_sh) -c -INSTALL_HEADER = $(INSTALL_DATA) -transform = $(program_transform_name) -NORMAL_INSTALL = : -PRE_INSTALL = : -POST_INSTALL = : -NORMAL_UNINSTALL = : -PRE_UNINSTALL = : -POST_UNINSTALL = : -build_triplet = @build@ -host_triplet = @host@ -subdir = devel-docs -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in -ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ - $(top_srcdir)/m4/libiconv.m4 $(top_srcdir)/m4/libm.m4 \ - $(top_srcdir)/m4/librecode.m4 $(top_srcdir)/m4/libtool.m4 \ - $(top_srcdir)/m4/localias.m4 $(top_srcdir)/m4/ltoptions.m4 \ - $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \ - $(top_srcdir)/m4/lt~obsolete.m4 $(top_srcdir)/m4/tools.m4 \ - $(top_srcdir)/m4/typevar.m4 $(top_srcdir)/configure.ac -am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ - $(ACLOCAL_M4) -mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs -CONFIG_HEADER = $(top_builddir)/config.h -CONFIG_CLEAN_FILES = -CONFIG_CLEAN_VPATH_FILES = -SOURCES = -DIST_SOURCES = -DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) -ACLOCAL = @ACLOCAL@ -AMTAR = @AMTAR@ -AR = @AR@ -AUTOCONF = @AUTOCONF@ -AUTOHEADER = @AUTOHEADER@ -AUTOMAKE = @AUTOMAKE@ -AWK = @AWK@ -CC = @CC@ -CCDEPMODE = @CCDEPMODE@ -CFLAGS = @CFLAGS@ -CONVERTER_LIBS = @CONVERTER_LIBS@ -CPP = @CPP@ -CPPFLAGS = @CPPFLAGS@ -CSTOCS_PROG = @CSTOCS_PROG@ -CYGPATH_W = @CYGPATH_W@ -DEFAULT_CONVERTER_LIST = @DEFAULT_CONVERTER_LIST@ -DEFAULT_EXTERNAL_CONVERTER = @DEFAULT_EXTERNAL_CONVERTER@ -DEFS = @DEFS@ -DEPDIR = @DEPDIR@ -DSYMUTIL = @DSYMUTIL@ -DUMPBIN = @DUMPBIN@ -ECHO_C = @ECHO_C@ -ECHO_N = @ECHO_N@ -ECHO_T = @ECHO_T@ -EGREP = @EGREP@ -EXEEXT = @EXEEXT@ -FGREP = @FGREP@ -GREP = @GREP@ -GTKDOC = @GTKDOC@ -HTML_DIR = @HTML_DIR@ -INSTALL = @INSTALL@ -INSTALL_DATA = @INSTALL_DATA@ -INSTALL_PROGRAM = @INSTALL_PROGRAM@ -INSTALL_SCRIPT = @INSTALL_SCRIPT@ -INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ -LD = @LD@ -LDFLAGS = @LDFLAGS@ -LIBICONV = @LIBICONV@ -LIBM = @LIBM@ -LIBOBJS = @LIBOBJS@ -LIBS = @LIBS@ -LIBTOOL = @LIBTOOL@ -LIPO = @LIPO@ -LN_S = @LN_S@ -LTLIBICONV = @LTLIBICONV@ -LTLIBOBJS = @LTLIBOBJS@ -MAINT = @MAINT@ -MAKEINFO = @MAKEINFO@ -MAP_PROG = @MAP_PROG@ -MKDIR_P = @MKDIR_P@ -MKTEMP_PROG = @MKTEMP_PROG@ -NM = @NM@ -NMEDIT = @NMEDIT@ -OBJDUMP = @OBJDUMP@ -OBJEXT = @OBJEXT@ -OTOOL = @OTOOL@ -OTOOL64 = @OTOOL64@ -PACKAGE = @PACKAGE@ -PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ -PACKAGE_NAME = @PACKAGE_NAME@ -PACKAGE_STRING = @PACKAGE_STRING@ -PACKAGE_TARNAME = @PACKAGE_TARNAME@ -PACKAGE_URL = @PACKAGE_URL@ -PACKAGE_VERSION = @PACKAGE_VERSION@ -PATH_SEPARATOR = @PATH_SEPARATOR@ -PICONV_PROG = @PICONV_PROG@ -RANLIB = @RANLIB@ -RECODE_PROG = @RECODE_PROG@ -RELEASE = @RELEASE@ -SED = @SED@ -SET_MAKE = @SET_MAKE@ -SHELL = @SHELL@ -SHELL_RANDOM_FILENAME = @SHELL_RANDOM_FILENAME@ -STRIP = @STRIP@ -UMAP_PROG = @UMAP_PROG@ -VERSION = @VERSION@ -abs_builddir = @abs_builddir@ -abs_srcdir = @abs_srcdir@ -abs_top_builddir = @abs_top_builddir@ -abs_top_srcdir = @abs_top_srcdir@ -ac_ct_CC = @ac_ct_CC@ -ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ -am__include = @am__include@ -am__leading_dot = @am__leading_dot@ -am__quote = @am__quote@ -am__tar = @am__tar@ -am__untar = @am__untar@ -bindir = @bindir@ -build = @build@ -build_alias = @build_alias@ -build_cpu = @build_cpu@ -build_os = @build_os@ -build_vendor = @build_vendor@ -builddir = @builddir@ -datadir = @datadir@ -datarootdir = @datarootdir@ -docdir = @docdir@ -dvidir = @dvidir@ -exec_prefix = @exec_prefix@ -host = @host@ -host_alias = @host_alias@ -host_cpu = @host_cpu@ -host_os = @host_os@ -host_vendor = @host_vendor@ -htmldir = @htmldir@ -includedir = @includedir@ -infodir = @infodir@ -install_sh = @install_sh@ -libdir = @libdir@ -libexecdir = @libexecdir@ -localedir = @localedir@ -localstatedir = @localstatedir@ -lt_ECHO = @lt_ECHO@ -mandir = @mandir@ -mkdir_p = @mkdir_p@ -oldincludedir = @oldincludedir@ -pdfdir = @pdfdir@ -prefix = @prefix@ -program_transform_name = @program_transform_name@ -psdir = @psdir@ -sbindir = @sbindir@ -sharedstatedir = @sharedstatedir@ -srcdir = @srcdir@ -sysconfdir = @sysconfdir@ -target_alias = @target_alias@ -top_build_prefix = @top_build_prefix@ -top_builddir = @top_builddir@ -top_srcdir = @top_srcdir@ - -# The name of the module, e.g. 'glib'. -DOC_MODULE = libenca - -# The top-level SGML file. Change it if you want. -DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml - -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR = ${top_srcdir}/lib - -# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj. -SCANOBJ_OPTIONS = - -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS = - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS = - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS = - -# Used for dependencies. -HFILE_GLOB = $(DOC_SOURCE_DIR)/*.h -CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c - -# Header files to ignore when scanning. -IGNORE_HFILES = - -# Images to copy into HTML directory. -HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). -content_files = - -# Other files to distribute. -extra_files = - -# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib -# contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS = -GTKDOC_LIBS = -GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) - -# If you need to override some of the declarations, place them in the -# $(DOC_MODULE)-overrides.txt file and uncomment the second line here. -DOC_OVERRIDES = -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### -TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE)-sections.txt \ - $(DOC_OVERRIDES) - -DOC_STAMPS = scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ - $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp - -SCANOBJ_FILES = \ - $(DOC_MODULE).args \ - $(DOC_MODULE).hierarchy \ - $(DOC_MODULE).signals \ - $(DOC_MODULE).prerequisites \ - $(DOC_MODULE).intefraces - -all: all-am - -.SUFFIXES: -$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) - @for dep in $?; do \ - case '$(am__configure_deps)' in \ - *$$dep*) \ - ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ - && { if test -f $@; then exit 0; else break; fi; }; \ - exit 1;; \ - esac; \ - done; \ - echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnits devel-docs/Makefile'; \ - $(am__cd) $(top_srcdir) && \ - $(AUTOMAKE) --gnits devel-docs/Makefile -.PRECIOUS: Makefile -Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status - @case '$?' in \ - *config.status*) \ - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ - *) \ - echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ - esac; - -$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh - -$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh -$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh -$(am__aclocal_m4_deps): - -mostlyclean-libtool: - -rm -f *.lo - -clean-libtool: - -rm -rf .libs _libs -tags: TAGS -TAGS: - -ctags: CTAGS -CTAGS: - - -distdir: $(DISTFILES) - @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ - topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ - list='$(DISTFILES)'; \ - dist_files=`for file in $$list; do echo $$file; done | \ - sed -e "s|^$$srcdirstrip/||;t" \ - -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ - case $$dist_files in \ - */*) $(MKDIR_P) `echo "$$dist_files" | \ - sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ - sort -u` ;; \ - esac; \ - for file in $$dist_files; do \ - if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ - if test -d $$d/$$file; then \ - dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ - if test -d "$(distdir)/$$file"; then \ - find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ - fi; \ - if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ - cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ - find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ - fi; \ - cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ - else \ - test -f "$(distdir)/$$file" \ - || cp -p $$d/$$file "$(distdir)/$$file" \ - || exit 1; \ - fi; \ - done - $(MAKE) $(AM_MAKEFLAGS) \ - top_distdir="$(top_distdir)" distdir="$(distdir)" \ - dist-hook -check-am: all-am -check: check-am -all-am: Makefile -installdirs: -install: install-am -install-exec: install-exec-am -install-data: install-data-am -uninstall: uninstall-am - -install-am: all-am - @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am - -installcheck: installcheck-am -install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install -mostlyclean-generic: - -clean-generic: - -distclean-generic: - -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) - -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) - -maintainer-clean-generic: - @echo "This command is intended for maintainers to use" - @echo "it deletes files that may require special tools to rebuild." -clean: clean-am - -clean-am: clean-generic clean-libtool clean-local mostlyclean-am - -distclean: distclean-am - -rm -f Makefile -distclean-am: clean-am distclean-generic - -dvi: dvi-am - -dvi-am: - -html: html-am - -html-am: - -info: info-am - -info-am: - -install-data-am: install-data-local - -install-dvi: install-dvi-am - -install-dvi-am: - -install-exec-am: - -install-html: install-html-am - -install-html-am: - -install-info: install-info-am - -install-info-am: - -install-man: - -install-pdf: install-pdf-am - -install-pdf-am: - -install-ps: install-ps-am - -install-ps-am: - -installcheck-am: - -maintainer-clean: maintainer-clean-am - -rm -f Makefile -maintainer-clean-am: distclean-am maintainer-clean-generic \ - maintainer-clean-local - -mostlyclean: mostlyclean-am - -mostlyclean-am: mostlyclean-generic mostlyclean-libtool - -pdf: pdf-am - -pdf-am: - -ps: ps-am - -ps-am: - -uninstall-am: uninstall-local - -.MAKE: install-am install-strip - -.PHONY: all all-am check check-am clean clean-generic clean-libtool \ - clean-local dist-hook distclean distclean-generic \ - distclean-libtool distdir dvi dvi-am html html-am info info-am \ - install install-am install-data install-data-am \ - install-data-local install-dvi install-dvi-am install-exec \ - install-exec-am install-html install-html-am install-info \ - install-info-am install-man install-pdf install-pdf-am \ - install-ps install-ps-am install-strip installcheck \ - installcheck-am installdirs maintainer-clean \ - maintainer-clean-generic maintainer-clean-local mostlyclean \ - mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ - uninstall uninstall-am uninstall-local - - -@ENABLE_GTK_DOC_TRUE@docs: html-build.stamp - -#### scan #### - -@ENABLE_GTK_DOC_TRUE@scan-build.stamp: $(HFILE_GLOB) -@ENABLE_GTK_DOC_TRUE@ @echo '*** Scanning header files ***' -@ENABLE_GTK_DOC_TRUE@ if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ -@ENABLE_GTK_DOC_TRUE@ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj $(SCANOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ -@ENABLE_GTK_DOC_TRUE@ else \ -@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) ; \ -@ENABLE_GTK_DOC_TRUE@ for i in $(SCANOBJ_FILES) ; do \ -@ENABLE_GTK_DOC_TRUE@ test -f $$i || touch $$i ; \ -@ENABLE_GTK_DOC_TRUE@ done \ -@ENABLE_GTK_DOC_TRUE@ fi -@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && \ -@ENABLE_GTK_DOC_TRUE@ gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) -@ENABLE_GTK_DOC_TRUE@ touch scan-build.stamp - -@ENABLE_GTK_DOC_TRUE@$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp -@ENABLE_GTK_DOC_TRUE@ @true - -#### templates #### - -@ENABLE_GTK_DOC_TRUE@tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) -@ENABLE_GTK_DOC_TRUE@ @echo '*** Rebuilding template files ***' -@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) -@ENABLE_GTK_DOC_TRUE@ touch tmpl-build.stamp - -@ENABLE_GTK_DOC_TRUE@tmpl.stamp: tmpl-build.stamp -@ENABLE_GTK_DOC_TRUE@ @true - -#### sgml #### - -@ENABLE_GTK_DOC_TRUE@sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml -@ENABLE_GTK_DOC_TRUE@ @echo '*** Building XML ***' -@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && \ -@ENABLE_GTK_DOC_TRUE@ gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml $(MKDB_OPTIONS) -@ENABLE_GTK_DOC_TRUE@ touch sgml-build.stamp - -@ENABLE_GTK_DOC_TRUE@sgml.stamp: sgml-build.stamp -@ENABLE_GTK_DOC_TRUE@ @true - -#### html #### - -@ENABLE_GTK_DOC_TRUE@html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) -@ENABLE_GTK_DOC_TRUE@ @echo '*** Building HTML ***' -@ENABLE_GTK_DOC_TRUE@ test -d $(srcdir)/html || mkdir $(srcdir)/html -@ENABLE_GTK_DOC_TRUE@ cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) -@ENABLE_GTK_DOC_TRUE@ test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) -@ENABLE_GTK_DOC_TRUE@ @echo '-- Fixing Crossreferences' -@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) -@ENABLE_GTK_DOC_TRUE@ touch html-build.stamp - -############## - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \ - $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp $(DESTDIR)$(TARGET_DIR); \ - fi) - -uninstall-local: - (installfiles=`cd $(srcdir)/html >/dev/null && echo *.html`; \ - if test "$$installfiles" = '*.html'; \ - then echo '-- Nothing to uninstall' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Removing '$$i ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$$i; \ - done; \ - echo '-- Removing index.sgml' ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \ - echo '-- Removing $(DOC_MODULE).devhelp' ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp; \ - fi) - -# -# Require gtk-doc when making dist -# -@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: -@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: -@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" -@ENABLE_GTK_DOC_FALSE@ @false - -dist-hook: dist-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/xml - mkdir $(distdir)/html - cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - cp $(srcdir)/xml/*.xml $(distdir)/xml - cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/$(DOC_MODULE).devhelp $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : dist-hook-local - -# Tell versions [3.59,3.63) of GNU make to not export all variables. -# Otherwise a system limit (for SysV at least) may be exceeded. -.NOEXPORT: diff --git a/lib/enca/devel-docs/html/ch01.html b/lib/enca/devel-docs/html/ch01.html deleted file mode 100644 index 5b27554331..0000000000 --- a/lib/enca/devel-docs/html/ch01.html +++ /dev/null @@ -1,45 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Enca Library API</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="Enca Library Reference Manual"> -<link rel="up" href="index.html" title="Enca Library Reference Manual"> -<link rel="prev" href="index.html" title="Enca Library Reference Manual"> -<link rel="next" href="libenca-Analyser.html" title="Analyser"> -<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -<link rel="chapter" href="ch01.html" title="Enca Library API"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td> </td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">Enca Library Reference Manual</th> -<td><a accesskey="n" href="libenca-Analyser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr></table> -<div class="chapter" title="Enca Library API"> -<div class="titlepage"><div><div><h2 class="title"> -<a name="id315616"></a>Enca Library API</h2></div></div></div> -<div class="toc"><dl> -<dt> -<span class="refentrytitle"><a href="libenca-Analyser.html">Analyser</a></span><span class="refpurpose"> — Basic analyser interface.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libenca-Typedefs-and-Constants.html">Typedefs and Constants</a></span><span class="refpurpose"> — Enca library typedefs, enums and constants.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libenca-Charsets-and-Surfaces.html">Charsets and Surfaces</a></span><span class="refpurpose"> — Functions and macros for getting something sensible from <a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding"><span class="type">EncaEncoding</span></a>.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libenca-Auxiliary-Functions.html">Auxiliary functions</a></span><span class="refpurpose"> — Variouis auxiliary functions and informations about libenca.</span> -</dt> -</dl></div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.11</div> -</body> -</html> diff --git a/lib/enca/devel-docs/html/home.png b/lib/enca/devel-docs/html/home.png Binary files differdeleted file mode 100644 index 17003611d9..0000000000 --- a/lib/enca/devel-docs/html/home.png +++ /dev/null diff --git a/lib/enca/devel-docs/html/index.html b/lib/enca/devel-docs/html/index.html deleted file mode 100644 index b17df785df..0000000000 --- a/lib/enca/devel-docs/html/index.html +++ /dev/null @@ -1,41 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Enca Library Reference Manual</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="Enca Library Reference Manual"> -<link rel="next" href="ch01.html" title="Enca Library API"> -<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -<link rel="chapter" href="ch01.html" title="Enca Library API"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<div class="book" title="Enca Library Reference Manual"> -<div class="titlepage"> -<div><div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Enca Library Reference Manual</p></th></tr></table></div></div> -<hr> -</div> -<div class="toc"><dl> -<dt><span class="chapter"><a href="ch01.html">Enca Library API</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="libenca-Analyser.html">Analyser</a></span><span class="refpurpose"> — Basic analyser interface.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libenca-Typedefs-and-Constants.html">Typedefs and Constants</a></span><span class="refpurpose"> — Enca library typedefs, enums and constants.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libenca-Charsets-and-Surfaces.html">Charsets and Surfaces</a></span><span class="refpurpose"> — Functions and macros for getting something sensible from <a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding"><span class="type">EncaEncoding</span></a>.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libenca-Auxiliary-Functions.html">Auxiliary functions</a></span><span class="refpurpose"> — Variouis auxiliary functions and informations about libenca.</span> -</dt> -</dl></dd> -</dl></div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.11</div> -</body> -</html> diff --git a/lib/enca/devel-docs/html/index.sgml b/lib/enca/devel-docs/html/index.sgml deleted file mode 100644 index 28f9673681..0000000000 --- a/lib/enca/devel-docs/html/index.sgml +++ /dev/null @@ -1,70 +0,0 @@ -<ANCHOR id="libenca-Analyser" href="libenca/libenca-Analyser.html"> -<ANCHOR id="libenca-Analyser.synopsis" href="libenca/libenca-Analyser.html#libenca-Analyser.synopsis"> -<ANCHOR id="libenca-Analyser.description" href="libenca/libenca-Analyser.html#libenca-Analyser.description"> -<ANCHOR id="libenca-Analyser.details" href="libenca/libenca-Analyser.html#libenca-Analyser.details"> -<ANCHOR id="enca-analyser-alloc" href="libenca/libenca-Analyser.html#enca-analyser-alloc"> -<ANCHOR id="enca-analyser-free" href="libenca/libenca-Analyser.html#enca-analyser-free"> -<ANCHOR id="enca-analyse" href="libenca/libenca-Analyser.html#enca-analyse"> -<ANCHOR id="enca-analyse-const" href="libenca/libenca-Analyser.html#enca-analyse-const"> -<ANCHOR id="enca-errno" href="libenca/libenca-Analyser.html#enca-errno"> -<ANCHOR id="enca-strerror" href="libenca/libenca-Analyser.html#enca-strerror"> -<ANCHOR id="enca-double-utf8-check" href="libenca/libenca-Analyser.html#enca-double-utf8-check"> -<ANCHOR id="enca-double-utf8-get-candidates" href="libenca/libenca-Analyser.html#enca-double-utf8-get-candidates"> -<ANCHOR id="enca-set-multibyte" href="libenca/libenca-Analyser.html#enca-set-multibyte"> -<ANCHOR id="enca-get-multibyte" href="libenca/libenca-Analyser.html#enca-get-multibyte"> -<ANCHOR id="enca-set-interpreted-surfaces" href="libenca/libenca-Analyser.html#enca-set-interpreted-surfaces"> -<ANCHOR id="enca-get-interpreted-surfaces" href="libenca/libenca-Analyser.html#enca-get-interpreted-surfaces"> -<ANCHOR id="enca-set-ambiguity" href="libenca/libenca-Analyser.html#enca-set-ambiguity"> -<ANCHOR id="enca-get-ambiguity" href="libenca/libenca-Analyser.html#enca-get-ambiguity"> -<ANCHOR id="enca-set-filtering" href="libenca/libenca-Analyser.html#enca-set-filtering"> -<ANCHOR id="enca-get-filtering" href="libenca/libenca-Analyser.html#enca-get-filtering"> -<ANCHOR id="enca-set-garbage-test" href="libenca/libenca-Analyser.html#enca-set-garbage-test"> -<ANCHOR id="enca-get-garbage-test" href="libenca/libenca-Analyser.html#enca-get-garbage-test"> -<ANCHOR id="enca-set-termination-strictness" href="libenca/libenca-Analyser.html#enca-set-termination-strictness"> -<ANCHOR id="enca-get-termination-strictness" href="libenca/libenca-Analyser.html#enca-get-termination-strictness"> -<ANCHOR id="enca-set-significant" href="libenca/libenca-Analyser.html#enca-set-significant"> -<ANCHOR id="enca-get-significant" href="libenca/libenca-Analyser.html#enca-get-significant"> -<ANCHOR id="enca-set-threshold" href="libenca/libenca-Analyser.html#enca-set-threshold"> -<ANCHOR id="enca-get-threshold" href="libenca/libenca-Analyser.html#enca-get-threshold"> -<ANCHOR id="libenca-Typedefs-and-Constants" href="libenca/libenca-Typedefs-and-Constants.html"> -<ANCHOR id="libenca-Typedefs-and-Constants.synopsis" href="libenca/libenca-Typedefs-and-Constants.html#libenca-Typedefs-and-Constants.synopsis"> -<ANCHOR id="libenca-Typedefs-and-Constants.description" href="libenca/libenca-Typedefs-and-Constants.html#libenca-Typedefs-and-Constants.description"> -<ANCHOR id="libenca-Typedefs-and-Constants.details" href="libenca/libenca-Typedefs-and-Constants.html#libenca-Typedefs-and-Constants.details"> -<ANCHOR id="EncaEncoding" href="libenca/libenca-Typedefs-and-Constants.html#EncaEncoding"> -<ANCHOR id="ENCA-CS-UNKNOWN--CAPS" href="libenca/libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS"> -<ANCHOR id="EncaSurface" href="libenca/libenca-Typedefs-and-Constants.html#EncaSurface"> -<ANCHOR id="EncaCharsetFlags" href="libenca/libenca-Typedefs-and-Constants.html#EncaCharsetFlags"> -<ANCHOR id="EncaNameStyle" href="libenca/libenca-Typedefs-and-Constants.html#EncaNameStyle"> -<ANCHOR id="EncaErrno" href="libenca/libenca-Typedefs-and-Constants.html#EncaErrno"> -<ANCHOR id="ENCA-NOT-A-CHAR--CAPS" href="libenca/libenca-Typedefs-and-Constants.html#ENCA-NOT-A-CHAR--CAPS"> -<ANCHOR id="libenca-Charsets-and-Surfaces" href="libenca/libenca-Charsets-and-Surfaces.html"> -<ANCHOR id="libenca-Charsets-and-Surfaces.synopsis" href="libenca/libenca-Charsets-and-Surfaces.html#libenca-Charsets-and-Surfaces.synopsis"> -<ANCHOR id="libenca-Charsets-and-Surfaces.description" href="libenca/libenca-Charsets-and-Surfaces.html#libenca-Charsets-and-Surfaces.description"> -<ANCHOR id="libenca-Charsets-and-Surfaces.details" href="libenca/libenca-Charsets-and-Surfaces.html#libenca-Charsets-and-Surfaces.details"> -<ANCHOR id="enca-charset-name" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-name"> -<ANCHOR id="enca-get-charset-aliases" href="libenca/libenca-Charsets-and-Surfaces.html#enca-get-charset-aliases"> -<ANCHOR id="enca-get-surface-name" href="libenca/libenca-Charsets-and-Surfaces.html#enca-get-surface-name"> -<ANCHOR id="enca-parse-encoding-name" href="libenca/libenca-Charsets-and-Surfaces.html#enca-parse-encoding-name"> -<ANCHOR id="enca-charset-natural-surface" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-natural-surface"> -<ANCHOR id="enca-charset-properties" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-properties"> -<ANCHOR id="enca-charset-is-7bit" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-7bit"> -<ANCHOR id="enca-charset-is-8bit" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-8bit"> -<ANCHOR id="enca-charset-is-16bit" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-16bit"> -<ANCHOR id="enca-charset-is-32bit" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-32bit"> -<ANCHOR id="enca-charset-is-fixed" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-fixed"> -<ANCHOR id="enca-charset-is-variable" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-variable"> -<ANCHOR id="enca-charset-is-binary" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-binary"> -<ANCHOR id="enca-charset-is-regular" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-regular"> -<ANCHOR id="enca-charset-is-multibyte" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-multibyte"> -<ANCHOR id="enca-charset-is-known" href="libenca/libenca-Charsets-and-Surfaces.html#enca-charset-is-known"> -<ANCHOR id="libenca-Auxiliary-Functions" href="libenca/libenca-Auxiliary-Functions.html"> -<ANCHOR id="libenca-Auxiliary-Functions.synopsis" href="libenca/libenca-Auxiliary-Functions.html#libenca-Auxiliary-Functions.synopsis"> -<ANCHOR id="libenca-Auxiliary-Functions.description" href="libenca/libenca-Auxiliary-Functions.html#libenca-Auxiliary-Functions.description"> -<ANCHOR id="libenca-Auxiliary-Functions.details" href="libenca/libenca-Auxiliary-Functions.html#libenca-Auxiliary-Functions.details"> -<ANCHOR id="enca-charset-has-ucs2-map" href="libenca/libenca-Auxiliary-Functions.html#enca-charset-has-ucs2-map"> -<ANCHOR id="enca-charset-ucs2-map" href="libenca/libenca-Auxiliary-Functions.html#enca-charset-ucs2-map"> -<ANCHOR id="enca-number-of-charsets" href="libenca/libenca-Auxiliary-Functions.html#enca-number-of-charsets"> -<ANCHOR id="enca-analyser-language" href="libenca/libenca-Auxiliary-Functions.html#enca-analyser-language"> -<ANCHOR id="enca-get-languages" href="libenca/libenca-Auxiliary-Functions.html#enca-get-languages"> -<ANCHOR id="enca-language-english-name" href="libenca/libenca-Auxiliary-Functions.html#enca-language-english-name"> -<ANCHOR id="enca-get-language-charsets" href="libenca/libenca-Auxiliary-Functions.html#enca-get-language-charsets"> diff --git a/lib/enca/devel-docs/html/left.png b/lib/enca/devel-docs/html/left.png Binary files differdeleted file mode 100644 index 2d05b3d5b4..0000000000 --- a/lib/enca/devel-docs/html/left.png +++ /dev/null diff --git a/lib/enca/devel-docs/html/libenca-Analyser.html b/lib/enca/devel-docs/html/libenca-Analyser.html deleted file mode 100644 index b5d585185e..0000000000 --- a/lib/enca/devel-docs/html/libenca-Analyser.html +++ /dev/null @@ -1,987 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Analyser</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="Enca Library Reference Manual"> -<link rel="up" href="ch01.html" title="Enca Library API"> -<link rel="prev" href="ch01.html" title="Enca Library API"> -<link rel="next" href="libenca-Typedefs-and-Constants.html" title="Typedefs and Constants"> -<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -<link rel="chapter" href="ch01.html" title="Enca Library API"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">Enca Library Reference Manual</th> -<td><a accesskey="n" href="libenca-Typedefs-and-Constants.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#libenca-Analyser.synopsis" class="shortcut">Top</a> -  | - <a href="#libenca-Analyser.description" class="shortcut">Description</a> -</td></tr> -</table> -<div class="refentry" title="Analyser"> -<a name="libenca-Analyser"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libenca-Analyser.top_of_page"></a>Analyser</span></h2> -<p>Analyser — Basic analyser interface.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> -<a name="libenca-Analyser.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -EncaAnalyser <a class="link" href="libenca-Analyser.html#enca-analyser-alloc" title="enca_analyser_alloc ()">enca_analyser_alloc</a> (const char *langname); -void <a class="link" href="libenca-Analyser.html#enca-analyser-free" title="enca_analyser_free ()">enca_analyser_free</a> (EncaAnalyser analyser); -<a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a> <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()">enca_analyse</a> (EncaAnalyser analyser, - unsigned char *buffer, - size_t size); -<a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a> <a class="link" href="libenca-Analyser.html#enca-analyse-const" title="enca_analyse_const ()">enca_analyse_const</a> (EncaAnalyser analyser, - unsigned char *buffer, - size_t size); -int <a class="link" href="libenca-Analyser.html#enca-errno" title="enca_errno ()">enca_errno</a> (EncaAnalyser analyser); -const char* <a class="link" href="libenca-Analyser.html#enca-strerror" title="enca_strerror ()">enca_strerror</a> (EncaAnalyser analyser, - int errnum); -int <a class="link" href="libenca-Analyser.html#enca-double-utf8-check" title="enca_double_utf8_check ()">enca_double_utf8_check</a> (EncaAnalyser analyser, - unsigned char *buffer, - size_t size); -int* <a class="link" href="libenca-Analyser.html#enca-double-utf8-get-candidates" title="enca_double_utf8_get_candidates ()">enca_double_utf8_get_candidates</a> (EncaAnalyser analyser); -void <a class="link" href="libenca-Analyser.html#enca-set-multibyte" title="enca_set_multibyte ()">enca_set_multibyte</a> (EncaAnalyser analyser, - int multibyte); -int <a class="link" href="libenca-Analyser.html#enca-get-multibyte" title="enca_get_multibyte ()">enca_get_multibyte</a> (EncaAnalyser analyser); -void <a class="link" href="libenca-Analyser.html#enca-set-interpreted-surfaces" title="enca_set_interpreted_surfaces ()">enca_set_interpreted_surfaces</a> (EncaAnalyser analyser, - int interpreted_surfaces); -int <a class="link" href="libenca-Analyser.html#enca-get-interpreted-surfaces" title="enca_get_interpreted_surfaces ()">enca_get_interpreted_surfaces</a> (EncaAnalyser analyser); -void <a class="link" href="libenca-Analyser.html#enca-set-ambiguity" title="enca_set_ambiguity ()">enca_set_ambiguity</a> (EncaAnalyser analyser, - int ambiguity); -int <a class="link" href="libenca-Analyser.html#enca-get-ambiguity" title="enca_get_ambiguity ()">enca_get_ambiguity</a> (EncaAnalyser analyser); -void <a class="link" href="libenca-Analyser.html#enca-set-filtering" title="enca_set_filtering ()">enca_set_filtering</a> (EncaAnalyser analyser, - int filtering); -int <a class="link" href="libenca-Analyser.html#enca-get-filtering" title="enca_get_filtering ()">enca_get_filtering</a> (EncaAnalyser analyser); -void <a class="link" href="libenca-Analyser.html#enca-set-garbage-test" title="enca_set_garbage_test ()">enca_set_garbage_test</a> (EncaAnalyser analyser, - int garabage_test); -int <a class="link" href="libenca-Analyser.html#enca-get-garbage-test" title="enca_get_garbage_test ()">enca_get_garbage_test</a> (EncaAnalyser analyser); -void <a class="link" href="libenca-Analyser.html#enca-set-termination-strictness" title="enca_set_termination_strictness ()">enca_set_termination_strictness</a> (EncaAnalyser analyser, - int termination_strictness); -int <a class="link" href="libenca-Analyser.html#enca-get-termination-strictness" title="enca_get_termination_strictness ()">enca_get_termination_strictness</a> (EncaAnalyser analyser); -int <a class="link" href="libenca-Analyser.html#enca-set-significant" title="enca_set_significant ()">enca_set_significant</a> (EncaAnalyser analyser, - size_t significant); -size_t <a class="link" href="libenca-Analyser.html#enca-get-significant" title="enca_get_significant ()">enca_get_significant</a> (EncaAnalyser analyser); -int <a class="link" href="libenca-Analyser.html#enca-set-threshold" title="enca_set_threshold ()">enca_set_threshold</a> (EncaAnalyser analyser, - double threshold); -double <a class="link" href="libenca-Analyser.html#enca-get-threshold" title="enca_get_threshold ()">enca_get_threshold</a> (EncaAnalyser analyser); -</pre> -</div> -<div class="refsect1" title="Description"> -<a name="libenca-Analyser.description"></a><h2>Description</h2> -<p> -Basically you want to allocate an analyser with <a class="link" href="libenca-Analyser.html#enca-analyser-alloc" title="enca_analyser_alloc ()"><code class="function">enca_analyser_alloc()</code></a> for some -language, use <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> (or <a class="link" href="libenca-Analyser.html#enca-analyse-const" title="enca_analyse_const ()"><code class="function">enca_analyse_const()</code></a>) on a buffer to find its -encoding, and interpret the results with something like <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-name" title="enca_charset_name ()"><code class="function">enca_charset_name()</code></a>. -The analyser then can be used for another buffer. Once you no longer need -it, call <a class="link" href="libenca-Analyser.html#enca-analyser-free" title="enca_analyser_free ()"><code class="function">enca_analyser_free()</code></a> to release it. -</p> -<p> -A single working example is better than a hundred pages of reference manual. -</p> -<div class="example"> -<a name="id341782"></a><p class="title"><b>Example 1. A minimal Enca library application – Czech encoding -detector.</b></p> -<div class="example-contents"><pre class="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; -} -</pre></div> -</div> -<br class="example-break"><p> -The analyser has plenty of options, but generally you don't need to fiddle -with them, except <a class="link" href="libenca-Analyser.html#enca-set-termination-strictness" title="enca_set_termination_strictness ()"><code class="function">enca_set_termination_strictness()</code></a>. -</p> -<p> -All names prefixed with <code class="function">ENCA_</code>, -<code class="function">Enca</code>, <code class="function">_Enca</code>, -or <code class="function">enca_</code> should be treated as reserved and not used for -application function/variable/type/macro names. -</p> -</div> -<div class="refsect1" title="Details"> -<a name="libenca-Analyser.details"></a><h2>Details</h2> -<div class="refsect2" title="enca_analyser_alloc ()"> -<a name="enca-analyser-alloc"></a><h3>enca_analyser_alloc ()</h3> -<pre class="programlisting">EncaAnalyser enca_analyser_alloc (const char *langname);</pre> -<p> -Allocates an analyser and initializes it for language <em class="parameter"><code>language</code></em>. -</p> -<p> -The analyser, once crerated, can be used only for language for which it -was initialized. If you need to detect encodings of texts in more than one -language, you must allocate an analyser for each one. Note however, an -analyser may occupy a considerable amount of memory (a few hundreds of kB), -so it's generally not a good idea to have several hundreds of them floating -around. -</p> -<p> -<em class="parameter"><code>langname</code></em> is two-letter ISO 639:1989 language code. Locale names in form -language_territory and ISO-639 English language names also may be accepted -in the future. To be on the safe side, use only names returned by -<a class="link" href="libenca-Auxiliary-Functions.html#enca-get-languages" title="enca_get_languages ()"><code class="function">enca_get_languages()</code></a>.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>langname</code></em> :</span></p></td> -<td> Language for which the analyser should be initialized. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The newly created <span class="type">EncaAnalyser</span> on success, <span class="type">NULL</span> on failure - (namely when <em class="parameter"><code>langname</code></em> is unknown or otherwise invalid). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_analyser_free ()"> -<a name="enca-analyser-free"></a><h3>enca_analyser_free ()</h3> -<pre class="programlisting">void enca_analyser_free (EncaAnalyser analyser);</pre> -<p> -Frees memory used by <span class="type">EncaAnalyser</span> <em class="parameter"><code>analyser</code></em>.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser to be destroyed. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_analyse ()"> -<a name="enca-analyse"></a><h3>enca_analyse ()</h3> -<pre class="programlisting"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a> enca_analyse (EncaAnalyser analyser, - unsigned char *buffer, - size_t size);</pre> -<p> -Analyses <em class="parameter"><code>buffer</code></em> and finds its encoding. -</p> -<p> -The <em class="parameter"><code>buffer</code></em> is checked for 8bit encodings of language for which <em class="parameter"><code>analyser</code></em> -was initialized and for multibyte encodings, mostly independent on language -(unless disabled with <a class="link" href="libenca-Analyser.html#enca-set-multibyte" title="enca_set_multibyte ()"><code class="function">enca_set_multibyte()</code></a>). -</p> -<p> -The contents of <em class="parameter"><code>buffer</code></em> may be (and probably will be) modified during the -analyse. Use <a class="link" href="libenca-Analyser.html#enca-analyse-const" title="enca_analyse_const ()"><code class="function">enca_analyse_const()</code></a> instead if this discomforts you.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser initialized for some language. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> -<td> Buffer to be analysed. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td> -<td> Size of <em class="parameter"><code>buffer</code></em>. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Encoding of <em class="parameter"><code>buffer</code></em>. When charset part of return value is - <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS" title="ENCA_CS_UNKNOWN"><span class="type">ENCA_CS_UNKNOWN</span></a>, encoding was not determined. Check - <a class="link" href="libenca-Analyser.html#enca-errno" title="enca_errno ()"><code class="function">enca_errno()</code></a> for reason. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_analyse_const ()"> -<a name="enca-analyse-const"></a><h3>enca_analyse_const ()</h3> -<pre class="programlisting"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a> enca_analyse_const (EncaAnalyser analyser, - unsigned char *buffer, - size_t size);</pre> -<p> -Analyses <em class="parameter"><code>buffer</code></em> and finds its encoding. -</p> -<p> -The <em class="parameter"><code>buffer</code></em> is checked for 8bit encodings of language for which <em class="parameter"><code>analyser</code></em> -was initialized and for multibyte encodings, mostly independent on language -(unless disabled with <a class="link" href="libenca-Analyser.html#enca-set-multibyte" title="enca_set_multibyte ()"><code class="function">enca_set_multibyte()</code></a>). -</p> -<p> -This function never modifies <em class="parameter"><code>buffer</code></em> (can be even used with string literal -<em class="parameter"><code>buffer</code></em>) at the expense it's generally slower than <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a>.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser initialized for some language. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> -<td> Buffer to be analysed. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td> -<td> Size of <em class="parameter"><code>buffer</code></em>. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Encoding of <em class="parameter"><code>buffer</code></em>. When charset part of return value is - <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS" title="ENCA_CS_UNKNOWN"><span class="type">ENCA_CS_UNKNOWN</span></a>, encoding was not determined. Check - <a class="link" href="libenca-Analyser.html#enca-errno" title="enca_errno ()"><code class="function">enca_errno()</code></a> for reason. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_errno ()"> -<a name="enca-errno"></a><h3>enca_errno ()</h3> -<pre class="programlisting">int enca_errno (EncaAnalyser analyser);</pre> -<p> -Returns analyser error code. -</p> -<p> -The error code is not modified. However, any other analyser call i.e. -call to a function taking <em class="parameter"><code>analyser</code></em> as parameter can change the error code.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Error code of reason why last analyser call failed. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_strerror ()"> -<a name="enca-strerror"></a><h3>enca_strerror ()</h3> -<pre class="programlisting">const char* enca_strerror (EncaAnalyser analyser, - int errnum);</pre> -<p> -Returns string describing the error code. -</p> -<p> -The returned string must be considered constant and must NOT be freed. -It is however gauranteed not to be modified on invalidated by subsequent -calls to any libenca functions, including <a class="link" href="libenca-Analyser.html#enca-strerror" title="enca_strerror ()"><code class="function">enca_strerror()</code></a>. -</p> -<p> -The analyser error code is not changed for a successful call, and it set -to <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-EINVALUE--CAPS"><span class="type">ENCA_EINVALUE</span></a> upon error.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>errnum</code></em> :</span></p></td> -<td> An analyser error code. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> String describing the error code. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_double_utf8_check ()"> -<a name="enca-double-utf8-check"></a><h3>enca_double_utf8_check ()</h3> -<pre class="programlisting">int enca_double_utf8_check (EncaAnalyser analyser, - unsigned char *buffer, - size_t size);</pre> -<p> -Checks buffer for double-UTF-8 encoding. -</p> -<p> -Double-UTF-8 encoding is the result of [errorneous] conversion of UTF-8 text -to UTF-8 again, as if it was in some 8bit charset. This is quite hard to -recover from. -</p> -<p> -The analayser mostly only determines what language will be assumed, -the rest of this test is independent on the main guessing routines. -When <em class="parameter"><code>buffer</code></em> doesn't containing UTF-8 text, the result is undefined -(namely, false positives are possible). -</p> -<p> -Calling this function when language is `none' has currently no effect.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> Analyzer state determinig the language for double-UTF-8 check. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> -<td> The buffer to be checked [<em class="parameter"><code>size</code></em>]. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td> -<td> The size of <em class="parameter"><code>buffer</code></em>. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero, when <em class="parameter"><code>buffer</code></em> probably contains doubly-UTF-8 encoded text. - More precisely, it returns the number of charsets which are - possible candidates for source charset. You can then use - <a class="link" href="libenca-Analyser.html#enca-double-utf8-get-candidates" title="enca_double_utf8_get_candidates ()"><code class="function">enca_double_utf8_get_candidates()</code></a> to retrieve the charsets. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_double_utf8_get_candidates ()"> -<a name="enca-double-utf8-get-candidates"></a><h3>enca_double_utf8_get_candidates ()</h3> -<pre class="programlisting">int* enca_double_utf8_get_candidates (EncaAnalyser analyser);</pre> -<p> -Returns array of double-UTF-8 source charset candidates from the last check. -</p> -<p> -The returned array should be freed by caller then no longer needed. Its -is the return value of the preceding <a class="link" href="libenca-Analyser.html#enca-double-utf8-check" title="enca_double_utf8_check ()"><code class="function">enca_double_utf8_check()</code></a> call. -</p> -<p> -When called before any double-UTF-8 test has been performed yet or after -and unsuccessfull double-UTF-8 test, it returns NULL, but the result after -an unsuccessfull check should be considered undefined.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> Analyzer state for which double-UTF-8 candidates are to be - returned. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> An array containing charset id's of possible source charsets from - which the sample was doubly-UTF-8 encoded. The array may contain - only one value, but usually enca is not able to decide between - e.g. ISO-8859-2 and Win1250, thus more candidates are returned. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_set_multibyte ()"> -<a name="enca-set-multibyte"></a><h3>enca_set_multibyte ()</h3> -<pre class="programlisting">void enca_set_multibyte (EncaAnalyser analyser, - int multibyte);</pre> -<p> -Enables or disables multibyte encoding tests for <em class="parameter"><code>analyser</code></em>. -</p> -<p> -This option is enabled by default. -</p> -<p> -When multibyte encodings are disabled, only 8bit charsets are checked. -Disabling them for language with no 8bit charsets leaves only one thing -<a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> could test: whether the sample is purely 7bit ASCII or not -(the latter leading to analyser failure, of course). -</p> -<p> -Multibyte encoding detection is also affected by -<a class="link" href="libenca-Analyser.html#enca-set-termination-strictness" title="enca_set_termination_strictness ()"><code class="function">enca_set_termination_strictness()</code></a>.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>multibyte</code></em> :</span></p></td> -<td> Whether multibyte encoding tests should be enabled (nonzero to - enable, zero to disable). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_multibyte ()"> -<a name="enca-get-multibyte"></a><h3>enca_get_multibyte ()</h3> -<pre class="programlisting">int enca_get_multibyte (EncaAnalyser analyser);</pre> -<p> -Returns whether <em class="parameter"><code>analyser</code></em> can return multibyte encodings. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-multibyte" title="enca_set_multibyte ()"><code class="function">enca_set_multibyte()</code></a> for more detailed description of multibyte -encoding checking.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when multibyte encoding are possible, zero otherwise. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_interpreted_surfaces ()"> -<a name="enca-set-interpreted-surfaces"></a><h3>enca_set_interpreted_surfaces ()</h3> -<pre class="programlisting">void enca_set_interpreted_surfaces (EncaAnalyser analyser, - int interpreted_surfaces);</pre> -<p> -Enables or disables interpeted surfaces tests for <em class="parameter"><code>analyser</code></em>. -</p> -<p> -This option is enabled by default. -</p> -<p> -To allow simple applications which care about charset only and don't want -to wrestle with surfaces, neglecting surface information should not have -serious consequences. While ignoring EOL type surface is feasible, and -ignoring UCS byteorders may be acceptable in endian-homogenous environment; -ignoring the fact file is Quoted-Printable encoded can have disasterous -consequences. By disabling this option you can disable surfaces requiring -fundamental reinterpretation of the content, namely <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-QP--CAPS"><code class="literal">ENCA_SURFACE_QP</code></a> -and <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-EOL-BIN--CAPS"><code class="literal">ENCA_SURFACE_EOL_BIN</code></a> (thus probably making <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> to fail on -such samples).</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>interpreted_surfaces</code></em> :</span></p></td> -<td> Whether interpreted surfaces tests should be enabled - (nonzero to allow, zero to disallow). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_interpreted_surfaces ()"> -<a name="enca-get-interpreted-surfaces"></a><h3>enca_get_interpreted_surfaces ()</h3> -<pre class="programlisting">int enca_get_interpreted_surfaces (EncaAnalyser analyser);</pre> -<p> -Returns whether <em class="parameter"><code>analyser</code></em> allows interpreted surfaces. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-interpreted-surfaces" title="enca_set_interpreted_surfaces ()"><code class="function">enca_set_interpreted_surfaces()</code></a> for more detailed description of -interpreted surfaces.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when interpreted surfaces are possible, zero otherwise. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_ambiguity ()"> -<a name="enca-set-ambiguity"></a><h3>enca_set_ambiguity ()</h3> -<pre class="programlisting">void enca_set_ambiguity (EncaAnalyser analyser, - int ambiguity);</pre> -<p> -Enables or disables ambiguous mode for <em class="parameter"><code>analyser</code></em>. -</p> -<p> -This option is disabled by default. -</p> -<p> -In ambiguous mode some result is returned even when the charset cannot be -determined uniquely, provided that sample contains only characters which -have the same meaning in all charsets under consideration.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>ambiguity</code></em> :</span></p></td> -<td> Whether result can be ambiguous (nonzero to allow, zero to - disallow). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_ambiguity ()"> -<a name="enca-get-ambiguity"></a><h3>enca_get_ambiguity ()</h3> -<pre class="programlisting">int enca_get_ambiguity (EncaAnalyser analyser);</pre> -<p> -Returns whether <em class="parameter"><code>analyser</code></em> can return ambiguous results. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-ambiguity" title="enca_set_ambiguity ()"><code class="function">enca_set_ambiguity()</code></a> for more detailed description of ambiguous results.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when ambiguous results are allowed, zero otherwise. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_filtering ()"> -<a name="enca-set-filtering"></a><h3>enca_set_filtering ()</h3> -<pre class="programlisting">void enca_set_filtering (EncaAnalyser analyser, - int filtering);</pre> -<p> -Enables or disables filters for <em class="parameter"><code>analyser</code></em>. -</p> -<p> -This option is enabled by default. -</p> -<p> -Various filters are used to filter out block of binary noise and box-drawing -characters that could otherwise confuse enca. In cases this is unwanted, -you can disable them by setting this option to zero.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>filtering</code></em> :</span></p></td> -<td> Whether filters should be enabled (nonzero to enable, zero to - disable). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_filtering ()"> -<a name="enca-get-filtering"></a><h3>enca_get_filtering ()</h3> -<pre class="programlisting">int enca_get_filtering (EncaAnalyser analyser);</pre> -<p> -Returns whether <em class="parameter"><code>analyser</code></em> has filtering enabled. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-filtering" title="enca_set_filtering ()"><code class="function">enca_set_filtering()</code></a> for more detailed description of filtering.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when filtering is enabled, zero otherwise. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_garbage_test ()"> -<a name="enca-set-garbage-test"></a><h3>enca_set_garbage_test ()</h3> -<pre class="programlisting">void enca_set_garbage_test (EncaAnalyser analyser, - int garabage_test);</pre> -<p> -Enables or disables garbage test for <em class="parameter"><code>analyser</code></em>. -</p> -<p> -This option is enabled by default. -</p> -<p> -To prevent white noise (and almost-white noise) from being accidentally -detected as some charset, a garbage test is used. In cases this is -unwanted, you can disable is by setting this option to zero.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>garabage_test</code></em> :</span></p></td> -<td> Whether garbage test should be allowed (nonzero to enable, - nzero to disable). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_garbage_test ()"> -<a name="enca-get-garbage-test"></a><h3>enca_get_garbage_test ()</h3> -<pre class="programlisting">int enca_get_garbage_test (EncaAnalyser analyser);</pre> -<p> -Returns whether <em class="parameter"><code>analyser</code></em> has garbage test enabled. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-garbage-test" title="enca_set_garbage_test ()"><code class="function">enca_set_garbage_test()</code></a> for more detailed description of garbage test.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when garbage test is enabled, zero otherwise. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_termination_strictness ()"> -<a name="enca-set-termination-strictness"></a><h3>enca_set_termination_strictness ()</h3> -<pre class="programlisting">void enca_set_termination_strictness (EncaAnalyser analyser, - int termination_strictness);</pre> -<p> -Enables or disables requiring multibyte sequences to be terminated correctly -at the end of sample. -</p> -<p> -This option is enabled by default. -</p> -<p> -The sample given to <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> generally may not be a complete text -(e.g. for efficiency reasons). As a result, it may end in the middle of a -multibyte sequence. In this case, you should disable this option to -prevent rejecting some charset just because the sample don't terminate -correctly. On the other hand, when given sample contains whole text, you -should always enable this option to assure correctness of the result. -</p> -<p> -Note this option does NOT affect fixed character size encodings, like UCS-2 -and UCS-4; sample is never assumed to contain UCS-2 text when its size is -not even (and similarly for UCS-4).</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>termination_strictness</code></em> :</span></p></td> -<td> Whether multibyte sequences are required to be - terminated correctly at the end of sample - (nonzero to require, zero to relax). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_termination_strictness ()"> -<a name="enca-get-termination-strictness"></a><h3>enca_get_termination_strictness ()</h3> -<pre class="programlisting">int enca_get_termination_strictness (EncaAnalyser analyser);</pre> -<p> -Returns whether <em class="parameter"><code>analyser</code></em> requires strict termination. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-termination-strictness" title="enca_set_termination_strictness ()"><code class="function">enca_set_termination_strictness()</code></a> for more detailed description of -termination strictness.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when strict termination is required, zero otherwise. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_significant ()"> -<a name="enca-set-significant"></a><h3>enca_set_significant ()</h3> -<pre class="programlisting">int enca_set_significant (EncaAnalyser analyser, - size_t significant);</pre> -<p> -Sets the minimal number of required significant characters. -</p> -<p> -The default value of this option is 10. -</p> -<p> -<a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> refuses to make a decision unles at least this number -of significant characters is found in sample. You may want to lower this -number for very short texts.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>significant</code></em> :</span></p></td> -<td> Minimal number of required significant characters. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Zero on success, nonzero on failure, i.e. when you passed zero - as <em class="parameter"><code>significant</code></em>. It sets analyser errno to ENCA_EINVALUE on - failure. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_significant ()"> -<a name="enca-get-significant"></a><h3>enca_get_significant ()</h3> -<pre class="programlisting">size_t enca_get_significant (EncaAnalyser analyser);</pre> -<p> -Returns the minimum number of significant characters required by <em class="parameter"><code>analyser</code></em>. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-significant" title="enca_set_significant ()"><code class="function">enca_set_significant()</code></a> for more detailed description of required -significant characters.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The minimum number of significant characters. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -<hr> -<div class="refsect2" title="enca_set_threshold ()"> -<a name="enca-set-threshold"></a><h3>enca_set_threshold ()</h3> -<pre class="programlisting">int enca_set_threshold (EncaAnalyser analyser, - double threshold);</pre> -<p> -Sets the minimal ratio between the most probable and the second most -probable charsets. -</p> -<p> -The default value of this option is 1.4142. -</p> -<p> -<a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> consideres the result known only when there's a clear gap -between the most probable and the second most probable charset -proababilities. Lower <em class="parameter"><code>threshold</code></em> values mean larger probability of a -mistake and smaller probability of not recognizing a charset; higher -<em class="parameter"><code>threshold</code></em> values the contrary. Threshold value of 2 is almost infinity.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>threshold</code></em> :</span></p></td> -<td> Minimal ratio between winner and second best guess. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Zero on success, nonzero on failure, i.e. when you passed value - smaller than 1.0 as <em class="parameter"><code>threshold</code></em>. It sets analyser errno to - ENCA_EINVALUE on failure. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_threshold ()"> -<a name="enca-get-threshold"></a><h3>enca_get_threshold ()</h3> -<pre class="programlisting">double enca_get_threshold (EncaAnalyser analyser);</pre> -<p> -Returns the threshold value used by <em class="parameter"><code>analyser</code></em>. -</p> -<p> -See <a class="link" href="libenca-Analyser.html#enca-set-threshold" title="enca_set_threshold ()"><code class="function">enca_set_threshold()</code></a> for more detailed threshold description.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The threshold value. - -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.3.</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.11</div> -</body> -</html> diff --git a/lib/enca/devel-docs/html/libenca-Auxiliary-Functions.html b/lib/enca/devel-docs/html/libenca-Auxiliary-Functions.html deleted file mode 100644 index 2f0bfeb665..0000000000 --- a/lib/enca/devel-docs/html/libenca-Auxiliary-Functions.html +++ /dev/null @@ -1,264 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Auxiliary functions</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="Enca Library Reference Manual"> -<link rel="up" href="ch01.html" title="Enca Library API"> -<link rel="prev" href="libenca-Charsets-and-Surfaces.html" title="Charsets and Surfaces"> -<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -<link rel="chapter" href="ch01.html" title="Enca Library API"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="libenca-Charsets-and-Surfaces.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">Enca Library Reference Manual</th> -<td> </td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#libenca-Auxiliary-Functions.synopsis" class="shortcut">Top</a> -  | - <a href="#libenca-Auxiliary-Functions.description" class="shortcut">Description</a> -</td></tr> -</table> -<div class="refentry" title="Auxiliary functions"> -<a name="libenca-Auxiliary-Functions"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libenca-Auxiliary-Functions.top_of_page"></a>Auxiliary functions</span></h2> -<p>Auxiliary functions — Variouis auxiliary functions and informations about libenca.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> -<a name="libenca-Auxiliary-Functions.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -int <a class="link" href="libenca-Auxiliary-Functions.html#enca-charset-has-ucs2-map" title="enca_charset_has_ucs2_map ()">enca_charset_has_ucs2_map</a> (int charset); -int <a class="link" href="libenca-Auxiliary-Functions.html#enca-charset-ucs2-map" title="enca_charset_ucs2_map ()">enca_charset_ucs2_map</a> (int charset, - unsigned int *buffer); -size_t <a class="link" href="libenca-Auxiliary-Functions.html#enca-number-of-charsets" title="enca_number_of_charsets ()">enca_number_of_charsets</a> (void); -const char* <a class="link" href="libenca-Auxiliary-Functions.html#enca-analyser-language" title="enca_analyser_language ()">enca_analyser_language</a> (EncaAnalyser analyser); -const char** <a class="link" href="libenca-Auxiliary-Functions.html#enca-get-languages" title="enca_get_languages ()">enca_get_languages</a> (size_t *n); -const char* <a class="link" href="libenca-Auxiliary-Functions.html#enca-language-english-name" title="enca_language_english_name ()">enca_language_english_name</a> (const char *lang); -int* <a class="link" href="libenca-Auxiliary-Functions.html#enca-get-language-charsets" title="enca_get_language_charsets ()">enca_get_language_charsets</a> (const char *langname, - size_t *n); -</pre> -</div> -<div class="refsect1" title="Description"> -<a name="libenca-Auxiliary-Functions.description"></a><h2>Description</h2> -<p> -</p> -</div> -<div class="refsect1" title="Details"> -<a name="libenca-Auxiliary-Functions.details"></a><h2>Details</h2> -<div class="refsect2" title="enca_charset_has_ucs2_map ()"> -<a name="enca-charset-has-ucs2-map"></a><h3>enca_charset_has_ucs2_map ()</h3> -<pre class="programlisting">int enca_charset_has_ucs2_map (int charset);</pre> -<p> -Find whether we have charset -> UCS-2 map.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> -<td> An 8bit charset. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when the map is available, zero otherwise. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_ucs2_map ()"> -<a name="enca-charset-ucs2-map"></a><h3>enca_charset_ucs2_map ()</h3> -<pre class="programlisting">int enca_charset_ucs2_map (int charset, - unsigned int *buffer);</pre> -<p> -Creates map from an 8bit charset to UCS-2. -</p> -<p> -The buffer must be at least 256*sizeof(unsigned int) long to hold the map.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> -<td> An 8bit charset. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> -<td> Buffer to store the map to. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> Nonzero when the map was successfully created, zero otherwise. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_number_of_charsets ()"> -<a name="enca-number-of-charsets"></a><h3>enca_number_of_charsets ()</h3> -<pre class="programlisting">size_t enca_number_of_charsets (void);</pre> -<p> -Returns number of known charsets. -</p> -<p> -Charsets idetifiers are assigned successively starting from zero, so last -charset has identifier <a class="link" href="libenca-Auxiliary-Functions.html#enca-number-of-charsets" title="enca_number_of_charsets ()"><code class="function">enca_number_of_charsets()</code></a> - 1.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The number of charsets. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_analyser_language ()"> -<a name="enca-analyser-language"></a><h3>enca_analyser_language ()</h3> -<pre class="programlisting">const char* enca_analyser_language (EncaAnalyser analyser);</pre> -<p> -Returns name of language which was <em class="parameter"><code>analyser</code></em> initialized for. -</p> -<p> -The returned string must be considered constant and must NOT be freed.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td> -<td> An analyser. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The language name. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_languages ()"> -<a name="enca-get-languages"></a><h3>enca_get_languages ()</h3> -<pre class="programlisting">const char** enca_get_languages (size_t *n);</pre> -<p> -Returns list of known languages. -</p> -<p> -The returned strings are two-letter ISO-639 language codes, the same as -<a class="link" href="libenca-Analyser.html#enca-analyser-alloc" title="enca_analyser_alloc ()"><code class="function">enca_analyser_alloc()</code></a> accepts. -</p> -<p> -The list of languages has to be freed by caller; the strings themselves -must be considered constant and must NOT be freed.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td> -<td> The number of languages will be stored here. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The list of languages, storing their number into *<em class="parameter"><code>n</code></em>. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_language_english_name ()"> -<a name="enca-language-english-name"></a><h3>enca_language_english_name ()</h3> -<pre class="programlisting">const char* enca_language_english_name (const char *lang);</pre> -<p> -Returns an English name of a language given its ISO-639 code. -</p> -<p> -The returned string must be considered constant and must NOT be freed.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>lang</code></em> :</span></p></td> -<td> A two-letter language code, such as obtained from - <a class="link" href="libenca-Auxiliary-Functions.html#enca-analyser-language" title="enca_analyser_language ()"><code class="function">enca_analyser_language()</code></a> or <a class="link" href="libenca-Auxiliary-Functions.html#enca-get-languages" title="enca_get_languages ()"><code class="function">enca_get_languages()</code></a>. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The English language name. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_language_charsets ()"> -<a name="enca-get-language-charsets"></a><h3>enca_get_language_charsets ()</h3> -<pre class="programlisting">int* enca_get_language_charsets (const char *langname, - size_t *n);</pre> -<p> -Returns list of identifiers of charsets supported for language <em class="parameter"><code>language</code></em>. -</p> -<p> -The list of charset identifiers has to be freed by caller.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>langname</code></em> :</span></p></td> -<td> Two-letter ISO-639 language code. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td> -<td> The number of charsets will be stored here. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The list of charsets, storing their number into *<em class="parameter"><code>n</code></em>. When language - contains no charsets or <em class="parameter"><code>langname</code></em> is invalid, <span class="type">NULL</span> is returned - and zero stored into *<em class="parameter"><code>n</code></em>. -</td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.11</div> -</body> -</html> diff --git a/lib/enca/devel-docs/html/libenca-Charsets-and-Surfaces.html b/lib/enca/devel-docs/html/libenca-Charsets-and-Surfaces.html deleted file mode 100644 index 56738147e0..0000000000 --- a/lib/enca/devel-docs/html/libenca-Charsets-and-Surfaces.html +++ /dev/null @@ -1,429 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Charsets and Surfaces</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="Enca Library Reference Manual"> -<link rel="up" href="ch01.html" title="Enca Library API"> -<link rel="prev" href="libenca-Typedefs-and-Constants.html" title="Typedefs and Constants"> -<link rel="next" href="libenca-Auxiliary-Functions.html" title="Auxiliary functions"> -<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -<link rel="chapter" href="ch01.html" title="Enca Library API"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="libenca-Typedefs-and-Constants.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">Enca Library Reference Manual</th> -<td><a accesskey="n" href="libenca-Auxiliary-Functions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#libenca-Charsets-and-Surfaces.synopsis" class="shortcut">Top</a> -  | - <a href="#libenca-Charsets-and-Surfaces.description" class="shortcut">Description</a> -</td></tr> -</table> -<div class="refentry" title="Charsets and Surfaces"> -<a name="libenca-Charsets-and-Surfaces"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libenca-Charsets-and-Surfaces.top_of_page"></a>Charsets and Surfaces</span></h2> -<p>Charsets and Surfaces — Functions and macros for getting something sensible from <a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding"><span class="type">EncaEncoding</span></a>.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> -<a name="libenca-Charsets-and-Surfaces.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -const char* <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-name" title="enca_charset_name ()">enca_charset_name</a> (int charset, - <a class="link" href="libenca-Typedefs-and-Constants.html#EncaNameStyle" title="enum EncaNameStyle">EncaNameStyle</a> whatname); -const char** <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-get-charset-aliases" title="enca_get_charset_aliases ()">enca_get_charset_aliases</a> (int charset, - size_t *n); -char* <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-get-surface-name" title="enca_get_surface_name ()">enca_get_surface_name</a> (<a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a> surface, - <a class="link" href="libenca-Typedefs-and-Constants.html#EncaNameStyle" title="enum EncaNameStyle">EncaNameStyle</a> whatname); -<a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a> <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-parse-encoding-name" title="enca_parse_encoding_name ()">enca_parse_encoding_name</a> (const char *name); -<a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a> <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-natural-surface" title="enca_charset_natural_surface ()">enca_charset_natural_surface</a> (int charset); -<a class="link" href="libenca-Typedefs-and-Constants.html#EncaCharsetFlags" title="enum EncaCharsetFlags">EncaCharsetFlags</a> <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-properties" title="enca_charset_properties ()">enca_charset_properties</a> (int charset); -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-7bit" title="enca_charset_is_7bit()">enca_charset_is_7bit</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-8bit" title="enca_charset_is_8bit()">enca_charset_is_8bit</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-16bit" title="enca_charset_is_16bit()">enca_charset_is_16bit</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-32bit" title="enca_charset_is_32bit()">enca_charset_is_32bit</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-fixed" title="enca_charset_is_fixed()">enca_charset_is_fixed</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-variable" title="enca_charset_is_variable()">enca_charset_is_variable</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-binary" title="enca_charset_is_binary()">enca_charset_is_binary</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-regular" title="enca_charset_is_regular()">enca_charset_is_regular</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-multibyte" title="enca_charset_is_multibyte()">enca_charset_is_multibyte</a> (cs) -#define <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-known" title="enca_charset_is_known()">enca_charset_is_known</a> (cs) -</pre> -</div> -<div class="refsect1" title="Description"> -<a name="libenca-Charsets-and-Surfaces.description"></a><h2>Description</h2> -<p> -</p> -</div> -<div class="refsect1" title="Details"> -<a name="libenca-Charsets-and-Surfaces.details"></a><h2>Details</h2> -<div class="refsect2" title="enca_charset_name ()"> -<a name="enca-charset-name"></a><h3>enca_charset_name ()</h3> -<pre class="programlisting">const char* enca_charset_name (int charset, - <a class="link" href="libenca-Typedefs-and-Constants.html#EncaNameStyle" title="enum EncaNameStyle">EncaNameStyle</a> whatname);</pre> -<p> -Translates numeric charset id <em class="parameter"><code>charset</code></em> to some kind of name.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> -<td> A charset id. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>whatname</code></em> :</span></p></td> -<td> Teh type of name you request. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The requested charset name; <span class="type">NULL</span> for invalid <em class="parameter"><code>whatname</code></em> or -<em class="parameter"><code>charset</code></em>, or when <em class="parameter"><code>whatname</code></em> name doesn't exist for charset <em class="parameter"><code>charset</code></em> -(<a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS" title="ENCA_CS_UNKNOWN"><span class="type">ENCA_CS_UNKNOWN</span></a> is OK). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_charset_aliases ()"> -<a name="enca-get-charset-aliases"></a><h3>enca_get_charset_aliases ()</h3> -<pre class="programlisting">const char** enca_get_charset_aliases (int charset, - size_t *n);</pre> -<p> -Returns list of accepted aliases for charset <em class="parameter"><code>charset</code></em>. -</p> -<p> -The list of aliases has to be freed by caller; the strings themselves -must be considered constant and must NOT be freed.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> -<td> A charset id. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td> -<td> The number of aliases will be stored here. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The list of aliases, storing their number into *<em class="parameter"><code>n</code></em>; <span class="type">NULL</span> for -invalid <em class="parameter"><code>charset</code></em> (*<em class="parameter"><code>n</code></em> is zero then). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_get_surface_name ()"> -<a name="enca-get-surface-name"></a><h3>enca_get_surface_name ()</h3> -<pre class="programlisting">char* enca_get_surface_name (<a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a> surface, - <a class="link" href="libenca-Typedefs-and-Constants.html#EncaNameStyle" title="enum EncaNameStyle">EncaNameStyle</a> whatname);</pre> -<p> -Constructs surface name from surface flags <em class="parameter"><code>surface</code></em>.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td> -<td> A surface. -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>whatname</code></em> :</span></p></td> -<td> The type of name you request. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The requested surface name; <span class="type">NULL</span> for invalid <em class="parameter"><code>whatname</code></em>; empty -string for naming style not supporting surfaces. In all cases, the -returned string must be freed by caller when no longer used. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_parse_encoding_name ()"> -<a name="enca-parse-encoding-name"></a><h3>enca_parse_encoding_name ()</h3> -<pre class="programlisting"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a> enca_parse_encoding_name (const char *name);</pre> -<p> -Transofrms encoding specification charset/surface into numeric <a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding"><span class="type">EncaEncoding</span></a>. -</p> -<p> -When the charset name is not recognized, surfaces are not parsed at all and -<a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS" title="ENCA_CS_UNKNOWN"><span class="type">ENCA_CS_UNKNOWN</span></a> is returned as charset. However, unrecognized surfaces are -considered only a minor problem causing <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-UNKNOWN--CAPS"><code class="literal">ENCA_SURFACE_UNKNOWN</code></a> flag to be -set in the result, beside recognized surface flags.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td> An encoding specification. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The charset/surface pair. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_natural_surface ()"> -<a name="enca-charset-natural-surface"></a><h3>enca_charset_natural_surface ()</h3> -<pre class="programlisting"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a> enca_charset_natural_surface (int charset);</pre> -<p> -Returns natural surface of a charset.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> -<td> A charset. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The requested charset natural surface (called `implied' in recode), - zero for invalid <em class="parameter"><code>charset</code></em> or for charsets with no natural surface. - - Natrual surface is the surface one expects for a given charset -- - e.g. CRLF EOLs for IBM/Microsoft charsets, CR EOLs for Macintosh - charsets and LF EOLs for ISO/Unix charsets. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_properties ()"> -<a name="enca-charset-properties"></a><h3>enca_charset_properties ()</h3> -<pre class="programlisting"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaCharsetFlags" title="enum EncaCharsetFlags">EncaCharsetFlags</a> enca_charset_properties (int charset);</pre> -<p> -Returns charset properties.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> -<td> A charset. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> The requested charset properties; zero for invalid <em class="parameter"><code>charset</code></em>. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_7bit()"> -<a name="enca-charset-is-7bit"></a><h3>enca_charset_is_7bit()</h3> -<pre class="programlisting">#define enca_charset_is_7bit(cs)</pre> -<p> -Expands to nonzero when characters are represented with 7bit characters.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_8bit()"> -<a name="enca-charset-is-8bit"></a><h3>enca_charset_is_8bit()</h3> -<pre class="programlisting">#define enca_charset_is_8bit(cs)</pre> -<p> -Expands to nonzero when characters are represented with bytes.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_16bit()"> -<a name="enca-charset-is-16bit"></a><h3>enca_charset_is_16bit()</h3> -<pre class="programlisting">#define enca_charset_is_16bit(cs)</pre> -<p> -Expands to nonzero when characters are represented with 2byte words.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_32bit()"> -<a name="enca-charset-is-32bit"></a><h3>enca_charset_is_32bit()</h3> -<pre class="programlisting">#define enca_charset_is_32bit(cs)</pre> -<p> -Expands to nonzero when characters are represented with 4byte words.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_fixed()"> -<a name="enca-charset-is-fixed"></a><h3>enca_charset_is_fixed()</h3> -<pre class="programlisting">#define enca_charset_is_fixed(cs)</pre> -<p> -Expands to nonzero when one characters consists of one fundamental piece.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_variable()"> -<a name="enca-charset-is-variable"></a><h3>enca_charset_is_variable()</h3> -<pre class="programlisting">#define enca_charset_is_variable(cs)</pre> -<p> -Expands to nonzero when one character consists of variable number of -fundamental pieces.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_binary()"> -<a name="enca-charset-is-binary"></a><h3>enca_charset_is_binary()</h3> -<pre class="programlisting">#define enca_charset_is_binary(cs)</pre> -<p> -Expands to nonzero when charset is binary from ASCII viewpoint.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_regular()"> -<a name="enca-charset-is-regular"></a><h3>enca_charset_is_regular()</h3> -<pre class="programlisting">#define enca_charset_is_regular(cs)</pre> -<p> -Expands to nonzero when charset is language dependent (8bit) charset.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_multibyte()"> -<a name="enca-charset-is-multibyte"></a><h3>enca_charset_is_multibyte()</h3> -<pre class="programlisting">#define enca_charset_is_multibyte(cs)</pre> -<p> -Expands to nonzero when charset is multibyte.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enca_charset_is_known()"> -<a name="enca-charset-is-known"></a><h3>enca_charset_is_known()</h3> -<pre class="programlisting">#define enca_charset_is_known(cs)</pre> -<p> -Expands to nonzero when the charset is known (i.e. it's not -ENCA_CS_UNKNOWN).</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>cs</code></em> :</span></p></td> -<td> Charset id. -</td> -</tr></tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.11</div> -</body> -</html> diff --git a/lib/enca/devel-docs/html/libenca-Typedefs-and-Constants.html b/lib/enca/devel-docs/html/libenca-Typedefs-and-Constants.html deleted file mode 100644 index bc5b348c32..0000000000 --- a/lib/enca/devel-docs/html/libenca-Typedefs-and-Constants.html +++ /dev/null @@ -1,432 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Typedefs and Constants</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> -<link rel="home" href="index.html" title="Enca Library Reference Manual"> -<link rel="up" href="ch01.html" title="Enca Library API"> -<link rel="prev" href="libenca-Analyser.html" title="Analyser"> -<link rel="next" href="libenca-Charsets-and-Surfaces.html" title="Charsets and Surfaces"> -<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -<link rel="chapter" href="ch01.html" title="Enca Library API"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="libenca-Analyser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">Enca Library Reference Manual</th> -<td><a accesskey="n" href="libenca-Charsets-and-Surfaces.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#libenca-Typedefs-and-Constants.synopsis" class="shortcut">Top</a> -  | - <a href="#libenca-Typedefs-and-Constants.description" class="shortcut">Description</a> -</td></tr> -</table> -<div class="refentry" title="Typedefs and Constants"> -<a name="libenca-Typedefs-and-Constants"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libenca-Typedefs-and-Constants.top_of_page"></a>Typedefs and Constants</span></h2> -<p>Typedefs and Constants — Enca library typedefs, enums and constants.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv" title="Synopsis"> -<a name="libenca-Typedefs-and-Constants.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> - <a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a>; -#define <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS" title="ENCA_CS_UNKNOWN">ENCA_CS_UNKNOWN</a> -enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a>; -enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaCharsetFlags" title="enum EncaCharsetFlags">EncaCharsetFlags</a>; -enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaNameStyle" title="enum EncaNameStyle">EncaNameStyle</a>; -enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaErrno" title="enum EncaErrno">EncaErrno</a>; -#define <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-NOT-A-CHAR--CAPS" title="ENCA_NOT_A_CHAR">ENCA_NOT_A_CHAR</a> -</pre> -</div> -<div class="refsect1" title="Description"> -<a name="libenca-Typedefs-and-Constants.description"></a><h2>Description</h2> -<p> -</p> -</div> -<div class="refsect1" title="Details"> -<a name="libenca-Typedefs-and-Constants.details"></a><h2>Details</h2> -<div class="refsect2" title="EncaEncoding"> -<a name="EncaEncoding"></a><h3>EncaEncoding</h3> -<pre class="programlisting">typedef struct { - int charset; EncaSurface surface; -} EncaEncoding; -</pre> -<p> -Encoding, i.e. charset and surface. -</p> -<p> -This is what <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> and <a class="link" href="libenca-Analyser.html#enca-analyse-const" title="enca_analyse_const ()"><code class="function">enca_analyse_const()</code></a> return. -</p> -<p> -The <em class="parameter"><code>charset</code></em> field is an opaque numerical charset identifier, which has no -meaning outside Enca library. -You will probably want to use it only as <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-name" title="enca_charset_name ()"><code class="function">enca_charset_name()</code></a> argument. -It is only guaranteed not to change meaning -during program execution time; change of its interpretation (e.g. due to -addition of new charsets) is not considered API change. -</p> -<p> -The <em class="parameter"><code>surface</code></em> field is a combination of <a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface"><span class="type">EncaSurface</span></a> flags. You may want -to ignore it completely; you should use <a class="link" href="libenca-Analyser.html#enca-set-interpreted-surfaces" title="enca_set_interpreted_surfaces ()"><code class="function">enca_set_interpreted_surfaces()</code></a> -to disable weird surfaces then.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term">int <em class="structfield"><code>charset</code></em>;</span></p></td> -<td> Numeric charset identifier. -</td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a> <em class="structfield"><code>surface</code></em>;</span></p></td> -<td> Surface flags. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="ENCA_CS_UNKNOWN"> -<a name="ENCA-CS-UNKNOWN--CAPS"></a><h3>ENCA_CS_UNKNOWN</h3> -<pre class="programlisting">#define ENCA_CS_UNKNOWN (-1) -</pre> -<p> -Unknown character set id. -</p> -<p> -Use <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-known" title="enca_charset_is_known()"><code class="function">enca_charset_is_known()</code></a> to check for unknown charset instead of direct -comparsion.</p> -<p> -</p> -</div> -<hr> -<div class="refsect2" title="enum EncaSurface"> -<a name="EncaSurface"></a><h3>enum EncaSurface</h3> -<pre class="programlisting">typedef enum { /*< flags >*/ - ENCA_SURFACE_EOL_CR = 1 << 0, - ENCA_SURFACE_EOL_LF = 1 << 1, - ENCA_SURFACE_EOL_CRLF = 1 << 2, - ENCA_SURFACE_EOL_MIX = 1 << 3, - ENCA_SURFACE_EOL_BIN = 1 << 4, - ENCA_SURFACE_MASK_EOL = (ENCA_SURFACE_EOL_CR - | ENCA_SURFACE_EOL_LF - | ENCA_SURFACE_EOL_CRLF - | ENCA_SURFACE_EOL_MIX - | ENCA_SURFACE_EOL_BIN), - ENCA_SURFACE_PERM_21 = 1 << 5, - ENCA_SURFACE_PERM_4321 = 1 << 6, - ENCA_SURFACE_PERM_MIX = 1 << 7, - ENCA_SURFACE_MASK_PERM = (ENCA_SURFACE_PERM_21 - | ENCA_SURFACE_PERM_4321 - | ENCA_SURFACE_PERM_MIX), - ENCA_SURFACE_QP = 1 << 8, - ENCA_SURFACE_REMOVE = 1 << 13, - ENCA_SURFACE_UNKNOWN = 1 << 14, - ENCA_SURFACE_MASK_ALL = (ENCA_SURFACE_MASK_EOL - | ENCA_SURFACE_MASK_PERM - | ENCA_SURFACE_QP - | ENCA_SURFACE_REMOVE) -} EncaSurface; -</pre> -<p> -Surface flags.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><a name="ENCA-SURFACE-EOL-CR--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_CR</code></span></p></td> -<td> End-of-lines are represented with CR's. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-EOL-LF--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_LF</code></span></p></td> -<td> End-of-lines are represented with LF's. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-EOL-CRLF--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_CRLF</code></span></p></td> -<td> End-of-lines are represented with CRLF's. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-EOL-MIX--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_MIX</code></span></p></td> -<td> Several end-of-line types, mixed. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-EOL-BIN--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_BIN</code></span></p></td> -<td> End-of-line concept not applicable (binary data). -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-MASK-EOL--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_MASK_EOL</code></span></p></td> -<td> Mask for end-of-line surfaces. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-PERM-21--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_PERM_21</code></span></p></td> -<td> Odd and even bytes swapped. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-PERM-4321--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_PERM_4321</code></span></p></td> -<td> Reversed byte sequence in 4byte words. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-PERM-MIX--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_PERM_MIX</code></span></p></td> -<td> Chunks with both endianess, concatenated. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-MASK-PERM--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_MASK_PERM</code></span></p></td> -<td> Mask for permutation surfaces. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-QP--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_QP</code></span></p></td> -<td> Quoted printables. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-REMOVE--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_REMOVE</code></span></p></td> -<td> Recode `remove' surface. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-UNKNOWN--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_UNKNOWN</code></span></p></td> -<td> Unknown surface. -</td> -</tr> -<tr> -<td><p><a name="ENCA-SURFACE-MASK-ALL--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_MASK_ALL</code></span></p></td> -<td> Mask for all bits, withnout <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-UNKNOWN--CAPS"><span class="type">ENCA_SURFACE_UNKNOWN</span></a>. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enum EncaCharsetFlags"> -<a name="EncaCharsetFlags"></a><h3>enum EncaCharsetFlags</h3> -<pre class="programlisting">typedef enum { /*< flags >*/ - ENCA_CHARSET_7BIT = 1 << 0, - ENCA_CHARSET_8BIT = 1 << 1, - ENCA_CHARSET_16BIT = 1 << 2, - ENCA_CHARSET_32BIT = 1 << 3, - ENCA_CHARSET_FIXED = 1 << 4, - ENCA_CHARSET_VARIABLE = 1 << 5, - ENCA_CHARSET_BINARY = 1 << 6, - ENCA_CHARSET_REGULAR = 1 << 7, - ENCA_CHARSET_MULTIBYTE = 1 << 8 -} EncaCharsetFlags; -</pre> -<p> -Charset properties. -</p> -<p> -Flags <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-7BIT--CAPS"><code class="literal">ENCA_CHARSET_7BIT</code></a>, <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-8BIT--CAPS"><code class="literal">ENCA_CHARSET_8BIT</code></a>, <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-16BIT--CAPS"><code class="literal">ENCA_CHARSET_16BIT</code></a>, -<a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-32BIT--CAPS"><code class="literal">ENCA_CHARSET_32BIT</code></a> tell how many bits a `fundamental piece' consists of. -This is different from bits per character; r.g. UTF-8 consists of 8bit -pieces (bytes), but character can be composed from 1 to 6 of them.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><a name="ENCA-CHARSET-7BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_7BIT</code></span></p></td> -<td> Characters are represented with 7bit characters. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-8BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_8BIT</code></span></p></td> -<td> Characters are represented with bytes. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-16BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_16BIT</code></span></p></td> -<td> Characters are represented with 2byte words. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-32BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_32BIT</code></span></p></td> -<td> Characters are represented with 4byte words. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-FIXED--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_FIXED</code></span></p></td> -<td> One characters consists of one fundamental piece. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-VARIABLE--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_VARIABLE</code></span></p></td> -<td> One character consists of variable number of -fundamental pieces. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-BINARY--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_BINARY</code></span></p></td> -<td> Charset is binary from ASCII viewpoint. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-REGULAR--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_REGULAR</code></span></p></td> -<td> Language dependent (8bit) charset. -</td> -</tr> -<tr> -<td><p><a name="ENCA-CHARSET-MULTIBYTE--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_MULTIBYTE</code></span></p></td> -<td> Multibyte charset. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enum EncaNameStyle"> -<a name="EncaNameStyle"></a><h3>enum EncaNameStyle</h3> -<pre class="programlisting">typedef enum { - ENCA_NAME_STYLE_ENCA, - ENCA_NAME_STYLE_RFC1345, - ENCA_NAME_STYLE_CSTOCS, - ENCA_NAME_STYLE_ICONV, - ENCA_NAME_STYLE_HUMAN, - ENCA_NAME_STYLE_MIME -} EncaNameStyle; -</pre> -<p> -Charset naming styles and conventions.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><a name="ENCA-NAME-STYLE-ENCA--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_ENCA</code></span></p></td> -<td> Default, implicit charset name in Enca. -</td> -</tr> -<tr> -<td><p><a name="ENCA-NAME-STYLE-RFC1345--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_RFC1345</code></span></p></td> -<td> RFC 1345 or otherwise canonical charset name. -</td> -</tr> -<tr> -<td><p><a name="ENCA-NAME-STYLE-CSTOCS--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_CSTOCS</code></span></p></td> -<td> Cstocs charset name (may not exist). -</td> -</tr> -<tr> -<td><p><a name="ENCA-NAME-STYLE-ICONV--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_ICONV</code></span></p></td> -<td> Iconv charset name (may not exist). -</td> -</tr> -<tr> -<td><p><a name="ENCA-NAME-STYLE-HUMAN--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_HUMAN</code></span></p></td> -<td> Human comprehensible description. -</td> -</tr> -<tr> -<td><p><a name="ENCA-NAME-STYLE-MIME--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_MIME</code></span></p></td> -<td> Preferred MIME name (may not exist). -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="enum EncaErrno"> -<a name="EncaErrno"></a><h3>enum EncaErrno</h3> -<pre class="programlisting">typedef enum { - ENCA_EOK = 0, - ENCA_EINVALUE, - ENCA_EEMPTY, - ENCA_EFILTERED, - ENCA_ENOCS8, - ENCA_ESIGNIF, - ENCA_EWINNER, - ENCA_EGARBAGE -} EncaErrno; -</pre> -<p> -Error codes.</p> -<p> -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><a name="ENCA-EOK--CAPS"></a><span class="term"><code class="literal">ENCA_EOK</code></span></p></td> -<td> OK. -</td> -</tr> -<tr> -<td><p><a name="ENCA-EINVALUE--CAPS"></a><span class="term"><code class="literal">ENCA_EINVALUE</code></span></p></td> -<td> Invalid value (usually of an option). -</td> -</tr> -<tr> -<td><p><a name="ENCA-EEMPTY--CAPS"></a><span class="term"><code class="literal">ENCA_EEMPTY</code></span></p></td> -<td> Sample is empty. -</td> -</tr> -<tr> -<td><p><a name="ENCA-EFILTERED--CAPS"></a><span class="term"><code class="literal">ENCA_EFILTERED</code></span></p></td> -<td> After filtering, (almost) nothing remained. -</td> -</tr> -<tr> -<td><p><a name="ENCA-ENOCS8--CAPS"></a><span class="term"><code class="literal">ENCA_ENOCS8</code></span></p></td> -<td> Mulitibyte tests failed and language contains no 8bit charsets. -</td> -</tr> -<tr> -<td><p><a name="ENCA-ESIGNIF--CAPS"></a><span class="term"><code class="literal">ENCA_ESIGNIF</code></span></p></td> -<td> Too few significant characters. -</td> -</tr> -<tr> -<td><p><a name="ENCA-EWINNER--CAPS"></a><span class="term"><code class="literal">ENCA_EWINNER</code></span></p></td> -<td> No clear winner. -</td> -</tr> -<tr> -<td><p><a name="ENCA-EGARBAGE--CAPS"></a><span class="term"><code class="literal">ENCA_EGARBAGE</code></span></p></td> -<td> Sample is garbage. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2" title="ENCA_NOT_A_CHAR"> -<a name="ENCA-NOT-A-CHAR--CAPS"></a><h3>ENCA_NOT_A_CHAR</h3> -<pre class="programlisting">#define ENCA_NOT_A_CHAR 0xffff -</pre> -<p> -Not-a-character in unicode tables.</p> -<p> -</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.11</div> -</body> -</html> diff --git a/lib/enca/devel-docs/html/libenca.devhelp b/lib/enca/devel-docs/html/libenca.devhelp deleted file mode 100644 index 29b53f9c35..0000000000 --- a/lib/enca/devel-docs/html/libenca.devhelp +++ /dev/null @@ -1,68 +0,0 @@ -<?xml version="1.0" encoding="utf-8" standalone="no"?> -<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> -<book xmlns="http://www.devhelp.net/book" title="Enca Library Reference Manual" link="index.html" author="" name="libenca"> - <chapters> - <sub name="Enca Library API" link="ch01.html"> - <sub name="Analyser" link="libenca-Analyser.html"/> - <sub name="Typedefs and Constants" link="libenca-Typedefs-and-Constants.html"/> - <sub name="Charsets and Surfaces" link="libenca-Charsets-and-Surfaces.html"/> - <sub name="Auxiliary functions" link="libenca-Auxiliary-Functions.html"/> - </sub> - </chapters> - <functions> - <function name="enca_analyser_alloc ()" link="libenca-Analyser.html#enca-analyser-alloc"/> - <function name="enca_analyser_free ()" link="libenca-Analyser.html#enca-analyser-free"/> - <function name="enca_analyse ()" link="libenca-Analyser.html#enca-analyse"/> - <function name="enca_analyse_const ()" link="libenca-Analyser.html#enca-analyse-const"/> - <function name="enca_errno ()" link="libenca-Analyser.html#enca-errno"/> - <function name="enca_strerror ()" link="libenca-Analyser.html#enca-strerror"/> - <function name="enca_double_utf8_check ()" link="libenca-Analyser.html#enca-double-utf8-check"/> - <function name="enca_double_utf8_get_candidates ()" link="libenca-Analyser.html#enca-double-utf8-get-candidates"/> - <function name="enca_set_multibyte ()" link="libenca-Analyser.html#enca-set-multibyte"/> - <function name="enca_get_multibyte ()" link="libenca-Analyser.html#enca-get-multibyte"/> - <function name="enca_set_interpreted_surfaces ()" link="libenca-Analyser.html#enca-set-interpreted-surfaces"/> - <function name="enca_get_interpreted_surfaces ()" link="libenca-Analyser.html#enca-get-interpreted-surfaces"/> - <function name="enca_set_ambiguity ()" link="libenca-Analyser.html#enca-set-ambiguity"/> - <function name="enca_get_ambiguity ()" link="libenca-Analyser.html#enca-get-ambiguity"/> - <function name="enca_set_filtering ()" link="libenca-Analyser.html#enca-set-filtering"/> - <function name="enca_get_filtering ()" link="libenca-Analyser.html#enca-get-filtering"/> - <function name="enca_set_garbage_test ()" link="libenca-Analyser.html#enca-set-garbage-test"/> - <function name="enca_get_garbage_test ()" link="libenca-Analyser.html#enca-get-garbage-test"/> - <function name="enca_set_termination_strictness ()" link="libenca-Analyser.html#enca-set-termination-strictness"/> - <function name="enca_get_termination_strictness ()" link="libenca-Analyser.html#enca-get-termination-strictness"/> - <function name="enca_set_significant ()" link="libenca-Analyser.html#enca-set-significant"/> - <function name="enca_get_significant ()" link="libenca-Analyser.html#enca-get-significant"/> - <function name="enca_set_threshold ()" link="libenca-Analyser.html#enca-set-threshold"/> - <function name="enca_get_threshold ()" link="libenca-Analyser.html#enca-get-threshold"/> - <function name="EncaEncoding" link="libenca-Typedefs-and-Constants.html#EncaEncoding"/> - <function name="ENCA_CS_UNKNOWN" link="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS"/> - <function name="enum EncaSurface" link="libenca-Typedefs-and-Constants.html#EncaSurface"/> - <function name="enum EncaCharsetFlags" link="libenca-Typedefs-and-Constants.html#EncaCharsetFlags"/> - <function name="enum EncaNameStyle" link="libenca-Typedefs-and-Constants.html#EncaNameStyle"/> - <function name="enum EncaErrno" link="libenca-Typedefs-and-Constants.html#EncaErrno"/> - <function name="ENCA_NOT_A_CHAR" link="libenca-Typedefs-and-Constants.html#ENCA-NOT-A-CHAR--CAPS"/> - <function name="enca_charset_name ()" link="libenca-Charsets-and-Surfaces.html#enca-charset-name"/> - <function name="enca_get_charset_aliases ()" link="libenca-Charsets-and-Surfaces.html#enca-get-charset-aliases"/> - <function name="enca_get_surface_name ()" link="libenca-Charsets-and-Surfaces.html#enca-get-surface-name"/> - <function name="enca_parse_encoding_name ()" link="libenca-Charsets-and-Surfaces.html#enca-parse-encoding-name"/> - <function name="enca_charset_natural_surface ()" link="libenca-Charsets-and-Surfaces.html#enca-charset-natural-surface"/> - <function name="enca_charset_properties ()" link="libenca-Charsets-and-Surfaces.html#enca-charset-properties"/> - <function name="enca_charset_is_7bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-7bit"/> - <function name="enca_charset_is_8bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-8bit"/> - <function name="enca_charset_is_16bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-16bit"/> - <function name="enca_charset_is_32bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-32bit"/> - <function name="enca_charset_is_fixed()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-fixed"/> - <function name="enca_charset_is_variable()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-variable"/> - <function name="enca_charset_is_binary()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-binary"/> - <function name="enca_charset_is_regular()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-regular"/> - <function name="enca_charset_is_multibyte()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-multibyte"/> - <function name="enca_charset_is_known()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-known"/> - <function name="enca_charset_has_ucs2_map ()" link="libenca-Auxiliary-Functions.html#enca-charset-has-ucs2-map"/> - <function name="enca_charset_ucs2_map ()" link="libenca-Auxiliary-Functions.html#enca-charset-ucs2-map"/> - <function name="enca_number_of_charsets ()" link="libenca-Auxiliary-Functions.html#enca-number-of-charsets"/> - <function name="enca_analyser_language ()" link="libenca-Auxiliary-Functions.html#enca-analyser-language"/> - <function name="enca_get_languages ()" link="libenca-Auxiliary-Functions.html#enca-get-languages"/> - <function name="enca_language_english_name ()" link="libenca-Auxiliary-Functions.html#enca-language-english-name"/> - <function name="enca_get_language_charsets ()" link="libenca-Auxiliary-Functions.html#enca-get-language-charsets"/> - </functions> -</book> diff --git a/lib/enca/devel-docs/html/libenca.devhelp2 b/lib/enca/devel-docs/html/libenca.devhelp2 deleted file mode 100644 index a2610b37de..0000000000 --- a/lib/enca/devel-docs/html/libenca.devhelp2 +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8" standalone="no"?> -<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> -<book xmlns="http://www.devhelp.net/book" title="Enca Library Reference Manual" link="index.html" author="" name="libenca" version="2" language="c"> - <chapters> - <sub name="Enca Library API" link="ch01.html"> - <sub name="Analyser" link="libenca-Analyser.html"/> - <sub name="Typedefs and Constants" link="libenca-Typedefs-and-Constants.html"/> - <sub name="Charsets and Surfaces" link="libenca-Charsets-and-Surfaces.html"/> - <sub name="Auxiliary functions" link="libenca-Auxiliary-Functions.html"/> - </sub> - </chapters> - <functions> - <keyword type="function" name="enca_analyser_alloc ()" link="libenca-Analyser.html#enca-analyser-alloc"/> - <keyword type="function" name="enca_analyser_free ()" link="libenca-Analyser.html#enca-analyser-free"/> - <keyword type="function" name="enca_analyse ()" link="libenca-Analyser.html#enca-analyse"/> - <keyword type="function" name="enca_analyse_const ()" link="libenca-Analyser.html#enca-analyse-const"/> - <keyword type="function" name="enca_errno ()" link="libenca-Analyser.html#enca-errno"/> - <keyword type="function" name="enca_strerror ()" link="libenca-Analyser.html#enca-strerror"/> - <keyword type="function" name="enca_double_utf8_check ()" link="libenca-Analyser.html#enca-double-utf8-check"/> - <keyword type="function" name="enca_double_utf8_get_candidates ()" link="libenca-Analyser.html#enca-double-utf8-get-candidates"/> - <keyword type="function" name="enca_set_multibyte ()" link="libenca-Analyser.html#enca-set-multibyte"/> - <keyword type="function" name="enca_get_multibyte ()" link="libenca-Analyser.html#enca-get-multibyte" since="1.3."/> - <keyword type="function" name="enca_set_interpreted_surfaces ()" link="libenca-Analyser.html#enca-set-interpreted-surfaces"/> - <keyword type="function" name="enca_get_interpreted_surfaces ()" link="libenca-Analyser.html#enca-get-interpreted-surfaces" since="1.3."/> - <keyword type="function" name="enca_set_ambiguity ()" link="libenca-Analyser.html#enca-set-ambiguity"/> - <keyword type="function" name="enca_get_ambiguity ()" link="libenca-Analyser.html#enca-get-ambiguity" since="1.3."/> - <keyword type="function" name="enca_set_filtering ()" link="libenca-Analyser.html#enca-set-filtering"/> - <keyword type="function" name="enca_get_filtering ()" link="libenca-Analyser.html#enca-get-filtering" since="1.3."/> - <keyword type="function" name="enca_set_garbage_test ()" link="libenca-Analyser.html#enca-set-garbage-test"/> - <keyword type="function" name="enca_get_garbage_test ()" link="libenca-Analyser.html#enca-get-garbage-test" since="1.3."/> - <keyword type="function" name="enca_set_termination_strictness ()" link="libenca-Analyser.html#enca-set-termination-strictness"/> - <keyword type="function" name="enca_get_termination_strictness ()" link="libenca-Analyser.html#enca-get-termination-strictness" since="1.3."/> - <keyword type="function" name="enca_set_significant ()" link="libenca-Analyser.html#enca-set-significant"/> - <keyword type="function" name="enca_get_significant ()" link="libenca-Analyser.html#enca-get-significant" since="1.3."/> - <keyword type="function" name="enca_set_threshold ()" link="libenca-Analyser.html#enca-set-threshold"/> - <keyword type="function" name="enca_get_threshold ()" link="libenca-Analyser.html#enca-get-threshold" since="1.3."/> - <keyword type="struct" name="EncaEncoding" link="libenca-Typedefs-and-Constants.html#EncaEncoding"/> - <keyword type="macro" name="ENCA_CS_UNKNOWN" link="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS"/> - <keyword type="enum" name="enum EncaSurface" link="libenca-Typedefs-and-Constants.html#EncaSurface"/> - <keyword type="enum" name="enum EncaCharsetFlags" link="libenca-Typedefs-and-Constants.html#EncaCharsetFlags"/> - <keyword type="enum" name="enum EncaNameStyle" link="libenca-Typedefs-and-Constants.html#EncaNameStyle"/> - <keyword type="enum" name="enum EncaErrno" link="libenca-Typedefs-and-Constants.html#EncaErrno"/> - <keyword type="macro" name="ENCA_NOT_A_CHAR" link="libenca-Typedefs-and-Constants.html#ENCA-NOT-A-CHAR--CAPS"/> - <keyword type="function" name="enca_charset_name ()" link="libenca-Charsets-and-Surfaces.html#enca-charset-name"/> - <keyword type="function" name="enca_get_charset_aliases ()" link="libenca-Charsets-and-Surfaces.html#enca-get-charset-aliases"/> - <keyword type="function" name="enca_get_surface_name ()" link="libenca-Charsets-and-Surfaces.html#enca-get-surface-name"/> - <keyword type="function" name="enca_parse_encoding_name ()" link="libenca-Charsets-and-Surfaces.html#enca-parse-encoding-name"/> - <keyword type="function" name="enca_charset_natural_surface ()" link="libenca-Charsets-and-Surfaces.html#enca-charset-natural-surface"/> - <keyword type="function" name="enca_charset_properties ()" link="libenca-Charsets-and-Surfaces.html#enca-charset-properties"/> - <keyword type="macro" name="enca_charset_is_7bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-7bit"/> - <keyword type="macro" name="enca_charset_is_8bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-8bit"/> - <keyword type="macro" name="enca_charset_is_16bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-16bit"/> - <keyword type="macro" name="enca_charset_is_32bit()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-32bit"/> - <keyword type="macro" name="enca_charset_is_fixed()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-fixed"/> - <keyword type="macro" name="enca_charset_is_variable()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-variable"/> - <keyword type="macro" name="enca_charset_is_binary()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-binary"/> - <keyword type="macro" name="enca_charset_is_regular()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-regular"/> - <keyword type="macro" name="enca_charset_is_multibyte()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-multibyte"/> - <keyword type="macro" name="enca_charset_is_known()" link="libenca-Charsets-and-Surfaces.html#enca-charset-is-known"/> - <keyword type="function" name="enca_charset_has_ucs2_map ()" link="libenca-Auxiliary-Functions.html#enca-charset-has-ucs2-map"/> - <keyword type="function" name="enca_charset_ucs2_map ()" link="libenca-Auxiliary-Functions.html#enca-charset-ucs2-map"/> - <keyword type="function" name="enca_number_of_charsets ()" link="libenca-Auxiliary-Functions.html#enca-number-of-charsets"/> - <keyword type="function" name="enca_analyser_language ()" link="libenca-Auxiliary-Functions.html#enca-analyser-language"/> - <keyword type="function" name="enca_get_languages ()" link="libenca-Auxiliary-Functions.html#enca-get-languages"/> - <keyword type="function" name="enca_language_english_name ()" link="libenca-Auxiliary-Functions.html#enca-language-english-name"/> - <keyword type="function" name="enca_get_language_charsets ()" link="libenca-Auxiliary-Functions.html#enca-get-language-charsets"/> - <keyword type="constant" name="ENCA_SURFACE_EOL_CR" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-EOL-CR--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_EOL_LF" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-EOL-LF--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_EOL_CRLF" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-EOL-CRLF--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_EOL_MIX" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-EOL-MIX--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_EOL_BIN" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-EOL-BIN--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_MASK_EOL" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-MASK-EOL--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_PERM_21" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-PERM-21--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_PERM_4321" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-PERM-4321--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_PERM_MIX" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-PERM-MIX--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_MASK_PERM" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-MASK-PERM--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_QP" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-QP--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_REMOVE" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-REMOVE--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_UNKNOWN" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-UNKNOWN--CAPS"/> - <keyword type="constant" name="ENCA_SURFACE_MASK_ALL" link="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-MASK-ALL--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_7BIT" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-7BIT--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_8BIT" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-8BIT--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_16BIT" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-16BIT--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_32BIT" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-32BIT--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_FIXED" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-FIXED--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_VARIABLE" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-VARIABLE--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_BINARY" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-BINARY--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_REGULAR" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-REGULAR--CAPS"/> - <keyword type="constant" name="ENCA_CHARSET_MULTIBYTE" link="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-MULTIBYTE--CAPS"/> - <keyword type="constant" name="ENCA_NAME_STYLE_ENCA" link="libenca-Typedefs-and-Constants.html#ENCA-NAME-STYLE-ENCA--CAPS"/> - <keyword type="constant" name="ENCA_NAME_STYLE_RFC1345" link="libenca-Typedefs-and-Constants.html#ENCA-NAME-STYLE-RFC1345--CAPS"/> - <keyword type="constant" name="ENCA_NAME_STYLE_CSTOCS" link="libenca-Typedefs-and-Constants.html#ENCA-NAME-STYLE-CSTOCS--CAPS"/> - <keyword type="constant" name="ENCA_NAME_STYLE_ICONV" link="libenca-Typedefs-and-Constants.html#ENCA-NAME-STYLE-ICONV--CAPS"/> - <keyword type="constant" name="ENCA_NAME_STYLE_HUMAN" link="libenca-Typedefs-and-Constants.html#ENCA-NAME-STYLE-HUMAN--CAPS"/> - <keyword type="constant" name="ENCA_NAME_STYLE_MIME" link="libenca-Typedefs-and-Constants.html#ENCA-NAME-STYLE-MIME--CAPS"/> - <keyword type="constant" name="ENCA_EOK" link="libenca-Typedefs-and-Constants.html#ENCA-EOK--CAPS"/> - <keyword type="constant" name="ENCA_EINVALUE" link="libenca-Typedefs-and-Constants.html#ENCA-EINVALUE--CAPS"/> - <keyword type="constant" name="ENCA_EEMPTY" link="libenca-Typedefs-and-Constants.html#ENCA-EEMPTY--CAPS"/> - <keyword type="constant" name="ENCA_EFILTERED" link="libenca-Typedefs-and-Constants.html#ENCA-EFILTERED--CAPS"/> - <keyword type="constant" name="ENCA_ENOCS8" link="libenca-Typedefs-and-Constants.html#ENCA-ENOCS8--CAPS"/> - <keyword type="constant" name="ENCA_ESIGNIF" link="libenca-Typedefs-and-Constants.html#ENCA-ESIGNIF--CAPS"/> - <keyword type="constant" name="ENCA_EWINNER" link="libenca-Typedefs-and-Constants.html#ENCA-EWINNER--CAPS"/> - <keyword type="constant" name="ENCA_EGARBAGE" link="libenca-Typedefs-and-Constants.html#ENCA-EGARBAGE--CAPS"/> - </functions> -</book> diff --git a/lib/enca/devel-docs/html/right.png b/lib/enca/devel-docs/html/right.png Binary files differdeleted file mode 100644 index 92832e3a45..0000000000 --- a/lib/enca/devel-docs/html/right.png +++ /dev/null diff --git a/lib/enca/devel-docs/html/style.css b/lib/enca/devel-docs/html/style.css deleted file mode 100644 index bb44c28093..0000000000 --- a/lib/enca/devel-docs/html/style.css +++ /dev/null @@ -1,167 +0,0 @@ -.synopsis, .classsynopsis -{ - background: #eeeeee; - border: solid 1px #aaaaaa; - padding: 0.5em; -} -.programlisting -{ - background: #eeeeff; - border: solid 1px #aaaaff; - padding: 0.5em; -} -.variablelist -{ - padding: 4px; - margin-left: 3em; -} -.variablelist td:first-child -{ - vertical-align: top; -} - -/* this is needed so that the local anchors are displayed below the naviagtion */ -@media screen { - sup a.footnote - { - position: relative; - top: 0em ! important; - } - div.refnamediv a[name], div.refsect1 a[name] - { - position: relative; - top: -4.5em; - } - table.navigation#top - { - background: #ffeeee; - border: solid 1px #ffaaaa; - margin-top: 0; - margin-bottom: 0; - position: fixed; - top: 0; - left: 0; - height: 2em; - z-index: 1; - } - .navigation a - { - color: #770000; - } - .navigation a:visited - { - color: #550000; - } - td.shortcuts - { - color: #770000; - font-size: 80%; - white-space: nowrap; - } - div.refentry, div.chapter, div.reference, div.part, div.book, div.glossary, div.sect1, div.appendix, div.preface - { - position: relative; - top: 3em; - z-index: 0; - } - div.glossary, div.index - { - position: relative; - top: 2em; - z-index: 0; - } - div.refnamediv - { - margin-top: 2em; - } - body - { - padding-bottom: 20em; - } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - background: #ffeeee; - border: solid 1px #ffaaaa; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 2em; - } -} - -.navigation .title -{ - font-size: 200%; -} - - -div.gallery-float -{ - float: left; - padding: 10px; -} -div.gallery-float img -{ - border-style: none; -} -div.gallery-spacer -{ - clear: both; -} -a -{ - text-decoration: none; -} -a:hover -{ - text-decoration: underline; - color: #FF0000; -} - -div.table table -{ - border-collapse: collapse; - border-spacing: 0px; - border-style: solid; - border-color: #777777; - border-width: 1px; -} - -div.table table td, div.table table th -{ - border-style: solid; - border-color: #777777; - border-width: 1px; - padding: 3px; - vertical-align: top; -} - -div.table table th -{ - background-color: #eeeeee; -} - -hr -{ - color: #777777; - background: #777777; - border: 0; - height: 1px; - clear: both; -} - -.footer -{ - padding-top: 3.5em; - color: #777777; - text-align: center; - font-size: 80%; -} diff --git a/lib/enca/devel-docs/html/up.png b/lib/enca/devel-docs/html/up.png Binary files differdeleted file mode 100644 index 85b3e2a275..0000000000 --- a/lib/enca/devel-docs/html/up.png +++ /dev/null diff --git a/lib/enca/devel-docs/libenca-decl-list.txt b/lib/enca/devel-docs/libenca-decl-list.txt deleted file mode 100644 index dcdd9d2f0c..0000000000 --- a/lib/enca/devel-docs/libenca-decl-list.txt +++ /dev/null @@ -1,138 +0,0 @@ -<SECTION> -<FILE>internal</FILE> -ENCA_STMT_START -ENCA_STMT_END -EncaAnalyserOptions -EncaAnalyserState -EncaCharsetInfo -EncaLanguageInfo -EncaLanguageHookData1CS -EncaLanguageHookDataEOL -EncaUTFCheckData -EncaHookFunc -EncaGuessFunc -FILL_NONLETTER -EPSILON -LF -CR -enca_ctype_test -enca_isalnum -enca_isalpha -enca_iscntrl -enca_isdigit -enca_isgraph -enca_islower -enca_isprint -enca_ispunct -enca_isspace -enca_isupper -enca_isxdigit -enca_isname -enca_isbinary -enca_istext -ELEMENTS -enca_malloc -enca_realloc -enca_free -NEW -RENEW -MAKE_HOOK_LINE -enca_strdup -enca_strstr -enca_stpcpy -enca_csname -enca_strconcat -enca_strappend -enca_name_to_charset -enca_name_to_surface -enca_language_init -enca_language_destroy -enca_get_charset_similarity_matrix -enca_charsets_subset_identical -enca_filter_boxdraw -enca_language_hook_ncs -enca_language_hook_eol -enca_guess_init -enca_guess_destroy -enca_eol_surface -enca_find_max_sec -enca_double_utf8_init -enca_double_utf8_destroy -enca_pair_init -enca_pair_destroy -enca_pair_analyse -ENCA_LANGUAGE_BE -ENCA_LANGUAGE_BG -ENCA_LANGUAGE_CS -ENCA_LANGUAGE_ET -ENCA_LANGUAGE_HR -ENCA_LANGUAGE_HU -ENCA_LANGUAGE_LT -ENCA_LANGUAGE_LV -ENCA_LANGUAGE_PL -ENCA_LANGUAGE_RU -ENCA_LANGUAGE_SK -ENCA_LANGUAGE_SL -ENCA_LANGUAGE_UK -ENCA_LANGUAGE_ZH -</SECTION> - -<SECTION> -<FILE>enca</FILE> -EncaSurface -EncaNameStyle -EncaCharsetFlags -EncaErrno -ENCA_CS_UNKNOWN -ENCA_NOT_A_CHAR -EncaAnalyser -EncaEncoding -enca_analyser_alloc -enca_analyser_free -enca_analyse -enca_analyse_const -enca_double_utf8_check -enca_double_utf8_get_candidates -enca_errno -enca_strerror -enca_set_multibyte -enca_get_multibyte -enca_set_interpreted_surfaces -enca_get_interpreted_surfaces -enca_set_ambiguity -enca_get_ambiguity -enca_set_filtering -enca_get_filtering -enca_set_garbage_test -enca_get_garbage_test -enca_set_termination_strictness -enca_get_termination_strictness -enca_set_significant -enca_get_significant -enca_set_threshold -enca_get_threshold -enca_charset_name -enca_get_charset_aliases -enca_get_surface_name -enca_parse_encoding_name -enca_charset_natural_surface -enca_charset_properties -enca_charset_is_known -enca_charset_is_7bit -enca_charset_is_8bit -enca_charset_is_16bit -enca_charset_is_32bit -enca_charset_is_fixed -enca_charset_is_variable -enca_charset_is_binary -enca_charset_is_regular -enca_charset_is_multibyte -enca_charset_has_ucs2_map -enca_charset_ucs2_map -enca_number_of_charsets -enca_analyser_language -enca_language_english_name -enca_get_languages -enca_get_language_charsets -</SECTION> - diff --git a/lib/enca/devel-docs/libenca-decl.txt b/lib/enca/devel-docs/libenca-decl.txt deleted file mode 100644 index 9dc36da8b6..0000000000 --- a/lib/enca/devel-docs/libenca-decl.txt +++ /dev/null @@ -1,755 +0,0 @@ -<MACRO> -<NAME>ENCA_STMT_START</NAME> -#define ENCA_STMT_START do -</MACRO> -<MACRO> -<NAME>ENCA_STMT_END</NAME> -#define ENCA_STMT_END while (0) -</MACRO> -<STRUCT> -<NAME>EncaAnalyserOptions</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaAnalyserState</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaCharsetInfo</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaLanguageInfo</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaLanguageHookData1CS</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaLanguageHookDataEOL</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaUTFCheckData</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaCharsetInfo</NAME> -struct _EncaCharsetInfo { - int enca; - int rfc1345; - int cstocs; - int iconv; - int mime; - const char *human; - unsigned int flags; - unsigned int nsurface; -}; -</STRUCT> -<USER_FUNCTION> -<NAME>EncaHookFunc</NAME> -<RETURNS>int </RETURNS> -EncaAnalyserState *analyser -</USER_FUNCTION> -<USER_FUNCTION> -<NAME>EncaGuessFunc</NAME> -<RETURNS>int </RETURNS> -EncaAnalyserState *analyser -</USER_FUNCTION> -<STRUCT> -<NAME>EncaLanguageInfo</NAME> -struct _EncaLanguageInfo { - const char *name; - const char *humanname; - size_t ncharsets; - const char *const *csnames; - const unsigned short int *const *weights; - const unsigned short int *significant; - const unsigned char *const *letters; - const unsigned char **const *pairs; - long int weight_sum; - EncaHookFunc hook; - EncaHookFunc eolhook; - EncaHookFunc lcuchook; - EncaHookFunc ratinghook; -}; -</STRUCT> -<STRUCT> -<NAME>EncaAnalyserOptions</NAME> -struct _EncaAnalyserOptions { - int const_buffer; - size_t min_chars; - double threshold; - int multibyte_enabled; - int interpreted_surfaces; - int ambiguous_mode; - int filtering; - int test_garbageness; - int termination_strictness; -}; -</STRUCT> -<STRUCT> -<NAME>EncaAnalyserState</NAME> -struct _EncaAnalyserState { - /* Language data. */ - const EncaLanguageInfo *lang; - size_t ncharsets; - int *charsets; - /* Analyser state. */ - EncaErrno gerrno; - size_t size; - unsigned char *buffer; - EncaEncoding result; - size_t *counts; - size_t bin; - size_t up; - double *ratings; - size_t *order; - size_t size2; - unsigned char *buffer2; - /* Double-UTF-8 data. */ - EncaUTFCheckData *utfch; - int *utfbuf; - /* Pair frequency data */ - unsigned char *pair2bits; - size_t *bitcounts; - size_t *pairratings; - /* LCUC data XXX: unused (yet) */ - size_t *lcbits; - size_t *ucbits; - /* Options. */ - EncaAnalyserOptions options; -}; -</STRUCT> -<STRUCT> -<NAME>EncaLanguageHookData1CS</NAME> -struct _EncaLanguageHookData1CS { - const char *name; - size_t size; - const unsigned char *list; - size_t cs; -}; -</STRUCT> -<STRUCT> -<NAME>EncaLanguageHookDataEOL</NAME> -struct _EncaLanguageHookDataEOL { - const char *name; - EncaSurface eol; - size_t cs; -}; -</STRUCT> -<STRUCT> -<NAME>EncaUTFCheckData</NAME> -struct _EncaUTFCheckData { - double rating; - size_t size; - int result; - int *ucs2; - int *weights; -}; -</STRUCT> -<MACRO> -<NAME>FILL_NONLETTER</NAME> -#define FILL_NONLETTER '.' -</MACRO> -<MACRO> -<NAME>EPSILON</NAME> -#define EPSILON 0.000001 -</MACRO> -<MACRO> -<NAME>LF</NAME> -#define LF ((unsigned char)'\n') -</MACRO> -<MACRO> -<NAME>CR</NAME> -#define CR ((unsigned char)'\r') -</MACRO> -<MACRO> -<NAME>enca_ctype_test</NAME> -#define enca_ctype_test(c, t) ((enca_ctype_data[(unsigned char)c] & t) != 0) -</MACRO> -<MACRO> -<NAME>enca_isalnum</NAME> -#define enca_isalnum(c) enca_ctype_test((c), ENCA_CTYPE_ALNUM) -</MACRO> -<MACRO> -<NAME>enca_isalpha</NAME> -#define enca_isalpha(c) enca_ctype_test((c), ENCA_CTYPE_ALPHA) -</MACRO> -<MACRO> -<NAME>enca_iscntrl</NAME> -#define enca_iscntrl(c) enca_ctype_test((c), ENCA_CTYPE_CNTRL) -</MACRO> -<MACRO> -<NAME>enca_isdigit</NAME> -#define enca_isdigit(c) enca_ctype_test((c), ENCA_CTYPE_DIGIT) -</MACRO> -<MACRO> -<NAME>enca_isgraph</NAME> -#define enca_isgraph(c) enca_ctype_test((c), ENCA_CTYPE_GRAPH) -</MACRO> -<MACRO> -<NAME>enca_islower</NAME> -#define enca_islower(c) enca_ctype_test((c), ENCA_CTYPE_LOWER) -</MACRO> -<MACRO> -<NAME>enca_isprint</NAME> -#define enca_isprint(c) enca_ctype_test((c), ENCA_CTYPE_PRINT) -</MACRO> -<MACRO> -<NAME>enca_ispunct</NAME> -#define enca_ispunct(c) enca_ctype_test((c), ENCA_CTYPE_PUNCT) -</MACRO> -<MACRO> -<NAME>enca_isspace</NAME> -#define enca_isspace(c) enca_ctype_test((c), ENCA_CTYPE_SPACE) -</MACRO> -<MACRO> -<NAME>enca_isupper</NAME> -#define enca_isupper(c) enca_ctype_test((c), ENCA_CTYPE_UPPER) -</MACRO> -<MACRO> -<NAME>enca_isxdigit</NAME> -#define enca_isxdigit(c) enca_ctype_test((c), ENCA_CTYPE_XDIGIT) -</MACRO> -<MACRO> -<NAME>enca_isname</NAME> -#define enca_isname(c) enca_ctype_test((c), ENCA_CTYPE_NAME) -</MACRO> -<MACRO> -<NAME>enca_isbinary</NAME> -#define enca_isbinary(c) enca_ctype_test((c), ENCA_CTYPE_BINARY) -</MACRO> -<MACRO> -<NAME>enca_istext</NAME> -#define enca_istext(c) enca_ctype_test((c), ENCA_CTYPE_TEXT) -</MACRO> -<MACRO> -<NAME>ELEMENTS</NAME> -#define ELEMENTS(array) (sizeof(array)/sizeof((array)[0])) -</MACRO> -<FUNCTION> -<NAME>enca_malloc</NAME> -<RETURNS>void*</RETURNS> -size_t size -</FUNCTION> -<FUNCTION> -<NAME>enca_realloc</NAME> -<RETURNS>void*</RETURNS> -void *ptr,size_t size -</FUNCTION> -<MACRO> -<NAME>enca_free</NAME> -#define enca_free(ptr) \ - ENCA_STMT_START{ if (ptr) free(ptr); ptr=NULL; }ENCA_STMT_END -</MACRO> -<MACRO> -<NAME>NEW</NAME> -#define NEW(type,n) ((type*)enca_malloc((n)*sizeof(type))) -</MACRO> -<MACRO> -<NAME>RENEW</NAME> -#define RENEW(ptr,type,n) ((type*)enca_realloc((ptr),(n)*sizeof(type))) -</MACRO> -<MACRO> -<NAME>MAKE_HOOK_LINE</NAME> -#define MAKE_HOOK_LINE(name) \ - { #name, ELEMENTS(list_##name), list_##name, (size_t)-1 } -</MACRO> -<FUNCTION> -<NAME>enca_strdup</NAME> -<RETURNS>char*</RETURNS> -const char *s -</FUNCTION> -<FUNCTION> -<NAME>enca_strstr</NAME> -<RETURNS>const char*</RETURNS> -const char *haystack,const char* needle -</FUNCTION> -<MACRO> -<NAME>enca_strstr</NAME> -# define enca_strstr strstr -</MACRO> -<FUNCTION> -<NAME>enca_stpcpy</NAME> -<RETURNS>char*</RETURNS> -char *dest,const char *src -</FUNCTION> -<MACRO> -<NAME>enca_stpcpy</NAME> -# define enca_stpcpy stpcpy -</MACRO> -<MACRO> -<NAME>enca_csname</NAME> -#define enca_csname(cs) enca_charset_name((cs), ENCA_NAME_STYLE_ENCA) -</MACRO> -<FUNCTION> -<NAME>enca_strconcat</NAME> -<RETURNS>char*</RETURNS> -const char *str,... -</FUNCTION> -<FUNCTION> -<NAME>enca_strappend</NAME> -<RETURNS>char*</RETURNS> -char *str,... -</FUNCTION> -<FUNCTION> -<NAME>enca_name_to_charset</NAME> -<RETURNS>int </RETURNS> -const char *csname -</FUNCTION> -<FUNCTION> -<NAME>enca_name_to_surface</NAME> -<RETURNS>EncaSurface </RETURNS> -const char *sname -</FUNCTION> -<FUNCTION> -<NAME>enca_language_init</NAME> -<RETURNS>int </RETURNS> -EncaAnalyserState *analyser,const char *langname -</FUNCTION> -<FUNCTION> -<NAME>enca_language_destroy</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_get_charset_similarity_matrix</NAME> -<RETURNS>double*</RETURNS> -const EncaLanguageInfo *lang -</FUNCTION> -<FUNCTION> -<NAME>enca_charsets_subset_identical</NAME> -<RETURNS>int </RETURNS> -int charset1,int charset2,const size_t *counts -</FUNCTION> -<FUNCTION> -<NAME>enca_filter_boxdraw</NAME> -<RETURNS>size_t </RETURNS> -EncaAnalyserState *analyser,unsigned char fill_char -</FUNCTION> -<FUNCTION> -<NAME>enca_language_hook_ncs</NAME> -<RETURNS>int </RETURNS> -EncaAnalyserState *analyser,size_t ncs,EncaLanguageHookData1CS *hookdata -</FUNCTION> -<FUNCTION> -<NAME>enca_language_hook_eol</NAME> -<RETURNS>int </RETURNS> -EncaAnalyserState *analyser,size_t ncs,EncaLanguageHookDataEOL *hookdata -</FUNCTION> -<FUNCTION> -<NAME>enca_guess_init</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_guess_destroy</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_eol_surface</NAME> -<RETURNS>EncaSurface </RETURNS> -const unsigned char *buffer,size_t size,const size_t *counts -</FUNCTION> -<FUNCTION> -<NAME>enca_find_max_sec</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_double_utf8_init</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_double_utf8_destroy</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_pair_init</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_pair_destroy</NAME> -<RETURNS>void </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_pair_analyse</NAME> -<RETURNS>int </RETURNS> -EncaAnalyserState *analyser -</FUNCTION> -<VARIABLE> -<NAME>ENCA_LANGUAGE_BE</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_BE; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_BG</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_BG; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_CS</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_CS; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_ET</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_ET; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_HR</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_HR; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_HU</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_HU; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_LT</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_LT; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_LV</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_LV; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_PL</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_PL; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_RU</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_RU; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_SK</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_SK; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_SL</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_SL; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_UK</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_UK; -</VARIABLE> -<VARIABLE> -<NAME>ENCA_LANGUAGE_ZH</NAME> -extern const EncaLanguageInfo ENCA_LANGUAGE_ZH; -</VARIABLE> -<ENUM> -<NAME>EncaSurface</NAME> -typedef enum { /*< flags >*/ - ENCA_SURFACE_EOL_CR = 1 << 0, - ENCA_SURFACE_EOL_LF = 1 << 1, - ENCA_SURFACE_EOL_CRLF = 1 << 2, - ENCA_SURFACE_EOL_MIX = 1 << 3, - ENCA_SURFACE_EOL_BIN = 1 << 4, - ENCA_SURFACE_MASK_EOL = (ENCA_SURFACE_EOL_CR - | ENCA_SURFACE_EOL_LF - | ENCA_SURFACE_EOL_CRLF - | ENCA_SURFACE_EOL_MIX - | ENCA_SURFACE_EOL_BIN), - ENCA_SURFACE_PERM_21 = 1 << 5, - ENCA_SURFACE_PERM_4321 = 1 << 6, - ENCA_SURFACE_PERM_MIX = 1 << 7, - ENCA_SURFACE_MASK_PERM = (ENCA_SURFACE_PERM_21 - | ENCA_SURFACE_PERM_4321 - | ENCA_SURFACE_PERM_MIX), - ENCA_SURFACE_QP = 1 << 8, - ENCA_SURFACE_REMOVE = 1 << 13, - ENCA_SURFACE_UNKNOWN = 1 << 14, - ENCA_SURFACE_MASK_ALL = (ENCA_SURFACE_MASK_EOL - | ENCA_SURFACE_MASK_PERM - | ENCA_SURFACE_QP - | ENCA_SURFACE_REMOVE) -} EncaSurface; -</ENUM> -<ENUM> -<NAME>EncaNameStyle</NAME> -typedef enum { - ENCA_NAME_STYLE_ENCA, - ENCA_NAME_STYLE_RFC1345, - ENCA_NAME_STYLE_CSTOCS, - ENCA_NAME_STYLE_ICONV, - ENCA_NAME_STYLE_HUMAN, - ENCA_NAME_STYLE_MIME -} EncaNameStyle; -</ENUM> -<ENUM> -<NAME>EncaCharsetFlags</NAME> -typedef enum { /*< flags >*/ - ENCA_CHARSET_7BIT = 1 << 0, - ENCA_CHARSET_8BIT = 1 << 1, - ENCA_CHARSET_16BIT = 1 << 2, - ENCA_CHARSET_32BIT = 1 << 3, - ENCA_CHARSET_FIXED = 1 << 4, - ENCA_CHARSET_VARIABLE = 1 << 5, - ENCA_CHARSET_BINARY = 1 << 6, - ENCA_CHARSET_REGULAR = 1 << 7, - ENCA_CHARSET_MULTIBYTE = 1 << 8 -} EncaCharsetFlags; -</ENUM> -<ENUM> -<NAME>EncaErrno</NAME> -typedef enum { - ENCA_EOK = 0, - ENCA_EINVALUE, - ENCA_EEMPTY, - ENCA_EFILTERED, - ENCA_ENOCS8, - ENCA_ESIGNIF, - ENCA_EWINNER, - ENCA_EGARBAGE -} EncaErrno; -</ENUM> -<MACRO> -<NAME>ENCA_CS_UNKNOWN</NAME> -#define ENCA_CS_UNKNOWN (-1) -</MACRO> -<MACRO> -<NAME>ENCA_NOT_A_CHAR</NAME> -#define ENCA_NOT_A_CHAR 0xffff -</MACRO> -<TYPEDEF> -<NAME>EncaAnalyser</NAME> -typedef struct _EncaAnalyserState *EncaAnalyser; -</TYPEDEF> -<STRUCT> -<NAME>EncaEncoding</NAME> -</STRUCT> -<STRUCT> -<NAME>EncaEncoding</NAME> -struct _EncaEncoding { int charset; EncaSurface surface; }; -</STRUCT> -<FUNCTION> -<NAME>enca_analyser_alloc</NAME> -<RETURNS>EncaAnalyser </RETURNS> -const char *langname -</FUNCTION> -<FUNCTION> -<NAME>enca_analyser_free</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_analyse</NAME> -<RETURNS>EncaEncoding </RETURNS> -EncaAnalyser analyser,unsigned char *buffer,size_t size -</FUNCTION> -<FUNCTION> -<NAME>enca_analyse_const</NAME> -<RETURNS>EncaEncoding </RETURNS> -EncaAnalyser analyser,const unsigned char *buffer,size_t size -</FUNCTION> -<FUNCTION> -<NAME>enca_double_utf8_check</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser,const unsigned char *buffer,size_t size -</FUNCTION> -<FUNCTION> -<NAME>enca_double_utf8_get_candidates</NAME> -<RETURNS>int*</RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_errno</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_strerror</NAME> -<RETURNS>const char*</RETURNS> -EncaAnalyser analyser,int errnum -</FUNCTION> -<FUNCTION> -<NAME>enca_set_multibyte</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser,int multibyte -</FUNCTION> -<FUNCTION> -<NAME>enca_get_multibyte</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_interpreted_surfaces</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser,int interpreted_surfaces -</FUNCTION> -<FUNCTION> -<NAME>enca_get_interpreted_surfaces</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_ambiguity</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser,int ambiguity -</FUNCTION> -<FUNCTION> -<NAME>enca_get_ambiguity</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_filtering</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser,int filtering -</FUNCTION> -<FUNCTION> -<NAME>enca_get_filtering</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_garbage_test</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser,int garabage_test -</FUNCTION> -<FUNCTION> -<NAME>enca_get_garbage_test</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_termination_strictness</NAME> -<RETURNS>void </RETURNS> -EncaAnalyser analyser,int termination_strictness -</FUNCTION> -<FUNCTION> -<NAME>enca_get_termination_strictness</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_significant</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser,size_t significant -</FUNCTION> -<FUNCTION> -<NAME>enca_get_significant</NAME> -<RETURNS>size_t </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_set_threshold</NAME> -<RETURNS>int </RETURNS> -EncaAnalyser analyser,double threshold -</FUNCTION> -<FUNCTION> -<NAME>enca_get_threshold</NAME> -<RETURNS>double </RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_charset_name</NAME> -<RETURNS>const char*</RETURNS> -int charset,EncaNameStyle whatname -</FUNCTION> -<FUNCTION> -<NAME>enca_get_charset_aliases</NAME> -<RETURNS>const char**</RETURNS> -int charset,size_t *n -</FUNCTION> -<FUNCTION> -<NAME>enca_get_surface_name</NAME> -<RETURNS>char*</RETURNS> -EncaSurface surface,EncaNameStyle whatname -</FUNCTION> -<FUNCTION> -<NAME>enca_parse_encoding_name</NAME> -<RETURNS>EncaEncoding </RETURNS> -const char *name -</FUNCTION> -<FUNCTION> -<NAME>enca_charset_natural_surface</NAME> -<RETURNS>EncaSurface </RETURNS> -int charset -</FUNCTION> -<FUNCTION> -<NAME>enca_charset_properties</NAME> -<RETURNS>EncaCharsetFlags </RETURNS> -int charset -</FUNCTION> -<MACRO> -<NAME>enca_charset_is_known</NAME> -#define enca_charset_is_known(cs) \ - ((cs) != ENCA_CS_UNKNOWN) -</MACRO> -<MACRO> -<NAME>enca_charset_is_7bit</NAME> -#define enca_charset_is_7bit(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_7BIT) -</MACRO> -<MACRO> -<NAME>enca_charset_is_8bit</NAME> -#define enca_charset_is_8bit(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_8BIT) -</MACRO> -<MACRO> -<NAME>enca_charset_is_16bit</NAME> -#define enca_charset_is_16bit(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_16BIT) -</MACRO> -<MACRO> -<NAME>enca_charset_is_32bit</NAME> -#define enca_charset_is_32bit(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_32BIT) -</MACRO> -<MACRO> -<NAME>enca_charset_is_fixed</NAME> -#define enca_charset_is_fixed(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_FIXED) -</MACRO> -<MACRO> -<NAME>enca_charset_is_variable</NAME> -#define enca_charset_is_variable(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_VARIABLE) -</MACRO> -<MACRO> -<NAME>enca_charset_is_binary</NAME> -#define enca_charset_is_binary(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_BINARY) -</MACRO> -<MACRO> -<NAME>enca_charset_is_regular</NAME> -#define enca_charset_is_regular(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_REGULAR) -</MACRO> -<MACRO> -<NAME>enca_charset_is_multibyte</NAME> -#define enca_charset_is_multibyte(cs) \ - (enca_charset_properties(cs) & ENCA_CHARSET_MULTIBYTE) -</MACRO> -<FUNCTION> -<NAME>enca_charset_has_ucs2_map</NAME> -<RETURNS>int </RETURNS> -int charset -</FUNCTION> -<FUNCTION> -<NAME>enca_charset_ucs2_map</NAME> -<RETURNS>int </RETURNS> -int charset,unsigned int *buffer -</FUNCTION> -<FUNCTION> -<NAME>enca_number_of_charsets</NAME> -<RETURNS>size_t </RETURNS> -void -</FUNCTION> -<FUNCTION> -<NAME>enca_analyser_language</NAME> -<RETURNS>const char*</RETURNS> -EncaAnalyser analyser -</FUNCTION> -<FUNCTION> -<NAME>enca_language_english_name</NAME> -<RETURNS>const char*</RETURNS> -const char *lang -</FUNCTION> -<FUNCTION> -<NAME>enca_get_languages</NAME> -<RETURNS>const char**</RETURNS> -size_t *n -</FUNCTION> -<FUNCTION> -<NAME>enca_get_language_charsets</NAME> -<RETURNS>int*</RETURNS> -const char *langname,size_t *n -</FUNCTION> diff --git a/lib/enca/devel-docs/libenca-docs.sgml b/lib/enca/devel-docs/libenca-docs.sgml deleted file mode 100644 index d4578d85a8..0000000000 --- a/lib/enca/devel-docs/libenca-docs.sgml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude"> - <bookinfo> - <title>Enca Library Reference Manual</title> - </bookinfo> - - <chapter> - <title>Enca Library API</title> - <xi:include href="xml/analyser.xml"/> - <xi:include href="xml/enums.xml"/> - <xi:include href="xml/encodings.xml"/> - <xi:include href="xml/auxiliary.xml"/> - </chapter> - -<!-- - <chapter> - <title>Enca Library Internal Functions</title> - <xi:include href="xml/internal.xml"/> - </chapter> ---> -</book> diff --git a/lib/enca/devel-docs/libenca-overrides.txt b/lib/enca/devel-docs/libenca-overrides.txt deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/enca/devel-docs/libenca-overrides.txt +++ /dev/null diff --git a/lib/enca/devel-docs/libenca-sections.txt b/lib/enca/devel-docs/libenca-sections.txt deleted file mode 100644 index 62c4c15891..0000000000 --- a/lib/enca/devel-docs/libenca-sections.txt +++ /dev/null @@ -1,136 +0,0 @@ -<SECTION> -<FILE>enums</FILE> -<TITLE>Typedefs and Constants</TITLE> -EncaEncoding -ENCA_CS_UNKNOWN -EncaSurface -EncaCharsetFlags -EncaNameStyle -EncaErrno -ENCA_NOT_A_CHAR -</SECTION> - -<SECTION> -<FILE>analyser</FILE> -<TITLE>Analyser</TITLE> -enca_analyser_alloc -enca_analyser_free -enca_analyse -enca_analyse_const -enca_errno -enca_strerror -enca_double_utf8_check -enca_double_utf8_get_candidates -enca_set_multibyte -enca_get_multibyte -enca_set_interpreted_surfaces -enca_get_interpreted_surfaces -enca_set_ambiguity -enca_get_ambiguity -enca_set_filtering -enca_get_filtering -enca_set_garbage_test -enca_get_garbage_test -enca_set_termination_strictness -enca_get_termination_strictness -enca_set_significant -enca_get_significant -enca_set_threshold -enca_get_threshold -</SECTION> - -<SECTION> -<FILE>encodings</FILE> -<TITLE>Charsets and Surfaces</TITLE> -enca_charset_name -enca_get_charset_aliases -enca_get_surface_name -enca_parse_encoding_name -enca_charset_natural_surface -enca_charset_properties -enca_charset_is_7bit -enca_charset_is_8bit -enca_charset_is_16bit -enca_charset_is_32bit -enca_charset_is_fixed -enca_charset_is_variable -enca_charset_is_binary -enca_charset_is_regular -enca_charset_is_multibyte -enca_charset_is_known -</SECTION> - -<SECTION> -<FILE>auxiliary</FILE> -<TITLE>Auxiliary Functions</TITLE> -enca_charset_has_ucs2_map -enca_charset_ucs2_map -enca_number_of_charsets -enca_analyser_language -enca_get_languages -enca_language_english_name -enca_get_language_charsets -</SECTION> - -<SECTION> -<FILE>internal</FILE> -<TITLE>Internal Functions</TITLE> -EncaAnalyserOptions -EncaAnalyserState -EncaCharsetInfo -EncaLanguageInfo -EncaLanguageHookData1CS -EncaLanguageHookDataEOL -EncaHookFunc -EncaGuessFunc -EncaUTFCheckData -ELEMENTS -MAKE_HOOK_LINE -EPSILON -FILL_NONLETTER -LF -CR -enca_malloc -enca_realloc -enca_free -NEW -RENEW -enca_strdup -enca_strstr -enca_stpcpy -enca_strconcat -enca_strappend -enca_csname -enca_name_to_charset -enca_name_to_surface -enca_language_init -enca_language_destroy -enca_get_charset_similarity_matrix -enca_charsets_subset_identical -enca_filter_boxdraw -enca_language_hook_ncs -enca_language_hook_eol -enca_guess_init -enca_guess_destroy -enca_eol_surface -enca_find_max_sec -ENCA_LANGUAGE_BE -ENCA_LANGUAGE_BG -ENCA_LANGUAGE_CS -ENCA_LANGUAGE_ET -ENCA_LANGUAGE_HR -ENCA_LANGUAGE_HU -ENCA_LANGUAGE_LT -ENCA_LANGUAGE_LV -ENCA_LANGUAGE_PL -ENCA_LANGUAGE_RU -ENCA_LANGUAGE_SK -ENCA_LANGUAGE_SL -ENCA_LANGUAGE_UK -enca_double_utf8_init -enca_double_utf8_destroy -enca_pair_init -enca_pair_destroy -enca_pair_analyse -</SECTION> - diff --git a/lib/enca/devel-docs/libenca-undeclared.txt b/lib/enca/devel-docs/libenca-undeclared.txt deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/enca/devel-docs/libenca-undeclared.txt +++ /dev/null diff --git a/lib/enca/devel-docs/libenca-undocumented.txt b/lib/enca/devel-docs/libenca-undocumented.txt deleted file mode 100644 index 82db84bb5b..0000000000 --- a/lib/enca/devel-docs/libenca-undocumented.txt +++ /dev/null @@ -1,13 +0,0 @@ -98% symbol docs coverage. -178 symbols documented. -1 symbols incomplete. -4 not documented. - - -EncaLanguageInfo (lcuchook) -count_bits - - -auxiliary:Long_Description -encodings:Long_Description -enums:Long_Description 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: - diff --git a/lib/enca/devel-docs/xml/analyser.xml b/lib/enca/devel-docs/xml/analyser.xml deleted file mode 100644 index 480d775bdc..0000000000 --- a/lib/enca/devel-docs/xml/analyser.xml +++ /dev/null @@ -1,697 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<refentry id="libenca-Analyser"> -<refmeta> -<refentrytitle role="top_of_page" id="libenca-Analyser.top_of_page">Analyser</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo>LIBENCA Library</refmiscinfo> -</refmeta> - -<refnamediv> -<refname>Analyser</refname> -<refpurpose>Basic analyser interface.</refpurpose> -</refnamediv> - -<refsynopsisdiv id="libenca-Analyser.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -<link linkend="EncaAnalyser">EncaAnalyser</link> <link linkend="enca-analyser-alloc">enca_analyser_alloc</link> (const <link linkend="char">char</link> *langname); -<link linkend="void">void</link> <link linkend="enca-analyser-free">enca_analyser_free</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="EncaEncoding">EncaEncoding</link> <link linkend="enca-analyse">enca_analyse</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size); -<link linkend="EncaEncoding">EncaEncoding</link> <link linkend="enca-analyse-const">enca_analyse_const</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size); -<link linkend="int">int</link> <link linkend="enca-errno">enca_errno</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -const <link linkend="char">char</link>* <link linkend="enca-strerror">enca_strerror</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> errnum); -<link linkend="int">int</link> <link linkend="enca-double-utf8-check">enca_double_utf8_check</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size); -<link linkend="int">int</link>* <link linkend="enca-double-utf8-get-candidates">enca_double_utf8_get_candidates</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="void">void</link> <link linkend="enca-set-multibyte">enca_set_multibyte</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> multibyte); -<link linkend="int">int</link> <link linkend="enca-get-multibyte">enca_get_multibyte</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="void">void</link> <link linkend="enca-set-interpreted-surfaces">enca_set_interpreted_surfaces</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> interpreted_surfaces); -<link linkend="int">int</link> <link linkend="enca-get-interpreted-surfaces">enca_get_interpreted_surfaces</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="void">void</link> <link linkend="enca-set-ambiguity">enca_set_ambiguity</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> ambiguity); -<link linkend="int">int</link> <link linkend="enca-get-ambiguity">enca_get_ambiguity</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="void">void</link> <link linkend="enca-set-filtering">enca_set_filtering</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> filtering); -<link linkend="int">int</link> <link linkend="enca-get-filtering">enca_get_filtering</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="void">void</link> <link linkend="enca-set-garbage-test">enca_set_garbage_test</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> garabage_test); -<link linkend="int">int</link> <link linkend="enca-get-garbage-test">enca_get_garbage_test</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="void">void</link> <link linkend="enca-set-termination-strictness">enca_set_termination_strictness</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> termination_strictness); -<link linkend="int">int</link> <link linkend="enca-get-termination-strictness">enca_get_termination_strictness</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="int">int</link> <link linkend="enca-set-significant">enca_set_significant</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="size-t">size_t</link> significant); -<link linkend="size-t">size_t</link> <link linkend="enca-get-significant">enca_get_significant</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -<link linkend="int">int</link> <link linkend="enca-set-threshold">enca_set_threshold</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="double">double</link> threshold); -<link linkend="double">double</link> <link linkend="enca-get-threshold">enca_get_threshold</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -</synopsis> -</refsynopsisdiv> - - - - - - - - - -<refsect1 id="libenca-Analyser.description" role="desc"> -<title role="desc.title">Description</title> -<para> -Basically you want to allocate an analyser with <link linkend="enca-analyser-alloc"><function>enca_analyser_alloc()</function></link> for some -language, use <link linkend="enca-analyse"><function>enca_analyse()</function></link> (or <link linkend="enca-analyse-const"><function>enca_analyse_const()</function></link>) on a buffer to find its -encoding, and interpret the results with something like <link linkend="enca-charset-name"><function>enca_charset_name()</function></link>. -The analyser then can be used for another buffer. Once you no longer need -it, call <link linkend="enca-analyser-free"><function>enca_analyser_free()</function></link> 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 <link linkend="enca-set-termination-strictness"><function>enca_set_termination_strictness()</function></link>. -</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> -</refsect1> - -<refsect1 id="libenca-Analyser.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="enca-analyser-alloc" role="function"> -<title>enca_analyser_alloc ()</title> -<indexterm zone="enca-analyser-alloc"><primary sortas="enca_analyser_alloc">enca_analyser_alloc</primary></indexterm><programlisting><link linkend="EncaAnalyser">EncaAnalyser</link> enca_analyser_alloc (const <link linkend="char">char</link> *langname);</programlisting> -<para> -Allocates an analyser and initializes it for language <parameter>language</parameter>. -</para> -<para> -The analyser, once crerated, can be used only for language for which it -was initialized. If you need to detect encodings of texts in more than one -language, you must allocate an analyser for each one. Note however, an -analyser may occupy a considerable amount of memory (a few hundreds of kB), -so it's generally not a good idea to have several hundreds of them floating -around. -</para> -<para> -<parameter>langname</parameter> is two-letter ISO 639:1989 language code. Locale names in form -language_territory and ISO-639 English language names also may be accepted -in the future. To be on the safe side, use only names returned by -<link linkend="enca-get-languages"><function>enca_get_languages()</function></link>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>langname</parameter> :</term> -<listitem><simpara> Language for which the analyser should be initialized. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created <link linkend="EncaAnalyser"><type>EncaAnalyser</type></link> on success, <link linkend="NULL--CAPS"><type>NULL</type></link> on failure - (namely when <parameter>langname</parameter> is unknown or otherwise invalid). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-analyser-free" role="function"> -<title>enca_analyser_free ()</title> -<indexterm zone="enca-analyser-free"><primary sortas="enca_analyser_free">enca_analyser_free</primary></indexterm><programlisting><link linkend="void">void</link> enca_analyser_free (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Frees memory used by <link linkend="EncaAnalyser"><type>EncaAnalyser</type></link> <parameter>analyser</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser to be destroyed. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-analyse" role="function"> -<title>enca_analyse ()</title> -<indexterm zone="enca-analyse"><primary sortas="enca_analyse">enca_analyse</primary></indexterm><programlisting><link linkend="EncaEncoding">EncaEncoding</link> enca_analyse (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size);</programlisting> -<para> -Analyses <parameter>buffer</parameter> and finds its encoding. -</para> -<para> -The <parameter>buffer</parameter> is checked for 8bit encodings of language for which <parameter>analyser</parameter> -was initialized and for multibyte encodings, mostly independent on language -(unless disabled with <link linkend="enca-set-multibyte"><function>enca_set_multibyte()</function></link>). -</para> -<para> -The contents of <parameter>buffer</parameter> may be (and probably will be) modified during the -analyse. Use <link linkend="enca-analyse-const"><function>enca_analyse_const()</function></link> instead if this discomforts you.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser initialized for some language. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>buffer</parameter> :</term> -<listitem><simpara> Buffer to be analysed. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>size</parameter> :</term> -<listitem><simpara> Size of <parameter>buffer</parameter>. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Encoding of <parameter>buffer</parameter>. When charset part of return value is - <link linkend="ENCA-CS-UNKNOWN--CAPS"><type>ENCA_CS_UNKNOWN</type></link>, encoding was not determined. Check - <link linkend="enca-errno"><function>enca_errno()</function></link> for reason. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-analyse-const" role="function"> -<title>enca_analyse_const ()</title> -<indexterm zone="enca-analyse-const"><primary sortas="enca_analyse_const">enca_analyse_const</primary></indexterm><programlisting><link linkend="EncaEncoding">EncaEncoding</link> enca_analyse_const (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size);</programlisting> -<para> -Analyses <parameter>buffer</parameter> and finds its encoding. -</para> -<para> -The <parameter>buffer</parameter> is checked for 8bit encodings of language for which <parameter>analyser</parameter> -was initialized and for multibyte encodings, mostly independent on language -(unless disabled with <link linkend="enca-set-multibyte"><function>enca_set_multibyte()</function></link>). -</para> -<para> -This function never modifies <parameter>buffer</parameter> (can be even used with string literal -<parameter>buffer</parameter>) at the expense it's generally slower than <link linkend="enca-analyse"><function>enca_analyse()</function></link>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser initialized for some language. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>buffer</parameter> :</term> -<listitem><simpara> Buffer to be analysed. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>size</parameter> :</term> -<listitem><simpara> Size of <parameter>buffer</parameter>. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Encoding of <parameter>buffer</parameter>. When charset part of return value is - <link linkend="ENCA-CS-UNKNOWN--CAPS"><type>ENCA_CS_UNKNOWN</type></link>, encoding was not determined. Check - <link linkend="enca-errno"><function>enca_errno()</function></link> for reason. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-errno" role="function"> -<title>enca_errno ()</title> -<indexterm zone="enca-errno"><primary sortas="enca_errno">enca_errno</primary></indexterm><programlisting><link linkend="int">int</link> enca_errno (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns analyser error code. -</para> -<para> -The error code is not modified. However, any other analyser call i.e. -call to a function taking <parameter>analyser</parameter> as parameter can change the error code.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Error code of reason why last analyser call failed. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-strerror" role="function"> -<title>enca_strerror ()</title> -<indexterm zone="enca-strerror"><primary sortas="enca_strerror">enca_strerror</primary></indexterm><programlisting>const <link linkend="char">char</link>* enca_strerror (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> errnum);</programlisting> -<para> -Returns string describing the error code. -</para> -<para> -The returned string must be considered constant and must NOT be freed. -It is however gauranteed not to be modified on invalidated by subsequent -calls to any libenca functions, including <link linkend="enca-strerror"><function>enca_strerror()</function></link>. -</para> -<para> -The analyser error code is not changed for a successful call, and it set -to <link linkend="ENCA-EINVALUE--CAPS"><type>ENCA_EINVALUE</type></link> upon error.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>errnum</parameter> :</term> -<listitem><simpara> An analyser error code. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> String describing the error code. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-double-utf8-check" role="function"> -<title>enca_double_utf8_check ()</title> -<indexterm zone="enca-double-utf8-check"><primary sortas="enca_double_utf8_check">enca_double_utf8_check</primary></indexterm><programlisting><link linkend="int">int</link> enca_double_utf8_check (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size);</programlisting> -<para> -Checks buffer for double-UTF-8 encoding. -</para> -<para> -Double-UTF-8 encoding is the result of [errorneous] conversion of UTF-8 text -to UTF-8 again, as if it was in some 8bit charset. This is quite hard to -recover from. -</para> -<para> -The analayser mostly only determines what language will be assumed, -the rest of this test is independent on the main guessing routines. -When <parameter>buffer</parameter> doesn't containing UTF-8 text, the result is undefined -(namely, false positives are possible). -</para> -<para> -Calling this function when language is `none' has currently no effect.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state determinig the language for double-UTF-8 check. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>buffer</parameter> :</term> -<listitem><simpara> The buffer to be checked [<parameter>size</parameter>]. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>size</parameter> :</term> -<listitem><simpara> The size of <parameter>buffer</parameter>. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero, when <parameter>buffer</parameter> probably contains doubly-UTF-8 encoded text. - More precisely, it returns the number of charsets which are - possible candidates for source charset. You can then use - <link linkend="enca-double-utf8-get-candidates"><function>enca_double_utf8_get_candidates()</function></link> to retrieve the charsets. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-double-utf8-get-candidates" role="function"> -<title>enca_double_utf8_get_candidates ()</title> -<indexterm zone="enca-double-utf8-get-candidates"><primary sortas="enca_double_utf8_get_candidates">enca_double_utf8_get_candidates</primary></indexterm><programlisting><link linkend="int">int</link>* enca_double_utf8_get_candidates (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns array of double-UTF-8 source charset candidates from the last check. -</para> -<para> -The returned array should be freed by caller then no longer needed. Its -is the return value of the preceding <link linkend="enca-double-utf8-check"><function>enca_double_utf8_check()</function></link> call. -</para> -<para> -When called before any double-UTF-8 test has been performed yet or after -and unsuccessfull double-UTF-8 test, it returns NULL, but the result after -an unsuccessfull check should be considered undefined.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state for which double-UTF-8 candidates are to be - returned. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An array containing charset id's of possible source charsets from - which the sample was doubly-UTF-8 encoded. The array may contain - only one value, but usually enca is not able to decide between - e.g. ISO-8859-2 and Win1250, thus more candidates are returned. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-set-multibyte" role="function"> -<title>enca_set_multibyte ()</title> -<indexterm zone="enca-set-multibyte"><primary sortas="enca_set_multibyte">enca_set_multibyte</primary></indexterm><programlisting><link linkend="void">void</link> enca_set_multibyte (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> multibyte);</programlisting> -<para> -Enables or disables multibyte encoding tests for <parameter>analyser</parameter>. -</para> -<para> -This option is enabled by default. -</para> -<para> -When multibyte encodings are disabled, only 8bit charsets are checked. -Disabling them for language with no 8bit charsets leaves only one thing -<link linkend="enca-analyse"><function>enca_analyse()</function></link> could test: whether the sample is purely 7bit ASCII or not -(the latter leading to analyser failure, of course). -</para> -<para> -Multibyte encoding detection is also affected by -<link linkend="enca-set-termination-strictness"><function>enca_set_termination_strictness()</function></link>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>multibyte</parameter> :</term> -<listitem><simpara> Whether multibyte encoding tests should be enabled (nonzero to - enable, zero to disable). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-multibyte" role="function" condition="since:1.3."> -<title>enca_get_multibyte ()</title> -<indexterm zone="enca-get-multibyte" role="1.3."><primary sortas="enca_get_multibyte">enca_get_multibyte</primary></indexterm><programlisting><link linkend="int">int</link> enca_get_multibyte (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns whether <parameter>analyser</parameter> can return multibyte encodings. -</para> -<para> -See <link linkend="enca-set-multibyte"><function>enca_set_multibyte()</function></link> for more detailed description of multibyte -encoding checking.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when multibyte encoding are possible, zero otherwise. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-interpreted-surfaces" role="function"> -<title>enca_set_interpreted_surfaces ()</title> -<indexterm zone="enca-set-interpreted-surfaces"><primary sortas="enca_set_interpreted_surfaces">enca_set_interpreted_surfaces</primary></indexterm><programlisting><link linkend="void">void</link> enca_set_interpreted_surfaces (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> interpreted_surfaces);</programlisting> -<para> -Enables or disables interpeted surfaces tests for <parameter>analyser</parameter>. -</para> -<para> -This option is enabled by default. -</para> -<para> -To allow simple applications which care about charset only and don't want -to wrestle with surfaces, neglecting surface information should not have -serious consequences. While ignoring EOL type surface is feasible, and -ignoring UCS byteorders may be acceptable in endian-homogenous environment; -ignoring the fact file is Quoted-Printable encoded can have disasterous -consequences. By disabling this option you can disable surfaces requiring -fundamental reinterpretation of the content, namely <link linkend="ENCA-SURFACE-QP--CAPS"><literal>ENCA_SURFACE_QP</literal></link> -and <link linkend="ENCA-SURFACE-EOL-BIN--CAPS"><literal>ENCA_SURFACE_EOL_BIN</literal></link> (thus probably making <link linkend="enca-analyse"><function>enca_analyse()</function></link> to fail on -such samples).</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>interpreted_surfaces</parameter> :</term> -<listitem><simpara> Whether interpreted surfaces tests should be enabled - (nonzero to allow, zero to disallow). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-interpreted-surfaces" role="function" condition="since:1.3."> -<title>enca_get_interpreted_surfaces ()</title> -<indexterm zone="enca-get-interpreted-surfaces" role="1.3."><primary sortas="enca_get_interpreted_surfaces">enca_get_interpreted_surfaces</primary></indexterm><programlisting><link linkend="int">int</link> enca_get_interpreted_surfaces (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns whether <parameter>analyser</parameter> allows interpreted surfaces. -</para> -<para> -See <link linkend="enca-set-interpreted-surfaces"><function>enca_set_interpreted_surfaces()</function></link> for more detailed description of -interpreted surfaces.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when interpreted surfaces are possible, zero otherwise. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-ambiguity" role="function"> -<title>enca_set_ambiguity ()</title> -<indexterm zone="enca-set-ambiguity"><primary sortas="enca_set_ambiguity">enca_set_ambiguity</primary></indexterm><programlisting><link linkend="void">void</link> enca_set_ambiguity (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> ambiguity);</programlisting> -<para> -Enables or disables ambiguous mode for <parameter>analyser</parameter>. -</para> -<para> -This option is disabled by default. -</para> -<para> -In ambiguous mode some result is returned even when the charset cannot be -determined uniquely, provided that sample contains only characters which -have the same meaning in all charsets under consideration.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>ambiguity</parameter> :</term> -<listitem><simpara> Whether result can be ambiguous (nonzero to allow, zero to - disallow). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-ambiguity" role="function" condition="since:1.3."> -<title>enca_get_ambiguity ()</title> -<indexterm zone="enca-get-ambiguity" role="1.3."><primary sortas="enca_get_ambiguity">enca_get_ambiguity</primary></indexterm><programlisting><link linkend="int">int</link> enca_get_ambiguity (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns whether <parameter>analyser</parameter> can return ambiguous results. -</para> -<para> -See <link linkend="enca-set-ambiguity"><function>enca_set_ambiguity()</function></link> for more detailed description of ambiguous results.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when ambiguous results are allowed, zero otherwise. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-filtering" role="function"> -<title>enca_set_filtering ()</title> -<indexterm zone="enca-set-filtering"><primary sortas="enca_set_filtering">enca_set_filtering</primary></indexterm><programlisting><link linkend="void">void</link> enca_set_filtering (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> filtering);</programlisting> -<para> -Enables or disables filters for <parameter>analyser</parameter>. -</para> -<para> -This option is enabled by default. -</para> -<para> -Various filters are used to filter out block of binary noise and box-drawing -characters that could otherwise confuse enca. In cases this is unwanted, -you can disable them by setting this option to zero.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>filtering</parameter> :</term> -<listitem><simpara> Whether filters should be enabled (nonzero to enable, zero to - disable). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-filtering" role="function" condition="since:1.3."> -<title>enca_get_filtering ()</title> -<indexterm zone="enca-get-filtering" role="1.3."><primary sortas="enca_get_filtering">enca_get_filtering</primary></indexterm><programlisting><link linkend="int">int</link> enca_get_filtering (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns whether <parameter>analyser</parameter> has filtering enabled. -</para> -<para> -See <link linkend="enca-set-filtering"><function>enca_set_filtering()</function></link> for more detailed description of filtering.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when filtering is enabled, zero otherwise. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-garbage-test" role="function"> -<title>enca_set_garbage_test ()</title> -<indexterm zone="enca-set-garbage-test"><primary sortas="enca_set_garbage_test">enca_set_garbage_test</primary></indexterm><programlisting><link linkend="void">void</link> enca_set_garbage_test (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> garabage_test);</programlisting> -<para> -Enables or disables garbage test for <parameter>analyser</parameter>. -</para> -<para> -This option is enabled by default. -</para> -<para> -To prevent white noise (and almost-white noise) from being accidentally -detected as some charset, a garbage test is used. In cases this is -unwanted, you can disable is by setting this option to zero.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>garabage_test</parameter> :</term> -<listitem><simpara> Whether garbage test should be allowed (nonzero to enable, - nzero to disable). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-garbage-test" role="function" condition="since:1.3."> -<title>enca_get_garbage_test ()</title> -<indexterm zone="enca-get-garbage-test" role="1.3."><primary sortas="enca_get_garbage_test">enca_get_garbage_test</primary></indexterm><programlisting><link linkend="int">int</link> enca_get_garbage_test (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns whether <parameter>analyser</parameter> has garbage test enabled. -</para> -<para> -See <link linkend="enca-set-garbage-test"><function>enca_set_garbage_test()</function></link> for more detailed description of garbage test.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when garbage test is enabled, zero otherwise. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-termination-strictness" role="function"> -<title>enca_set_termination_strictness ()</title> -<indexterm zone="enca-set-termination-strictness"><primary sortas="enca_set_termination_strictness">enca_set_termination_strictness</primary></indexterm><programlisting><link linkend="void">void</link> enca_set_termination_strictness (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="int">int</link> termination_strictness);</programlisting> -<para> -Enables or disables requiring multibyte sequences to be terminated correctly -at the end of sample. -</para> -<para> -This option is enabled by default. -</para> -<para> -The sample given to <link linkend="enca-analyse"><function>enca_analyse()</function></link> generally may not be a complete text -(e.g. for efficiency reasons). As a result, it may end in the middle of a -multibyte sequence. In this case, you should disable this option to -prevent rejecting some charset just because the sample don't terminate -correctly. On the other hand, when given sample contains whole text, you -should always enable this option to assure correctness of the result. -</para> -<para> -Note this option does NOT affect fixed character size encodings, like UCS-2 -and UCS-4; sample is never assumed to contain UCS-2 text when its size is -not even (and similarly for UCS-4).</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>termination_strictness</parameter> :</term> -<listitem><simpara> Whether multibyte sequences are required to be - terminated correctly at the end of sample - (nonzero to require, zero to relax). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-termination-strictness" role="function" condition="since:1.3."> -<title>enca_get_termination_strictness ()</title> -<indexterm zone="enca-get-termination-strictness" role="1.3."><primary sortas="enca_get_termination_strictness">enca_get_termination_strictness</primary></indexterm><programlisting><link linkend="int">int</link> enca_get_termination_strictness (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns whether <parameter>analyser</parameter> requires strict termination. -</para> -<para> -See <link linkend="enca-set-termination-strictness"><function>enca_set_termination_strictness()</function></link> for more detailed description of -termination strictness.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when strict termination is required, zero otherwise. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-significant" role="function"> -<title>enca_set_significant ()</title> -<indexterm zone="enca-set-significant"><primary sortas="enca_set_significant">enca_set_significant</primary></indexterm><programlisting><link linkend="int">int</link> enca_set_significant (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="size-t">size_t</link> significant);</programlisting> -<para> -Sets the minimal number of required significant characters. -</para> -<para> -The default value of this option is 10. -</para> -<para> -<link linkend="enca-analyse"><function>enca_analyse()</function></link> refuses to make a decision unles at least this number -of significant characters is found in sample. You may want to lower this -number for very short texts.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>significant</parameter> :</term> -<listitem><simpara> Minimal number of required significant characters. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Zero on success, nonzero on failure, i.e. when you passed zero - as <parameter>significant</parameter>. It sets analyser errno to ENCA_EINVALUE on - failure. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-significant" role="function" condition="since:1.3."> -<title>enca_get_significant ()</title> -<indexterm zone="enca-get-significant" role="1.3."><primary sortas="enca_get_significant">enca_get_significant</primary></indexterm><programlisting><link linkend="size-t">size_t</link> enca_get_significant (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns the minimum number of significant characters required by <parameter>analyser</parameter>. -</para> -<para> -See <link linkend="enca-set-significant"><function>enca_set_significant()</function></link> for more detailed description of required -significant characters.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The minimum number of significant characters. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> -<refsect2 id="enca-set-threshold" role="function"> -<title>enca_set_threshold ()</title> -<indexterm zone="enca-set-threshold"><primary sortas="enca_set_threshold">enca_set_threshold</primary></indexterm><programlisting><link linkend="int">int</link> enca_set_threshold (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser, - <link linkend="double">double</link> threshold);</programlisting> -<para> -Sets the minimal ratio between the most probable and the second most -probable charsets. -</para> -<para> -The default value of this option is 1.4142. -</para> -<para> -<link linkend="enca-analyse"><function>enca_analyse()</function></link> consideres the result known only when there's a clear gap -between the most probable and the second most probable charset -proababilities. Lower <parameter>threshold</parameter> values mean larger probability of a -mistake and smaller probability of not recognizing a charset; higher -<parameter>threshold</parameter> values the contrary. Threshold value of 2 is almost infinity.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>threshold</parameter> :</term> -<listitem><simpara> Minimal ratio between winner and second best guess. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Zero on success, nonzero on failure, i.e. when you passed value - smaller than 1.0 as <parameter>threshold</parameter>. It sets analyser errno to - ENCA_EINVALUE on failure. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-threshold" role="function" condition="since:1.3."> -<title>enca_get_threshold ()</title> -<indexterm zone="enca-get-threshold" role="1.3."><primary sortas="enca_get_threshold">enca_get_threshold</primary></indexterm><programlisting><link linkend="double">double</link> enca_get_threshold (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns the threshold value used by <parameter>analyser</parameter>. -</para> -<para> -See <link linkend="enca-set-threshold"><function>enca_set_threshold()</function></link> for more detailed threshold description.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The threshold value. - -</simpara></listitem></varlistentry> -</variablelist><para role="since">Since 1.3.</para></refsect2> - -</refsect1> - - - - -</refentry> diff --git a/lib/enca/devel-docs/xml/api-index-1.3..xml b/lib/enca/devel-docs/xml/api-index-1.3..xml deleted file mode 100644 index 9d73d9ff01..0000000000 --- a/lib/enca/devel-docs/xml/api-index-1.3..xml +++ /dev/null @@ -1,15 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<indexdiv> -<indexdiv><title>E</title> -<indexentry><primaryie linkends="enca-get-ambiguity"><link linkend="enca-get-ambiguity">enca_get_ambiguity</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-filtering"><link linkend="enca-get-filtering">enca_get_filtering</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-garbage-test"><link linkend="enca-get-garbage-test">enca_get_garbage_test</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-interpreted-surfaces"><link linkend="enca-get-interpreted-surfaces">enca_get_interpreted_surfaces</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-multibyte"><link linkend="enca-get-multibyte">enca_get_multibyte</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-significant"><link linkend="enca-get-significant">enca_get_significant</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-termination-strictness"><link linkend="enca-get-termination-strictness">enca_get_termination_strictness</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-threshold"><link linkend="enca-get-threshold">enca_get_threshold</link></primaryie></indexentry> -</indexdiv> -</indexdiv> diff --git a/lib/enca/devel-docs/xml/api-index-deprecated.xml b/lib/enca/devel-docs/xml/api-index-deprecated.xml deleted file mode 100644 index 113283526a..0000000000 --- a/lib/enca/devel-docs/xml/api-index-deprecated.xml +++ /dev/null @@ -1,5 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<indexdiv> -</indexdiv> diff --git a/lib/enca/devel-docs/xml/api-index-full.xml b/lib/enca/devel-docs/xml/api-index-full.xml deleted file mode 100644 index 1245d58abe..0000000000 --- a/lib/enca/devel-docs/xml/api-index-full.xml +++ /dev/null @@ -1,130 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<indexdiv> -<indexdiv><title>C</title> -<indexentry><primaryie linkends="CR--CAPS"><link linkend="CR--CAPS">CR</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>E</title> -<indexentry><primaryie linkends="ELEMENTS--CAPS"><link linkend="ELEMENTS--CAPS">ELEMENTS</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaAnalyserOptions"><link linkend="EncaAnalyserOptions">EncaAnalyserOptions</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaAnalyserState"><link linkend="EncaAnalyserState">EncaAnalyserState</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaCharsetFlags"><link linkend="EncaCharsetFlags">EncaCharsetFlags</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaCharsetInfo"><link linkend="EncaCharsetInfo">EncaCharsetInfo</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaEncoding"><link linkend="EncaEncoding">EncaEncoding</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaErrno"><link linkend="EncaErrno">EncaErrno</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaGuessFunc"><link linkend="EncaGuessFunc">EncaGuessFunc</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaHookFunc"><link linkend="EncaHookFunc">EncaHookFunc</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaLanguageHookData1CS"><link linkend="EncaLanguageHookData1CS">EncaLanguageHookData1CS</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaLanguageHookDataEOL"><link linkend="EncaLanguageHookDataEOL">EncaLanguageHookDataEOL</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaLanguageInfo"><link linkend="EncaLanguageInfo">EncaLanguageInfo</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaNameStyle"><link linkend="EncaNameStyle">EncaNameStyle</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaSurface"><link linkend="EncaSurface">EncaSurface</link></primaryie></indexentry> -<indexentry><primaryie linkends="EncaUTFCheckData"><link linkend="EncaUTFCheckData">EncaUTFCheckData</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-analyse"><link linkend="enca-analyse">enca_analyse</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-analyser-alloc"><link linkend="enca-analyser-alloc">enca_analyser_alloc</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-analyser-free"><link linkend="enca-analyser-free">enca_analyser_free</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-analyser-language"><link linkend="enca-analyser-language">enca_analyser_language</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-analyse-const"><link linkend="enca-analyse-const">enca_analyse_const</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charsets-subset-identical"><link linkend="enca-charsets-subset-identical">enca_charsets_subset_identical</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-has-ucs2-map"><link linkend="enca-charset-has-ucs2-map">enca_charset_has_ucs2_map</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-16bit"><link linkend="enca-charset-is-16bit">enca_charset_is_16bit</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-32bit"><link linkend="enca-charset-is-32bit">enca_charset_is_32bit</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-7bit"><link linkend="enca-charset-is-7bit">enca_charset_is_7bit</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-8bit"><link linkend="enca-charset-is-8bit">enca_charset_is_8bit</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-binary"><link linkend="enca-charset-is-binary">enca_charset_is_binary</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-fixed"><link linkend="enca-charset-is-fixed">enca_charset_is_fixed</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-known"><link linkend="enca-charset-is-known">enca_charset_is_known</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-multibyte"><link linkend="enca-charset-is-multibyte">enca_charset_is_multibyte</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-regular"><link linkend="enca-charset-is-regular">enca_charset_is_regular</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-is-variable"><link linkend="enca-charset-is-variable">enca_charset_is_variable</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-name"><link linkend="enca-charset-name">enca_charset_name</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-natural-surface"><link linkend="enca-charset-natural-surface">enca_charset_natural_surface</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-properties"><link linkend="enca-charset-properties">enca_charset_properties</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-charset-ucs2-map"><link linkend="enca-charset-ucs2-map">enca_charset_ucs2_map</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-csname"><link linkend="enca-csname">enca_csname</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-CS-UNKNOWN--CAPS"><link linkend="ENCA-CS-UNKNOWN--CAPS">ENCA_CS_UNKNOWN</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-double-utf8-check"><link linkend="enca-double-utf8-check">enca_double_utf8_check</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-double-utf8-destroy"><link linkend="enca-double-utf8-destroy">enca_double_utf8_destroy</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-double-utf8-get-candidates"><link linkend="enca-double-utf8-get-candidates">enca_double_utf8_get_candidates</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-double-utf8-init"><link linkend="enca-double-utf8-init">enca_double_utf8_init</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-eol-surface"><link linkend="enca-eol-surface">enca_eol_surface</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-errno"><link linkend="enca-errno">enca_errno</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-filter-boxdraw"><link linkend="enca-filter-boxdraw">enca_filter_boxdraw</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-find-max-sec"><link linkend="enca-find-max-sec">enca_find_max_sec</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-free"><link linkend="enca-free">enca_free</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-ambiguity"><link linkend="enca-get-ambiguity">enca_get_ambiguity</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-charset-aliases"><link linkend="enca-get-charset-aliases">enca_get_charset_aliases</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-charset-similarity-matrix"><link linkend="enca-get-charset-similarity-matrix">enca_get_charset_similarity_matrix</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-filtering"><link linkend="enca-get-filtering">enca_get_filtering</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-garbage-test"><link linkend="enca-get-garbage-test">enca_get_garbage_test</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-interpreted-surfaces"><link linkend="enca-get-interpreted-surfaces">enca_get_interpreted_surfaces</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-languages"><link linkend="enca-get-languages">enca_get_languages</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-language-charsets"><link linkend="enca-get-language-charsets">enca_get_language_charsets</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-multibyte"><link linkend="enca-get-multibyte">enca_get_multibyte</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-significant"><link linkend="enca-get-significant">enca_get_significant</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-surface-name"><link linkend="enca-get-surface-name">enca_get_surface_name</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-termination-strictness"><link linkend="enca-get-termination-strictness">enca_get_termination_strictness</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-get-threshold"><link linkend="enca-get-threshold">enca_get_threshold</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-guess-destroy"><link linkend="enca-guess-destroy">enca_guess_destroy</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-guess-init"><link linkend="enca-guess-init">enca_guess_init</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-BE--CAPS"><link linkend="ENCA-LANGUAGE-BE--CAPS">ENCA_LANGUAGE_BE</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-BG--CAPS"><link linkend="ENCA-LANGUAGE-BG--CAPS">ENCA_LANGUAGE_BG</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-CS--CAPS"><link linkend="ENCA-LANGUAGE-CS--CAPS">ENCA_LANGUAGE_CS</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-language-destroy"><link linkend="enca-language-destroy">enca_language_destroy</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-language-english-name"><link linkend="enca-language-english-name">enca_language_english_name</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-ET--CAPS"><link linkend="ENCA-LANGUAGE-ET--CAPS">ENCA_LANGUAGE_ET</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-language-hook-eol"><link linkend="enca-language-hook-eol">enca_language_hook_eol</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-language-hook-ncs"><link linkend="enca-language-hook-ncs">enca_language_hook_ncs</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-HR--CAPS"><link linkend="ENCA-LANGUAGE-HR--CAPS">ENCA_LANGUAGE_HR</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-HU--CAPS"><link linkend="ENCA-LANGUAGE-HU--CAPS">ENCA_LANGUAGE_HU</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-language-init"><link linkend="enca-language-init">enca_language_init</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-LT--CAPS"><link linkend="ENCA-LANGUAGE-LT--CAPS">ENCA_LANGUAGE_LT</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-LV--CAPS"><link linkend="ENCA-LANGUAGE-LV--CAPS">ENCA_LANGUAGE_LV</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-PL--CAPS"><link linkend="ENCA-LANGUAGE-PL--CAPS">ENCA_LANGUAGE_PL</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-RU--CAPS"><link linkend="ENCA-LANGUAGE-RU--CAPS">ENCA_LANGUAGE_RU</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-SK--CAPS"><link linkend="ENCA-LANGUAGE-SK--CAPS">ENCA_LANGUAGE_SK</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-SL--CAPS"><link linkend="ENCA-LANGUAGE-SL--CAPS">ENCA_LANGUAGE_SL</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-LANGUAGE-UK--CAPS"><link linkend="ENCA-LANGUAGE-UK--CAPS">ENCA_LANGUAGE_UK</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-malloc"><link linkend="enca-malloc">enca_malloc</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-name-to-charset"><link linkend="enca-name-to-charset">enca_name_to_charset</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-name-to-surface"><link linkend="enca-name-to-surface">enca_name_to_surface</link></primaryie></indexentry> -<indexentry><primaryie linkends="ENCA-NOT-A-CHAR--CAPS"><link linkend="ENCA-NOT-A-CHAR--CAPS">ENCA_NOT_A_CHAR</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-number-of-charsets"><link linkend="enca-number-of-charsets">enca_number_of_charsets</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-pair-analyse"><link linkend="enca-pair-analyse">enca_pair_analyse</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-pair-destroy"><link linkend="enca-pair-destroy">enca_pair_destroy</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-pair-init"><link linkend="enca-pair-init">enca_pair_init</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-parse-encoding-name"><link linkend="enca-parse-encoding-name">enca_parse_encoding_name</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-realloc"><link linkend="enca-realloc">enca_realloc</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-ambiguity"><link linkend="enca-set-ambiguity">enca_set_ambiguity</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-filtering"><link linkend="enca-set-filtering">enca_set_filtering</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-garbage-test"><link linkend="enca-set-garbage-test">enca_set_garbage_test</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-interpreted-surfaces"><link linkend="enca-set-interpreted-surfaces">enca_set_interpreted_surfaces</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-multibyte"><link linkend="enca-set-multibyte">enca_set_multibyte</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-significant"><link linkend="enca-set-significant">enca_set_significant</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-termination-strictness"><link linkend="enca-set-termination-strictness">enca_set_termination_strictness</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-set-threshold"><link linkend="enca-set-threshold">enca_set_threshold</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-stpcpy"><link linkend="enca-stpcpy">enca_stpcpy</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-strappend"><link linkend="enca-strappend">enca_strappend</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-strconcat"><link linkend="enca-strconcat">enca_strconcat</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-strdup"><link linkend="enca-strdup">enca_strdup</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-strerror"><link linkend="enca-strerror">enca_strerror</link></primaryie></indexentry> -<indexentry><primaryie linkends="enca-strstr"><link linkend="enca-strstr">enca_strstr</link></primaryie></indexentry> -<indexentry><primaryie linkends="EPSILON--CAPS"><link linkend="EPSILON--CAPS">EPSILON</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>F</title> -<indexentry><primaryie linkends="FILL-NONLETTER--CAPS"><link linkend="FILL-NONLETTER--CAPS">FILL_NONLETTER</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>L</title> -<indexentry><primaryie linkends="LF--CAPS"><link linkend="LF--CAPS">LF</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>M</title> -<indexentry><primaryie linkends="MAKE-HOOK-LINE--CAPS"><link linkend="MAKE-HOOK-LINE--CAPS">MAKE_HOOK_LINE</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>N</title> -<indexentry><primaryie linkends="NEW--CAPS"><link linkend="NEW--CAPS">NEW</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>R</title> -<indexentry><primaryie linkends="RENEW--CAPS"><link linkend="RENEW--CAPS">RENEW</link></primaryie></indexentry> -</indexdiv> -</indexdiv> diff --git a/lib/enca/devel-docs/xml/auxiliary.xml b/lib/enca/devel-docs/xml/auxiliary.xml deleted file mode 100644 index 6008844e0f..0000000000 --- a/lib/enca/devel-docs/xml/auxiliary.xml +++ /dev/null @@ -1,177 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<refentry id="libenca-Auxiliary-Functions"> -<refmeta> -<refentrytitle role="top_of_page" id="libenca-Auxiliary-Functions.top_of_page">Auxiliary functions</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo>LIBENCA Library</refmiscinfo> -</refmeta> - -<refnamediv> -<refname>Auxiliary functions</refname> -<refpurpose>Variouis auxiliary functions and informations about libenca.</refpurpose> -</refnamediv> - -<refsynopsisdiv id="libenca-Auxiliary-Functions.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -<link linkend="int">int</link> <link linkend="enca-charset-has-ucs2-map">enca_charset_has_ucs2_map</link> (<link linkend="int">int</link> charset); -<link linkend="int">int</link> <link linkend="enca-charset-ucs2-map">enca_charset_ucs2_map</link> (<link linkend="int">int</link> charset, - unsigned <link linkend="int">int</link> *buffer); -<link linkend="size-t">size_t</link> <link linkend="enca-number-of-charsets">enca_number_of_charsets</link> (void); -const <link linkend="char">char</link>* <link linkend="enca-analyser-language">enca_analyser_language</link> (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser); -const <link linkend="char">char</link>** <link linkend="enca-get-languages">enca_get_languages</link> (<link linkend="size-t">size_t</link> *n); -const <link linkend="char">char</link>* <link linkend="enca-language-english-name">enca_language_english_name</link> (const <link linkend="char">char</link> *lang); -<link linkend="int">int</link>* <link linkend="enca-get-language-charsets">enca_get_language_charsets</link> (const <link linkend="char">char</link> *langname, - <link linkend="size-t">size_t</link> *n); -</synopsis> -</refsynopsisdiv> - - - - - - - - - -<refsect1 id="libenca-Auxiliary-Functions.description" role="desc"> -<title role="desc.title">Description</title> -<para> -</para> -</refsect1> - -<refsect1 id="libenca-Auxiliary-Functions.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="enca-charset-has-ucs2-map" role="function"> -<title>enca_charset_has_ucs2_map ()</title> -<indexterm zone="enca-charset-has-ucs2-map"><primary sortas="enca_charset_has_ucs2_map">enca_charset_has_ucs2_map</primary></indexterm><programlisting><link linkend="int">int</link> enca_charset_has_ucs2_map (<link linkend="int">int</link> charset);</programlisting> -<para> -Find whether we have charset -> UCS-2 map.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset</parameter> :</term> -<listitem><simpara> An 8bit charset. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when the map is available, zero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-ucs2-map" role="function"> -<title>enca_charset_ucs2_map ()</title> -<indexterm zone="enca-charset-ucs2-map"><primary sortas="enca_charset_ucs2_map">enca_charset_ucs2_map</primary></indexterm><programlisting><link linkend="int">int</link> enca_charset_ucs2_map (<link linkend="int">int</link> charset, - unsigned <link linkend="int">int</link> *buffer);</programlisting> -<para> -Creates map from an 8bit charset to UCS-2. -</para> -<para> -The buffer must be at least 256*sizeof(unsigned int) long to hold the map.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset</parameter> :</term> -<listitem><simpara> An 8bit charset. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>buffer</parameter> :</term> -<listitem><simpara> Buffer to store the map to. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when the map was successfully created, zero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-number-of-charsets" role="function"> -<title>enca_number_of_charsets ()</title> -<indexterm zone="enca-number-of-charsets"><primary sortas="enca_number_of_charsets">enca_number_of_charsets</primary></indexterm><programlisting><link linkend="size-t">size_t</link> enca_number_of_charsets (void);</programlisting> -<para> -Returns number of known charsets. -</para> -<para> -Charsets idetifiers are assigned successively starting from zero, so last -charset has identifier <link linkend="enca-number-of-charsets"><function>enca_number_of_charsets()</function></link> - 1.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of charsets. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-analyser-language" role="function"> -<title>enca_analyser_language ()</title> -<indexterm zone="enca-analyser-language"><primary sortas="enca_analyser_language">enca_analyser_language</primary></indexterm><programlisting>const <link linkend="char">char</link>* enca_analyser_language (<link linkend="EncaAnalyser">EncaAnalyser</link> analyser);</programlisting> -<para> -Returns name of language which was <parameter>analyser</parameter> initialized for. -</para> -<para> -The returned string must be considered constant and must NOT be freed.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The language name. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-languages" role="function"> -<title>enca_get_languages ()</title> -<indexterm zone="enca-get-languages"><primary sortas="enca_get_languages">enca_get_languages</primary></indexterm><programlisting>const <link linkend="char">char</link>** enca_get_languages (<link linkend="size-t">size_t</link> *n);</programlisting> -<para> -Returns list of known languages. -</para> -<para> -The returned strings are two-letter ISO-639 language codes, the same as -<link linkend="enca-analyser-alloc"><function>enca_analyser_alloc()</function></link> accepts. -</para> -<para> -The list of languages has to be freed by caller; the strings themselves -must be considered constant and must NOT be freed.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>n</parameter> :</term> -<listitem><simpara> The number of languages will be stored here. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The list of languages, storing their number into *<parameter>n</parameter>. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-language-english-name" role="function"> -<title>enca_language_english_name ()</title> -<indexterm zone="enca-language-english-name"><primary sortas="enca_language_english_name">enca_language_english_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* enca_language_english_name (const <link linkend="char">char</link> *lang);</programlisting> -<para> -Returns an English name of a language given its ISO-639 code. -</para> -<para> -The returned string must be considered constant and must NOT be freed.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>lang</parameter> :</term> -<listitem><simpara> A two-letter language code, such as obtained from - <link linkend="enca-analyser-language"><function>enca_analyser_language()</function></link> or <link linkend="enca-get-languages"><function>enca_get_languages()</function></link>. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The English language name. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-language-charsets" role="function"> -<title>enca_get_language_charsets ()</title> -<indexterm zone="enca-get-language-charsets"><primary sortas="enca_get_language_charsets">enca_get_language_charsets</primary></indexterm><programlisting><link linkend="int">int</link>* enca_get_language_charsets (const <link linkend="char">char</link> *langname, - <link linkend="size-t">size_t</link> *n);</programlisting> -<para> -Returns list of identifiers of charsets supported for language <parameter>language</parameter>. -</para> -<para> -The list of charset identifiers has to be freed by caller.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>langname</parameter> :</term> -<listitem><simpara> Two-letter ISO-639 language code. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>n</parameter> :</term> -<listitem><simpara> The number of charsets will be stored here. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The list of charsets, storing their number into *<parameter>n</parameter>. When language - contains no charsets or <parameter>langname</parameter> is invalid, <link linkend="NULL--CAPS"><type>NULL</type></link> is returned - and zero stored into *<parameter>n</parameter>. -</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - - - - -</refentry> diff --git a/lib/enca/devel-docs/xml/encodings.xml b/lib/enca/devel-docs/xml/encodings.xml deleted file mode 100644 index 761e5ed660..0000000000 --- a/lib/enca/devel-docs/xml/encodings.xml +++ /dev/null @@ -1,286 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<refentry id="libenca-Charsets-and-Surfaces"> -<refmeta> -<refentrytitle role="top_of_page" id="libenca-Charsets-and-Surfaces.top_of_page">Charsets and Surfaces</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo>LIBENCA Library</refmiscinfo> -</refmeta> - -<refnamediv> -<refname>Charsets and Surfaces</refname> -<refpurpose>Functions and macros for getting something sensible from <link linkend="EncaEncoding"><type>EncaEncoding</type></link>.</refpurpose> -</refnamediv> - -<refsynopsisdiv id="libenca-Charsets-and-Surfaces.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -const <link linkend="char">char</link>* <link linkend="enca-charset-name">enca_charset_name</link> (<link linkend="int">int</link> charset, - <link linkend="EncaNameStyle">EncaNameStyle</link> whatname); -const <link linkend="char">char</link>** <link linkend="enca-get-charset-aliases">enca_get_charset_aliases</link> (<link linkend="int">int</link> charset, - <link linkend="size-t">size_t</link> *n); -<link linkend="char">char</link>* <link linkend="enca-get-surface-name">enca_get_surface_name</link> (<link linkend="EncaSurface">EncaSurface</link> surface, - <link linkend="EncaNameStyle">EncaNameStyle</link> whatname); -<link linkend="EncaEncoding">EncaEncoding</link> <link linkend="enca-parse-encoding-name">enca_parse_encoding_name</link> (const <link linkend="char">char</link> *name); -<link linkend="EncaSurface">EncaSurface</link> <link linkend="enca-charset-natural-surface">enca_charset_natural_surface</link> (<link linkend="int">int</link> charset); -<link linkend="EncaCharsetFlags">EncaCharsetFlags</link> <link linkend="enca-charset-properties">enca_charset_properties</link> (<link linkend="int">int</link> charset); -#define <link linkend="enca-charset-is-7bit">enca_charset_is_7bit</link> (cs) -#define <link linkend="enca-charset-is-8bit">enca_charset_is_8bit</link> (cs) -#define <link linkend="enca-charset-is-16bit">enca_charset_is_16bit</link> (cs) -#define <link linkend="enca-charset-is-32bit">enca_charset_is_32bit</link> (cs) -#define <link linkend="enca-charset-is-fixed">enca_charset_is_fixed</link> (cs) -#define <link linkend="enca-charset-is-variable">enca_charset_is_variable</link> (cs) -#define <link linkend="enca-charset-is-binary">enca_charset_is_binary</link> (cs) -#define <link linkend="enca-charset-is-regular">enca_charset_is_regular</link> (cs) -#define <link linkend="enca-charset-is-multibyte">enca_charset_is_multibyte</link> (cs) -#define <link linkend="enca-charset-is-known">enca_charset_is_known</link> (cs) -</synopsis> -</refsynopsisdiv> - - - - - - - - - -<refsect1 id="libenca-Charsets-and-Surfaces.description" role="desc"> -<title role="desc.title">Description</title> -<para> -</para> -</refsect1> - -<refsect1 id="libenca-Charsets-and-Surfaces.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="enca-charset-name" role="function"> -<title>enca_charset_name ()</title> -<indexterm zone="enca-charset-name"><primary sortas="enca_charset_name">enca_charset_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* enca_charset_name (<link linkend="int">int</link> charset, - <link linkend="EncaNameStyle">EncaNameStyle</link> whatname);</programlisting> -<para> -Translates numeric charset id <parameter>charset</parameter> to some kind of name.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset</parameter> :</term> -<listitem><simpara> A charset id. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>whatname</parameter> :</term> -<listitem><simpara> Teh type of name you request. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The requested charset name; <link linkend="NULL--CAPS"><type>NULL</type></link> for invalid <parameter>whatname</parameter> or -<parameter>charset</parameter>, or when <parameter>whatname</parameter> name doesn't exist for charset <parameter>charset</parameter> -(<link linkend="ENCA-CS-UNKNOWN--CAPS"><type>ENCA_CS_UNKNOWN</type></link> is OK). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-charset-aliases" role="function"> -<title>enca_get_charset_aliases ()</title> -<indexterm zone="enca-get-charset-aliases"><primary sortas="enca_get_charset_aliases">enca_get_charset_aliases</primary></indexterm><programlisting>const <link linkend="char">char</link>** enca_get_charset_aliases (<link linkend="int">int</link> charset, - <link linkend="size-t">size_t</link> *n);</programlisting> -<para> -Returns list of accepted aliases for charset <parameter>charset</parameter>. -</para> -<para> -The list of aliases has to be freed by caller; the strings themselves -must be considered constant and must NOT be freed.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset</parameter> :</term> -<listitem><simpara> A charset id. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>n</parameter> :</term> -<listitem><simpara> The number of aliases will be stored here. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The list of aliases, storing their number into *<parameter>n</parameter>; <link linkend="NULL--CAPS"><type>NULL</type></link> for -invalid <parameter>charset</parameter> (*<parameter>n</parameter> is zero then). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-surface-name" role="function"> -<title>enca_get_surface_name ()</title> -<indexterm zone="enca-get-surface-name"><primary sortas="enca_get_surface_name">enca_get_surface_name</primary></indexterm><programlisting><link linkend="char">char</link>* enca_get_surface_name (<link linkend="EncaSurface">EncaSurface</link> surface, - <link linkend="EncaNameStyle">EncaNameStyle</link> whatname);</programlisting> -<para> -Constructs surface name from surface flags <parameter>surface</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>surface</parameter> :</term> -<listitem><simpara> A surface. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>whatname</parameter> :</term> -<listitem><simpara> The type of name you request. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The requested surface name; <link linkend="NULL--CAPS"><type>NULL</type></link> for invalid <parameter>whatname</parameter>; empty -string for naming style not supporting surfaces. In all cases, the -returned string must be freed by caller when no longer used. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-parse-encoding-name" role="function"> -<title>enca_parse_encoding_name ()</title> -<indexterm zone="enca-parse-encoding-name"><primary sortas="enca_parse_encoding_name">enca_parse_encoding_name</primary></indexterm><programlisting><link linkend="EncaEncoding">EncaEncoding</link> enca_parse_encoding_name (const <link linkend="char">char</link> *name);</programlisting> -<para> -Transofrms encoding specification charset/surface into numeric <link linkend="EncaEncoding"><type>EncaEncoding</type></link>. -</para> -<para> -When the charset name is not recognized, surfaces are not parsed at all and -<link linkend="ENCA-CS-UNKNOWN--CAPS"><type>ENCA_CS_UNKNOWN</type></link> is returned as charset. However, unrecognized surfaces are -considered only a minor problem causing <link linkend="ENCA-SURFACE-UNKNOWN--CAPS"><literal>ENCA_SURFACE_UNKNOWN</literal></link> flag to be -set in the result, beside recognized surface flags.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>name</parameter> :</term> -<listitem><simpara> An encoding specification. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The charset/surface pair. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-natural-surface" role="function"> -<title>enca_charset_natural_surface ()</title> -<indexterm zone="enca-charset-natural-surface"><primary sortas="enca_charset_natural_surface">enca_charset_natural_surface</primary></indexterm><programlisting><link linkend="EncaSurface">EncaSurface</link> enca_charset_natural_surface (<link linkend="int">int</link> charset);</programlisting> -<para> -Returns natural surface of a charset.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset</parameter> :</term> -<listitem><simpara> A charset. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The requested charset natural surface (called `implied' in recode), - zero for invalid <parameter>charset</parameter> or for charsets with no natural surface. - - Natrual surface is the surface one expects for a given charset -- - e.g. CRLF EOLs for IBM/Microsoft charsets, CR EOLs for Macintosh - charsets and LF EOLs for ISO/Unix charsets. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-properties" role="function"> -<title>enca_charset_properties ()</title> -<indexterm zone="enca-charset-properties"><primary sortas="enca_charset_properties">enca_charset_properties</primary></indexterm><programlisting><link linkend="EncaCharsetFlags">EncaCharsetFlags</link> enca_charset_properties (<link linkend="int">int</link> charset);</programlisting> -<para> -Returns charset properties.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset</parameter> :</term> -<listitem><simpara> A charset. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The requested charset properties; zero for invalid <parameter>charset</parameter>. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-7bit" role="macro"> -<title>enca_charset_is_7bit()</title> -<indexterm zone="enca-charset-is-7bit"><primary sortas="enca_charset_is_7bit">enca_charset_is_7bit</primary></indexterm><programlisting>#define enca_charset_is_7bit(cs)</programlisting> -<para> -Expands to nonzero when characters are represented with 7bit characters.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-8bit" role="macro"> -<title>enca_charset_is_8bit()</title> -<indexterm zone="enca-charset-is-8bit"><primary sortas="enca_charset_is_8bit">enca_charset_is_8bit</primary></indexterm><programlisting>#define enca_charset_is_8bit(cs)</programlisting> -<para> -Expands to nonzero when characters are represented with bytes.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-16bit" role="macro"> -<title>enca_charset_is_16bit()</title> -<indexterm zone="enca-charset-is-16bit"><primary sortas="enca_charset_is_16bit">enca_charset_is_16bit</primary></indexterm><programlisting>#define enca_charset_is_16bit(cs)</programlisting> -<para> -Expands to nonzero when characters are represented with 2byte words.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-32bit" role="macro"> -<title>enca_charset_is_32bit()</title> -<indexterm zone="enca-charset-is-32bit"><primary sortas="enca_charset_is_32bit">enca_charset_is_32bit</primary></indexterm><programlisting>#define enca_charset_is_32bit(cs)</programlisting> -<para> -Expands to nonzero when characters are represented with 4byte words.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-fixed" role="macro"> -<title>enca_charset_is_fixed()</title> -<indexterm zone="enca-charset-is-fixed"><primary sortas="enca_charset_is_fixed">enca_charset_is_fixed</primary></indexterm><programlisting>#define enca_charset_is_fixed(cs)</programlisting> -<para> -Expands to nonzero when one characters consists of one fundamental piece.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-variable" role="macro"> -<title>enca_charset_is_variable()</title> -<indexterm zone="enca-charset-is-variable"><primary sortas="enca_charset_is_variable">enca_charset_is_variable</primary></indexterm><programlisting>#define enca_charset_is_variable(cs)</programlisting> -<para> -Expands to nonzero when one character consists of variable number of -fundamental pieces.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-binary" role="macro"> -<title>enca_charset_is_binary()</title> -<indexterm zone="enca-charset-is-binary"><primary sortas="enca_charset_is_binary">enca_charset_is_binary</primary></indexterm><programlisting>#define enca_charset_is_binary(cs)</programlisting> -<para> -Expands to nonzero when charset is binary from ASCII viewpoint.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-regular" role="macro"> -<title>enca_charset_is_regular()</title> -<indexterm zone="enca-charset-is-regular"><primary sortas="enca_charset_is_regular">enca_charset_is_regular</primary></indexterm><programlisting>#define enca_charset_is_regular(cs)</programlisting> -<para> -Expands to nonzero when charset is language dependent (8bit) charset.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-multibyte" role="macro"> -<title>enca_charset_is_multibyte()</title> -<indexterm zone="enca-charset-is-multibyte"><primary sortas="enca_charset_is_multibyte">enca_charset_is_multibyte</primary></indexterm><programlisting>#define enca_charset_is_multibyte(cs)</programlisting> -<para> -Expands to nonzero when charset is multibyte.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charset-is-known" role="macro"> -<title>enca_charset_is_known()</title> -<indexterm zone="enca-charset-is-known"><primary sortas="enca_charset_is_known">enca_charset_is_known</primary></indexterm><programlisting>#define enca_charset_is_known(cs)</programlisting> -<para> -Expands to nonzero when the charset is known (i.e. it's not -ENCA_CS_UNKNOWN).</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> Charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - - - - -</refentry> diff --git a/lib/enca/devel-docs/xml/enums.xml b/lib/enca/devel-docs/xml/enums.xml deleted file mode 100644 index ca4e66aedc..0000000000 --- a/lib/enca/devel-docs/xml/enums.xml +++ /dev/null @@ -1,387 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<refentry id="libenca-Typedefs-and-Constants"> -<refmeta> -<refentrytitle role="top_of_page" id="libenca-Typedefs-and-Constants.top_of_page">Typedefs and Constants</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo>LIBENCA Library</refmiscinfo> -</refmeta> - -<refnamediv> -<refname>Typedefs and Constants</refname> -<refpurpose>Enca library typedefs, enums and constants.</refpurpose> -</refnamediv> - -<refsynopsisdiv id="libenca-Typedefs-and-Constants.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> - <link linkend="EncaEncoding">EncaEncoding</link>; -#define <link linkend="ENCA-CS-UNKNOWN--CAPS">ENCA_CS_UNKNOWN</link> -enum <link linkend="EncaSurface">EncaSurface</link>; -enum <link linkend="EncaCharsetFlags">EncaCharsetFlags</link>; -enum <link linkend="EncaNameStyle">EncaNameStyle</link>; -enum <link linkend="EncaErrno">EncaErrno</link>; -#define <link linkend="ENCA-NOT-A-CHAR--CAPS">ENCA_NOT_A_CHAR</link> -</synopsis> -</refsynopsisdiv> - - - - - - - - - -<refsect1 id="libenca-Typedefs-and-Constants.description" role="desc"> -<title role="desc.title">Description</title> -<para> -</para> -</refsect1> - -<refsect1 id="libenca-Typedefs-and-Constants.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="EncaEncoding" role="struct"> -<title>EncaEncoding</title> -<indexterm zone="EncaEncoding"><primary sortas="EncaEncoding">EncaEncoding</primary></indexterm><programlisting>typedef struct { - int charset; EncaSurface surface; -} EncaEncoding; -</programlisting> -<para> -Encoding, i.e. charset and surface. -</para> -<para> -This is what <link linkend="enca-analyse"><function>enca_analyse()</function></link> and <link linkend="enca-analyse-const"><function>enca_analyse_const()</function></link> return. -</para> -<para> -The <parameter>charset</parameter> field is an opaque numerical charset identifier, which has no -meaning outside Enca library. -You will probably want to use it only as <link linkend="enca-charset-name"><function>enca_charset_name()</function></link> argument. -It is only guaranteed not to change meaning -during program execution time; change of its interpretation (e.g. due to -addition of new charsets) is not considered API change. -</para> -<para> -The <parameter>surface</parameter> field is a combination of <link linkend="EncaSurface"><type>EncaSurface</type></link> flags. You may want -to ignore it completely; you should use <link linkend="enca-set-interpreted-surfaces"><function>enca_set_interpreted_surfaces()</function></link> -to disable weird surfaces then.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term><link linkend="int">int</link> <structfield>charset</structfield>;</term> -<listitem><simpara> Numeric charset identifier. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaSurface">EncaSurface</link> <structfield>surface</structfield>;</term> -<listitem><simpara> Surface flags. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="ENCA-CS-UNKNOWN--CAPS" role="macro"> -<title>ENCA_CS_UNKNOWN</title> -<indexterm zone="ENCA-CS-UNKNOWN--CAPS"><primary sortas="ENCA_CS_UNKNOWN">ENCA_CS_UNKNOWN</primary></indexterm><programlisting>#define ENCA_CS_UNKNOWN (-1) -</programlisting> -<para> -Unknown character set id. -</para> -<para> -Use <link linkend="enca-charset-is-known"><function>enca_charset_is_known()</function></link> to check for unknown charset instead of direct -comparsion.</para> -<para> -</para></refsect2> -<refsect2 id="EncaSurface" role="enum"> -<title>enum EncaSurface</title> -<indexterm zone="EncaSurface"><primary sortas="EncaSurface">EncaSurface</primary></indexterm><programlisting>typedef enum { /*< flags >*/ - ENCA_SURFACE_EOL_CR = 1 << 0, - ENCA_SURFACE_EOL_LF = 1 << 1, - ENCA_SURFACE_EOL_CRLF = 1 << 2, - ENCA_SURFACE_EOL_MIX = 1 << 3, - ENCA_SURFACE_EOL_BIN = 1 << 4, - ENCA_SURFACE_MASK_EOL = (ENCA_SURFACE_EOL_CR - | ENCA_SURFACE_EOL_LF - | ENCA_SURFACE_EOL_CRLF - | ENCA_SURFACE_EOL_MIX - | ENCA_SURFACE_EOL_BIN), - ENCA_SURFACE_PERM_21 = 1 << 5, - ENCA_SURFACE_PERM_4321 = 1 << 6, - ENCA_SURFACE_PERM_MIX = 1 << 7, - ENCA_SURFACE_MASK_PERM = (ENCA_SURFACE_PERM_21 - | ENCA_SURFACE_PERM_4321 - | ENCA_SURFACE_PERM_MIX), - ENCA_SURFACE_QP = 1 << 8, - ENCA_SURFACE_REMOVE = 1 << 13, - ENCA_SURFACE_UNKNOWN = 1 << 14, - ENCA_SURFACE_MASK_ALL = (ENCA_SURFACE_MASK_EOL - | ENCA_SURFACE_MASK_PERM - | ENCA_SURFACE_QP - | ENCA_SURFACE_REMOVE) -} EncaSurface; -</programlisting> -<para> -Surface flags.</para> -<para> -</para><variablelist role="enum"> -<varlistentry id="ENCA-SURFACE-EOL-CR--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_EOL_CR</literal></term> -<listitem><simpara> End-of-lines are represented with CR's. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-EOL-LF--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_EOL_LF</literal></term> -<listitem><simpara> End-of-lines are represented with LF's. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-EOL-CRLF--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_EOL_CRLF</literal></term> -<listitem><simpara> End-of-lines are represented with CRLF's. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-EOL-MIX--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_EOL_MIX</literal></term> -<listitem><simpara> Several end-of-line types, mixed. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-EOL-BIN--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_EOL_BIN</literal></term> -<listitem><simpara> End-of-line concept not applicable (binary data). -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-MASK-EOL--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_MASK_EOL</literal></term> -<listitem><simpara> Mask for end-of-line surfaces. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-PERM-21--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_PERM_21</literal></term> -<listitem><simpara> Odd and even bytes swapped. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-PERM-4321--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_PERM_4321</literal></term> -<listitem><simpara> Reversed byte sequence in 4byte words. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-PERM-MIX--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_PERM_MIX</literal></term> -<listitem><simpara> Chunks with both endianess, concatenated. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-MASK-PERM--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_MASK_PERM</literal></term> -<listitem><simpara> Mask for permutation surfaces. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-QP--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_QP</literal></term> -<listitem><simpara> Quoted printables. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-REMOVE--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_REMOVE</literal></term> -<listitem><simpara> Recode `remove' surface. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-UNKNOWN--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_UNKNOWN</literal></term> -<listitem><simpara> Unknown surface. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-SURFACE-MASK-ALL--CAPS" role="constant"> -<term><literal>ENCA_SURFACE_MASK_ALL</literal></term> -<listitem><simpara> Mask for all bits, withnout <link linkend="ENCA-SURFACE-UNKNOWN--CAPS"><type>ENCA_SURFACE_UNKNOWN</type></link>. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaCharsetFlags" role="enum"> -<title>enum EncaCharsetFlags</title> -<indexterm zone="EncaCharsetFlags"><primary sortas="EncaCharsetFlags">EncaCharsetFlags</primary></indexterm><programlisting>typedef enum { /*< flags >*/ - ENCA_CHARSET_7BIT = 1 << 0, - ENCA_CHARSET_8BIT = 1 << 1, - ENCA_CHARSET_16BIT = 1 << 2, - ENCA_CHARSET_32BIT = 1 << 3, - ENCA_CHARSET_FIXED = 1 << 4, - ENCA_CHARSET_VARIABLE = 1 << 5, - ENCA_CHARSET_BINARY = 1 << 6, - ENCA_CHARSET_REGULAR = 1 << 7, - ENCA_CHARSET_MULTIBYTE = 1 << 8 -} EncaCharsetFlags; -</programlisting> -<para> -Charset properties. -</para> -<para> -Flags <link linkend="ENCA-CHARSET-7BIT--CAPS"><literal>ENCA_CHARSET_7BIT</literal></link>, <link linkend="ENCA-CHARSET-8BIT--CAPS"><literal>ENCA_CHARSET_8BIT</literal></link>, <link linkend="ENCA-CHARSET-16BIT--CAPS"><literal>ENCA_CHARSET_16BIT</literal></link>, -<link linkend="ENCA-CHARSET-32BIT--CAPS"><literal>ENCA_CHARSET_32BIT</literal></link> tell how many bits a `fundamental piece' consists of. -This is different from bits per character; r.g. UTF-8 consists of 8bit -pieces (bytes), but character can be composed from 1 to 6 of them.</para> -<para> -</para><variablelist role="enum"> -<varlistentry id="ENCA-CHARSET-7BIT--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_7BIT</literal></term> -<listitem><simpara> Characters are represented with 7bit characters. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-8BIT--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_8BIT</literal></term> -<listitem><simpara> Characters are represented with bytes. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-16BIT--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_16BIT</literal></term> -<listitem><simpara> Characters are represented with 2byte words. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-32BIT--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_32BIT</literal></term> -<listitem><simpara> Characters are represented with 4byte words. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-FIXED--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_FIXED</literal></term> -<listitem><simpara> One characters consists of one fundamental piece. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-VARIABLE--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_VARIABLE</literal></term> -<listitem><simpara> One character consists of variable number of -fundamental pieces. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-BINARY--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_BINARY</literal></term> -<listitem><simpara> Charset is binary from ASCII viewpoint. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-REGULAR--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_REGULAR</literal></term> -<listitem><simpara> Language dependent (8bit) charset. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-CHARSET-MULTIBYTE--CAPS" role="constant"> -<term><literal>ENCA_CHARSET_MULTIBYTE</literal></term> -<listitem><simpara> Multibyte charset. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaNameStyle" role="enum"> -<title>enum EncaNameStyle</title> -<indexterm zone="EncaNameStyle"><primary sortas="EncaNameStyle">EncaNameStyle</primary></indexterm><programlisting>typedef enum { - ENCA_NAME_STYLE_ENCA, - ENCA_NAME_STYLE_RFC1345, - ENCA_NAME_STYLE_CSTOCS, - ENCA_NAME_STYLE_ICONV, - ENCA_NAME_STYLE_HUMAN, - ENCA_NAME_STYLE_MIME -} EncaNameStyle; -</programlisting> -<para> -Charset naming styles and conventions.</para> -<para> -</para><variablelist role="enum"> -<varlistentry id="ENCA-NAME-STYLE-ENCA--CAPS" role="constant"> -<term><literal>ENCA_NAME_STYLE_ENCA</literal></term> -<listitem><simpara> Default, implicit charset name in Enca. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-NAME-STYLE-RFC1345--CAPS" role="constant"> -<term><literal>ENCA_NAME_STYLE_RFC1345</literal></term> -<listitem><simpara> RFC 1345 or otherwise canonical charset name. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-NAME-STYLE-CSTOCS--CAPS" role="constant"> -<term><literal>ENCA_NAME_STYLE_CSTOCS</literal></term> -<listitem><simpara> Cstocs charset name (may not exist). -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-NAME-STYLE-ICONV--CAPS" role="constant"> -<term><literal>ENCA_NAME_STYLE_ICONV</literal></term> -<listitem><simpara> Iconv charset name (may not exist). -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-NAME-STYLE-HUMAN--CAPS" role="constant"> -<term><literal>ENCA_NAME_STYLE_HUMAN</literal></term> -<listitem><simpara> Human comprehensible description. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-NAME-STYLE-MIME--CAPS" role="constant"> -<term><literal>ENCA_NAME_STYLE_MIME</literal></term> -<listitem><simpara> Preferred MIME name (may not exist). -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaErrno" role="enum"> -<title>enum EncaErrno</title> -<indexterm zone="EncaErrno"><primary sortas="EncaErrno">EncaErrno</primary></indexterm><programlisting>typedef enum { - ENCA_EOK = 0, - ENCA_EINVALUE, - ENCA_EEMPTY, - ENCA_EFILTERED, - ENCA_ENOCS8, - ENCA_ESIGNIF, - ENCA_EWINNER, - ENCA_EGARBAGE -} EncaErrno; -</programlisting> -<para> -Error codes.</para> -<para> -</para><variablelist role="enum"> -<varlistentry id="ENCA-EOK--CAPS" role="constant"> -<term><literal>ENCA_EOK</literal></term> -<listitem><simpara> OK. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-EINVALUE--CAPS" role="constant"> -<term><literal>ENCA_EINVALUE</literal></term> -<listitem><simpara> Invalid value (usually of an option). -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-EEMPTY--CAPS" role="constant"> -<term><literal>ENCA_EEMPTY</literal></term> -<listitem><simpara> Sample is empty. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-EFILTERED--CAPS" role="constant"> -<term><literal>ENCA_EFILTERED</literal></term> -<listitem><simpara> After filtering, (almost) nothing remained. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-ENOCS8--CAPS" role="constant"> -<term><literal>ENCA_ENOCS8</literal></term> -<listitem><simpara> Mulitibyte tests failed and language contains no 8bit charsets. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-ESIGNIF--CAPS" role="constant"> -<term><literal>ENCA_ESIGNIF</literal></term> -<listitem><simpara> Too few significant characters. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-EWINNER--CAPS" role="constant"> -<term><literal>ENCA_EWINNER</literal></term> -<listitem><simpara> No clear winner. -</simpara></listitem> -</varlistentry> -<varlistentry id="ENCA-EGARBAGE--CAPS" role="constant"> -<term><literal>ENCA_EGARBAGE</literal></term> -<listitem><simpara> Sample is garbage. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="ENCA-NOT-A-CHAR--CAPS" role="macro"> -<title>ENCA_NOT_A_CHAR</title> -<indexterm zone="ENCA-NOT-A-CHAR--CAPS"><primary sortas="ENCA_NOT_A_CHAR">ENCA_NOT_A_CHAR</primary></indexterm><programlisting>#define ENCA_NOT_A_CHAR 0xffff -</programlisting> -<para> -Not-a-character in unicode tables.</para> -<para> -</para></refsect2> - -</refsect1> - - - - -</refentry> diff --git a/lib/enca/devel-docs/xml/internal.xml b/lib/enca/devel-docs/xml/internal.xml deleted file mode 100644 index 37fafc197a..0000000000 --- a/lib/enca/devel-docs/xml/internal.xml +++ /dev/null @@ -1,1328 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<refentry id="libenca-Internal-Functions"> -<refmeta> -<refentrytitle role="top_of_page" id="libenca-Internal-Functions.top_of_page">internal</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo>LIBENCA Library</refmiscinfo> -</refmeta> - -<refnamediv> -<refname>internal</refname> -<refpurpose><para> -internal functions -</para></refpurpose> -</refnamediv> - -<refsynopsisdiv id="libenca-Internal-Functions.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> - <link linkend="EncaAnalyserOptions">EncaAnalyserOptions</link>; - <link linkend="EncaAnalyserState">EncaAnalyserState</link>; - <link linkend="EncaCharsetInfo">EncaCharsetInfo</link>; - <link linkend="EncaLanguageInfo">EncaLanguageInfo</link>; - <link linkend="EncaLanguageHookData1CS">EncaLanguageHookData1CS</link>; - <link linkend="EncaLanguageHookDataEOL">EncaLanguageHookDataEOL</link>; -<link linkend="int">int</link> (<link linkend="EncaHookFunc">*EncaHookFunc</link>) (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="int">int</link> (<link linkend="EncaGuessFunc">*EncaGuessFunc</link>) (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); - <link linkend="EncaUTFCheckData">EncaUTFCheckData</link>; -#define <link linkend="ELEMENTS--CAPS">ELEMENTS</link> (array) -#define <link linkend="MAKE-HOOK-LINE--CAPS">MAKE_HOOK_LINE</link> (name) -#define <link linkend="EPSILON--CAPS">EPSILON</link> -#define <link linkend="FILL-NONLETTER--CAPS">FILL_NONLETTER</link> -#define <link linkend="LF--CAPS">LF</link> -#define <link linkend="CR--CAPS">CR</link> -<link linkend="void">void</link>* <link linkend="enca-malloc">enca_malloc</link> (<link linkend="size-t">size_t</link> size); -<link linkend="void">void</link>* <link linkend="enca-realloc">enca_realloc</link> (<link linkend="void">void</link> *ptr, - <link linkend="size-t">size_t</link> size); -#define <link linkend="enca-free">enca_free</link> (ptr) -#define <link linkend="NEW--CAPS">NEW</link> (type,n) -#define <link linkend="RENEW--CAPS">RENEW</link> (ptr,type,n) -<link linkend="char">char</link>* <link linkend="enca-strdup">enca_strdup</link> (const <link linkend="char">char</link> *s); -const <link linkend="char">char</link>* <link linkend="enca-strstr">enca_strstr</link> (const <link linkend="char">char</link> *haystack, - const <link linkend="char">char</link> *needle); -<link linkend="char">char</link>* <link linkend="enca-stpcpy">enca_stpcpy</link> (<link linkend="char">char</link> *dest, - const <link linkend="char">char</link> *src); -<link linkend="char">char</link>* <link linkend="enca-strconcat">enca_strconcat</link> (const <link linkend="char">char</link> *str, - ...); -<link linkend="char">char</link>* <link linkend="enca-strappend">enca_strappend</link> (<link linkend="char">char</link> *str, - ...); -#define <link linkend="enca-csname">enca_csname</link> (cs) -<link linkend="int">int</link> <link linkend="enca-name-to-charset">enca_name_to_charset</link> (const <link linkend="char">char</link> *csname); -<link linkend="EncaSurface">EncaSurface</link> <link linkend="enca-name-to-surface">enca_name_to_surface</link> (const <link linkend="char">char</link> *sname); -<link linkend="int">int</link> <link linkend="enca-language-init">enca_language_init</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - const <link linkend="char">char</link> *langname); -<link linkend="void">void</link> <link linkend="enca-language-destroy">enca_language_destroy</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="double">double</link>* <link linkend="enca-get-charset-similarity-matrix">enca_get_charset_similarity_matrix</link> (const <link linkend="EncaLanguageInfo">EncaLanguageInfo</link> *lang); -<link linkend="int">int</link> <link linkend="enca-charsets-subset-identical">enca_charsets_subset_identical</link> (<link linkend="int">int</link> charset1, - <link linkend="int">int</link> charset2, - const <link linkend="size-t">size_t</link> *counts); -<link linkend="size-t">size_t</link> <link linkend="enca-filter-boxdraw">enca_filter_boxdraw</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - unsigned <link linkend="char">char</link> fill_char); -<link linkend="int">int</link> <link linkend="enca-language-hook-ncs">enca_language_hook_ncs</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - <link linkend="size-t">size_t</link> ncs, - <link linkend="EncaLanguageHookData1CS">EncaLanguageHookData1CS</link> *hookdata); -<link linkend="int">int</link> <link linkend="enca-language-hook-eol">enca_language_hook_eol</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - <link linkend="size-t">size_t</link> ncs, - <link linkend="EncaLanguageHookDataEOL">EncaLanguageHookDataEOL</link> *hookdata); -<link linkend="void">void</link> <link linkend="enca-guess-init">enca_guess_init</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="void">void</link> <link linkend="enca-guess-destroy">enca_guess_destroy</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="EncaSurface">EncaSurface</link> <link linkend="enca-eol-surface">enca_eol_surface</link> (unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size, - const <link linkend="size-t">size_t</link> *counts); -<link linkend="void">void</link> <link linkend="enca-find-max-sec">enca_find_max_sec</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-BE--CAPS">ENCA_LANGUAGE_BE</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-BG--CAPS">ENCA_LANGUAGE_BG</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-CS--CAPS">ENCA_LANGUAGE_CS</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-ET--CAPS">ENCA_LANGUAGE_ET</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-HR--CAPS">ENCA_LANGUAGE_HR</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-HU--CAPS">ENCA_LANGUAGE_HU</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-LT--CAPS">ENCA_LANGUAGE_LT</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-LV--CAPS">ENCA_LANGUAGE_LV</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-PL--CAPS">ENCA_LANGUAGE_PL</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-RU--CAPS">ENCA_LANGUAGE_RU</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-SK--CAPS">ENCA_LANGUAGE_SK</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-SL--CAPS">ENCA_LANGUAGE_SL</link>; -extern const EncaLanguageInfo <link linkend="ENCA-LANGUAGE-UK--CAPS">ENCA_LANGUAGE_UK</link>; -<link linkend="void">void</link> <link linkend="enca-double-utf8-init">enca_double_utf8_init</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="void">void</link> <link linkend="enca-double-utf8-destroy">enca_double_utf8_destroy</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="void">void</link> <link linkend="enca-pair-init">enca_pair_init</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="void">void</link> <link linkend="enca-pair-destroy">enca_pair_destroy</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -<link linkend="int">int</link> <link linkend="enca-pair-analyse">enca_pair_analyse</link> (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser); -</synopsis> -</refsynopsisdiv> - - - - - - - - - -<refsect1 id="libenca-Internal-Functions.description" role="desc"> -<title role="desc.title">Description</title> -<para> -Do not use outside Enca library. -</para> -</refsect1> - -<refsect1 id="libenca-Internal-Functions.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="EncaAnalyserOptions" role="struct"> -<title>EncaAnalyserOptions</title> -<indexterm zone="EncaAnalyserOptions"><primary sortas="EncaAnalyserOptions">EncaAnalyserOptions</primary></indexterm><programlisting>typedef struct { - int const_buffer; - size_t min_chars; - double threshold; - int multibyte_enabled; - int interpreted_surfaces; - int ambiguous_mode; - int filtering; - int test_garbageness; - int termination_strictness; -} EncaAnalyserOptions; -</programlisting> -<para> -Analyser options, a part of analyser state.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term><link linkend="int">int</link> <structfield>const_buffer</structfield>;</term> -<listitem><simpara> Treat buffer as const? Otherwise its content can be, - and probably will be, modified. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>min_chars</structfield>;</term> -<listitem><simpara> Minimal number significant characters. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="double">double</link> <structfield>threshold</structfield>;</term> -<listitem><simpara> Minimal ratio between winner and the second. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>multibyte_enabled</structfield>;</term> -<listitem><simpara> Check for multibyte encodings? -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>interpreted_surfaces</structfield>;</term> -<listitem><simpara> Allow surfaces causing fundamental reinterpretation? -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>ambiguous_mode</structfield>;</term> -<listitem><simpara> Ambiguous mode? -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>filtering</structfield>;</term> -<listitem><simpara> Allow binary and box-drawing filters? -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>test_garbageness</structfield>;</term> -<listitem><simpara> Do test garbageness? -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>termination_strictness</structfield>;</term> -<listitem><simpara> Disallow broken multibyte sequences at buffer end? -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaAnalyserState" role="struct"> -<title>EncaAnalyserState</title> -<indexterm zone="EncaAnalyserState"><primary sortas="EncaAnalyserState">EncaAnalyserState</primary></indexterm><programlisting>typedef struct { - /* Language data. */ - const EncaLanguageInfo *lang; - size_t ncharsets; - int *charsets; - /* Analyser state. */ - EncaErrno gerrno; - size_t size; - unsigned char *buffer; - EncaEncoding result; - size_t *counts; - size_t bin; - size_t up; - double *ratings; - size_t *order; - size_t size2; - unsigned char *buffer2; - /* Double-UTF-8 data. */ - EncaUTFCheckData *utfch; - int *utfbuf; - /* Pair frequency data */ - unsigned char *pair2bits; - size_t *bitcounts; - size_t *pairratings; - /* LCUC data XXX: unused (yet) */ - size_t *lcbits; - size_t *ucbits; - /* Options. */ - EncaAnalyserOptions options; -} EncaAnalyserState; -</programlisting> -<para> -The internal analyser state. -</para> -<para> -Passed as an opaque object (`this') to analyser calls.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term>const <link linkend="EncaLanguageInfo">EncaLanguageInfo</link> *<structfield>lang</structfield>;</term> -<listitem><simpara> Language informations. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>ncharsets</structfield>;</term> -<listitem><simpara> Number of 8bit charsets in this language. - (Equal to <parameter>lang</parameter>->ncharsets.) -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> *<structfield>charsets</structfield>;</term> -<listitem><simpara> 8bit charset id's [<parameter>ncharsets</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaErrno">EncaErrno</link> <structfield>gerrno</structfield>;</term> -<listitem><simpara> Guessing gerrno. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>size</structfield>;</term> -<listitem><simpara> Size of buffer. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>unsigned <link linkend="char">char</link> *<structfield>buffer</structfield>;</term> -<listitem><simpara> Buffer whose encoding is to be detected [<parameter>size</parameter>]. - (Owned by outer world.) -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaEncoding">EncaEncoding</link> <structfield>result</structfield>;</term> -<listitem><simpara> Result returned to caller. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> *<structfield>counts</structfield>;</term> -<listitem><simpara> Character counts [0x100]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>bin</structfield>;</term> -<listitem><simpara> Number of `binary' characters. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>up</structfield>;</term> -<listitem><simpara> Number of 8bit characters. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="double">double</link> *<structfield>ratings</structfield>;</term> -<listitem><simpara> 8bit charset ratings [<parameter>ncharsets</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> *<structfield>order</structfield>;</term> -<listitem><simpara> Charset indices (not id's) sorted by ratings in descending order - [ncharsets]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>size2</structfield>;</term> -<listitem><simpara> Size of buffer2. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>unsigned <link linkend="char">char</link> *<structfield>buffer2</structfield>;</term> -<listitem><simpara> A temporary secondary buffer [<parameter>size2</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaUTFCheckData">EncaUTFCheckData</link> *<structfield>utfch</structfield>;</term> -<listitem><simpara> Double-UTF-8 test data [<parameter>ncharsets</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> *<structfield>utfbuf</structfield>;</term> -<listitem><simpara> Double-UTF-8 buffer for various UCS-2 character counting [0x10000]. - (Magic: see <link linkend="mark-scratch-buffer"><function>mark_scratch_buffer()</function></link> for description.) -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>unsigned <link linkend="char">char</link> *<structfield>pair2bits</structfield>;</term> -<listitem><simpara> Character pair map to charsets [0x100000] (indexed - 0x100*first + second). Each bit corresponds to one charset, - when set, the pair is `good' for the given charset. The - type is char, so it breaks for <parameter>ncharsets</parameter> > 8, but it should - not be accessed from outer world, so it can be easily enlarged - to more bits. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> *<structfield>bitcounts</structfield>;</term> -<listitem><simpara> Counts for each possible bit combinations in <parameter>pair2bits</parameter> - [0x1 << ncharsets]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> *<structfield>pairratings</structfield>;</term> -<listitem><simpara> Counts of `good' pairs per charset [<parameter>ncharsets</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> *<structfield>lcbits</structfield>;</term> -<listitem><simpara> If a character is lowercase in some charset, correspinding bit - is set [0x100]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> *<structfield>ucbits</structfield>;</term> -<listitem><simpara> If a character is uppercase in some charset, correspinding bit - is set [0x100]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaAnalyserOptions">EncaAnalyserOptions</link> <structfield>options</structfield>;</term> -<listitem><simpara> Analyser options. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaCharsetInfo" role="struct"> -<title>EncaCharsetInfo</title> -<indexterm zone="EncaCharsetInfo"><primary sortas="EncaCharsetInfo">EncaCharsetInfo</primary></indexterm><programlisting>typedef struct { - int enca; - int rfc1345; - int cstocs; - int iconv; - int mime; - const char *human; - unsigned int flags; - unsigned int nsurface; -} EncaCharsetInfo; -</programlisting> -<para> -General charset informnations. -</para> -<para> -All the <link linkend="int"><type>int</type></link> fields are indices in <link linkend="ALIAS-LIST--CAPS"><type>ALIAS_LIST</type></link>[].</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term><link linkend="int">int</link> <structfield>enca</structfield>;</term> -<listitem><simpara> Default, implicit name in enca. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>rfc1345</structfield>;</term> -<listitem><simpara> RFC1345 charset name. - (For charsets not in RFC1345, some canonical name is invented.) -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>cstocs</structfield>;</term> -<listitem><simpara> Cstocs charset name or -1. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>iconv</structfield>;</term> -<listitem><simpara> Iconv charset name or -1. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>mime</structfield>;</term> -<listitem><simpara> Preferred MIME charset name or -1. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>const <link linkend="char">char</link> *<structfield>human</structfield>;</term> -<listitem><simpara> Human comprehensible description. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>unsigned <link linkend="int">int</link> <structfield>flags</structfield>;</term> -<listitem><simpara> Charset properties (7bit, 8bit, multibyte, ...). -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>unsigned <link linkend="int">int</link> <structfield>nsurface</structfield>;</term> -<listitem><simpara> Natural surface (`implied' in recode). -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaLanguageInfo" role="struct"> -<title>EncaLanguageInfo</title> -<indexterm zone="EncaLanguageInfo"><primary sortas="EncaLanguageInfo">EncaLanguageInfo</primary></indexterm><programlisting>typedef struct { - const char *name; - const char *humanname; - size_t ncharsets; - const char *const *csnames; - const unsigned short int *const *weights; - const unsigned short int *significant; - const unsigned char *const *letters; - const unsigned char **const *pairs; - long int weight_sum; - EncaHookFunc hook; - EncaHookFunc eolhook; - EncaHookFunc lcuchook; - EncaHookFunc ratinghook; -} EncaLanguageInfo; -</programlisting> -<para> -Language specific data.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term>const <link linkend="char">char</link> *<structfield>name</structfield>;</term> -<listitem><simpara> Language name, or more precisely, locale name. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>const <link linkend="char">char</link> *<structfield>humanname</structfield>;</term> -<listitem><simpara> Normal human-readable [English] language name. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>ncharsets</structfield>;</term> -<listitem><simpara> Number of charsets in this language. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>const <link linkend="char">char</link> *const  *<structfield>csnames</structfield>;</term> -<listitem><simpara> Charset names [<parameter>ncharsets</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term>long <link linkend="int">int</link> <structfield>weight_sum</structfield>;</term> -<listitem><simpara> Sum of all <parameter>weights</parameter> (is the same for all charsets). -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaHookFunc">EncaHookFunc</link> <structfield>hook</structfield>;</term> -<listitem><simpara> Hook function (deciding hard cases). -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaHookFunc">EncaHookFunc</link> <structfield>eolhook</structfield>;</term> -<listitem><simpara> EOL hook function (deciding ambiguous cases based on EOL type). -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaHookFunc">EncaHookFunc</link> <structfield>lcuchook</structfield>;</term> -<listitem><simpara> -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaHookFunc">EncaHookFunc</link> <structfield>ratinghook</structfield>;</term> -<listitem><simpara> Helper to calculate ratings for weightingless languages. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaLanguageHookData1CS" role="struct"> -<title>EncaLanguageHookData1CS</title> -<indexterm zone="EncaLanguageHookData1CS"><primary sortas="EncaLanguageHookData1CS">EncaLanguageHookData1CS</primary></indexterm><programlisting>typedef struct { - const char *name; - size_t size; - const unsigned char *list; - size_t cs; -} EncaLanguageHookData1CS; -</programlisting> -<para> -Cointainer for data needed by <link linkend="enca-language-hook-ncs"><function>enca_language_hook_ncs()</function></link>.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term>const <link linkend="char">char</link> *<structfield>name</structfield>;</term> -<listitem><simpara> Charset name. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>size</structfield>;</term> -<listitem><simpara> Number of characters in <parameter>list</parameter>. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>cs</structfield>;</term> -<listitem><simpara> Charset number. This is an index in <parameter>analyser</parameter> arrays (like <parameter>charsets</parameter>), - NOT a charset id. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaLanguageHookDataEOL" role="struct"> -<title>EncaLanguageHookDataEOL</title> -<indexterm zone="EncaLanguageHookDataEOL"><primary sortas="EncaLanguageHookDataEOL">EncaLanguageHookDataEOL</primary></indexterm><programlisting>typedef struct { - const char *name; - EncaSurface eol; - size_t cs; -} EncaLanguageHookDataEOL; -</programlisting> -<para> -Cointainer for data needed by <link linkend="enca-language-hook-eol"><function>enca_language_hook_eol()</function></link>.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term>const <link linkend="char">char</link> *<structfield>name</structfield>;</term> -<listitem><simpara> Charset name. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="EncaSurface">EncaSurface</link> <structfield>eol</structfield>;</term> -<listitem><simpara> The corresponding <link linkend="EncaSurface"><type>EncaSurface</type></link> bit. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>cs</structfield>;</term> -<listitem><simpara> Charset number. This is an index in <parameter>analyser</parameter> arrays (like <parameter>charsets</parameter>), - NOT a charset id. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaHookFunc" role="function"> -<title>EncaHookFunc ()</title> -<indexterm zone="EncaHookFunc"><primary sortas="EncaHookFunc">EncaHookFunc</primary></indexterm><programlisting><link linkend="int">int</link> (*EncaHookFunc) (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Language hook function type. -</para> -<para> -Launches language specific hooks for a particular language.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser state whose charset ratings are to be modified. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero if charset ratigns have been actually modified, zero -otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaGuessFunc" role="function"> -<title>EncaGuessFunc ()</title> -<indexterm zone="EncaGuessFunc"><primary sortas="EncaGuessFunc">EncaGuessFunc</primary></indexterm><programlisting><link linkend="int">int</link> (*EncaGuessFunc) (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Special (multibyte) encoding check function type.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser state whose buffer should be checked. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero if analyser->result has been set, zero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="EncaUTFCheckData" role="struct"> -<title>EncaUTFCheckData</title> -<indexterm zone="EncaUTFCheckData"><primary sortas="EncaUTFCheckData">EncaUTFCheckData</primary></indexterm><programlisting>typedef struct { - double rating; - size_t size; - int result; - int *ucs2; - int *weights; -} EncaUTFCheckData; -</programlisting> -<para> -Data needed by double-UTF-8 check, per language charset.</para> -<para> -</para><variablelist role="struct"> -<varlistentry> -<term><link linkend="double">double</link> <structfield>rating</structfield>;</term> -<listitem><simpara> Total rating for this charset. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="size-t">size_t</link> <structfield>size</structfield>;</term> -<listitem><simpara> Number of UCS-2 characters. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> <structfield>result</structfield>;</term> -<listitem><simpara> Nonzero when the sample is probably Doubly-UTF-8 encoded from - this charset. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> *<structfield>ucs2</structfield>;</term> -<listitem><simpara> List of significant UCS-2 characters, in order [<parameter>size</parameter>]. -</simpara></listitem> -</varlistentry> -<varlistentry> -<term><link linkend="int">int</link> *<structfield>weights</structfield>;</term> -<listitem><simpara> Weights for double-UTF-8 check [<parameter>size</parameter>]. Positive means normal - UTF-8, negative doubly-encoded. -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="ELEMENTS--CAPS" role="macro"> -<title>ELEMENTS()</title> -<indexterm zone="ELEMENTS--CAPS"><primary sortas="ELEMENTS">ELEMENTS</primary></indexterm><programlisting>#define ELEMENTS(array) (sizeof(array)/sizeof((array)[0])) -</programlisting> -<para> -Compute the number of elements of a static array.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>array</parameter> :</term> -<listitem><simpara> An array whose size is to be computed. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of elements. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="MAKE-HOOK-LINE--CAPS" role="macro"> -<title>MAKE_HOOK_LINE()</title> -<indexterm zone="MAKE-HOOK-LINE--CAPS"><primary sortas="MAKE_HOOK_LINE">MAKE_HOOK_LINE</primary></indexterm><programlisting>#define MAKE_HOOK_LINE(name)</programlisting> -<para> -Ugly code `beautifier' macro for language hooks.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>name</parameter> :</term> -<listitem><simpara> A charset name in C-style identifier suitable form. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="EPSILON--CAPS" role="macro"> -<title>EPSILON</title> -<indexterm zone="EPSILON--CAPS"><primary sortas="EPSILON">EPSILON</primary></indexterm><programlisting>#define EPSILON 0.000001 -</programlisting> -<para> -`Zero' for float comparsion (and to prevent division by zero, etc.).</para> -<para> -</para></refsect2> -<refsect2 id="FILL-NONLETTER--CAPS" role="macro"> -<title>FILL_NONLETTER</title> -<indexterm zone="FILL-NONLETTER--CAPS"><primary sortas="FILL_NONLETTER">FILL_NONLETTER</primary></indexterm><programlisting>#define FILL_NONLETTER '.' -</programlisting> -<para> -Replacement character for non-letters in pair frequencies.</para> -<para> -</para></refsect2> -<refsect2 id="LF--CAPS" role="macro"> -<title>LF</title> -<indexterm zone="LF--CAPS"><primary sortas="LF">LF</primary></indexterm><programlisting>#define LF ((unsigned char)'\n') -</programlisting> -<para> -Line feed character (End-of-line on Unix).</para> -<para> -</para></refsect2> -<refsect2 id="CR--CAPS" role="macro"> -<title>CR</title> -<indexterm zone="CR--CAPS"><primary sortas="CR">CR</primary></indexterm><programlisting>#define CR ((unsigned char)'\r') -</programlisting> -<para> -Carriage return character (End-of-line on Macintosh).</para> -<para> -</para></refsect2> -<refsect2 id="enca-malloc" role="function"> -<title>enca_malloc ()</title> -<indexterm zone="enca-malloc"><primary sortas="enca_malloc">enca_malloc</primary></indexterm><programlisting><link linkend="void">void</link>* enca_malloc (<link linkend="size-t">size_t</link> size);</programlisting> -<para> -Allocates memory, always successfully (when fails, aborts program).</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>size</parameter> :</term> -<listitem><simpara> The number of bytes to allocate. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the newly allocated memory. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-realloc" role="function"> -<title>enca_realloc ()</title> -<indexterm zone="enca-realloc"><primary sortas="enca_realloc">enca_realloc</primary></indexterm><programlisting><link linkend="void">void</link>* enca_realloc (<link linkend="void">void</link> *ptr, - <link linkend="size-t">size_t</link> size);</programlisting> -<para> -Reallocates memory, always successfully (when fails, aborts program).</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>ptr</parameter> :</term> -<listitem><simpara> Pointer to block of previously allocated memory. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>size</parameter> :</term> -<listitem><simpara> The number of bytes to resize the block. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the newly allocated memory, <link linkend="NULL--CAPS"><type>NULL</type></link> when <parameter>size</parameter> is zero. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-free" role="macro"> -<title>enca_free()</title> -<indexterm zone="enca-free"><primary sortas="enca_free">enca_free</primary></indexterm><programlisting>#define enca_free(ptr)</programlisting> -<para> -Frees memory pointed by <parameter>ptr</parameter> with <link linkend="free"><function>free()</function></link> hack and assigns it a safe value, -thus may be called more than once. -</para> -<para> -<parameter>ptr</parameter> MUST be l-value.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>ptr</parameter> :</term> -<listitem><simpara> Pointer to memory to free. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="NEW--CAPS" role="macro"> -<title>NEW()</title> -<indexterm zone="NEW--CAPS"><primary sortas="NEW">NEW</primary></indexterm><programlisting>#define NEW(type,n) ((type*)enca_malloc((n)*sizeof(type))) -</programlisting> -<para> -An <link linkend="enca-malloc"><function>enca_malloc()</function></link> wrapper.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>type</parameter> :</term> -<listitem><simpara> Data type to allocate. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>n</parameter> :</term> -<listitem><simpara> Number of elements to allocate. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the newly allocated memory. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="RENEW--CAPS" role="macro"> -<title>RENEW()</title> -<indexterm zone="RENEW--CAPS"><primary sortas="RENEW">RENEW</primary></indexterm><programlisting>#define RENEW(ptr,type,n) ((type*)enca_realloc((ptr),(n)*sizeof(type))) -</programlisting> -<para> -An <link linkend="enca-realloc"><function>enca_realloc()</function></link> wrapper.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>ptr</parameter> :</term> -<listitem><simpara> Pointer to already allocate memory or <link linkend="NULL--CAPS"><type>NULL</type></link>. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>type</parameter> :</term> -<listitem><simpara> Data type to allocate. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>n</parameter> :</term> -<listitem><simpara> Number of elements to resize the memory to. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the reallocated memory (or pointer safe to call <link linkend="free"><function>free()</function></link> -on when <parameter>n</parameter> is zero). -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-strdup" role="function"> -<title>enca_strdup ()</title> -<indexterm zone="enca-strdup"><primary sortas="enca_strdup">enca_strdup</primary></indexterm><programlisting><link linkend="char">char</link>* enca_strdup (const <link linkend="char">char</link> *s);</programlisting> -<para> -Duplicates string. -</para> -<para> -Will be defined as <link linkend="strdup"><function>strdup()</function></link> when system provides it.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>s</parameter> :</term> -<listitem><simpara> A string. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly allocated string copy. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-strstr" role="function"> -<title>enca_strstr ()</title> -<indexterm zone="enca-strstr"><primary sortas="enca_strstr">enca_strstr</primary></indexterm><programlisting>const <link linkend="char">char</link>* enca_strstr (const <link linkend="char">char</link> *haystack, - const <link linkend="char">char</link> *needle);</programlisting> -<para> -Finds occurence of a substring in a string. -</para> -<para> -Will be defined as <link linkend="strstr"><function>strstr()</function></link> when system provides it.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>haystack</parameter> :</term> -<listitem><simpara> A string where to search. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>needle</parameter> :</term> -<listitem><simpara> A string to find. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the first occurence of <parameter>needle</parameter> in <parameter>haystack</parameter>; <link linkend="NULL--CAPS"><type>NULL</type></link> if - not found. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-stpcpy" role="function"> -<title>enca_stpcpy ()</title> -<indexterm zone="enca-stpcpy"><primary sortas="enca_stpcpy">enca_stpcpy</primary></indexterm><programlisting><link linkend="char">char</link>* enca_stpcpy (<link linkend="char">char</link> *dest, - const <link linkend="char">char</link> *src);</programlisting> -<para> -Appends a string to the end of another strings, returning pointer to -the terminating zero byte. -</para> -<para> -Will be defined as <link linkend="stpcpy"><function>stpcpy()</function></link> when system provides it. -</para> -<para> -Caller is responisble for providing <parameter>dest</parameter> long enough to hold the result.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>dest</parameter> :</term> -<listitem><simpara> A string. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>src</parameter> :</term> -<listitem><simpara> A string to append. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the terminating zero byte of resulting string. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-strconcat" role="function"> -<title>enca_strconcat ()</title> -<indexterm zone="enca-strconcat"><primary sortas="enca_strconcat">enca_strconcat</primary></indexterm><programlisting><link linkend="char">char</link>* enca_strconcat (const <link linkend="char">char</link> *str, - ...);</programlisting> -<para> -Concatenates arbitrary (but at least one) number of strings.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>str</parameter> :</term> -<listitem><simpara> A string. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>...</parameter> :</term> -<listitem><simpara> A <link linkend="NULL-terminated"><type>NULL-terminated</type></link> list of string to append. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> All the strings concatenated together. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-strappend" role="function"> -<title>enca_strappend ()</title> -<indexterm zone="enca-strappend"><primary sortas="enca_strappend">enca_strappend</primary></indexterm><programlisting><link linkend="char">char</link>* enca_strappend (<link linkend="char">char</link> *str, - ...);</programlisting> -<para> -Appends arbitrary number of strings to a string. -</para> -<para> -The string <parameter>str</parameter> is destroyed (reallocated), the others are kept.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>str</parameter> :</term> -<listitem><simpara> A string. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>...</parameter> :</term> -<listitem><simpara> A <link linkend="NULL-terminated"><type>NULL-terminated</type></link> list of string to append. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> All the strings concatenated together. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-csname" role="macro"> -<title>enca_csname()</title> -<indexterm zone="enca-csname"><primary sortas="enca_csname">enca_csname</primary></indexterm><programlisting>#define enca_csname(cs) enca_charset_name((cs), ENCA_NAME_STYLE_ENCA) -</programlisting> -<para> -A shorthand for printing names with <link linkend="ENCA-NAME-STYLE-ENCA--CAPS"><type>ENCA_NAME_STYLE_ENCA</type></link>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>cs</parameter> :</term> -<listitem><simpara> A charset id. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-name-to-charset" role="function"> -<title>enca_name_to_charset ()</title> -<indexterm zone="enca-name-to-charset"><primary sortas="enca_name_to_charset">enca_name_to_charset</primary></indexterm><programlisting><link linkend="int">int</link> enca_name_to_charset (const <link linkend="char">char</link> *csname);</programlisting> -<para> -Transforms charset name to numeric charset id.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>csname</parameter> :</term> -<listitem><simpara> The charset name. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The charset id; <link linkend="ENCA-CS-UNKNOWN--CAPS"><type>ENCA_CS_UNKNOWN</type></link> when the name is not recognized. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-name-to-surface" role="function"> -<title>enca_name_to_surface ()</title> -<indexterm zone="enca-name-to-surface"><primary sortas="enca_name_to_surface">enca_name_to_surface</primary></indexterm><programlisting><link linkend="EncaSurface">EncaSurface</link> enca_name_to_surface (const <link linkend="char">char</link> *sname);</programlisting> -<para> -Transforms surface name to numeric surface id.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>sname</parameter> :</term> -<listitem><simpara> The surface name. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The surface id; <link linkend="ENCA-SURFACE-UNKNOWN--CAPS"><literal>ENCA_SURFACE_UNKNOWN</literal></link> when the name is not -recognized. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-language-init" role="function"> -<title>enca_language_init ()</title> -<indexterm zone="enca-language-init"><primary sortas="enca_language_init">enca_language_init</primary></indexterm><programlisting><link linkend="int">int</link> enca_language_init (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - const <link linkend="char">char</link> *langname);</programlisting> -<para> -Initializes analyser for language <parameter>langname</parameter>. -</para> -<para> -Assumes <parameter>analyser</parameter> is unitinialized, calling with an initialized <parameter>analyser</parameter> -leads to memory leak.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state to be initialized for this language. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>langname</parameter> :</term> -<listitem><simpara> Two-letter ISO-639 language code. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero on success, zero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-language-destroy" role="function"> -<title>enca_language_destroy ()</title> -<indexterm zone="enca-language-destroy"><primary sortas="enca_language_destroy">enca_language_destroy</primary></indexterm><programlisting><link linkend="void">void</link> enca_language_destroy (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Destroys the language part of analyser state <parameter>analyser</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state whose language part should be destroyed. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-get-charset-similarity-matrix" role="function"> -<title>enca_get_charset_similarity_matrix ()</title> -<indexterm zone="enca-get-charset-similarity-matrix"><primary sortas="enca_get_charset_similarity_matrix">enca_get_charset_similarity_matrix</primary></indexterm><programlisting><link linkend="double">double</link>* enca_get_charset_similarity_matrix (const <link linkend="EncaLanguageInfo">EncaLanguageInfo</link> *lang);</programlisting> -<para> -Computes character weight similarity matrix for language <parameter>lang</parameter>. -</para> -<para> -sim[i,j] is normalized to sim[i,i] thus: -- a row i contains ,probabilities` different languages will look like the - i-th one -- a column i contains ,probabilities` the i-th language will look like - the other languages. -</para> -<para> -For all practical applications, the higher one of sim[i,j] and sim[j,i] -is important. -</para> -<para> -Note: this is not used anywhere, only by simtable.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>lang</parameter> :</term> -<listitem><simpara> A language. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The matrix, its size is determined by <parameter>lang</parameter>->ncharsets; <link linkend="NULL--CAPS"><type>NULL</type></link> - for language with no charsets. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-charsets-subset-identical" role="function"> -<title>enca_charsets_subset_identical ()</title> -<indexterm zone="enca-charsets-subset-identical"><primary sortas="enca_charsets_subset_identical">enca_charsets_subset_identical</primary></indexterm><programlisting><link linkend="int">int</link> enca_charsets_subset_identical (<link linkend="int">int</link> charset1, - <link linkend="int">int</link> charset2, - const <link linkend="size-t">size_t</link> *counts);</programlisting> -<para> -Checks whether all characters with nonzero count have the same meaning -in both charsets. -</para> -<para> -In other words, it checks whether conversion of sample containing only -these characters from <parameter>charset1</parameter> to <parameter>charset2</parameter> would be identity.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>charset1</parameter> :</term> -<listitem><simpara> A charset. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>charset2</parameter> :</term> -<listitem><simpara> Another charset. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>counts</parameter> :</term> -<listitem><simpara> An array of size 0x100 containing character counts. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero if charsets are identical on the subset, zero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-filter-boxdraw" role="function"> -<title>enca_filter_boxdraw ()</title> -<indexterm zone="enca-filter-boxdraw"><primary sortas="enca_filter_boxdraw">enca_filter_boxdraw</primary></indexterm><programlisting><link linkend="size-t">size_t</link> enca_filter_boxdraw (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - unsigned <link linkend="char">char</link> fill_char);</programlisting> -<para> -Runs boxdrawing characters filter on <parameter>buffer</parameter> for each charset in <parameter>language</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser whose charsets should be considered for filtration. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>fill_char</parameter> :</term> -<listitem><simpara> Replacement character for filtered bytes. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Number of characters filtered out. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-language-hook-ncs" role="function"> -<title>enca_language_hook_ncs ()</title> -<indexterm zone="enca-language-hook-ncs"><primary sortas="enca_language_hook_ncs">enca_language_hook_ncs</primary></indexterm><programlisting><link linkend="int">int</link> enca_language_hook_ncs (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - <link linkend="size-t">size_t</link> ncs, - <link linkend="EncaLanguageHookData1CS">EncaLanguageHookData1CS</link> *hookdata);</programlisting> -<para> -Decide between two charsets differing only in a few characters. -</para> -<para> -If the two most probable charsets correspond to <parameter>hookdata</parameter> charsets, -give the characters they differ half the weight of all other characters -together, thus allowing to decide between the two very similar charsets. -</para> -<para> -It also recomputes <parameter>order</parameter> when something changes.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser whose charset ratings are to be modified. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>ncs</parameter> :</term> -<listitem><simpara> The number of charsets. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>hookdata</parameter> :</term> -<listitem><simpara> What characters of which charsets should be given the extra - weight. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when <parameter>ratings</parameter> were actually modified, nonzero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-language-hook-eol" role="function"> -<title>enca_language_hook_eol ()</title> -<indexterm zone="enca-language-hook-eol"><primary sortas="enca_language_hook_eol">enca_language_hook_eol</primary></indexterm><programlisting><link linkend="int">int</link> enca_language_hook_eol (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser, - <link linkend="size-t">size_t</link> ncs, - <link linkend="EncaLanguageHookDataEOL">EncaLanguageHookDataEOL</link> *hookdata);</programlisting> -<para> -Decide between two charsets differing only in EOL type or other surface. -</para> -<para> -The (surface mask, charset) pairs are scanned in order. If a matching -surface is found, ratings of all other charsets in the list are zeroed. -So you can place a surface mask of all 1s at the end to match when nothing -else matches. -</para> -<para> -All the charsets have to have the same rating, or nothing happens. -</para> -<para> -It also recomputes <parameter>order</parameter> when something changes.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser whose charset ratings are to be modified. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>ncs</parameter> :</term> -<listitem><simpara> The number of charsets. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>hookdata</parameter> :</term> -<listitem><simpara> What characters of which charsets should be decided with based - on the EOL type. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when <parameter>ratings</parameter> were actually modified, nonzero otherwise. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-guess-init" role="function"> -<title>enca_guess_init ()</title> -<indexterm zone="enca-guess-init"><primary sortas="enca_guess_init">enca_guess_init</primary></indexterm><programlisting><link linkend="void">void</link> enca_guess_init (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Allocates and initializes analyser state, sets options to defaults. -</para> -<para> -Assumes <parameter>analyser</parameter> is unitinialized, calling with an initialized <parameter>analyser</parameter> -leads to memory leak, but <parameter>analyser</parameter>->lang must be already initialized.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser to initialize. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-guess-destroy" role="function"> -<title>enca_guess_destroy ()</title> -<indexterm zone="enca-guess-destroy"><primary sortas="enca_guess_destroy">enca_guess_destroy</primary></indexterm><programlisting><link linkend="void">void</link> enca_guess_destroy (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Frees memory owned by analyser state.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyser to destroy. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-eol-surface" role="function"> -<title>enca_eol_surface ()</title> -<indexterm zone="enca-eol-surface"><primary sortas="enca_eol_surface">enca_eol_surface</primary></indexterm><programlisting><link linkend="EncaSurface">EncaSurface</link> enca_eol_surface (unsigned <link linkend="char">char</link> *buffer, - <link linkend="size-t">size_t</link> size, - const <link linkend="size-t">size_t</link> *counts);</programlisting> -<para> -Find EOL type of sample in <parameter>buffer</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>buffer</parameter> :</term> -<listitem><simpara> A buffer whose EOL type is to be detected. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>size</parameter> :</term> -<listitem><simpara> Size of <parameter>buffer</parameter>. -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>counts</parameter> :</term> -<listitem><simpara> Character counts. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The EOL surface flags. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-find-max-sec" role="function"> -<title>enca_find_max_sec ()</title> -<indexterm zone="enca-find-max-sec"><primary sortas="enca_find_max_sec">enca_find_max_sec</primary></indexterm><programlisting><link linkend="void">void</link> enca_find_max_sec (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Updates <parameter>analyser</parameter>->order according to charset <parameter>ratings</parameter>. -</para> -<para> -XXX: This should be stable sort. The ordering is defined by -data/<lang>/<lang>.h header file which is in turn defined by odering in -the appropriate script (doit.sh). Silly. -</para> -<para> -Must not be called with <parameter>analyser</parameter> with no regular charsets.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> An analyser. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="ENCA-LANGUAGE-BE--CAPS" role="variable"> -<title>ENCA_LANGUAGE_BE</title> -<indexterm zone="ENCA-LANGUAGE-BE--CAPS"><primary sortas="ENCA_LANGUAGE_BE">ENCA_LANGUAGE_BE</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_BE; -</programlisting> -<para> -Belarussian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-BG--CAPS" role="variable"> -<title>ENCA_LANGUAGE_BG</title> -<indexterm zone="ENCA-LANGUAGE-BG--CAPS"><primary sortas="ENCA_LANGUAGE_BG">ENCA_LANGUAGE_BG</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_BG; -</programlisting> -<para> -Bulgarian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-CS--CAPS" role="variable"> -<title>ENCA_LANGUAGE_CS</title> -<indexterm zone="ENCA-LANGUAGE-CS--CAPS"><primary sortas="ENCA_LANGUAGE_CS">ENCA_LANGUAGE_CS</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_CS; -</programlisting> -<para> -Czech language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-ET--CAPS" role="variable"> -<title>ENCA_LANGUAGE_ET</title> -<indexterm zone="ENCA-LANGUAGE-ET--CAPS"><primary sortas="ENCA_LANGUAGE_ET">ENCA_LANGUAGE_ET</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_ET; -</programlisting> -<para> -Estonian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-HR--CAPS" role="variable"> -<title>ENCA_LANGUAGE_HR</title> -<indexterm zone="ENCA-LANGUAGE-HR--CAPS"><primary sortas="ENCA_LANGUAGE_HR">ENCA_LANGUAGE_HR</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_HR; -</programlisting> -<para> -Croatian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-HU--CAPS" role="variable"> -<title>ENCA_LANGUAGE_HU</title> -<indexterm zone="ENCA-LANGUAGE-HU--CAPS"><primary sortas="ENCA_LANGUAGE_HU">ENCA_LANGUAGE_HU</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_HU; -</programlisting> -<para> -Hungarian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-LT--CAPS" role="variable"> -<title>ENCA_LANGUAGE_LT</title> -<indexterm zone="ENCA-LANGUAGE-LT--CAPS"><primary sortas="ENCA_LANGUAGE_LT">ENCA_LANGUAGE_LT</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_LT; -</programlisting> -<para> -Lithuanian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-LV--CAPS" role="variable"> -<title>ENCA_LANGUAGE_LV</title> -<indexterm zone="ENCA-LANGUAGE-LV--CAPS"><primary sortas="ENCA_LANGUAGE_LV">ENCA_LANGUAGE_LV</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_LV; -</programlisting> -<para> -Latvian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-PL--CAPS" role="variable"> -<title>ENCA_LANGUAGE_PL</title> -<indexterm zone="ENCA-LANGUAGE-PL--CAPS"><primary sortas="ENCA_LANGUAGE_PL">ENCA_LANGUAGE_PL</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_PL; -</programlisting> -<para> -Polish language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-RU--CAPS" role="variable"> -<title>ENCA_LANGUAGE_RU</title> -<indexterm zone="ENCA-LANGUAGE-RU--CAPS"><primary sortas="ENCA_LANGUAGE_RU">ENCA_LANGUAGE_RU</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_RU; -</programlisting> -<para> -Russian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-SK--CAPS" role="variable"> -<title>ENCA_LANGUAGE_SK</title> -<indexterm zone="ENCA-LANGUAGE-SK--CAPS"><primary sortas="ENCA_LANGUAGE_SK">ENCA_LANGUAGE_SK</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_SK; -</programlisting> -<para> -Slovak language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-SL--CAPS" role="variable"> -<title>ENCA_LANGUAGE_SL</title> -<indexterm zone="ENCA-LANGUAGE-SL--CAPS"><primary sortas="ENCA_LANGUAGE_SL">ENCA_LANGUAGE_SL</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_SL; -</programlisting> -<para> -Slovene language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="ENCA-LANGUAGE-UK--CAPS" role="variable"> -<title>ENCA_LANGUAGE_UK</title> -<indexterm zone="ENCA-LANGUAGE-UK--CAPS"><primary sortas="ENCA_LANGUAGE_UK">ENCA_LANGUAGE_UK</primary></indexterm><programlisting>extern const EncaLanguageInfo ENCA_LANGUAGE_UK; -</programlisting> -<para> -Ukrainian language. -</para> -<para> -Everything the world out there needs to know about this language.</para> -<para> -</para></refsect2> -<refsect2 id="enca-double-utf8-init" role="function"> -<title>enca_double_utf8_init ()</title> -<indexterm zone="enca-double-utf8-init"><primary sortas="enca_double_utf8_init">enca_double_utf8_init</primary></indexterm><programlisting><link linkend="void">void</link> enca_double_utf8_init (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Initializes double-UTF-8 check. -</para> -<para> -In fact it initializes the fields to <link linkend="NULL--CAPS"><type>NULL</type></link>'s, they are actually initialized -only when needed.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state to be initialized. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-double-utf8-destroy" role="function"> -<title>enca_double_utf8_destroy ()</title> -<indexterm zone="enca-double-utf8-destroy"><primary sortas="enca_double_utf8_destroy">enca_double_utf8_destroy</primary></indexterm><programlisting><link linkend="void">void</link> enca_double_utf8_destroy (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Destroys the double-UTF-8 check part of analyser state <parameter>analyser</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state whose double-UTF-8 check part should be destroyed. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-pair-init" role="function"> -<title>enca_pair_init ()</title> -<indexterm zone="enca-pair-init"><primary sortas="enca_pair_init">enca_pair_init</primary></indexterm><programlisting><link linkend="void">void</link> enca_pair_init (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Initializes pair statistics data. -</para> -<para> -In fact it just sets everything to <link linkend="NULL--CAPS"><type>NULL</type></link>, to be initialized when needed.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state to be initialized. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-pair-destroy" role="function"> -<title>enca_pair_destroy ()</title> -<indexterm zone="enca-pair-destroy"><primary sortas="enca_pair_destroy">enca_pair_destroy</primary></indexterm><programlisting><link linkend="void">void</link> enca_pair_destroy (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Destroys the pair statistics part of analyser state <parameter>analyser</parameter>.</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analyzer state whose pair statistics part should be destroyed. -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="enca-pair-analyse" role="function"> -<title>enca_pair_analyse ()</title> -<indexterm zone="enca-pair-analyse"><primary sortas="enca_pair_analyse">enca_pair_analyse</primary></indexterm><programlisting><link linkend="int">int</link> enca_pair_analyse (<link linkend="EncaAnalyserState">EncaAnalyserState</link> *analyser);</programlisting> -<para> -Performs pair-frequency based analysis, provided that the language supports -it (does nothing otherwise).</para> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>analyser</parameter> :</term> -<listitem><simpara> Analysed containing the sample for pair frequency analysis. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Nonzero when the character set was succesfully determined, - <parameter>analyser</parameter>-><parameter>result</parameter>.<parameter>charset</parameter> is then directly modified. -</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - - - - -</refentry> diff --git a/lib/enca/devel-docs/xml/libenca-doc.bottom b/lib/enca/devel-docs/xml/libenca-doc.bottom deleted file mode 100644 index 27385094b8..0000000000 --- a/lib/enca/devel-docs/xml/libenca-doc.bottom +++ /dev/null @@ -1,5 +0,0 @@ - <xi:include href="xml/enums.xml"/> - <xi:include href="xml/analyser.xml"/> - <xi:include href="xml/encodings.xml"/> - <xi:include href="xml/auxiliary.xml"/> - <xi:include href="xml/internal.xml"/> diff --git a/lib/enca/devel-docs/xml/libenca-doc.top b/lib/enca/devel-docs/xml/libenca-doc.top deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/enca/devel-docs/xml/libenca-doc.top +++ /dev/null diff --git a/lib/enca/devel-docs/xml/object_index.sgml b/lib/enca/devel-docs/xml/object_index.sgml deleted file mode 100644 index 229837e7ef..0000000000 --- a/lib/enca/devel-docs/xml/object_index.sgml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE informaltable PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<informaltable pgwide="1" frame="none"> -<tgroup cols="3"> -<colspec colwidth="1*"/> -<colspec colwidth="1*"/> -<colspec colwidth="1*"/> -<tbody> -<row><entry> </entry></row> -</tbody></tgroup></informaltable> diff --git a/lib/enca/devel-docs/xml/tree_index.sgml b/lib/enca/devel-docs/xml/tree_index.sgml deleted file mode 100644 index 6f979c8836..0000000000 --- a/lib/enca/devel-docs/xml/tree_index.sgml +++ /dev/null @@ -1,5 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE screen PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<screen> -</screen> |