llvm-project/libc/utils/CPP
Siva Chandra Reddy 4d812acba6 [libc] Add a README to the sub-directories under the utils directory.
Also, the source layout document has been updated to reflect the current
layout of the `utils` directory.

Reviewers: PaulkaToast

Differential Revision: https://reviews.llvm.org/D74502
2020-02-23 22:11:35 -08:00
..
Array.h
ArrayRef.h
CMakeLists.txt
README.md [libc] Add a README to the sub-directories under the utils directory. 2020-02-23 22:11:35 -08:00
StringRef.h
TypeTraits.h [libc] Add [EXPECT|ASSERT]_[TRUE|FALSE] unittest macros. 2020-01-30 11:59:31 -08:00

README.md

This directory contains re-implementations of some C++ standard library utilities, as well as some LLVM utilities. These utilities are for use with internal LLVM libc code and tests.

More utilities will be added on an as needed basis. There are certain rules to be followed for future changes and additions:

  1. Only two kind of headers can be included: Other headers from this directory, and free standing C headers.
  2. Free standing C headers are to be included as C headers and not as C++ headers. That is, use #include <stddef.h> and not #include <cstddef>.
  3. The utilities should be defined in the namespace __llvm_libc::cpp. The higher level namespace should have a __ prefix to avoid symbol name pollution when the utilities are used in implementation of public functions.