llvm/lib/Support
Saleem Abdulrasool 404a72729b support: add a utility function to normalise path separators
Add a utility function to convert the Windows path separator to Unix style path
separators.  This is used by a subsequent change in clang to enable the use of
Windows SDK headers on Linux.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@203611 91177308-0d34-0410-b5e6-96231b3b80d8
2014-03-11 22:05:42 +00:00
..
Unix support: add a utility function to normalise path separators 2014-03-11 22:05:42 +00:00
Windows support: add a utility function to normalise path separators 2014-03-11 22:05:42 +00:00
Allocator.cpp
APFloat.cpp APFloat: Add a move ctor and operator= 2014-03-04 20:26:51 +00:00
APInt.cpp Fix known typos 2014-01-24 17:20:08 +00:00
APSInt.cpp
ARMBuildAttrs.cpp ARM: update build attributes for ABI r2.09 2014-01-19 08:25:35 +00:00
Atomic.cpp
BlockFrequency.cpp [block-freq] Add a right shift to BlockFrequency that saturates at 1. 2013-12-14 02:24:22 +00:00
BranchProbability.cpp
circular_raw_ostream.cpp
CMakeLists.txt [Modules] Move the ConstantRange class into the IR library. This is 2014-03-04 12:24:34 +00:00
CommandLine.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
Compression.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
ConvertUTF.c
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp Remove dependence on std::function. 2014-03-04 22:13:07 +00:00
DAGDeltaAlgorithm.cpp [C++11] Remove 'virtual' keyword from methods marked with 'override' keyword. 2014-03-10 03:53:12 +00:00
DataExtractor.cpp
DataStream.cpp [C++11] Remove 'virtual' keyword from methods marked with 'override' keyword. 2014-03-10 03:53:12 +00:00
Debug.cpp
DeltaAlgorithm.cpp
Disassembler.cpp
Dwarf.cpp Dwarf: Fix a copy-paste bug. 2013-12-22 10:23:23 +00:00
DynamicLibrary.cpp Re-sort all of the includes with ./utils/sort_includes.py so that 2014-01-07 11:48:04 +00:00
Errno.cpp
ErrorHandling.cpp Roll back the ConstStringRef change for now 2014-01-27 05:24:39 +00:00
FileOutputBuffer.cpp [C++11] Add overloads for externally used OwningPtr functions. 2014-03-05 10:27:34 +00:00
FileUtilities.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
FoldingSet.cpp
FormattedStream.cpp
GraphWriter.cpp Use the simpler version of sys::fs::remove when possible. 2014-01-10 21:40:29 +00:00
Hashing.cpp
Host.cpp Add support for krait cpu in llvm::sys::getHostCPUName() 2013-12-20 09:24:13 +00:00
IncludeFile.cpp
IntEqClasses.cpp
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
IsInf.cpp
IsNAN.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
LineIterator.cpp Use two variables here rather than reusing (and abusing) one. This is 2013-12-27 04:44:35 +00:00
LLVMBuild.txt
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 Cleanup the interface for creating soft or hard links. 2014-03-11 18:40:24 +00:00
Makefile
ManagedStatic.cpp Revert "[C++11] Replace LLVM atomics with std::atomic." 2014-03-03 18:02:34 +00:00
MD5.cpp
Memory.cpp
MemoryBuffer.cpp [C++11] Remove 'virtual' keyword from methods marked with 'override' keyword. 2014-03-10 03:53:12 +00:00
MemoryObject.cpp
Mutex.cpp Remove unnecessary call to pthread_mutexattr_setpshared() 2014-01-29 00:20:44 +00:00
Path.cpp Fix an inconsistency in treatment of trailing / in path::const_iterator 2014-03-05 19:56:30 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Re-sort all of the includes with ./utils/sort_includes.py so that 2014-01-07 11:48:04 +00:00
Process.cpp Hopefully fixing the MinGW 32 build, which was broken by r200767. Not using rand_s() since MinGW does not have an implementation for it, but instead using the underlying CryptGenRandom APIs. 2014-02-11 02:47:33 +00:00
Program.cpp Add non-blocking Wait() for launched processes 2013-10-01 14:28:18 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Revert "Use StringRef in raw_fd_ostream constructor" 2014-02-27 02:09:10 +00:00
README.txt.system
regcclass.h
regcname.h
regcomp.c Fix known typos 2014-01-24 17:20:08 +00:00
regengine.inc
regerror.c
regex2.h
regex_impl.h
Regex.cpp Make llvm::Regex non-copyable but movable. 2014-01-02 19:04:59 +00:00
regexec.c
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp
SearchForAddressOfSpecialSymbol.cpp
Signals.cpp
SmallPtrSet.cpp [C++11] Remove the R-value reference #if usage from the ADT and Support 2014-03-01 09:27:28 +00:00
SmallVector.cpp
SourceMgr.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
Statistic.cpp Revert "[C++11] Replace LLVM atomics with std::atomic." 2014-03-03 18:02:34 +00:00
StreamableMemoryObject.cpp [C++11] Remove 'virtual' keyword from methods marked with 'override' keyword. 2014-03-10 03:53:12 +00:00
StringExtras.cpp
StringMap.cpp
StringPool.cpp
StringRef.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
StringRefMemoryObject.cpp
system_error.cpp [C++11] Remove 'virtual' keyword from methods marked with 'override' keyword. 2014-03-10 03:53:12 +00:00
SystemUtils.cpp
TargetRegistry.cpp [C++11] Revert uses of lambdas with array_pod_sort. 2014-03-07 21:52:38 +00:00
Threading.cpp Revert "[C++11] Replace LLVM atomics with std::atomic." 2014-03-03 18:02:34 +00:00
ThreadLocal.cpp [C++11] Replace LLVM_STATIC_ASSERT with static_assert, we now have 2014-03-02 13:10:45 +00:00
Timer.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
TimeValue.cpp
ToolOutputFile.cpp Use the simpler version of sys::fs::remove when possible. 2014-01-10 21:40:29 +00:00
Triple.cpp Fix inconsistent whitespace. 2014-03-09 23:17:28 +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
Watchdog.cpp
YAMLParser.cpp Replace OwningPtr<T> with std::unique_ptr<T>. 2014-03-06 05:51:42 +00:00
YAMLTraits.cpp Re-sort all of the includes with ./utils/sort_includes.py so that 2014-01-07 11:48:04 +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