1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-21 03:53:04 +02:00
llvm-mirror/lib/Support
Reid Kleckner d11aae6992 [Windows] Convert from UTF-8 to UTF-16 when writing to a Windows console
Summary:
Calling WriteConsoleW is the most reliable way to print Unicode
characters to a Windows console.

If binary data gets printed to the console, attempting to re-encode it
shouldn't be a problem, since garbage in can produce garbage out.

This breaks printing strings in the local codepage, which WriteConsoleA
knows how to handle. For example, this can happen when user source code
is encoded with the local codepage, and an LLVM tool quotes it while
emitting a caret diagnostic. This is unfortunate, but well-behaved tools
should validate that their input is UTF-8 and escape non-UTF-8
characters before sending them to raw_fd_ostream. Clang already does
this, but not all LLVM tools do this.

One drawback to the current implementation is printing a string a byte
at a time doesn't work. Consider this LLVM code:
  for (char C : MyStr) outs() << C;

Because outs() is now unbuffered, we wil try to convert each byte to
UTF-16, which will fail. However, this already didn't work, so I think
we may as well update callers that do that as we find them to print
complete portions of strings. You can see a real example of this in my
patch to SourceMgr.cpp

Fixes PR38669 and PR36267.

Reviewers: zturner, efriedma

Subscribers: llvm-commits, hiraditya

Differential Revision: https://reviews.llvm.org/D51558

