llvm/lib/Support
Marianne Mailhot-Sarrasin 07ef9b6010 More UTF string conversion wrappers
Added new string conversion wrappers that convert between `std::string` (of UTF-8 bytes) and `std::wstring`, which is particularly useful for Win32 interop. Also fixed a missing string conversion for `getenv` on Win32, using these new wrappers.
The motivation behind this is to provide the support functions required for LLDB to work properly on Windows with non-ASCII data; however, the functions are not LLDB specific.

Patch by cameron314

Differential Revision: http://reviews.llvm.org/D17549


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@263247 91177308-0d34-0410-b5e6-96231b3b80d8
2016-03-11 15:59:32 +00:00
..
Unix Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
Windows Revert r130657, "Windows/DynamicLibrary.inc: Clean up ELM_Callback. We may check the decl instead of the versions of individual libraries." 2016-03-07 00:13:09 +00:00
Allocator.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
APFloat.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
APInt.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
APSInt.cpp ADT: Add a string APSInt constructor. 2015-06-23 18:22:10 +00:00
ARMBuildAttrs.cpp [ARM] Add DSP build attribute and extension targeting 2016-01-25 11:26:11 +00:00
ARMWinEH.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
Atomic.cpp Fix .cpp files claiming to be header files 2014-06-20 01:36:00 +00:00
BlockFrequency.cpp Add - and -= operators to BlockFrequency using saturating arithmetic. 2015-10-12 18:34:00 +00:00
BranchProbability.cpp Annotate dump() methods with LLVM_DUMP_METHOD, addressing Richard Smith r259192 post commit comment. 2016-01-29 20:50:44 +00:00
circular_raw_ostream.cpp
CMakeLists.txt Refactor duplicated code for linking with pthread. 2016-03-01 15:54:40 +00:00
COM.cpp Make an RAII com initializer. 2015-04-27 17:19:26 +00:00
CommandLine.cpp More UTF string conversion wrappers 2016-03-11 15:59:32 +00:00
Compression.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
ConvertUTF.c Support/ConvertUTF: restore compatibility with MSVC, which only implements C89 2014-06-16 11:22:33 +00:00
ConvertUTFWrapper.cpp More UTF string conversion wrappers 2016-03-11 15:59:32 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp Use array_lengthof. NFC 2015-10-18 05:15:38 +00:00
DAGDeltaAlgorithm.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +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 Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
Debug.cpp The --debug-only option now takes a comma separated list of debug types. 2016-01-12 10:23:13 +00:00
DeltaAlgorithm.cpp
Dwarf.cpp Macro debug info support in LLVM IR 2015-12-10 12:56:35 +00:00
DynamicLibrary.cpp Add more wrappers for symbol APIs to the C API. 2015-06-09 15:57:30 +00:00
Errno.cpp Silence warning: variable 'buffer' set but not used. 2014-12-04 21:36:38 +00:00
ErrorHandling.cpp Reorganize the C API headers to improve build times. 2015-12-18 01:46:52 +00:00
FileOutputBuffer.cpp Remove temporary file on signal. 2015-09-18 15:17:53 +00:00
FileUtilities.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
FoldingSet.cpp [ADT] Teach FoldingSet to be movable. 2015-08-16 23:17:27 +00:00
FormattedStream.cpp Re-sort includes with sort-includes.py and insert raw_ostream.h where it's used. 2015-03-23 19:32:43 +00:00
GraphWriter.cpp [Support] Reapply r245289 "Always wait for GraphViz before opening the viewer" 2015-09-18 10:56:30 +00:00
Hashing.cpp
Host.cpp Fix LLVM's handling and detection of skylake and cannonlake CPUs 2016-02-21 17:12:03 +00:00
IntEqClasses.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
IntervalMap.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
IntrusiveRefCntPtr.cpp
JamCRC.cpp [MC] Add support for generating COFF CRCs 2015-09-01 21:23:58 +00:00
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 Add CRLF support to LineIterator. 2014-11-03 14:09:47 +00:00
LLVMBuild.txt
Locale.cpp Add #include llvm-config.h to Locale.cpp which depends on LLVM_ON_WIN32. 2015-09-11 13:22:47 +00:00
LockFileManager.cpp Reapply "Use gethostuuid() on Mac to identify hosts for LockFileManager" 2015-06-29 22:16:39 +00:00
ManagedStatic.cpp Support: Clean up TSan annotations. 2015-08-18 22:31:24 +00:00
MathExtras.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
MD5.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
Memory.cpp
MemoryBuffer.cpp Fix undefined behavior when compiling in C++14 mode (with sized deletion 2016-02-04 01:21:16 +00:00
MemoryObject.cpp Make readBytes pure virtual. Every real implementation has it. 2014-11-12 02:30:38 +00:00
Mutex.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +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 Fix identify_magic() to check that a file that starts with MH_MAGIC is 2016-01-26 23:43:37 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Reorganize the C API headers to improve build times. 2015-12-18 01:46:52 +00:00
Process.cpp Assert that Process::FindInEnvPath() is passed a relative path. 2015-04-24 22:18:46 +00:00
Program.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
RandomNumberGenerator.cpp Add missing include that MSVC complains about. 2015-03-23 18:19:41 +00:00
raw_os_ostream.cpp
raw_ostream.cpp Assert when trying to seek un-seekable raw_fd_ostream. 2016-02-23 07:17:58 +00:00
README.txt.system
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
Regex.cpp Remove more superfluous .str() and replace std::string concatenation with Twine. 2015-03-30 15:42:36 +00:00
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
RWMutex.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
ScaledNumber.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
SearchForAddressOfSpecialSymbol.cpp [C++11] Make use of 'nullptr' in the Support library. 2014-04-07 04:17:22 +00:00
Signals.cpp Appease hosts without HAVE_BACKTRACE nor ENABLE_BACKTRACES. 2015-11-08 09:45:06 +00:00
SmallPtrSet.cpp SmallPtrSet: Avoid initializing Array in the small case. 2016-02-15 21:38:42 +00:00
SmallVector.cpp [ADT] Assert that SmallVectorBase::grow_pod() successfully reallocates memory. 2015-06-09 09:47:46 +00:00
SourceMgr.cpp MIR Serialization: Connect the machine function analysis pass to the MIR parser. 2015-06-15 20:30:22 +00:00
SpecialCaseList.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
Statistic.cpp Simplify memory management with std::unique_ptr. 2015-12-16 22:28:34 +00:00
StreamingMemoryObject.cpp Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC) 2015-06-23 09:49:53 +00:00
StringExtras.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
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 [ADT] Rewrite the StringRef::find implementation to be simpler, clearer, 2015-09-10 11:17:49 +00:00
StringSaver.cpp There is only one saver of strings. 2015-08-13 01:07:02 +00:00
SystemUtils.cpp Purge unused includes throughout libSupport. 2015-03-23 18:07:13 +00:00
TargetParser.cpp Support: catch invalid accesses 2016-03-05 20:00:44 +00:00
TargetRegistry.cpp Don't mention a command line option in an error. 2016-01-28 22:55:45 +00:00
Threading.cpp Revert 220932. 2014-11-05 04:44:31 +00:00
ThreadLocal.cpp ThreadLocal: Move Unix-specific code out of Support/ThreadLocal.cpp 2014-12-15 01:19:53 +00:00
ThreadPool.cpp Fix MSVC build with LLVM_ENABLE_THREADS=OFF 2015-12-15 05:53:41 +00:00
Timer.cpp [Support] Allow multiple paired calls to {start,stop}Timer() 2015-12-22 17:36:17 +00:00
TimeValue.cpp Fix some Clang-tidy modernize warnings, other minor fixes. 2015-11-04 22:32:32 +00:00
ToolOutputFile.cpp Modernize raw_fd_ostream's constructor a bit. 2014-08-25 18:16:47 +00:00
Triple.cpp Add AMDGPU related triple vendors/OSes 2016-02-13 01:56:21 +00:00
Twine.cpp Annotate dump() methods with LLVM_DUMP_METHOD, addressing Richard Smith r259192 post commit comment. 2016-01-29 20:50:44 +00:00
Unicode.cpp
Valgrind.cpp Add a missing include of cstddef needed for size_t. 2015-10-15 19:41:54 +00:00
Watchdog.cpp
YAMLParser.cpp Simplify users of StringRef::{l,r}trim (NFC) 2016-02-16 02:06:01 +00:00
YAMLTraits.cpp [YAMLTraits] Use StringRef::copy. No functionality change. 2015-08-05 14:16:38 +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