license.bot | f003cfe | 2008-08-24 09:55:55 +0900 | [diff] [blame^] | 1 | // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 4 | // |
| 5 | // This file defines utility functions for escaping strings. |
| 6 | |
| 7 | #ifndef BASE_STRING_ESCAPE_H__ |
| 8 | #define BASE_STRING_ESCAPE_H__ |
| 9 | |
| 10 | #include <string> |
| 11 | |
| 12 | namespace string_escape { |
| 13 | |
| 14 | // Escape |str| appropriately for a javascript string litereal, _appending_ the |
| 15 | // result to |dst|. This will create standard escape sequences (\b, \n), |
| 16 | // hex escape sequences (\x00), and unicode escape sequences (\uXXXX). |
| 17 | // If |put_in_quotes| is true, the result will be surrounded in double quotes. |
| 18 | // The outputted literal, when interpreted by the browser, should result in a |
| 19 | // javascript string that is identical and the same length as the input |str|. |
| 20 | void JavascriptDoubleQuote(const std::wstring& str, |
| 21 | bool put_in_quotes, |
| 22 | std::string* dst); |
| 23 | |
| 24 | // Similar to the wide version, but for narrow strings. It will not use |
| 25 | // \uXXXX unicode escape sequences. It will pass non-7bit characters directly |
| 26 | // into the string unencoded, allowing the browser to interpret the encoding. |
| 27 | // The outputted literal, when interpreted by the browser, could result in a |
| 28 | // javascript string of a different length than the input |str|. |
| 29 | void JavascriptDoubleQuote(const std::string& str, |
| 30 | bool put_in_quotes, |
| 31 | std::string* dst); |
| 32 | |
| 33 | } // namespace string_escape |
| 34 | |
| 35 | #endif // BASE_STRING_ESCAPE_H__ |
license.bot | f003cfe | 2008-08-24 09:55:55 +0900 | [diff] [blame^] | 36 | |