[email protected] | 72e2e242 | 2012-02-27 18:38:12 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
license.bot | bf09a50 | 2008-08-24 00:55:55 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
[email protected] | 02c8796 | 2008-10-06 10:25:35 | [diff] [blame] | 4 | |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 5 | // This class works with command lines: building and parsing. |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 6 | // Arguments with prefixes ('--', '-', and on Windows, '/') are switches. |
| 7 | // Switches will precede all other arguments without switch prefixes. |
| 8 | // Switches can optionally have values, delimited by '=', e.g., "-switch=value". |
| 9 | // An argument of "--" will terminate switch parsing during initialization, |
| 10 | // interpreting subsequent tokens as non-switch arguments, regardless of prefix. |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 11 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 12 | // There is a singleton read-only CommandLine that represents the command line |
| 13 | // that the current process was started with. It must be initialized in main(). |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 14 | |
[email protected] | 02c8796 | 2008-10-06 10:25:35 | [diff] [blame] | 15 | #ifndef BASE_COMMAND_LINE_H_ |
| 16 | #define BASE_COMMAND_LINE_H_ |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 17 | |
[email protected] | 2edc286 | 2011-04-04 18:04:37 | [diff] [blame] | 18 | #include <stddef.h> |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 19 | #include <map> |
| 20 | #include <string> |
| 21 | #include <vector> |
| 22 | |
[email protected] | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 23 | #include "base/base_export.h" |
mgiuca | c9e499e | 2014-10-01 07:54:57 | [diff] [blame] | 24 | #include "base/strings/string16.h" |
jackhou | 1bd9da9 | 2015-05-21 04:48:00 | [diff] [blame] | 25 | #include "base/strings/string_piece.h" |
[email protected] | 74e9fa2 | 2010-12-29 21:06:43 | [diff] [blame] | 26 | #include "build/build_config.h" |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 27 | |
[email protected] | a3ef483 | 2013-02-02 05:12:33 | [diff] [blame] | 28 | namespace base { |
[email protected] | 2f3b1cc | 2014-03-17 23:07:15 | [diff] [blame] | 29 | |
[email protected] | 5d91c9e | 2010-07-28 17:25:28 | [diff] [blame] | 30 | class FilePath; |
[email protected] | d4515eb | 2009-01-30 00:40:43 | [diff] [blame] | 31 | |
[email protected] | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 32 | class BASE_EXPORT CommandLine { |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 33 | public: |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 34 | #if defined(OS_WIN) |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 35 | // The native command line string type. |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 36 | using StringType = string16; |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 37 | #elif defined(OS_POSIX) |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 38 | using StringType = std::string; |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 39 | #endif |
| 40 | |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 41 | using CharType = StringType::value_type; |
| 42 | using StringVector = std::vector<StringType>; |
Jeremy Roman | 863386d | 2017-10-31 19:25:38 | [diff] [blame] | 43 | using SwitchMap = std::map<std::string, StringType, std::less<>>; |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 44 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 45 | // A constructor for CommandLines that only carry switches and arguments. |
[email protected] | 947446b | 2010-10-21 03:36:31 | [diff] [blame] | 46 | enum NoProgram { NO_PROGRAM }; |
| 47 | explicit CommandLine(NoProgram no_program); |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 48 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 49 | // Construct a new command line with |program| as argv[0]. |
[email protected] | 2f3b1cc | 2014-03-17 23:07:15 | [diff] [blame] | 50 | explicit CommandLine(const FilePath& program); |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 51 | |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 52 | // Construct a new command line from an argument list. |
| 53 | CommandLine(int argc, const CharType* const* argv); |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 54 | explicit CommandLine(const StringVector& argv); |
[email protected] | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 55 | |
jackhou | 1bd9da9 | 2015-05-21 04:48:00 | [diff] [blame] | 56 | // Override copy and assign to ensure |switches_by_stringpiece_| is valid. |
| 57 | CommandLine(const CommandLine& other); |
| 58 | CommandLine& operator=(const CommandLine& other); |
| 59 | |
[email protected] | acbeb3d | 2011-03-01 20:47:58 | [diff] [blame] | 60 | ~CommandLine(); |
| 61 | |
[email protected] | bf98a0e1 | 2013-09-25 23:36:00 | [diff] [blame] | 62 | #if defined(OS_WIN) |
| 63 | // By default this class will treat command-line arguments beginning with |
| 64 | // slashes as switches on Windows, but not other platforms. |
| 65 | // |
| 66 | // If this behavior is inappropriate for your application, you can call this |
| 67 | // function BEFORE initializing the current process' global command line |
| 68 | // object and the behavior will be the same as Posix systems (only hyphens |
| 69 | // begin switches, everything else will be an arg). |
| 70 | static void set_slash_is_not_a_switch(); |
ananta | d936bc1 | 2016-06-22 21:40:31 | [diff] [blame] | 71 | |
| 72 | // Normally when the CommandLine singleton is initialized it gets the command |
| 73 | // line via the GetCommandLineW API and then uses the shell32 API |
| 74 | // CommandLineToArgvW to parse the command line and convert it back to |
| 75 | // argc and argv. Tests who don't want this dependency on shell32 and need |
| 76 | // to honor the arguments passed in should use this function. |
| 77 | static void InitUsingArgvForTesting(int argc, const char* const* argv); |
[email protected] | bf98a0e1 | 2013-09-25 23:36:00 | [diff] [blame] | 78 | #endif |
| 79 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 80 | // Initialize the current process CommandLine singleton. On Windows, ignores |
| 81 | // its arguments (we instead parse GetCommandLineW() directly) because we |
| 82 | // don't trust the CRT's parsing of the command line, but it still must be |
[email protected] | 72e2e242 | 2012-02-27 18:38:12 | [diff] [blame] | 83 | // called to set up the command line. Returns false if initialization has |
| 84 | // already occurred, and true otherwise. Only the caller receiving a 'true' |
| 85 | // return value should take responsibility for calling Reset. |
| 86 | static bool Init(int argc, const char* const* argv); |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 87 | |
[email protected] | a2318cda | 2009-02-25 21:13:53 | [diff] [blame] | 88 | // Destroys the current process CommandLine singleton. This is necessary if |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 89 | // you want to reset the base library to its initial state (for example, in an |
[email protected] | a2318cda | 2009-02-25 21:13:53 | [diff] [blame] | 90 | // outer library that needs to be able to terminate, and be re-initialized). |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 91 | // If Init is called only once, as in main(), Reset() is not necessary. |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 92 | // Do not call this in tests. Use base::test::ScopedCommandLine instead. |
[email protected] | 02fb75ab | 2009-10-12 16:11:40 | [diff] [blame] | 93 | static void Reset(); |
[email protected] | a2318cda | 2009-02-25 21:13:53 | [diff] [blame] | 94 | |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 95 | // Get the singleton CommandLine representing the current process's |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 96 | // command line. Note: returned value is mutable, but not thread safe; |
[email protected] | 0189bbd | 2009-10-12 22:50:39 | [diff] [blame] | 97 | // only mutate if you know what you're doing! |
[email protected] | dcd869c | 2010-08-30 20:15:25 | [diff] [blame] | 98 | static CommandLine* ForCurrentProcess(); |
[email protected] | 1a48f31 | 2008-08-12 01:14:37 | [diff] [blame] | 99 | |
[email protected] | 2bf64a9 | 2013-07-11 23:10:40 | [diff] [blame] | 100 | // Returns true if the CommandLine has been initialized for the given process. |
| 101 | static bool InitializedForCurrentProcess(); |
| 102 | |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 103 | #if defined(OS_WIN) |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 104 | static CommandLine FromString(const string16& command_line); |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 105 | #endif |
| 106 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 107 | // Initialize from an argv vector. |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 108 | void InitFromArgv(int argc, const CharType* const* argv); |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 109 | void InitFromArgv(const StringVector& argv); |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 110 | |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 111 | // Constructs and returns the represented command line string. |
[email protected] | 45f982e | 2012-10-29 21:31:31 | [diff] [blame] | 112 | // CAUTION! This should be avoided on POSIX because quoting behavior is |
| 113 | // unclear. |
mgiuca | c974d510 | 2014-10-01 09:24:51 | [diff] [blame] | 114 | StringType GetCommandLineString() const { |
| 115 | return GetCommandLineStringInternal(false); |
| 116 | } |
| 117 | |
| 118 | #if defined(OS_WIN) |
| 119 | // Constructs and returns the represented command line string. Assumes the |
| 120 | // command line contains placeholders (eg, %1) and quotes any program or |
| 121 | // argument with a '%' in it. This should be avoided unless the placeholder is |
| 122 | // required by an external interface (eg, the Windows registry), because it is |
| 123 | // not generally safe to replace it with an arbitrary string. If possible, |
| 124 | // placeholders should be replaced *before* converting the command line to a |
| 125 | // string. |
| 126 | StringType GetCommandLineStringWithPlaceholders() const { |
| 127 | return GetCommandLineStringInternal(true); |
| 128 | } |
| 129 | #endif |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 130 | |
[email protected] | 45f982e | 2012-10-29 21:31:31 | [diff] [blame] | 131 | // Constructs and returns the represented arguments string. |
| 132 | // CAUTION! This should be avoided on POSIX because quoting behavior is |
| 133 | // unclear. |
mgiuca | c974d510 | 2014-10-01 09:24:51 | [diff] [blame] | 134 | StringType GetArgumentsString() const { |
| 135 | return GetArgumentsStringInternal(false); |
| 136 | } |
| 137 | |
| 138 | #if defined(OS_WIN) |
| 139 | // Constructs and returns the represented arguments string. Assumes the |
| 140 | // command line contains placeholders (eg, %1) and quotes any argument with a |
| 141 | // '%' in it. This should be avoided unless the placeholder is required by an |
| 142 | // external interface (eg, the Windows registry), because it is not generally |
| 143 | // safe to replace it with an arbitrary string. If possible, placeholders |
| 144 | // should be replaced *before* converting the arguments to a string. |
| 145 | StringType GetArgumentsStringWithPlaceholders() const { |
| 146 | return GetArgumentsStringInternal(true); |
| 147 | } |
| 148 | #endif |
[email protected] | 45f982e | 2012-10-29 21:31:31 | [diff] [blame] | 149 | |
[email protected] | 10e42bf | 2008-10-15 21:59:08 | [diff] [blame] | 150 | // Returns the original command line string as a vector of strings. |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 151 | const StringVector& argv() const { return argv_; } |
[email protected] | 10e42bf | 2008-10-15 21:59:08 | [diff] [blame] | 152 | |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 153 | // Get and Set the program part of the command line string (the first item). |
[email protected] | 2f3b1cc | 2014-03-17 23:07:15 | [diff] [blame] | 154 | FilePath GetProgram() const; |
| 155 | void SetProgram(const FilePath& program); |
[email protected] | 0189bbd | 2009-10-12 22:50:39 | [diff] [blame] | 156 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 157 | // Returns true if this command line contains the given switch. |
jackhou | 1bd9da9 | 2015-05-21 04:48:00 | [diff] [blame] | 158 | // Switch names must be lowercase. |
| 159 | // The second override provides an optimized version to avoid inlining codegen |
| 160 | // at every callsite to find the length of the constant and construct a |
| 161 | // StringPiece. |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 162 | bool HasSwitch(const StringPiece& switch_string) const; |
tapted | 009a1dc8 | 2015-03-30 03:57:10 | [diff] [blame] | 163 | bool HasSwitch(const char switch_constant[]) const; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 164 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 165 | // Returns the value associated with the given switch. If the switch has no |
| 166 | // value or isn't present, this method returns the empty string. |
jackhou | 1bd9da9 | 2015-05-21 04:48:00 | [diff] [blame] | 167 | // Switch names must be lowercase. |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 168 | std::string GetSwitchValueASCII(const StringPiece& switch_string) const; |
| 169 | FilePath GetSwitchValuePath(const StringPiece& switch_string) const; |
| 170 | StringType GetSwitchValueNative(const StringPiece& switch_string) const; |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 171 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 172 | // Get a copy of all switches, along with their values. |
| 173 | const SwitchMap& GetSwitches() const { return switches_; } |
| 174 | |
| 175 | // Append a switch [with optional value] to the command line. |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 176 | // Note: Switches will precede arguments regardless of appending order. |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 177 | void AppendSwitch(const std::string& switch_string); |
[email protected] | a3ef483 | 2013-02-02 05:12:33 | [diff] [blame] | 178 | void AppendSwitchPath(const std::string& switch_string, |
[email protected] | 2f3b1cc | 2014-03-17 23:07:15 | [diff] [blame] | 179 | const FilePath& path); |
[email protected] | 4f08c83f | 2010-07-29 23:02:34 | [diff] [blame] | 180 | void AppendSwitchNative(const std::string& switch_string, |
| 181 | const StringType& value); |
[email protected] | d420c31e | 2010-07-30 02:14:22 | [diff] [blame] | 182 | void AppendSwitchASCII(const std::string& switch_string, |
| 183 | const std::string& value); |
[email protected] | 4f08c83f | 2010-07-29 23:02:34 | [diff] [blame] | 184 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 185 | // Copy a set of switches (and any values) from another command line. |
| 186 | // Commonly used when launching a subprocess. |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 187 | void CopySwitchesFrom(const CommandLine& source, |
| 188 | const char* const switches[], |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 189 | size_t count); |
| 190 | |
| 191 | // Get the remaining arguments to the command. |
[email protected] | 75f1c78 | 2011-07-13 23:41:22 | [diff] [blame] | 192 | StringVector GetArgs() const; |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 193 | |
| 194 | // Append an argument to the command line. Note that the argument is quoted |
| 195 | // properly such that it is interpreted as one argument to the target command. |
| 196 | // AppendArg is primarily for ASCII; non-ASCII input is interpreted as UTF-8. |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 197 | // Note: Switches will precede arguments regardless of appending order. |
[email protected] | 0445eb4 | 2010-08-13 22:10:30 | [diff] [blame] | 198 | void AppendArg(const std::string& value); |
[email protected] | 2f3b1cc | 2014-03-17 23:07:15 | [diff] [blame] | 199 | void AppendArgPath(const FilePath& value); |
[email protected] | 0445eb4 | 2010-08-13 22:10:30 | [diff] [blame] | 200 | void AppendArgNative(const StringType& value); |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 201 | |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 202 | // Append the switches and arguments from another command line to this one. |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 203 | // If |include_program| is true, include |other|'s program as well. |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 204 | void AppendArguments(const CommandLine& other, bool include_program); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 205 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 206 | // Insert a command before the current command. |
Mostyn Bramley-Moore | d0ecd6a | 2017-12-06 19:13:21 | [diff] [blame] | 207 | // Common for debuggers, like "gdb --args". |
[email protected] | 13081fc | 2010-08-04 18:24:38 | [diff] [blame] | 208 | void PrependWrapper(const StringType& wrapper); |
[email protected] | 052f1d48 | 2009-02-10 00:52:14 | [diff] [blame] | 209 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 210 | #if defined(OS_WIN) |
| 211 | // Initialize by parsing the given command line string. |
| 212 | // The program name is assumed to be the first item in the string. |
thestig | fd08568 | 2016-07-15 02:50:16 | [diff] [blame] | 213 | void ParseFromString(const string16& command_line); |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 214 | #endif |
[email protected] | 4f08c83f | 2010-07-29 23:02:34 | [diff] [blame] | 215 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 216 | private: |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 217 | // Disallow default constructor; a program name must be explicitly specified. |
Chris Watkins | 091d629 | 2017-12-13 04:25:58 | [diff] [blame] | 218 | CommandLine() = delete; |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 219 | // Allow the copy constructor. A common pattern is to copy of the current |
| 220 | // process's command line and then add some flags to it. For example: |
| 221 | // CommandLine cl(*CommandLine::ForCurrentProcess()); |
| 222 | // cl.AppendSwitch(...); |
[email protected] | d4515eb | 2009-01-30 00:40:43 | [diff] [blame] | 223 | |
mgiuca | c974d510 | 2014-10-01 09:24:51 | [diff] [blame] | 224 | // Internal version of GetCommandLineString. If |quote_placeholders| is true, |
| 225 | // also quotes parts with '%' in them. |
| 226 | StringType GetCommandLineStringInternal(bool quote_placeholders) const; |
| 227 | |
| 228 | // Internal version of GetArgumentsString. If |quote_placeholders| is true, |
| 229 | // also quotes parts with '%' in them. |
| 230 | StringType GetArgumentsStringInternal(bool quote_placeholders) const; |
| 231 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 232 | // The singleton CommandLine representing the current process's command line. |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 233 | static CommandLine* current_process_commandline_; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 234 | |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 235 | // The argv array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* } |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 236 | StringVector argv_; |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 237 | |
[email protected] | 06cc083a | 2011-03-01 02:28:42 | [diff] [blame] | 238 | // Parsed-out switch keys and values. |
[email protected] | f6c3483 | 2010-05-24 10:39:59 | [diff] [blame] | 239 | SwitchMap switches_; |
[email protected] | bb97536 | 2009-01-21 01:00:22 | [diff] [blame] | 240 | |
[email protected] | a40ca430 | 2011-05-14 01:10:24 | [diff] [blame] | 241 | // The index after the program and switches, any arguments start here. |
| 242 | size_t begin_args_; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 243 | }; |
| 244 | |
[email protected] | 2f3b1cc | 2014-03-17 23:07:15 | [diff] [blame] | 245 | } // namespace base |
| 246 | |
[email protected] | 02c8796 | 2008-10-06 10:25:35 | [diff] [blame] | 247 | #endif // BASE_COMMAND_LINE_H_ |