legacy-libs/grpc-cloned/deps/grpc/third_party/abseil-cpp/README.md

   1 # Abseil - C++ Common Libraries
   2
   3 The repository contains the Abseil C++ library code. Abseil is an open-source
   4 collection of C++ code (compliant to C++11) designed to augment the C++
   5 standard library.
   6
   7 ## Table of Contents
   8
   9 - [About Abseil](#about)
  10 - [Quickstart](#quickstart)
  11 - [Building Abseil](#build)
  12 - [Codemap](#codemap)
  13 - [License](#license)
  14 - [Links](#links)
  15
  16 <a name="about"></a>
  17 ## About Abseil
  18
  19 Abseil is an open-source collection of C++ library code designed to augment
  20 the C++ standard library. The Abseil library code is collected from Google's
  21 own C++ code base, has been extensively tested and used in production, and
  22 is the same code we depend on in our daily coding lives.
  23
  24 In some cases, Abseil provides pieces missing from the C++ standard; in
  25 others, Abseil provides alternatives to the standard for special needs
  26 we've found through usage in the Google code base. We denote those cases
  27 clearly within the library code we provide you.
  28
  29 Abseil is not meant to be a competitor to the standard library; we've
  30 just found that many of these utilities serve a purpose within our code
  31 base, and we now want to provide those resources to the C++ community as
  32 a whole.
  33
  34 <a name="quickstart"></a>
  35 ## Quickstart
  36
  37 If you want to just get started, make sure you at least run through the
  38 [Abseil Quickstart](https://abseil.io/docs/cpp/quickstart). The Quickstart
  39 contains information about setting up your development environment, downloading
  40 the Abseil code, running tests, and getting a simple binary working.
  41
  42 <a name="build"></a>
  43 ## Building Abseil
  44
  45 [Bazel](https://bazel.build) is the official build system for Abseil,
  46 which is supported on most major platforms (Linux, Windows, MacOS, for example)
  47 and compilers. See the [quickstart](https://abseil.io/docs/cpp/quickstart) for
  48 more information on building Abseil using the Bazel build system.
  49
  50 <a name="cmake"></a>
  51 If you require CMake support, please check the
  52 [CMake build instructions](CMake/README.md).
  53
  54 ## Codemap
  55
  56 Abseil contains the following C++ library components:
  57
  58 * [`base`](absl/base/) Abseil Fundamentals
  59   <br /> The `base` library contains initialization code and other code which
  60   all other Abseil code depends on. Code within `base` may not depend on any
  61   other code (other than the C++ standard library).
  62 * [`algorithm`](absl/algorithm/)
  63   <br /> The `algorithm` library contains additions to the C++ `<algorithm>`
  64   library and container-based versions of such algorithms.
  65 * [`container`](absl/container/)
  66   <br /> The `container` library contains additional STL-style containers,
  67   including Abseil's unordered "Swiss table" containers.
  68 * [`debugging`](absl/debugging/)
  69   <br /> The `debugging` library contains code useful for enabling leak
  70   checks, and stacktrace and symbolization utilities.
  71 * [`hash`](absl/hash/)
  72   <br /> The `hash` library contains the hashing framework and default hash
  73   functor implementations for hashable types in Abseil.
  74 * [`memory`](absl/memory/)
  75   <br /> The `memory` library contains C++11-compatible versions of
  76   `std::make_unique()` and related memory management facilities.
  77 * [`meta`](absl/meta/)
  78   <br /> The `meta` library contains C++11-compatible versions of type checks
  79   available within C++14 and C++17 versions of the C++ `<type_traits>` library.
  80 * [`numeric`](absl/numeric/)
  81   <br /> The `numeric` library contains C++11-compatible 128-bit integers.
  82 * [`strings`](absl/strings/)
  83   <br /> The `strings` library contains a variety of strings routines and
  84   utilities, including a C++11-compatible version of the C++17
  85   `std::string_view` type.
  86 * [`synchronization`](absl/synchronization/)
  87   <br /> The `synchronization` library contains concurrency primitives (Abseil's
  88   `absl::Mutex` class, an alternative to `std::mutex`) and a variety of
  89   synchronization abstractions.
  90 * [`time`](absl/time/)
  91   <br /> The `time` library contains abstractions for computing with absolute
  92   points in time, durations of time, and formatting and parsing time within
  93   time zones.
  94 * [`types`](absl/types/)
  95   <br /> The `types` library contains non-container utility types, like a
  96   C++11-compatible version of the C++17 `std::optional` type.
  97 * [`utility`](absl/utility/)
  98   <br /> The `utility` library contains utility and helper code.
  99
 100 ## License
 101
 102 The Abseil C++ library is licensed under the terms of the Apache
 103 license. See [LICENSE](LICENSE) for more information.
 104
 105 ## Links
 106
 107 For more information about Abseil:
 108
 109 * Consult our [Abseil Introduction](https://abseil.io/about/intro)
 110 * Read [Why Adopt Abseil](https://abseil.io/about/philosophy) to understand our
 111   design philosophy.
 112 * Peruse our
 113   [Abseil Compatibility Guarantees](https://abseil.io/about/compatibility) to
 114   understand both what we promise to you, and what we expect of you in return.