From: DongHun Kwak Date: Wed, 11 Oct 2017 08:32:07 +0000 (+0900) Subject: Imported Upstream version 0.2.6 X-Git-Tag: upstream/0.2.6 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F55%2F154755%2F1;p=platform%2Fupstream%2Flibdatrie.git Imported Upstream version 0.2.6 Change-Id: I51ac4a77e67728a4da6f9f154b30e05de3284aa0 Signed-off-by: DongHun Kwak --- diff --git a/ChangeLog b/ChangeLog index c3b480d..baa1859 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,166 @@ +2013-01-23 Theppitak Karoonboonyanan + + * NEWS, configure.ac: + === Version 0.2.6 === + +2013-01-22 Theppitak Karoonboonyanan + + Use xz compression for release tarball. + + * configure.ac: + - Specify "dist-xz no-dist-gzip" options to AM_INIT_AUTOMAKE. + +2012-08-06 Theppitak Karoonboonyanan + + Improve AlphaMap range merging. + + * datrie/alpha-map.c (alpha_map_add_range): + - Also try to merge adjacent ranges. Otherwise, adding one by one + character will result in linear search on alphabet set. + + Thanks Mikhail Korobov for the report. + +2012-08-05 Theppitak Karoonboonyanan + + Migrate trie_enumerate() to the new TrieIterator. + + This improves performance by 10%, and recursion stacks are also + eliminated. + + * datrie/trie.c (trie_enumerate): + - Replace da_enumerate() call with TrieIterator loop. + * datrie/trie.c (-trie_da_enum_func, -_TrieEnumData): + * datrie/darray.h, datrie/darray.c + (-da_enumerate, -da_get_transition_key, -DAEnumFunc, + -da_enumerate_recursive): + - Drop now-unused codes. + +2012-08-05 Theppitak Karoonboonyanan + + Optimize key calculation for TrieIterator. + + * datrie/Makefile.am +datrie/dstring.h +datrie/dstring-private.h + +datrie/dstring.c +datrie/trie-string.h +datrie/trie-string.c: + - Add dynamic string classes DString and TrieString. + * datrie/trie.c: + - (TrieIterator): Add "key" dynamic trie string member for + incrementally gathering the key while iterating. + - Initialize "key" member to NULL on construction. Only allocate and + free it on branching root states. + * datrie/darray.h, datrie/darray.c + (da_first_separate, da_next_separate): + - Instead of allocating memory for return string, accept a dynamic + string object and update it while traversing. + * datrie/trie.c (trie_iterator_next): + - For branching state, create the "key" dynamic string object on + first iteration and pass it to da_first_separate() and + da_next_separate() along the iterations. + * datrie/trie.c (trie_iterator_get_key): + - Replace the total key reconstruction by da_get_transition_key() + with simple string catenation of the dynamic "key" and the suffix + string. + * datrie/darray.h, datrie/darray.c (da_get_transition_key): + - Adjust to use dynamic string instead of total allocation. + * datrie/darray.c (da_enumerate_recursive): + - Adjust the da_get_transition_key() call accordingly. + + Thanks Mikhail Korobov for the suggested approach + and for profiling check. + +2012-07-31 Theppitak Karoonboonyanan + + Add TrieIterator and its operations. + + * datrie/trie.h, datrie/trie.c + (+trie_iterator_new, +trie_iterator_free, +trie_iterator_next, + +trie_iterator_get_key, +trie_iterator_get_data): + - Add TrieIterator class and its methods. + * datrie/libdatrie.def, datrie/libdatrie.map: + - Add the new export symbols. + * datrie/darray.h, datrie/darray.c + (da_get_state_key -> da_get_transition_key): + - Adjust da_get_state_key() from getting transition key from root + to getting from arbitrary ancestor. + * datrie/darray.h, datrie/darray.c + (+da_first_separate, +da_next_separate): + - Add internal functions for iterating from one separate node to + another in double-array structure. + + Thanks Mikhail Korobov for the use case suggestion. + +2012-07-30 Theppitak Karoonboonyanan + + * doc/Doxyfile.in: Upgrade to doxygen 1.8.1.2 format. + +2012-07-29 Theppitak Karoonboonyanan + + * datrie/trie.c: Reformat source. + +2012-07-29 Theppitak Karoonboonyanan + + * datrie/trie.h, datrie/trie.c (trie_state_walkable_chars): + Reformat source. + +2012-07-27 Theppitak Karoonboonyanan + + Add new API trie_state_walkable_chars() to allow breadth-first + traversal. + + * datrie/darray.h, datrie/darray.c: + - Move da_output_symbols() to darray.h, to be called by the new + function. + - Move the Symbols class to darray.h, as required by + da_output_symbols(). + * datrie/trie.h, datrie/trie.c (+trie_state_walkable_chars): + - Add the new public function. + * datrie/libdatrie.map, datrie/libdatrie.def: + - Add the new symbol to export maps. + * configure.ac: + - Update library versioning to reflect API addition. + +2012-07-26 Theppitak Karoonboonyanan + + * darray/darray.c (da_has_children): Accept (const DArray *) arg. + +2012-07-26 Theppitak Karoonboonyanan + + * datrie/darray.c (da_has_children, da_output_symbols, + da_relocate_base): + Calculate max_c candidate using num_cells - base instead of + TRIE_INDEX_MAX - base, to prevent more unnecessary loops. + +2012-07-26 Theppitak Karoonboonyanan + + * datrie/trie.c (trie_state_get_data): + Check if the state is leaf, not just suffix, before getting data. + + Thanks Mikhail Korobov for the report. + +2012-07-25 Theppitak Karoonboonyanan + + * datrie/tail.h, datrie/tail.c: + * datrie/alpha-map.c: + * datrie/trie.h, datrie/trie.c: + * datrie/darray.c: Remove trailing spaces. + +2012-07-13 Theppitak Karoonboonyanan + + * datrie/tail.c (tail_get_suffix): Fix function documentation. + + Thanks Mikhail Korobov for the report. + +2012-07-13 Theppitak Karoonboonyanan + + * datrie/darray.c, datrie/tail.c: + - Don't include when compiled with MSVC, as the header is + missing there, and SIZE_MAX is provided in some other header. + + Thanks Mikhail Korobov for the report. + +2012-07-13 Theppitak Karoonboonyanan + + * configure.ac: Post-release version suffix added. + 2011-11-04 Theppitak Karoonboonyanan * NEWS, configure.ac: diff --git a/NEWS b/NEWS index 247907c..a6c40fb 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,14 @@ libdatrie +0.2.6 (2013-01-23) +===== +- New API trie_state_walkable_chars() for breadth-first traversal. +- New class TrieIterator for callback-free enumeration. +- Improved performance on key enumeration. +- Improved AlphaMap range merging. +- Bug fixes. +[Many thanks to Mikhail Korobov for improvements in this version.] + 0.2.5 (2011-11-04) ===== - Fix missing 'extern "C"' in header file. [Patch from Aurimas Černius] diff --git a/configure.ac b/configure.ac index 99059e4..11cb008 100644 --- a/configure.ac +++ b/configure.ac @@ -2,20 +2,20 @@ # Process this file with autoconf to produce a configure script. AC_PREREQ(2.59) -AC_INIT(libdatrie, 0.2.5, thep@linux.thai.net) +AC_INIT(libdatrie, 0.2.6, thep@linux.thai.net) AC_CONFIG_SRCDIR([datrie/trie.h]) AC_CONFIG_HEADER([config.h]) AC_CONFIG_MACRO_DIR([m4]) -AM_INIT_AUTOMAKE +AM_INIT_AUTOMAKE(dist-xz no-dist-gzip) # Library versioning # Library code modified: REVISION++ # Interfaces added: CURRENT++ REVISION=0 AGE++ # Interfaces changed/removed: CURRENT++ REVISION=0 AGE=0 -LT_CURRENT=2 +LT_CURRENT=3 LT_REVISION=0 -LT_AGE=1 +LT_AGE=2 AC_SUBST(LT_CURRENT) AC_SUBST(LT_REVISION) AC_SUBST(LT_AGE) diff --git a/datrie/Makefile.am b/datrie/Makefile.am index d40d582..9d567ff 100644 --- a/datrie/Makefile.am +++ b/datrie/Makefile.am @@ -16,6 +16,11 @@ libdatrie_la_SOURCES = \ typedefs.h \ triedefs.h \ trie-private.h \ + dstring.h \ + dstring-private.h \ + dstring.c \ + trie-string.h \ + trie-string.c \ fileutils.h \ fileutils.c \ darray.h \ diff --git a/datrie/alpha-map.c b/datrie/alpha-map.c index 9ce2ddc..86afdbc 100644 --- a/datrie/alpha-map.c +++ b/datrie/alpha-map.c @@ -151,7 +151,7 @@ alpha_map_free (AlphaMap *alpha_map) { AlphaRange *p, *q; - p = alpha_map->first_range; + p = alpha_map->first_range; while (p) { q = p->next; free (p); @@ -264,20 +264,28 @@ alpha_map_add_range (AlphaMap *alpha_map, AlphaChar begin, AlphaChar end) begin_node = r; break; } + if (r->end + 1 == begin) { + /* 'begin' is next to 'r'-end + * -> extend 'r'-end to cover 'begin' + */ + r->end = begin; + begin_node = r; + break; + } } - if (!begin_node && r && r->begin <= end) { + if (!begin_node && r && r->begin <= end + 1) { /* ['begin', 'end'] overlaps into 'r'-begin + * or 'r' is next to 'end' if r->begin == end + 1 * -> extend 'r'-begin to include the range */ r->begin = begin; begin_node = r; } /* Run upto the first range that exceeds 'end' */ - while (r && r->begin <= end) { + while (r && r->begin <= end + 1) { if (end <= r->end) { /* 'r' covers 'end' -> take 'r' as ending point */ end_node = r; - break; } else if (r != begin_node) { /* ['begin', 'end'] covers the whole 'r' -> remove 'r' */ if (q) { @@ -289,10 +297,10 @@ alpha_map_add_range (AlphaMap *alpha_map, AlphaChar begin, AlphaChar end) free (r); r = alpha_map->first_range; } - } else { - q = r; - r = r->next; + continue; } + q = r; + r = r->next; } if (!end_node && q && begin <= q->end) { /* ['begin', 'end'] overlaps 'q' at the end diff --git a/datrie/darray.c b/datrie/darray.c index 234e904..8d976a6 100644 --- a/datrie/darray.c +++ b/datrie/darray.c @@ -26,7 +26,9 @@ #include #include -#include +#ifndef _MSC_VER /* for SIZE_MAX */ +# include +#endif #include #include "trie-private.h" @@ -37,19 +39,11 @@ * INTERNAL TYPES DECLARATIONS * *----------------------------------*/ -typedef struct _Symbols Symbols; - struct _Symbols { short num_symbols; TrieChar symbols[256]; }; -static Symbols * symbols_new (); -static void symbols_free (Symbols *syms); -static void symbols_add (Symbols *syms, TrieChar c); - -#define symbols_num(s) ((s)->num_symbols) -#define symbols_get(s,i) ((s)->symbols[i]) #define symbols_add_fast(s,c) ((s)->symbols[(s)->num_symbols++] = c) /*-----------------------------------* @@ -61,15 +55,9 @@ static void symbols_add (Symbols *syms, TrieChar c); static Bool da_check_free_cell (DArray *d, TrieIndex s); -static Bool da_has_children (DArray *d, - TrieIndex s); - -static Symbols * da_output_symbols (const DArray *d, +static Bool da_has_children (const DArray *d, TrieIndex s); -static TrieChar * da_get_state_key (const DArray *d, - TrieIndex state); - static TrieIndex da_find_free_base (DArray *d, const Symbols *symbols); @@ -90,18 +78,13 @@ static void da_alloc_cell (DArray *d, static void da_free_cell (DArray *d, TrieIndex cell); -static Bool da_enumerate_recursive (const DArray *d, - TrieIndex state, - DAEnumFunc enum_func, - void *user_data); - /* ==================== BEGIN IMPLEMENTATION PART ==================== */ /*------------------------------------* * INTERNAL TYPES IMPLEMENTATIONS * *------------------------------------*/ -static Symbols * +Symbols * symbols_new () { Symbols *syms; @@ -116,13 +99,13 @@ symbols_new () return syms; } -static void +void symbols_free (Symbols *syms) { free (syms); } -static void +void symbols_add (Symbols *syms, TrieChar c) { short lower, upper; @@ -148,6 +131,19 @@ symbols_add (Symbols *syms, TrieChar c) syms->num_symbols++; } +int +symbols_num (const Symbols *syms) +{ + return syms->num_symbols; +} + +TrieChar +symbols_get (const Symbols *syms, int index) +{ + return syms->symbols[index]; +} + + /*------------------------------* * PRIVATE DATA DEFINITONS * *------------------------------*/ @@ -426,7 +422,7 @@ da_walk (const DArray *d, TrieIndex *s, TrieChar c) * * @return the index of the new node * - * Insert a new arc labelled with character @a c from the trie node + * Insert a new arc labelled with character @a c from the trie node * represented by index @a s in double-array structure @a d. * Note that it assumes that no such arc exists before inserting. */ @@ -492,7 +488,7 @@ da_check_free_cell (DArray *d, } static Bool -da_has_children (DArray *d, +da_has_children (const DArray *d, TrieIndex s) { TrieIndex base; @@ -502,7 +498,7 @@ da_has_children (DArray *d, if (TRIE_INDEX_ERROR == base || base < 0) return FALSE; - max_c = MIN_VAL (TRIE_CHAR_MAX, TRIE_INDEX_MAX - base); + max_c = MIN_VAL (TRIE_CHAR_MAX, d->num_cells - base); for (c = 0; c < max_c; c++) { if (da_get_check (d, base + c) == s) return TRUE; @@ -511,7 +507,7 @@ da_has_children (DArray *d, return FALSE; } -static Symbols * +Symbols * da_output_symbols (const DArray *d, TrieIndex s) { @@ -522,7 +518,7 @@ da_output_symbols (const DArray *d, syms = symbols_new (); base = da_get_base (d, s); - max_c = MIN_VAL (TRIE_CHAR_MAX, TRIE_INDEX_MAX - base); + max_c = MIN_VAL (TRIE_CHAR_MAX, d->num_cells - base); for (c = 0; c < max_c; c++) { if (da_get_check (d, base + c) == s) symbols_add_fast (syms, (TrieChar) c); @@ -531,44 +527,6 @@ da_output_symbols (const DArray *d, return syms; } -static TrieChar * -da_get_state_key (const DArray *d, - TrieIndex state) -{ - TrieChar *key; - int key_size, key_length; - int i; - - key_size = 20; - key_length = 0; - key = (TrieChar *) malloc (key_size); - - /* trace back to root */ - while (da_get_root (d) != state) { - TrieIndex parent; - - if (key_length + 1 >= key_size) { - key_size += 20; - key = (TrieChar *) realloc (key, key_size); - } - parent = da_get_check (d, state); - key[key_length++] = (TrieChar) (state - da_get_base (d, parent)); - state = parent; - } - key[key_length] = '\0'; - - /* reverse the string */ - for (i = 0; i < --key_length; i++) { - TrieChar temp; - - temp = key[i]; - key[i] = key[key_length]; - key[key_length] = temp; - } - - return key; -} - static TrieIndex da_find_free_base (DArray *d, const Symbols *symbols) @@ -658,7 +616,7 @@ da_relocate_base (DArray *d, if (old_next_base > 0) { TrieIndex c, max_c; - max_c = MIN_VAL (TRIE_CHAR_MAX, TRIE_INDEX_MAX - old_next_base); + max_c = MIN_VAL (TRIE_CHAR_MAX, d->num_cells - old_next_base); for (c = 0; c < max_c; c++) { if (da_get_check (d, old_next_base + c) == old_next) da_set_check (d, old_next_base + c, new_next); @@ -719,7 +677,7 @@ da_extend_pool (DArray *d, * @param s : the dangling state to prune off * * Prune off a non-separate path up from the final state @a s. - * If @a s still has some children states, it does nothing. Otherwise, + * If @a s still has some children states, it does nothing. Otherwise, * it deletes the node and all its parents which become non-separate. */ void @@ -786,57 +744,95 @@ da_free_cell (DArray *d, } /** - * @brief Enumerate entries stored in double-array structure + * @brief Find first separate node in a sub-trie + * + * @param d : the double-array structure + * @param root : the sub-trie root to search from + * @param keybuff : the TrieString buffer for incrementally calcuating key * - * @param d : the double-array structure - * @param enum_func : the callback function to be called on each separate node - * @param user_data : user-supplied data to send as an argument to @a enum_func + * @return index to the first separate node; TRIE_INDEX_ERROR on any failure * - * @return boolean value indicating whether all the keys are visited + * Find the first separate node under a sub-trie rooted at @a root. * - * Enumerate all keys stored in double-array structure. For each entry, the - * user-supplied @a enum_func callback function is called, with the entry key, - * the separate node, and user-supplied data. Returning FALSE from such - * callback will stop enumeration and return FALSE. + * On return, @a keybuff is appended with the key characters which walk from + * @a root to the separate node. This is for incrementally calculating the + * transition key, which is more efficient than later totally reconstructing + * key from the given separate node. + * + * Available since: 0.2.6 */ -Bool -da_enumerate (const DArray *d, DAEnumFunc enum_func, void *user_data) +TrieIndex +da_first_separate (DArray *d, TrieIndex root, TrieString *keybuff) { - return da_enumerate_recursive (d, da_get_root (d), enum_func, user_data); -} + TrieIndex base; + TrieChar c, max_c; -static Bool -da_enumerate_recursive (const DArray *d, - TrieIndex state, - DAEnumFunc enum_func, - void *user_data) -{ - Bool ret; - TrieIndex base; + while ((base = da_get_base (d, root)) >= 0) { + max_c = MIN_VAL (TRIE_CHAR_MAX, d->num_cells - base); + for (c = 0; c < max_c; c++) { + if (da_get_check (d, base + c) == root) + break; + } - base = da_get_base (d, state); + if (c == max_c) + return TRIE_INDEX_ERROR; - if (base < 0) { - TrieChar *key; + trie_string_append_char (keybuff, c); + root = base + c; + } - key = da_get_state_key (d, state); - ret = (*enum_func) (key, state, user_data); - free (key); - } else { - Symbols *symbols; - int i; - - ret = TRUE; - symbols = da_output_symbols (d, state); - for (i = 0; ret && i < symbols_num (symbols); i++) { - ret = da_enumerate_recursive (d, base + symbols_get (symbols, i), - enum_func, user_data); + return root; +} + +/** + * @brief Find next separate node in a sub-trie + * + * @param d : the double-array structure + * @param root : the sub-trie root to search from + * @param sep : the current separate node + * @param keybuff : the TrieString buffer for incrementally calcuating key + * + * @return index to the next separate node; TRIE_INDEX_ERROR if no more + * separate node is found + * + * Find the next separate node under a sub-trie rooted at @a root starting + * from the current separate node @a sep. + * + * On return, @a keybuff is incrementally updated from the key which walks + * to previous separate node to the one which walks to the new separate node. + * So, it is assumed to be initialized by at least one da_first_separate() + * call before. This incremental key calculation is more efficient than later + * totally reconstructing key from the given separate node. + * + * Available since: 0.2.6 + */ +TrieIndex +da_next_separate (DArray *d, TrieIndex root, TrieIndex sep, TrieString *keybuff) +{ + TrieIndex parent; + TrieIndex base; + TrieChar c, max_c; + + while (sep != root) { + parent = da_get_check (d, sep); + base = da_get_base (d, parent); + c = sep - base; + + trie_string_cut_last (keybuff); + + /* find next sibling of sep */ + max_c = MIN_VAL (TRIE_CHAR_MAX, d->num_cells - base); + while (++c < max_c) { + if (da_get_check (d, base + c) == parent) { + trie_string_append_char (keybuff, c); + return da_first_separate (d, base + c, keybuff); + } } - symbols_free (symbols); + sep = parent; } - return ret; + return TRIE_INDEX_ERROR; } /* diff --git a/datrie/darray.h b/datrie/darray.h index bbdecd3..f290040 100644 --- a/datrie/darray.h +++ b/datrie/darray.h @@ -28,6 +28,7 @@ #define __DARRAY_H #include "triedefs.h" +#include "trie-string.h" /** * @file darray.h @@ -35,22 +36,20 @@ */ /** - * @brief Double-array structure type + * @brief Symbol set structure type */ -typedef struct _DArray DArray; +typedef struct _Symbols Symbols; + +Symbols * symbols_new (); +void symbols_free (Symbols *syms); +void symbols_add (Symbols *syms, TrieChar c); +int symbols_num (const Symbols *syms); +TrieChar symbols_get (const Symbols *syms, int index); /** - * @brief Double-array entry enumeration function - * - * @param key : the key of the entry, up to @a sep_node - * @param sep_node : the separate node of the entry - * @param user_data : user-supplied data - * - * @return TRUE to continue enumeration, FALSE to stop + * @brief Double-array structure type */ -typedef Bool (*DAEnumFunc) (const TrieChar *key, - TrieIndex sep_node, - void *user_data); +typedef struct _DArray DArray; DArray * da_new (); @@ -76,6 +75,8 @@ void da_set_check (DArray *d, TrieIndex s, TrieIndex val); Bool da_walk (const DArray *d, TrieIndex *s, TrieChar c); +Symbols * da_output_symbols (const DArray *d, TrieIndex s); + /** * @brief Test walkability in double-array structure * @@ -99,7 +100,12 @@ void da_prune (DArray *d, TrieIndex s); void da_prune_upto (DArray *d, TrieIndex p, TrieIndex s); -Bool da_enumerate (const DArray *d, DAEnumFunc enum_func, void *user_data); +TrieIndex da_first_separate (DArray *d, TrieIndex root, TrieString *keybuff); + +TrieIndex da_next_separate (DArray *d, + TrieIndex root, + TrieIndex sep, + TrieString *keybuff); #endif /* __DARRAY_H */ diff --git a/datrie/dstring-private.h b/datrie/dstring-private.h new file mode 100644 index 0000000..517bbf5 --- /dev/null +++ b/datrie/dstring-private.h @@ -0,0 +1,45 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * libdatrie - Double-Array Trie Library + * Copyright (C) 2006 Theppitak Karoonboonyanan + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * dstring-private.h - Dynamic string type + * Created: 2012-08-02 + * Author: Theppitak Karoonboonyanan + */ + +#ifndef __DSTRING_PRIVATE_H +#define __DSTRING_PRIVATE_H + +#include "typedefs.h" + + +struct _DString { + int char_size; + int str_len; + int alloc_size; + void * val; +}; + + +#endif /* __DSTRING_PRIVATE_H */ + +/* +vi:ts=4:ai:expandtab +*/ diff --git a/datrie/dstring.c b/datrie/dstring.c new file mode 100644 index 0000000..1004e3a --- /dev/null +++ b/datrie/dstring.c @@ -0,0 +1,187 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * libdatrie - Double-Array Trie Library + * Copyright (C) 2006 Theppitak Karoonboonyanan + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * dstring.c - Dynamic string type + * Created: 2012-08-01 + * Author: Theppitak Karoonboonyanan + */ + +#include "dstring.h" +#include "dstring-private.h" + +#include "trie-private.h" +#include +#include + + +DString * +dstring_new (int char_size, int n_elm) +{ + DString *ds; + + ds = (DString *) malloc (sizeof (DString)); + if (!ds) + return NULL; + + ds->alloc_size = char_size * n_elm; + ds->val = malloc (ds->alloc_size); + if (!ds->val) { + free (ds); + return NULL; + } + + ds->char_size = char_size; + ds->str_len = 0; + + return ds; +} + +void +dstring_free (DString *ds) +{ + free (ds->val); + free (ds); +} + +int +dstring_length (const DString *ds) +{ + return ds->str_len; +} + +const void * +dstring_get_val (const DString *ds) +{ + return ds->val; +} + +void * +dstring_get_val_rw (DString *ds) +{ + return ds->val; +} + +void +dstring_clear (DString *ds) +{ + ds->str_len = 0; +} + +static Bool +dstring_ensure_space (DString *ds, int size) +{ + if (ds->alloc_size < size) { + int re_size = MAX_VAL (ds->alloc_size * 2, size); + void *re_ptr = realloc (ds->val, re_size); + if (!re_ptr) + return FALSE; + ds->val = re_ptr; + ds->alloc_size = re_size; + } + + return TRUE; +} + +Bool +dstring_copy (DString *dst, const DString *src) +{ + if (!dstring_ensure_space (dst, (src->str_len + 1) * src->char_size)) + return FALSE; + + memcpy (dst->val, src->val, (src->str_len + 1) * src->char_size); + + dst->char_size = src->char_size; + dst->str_len = src->str_len; + + return TRUE; +} + +Bool +dstring_append (DString *dst, const DString *src) +{ + if (dst->char_size != src->char_size) + return FALSE; + + if (!dstring_ensure_space (dst, (dst->str_len + src->str_len + 1) + * dst->char_size)) + { + return FALSE; + } + + memcpy (dst->val + (dst->char_size * dst->str_len), src->val, + (src->str_len + 1) * dst->char_size); + + dst->str_len += src->str_len; + + return TRUE; +} + +Bool +dstring_append_string (DString *ds, const void *data, int len) +{ + if (!dstring_ensure_space (ds, (ds->str_len + len + 1) * ds->char_size)) + return FALSE; + + memcpy (ds->val + (ds->char_size * ds->str_len), data, ds->char_size * len); + + ds->str_len += len; + + return TRUE; +} + +Bool +dstring_append_char (DString *ds, const void *data) +{ + if (!dstring_ensure_space (ds, (ds->str_len + 2) * ds->char_size)) + return FALSE; + + memcpy (ds->val + (ds->char_size * ds->str_len), data, ds->char_size); + + ds->str_len++; + + return TRUE; +} + +Bool +dstring_terminate (DString *ds) +{ + if (!dstring_ensure_space (ds, (ds->str_len + 2) * ds->char_size)) + return FALSE; + + memset (ds->val + (ds->char_size * ds->str_len), 0, ds->char_size); + + return TRUE; +} + +Bool +dstring_cut_last (DString *ds) +{ + if (0 == ds->str_len) + return FALSE; + + ds->str_len--; + + return TRUE; +} + +/* +vi:ts=4:ai:expandtab +*/ diff --git a/datrie/dstring.h b/datrie/dstring.h new file mode 100644 index 0000000..7984dfd --- /dev/null +++ b/datrie/dstring.h @@ -0,0 +1,62 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * libdatrie - Double-Array Trie Library + * Copyright (C) 2006 Theppitak Karoonboonyanan + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * dstring.h - Dynamic string type + * Created: 2012-08-01 + * Author: Theppitak Karoonboonyanan + */ + +#ifndef __DSTRING_H +#define __DSTRING_H + +#include "typedefs.h" + +typedef struct _DString DString; + +DString * dstring_new (int char_size, int n_elm); + +void dstring_free (DString *ds); + +int dstring_length (const DString *ds); + +const void * dstring_get_val (const DString *ds); + +void * dstring_get_val_rw (DString *ds); + +void dstring_clear (DString *ds); + +Bool dstring_copy (DString *dst, const DString *src); + +Bool dstring_append (DString *dst, const DString *src); + +Bool dstring_append_string (DString *ds, const void *data, int len); + +Bool dstring_append_char (DString *ds, const void *data); + +Bool dstring_terminate (DString *ds); + +Bool dstring_cut_last (DString *ds); + +#endif /* __DSTRING_H */ + +/* +vi:ts=4:ai:expandtab +*/ diff --git a/datrie/libdatrie.def b/datrie/libdatrie.def index 19baa49..19d4a87 100644 --- a/datrie/libdatrie.def +++ b/datrie/libdatrie.def @@ -22,5 +22,11 @@ trie_state_free trie_state_rewind trie_state_walk trie_state_is_walkable +trie_state_walkable_chars trie_state_is_single trie_state_get_data +trie_iterator_new +trie_iterator_free +trie_iterator_next +trie_iterator_get_key +trie_iterator_get_data diff --git a/datrie/libdatrie.map b/datrie/libdatrie.map index 12b3c0b..d6a518a 100644 --- a/datrie/libdatrie.map +++ b/datrie/libdatrie.map @@ -32,3 +32,12 @@ DATRIE_0.2.4 { trie_fwrite; } DATRIE_0.2; +DATRIE_0.2.6 { + trie_state_walkable_chars; + trie_iterator_new; + trie_iterator_free; + trie_iterator_next; + trie_iterator_get_key; + trie_iterator_get_data; +} DATRIE_0.2.4; + diff --git a/datrie/tail.c b/datrie/tail.c index 4e31d9f..f9d63a7 100644 --- a/datrie/tail.c +++ b/datrie/tail.c @@ -26,7 +26,9 @@ #include #include -#include +#ifndef _MSC_VER /* for SIZE_MAX */ +# include +#endif #include #include "tail.h" @@ -251,10 +253,11 @@ tail_fwrite (const Tail *t, FILE *file) * @param t : the tail data * @param index : the index of the suffix * - * @return an allocated string of the indexed suffix. + * @return pointer to the indexed suffix string. * - * Get suffix from tail with given @a index. The returned string is allocated. - * The caller should free it with free(). + * Get suffix from tail with given @a index. The returned string is a pointer + * to internal storage, which should be accessed read-only by the caller. + * No need to free() it. */ const TrieChar * tail_get_suffix (const Tail *t, TrieIndex index) @@ -329,7 +332,7 @@ tail_alloc_block (Tail *t) t->tails[block].next_free = -1; t->tails[block].data = TRIE_DATA_ERROR; t->tails[block].suffix = NULL; - + return block + TAIL_START_BLOCKNO; } diff --git a/datrie/tail.h b/datrie/tail.h index d33ddcd..194d083 100644 --- a/datrie/tail.h +++ b/datrie/tail.h @@ -81,7 +81,7 @@ Bool tail_walk_char (const Tail *t, * * @return boolean indicating walkability * - * Test if the character @a c can be used to walk from given character + * Test if the character @a c can be used to walk from given character * position @a suffix_idx of entry @a s of the tail data @a t. */ /* diff --git a/datrie/trie-string.c b/datrie/trie-string.c new file mode 100644 index 0000000..7deddeb --- /dev/null +++ b/datrie/trie-string.c @@ -0,0 +1,113 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * libdatrie - Double-Array Trie Library + * Copyright (C) 2006 Theppitak Karoonboonyanan + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * trie-string.c - Dynamic string type for Trie alphabets + * Created: 2012-08-02 + * Author: Theppitak Karoonboonyanan + */ + +#include "trie-string.h" +#include "dstring-private.h" +#include "triedefs.h" + +#include + + +struct _TrieString { + DString ds; +}; + + +TrieString * +trie_string_new (int n_elm) +{ + return (TrieString *) dstring_new (sizeof (TrieChar), n_elm); +} + +void +trie_string_free (TrieString *ts) +{ + dstring_free ((DString *)ts); +} + +int +trie_string_length (const TrieString *ts) +{ + return dstring_length ((DString *)ts); +} + +const void * +trie_string_get_val (const TrieString *ts) +{ + return dstring_get_val ((DString *)ts); +} + +void * +trie_string_get_val_rw (TrieString *ts) +{ + return dstring_get_val_rw ((DString *)ts); +} + +void +trie_string_clear (TrieString *ts) +{ + dstring_clear ((DString *)ts); +} + +Bool +trie_string_copy (TrieString *dst, const TrieString *src) +{ + return dstring_copy ((DString *)dst, (const DString *)src); +} + +Bool +trie_string_append (TrieString *dst, const TrieString *src) +{ + return dstring_append ((DString *)dst, (const DString *)src); +} + +Bool +trie_string_append_string (TrieString *ts, const TrieChar *str) +{ + return dstring_append_string ((DString *)ts, str, strlen (str)); +} + +Bool +trie_string_append_char (TrieString *ts, TrieChar tc) +{ + return dstring_append_char ((DString *)ts, &tc); +} + +Bool +trie_string_terminate (TrieString *ts) +{ + return dstring_terminate ((DString *)ts); +} + +Bool +trie_string_cut_last (TrieString *ts) +{ + return dstring_cut_last ((DString *)ts); +} + +/* +vi:ts=4:ai:expandtab +*/ diff --git a/datrie/trie-string.h b/datrie/trie-string.h new file mode 100644 index 0000000..a623096 --- /dev/null +++ b/datrie/trie-string.h @@ -0,0 +1,65 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * libdatrie - Double-Array Trie Library + * Copyright (C) 2006 Theppitak Karoonboonyanan + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * trie-string.h - Dynamic string type for Trie alphabets + * Created: 2012-08-02 + * Author: Theppitak Karoonboonyanan + */ + +#ifndef __TRIE_STRING_H +#define __TRIE_STRING_H + +#include "dstring.h" +#include "triedefs.h" + +typedef struct _TrieString TrieString; + +TrieString * trie_string_new (int n_elm); + +void trie_string_free (TrieString *ts); + +int trie_string_length (const TrieString *ts); + +const void * trie_string_get_val (const TrieString *ts); + +void * trie_string_get_val_rw (TrieString *ts); + +void trie_string_clear (TrieString *ts); + +Bool trie_string_copy (TrieString *dst, const TrieString *src); + +Bool trie_string_append (TrieString *dst, const TrieString *src); + +Bool trie_string_append_string (TrieString *ts, const TrieChar *str); + +Bool trie_string_append_char (TrieString *ts, TrieChar tc); + +Bool trie_string_terminate (TrieString *ts); + +Bool trie_string_cut_last (TrieString *ts); + + +#endif /* __TRIE_STRING_H */ + +/* +vi:ts=4:ai:expandtab +*/ + diff --git a/datrie/trie.c b/datrie/trie.c index 3353a51..21a6fee 100644 --- a/datrie/trie.c +++ b/datrie/trie.c @@ -33,6 +33,7 @@ #include "alpha-map-private.h" #include "darray.h" #include "tail.h" +#include "trie-string.h" /** * @brief Trie structure @@ -55,6 +56,16 @@ struct _TrieState { short is_suffix; /**< whether it is currently in suffix part */ }; +/** + * @brief TrieIterator structure + */ +struct _TrieIterator { + const TrieState *root; /**< the state to start iteration from */ + TrieState *state; /**< the current state */ + TrieString *key; /**< buffer for calculating the entry key */ +}; + + /*------------------------* * INTERNAL FUNCTIONS * *------------------------*/ @@ -68,11 +79,10 @@ static TrieState * trie_state_new (const Trie *trie, short suffix_idx, short is_suffix); -static Bool -trie_store_conditionally (Trie *trie, - const AlphaChar *key, - TrieData data, - Bool is_overwrite); +static Bool trie_store_conditionally (Trie *trie, + const AlphaChar *key, + TrieData data, + Bool is_overwrite); static Bool trie_branch_in_branch (Trie *trie, TrieIndex sep_node, @@ -121,7 +131,7 @@ trie_new (const AlphaMap *alpha_map) trie->tail = tail_new (); if (!trie->tail) goto exit_da_created; - + trie->is_dirty = TRUE; return trie; @@ -360,7 +370,7 @@ trie_retrieve (const Trie *trie, const AlphaChar *key, TrieData *o_data) * * @return boolean value indicating the success of the process * - * Store a @a data for the given @a key in @a trie. If @a key does not + * Store a @a data for the given @a key in @a trie. If @a key does not * exist in @a trie, it will be appended. If it does, its current data will * be overwritten. */ @@ -379,7 +389,7 @@ trie_store (Trie *trie, const AlphaChar *key, TrieData data) * * @return boolean value indicating the success of the process * - * Store a @a data for the given @a key in @a trie. If @a key does not + * Store a @a data for the given @a key in @a trie. If @a key does not * exist in @a trie, it will be appended. If it does, the function will * return failure and the existing value will not be touched. * @@ -567,45 +577,6 @@ trie_delete (Trie *trie, const AlphaChar *key) return TRUE; } -typedef struct { - const Trie *trie; - TrieEnumFunc enum_func; - void *user_data; -} _TrieEnumData; - -static Bool -trie_da_enum_func (const TrieChar *key, TrieIndex sep_node, void *user_data) -{ - _TrieEnumData *enum_data; - TrieIndex t; - const TrieChar *suffix; - AlphaChar *full_key, *p; - Bool ret; - - enum_data = (_TrieEnumData *) user_data; - - t = trie_da_get_tail_index (enum_data->trie->da, sep_node); - suffix = tail_get_suffix (enum_data->trie->tail, t); - - full_key = (AlphaChar *) malloc ((strlen ((const char *)key) - + strlen ((const char *)suffix) + 1) - * sizeof (AlphaChar)); - for (p = full_key; *key; p++, key++) { - *p = alpha_map_trie_to_char (enum_data->trie->alpha_map, *key); - } - for ( ; *suffix; p++, suffix++) { - *p = alpha_map_trie_to_char (enum_data->trie->alpha_map, *suffix); - } - *p = 0; - - ret = (*enum_data->enum_func) (full_key, - tail_get_data (enum_data->trie->tail, t), - enum_data->user_data); - - free (full_key); - return ret; -} - /** * @brief Enumerate entries in trie * @@ -615,20 +586,40 @@ trie_da_enum_func (const TrieChar *key, TrieIndex sep_node, void *user_data) * * @return boolean value indicating whether all the keys are visited * - * Enumerate all entries in trie. For each entry, the user-supplied + * Enumerate all entries in trie. For each entry, the user-supplied * @a enum_func callback function is called, with the entry key and data. * Returning FALSE from such callback will stop enumeration and return FALSE. */ Bool trie_enumerate (const Trie *trie, TrieEnumFunc enum_func, void *user_data) { - _TrieEnumData enum_data; + TrieState *root; + TrieIterator *iter; + Bool cont = TRUE; - enum_data.trie = trie; - enum_data.enum_func = enum_func; - enum_data.user_data = user_data; + root = trie_root (trie); + if (!root) + return FALSE; - return da_enumerate (trie->da, trie_da_enum_func, &enum_data); + iter = trie_iterator_new (root); + if (!iter) + goto exit_root_created; + + while (cont && trie_iterator_next (iter)) { + AlphaChar *key = trie_iterator_get_key (iter); + TrieData data = trie_iterator_get_data (iter); + cont = (*enum_func) (key, data, user_data); + free (key); + } + + trie_iterator_free (iter); + trie_state_free (root); + + return cont; + +exit_root_created: + trie_state_free (root); + return FALSE; } @@ -787,12 +778,58 @@ trie_state_is_walkable (const TrieState *s, AlphaChar c) if (!s->is_suffix) return da_is_walkable (s->trie->da, s->index, tc); - else + else return tail_is_walkable_char (s->trie->tail, s->index, s->suffix_idx, tc); } /** + * @brief Get all walkable characters from state + * + * @param s : the state to get + * @param chars : the storage for the result + * @param chars_nelm : the size of @a chars[] in number of elements + * + * @return total walkable characters + * + * Get the list of all walkable characters from state @a s. At most + * @a chars_nelm walkable characters are stored in @a chars[] on return. + * + * The function returns the actual number of walkable characters from @a s. + * Note that this may not equal the number of characters stored in @a chars[] + * if @a chars_nelm is less than the actual number. + * + * Available since: 0.2.6 + */ +int +trie_state_walkable_chars (const TrieState *s, + AlphaChar chars[], + int chars_nelm) +{ + int syms_num = 0; + + if (!s->is_suffix) { + Symbols *syms = da_output_symbols (s->trie->da, s->index); + int i; + + syms_num = symbols_num (syms); + for (i = 0; i < syms_num && i < chars_nelm; i++) { + TrieChar tc = symbols_get (syms, i); + chars[i] = alpha_map_trie_to_char (s->trie->alpha_map, tc); + } + + symbols_free (syms); + } else { + const TrieChar *suffix = tail_get_suffix (s->trie->tail, s->index); + chars[0] = alpha_map_trie_to_char (s->trie->alpha_map, + suffix[s->suffix_idx]); + syms_num = 1; + } + + return syms_num; +} + +/** * @brief Check for single path * * @param s : the state to check @@ -822,8 +859,215 @@ trie_state_is_single (const TrieState *s) TrieData trie_state_get_data (const TrieState *s) { - return s->is_suffix ? tail_get_data (s->trie->tail, s->index) - : TRIE_DATA_ERROR; + return trie_state_is_leaf (s) ? tail_get_data (s->trie->tail, s->index) + : TRIE_DATA_ERROR; +} + + +/*---------------------* + * ENTRY ITERATION * + *---------------------*/ + +/** + * @brief Create a new trie iterator + * + * @param s : the TrieState to start iteration from + * + * @return a pointer to the newly created TrieIterator, or NULL on failure + * + * Create a new trie iterator for iterating entries of a sub-trie rooted at + * state @a s. + * + * Use it with the result of trie_get_root() to iterate the whole trie. + * + * The created object must be freed with trie_iterator_free(). + * + * Available since: 0.2.6 + */ +TrieIterator * +trie_iterator_new (TrieState *s) +{ + TrieIterator *iter; + + iter = (TrieIterator *) malloc (sizeof (TrieIterator)); + if (!iter) + return NULL; + + iter->root = s; + iter->state = NULL; + iter->key = NULL; + + return iter; +} + +/** + * @brief Free a trie iterator + * + * @param iter : the trie iterator to free + * + * Destruct the iterator @a iter and free its allocated memory. + * + * Available since: 0.2.6 + */ +void +trie_iterator_free (TrieIterator *iter) +{ + if (iter->state) { + trie_state_free (iter->state); + } + if (iter->key) { + trie_string_free (iter->key); + } + free (iter); +} + +/** + * @brief Move trie iterator to the next entry + * + * @param iter : an iterator + * + * @return boolean value indicating the availability of the entry + * + * Move trie iterator to the next entry. + * On return, the iterator @a iter is updated to reference to the new entry + * if successfully moved. + * + * Available since: 0.2.6 + */ +Bool +trie_iterator_next (TrieIterator *iter) +{ + TrieState *s = iter->state; + TrieIndex sep; + + /* first iteration */ + if (!s) { + s = iter->state = trie_state_clone (iter->root); + + /* for tail state, we are already at the only entry */ + if (s->is_suffix) + return TRUE; + + iter->key = trie_string_new (20); + sep = da_first_separate (s->trie->da, s->index, iter->key); + if (TRIE_INDEX_ERROR == sep) + return FALSE; + + s->index = sep; + return TRUE; + } + + /* no next entry for tail state */ + if (s->is_suffix) + return FALSE; + + /* iter->state is a separate node */ + sep = da_next_separate (s->trie->da, iter->root->index, s->index, + iter->key); + if (TRIE_INDEX_ERROR == sep) + return FALSE; + + s->index = sep; + return TRUE; +} + +/** + * @brief Get key for a trie iterator + * + * @param iter : an iterator + * + * @return the allocated key string; NULL on failure + * + * Get key for the current entry referenced by the trie iterator @a iter. + * + * The return string must be freed with free(). + * + * Available since: 0.2.6 + */ +AlphaChar * +trie_iterator_get_key (const TrieIterator *iter) +{ + const TrieState *s; + const TrieChar *tail_str; + AlphaChar *alpha_key, *alpha_p; + + s = iter->state; + if (!s) + return NULL; + + /* if s is in tail, root == s */ + if (s->is_suffix) { + tail_str = tail_get_suffix (s->trie->tail, s->index); + if (!tail_str) + return NULL; + + tail_str += s->suffix_idx; + + alpha_key = (AlphaChar *) malloc (sizeof (AlphaChar) + * (strlen (tail_str) + 1)); + alpha_p = alpha_key; + } else { + TrieIndex tail_idx; + int i, key_len; + const TrieChar *key_p; + + tail_idx = trie_da_get_tail_index (s->trie->da, s->index); + tail_str = tail_get_suffix (s->trie->tail, tail_idx); + if (!tail_str) + return NULL; + + key_len = trie_string_length (iter->key); + key_p = trie_string_get_val (iter->key); + alpha_key = (AlphaChar *) malloc ( + sizeof (AlphaChar) * (key_len + strlen (tail_str) + 1) + ); + alpha_p = alpha_key; + for (i = key_len; i > 0; i--) { + *alpha_p++ = alpha_map_trie_to_char (s->trie->alpha_map, *key_p++); + } + } + + while (*tail_str) { + *alpha_p++ = alpha_map_trie_to_char (s->trie->alpha_map, *tail_str++); + } + *alpha_p = 0; + + return alpha_key; +} + +/** + * @brief Get data for the entry referenced by an iterator + * + * @param iter : an iterator + * + * @return the data associated with the entry referenced by iterator @a iter, + * or TRIE_DATA_ERROR if @a iter does not reference to a unique entry + * + * Get value for the entry referenced by an iterator. Getting value from an + * un-iterated (or broken for any reason) iterator will result in + * TRIE_DATA_ERROR. + * + * Available since: 0.2.6 + */ +TrieData +trie_iterator_get_data (const TrieIterator *iter) +{ + const TrieState *s = iter->state; + TrieIndex tail_index; + + if (!s) + return TRIE_DATA_ERROR; + + if (!s->is_suffix) { + if (!trie_da_is_separate (s->trie->da, s->index)) + return TRIE_DATA_ERROR; + + tail_index = trie_da_get_tail_index (s->trie->da, s->index); + } else { + tail_index = s->index; + } + + return tail_get_data (s->trie->tail, tail_index); } /* diff --git a/datrie/trie.h b/datrie/trie.h index dd6d6f3..16a2af6 100644 --- a/datrie/trie.h +++ b/datrie/trie.h @@ -62,6 +62,12 @@ typedef Bool (*TrieEnumFunc) (const AlphaChar *key, */ typedef struct _TrieState TrieState; + +/** + * @brief Trie iteration state + */ +typedef struct _TrieIterator TrieIterator; + /*-----------------------* * GENERAL FUNCTIONS * *-----------------------*/ @@ -123,6 +129,10 @@ Bool trie_state_walk (TrieState *s, AlphaChar c); Bool trie_state_is_walkable (const TrieState *s, AlphaChar c); +int trie_state_walkable_chars (const TrieState *s, + AlphaChar chars[], + int chars_nelm); + /** * @brief Check for terminal state * @@ -144,7 +154,7 @@ Bool trie_state_is_single (const TrieState *s); * * @return boolean value indicating whether it is a leaf state * - * Check if the given state is a leaf state. A leaf state is a terminal state + * Check if the given state is a leaf state. A leaf state is a terminal state * that has no other branch. */ #define trie_state_is_leaf(s) \ @@ -152,6 +162,22 @@ Bool trie_state_is_single (const TrieState *s); TrieData trie_state_get_data (const TrieState *s); + +/*----------------------* + * ENTRY ITERATION * + *----------------------*/ + +TrieIterator * trie_iterator_new (TrieState *s); + +void trie_iterator_free (TrieIterator *iter); + +Bool trie_iterator_next (TrieIterator *iter); + +AlphaChar * trie_iterator_get_key (const TrieIterator *iter); + +TrieData trie_iterator_get_data (const TrieIterator *iter); + + #ifdef __cplusplus } #endif diff --git a/debian/changelog b/debian/changelog deleted file mode 100644 index e9e288c..0000000 --- a/debian/changelog +++ /dev/null @@ -1,240 +0,0 @@ -libdatrie (0.2.4-3) unstable; urgency=low - - * Merge Ubuntu changes (build for multiarch) - - Build-dep on debhelper (>= 8.1.3) - - Add "Pre-Depends: ${misc:Pre-Depends}" for libdatrie1 - - Add DEB_HOST_MULTIARCH and pass it to --libdir as a subdir - under /usr/lib in configure - - Replace /usr/lib/ with /usr/lib/*/ in {libdatrie1,libdatrie-dev}.install - - Add "Multi-Arch: same" for libdatrie1 - * Use dh-autoreconf instead of direct autoreconf call and manual cleanups - - Build-dep on dh-autoreconf - - Call dh_autoreconf on configure and dh_autoreconf_clean on clean - * Bump Standards-Version to 3.9.2 (no changes needed) - - -- Theppitak Karoonboonyanan Sun, 19 Jun 2011 22:11:10 +0700 - -libdatrie (0.2.4-2ubuntu1) oneiric; urgency=low - - * Build for multiarch. - - -- Steve Langasek Sat, 26 Mar 2011 00:56:37 -0700 - -libdatrie (0.2.4-2) unstable; urgency=low - - * debian/copyright: - - Updated to DEP-5 rev 173. - - Update copyright year for debian/*. - * debian/rules: - - Drop unnecessary --infodir configure option. - - Use short options -i/-a instead of --indep/--arch for dh_ commands. - * Mark libdatrie-doc as "Multi-Arch: foreign" in preparation for multi-arch - environment to come. This will satisfy Recommends from libdatrie-dev. - * Bump Standards-Version to 3.9.1 (no changes needed) - - -- Theppitak Karoonboonyanan Sun, 13 Mar 2011 21:32:47 +0700 - -libdatrie (0.2.4-1) unstable; urgency=low - - * New upstream release - - debian/libdatrie1.symbols: Add new symbols according to upstream. - * Bump Standards-Version to 3.9.0 (no changes needed) - - -- Theppitak Karoonboonyanan Wed, 30 Jun 2010 16:40:33 +0700 - -libdatrie (0.2.3-1) unstable; urgency=low - - * New upstream release. - * Bump Standards-Version to 3.8.4 (no changes needed) - - -- Theppitak Karoonboonyanan Sat, 27 Feb 2010 21:09:46 +0700 - -libdatrie (0.2.2-3) unstable; urgency=low - - * debian/rules: Fix failure to build twice in a row (Closes: #564815): - - Fix typo '$(MAKE) maintainerclan' - - Clean other changed files left over from 'make maintainer-clean' - - 'config.status' depends on 'configure.ac' instead of 'configure' - - Don't fail if m4/ already exists - * Add missing ${misc:Depends} [lintian]. - - -- Theppitak Karoonboonyanan Wed, 13 Jan 2010 20:48:24 +0700 - -libdatrie (0.2.2-2) unstable; urgency=low - - * debian/control: - - Update my e-mail address to @debian.org. - - Drop DM-Upload-Allowed. - * debian/copyright: - - Update my e-mail address for debian/* to @debian.org. - * debian/rules: - - Run autoreconf instead of just updating config.{sub,guess}, as required - by libtool - - Run 'make maintainerclean' instead of 'make distclean' on clean target, - to clear all autoconf-generated files - * debian/control: - - Build-Depends on libtool, automake, autoconf, for autoreconf. - - Drop Build-Depends on autotools-dev - * Switch to "3.0 (quilt)" source format. - * Bump Standards-Version to 3.8.3 (no changes needed) - - -- Theppitak Karoonboonyanan Mon, 07 Dec 2009 12:40:05 +0700 - -libdatrie (0.2.2-1) unstable; urgency=low - - * Use complete sentences in libdatrie1 long description. (Closes: #525806) - * New upstream release, fixing builds on non-GNU systems. - * Remove duplicated field "section" for libdatrie1 [lintian]. - - -- Theppitak Karoonboonyanan Wed, 29 Apr 2009 15:24:31 +0700 - -libdatrie (0.2.1-2) unstable; urgency=low - - * Drop versioned b-dep on dpkg-dev, as Vcs-Cvs: is no more needed. - * Upload to unstable. - - -- Theppitak Karoonboonyanan Sun, 12 Apr 2009 10:02:04 +0700 - -libdatrie (0.2.1-1) experimental; urgency=low - - * Fix broken Vcs-Browser field. - * New upstream release, with symbols versioning added - - debian/libdatrie0.symbols: Update symbols tags to "DATRIE_0.2" as per - upstream. This is not considered ABI breakage, as unversioned calls are - still resolved to the same symbols as versioned ones. - - -- Theppitak Karoonboonyanan Sun, 05 Apr 2009 14:42:01 +0700 - -libdatrie (0.2.0-1) experimental; urgency=low - - * VCS moved from CVS to SVN; update Vcs-* fields accordingly. - * New upstream version, with ABI breakage - - Rename binary packages according to SONAME change, to allow run-time - coexistence with old version: libdatrie1, libdatrie1-bin - - Rename libdatrie0-dev to libdatrie-dev, and conflicts with - libdatrie0-dev, as both versions share the same headers location; - this should be the package naming scheme from now on - - Ditto to libdatrie-doc - * Shared lib updates: - - debian/rules: - + Bump shlib dep to 0.2.0, and shlib package is now libdatrie1 - - debian/libdatrie1.symbols: - + Update symbols, setting minver to 0.2.0 for all symbols - * Bump debhelper compat to level 7 - - Bump debian/compat to 7 - - Build-dep on debhelper (>= 7) - - debian/rules: - + Replace obsoleted 'dh_clean -k' with 'dh_prep' - + Remove *-stamp clean-ups in clean target, as dh_clean now does it - * debian/libdatrie-doc.docs: - - Install README.migration provided by upstream - * debian/copyright: - - Update format to proposal rev 454 - * Bump Standards-Version to 3.8.1 (no changes needed) - - -- Theppitak Karoonboonyanan Wed, 25 Mar 2009 14:43:36 +0700 - -libdatrie (0.1.3-2) unstable; urgency=low - - * Add Build-Depends-Package info to libdatrie0.symbols and bump dpkg-dev - Build-deps to (>= 1.14.13) accordingly. Thanks Loïc Minier. - * Fix CVSROOT in Vcs-Cvs, so it really works with debcheckout. - * debian/libdatrie0-doc.doc-base: Correct doc-base section (Programming). - * debian/rules: - - Update config.{guess,status} before configure, and clean them up on - clean target, so the changes are not included in .diff.gz - - Use 'make -C $dir' instead of 'cd $dir; make' - - Do not build/install doc on binary-arch - * debian/copyright: - - Remove inline license file referals, and use usual Debian text at the - bottom instead - - Update format to current proposal - * debian/watch: Fix watch pattern so that only *.tar.gz is matched, not - *.tar.gz.md5sum. - * Use short description for libdatrie0, and add that it's usually - auto-installed. - * debian/control: - - Add DM-Upload-Allowed - - Bump Standards-Versions to 3.8.0 (no changes needed) - - -- Theppitak Karoonboonyanan Sat, 21 Jun 2008 11:39:32 +0700 - -libdatrie (0.1.3-1) unstable; urgency=low - - * New upstream release - - Fix memory bug which can crash on some platforms, reportedly win32. - - Fix symbols exporting, so it builds on Mac. - - Remove excessive documentation for private API's. - - Add the SBM file format documentation frequently asked for - * debian/copyright: Rewrite in machine-interpretable format. - * Remove XS- prefix from XS-Vcs-* fields. - * Move Homepage info from description to control field. - * Bump Standards-Version to 3.7.3, no changes needed. - * debian/libdatrie0.symbols: Add symbols file to provide fine-grained - shlib dependency tracking. - * debian/control: Build-depend on debhelper (>= 5.0.61) and dpkg-dev (>= - 1.14.9) for the required dh_makeshlibs version. - * debian/libdatrie0-doc.doc-base: Remove excessive whitespace. (lintian) - - -- Theppitak Karoonboonyanan Mon, 28 Jan 2008 17:19:12 +0700 - -libdatrie (0.1.2-2) unstable; urgency=low - - * Do not install functions man pages for now, to avoid messing man - directories with plenty of doxygen-generated pages, and to avoid conflicts - with other packages. - - -- Theppitak Karoonboonyanan Sat, 25 Aug 2007 17:11:23 +0700 - -libdatrie (0.1.2-1) unstable; urgency=low - - * debian/libdatrie-bin.manpages: - - Install man pages from built directory, rather than from source. - * debian/libdatrie0-dev.manpages: - - Added to install doxygen-generated API man pages. - * New upstream release - - Limited symbols export, to avoid name clashing - - Improved error handling for edge cases - - Fix crashes - * Set shlibs to >= 0.1.2. - * Add XS-Vcs-Cvs and XS-Vcs-Browser info. - * Do not ignore 'make clean' error. - - -- Theppitak Karoonboonyanan Sat, 25 Aug 2007 14:56:20 +0700 - -libdatrie (0.1.1-4) unstable; urgency=low - - * debian/rules: Revert manual calls to doxygen and rely on configure - auto-detection. Doxygen shouldn't be found in arch buildd's now, as we had - moved it to Build-Depends-Indep. Thanks to Loïc Minier for suggestion. - - -- Theppitak Karoonboonyanan Mon, 11 Dec 2006 09:51:26 +0700 - -libdatrie (0.1.1-3) unstable; urgency=low - - * Package sponsored by Loïc Minier. - * Split arch and indep builds completely - - debian/control: move doxygen to Build-Depends-Indep. - - debian/rules: disable doxygen and manually call it on indep targets. - * debian/rules adjustments - - Remove unused shared library version info assignment. - - Pass --host=$(DEB_HOST_GNU_TYPE) to configure only when cross compiling. - - Add missing targets in .PHONY - * debian/*.dirs: Removed, not needed for debhelper compat level 5. - * debian/copyright: Change the download place to match that in watch file. - - -- Theppitak Karoonboonyanan Sun, 10 Dec 2006 17:02:24 +0700 - -libdatrie (0.1.1-2) unstable; urgency=low - - * Split binary program to libdatrie-bin. - * Rename libdatrie-{dev,doc} to libdatrie0-{dev,doc}. - - -- Theppitak Karoonboonyanan Wed, 18 Oct 2006 00:17:08 +0700 - -libdatrie (0.1.1-1) unstable; urgency=low - - * Initial release (Closes: #392315) - - -- Theppitak Karoonboonyanan Thu, 12 Oct 2006 15:27:50 +0700 - diff --git a/debian/compat b/debian/compat deleted file mode 100644 index 7f8f011..0000000 --- a/debian/compat +++ /dev/null @@ -1 +0,0 @@ -7 diff --git a/debian/control b/debian/control deleted file mode 100644 index 4987255..0000000 --- a/debian/control +++ /dev/null @@ -1,76 +0,0 @@ -Source: libdatrie -Priority: optional -Maintainer: Theppitak Karoonboonyanan -Build-Depends: debhelper (>= 8.1.3), dh-autoreconf -Build-Depends-Indep: doxygen -Standards-Version: 3.9.2 -Section: libs -Vcs-Svn: http://linux.thai.net/svn/software/datrie -Vcs-Browser: http://linux.thai.net/websvn/wsvn/software.datrie/?sc=0 -Homepage: http://libthai.sourceforge.net/ - -Package: libdatrie-dev -Section: libdevel -Architecture: any -Depends: libdatrie1 (= ${binary:Version}), ${misc:Depends} -Suggests: libdatrie-doc (= ${source:Version}) -Conflicts: libdatrie0-dev -Description: Development files for double-array trie library - Trie is a kind of digital search tree, an efficient indexing method with - O(1) time complexity for searching. Comparably as efficient as hashing, - trie also provides flexibility on incremental matching and key spelling - manipulation. This makes it ideal for lexical analyzers, as well as - spelling dictionaries. - . - This library is an implementation of double-array structure for representing - trie, as proposed by Junichi Aoe. The details of the implementation can be - found at http://linux.thai.net/~thep/datrie/datrie.html - . - This package contains the development libraries, header files and manpages - you need to develop your programs using the datrie library. - -Package: libdatrie1-bin -Section: misc -Architecture: any -Depends: ${shlibs:Depends}, ${misc:Depends} -Description: Programs for double-array trie library - Trie is a kind of digital search tree, an efficient indexing method with - O(1) time complexity for searching. Comparably as efficient as hashing, - trie also provides flexibility on incremental matching and key spelling - manipulation. This makes it ideal for lexical analyzers, as well as - spelling dictionaries. - . - This library is an implementation of double-array structure for representing - trie, as proposed by Junichi Aoe. The details of the implementation can be - found at http://linux.thai.net/~thep/datrie/datrie.html - . - This package contains the program files which is used with the library, - including trietool, the trie manipulation tool. - -Package: libdatrie1 -Architecture: any -Depends: ${shlibs:Depends}, ${misc:Depends} -Pre-Depends: ${misc:Pre-Depends} -Multi-Arch: same -Description: Double-array trie library - This package provides shared libraries needed to run programs that use the - datrie library. It is usually automatically installed. - -Package: libdatrie-doc -Section: doc -Architecture: all -Multi-Arch: foreign -Depends: lynx | www-browser, ${misc:Depends} -Conflicts: libdatrie0-doc -Description: Documentation files for double-array trie library - Trie is a kind of digital search tree, an efficient indexing method with - O(1) time complexity for searching. Comparably as efficient as hashing, - trie also provides flexibility on incremental matching and key spelling - manipulation. This makes it ideal for lexical analyzers, as well as - spelling dictionaries. - . - This library is an implementation of double-array structure for representing - trie, as proposed by Junichi Aoe. The details of the implementation can be - found at http://linux.thai.net/~thep/datrie/datrie.html - . - This package contains some documents about the datrie library. diff --git a/debian/copyright b/debian/copyright deleted file mode 100644 index 8733947..0000000 --- a/debian/copyright +++ /dev/null @@ -1,17 +0,0 @@ -Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn?op=file&rev=173 -Upstream-Name: libdatrie -Upstream-Contact: Theppitak Karoonboonyanan -Source: ftp://linux.thai.net/pub/thailinux/software/libthai/ - -Files: * -Copyright: 2006-2009 Theppitak Karoonboonyanan -License: LGPL-2+ - On Debian GNU/Linux systems, the complete text of the GNU Lesser General - Public License version 2 can be found in `/usr/share/common-licenses/LGPL-2'. - -Files: debian/* -Copyright: 2006-2011 Theppitak Karoonboonyanan -License: GPL-2+ - On Debian GNU/Linux systems, the complete text of the GNU General Public - License version 2 can be found in `/usr/share/common-licenses/GPL-2'. - diff --git a/debian/libdatrie-dev.docs b/debian/libdatrie-dev.docs deleted file mode 100644 index 50bd824..0000000 --- a/debian/libdatrie-dev.docs +++ /dev/null @@ -1,2 +0,0 @@ -NEWS -README diff --git a/debian/libdatrie-dev.install b/debian/libdatrie-dev.install deleted file mode 100644 index 76f28fa..0000000 --- a/debian/libdatrie-dev.install +++ /dev/null @@ -1,4 +0,0 @@ -usr/include/* -usr/lib/*/lib*.a -usr/lib/*/lib*.so -usr/lib/*/pkgconfig/* diff --git a/debian/libdatrie-doc.doc-base b/debian/libdatrie-doc.doc-base deleted file mode 100644 index 7637513..0000000 --- a/debian/libdatrie-doc.doc-base +++ /dev/null @@ -1,10 +0,0 @@ -Document: libdatrie-reference -Title: libdatrie Reference Manual -Author: Theppitak Karoonboonyanan -Abstract: This manual describes libdatrie API -Section: Programming - -Format: HTML -Index: /usr/share/doc/libdatrie-doc/html/index.html -Files: /usr/share/doc/libdatrie-doc/html/*.html - diff --git a/debian/libdatrie-doc.docs b/debian/libdatrie-doc.docs deleted file mode 100644 index 2209d22..0000000 --- a/debian/libdatrie-doc.docs +++ /dev/null @@ -1,3 +0,0 @@ -NEWS -README -README.migration diff --git a/debian/libdatrie-doc.install b/debian/libdatrie-doc.install deleted file mode 100644 index 7aab23c..0000000 --- a/debian/libdatrie-doc.install +++ /dev/null @@ -1 +0,0 @@ -usr/share/doc/datrie/html usr/share/doc/libdatrie-doc diff --git a/debian/libdatrie1-bin.docs b/debian/libdatrie1-bin.docs deleted file mode 100644 index 50bd824..0000000 --- a/debian/libdatrie1-bin.docs +++ /dev/null @@ -1,2 +0,0 @@ -NEWS -README diff --git a/debian/libdatrie1-bin.install b/debian/libdatrie1-bin.install deleted file mode 100644 index 1df36c6..0000000 --- a/debian/libdatrie1-bin.install +++ /dev/null @@ -1 +0,0 @@ -usr/bin/* diff --git a/debian/libdatrie1-bin.manpages b/debian/libdatrie1-bin.manpages deleted file mode 100644 index 5ea05fe..0000000 --- a/debian/libdatrie1-bin.manpages +++ /dev/null @@ -1 +0,0 @@ -debian/tmp/usr/share/man/man1/* diff --git a/debian/libdatrie1.docs b/debian/libdatrie1.docs deleted file mode 100644 index 50bd824..0000000 --- a/debian/libdatrie1.docs +++ /dev/null @@ -1,2 +0,0 @@ -NEWS -README diff --git a/debian/libdatrie1.install b/debian/libdatrie1.install deleted file mode 100644 index 3ddde58..0000000 --- a/debian/libdatrie1.install +++ /dev/null @@ -1 +0,0 @@ -usr/lib/*/lib*.so.* diff --git a/debian/libdatrie1.symbols b/debian/libdatrie1.symbols deleted file mode 100644 index 1e27e0f..0000000 --- a/debian/libdatrie1.symbols +++ /dev/null @@ -1,30 +0,0 @@ -libdatrie.so.1 libdatrie1 #MINVER# -* Build-Depends-Package: libdatrie-dev - DATRIE_0.2@DATRIE_0.2 0.2.1 - alpha_char_strlen@DATRIE_0.2 0.2.0 - alpha_map_add_range@DATRIE_0.2 0.2.0 - alpha_map_clone@DATRIE_0.2 0.2.0 - alpha_map_free@DATRIE_0.2 0.2.0 - alpha_map_new@DATRIE_0.2 0.2.0 - trie_delete@DATRIE_0.2 0.2.0 - trie_enumerate@DATRIE_0.2 0.2.0 - trie_free@DATRIE_0.2 0.2.0 - trie_is_dirty@DATRIE_0.2 0.2.0 - trie_new@DATRIE_0.2 0.2.0 - trie_new_from_file@DATRIE_0.2 0.2.0 - trie_retrieve@DATRIE_0.2 0.2.0 - trie_root@DATRIE_0.2 0.2.0 - trie_save@DATRIE_0.2 0.2.0 - trie_state_clone@DATRIE_0.2 0.2.0 - trie_state_copy@DATRIE_0.2 0.2.0 - trie_state_free@DATRIE_0.2 0.2.0 - trie_state_get_data@DATRIE_0.2 0.2.0 - trie_state_is_single@DATRIE_0.2 0.2.0 - trie_state_is_walkable@DATRIE_0.2 0.2.0 - trie_state_rewind@DATRIE_0.2 0.2.0 - trie_state_walk@DATRIE_0.2 0.2.0 - trie_store@DATRIE_0.2 0.2.0 - DATRIE_0.2.4@DATRIE_0.2.4 0.2.4 - trie_store_if_absent@DATRIE_0.2.4 0.2.4 - trie_fread@DATRIE_0.2.4 0.2.4 - trie_fwrite@DATRIE_0.2.4 0.2.4 diff --git a/debian/rules b/debian/rules deleted file mode 100755 index 2184a81..0000000 --- a/debian/rules +++ /dev/null @@ -1,132 +0,0 @@ -#!/usr/bin/make -f -# -*- makefile -*- - -# Uncomment this to turn on verbose mode. -#export DH_VERBOSE=1 - - -DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH) -# These are used for cross-compiling and for saving the configure script -# from having to guess our platform (since we know it already) -DEB_HOST_GNU_TYPE ?= $(shell dpkg-architecture -qDEB_HOST_GNU_TYPE) -DEB_BUILD_GNU_TYPE ?= $(shell dpkg-architecture -qDEB_BUILD_GNU_TYPE) - -ifeq ($(DEB_BUILD_GNU_TYPE),$(DEB_HOST_GNU_TYPE)) - build_flags = --build=$(DEB_BUILD_GNU_TYPE) -else - build_flags = --build=$(DEB_BUILD_GNU_TYPE) --host=$(DEB_HOST_GNU_TYPE) -endif - - -CFLAGS = -Wall -g - -ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) - CFLAGS += -O0 -else - CFLAGS += -O2 -endif - -SHARED_PKG := libdatrie1 -SHLIB_VER := 0.2.0 - -config.status: configure.ac - dh_testdir - - [ -d m4 ] || mkdir m4 - dh_autoreconf - - # Add here commands to configure the package. - ./configure $(build_flags) --prefix=/usr \ - --mandir=\$${prefix}/share/man \ - --libdir=\$${prefix}/lib/$(DEB_HOST_MULTIARCH) \ - CFLAGS="$(CFLAGS)" LDFLAGS="-Wl,-z,defs" - - -build-indep: build-indep-stamp -build-indep-stamp: config.status - dh_testdir - - # Add here commands to compile the package. - $(MAKE) -C doc - - touch $@ - -build-arch: build-arch-stamp -build-arch-stamp: config.status - dh_testdir - - # Add here commands to compile the package. - $(MAKE) -C datrie - $(MAKE) -C tools - $(MAKE) -C man - - touch $@ - -build: build-indep build-arch - -clean: - dh_testdir - dh_testroot - - # Add here commands to clean up after the build process. - dh_autoreconf_clean - - dh_clean - -install-indep: build-indep - dh_testdir - dh_testroot - dh_prep - dh_installdirs -i - - # Add here commands to install the package into debian/tmp - $(MAKE) -C doc install DESTDIR=$(CURDIR)/debian/tmp - -install-arch: build-arch - dh_testdir - dh_testroot - dh_prep - dh_installdirs -a - - # Add here commands to install the package into debian/tmp - $(MAKE) -C datrie install DESTDIR=$(CURDIR)/debian/tmp - $(MAKE) -C tools install DESTDIR=$(CURDIR)/debian/tmp - $(MAKE) -C man install DESTDIR=$(CURDIR)/debian/tmp - $(MAKE) install-am DESTDIR=$(CURDIR)/debian/tmp - -# Build architecture-independent files here. -binary-indep: build-indep install-indep - dh_testdir - dh_testroot - dh_installchangelogs -i ChangeLog - dh_installdocs -i - dh_install -i --sourcedir=debian/tmp - dh_link -i - dh_compress -i - dh_fixperms -i - dh_installdeb -i - dh_gencontrol -i - dh_md5sums -i - dh_builddeb -i - -# Build architecture-dependent files here. -binary-arch: build-arch install-arch - dh_testdir - dh_testroot - dh_installchangelogs -a ChangeLog - dh_installdocs -a - dh_install -a --sourcedir=debian/tmp - dh_installman -a - dh_link -a - dh_strip -a - dh_compress -a - dh_fixperms -a - dh_makeshlibs -a -p$(SHARED_PKG) -V'$(SHARED_PKG) (>= $(SHLIB_VER))' - dh_installdeb -a - dh_shlibdeps -a - dh_gencontrol -a - dh_md5sums -a - dh_builddeb -a - -binary: binary-indep binary-arch -.PHONY: build build-arch build-indep clean binary-indep binary-arch binary install-arch install-indep diff --git a/debian/source/format b/debian/source/format deleted file mode 100644 index 163aaf8..0000000 --- a/debian/source/format +++ /dev/null @@ -1 +0,0 @@ -3.0 (quilt) diff --git a/debian/watch b/debian/watch deleted file mode 100644 index d6e6b0e..0000000 --- a/debian/watch +++ /dev/null @@ -1,2 +0,0 @@ -version=3 -opts=pasv ftp://linux.thai.net/pub/thailinux/software/libthai/libdatrie-([\d+\.]+|\d+)\.tar\.gz debian uupdate diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 45d37ef..265a48c 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,89 +1,103 @@ -# Doxyfile 1.5.8 +# Doxyfile 1.8.1.2 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# All text after a hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") +# Values that contain spaces should be placed between quotes (" "). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. PROJECT_NAME = @PACKAGE@ -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = @VERSION@ -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = @top_builddir@/doc -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, -# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, -# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, -# Spanish, Swedish, and Ukrainian. +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = "The $name class " \ @@ -98,480 +112,557 @@ ABBREVIATE_BRIEF = "The $name class " \ an \ the -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = @top_srcdir@ -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = @top_srcdir@ -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it parses. -# With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this tag. -# The format is ext=language, where ext is a file extension, and language is one of -# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, -# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO -# If you use Microsoft's C++/CLI language, you should set this option to YES to +# If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen to replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. SYMBOL_CACHE_SIZE = 0 +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespace are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = YES -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = YES -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by -# doxygen. The layout file controls the global structure of the generated output files -# in an output format independent way. The create the layout file that represents -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a -# file name after the option, if omitted DoxygenLayout.xml will be used as the name -# of the layout file. +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. -LAYOUT_FILE = +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text " -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = @top_srcdir@/datrie/alpha-map.h \ @@ -581,163 +672,174 @@ INPUT = @top_srcdir@/datrie/alpha-map.h \ @top_srcdir@/datrie/triedefs.h \ @top_srcdir@/datrie/typedefs.h -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl -FILE_PATTERNS = +FILE_PATTERNS = -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = * -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = NO @@ -746,384 +848,547 @@ VERBATIM_HEADERS = NO # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. -HTML_HEADER = +HTML_FOOTER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# style sheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 -HTML_FOOTER = +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! +HTML_COLORSTYLE_SAT = 100 -HTML_STYLESHEET = +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. +HTML_COLORSTYLE_GAMMA = 80 -HTML_ALIGN_MEMBERS = YES +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. HTML_DYNAMIC_SECTIONS = NO -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER -# are set, an additional index file will be generated that can be used as input for -# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated -# HTML documentation. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. -QCH_FILE = +QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace -QHP_NAMESPACE = +QHP_NAMESPACE = -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. -# For more information please see +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters -QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. -QHP_CUST_FILTER_ATTRS = +QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's -# filter section matches. -# Qt Help Project / Filter Attributes. +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. -QHG_LOCATION = +QHG_LOCATION = -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. -DISABLE_INDEX = NO +GENERATE_ECLIPSEHELP = NO -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. -ENUM_VALUES_PER_LINE = 4 +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to FRAME, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. Other possible values -# for this tag are: HIERARCHIES, which will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list; -# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which -# disables this behavior completely. For backwards compatibility with previous -# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE -# respectively. +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. GENERATE_TREEVIEW = NO -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = NO + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = NO -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = NO -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = YES @@ -1132,33 +1397,33 @@ MAN_LINKS = YES # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -1167,10 +1432,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -1179,347 +1444,364 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = NO -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. -MSCGEN_PATH = +MSCGEN_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This -# font does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. DOT_FONTNAME = FreeSans -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. -DOT_FONTPATH = +DOT_FONTPATH = -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. -DOT_PATH = +DOT_PATH = -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 1000 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Options related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = NO