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>> and its <<ucw-tableprinter.5:,options>>
  50 - <<xtypes:,Extended data types>>
  51
  52 Other features
  53 --------------
  54 - <<configure:,Compile time configuration>>
  55 - <<config:,Configuration file syntax>>
  56 - <<docsys:,Documentation system>>
  57 - <<generic:,Macro-generated generics>>
  58
  59 Yet undocumented modules
  60 ------------------------
  61 - Trie
  62   * `trie.h`
  63 - Red-black trees
  64   * `redblack.h`
  65 - Bit manipulation
  66   * `bitarray.h`
  67   * `bitops.h`
  68   * `bitsig.h`
  69 - String manipulation
  70   * `kmp.h`
  71   * `kmp-search.h`
  72   * `regex.h`
  73   * `stkstring.h`
  74   * `strtonum.h`
  75   * `wildmatch.h`
  76 - File manipulation
  77   * `asio.h`
  78   * `io.h`
  79   * `partmap.h`
  80 - Address manipulation
  81   * `url.h`
  82   * `ipaccess.h`
  83 - Threads
  84   * `semaphore.h`
  85   * `threads.h`
  86   * `workqueue.h`
  87 - Miscellaneous
  88   * `sighandler.h`
  89   * `process.h`
  90
  91 Companion libraries
  92 -------------------
  93 - <<../ucw-json/index:,LibUCW-JSON>> -- a JSON parser and formatter
  94 - <<../ucw-xml/index:,LibUCW-XML>> -- a XML parser
  95 - LibUCW-charset -- character set conversion (undocumented)
  96 - LibUCW-images -- loading and conversion of images (undocumented)
  97
  98 License
  99 -------
 100 The UCW library is copyrighted by its authors.
 101
 102 It can be freely distributed and used according to the terms of
 103 the GNU Lesser General Public License, either version 2 or any later
 104 version.
 105
 106 Authors
 107 -------
 108 Primary authors and maintainers are:
 109
 110 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
 111 - Martin Mareš <mailto:mj\@ucw.cz[]>
 112 - Robert Špalek <mailto:robert\@ucw.cz[]>
 113
 114 Several modules have been contributed by:
 115
 116 - Daniel Fiala <mailto:danfiala\@ucw.cz[]> (strtonum)
 117 - Tomáš Gavenčiak <mailto:gavento\@ucw.cz[]> (logging system)
 118 - Robert Kessl <mailto:robert.kessl\@economia.cz[]> (table printer)
 119 - Jan Moskyto Matějka <mailto:mq\@ucw.cz[]> (option parser, fb-multi)
 120 - Tomáš Valla <mailto:tom\@ucw.cz[]> (varint)
 121 - Michal Vaner <mailto:vorner\@ucw.cz[]> (documentation system)