llvm-6502/lib/Support
Michael J. Spencer 924aa23b74 Support/Windows/PathV2: Fix header comment.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121383 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-09 17:37:42 +00:00
..
Unix Support: Remove Alarm. It is unused (via local grep and google code search). 2010-12-07 18:41:59 +00:00
Windows Support/Windows/PathV2: Fix header comment. 2010-12-09 17:37:42 +00:00
Allocator.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
APFloat.cpp PR5207: Change APInt methods trunc(), sext(), zext(), sextOrTrunc() and 2010-12-07 08:25:19 +00:00
APInt.cpp PR5207: Change APInt methods trunc(), sext(), zext(), sextOrTrunc() and 2010-12-07 08:25:19 +00:00
APSInt.cpp
Atomic.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
circular_raw_ostream.cpp
CMakeLists.txt Support: Remove Alarm. It is unused (via local grep and google code search). 2010-12-07 18:41:59 +00:00
CommandLine.cpp Support/MemoryBuffer: Replace all uses of std::string *ErrMsg with error_code &ec. And fix clients. 2010-12-09 17:36:48 +00:00
ConstantRange.cpp PR5207: Change APInt methods trunc(), sext(), zext(), sextOrTrunc() and 2010-12-07 08:25:19 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
DAGDeltaAlgorithm.cpp
Debug.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
DeltaAlgorithm.cpp
Disassembler.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Dwarf.cpp
DynamicLibrary.cpp Don't leak the mutex when loading dynamic libraries. 2010-12-07 07:56:20 +00:00
Errno.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
ErrorHandling.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
FileUtilities.cpp Fix whitespace. 2010-12-09 17:37:32 +00:00
FoldingSet.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
FormattedStream.cpp
GraphWriter.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Host.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
IncludeFile.cpp Now to chant the magical incantation that will exorcise the System library 2010-11-29 19:44:50 +00:00
IntervalMap.cpp Add IntervalMap::iterator::set{Start,Stop,Value} methods that allow limited 2010-12-03 19:02:00 +00:00
IsInf.cpp
IsNAN.cpp
Makefile Merge System into Support. 2010-11-29 18:16:10 +00:00
ManagedStatic.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Memory.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
MemoryBuffer.cpp Support/MemoryBuffer: Replace all uses of std::string *ErrMsg with error_code &ec. And fix clients. 2010-12-09 17:36:48 +00:00
MemoryObject.cpp
Mutex.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Path.cpp Delete Path::appendSuffix's return value; it wasn't used anywhere, which 2010-12-01 02:46:41 +00:00
PathV2.cpp Support/FileSystem: Change file_status predicate functions that cannot fail to 2010-12-09 17:37:02 +00:00
PluginLoader.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
PrettyStackTrace.cpp Apparently OS X 10.4 doesn't have __crashreporter_info__. 2010-12-03 07:45:22 +00:00
Process.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Program.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
README.txt.system Merge System into Support. 2010-11-29 18:16:10 +00:00
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 Merge System into Support. 2010-11-29 18:16:10 +00:00
SearchForAddressOfSpecialSymbol.cpp build: Go back to dropping __eprintf reference when building with Clang, see 2010-12-07 16:29:44 +00:00
Signals.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
SmallPtrSet.cpp
SmallVector.cpp
SourceMgr.cpp Fix whitespace. 2010-12-09 17:37:32 +00:00
Statistic.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
StringExtras.cpp
StringMap.cpp
StringPool.cpp
StringRef.cpp PR5207: Change APInt methods trunc(), sext(), zext(), sextOrTrunc() and 2010-12-07 08:25:19 +00:00
system_error.cpp Support/MemoryBuffer: Replace all uses of std::string *ErrMsg with error_code &ec. And fix clients. 2010-12-09 17:36:48 +00:00
SystemUtils.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
TargetRegistry.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Threading.cpp Now to chant the magical incantation that will exorcise the System library 2010-11-29 19:44:50 +00:00
ThreadLocal.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Timer.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
TimeValue.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
ToolOutputFile.cpp Merge System into Support. 2010-11-29 18:16:10 +00:00
Triple.cpp
Twine.cpp Support/ADT/Twine: Make toNullTerminatedStringRef not rely on UB :(. 2010-12-03 05:42:25 +00:00
Valgrind.cpp Merge System into Support. 2010-11-29 18:16:10 +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