1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-18 18:42:46 +02:00
llvm-mirror/lib/Support
Zachary Turner 873731b063 Resubmit "Update llvm command line parser to support subcommands."
This fixes an issue where occurrence counts would be unexpectedly
reset when parsing different parts of a command line multiple
times.

**ORIGINAL COMMIT MESSAGE**

This allows command line tools to use syntaxes like the following:

      llvm-foo.exe command1 -o1 -o2
      llvm-foo.exe command2 -p1 -p2

Where command1 and command2 contain completely different sets of
valid options.  This is backwards compatible with previous uses
of llvm cl which did not support subcommands, as any option
which specifies no optional subcommand (e.g. all existing
code) goes into a special "top level" subcommand that expects
dashed options to appear immediately after the program name.
For example, code which is subcommand unaware would generate
a command line such as the following, where no subcommand
is specified:

      llvm-foo.exe -q1 -q2

The top level subcommand can co-exist with actual subcommands,
as it is implemented as an actual subcommand which is searched
if no explicit subcommand is specified.  So llvm-foo.exe as
specified above could be written so as to support all three
aforementioned command lines simultaneously.

There is one additional "special" subcommand called AllSubCommands,
which can be used to inject an option into every subcommand.
This is useful to support things like help, so that commands
such as:

      llvm-foo.exe --help
      llvm-foo.exe command1 --help
      llvm-foo.exe command2 --help

All work and display the help for the selected subcommand
without having to explicitly go and write code to handle each
one separately.

This patch is submitted without an example of anything actually
using subcommands, but a followup patch will convert the
llvm-pdbdump tool to use subcommands.

Reviewed By: beanz

