ucw/doc/index.txt

   1 The UCW library
   2 ===============
   3
   4 The UCW library aims to provide a set general purpose tools for programming
   5 in the C language. It contains generic data structures (lists, trees, hash
   6 tables etc.), fast memory allocators optimized for various usage patterns,
   7 abstract I/O streams and optimized implementations of some common algorithms
   8 (e.g., sorting of arrays and files).
   9
  10 Please note that this documentation is not yet complete. Many modules are
  11 not described, so you might need to look into the source code.
  12
  13 You can see the index of <<def_index:,documented definitions>>.
  14
  15 Modules
  16 -------
  17 - <<fastbuf:,Fastbufs>>
  18 - <<basecode:,Base64 and Base224 encoding>>
  19 - <<hash:,Hashing routines>>
  20 - <<conf:,Configuration and command line parser>>
  21 - <<mempool:,Memory pools>>
  22 - <<mainloop:,Mainloop>>
  23
  24 Other features
  25 --------------
  26 - <<configure:,Compile time configuration>>
  27 - <<config:,Configuration file syntax>>
  28 - <<docsys:,Documentation system>>
  29
  30 Yet undocumented modules
  31 ------------------------
  32 - Sorting
  33   * `arraysort.h`
  34   * `sorter/`
  35 - Growing buffers
  36   * `gbuf.h`
  37   * `bbuf.h`
  38 - Heaps
  39   * `binheap.h`
  40   * `binheap-node.h`
  41   * `heap.h`
  42 - Binary search
  43   * `binsearch.h`
  44 - Bit manipulation
  45   * `bitarray.h`
  46   * `bitopts.h`
  47   * `bitsig.h`
  48 - Character manipulation
  49   * `char-map.h`
  50   * `chartype.h`
  51   * `unicode.h`
  52 - Link lists
  53   * `clists.h`
  54   * `simple-lists.h`
  55   * `slists.h`
  56 - Fixed-sized allocator
  57   * `eltpool.h`
  58 - Hash tables
  59   * `hashtable.h`
  60 - IP address access lists
  61   * `ipaccess.h`
  62 - String manipulation
  63   * `kmp.h`
  64   * `kmp-search.h`
  65   * `regex.h`
  66   * `stkstring.h`
  67   * `string.h`
  68   * `str-match.h`
  69   * `wildmatch.h`
  70 - File manipulation
  71   * `asio.h`
  72   * `lfs.h`
  73   * `partmap.h`
  74 - Compression
  75   * `lizard.h`
  76 - Prefetching of memory
  77   * `prefetch.h`
  78 - Primes
  79   * `prime.h`
  80 - Profiling support
  81   * `profile.h`
  82 - Caches
  83   * `qache.h`
  84 - Red-black trees
  85   * `redblack.h`
  86 - Threads
  87   * `semaphore.h`
  88   * `threads.h`
  89   * `workqueue.h`
  90 - Trie
  91   * `trie.h`
  92 - Unaligned data
  93   * `unaligned.h`
  94 - URL manipulation
  95   * `url.h`
  96
  97 License
  98 -------
  99 The UCW library is copyrighted by its authors:
 100
 101 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
 102 - Martin Mareš <mailto:mj\@ucw.cz[]>
 103 - Robert Špalek <mailto:robert\@ucw.cz[]>
 104 - Michal Vaner <mailto:vorner\@ucw.cz[]>
 105
 106 It can be freely distributed and used according to the terms of
 107 the GNU Lesser General Public License.