Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(240)

Side by Side Diff: tools/gn/escape.h

Issue 311733002: Redo escaping in GN (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: review comments Created 6 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef TOOLS_GN_ESCAPE_H_ 5 #ifndef TOOLS_GN_ESCAPE_H_
6 #define TOOLS_GN_ESCAPE_H_ 6 #define TOOLS_GN_ESCAPE_H_
7 7
8 #include <iosfwd> 8 #include <iosfwd>
9 9
10 #include "base/strings/string_piece.h" 10 #include "base/strings/string_piece.h"
11 11
12 enum EscapingMode { 12 enum EscapingMode {
13 // No escaping. 13 // No escaping.
14 ESCAPE_NONE, 14 ESCAPE_NONE,
15 15
16 // Ninja string escaping. 16 // Ninja string escaping.
17 ESCAPE_NINJA = 1, 17 ESCAPE_NINJA,
18 18
19 // Shell string escaping. 19 // For writing commands to ninja files.
20 ESCAPE_SHELL = 2, 20 ESCAPE_NINJA_COMMAND,
21 };
21 22
22 // For writing shell commands to ninja files. 23 enum EscapingPlatform {
23 ESCAPE_NINJA_SHELL = ESCAPE_NINJA | ESCAPE_SHELL, 24 // Do escaping for the current platform.
25 ESCAPE_PLATFORM_CURRENT,
24 26
25 ESCAPE_JSON = 4, 27 // Force escaping for the given platform.
28 ESCAPE_PLATFORM_POSIX,
29 ESCAPE_PLATFORM_WIN,
26 }; 30 };
27 31
28 struct EscapeOptions { 32 struct EscapeOptions {
29 EscapeOptions() 33 EscapeOptions()
30 : mode(ESCAPE_NONE), 34 : mode(ESCAPE_NONE),
31 convert_slashes(false), 35 platform(ESCAPE_PLATFORM_CURRENT),
32 inhibit_quoting(false) { 36 inhibit_quoting(false) {
33 } 37 }
34 38
35 EscapingMode mode; 39 EscapingMode mode;
36 40
37 // When set, converts forward-slashes to system-specific path separators. 41 // Controls how "fork" escaping is done. You will generally want to keep the
38 bool convert_slashes; 42 // default "current" platform.
43 EscapingPlatform platform;
39 44
40 // When the escaping mode is ESCAPE_SHELL, the escaper will normally put 45 // When the escaping mode is ESCAPE_SHELL, the escaper will normally put
41 // quotes around things with spaces. If this value is set to true, we'll 46 // quotes around things with spaces. If this value is set to true, we'll
42 // disable the quoting feature and just add the spaces. 47 // disable the quoting feature and just add the spaces.
43 // 48 //
44 // This mode is for when quoting is done at some higher-level. Defaults to 49 // This mode is for when quoting is done at some higher-level. Defaults to
45 // false. 50 // false. Note that Windows has strange behavior where the meaning of the
51 // backslashes changes according to if it is followed by a quote. The
52 // escaping rules assume that a double-quote will be appended to the result.
46 bool inhibit_quoting; 53 bool inhibit_quoting;
47 }; 54 };
48 55
49 // Escapes the given input, returnining the result. 56 // Escapes the given input, returnining the result.
50 // 57 //
51 // If needed_quoting is non-null, whether the string was or should have been 58 // If needed_quoting is non-null, whether the string was or should have been
52 // (if inhibit_quoting was set) quoted will be written to it. This value should 59 // (if inhibit_quoting was set) quoted will be written to it. This value should
53 // be initialized to false by the caller and will be written to only if it's 60 // be initialized to false by the caller and will be written to only if it's
54 // true (the common use-case is for chaining calls). 61 // true (the common use-case is for chaining calls).
55 std::string EscapeString(const base::StringPiece& str, 62 std::string EscapeString(const base::StringPiece& str,
56 const EscapeOptions& options, 63 const EscapeOptions& options,
57 bool* needed_quoting); 64 bool* needed_quoting);
58 65
59 // Same as EscapeString but writes the results to the given stream, saving a 66 // Same as EscapeString but writes the results to the given stream, saving a
60 // copy. 67 // copy.
61 void EscapeStringToStream(std::ostream& out, 68 void EscapeStringToStream(std::ostream& out,
62 const base::StringPiece& str, 69 const base::StringPiece& str,
63 const EscapeOptions& options); 70 const EscapeOptions& options);
64 71
65 #endif // TOOLS_GN_ESCAPE_H_ 72 #endif // TOOLS_GN_ESCAPE_H_
OLDNEW
« no previous file with comments | « third_party/mesa/BUILD.gn ('k') | tools/gn/escape.cc » ('j') | tools/gn/escape_unittest.cc » ('J')

Powered by Google App Engine
This is Rietveld 408576698