llvm-project/llvm/lib/Support
Yaron Keren 09fb7c6e7a Teach raw_ostream to accept SmallString.
Saves adding .str() call to any raw_ostream << SmallString usage
and a small step towards making .str() consistent in the ADTs by
removing one of the SmallString::str() use cases, discussion at

http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20141013/240026.html

I'll update the Phabricator patch http://reviews.llvm.org/D6372
for review of the Twine SmallString support, it's more complex
than this one.

llvm-svn: 231763
2015-03-10 07:33:23 +00:00
..
Unix Replace PrintStackTrace(FILE*) with PrintStackTrace(raw_ostream&) 2015-03-05 19:10:52 +00:00
Windows Replace PrintStackTrace(FILE*) with PrintStackTrace(raw_ostream&) 2015-03-05 19:10:52 +00:00
APFloat.cpp Simplify expressions involving boolean constants with clang-tidy 2015-03-09 01:57:13 +00:00
APInt.cpp Teach raw_ostream to accept SmallString. 2015-03-10 07:33:23 +00:00
APSInt.cpp
ARMBuildAttrs.cpp ARM: update build attributes for ABI r2.09 2014-01-19 08:25:35 +00:00
ARMWinEH.cpp Support: add Windows ARM EH data structures 2014-06-02 01:17:49 +00:00
Allocator.cpp [Allocator] Hoist the external helper function into a namespace scope 2014-04-14 06:42:56 +00:00
Atomic.cpp Fix .cpp files claiming to be header files 2014-06-20 01:36:00 +00:00
BlockFrequency.cpp blockfreq: Defer to BranchProbability::scale() (again) 2014-04-29 16:31:29 +00:00
BranchProbability.cpp BranchProb: Simplify printing code 2014-04-29 17:07:42 +00:00
CMakeLists.txt Drop the hacks used for partial C99 math libraries. 2015-03-09 18:35:18 +00:00
COPYRIGHT.regex
CommandLine.cpp Simplify expressions involving boolean constants with clang-tidy 2015-03-09 01:57:13 +00:00
Compression.cpp [msan] Annotate zlib functions for MemorySanitizer. 2014-11-25 15:24:07 +00:00
ConvertUTF.c Support/ConvertUTF: restore compatibility with MSVC, which only implements C89 2014-06-16 11:22:33 +00:00
ConvertUTFWrapper.cpp Make UTF8->UTF16 conversion null terminate output on empty input. 2015-02-08 18:08:51 +00:00
CrashRecoveryContext.cpp For CrashRecoveryContext::RunSafelyOnThread, propagate Darwin's PRIO_DARWIN_BG to the new thread if it is 2014-06-25 23:54:50 +00:00
DAGDeltaAlgorithm.cpp [Modules] Make Support/Debug.h modular. This requires it to not change 2014-04-21 22:55:11 +00:00
DataExtractor.cpp Using llvm::sys::swapByteOrder() for the common case of byte-swapping a value in place 2014-06-14 13:18:07 +00:00
DataStream.cpp Merge StreamableMemoryObject into MemoryObject. 2014-11-12 03:55:46 +00:00
Debug.cpp Provide the same ABI regardless of NDEBUG 2015-02-19 05:30:16 +00:00
DeltaAlgorithm.cpp
Dwarf.cpp Support: Add dwarf::getOperationEncoding() 2015-02-13 01:05:00 +00:00
DynamicLibrary.cpp Revert "Limit the symbol search in DynamicLibrary to the module that was opened." 2014-08-27 17:51:43 +00:00
Errno.cpp Silence warning: variable 'buffer' set but not used. 2014-12-04 21:36:38 +00:00
ErrorHandling.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
FileOutputBuffer.cpp Support: Improve performance of FileOutputBuffer on Windows 2015-03-06 06:07:32 +00:00
FileUtilities.cpp Remove some calls to std::move. 2014-08-01 14:31:55 +00:00
FoldingSet.cpp [C++11] More 'nullptr' conversion. In some cases just using a boolean check instead of comparing to nullptr. 2014-04-15 06:32:26 +00:00
FormattedStream.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
GraphWriter.cpp Fix style. 2014-11-07 21:30:36 +00:00
Hashing.cpp
Host.cpp We require MSVC 1800 as our minimum, so these checks can safely go away; NFC. 2015-02-16 18:23:00 +00:00
IntEqClasses.cpp
IntervalMap.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
IntrusiveRefCntPtr.cpp
LEB128.cpp Don't inline get[S|U]LEB128Size() until they are proved to be hot. 2014-02-22 15:39:39 +00:00
LLVMBuild.txt
LineIterator.cpp Add CRLF support to LineIterator. 2014-11-03 14:09:47 +00:00
Locale.cpp Move generic isPrint and columnWidth implementations to a separate header/source to allow using both generic and system-dependent versions on win32. 2013-09-04 16:00:12 +00:00
LockFileManager.cpp [Support] Increase timeout for the LockFileManager back to 5 mins. 2015-03-04 22:54:38 +00:00
MD5.cpp Make the MD5 result name consistent between functions, header and source. 2014-10-06 13:48:07 +00:00
Makefile Support: Inject LLVM_VERSION_INFO into the Support library 2014-06-17 06:52:47 +00:00
ManagedStatic.cpp Revert 220932. 2014-11-05 04:44:31 +00:00
MathExtras.cpp Fix llvm::huge_valf multiple initializations with Visual C++. 2014-09-27 14:41:29 +00:00
Memory.cpp
MemoryBuffer.cpp Pass EC by reference to MemoryBufferMMapFile to return error code. 2014-12-12 22:27:53 +00:00
MemoryObject.cpp Make readBytes pure virtual. Every real implementation has it. 2014-11-12 02:30:38 +00:00
Mutex.cpp [C++11] More 'nullptr' conversion. In some cases just using a boolean check instead of comparing to nullptr. 2014-04-15 06:32:26 +00:00
Options.cpp Defining a new API for debug options that doesn't rely on static global cl::opts. 2014-10-15 21:54:35 +00:00
Path.cpp Don't treat .foo as two path components in path::iterators 2015-03-10 00:04:29 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Fix the preprocessor checks used to determine if backtraces have been enabled. 2015-01-29 07:53:13 +00:00
Process.cpp Remove dead code. NFC. 2014-12-04 16:59:36 +00:00
Program.cpp Fix .cpp files claiming to be header files 2014-06-20 01:36:00 +00:00
README.txt.system
RWMutex.cpp [C++11] More 'nullptr' conversion. In some cases just using a boolean check instead of comparing to nullptr. 2014-04-15 06:32:26 +00:00
RandomNumberGenerator.cpp Random Number Generator Refactoring (removing from Module) 2014-12-17 18:12:10 +00:00
Regex.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
ScaledNumber.cpp [cleanup] Re-sort all the #include lines in LLVM using 2015-01-14 11:23:27 +00:00
SearchForAddressOfSpecialSymbol.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
Signals.cpp
SmallPtrSet.cpp Sync the __builtin_expects for our 3 quadratically probed hash table implementations. 2015-02-23 16:41:36 +00:00
SmallVector.cpp
SourceMgr.cpp Remove unnecessary .c_str() when implicitly converting to Twine 2014-11-06 01:13:27 +00:00
SpecialCaseList.cpp SpecialCaseList: Add support for parsing multiple input files. 2015-02-04 17:39:48 +00:00
Statistic.cpp Revert "[C++11] Replace LLVM atomics with std::atomic." 2014-03-03 18:02:34 +00:00
StreamingMemoryObject.cpp Removing LLVM_DELETED_FUNCTION, as MSVC 2012 was the last reason for requiring the macro. NFC; LLVM edition. 2015-02-15 22:54:22 +00:00
StringExtras.cpp
StringMap.cpp Sync the __builtin_expects for our 3 quadratically probed hash table implementations. 2015-02-23 16:41:36 +00:00
StringPool.cpp Convert StringMapEntry::Create to use StringRef instead of start/end pointers. Simpliies all in tree call sites. No functional change. 2014-06-11 05:35:56 +00:00
StringRef.cpp Simplify creation of a bunch of ArrayRefs by using None, makeArrayRef or just letting them be implicitly created. 2014-08-27 05:25:25 +00:00
SystemUtils.cpp
TargetRegistry.cpp Remove obsolete function TargetRegistry::getClosestTargetForJIT() 2014-07-01 10:47:13 +00:00
ThreadLocal.cpp ThreadLocal: Move Unix-specific code out of Support/ThreadLocal.cpp 2014-12-15 01:19:53 +00:00
Threading.cpp Revert 220932. 2014-11-05 04:44:31 +00:00
TimeValue.cpp Cleaning up static initializers in TimeValue. 2014-08-29 01:05:12 +00:00
Timer.cpp Modernize raw_fd_ostream's constructor a bit. 2014-08-25 18:16:47 +00:00
ToolOutputFile.cpp Modernize raw_fd_ostream's constructor a bit. 2014-08-25 18:16:47 +00:00
Triple.cpp Add support for Nuxi CloudABI. 2015-03-09 18:40:45 +00:00
Twine.cpp Remove unnecessary llvm:: qualification. 2014-02-26 23:27:16 +00:00
Unicode.cpp Move generic isPrint and columnWidth implementations to a separate header/source to allow using both generic and system-dependent versions on win32. 2013-09-04 16:00:12 +00:00
Valgrind.cpp Provide the same ABI regardless of NDEBUG 2015-02-19 05:30:16 +00:00
Watchdog.cpp
YAMLParser.cpp Demote vectors to arrays. No functionality change. 2015-02-19 15:26:17 +00:00
YAMLTraits.cpp Detect malformed YAML sequence in yaml::Input::beginSequence() 2015-03-02 17:26:43 +00:00
circular_raw_ostream.cpp
raw_os_ostream.cpp
raw_ostream.cpp Format: Modernize using variadic templates. 2015-02-15 22:15:41 +00:00
regcclass.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
regcname.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
regcomp.c Use wider type for overflow check on LLP64 platforms like Win64, found by clang-cl -Wtautological 2015-02-26 21:07:30 +00:00
regengine.inc Clean up language and grammar. 2014-05-20 17:11:11 +00:00
regerror.c
regex2.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00
regex_impl.h
regexec.c
regfree.c
regstrlcpy.c
regutils.h adding re-include guards into lib/Support/reg*.h 2014-06-12 16:07:56 +00:00