llvm-svn: 341433
2018-09-05 00:08:56 +00:00
..
Unix Use a lambda for calls to ::open in RetryAfterSignal 2018-08-27 15:55:39 +00:00
Windows Set console mode when -fansi-escape-codes is enabled 2018-09-04 19:23:05 +00:00
Allocator.cpp Recover some overzealously removed includes. 2017-12-13 22:21:02 +00:00
AMDGPUMetadata.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
APFloat.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
APInt.cpp [ADT] Replace APInt::WORD_MAX with APInt::WORDTYPE_MAX 2018-08-16 11:08:23 +00:00
APSInt.cpp
ARMAttributeParser.cpp Test commit 2018-02-26 13:05:18 +00:00
ARMBuildAttrs.cpp
ARMWinEH.cpp
Atomic.cpp Fix llvm-for-windows-on-linux build after LLVM r272701. 2017-08-03 20:10:47 +00:00
BinaryStreamError.cpp [DebugInfo] Common behavior for error types 2018-08-31 17:41:58 +00:00
BinaryStreamReader.cpp
BinaryStreamRef.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
BinaryStreamWriter.cpp [BinaryStream] Support growable streams. 2017-11-27 18:48:37 +00:00
BlockFrequency.cpp Remove redundant includes from lib/Support. 2017-12-13 21:30:58 +00:00
BranchProbability.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
CachePruning.cpp [Support][CachePruning] prune least recently accessed files first 2018-08-22 00:52:16 +00:00
Chrono.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
circular_raw_ostream.cpp [Support] Remove unused raw_ostream::handle whose anchor role was superseded by anchor() 2018-06-02 06:00:35 +00:00
CMakeLists.txt Add data structure to form equivalence classes of mangled names. 2018-08-24 22:31:51 +00:00
CodeGenCoverage.cpp [Support] Fix some Wundef warnings 2018-08-23 09:42:58 +00:00
COM.cpp [Support] Fix some Wundef warnings 2018-08-23 09:42:58 +00:00
CommandLine.cpp [CommandLine] Error message for incorrect PositionalEatArgs usage 2018-05-14 23:26:06 +00:00
Compression.cpp Fix buildbot breakage. 2018-08-04 00:23:37 +00:00
ConvertUTF.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
ConvertUTFWrapper.cpp
COPYRIGHT.regex
CrashRecoveryContext.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
DAGDeltaAlgorithm.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
DataExtractor.cpp
Debug.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +00:00
DebugCounter.cpp [DebugCounters] don't do redundant map lookups; NFC 2018-08-17 22:34:04 +00:00
DeltaAlgorithm.cpp
DJB.cpp Make llvm::djbHash an inline function. 2018-03-02 22:00:38 +00:00
DynamicLibrary.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
Errno.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
Error.cpp [Error] Add FileError helper; upgrade StringError behavior 2018-08-30 13:10:42 +00:00
ErrorHandling.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
FileCheck.cpp Refactor FileCheck to make it usable as an API 2018-08-07 21:58:49 +00:00
FileOutputBuffer.cpp [Support] Allow discarding a FileOutputBuffer without removing the memory mapping 2018-08-24 18:36:22 +00:00
FileUtilities.cpp
FoldingSet.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
FormattedStream.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
FormatVariadic.cpp Remove unused variables. No functionality change. 2017-10-08 19:11:02 +00:00
GlobPattern.cpp [Support/GlobPattern] - Do not crash when pattern has characters with int value < 0. 2017-07-31 09:26:50 +00:00
GraphWriter.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
Hashing.cpp Hashing: use 64-bit seed for hashing on all platforms. 2018-08-30 20:28:32 +00:00
Host.cpp Do not leak the Mach host port in sys::getHostCPUName() 2018-09-04 10:54:09 +00:00
InitLLVM.cpp Rename sys::Process::GetArgumentVector -> sys::windows::GetCommandLineArguments 2018-04-17 21:09:16 +00:00
IntEqClasses.cpp
IntervalMap.cpp
ItaniumManglingCanonicalizer.cpp Avoid specializing a variadic member template in a way that seems to not 2018-08-26 09:17:49 +00:00
JamCRC.cpp
JSON.cpp [Support] Harded JSON against invalid UTF-8. 2018-07-10 11:51:26 +00:00
KnownBits.cpp [KnownBits][ValueTracking] Move the math for calculating known bits for add/sub into a static method in KnownBits object 2017-08-08 16:29:35 +00:00
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt
Locale.cpp [Windows] Convert from UTF-8 to UTF-16 when writing to a Windows console 2018-09-05 00:08:56 +00:00
LockFileManager.cpp [Support] Fix some Wundef warnings 2018-08-23 09:42:58 +00:00
LowLevelType.cpp [GlobalISel] Enable legalizing non-power-of-2 sized types. 2017-11-07 10:34:34 +00:00
ManagedStatic.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
MathExtras.cpp
MD5.cpp Remove \brief commands from doxygen comments. 2018-05-01 15:54:18 +00:00
Memory.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
MemoryBuffer.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
Mutex.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
NativeFormatting.cpp Support: Add missing #include. 2018-01-18 20:49:33 +00:00
Options.cpp
Parallel.cpp Remove unused SyncExecutor and make it clearer that the whole file is only used if LLVM_ENABLE_THREADS 2018-05-11 15:25:38 +00:00
Path.cpp [Windows FS] Allow moving files in TempFile::keep 2018-08-03 10:13:35 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
Process.cpp Make LLVM_ENABLE_CRASH_DUMPS set a variable default 2018-08-23 22:58:56 +00:00
Program.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
RandomNumberGenerator.cpp Rename DEBUG macro to LLVM_DEBUG. 2018-05-14 12:53:11 +00:00
raw_os_ostream.cpp
raw_ostream.cpp [Windows] Convert from UTF-8 to UTF-16 when writing to a Windows console 2018-09-05 00:08:56 +00:00
README.txt.system
regcomp.c Attempt to heal bots after r328970. 2018-04-02 13:49:35 +00:00
regengine.inc [ADT] Replace std::isprint by llvm::isPrint. 2018-07-26 15:31:41 +00:00
regerror.c
regex2.h Support/reg*.h: Make headers include their dependencies 2017-10-26 20:23:11 +00:00
regex_impl.h Remove trailing space 2018-07-30 19:41:25 +00:00
Regex.cpp Fix compilation on Darwin with expensive checks. 2018-03-12 11:01:05 +00:00
regexec.c
regfree.c
regstrlcpy.c
regutils.h
RWMutex.cpp Fix include of config.h that was incorrectly changed in r331184 2018-05-03 21:59:13 +00:00
ScaledNumber.cpp
ScopedPrinter.cpp Remove redundant includes from lib/Support. 2017-12-13 21:30:58 +00:00
SHA1.cpp Fix header comment on SHA1 code. 2018-03-09 00:23:35 +00:00
Signals.cpp Refactor ExecuteAndWait to take StringRefs. 2018-06-12 17:43:52 +00:00
SmallPtrSet.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
SmallVector.cpp ADT: Shrink SmallVector size 0 to 16B on 64-bit platforms 2018-07-24 11:32:13 +00:00
SourceMgr.cpp [Windows] Convert from UTF-8 to UTF-16 when writing to a Windows console 2018-09-05 00:08:56 +00:00
SpecialCaseList.cpp Extend SpecialCaseList to allow users to blame matches on entries in the file. 2017-11-07 21:16:46 +00:00
Statistic.cpp Fix lock order inversion between ManagedStatic and Statistic 2018-04-17 23:37:18 +00:00
StringExtras.cpp [ADT] Replace std::isprint by llvm::isPrint. 2018-07-26 15:31:41 +00:00
StringMap.cpp Use uniform mechanism for OOM errors handling 2018-06-09 05:19:45 +00:00
StringPool.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
StringRef.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
StringSaver.cpp Fix an undefined behavior when storing an empty StringRef. 2018-08-20 13:12:54 +00:00
SystemUtils.cpp
TargetParser.cpp Start reserving x18 by default on Android targets. 2018-08-29 01:38:47 +00:00
TargetRegistry.cpp Improve incompatible triple error 2018-08-23 03:40:31 +00:00
TarWriter.cpp [FileSystem] Split up the OpenFlags enumeration. 2018-06-07 19:58:58 +00:00
Threading.cpp s/LLVM_ON_WIN32/_WIN32/, llvm 2018-04-29 00:45:03 +00:00
ThreadLocal.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
ThreadPool.cpp Revert "Enable ThreadPool to queue tasks that return values." 2018-06-13 21:24:19 +00:00
Timer.cpp [Support] Add a public API to allow clearing all (static) timer groups. 2018-08-17 04:13:19 +00:00
ToolOutputFile.cpp [Support] Rename tool_output_file to ToolOutputFile, NFC 2017-09-23 01:03:17 +00:00
TrigramIndex.cpp
Triple.cpp This patch adds support to LLVM for writing HermitCore (https://hermitcore.org) ELF binaries. 2018-08-25 01:08:18 +00:00
Twine.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
Unicode.cpp
UnicodeCaseFold.cpp Resubmit r325107 (case folding DJB hash) 2018-02-21 22:36:31 +00:00
Valgrind.cpp
VersionTuple.cpp Move VersionTuple from clang/Basic to llvm/Support 2018-06-11 10:28:04 +00:00
Watchdog.cpp IWYU for llvm-config.h in llvm, additions. 2018-04-30 14:59:11 +00:00
WithColor.cpp [Support] Move header to WithColor header 2018-05-24 11:47:20 +00:00
xxhash.cpp Make ICF log output order deterministic. 2018-07-31 18:04:58 +00:00
YAMLParser.cpp Remove trailing space 2018-07-30 19:41:25 +00:00
YAMLTraits.cpp [YAML] Escape non-printable multibyte UTF8 in Output::scalarString. 2018-03-27 19:52:45 +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