xref: /aosp_15_r20/external/google-breakpad/src/processor/tokenize.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2010 Google LLC
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //     * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //     * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //     * Neither the name of Google LLC nor the names of its
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 //
29 // Implements a Tokenize function for splitting up strings.
30 
31 #ifndef GOOGLE_BREAKPAD_PROCESSOR_TOKENIZE_H_
32 #define GOOGLE_BREAKPAD_PROCESSOR_TOKENIZE_H_
33 
34 #include <string>
35 #include <vector>
36 
37 #include "common/using_std_string.h"
38 
39 namespace google_breakpad {
40 
41 // Splits line into at most max_tokens tokens, separated by any of the
42 // characters in separators and placing them in the tokens vector.
43 // line is a 0-terminated string that optionally ends with a newline
44 // character or combination, which will be removed.
45 // If more tokens than max_tokens are present, the final token is placed
46 // into the vector without splitting it up at all.  This modifies line as
47 // a side effect.  Returns true if exactly max_tokens tokens are returned,
48 // and false if fewer are returned.  This is not considered a failure of
49 // Tokenize, but may be treated as a failure if the caller expects an
50 // exact, as opposed to maximum, number of tokens.
51 
52 bool Tokenize(char* line,
53               const char* separators,
54               int max_tokens,
55               std::vector<char*>* tokens);
56 // For convenience, since you need a char* to pass to Tokenize.
57 // You can call StringToVector on a string, and use &vec[0].
58 void StringToVector(const string& str, std::vector<char>& vec);
59 
60 }  // namespace google_breakpad
61 
62 #endif  // GOOGLE_BREAKPAD_PROCESSOR_TOKENIZE_H_
63