README.txt.system

Design Of lib/System
====================

The software in this directory is designed to completely shield LLVM from any
and all operating system specific functionality. It is not intended to be a
complete operating system wrapper (such as ACE), but only to provide the
functionality necessary to support LLVM.

The software located here, of necessity, has very specific and stringent design
rules. Violation of these rules means that cracks in the shield could form and
the primary goal of the library is defeated. By consistently using this library,
LLVM becomes more easily ported to new platforms since the only thing requiring
porting is this library.

Complete documentation for the library can be found in the file:
  llvm/docs/SystemLibrary.html
or at this URL:
  http://llvm.org/docs/SystemLibrary.html

While we recommend that you read the more detailed documentation, for the
impatient, here's a high level summary of the library's requirements.

 1. No system header files are to be exposed through the interface.
 2. Std C++ and Std C header files are okay to be exposed through the interface.
 3. No exposed system-specific functions.
 4. No exposed system-specific data.
 5. Data in lib/System classes must use only simple C++ intrinsic types.
 6. Errors are handled by returning "true" and setting an optional std::string
 7. Library must not throw any exceptions, period.
 8. Interface functions must not have throw() specifications.
 9. No duplicate function impementations are permitted within an operating
    system class.

To accomplish these requirements, the library has numerous design criteria that
must be satisfied. Here's a high level summary of the library's design criteria:

 1. No unused functionality (only what LLVM needs)
 2. High-Level Interfaces
 3. Use Opaque Classes
 4. Common Implementations
 5. Multiple Implementations
 6. Minimize Memory Allocation
 7. No Virtual Methods