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 - <<mainloop:,Mainloop>>
  28 - <<unaligned:,Unaligned data>>
  29 - <<lists:,Linked lists>>
  30 - <<heap:,Binary heaps>>
  31 - <<binheap:,Binomial heaps>>
  32 - <<hashtable:,Hash tables>>
  33 - <<growbuf:,Growing buffers>>
  34 - <<chartype:,Single-byte characters>>
  35 - <<unicode:,Multi-byte characters>>
  36 - <<prime:,Prime numbers>>
  37 - <<sort:,Sorting>>
  38 - <<binsearch:,Binary search>>
  39 - <<compress:,Compression>>
  40 - <<trans:,Transactions and resource tracking>>
  41 - <<string:,String operations>>
  42 - <<time:,Time and timers>>
  43 - <<daemon:,Daemon helpers>>
  44
  45 Other features
  46 --------------
  47 - <<configure:,Compile time configuration>>
  48 - <<config:,Configuration file syntax>>
  49 - <<docsys:,Documentation system>>
  50 - <<generic:,Macro-generated generics>>
  51
  52 Yet undocumented modules
  53 ------------------------
  54 - Allocators
  55   * `gary.h`
  56 - Trie
  57   * `trie.h`
  58 - Red-black trees
  59   * `redblack.h`
  60 - Bit manipulation
  61   * `bitarray.h`
  62   * `bitops.h`
  63   * `bitsig.h`
  64 - String manipulation
  65   * `kmp.h`
  66   * `kmp-search.h`
  67   * `regex.h`
  68   * `stkstring.h`
  69   * `strtonum.h`
  70   * `wildmatch.h`
  71 - File manipulation
  72   * `asio.h`
  73   * `io.h`
  74   * `partmap.h`
  75 - Address manipulation
  76   * `url.h`
  77   * `ipaccess.h`
  78 - Threads
  79   * `semaphore.h`
  80   * `threads.h`
  81   * `workqueue.h`
  82 - Miscellaneous
  83   * `sighandler.h`
  84   * `process.h`
  85
  86 License
  87 -------
  88 The UCW library is copyrighted by its authors:
  89
  90 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  91 - Martin Mareš <mailto:mj\@ucw.cz[]>
  92 - Robert Špalek <mailto:robert\@ucw.cz[]>
  93 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  94
  95 It can be freely distributed and used according to the terms of
  96 the GNU Lesser General Public License, either version 2 or any later
  97 version.