llvm-6502/lib/Support
Chandler Carruth cceb8f44a0 Move constructors out-of-line and flesh out their documentation. No
functionality changed. This is in preparation for some refactoring of
how this class behaves.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@150941 91177308-0d34-0410-b5e6-96231b3b80d8
2012-02-20 00:02:47 +00:00
..
Unix Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Windows Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Allocator.cpp
APFloat.cpp APFloat::toString(): Fix overrun at scanning. 2012-02-19 03:18:29 +00:00
APInt.cpp Add r149110 back with a fix for when the vector and the int have the same 2012-01-27 23:33:07 +00:00
APSInt.cpp
Atomic.cpp drop unneeded config.h includes 2011-12-22 23:04:07 +00:00
BlockFrequency.cpp BlockFrequency: Use a smarter overflow check. 2011-10-27 16:38:50 +00:00
BranchProbability.cpp Print branch probabilities as percentages. 2011-10-23 11:32:54 +00:00
circular_raw_ostream.cpp
CMakeLists.txt Hashing.h - utilities for hashing various data types. 2012-02-18 21:00:49 +00:00
CommandLine.cpp Correct use of const in ParseCommandLineOptions 2012-02-07 19:36:01 +00:00
ConstantRange.cpp Convert assert(0) to llvm_unreachable 2012-02-07 05:05:23 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp Remove dead code. Improve llvm_unreachable text. Simplify some control flow. 2012-02-19 11:37:01 +00:00
DAGDeltaAlgorithm.cpp Adding missing anchor to DATDeltaAlgorithm. 2011-12-07 06:44:23 +00:00
DataExtractor.cpp
DataStream.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
Debug.cpp
DeltaAlgorithm.cpp
Disassembler.cpp
Dwarf.cpp Add new tag and an attribute to support debug info for objective-c property. 2012-02-03 23:57:08 +00:00
DynamicLibrary.cpp
Errno.cpp
ErrorHandling.cpp
FileUtilities.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
FoldingSet.cpp
FormattedStream.cpp
GraphWriter.cpp
Hashing.cpp Fix issue with bitwise and precedence. 2012-02-18 22:56:41 +00:00
Host.cpp Remove unreachable code. (replace with llvm_unreachable to help GCC where necessary) 2012-01-17 04:43:56 +00:00
IncludeFile.cpp
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp Unweaken vtables as per http://llvm.org/docs/CodingStandards.html#ll_virtual_anch 2011-12-20 02:50:00 +00:00
IsInf.cpp
IsNAN.cpp
JSONParser.cpp fix typo 2012-02-06 05:29:29 +00:00
LLVMBuild.txt LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
LockFileManager.cpp Move Clang's file-level locking facility over to LLVM's support 2012-01-29 20:15:10 +00:00
Makefile
ManagedStatic.cpp Add support for tsan annotations (thread sanitizer, a valgrind-based tool). 2011-11-14 20:50:16 +00:00
Memory.cpp
MemoryBuffer.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
MemoryObject.cpp Enable streaming of bitcode 2012-02-06 22:30:29 +00:00
Mutex.cpp Persuade GCC that there is nothing worth warning about here (there isn't). 2012-02-05 14:20:11 +00:00
Path.cpp Support/FileSystem: Add file_magic and move a vew clients over to it. 2011-12-13 23:17:12 +00:00
PathV2.cpp Change default error_code ctor to a 'named ctor' so it's more self-documenting. 2012-02-09 19:24:12 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp
Process.cpp
Program.cpp Support/Program: Make Change<stream>ToBinary return error_code. 2011-12-13 23:16:49 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Support/Program: Make Change<stream>ToBinary return error_code. 2011-12-13 23:16:49 +00:00
README.txt.system
regcclass.h
regcname.h
regcomp.c
regengine.inc
regerror.c
regex2.h
regex_impl.h
Regex.cpp
regexec.c
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp Remove dead code. 2012-01-15 01:09:13 +00:00
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp
SmallVector.cpp
SourceMgr.cpp Removing unused default switch cases in switches over enums that already account for all enumeration values explicitly. 2012-01-16 23:24:27 +00:00
Statistic.cpp Silence tsan false-positives (tsan can't track things which are only safe due to 2011-12-05 23:07:05 +00:00
StreamableMemoryObject.cpp Fix comment-rulers. 2012-02-06 22:41:47 +00:00
StringExtras.cpp
StringMap.cpp Switch StringMap from an array of structures to a structure of arrays. 2011-12-27 20:35:07 +00:00
StringPool.cpp
StringRef.cpp Add function for computing the edit distance of two arrays. 2012-02-15 22:13:07 +00:00
system_error.cpp
SystemUtils.cpp
TargetRegistry.cpp revert r147542 after comments from Joerg Sonnenberger 2012-01-05 18:28:46 +00:00
Threading.cpp rename ENABLE_THREADS to LLVM_ENABLE_THREADS 2011-11-28 00:48:58 +00:00
ThreadLocal.cpp rename ENABLE_THREADS to LLVM_ENABLE_THREADS 2011-11-28 00:48:58 +00:00
Timer.cpp Add more PRI.64 macros for MSVC and use them throughout the codebase. 2011-11-05 08:57:40 +00:00
TimeValue.cpp
ToolOutputFile.cpp
Triple.cpp Move constructors out-of-line and flesh out their documentation. No 2012-02-20 00:02:47 +00:00
Twine.cpp
Valgrind.cpp Don't define these unless we plan to use them. 2011-11-28 22:14:02 +00:00

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