llvm-svn: 274171
2016-06-29 21:48:26 +00:00
..
Unix In openFileForRead, attempt to fetch the actual name of the file on disk -- including case -- so that clang can later warn about non-portable #include and #import directives. 2016-06-13 15:54:56 +00:00
Windows Explicitly specify the ANSI version of these Win32 APIs. While these are seemingly unrelated changes, they are all NFC because we currently default to the ANSI versions of the APIs when building for Windows. This simply makes the ANSI usage explicit. 2016-06-23 14:45:54 +00:00
Allocator.cpp
APFloat.cpp Remove some unneeded headers and replace some headers with forward class declarations (NFC) 2016-04-16 07:51:28 +00:00
APInt.cpp APInt: remove unsued param in private method. NFC 2016-06-27 08:31:48 +00:00
APSInt.cpp Remove some unneeded headers and replace some headers with forward class declarations (NFC) 2016-04-16 07:51:28 +00:00
ARMBuildAttrs.cpp [ARM] Add DSP build attribute and extension targeting 2016-01-25 11:26:11 +00:00
ARMWinEH.cpp
Atomic.cpp Remove all of the legacy home-grown atomic operations LLVM provided 2016-06-02 17:11:11 +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
CachePruning.cpp CachePruning: correct comment about file order. NFC 2016-06-27 08:46:23 +00:00
circular_raw_ostream.cpp
CMakeLists.txt [CMake] Restrict libxar linkage to just llvm-objdump 2016-05-26 16:32:40 +00:00
COM.cpp
CommandLine.cpp Resubmit "Update llvm command line parser to support subcommands." 2016-06-29 21:48:26 +00:00
Compression.cpp
ConvertUTF.c
ConvertUTFWrapper.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
COPYRIGHT.regex
CrashRecoveryContext.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
DAGDeltaAlgorithm.cpp
DataExtractor.cpp
DataStream.cpp
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 [DebugInfo] Add calling convention support for DWARF and CodeView 2016-06-08 20:34:29 +00:00
DynamicLibrary.cpp
Errno.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Error.cpp Linker: teach the IR mover to return llvm::Error. 2016-05-27 05:21:35 +00:00
ErrorHandling.cpp [Support] Make all Errors convertible to std::error_code. 2016-03-23 23:57:28 +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 Adding reserve and capacity methods to FoldingSet 2016-06-03 13:54:48 +00:00
FormattedStream.cpp
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 Reapply 272328 and 272329 as a single patch. 2016-06-09 23:04:15 +00:00
IntEqClasses.cpp Remove uses of builtin comma operator. 2016-02-18 22:09:30 +00:00
IntervalMap.cpp
IntrusiveRefCntPtr.cpp
JamCRC.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
LEB128.cpp
LineIterator.cpp
LLVMBuild.txt
Locale.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
LockFileManager.cpp [LockFileManager] Improve error output by using better error messages 2016-06-04 00:34:00 +00:00
ManagedStatic.cpp [ManagedStatic] Reimplement double-checked locking with std::atomic. 2016-06-29 15:04:07 +00:00
MathExtras.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
MD5.cpp
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
Mutex.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
Options.cpp
Path.cpp Add support for Darwin’s 64-bit universal files with 64-bit offsets and sizes for the objects. 2016-06-20 22:16:18 +00:00
PluginLoader.cpp
PrettyStackTrace.cpp Use C++ casts to avoid a warning 2016-05-27 23:04:28 +00:00
Process.cpp [Support] Creation of minidump after compiler crash on Windows 2016-05-04 16:56:51 +00:00
Program.cpp
RandomNumberGenerator.cpp
raw_os_ostream.cpp
raw_ostream.cpp C++11 is required, remove some preprocessor checks for it 2016-03-28 11:13:03 +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 Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
ScaledNumber.cpp Remove some unneeded headers and replace some headers with forward class declarations (NFC) 2016-04-16 07:51:28 +00:00
ScopedPrinter.cpp Move llvm-readobj/StreamWriter to Support. 2016-05-03 00:28:04 +00:00
SearchForAddressOfSpecialSymbol.cpp Revert "Fix Clang-tidy modernize-deprecated-headers warnings in remaining files; other minor fixes." 2016-04-05 20:45:04 +00:00
SHA1.cpp [NFC] Header cleanup 2016-04-18 09:17:29 +00:00
Signals.cpp Search for llvm-symbolizer binary in the same directory as argv[0], before 2016-06-09 00:53:21 +00:00
SmallPtrSet.cpp SmallPtrSet: Avoid initializing Array in the small case. 2016-02-15 21:38:42 +00:00
SmallVector.cpp
SourceMgr.cpp
SpecialCaseList.cpp Avoid some copies by using const references. 2016-05-27 12:30:51 +00:00
Statistic.cpp Statistic: Add machine parseable json output 2016-06-15 20:19:16 +00:00
StreamingMemoryObject.cpp Support: Implement StreamingMemoryObject::getPointer 2016-03-27 23:00:59 +00:00
StringExtras.cpp
StringMap.cpp Adjust initial size in StringMap constructor to guarantee no grow() 2016-03-25 05:57:57 +00:00
StringPool.cpp
StringRef.cpp [MCParser] Accept uppercase radix variants 0X and 0B 2016-03-18 18:22:07 +00:00
StringSaver.cpp
SystemUtils.cpp
TargetParser.cpp [AArch64] Add RAS extensions support in AArch64TargetParser. 2016-06-13 05:27:58 +00:00
TargetRegistry.cpp Don't mention a command line option in an error. 2016-01-28 22:55:45 +00:00
Threading.cpp [LPM] Reinstate r271781 which reinstated r271652 to replace the 2016-06-04 19:57:55 +00:00
ThreadLocal.cpp
ThreadPool.cpp Removing whitespace from test commit rL273447 2016-06-22 18:01:11 +00:00
Timer.cpp Test commit. Removes some spaces. No functionality changed. 2016-06-03 19:20:37 +00:00
TimeValue.cpp Fix some Clang-tidy modernize warnings, other minor fixes. 2015-11-04 22:32:32 +00:00
ToolOutputFile.cpp
Triple.cpp [Triple] Reimplement isLittleEndian(). Now it works for arm too. 2016-06-29 20:01:39 +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 [YAML] Fix YAML tags appearing before the start of sequence elements 2016-06-28 21:10:26 +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