o3tl/README.md

   1 # LibreOffice Template Library
   2
   3 Very basic template functionality, a bit like boost or STL, but specific to LibreOffice.
   4
   5 o3tl stands for "OOo [o3, get it?] template library", in which OOo stands for OpenOffice.org,
   6 predecessor of LibreOffice.
   7
   8 From <https://blog.thebehrens.net/2006/01/15/update-cow_wrapper-is-available-now/>
   9 The scope for o3tl is admittedly kind of ambitious, as it should contain "...very basic (template)
  10 functionality, comparable to what's provided by boost or stl, but specific to OOo (what comes to mind
  11 are e.g. STL adapters for our own data types and UNO, and stuff that could in principle be upstreamed
  12 to boost, but isn't as of now)."
  13
  14 ## Class Overview
  15
  16 - `[git:include/o3tl/cow_wrapper.hxx]`
  17
  18     A copy-on-write wrapper.
  19
  20 - `[git:include/o3tl/lazy_update.hxx]`
  21
  22     This template collects data in input type, and updates the output type with the given update functor,
  23     but only if the output is requested. Useful if updating is expensive, or input changes frequently, but
  24     output is only comparatively seldom used.
  25
  26 - `[git:include/o3tl/vector_pool.hxx]`
  27
  28     Simple vector-based memory pool allocator.
  29
  30 - `[git:include/o3tl/functional.hxx]`
  31
  32     Some more templates, leftovers in spirit of STLport's old functional
  33     header that are not part of the C++ standard (STLport has been
  34     replaced by direct use of the C++ STL in LibreOffice).