| // Copyright 2014 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef TOOLS_GN_SWITCHES_H_ |
| #define TOOLS_GN_SWITCHES_H_ |
| |
| #include <map> |
| #include <string_view> |
| |
| namespace switches { |
| |
| struct SwitchInfo { |
| SwitchInfo(); |
| SwitchInfo(const char* short_help, const char* long_help); |
| |
| const char* short_help; |
| const char* long_help; |
| }; |
| |
| using SwitchInfoMap = std::map<std::string_view, SwitchInfo>; |
| |
| // Returns the mapping of all global switches. |
| const SwitchInfoMap& GetSwitches(); |
| |
| // This file contains global switches. If a command takes specific ones only |
| // to that command, just put them in that command's .cc file. |
| |
| extern const char kArgs[]; |
| extern const char kArgs_HelpShort[]; |
| extern const char kArgs_Help[]; |
| |
| extern const char kColor[]; |
| extern const char kColor_HelpShort[]; |
| extern const char kColor_Help[]; |
| |
| extern const char kDotfile[]; |
| extern const char kDotfile_HelpShort[]; |
| extern const char kDotfile_Help[]; |
| |
| extern const char kFailOnUnusedArgs[]; |
| extern const char kFailOnUnusedArgs_HelpShort[]; |
| extern const char kFailOnUnusedArgs_Help[]; |
| |
| extern const char kMarkdown[]; |
| extern const char kMarkdown_HelpShort[]; |
| extern const char kMarkdown_Help[]; |
| |
| extern const char kNinjaExecutable[]; |
| extern const char kNinjaExecutable_HelpShort[]; |
| extern const char kNinjaExecutable_Help[]; |
| |
| extern const char kNoColor[]; |
| extern const char kNoColor_HelpShort[]; |
| extern const char kNoColor_Help[]; |
| |
| extern const char kScriptExecutable[]; |
| extern const char kScriptExecutable_HelpShort[]; |
| extern const char kScriptExecutable_Help[]; |
| |
| extern const char kQuiet[]; |
| extern const char kQuiet_HelpShort[]; |
| extern const char kQuiet_Help[]; |
| |
| extern const char kRoot[]; |
| extern const char kRoot_HelpShort[]; |
| extern const char kRoot_Help[]; |
| |
| extern const char kRootTarget[]; |
| extern const char kRootTarget_HelpShort[]; |
| extern const char kRootTarget_Help[]; |
| |
| extern const char kRuntimeDepsListFile[]; |
| extern const char kRuntimeDepsListFile_HelpShort[]; |
| extern const char kRuntimeDepsListFile_Help[]; |
| |
| extern const char kThreads[]; |
| extern const char kThreads_HelpShort[]; |
| extern const char kThreads_Help[]; |
| |
| extern const char kTime[]; |
| extern const char kTime_HelpShort[]; |
| extern const char kTime_Help[]; |
| |
| extern const char kTracelog[]; |
| extern const char kTracelog_HelpShort[]; |
| extern const char kTracelog_Help[]; |
| |
| extern const char kVerbose[]; |
| extern const char kVerbose_HelpShort[]; |
| extern const char kVerbose_Help[]; |
| |
| extern const char kVersion[]; |
| extern const char kVersion_HelpShort[]; |
| extern const char kVersion_Help[]; |
| |
| // This switch is used by several commands. It is here so it can be shared, |
| // but it's documented in the individual commands it applies to rather than |
| // globally. |
| extern const char kDefaultToolchain[]; |
| #define DEFAULT_TOOLCHAIN_SWITCH_HELP \ |
| " --default-toolchain\n" \ |
| " Normally wildcard targets are matched in all toolchains. This\n" \ |
| " switch makes wildcard labels with no explicit toolchain reference\n" \ |
| " only match targets in the default toolchain.\n" \ |
| "\n" \ |
| " Non-wildcard inputs with no explicit toolchain specification will\n" \ |
| " always match only a target in the default toolchain if one exists.\n" |
| |
| // This switch is used to signal to the gen command that it is being invoked on |
| // a regeneration step. Ie, ninja has realized that build.ninja needs to be |
| // generated again and has invoked gn gen. There is no help associated with it |
| // because users should not be setting this switch. It is located in this file |
| // so it can be shared between command_gen and ninja_build_writer. |
| extern const char kRegeneration[]; |
| |
| // This switch is read by Setup so needs to be in this global place, but is |
| // relevant only by command_gen so is documented there. |
| extern const char kAddExportCompileCommands[]; |
| |
| } // namespace switches |
| |
| #endif // TOOLS_GN_SWITCHES_H_ |