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 For news and incompatible changes in this version, see the <<relnotes:,Release notes>>.
  16
  17 Modules
  18 -------
  19 - <<basics:,Basics>>
  20 - <<log:,Logging>>
  21 - <<fastbuf:,Fastbufs>>
  22 - <<basecode:,Base64 and Base224 encoding>>
  23 - <<hash:,Hashing routines>>
  24 - <<conf:,Configuration and command line parser>>
  25 - <<mempool:,Memory pools>>
  26 - <<eltpool:,Fixed-sized allocators>>
  27 - <<alloc:,Generic allocators>>
  28 - <<mainloop:,Mainloop>>
  29 - <<unaligned:,Unaligned data>>
  30 - <<lists:,Linked lists>>
  31 - <<gary:,Growing arrays>>
  32 - <<heap:,Binary heaps>>
  33 - <<binheap:,Binomial heaps>>
  34 - <<hashtable:,Hash tables>>
  35 - <<growbuf:,Growing buffers>> (obsolete)
  36 - <<chartype:,Single-byte characters>>
  37 - <<unicode:,Multi-byte characters>>
  38 - <<varint:,Encoding of integers>>
  39 - <<prime:,Prime numbers>>
  40 - <<sort:,Sorting>>
  41 - <<binsearch:,Binary search>>
  42 - <<compress:,Compression>>
  43 - <<trans:,Transactions and resource tracking>>
  44 - <<string:,String operations>>
  45 - <<time:,Time and timers>>
  46 - <<daemon:,Daemon helpers>>
  47 - <<signal:,Signal helpers>>
  48 - <<opt:,Command line parser>>
  49 - <<table:,Table printer>>
  50
  51 Other features
  52 --------------
  53 - <<configure:,Compile time configuration>>
  54 - <<config:,Configuration file syntax>>
  55 - <<docsys:,Documentation system>>
  56 - <<generic:,Macro-generated generics>>
  57
  58 Yet undocumented modules
  59 ------------------------
  60 - Trie
  61   * `trie.h`
  62 - Red-black trees
  63   * `redblack.h`
  64 - Bit manipulation
  65   * `bitarray.h`
  66   * `bitops.h`
  67   * `bitsig.h`
  68 - String manipulation
  69   * `kmp.h`
  70   * `kmp-search.h`
  71   * `regex.h`
  72   * `stkstring.h`
  73   * `strtonum.h`
  74   * `wildmatch.h`
  75 - File manipulation
  76   * `asio.h`
  77   * `io.h`
  78   * `partmap.h`
  79 - Address manipulation
  80   * `url.h`
  81   * `ipaccess.h`
  82 - Threads
  83   * `semaphore.h`
  84   * `threads.h`
  85   * `workqueue.h`
  86 - Miscellaneous
  87   * `sighandler.h`
  88   * `process.h`
  89
  90 License
  91 -------
  92 The UCW library is copyrighted by its authors.
  93
  94 It can be freely distributed and used according to the terms of
  95 the GNU Lesser General Public License, either version 2 or any later
  96 version.
  97
  98 Authors
  99 -------
 100 Primary authors and maintainers are:
 101
 102 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
 103 - Martin Mareš <mailto:mj\@ucw.cz[]>
 104 - Robert Špalek <mailto:robert\@ucw.cz[]>
 105
 106 Several modules have been contributed by:
 107
 108 - Daniel Fiala <mailto:danfiala\@ucw.cz[]> (strtonum)
 109 - Tomáš Gavenčiak <mailto:gavento\@ucw.cz[]> (logging system)
 110 - Robert Kessl <mailto:robert.kessl\@economia.cz[]> (table printer)
 111 - Jan Moskyto Matějka <mailto:mq\@ucw.cz[]> (option parser, fb-multi)
 112 - Tomáš Valla <mailto:tom\@ucw.cz[]> (varint)
 113 - Michal Vaner <mailto:vorner\@ucw.cz[]> (documentation system)