Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/util/substring.h @ 9621

Last change on this file since 9621 was 9406, checked in by bensch, 18 years ago

orxonox/trunk: merged the proxy back

merged with commandsvn merge -r9346:HEAD https://svn.orxonox.net/orxonox/branches/proxy .

no conflicts

File size: 4.9 KB
RevLine 
[4597]1/*!
[7325]2 * @file substring.h
3 * @brief a small class to get the parts of a string separated by commas
[9406]4 *
5 * This class is also identified as a Tokenizer. It splits up one long
6 * String into multiple small ones by a designated Delimiter.
7 *
8 * Substring is Advanced, and it is possible, to split a string by ','
9 * but also removing leading and trailing spaces around the comma.
10 *
11 * @example
12 * Split the String std::string st = "1345, The new empire   , is , orxonox"
13 * is splitted with:
14 * SubString(st, ',', " \n\t")
15 * into
16 * "1345", "The new empire", "is", "orxonox"
17 * As you can see, the useless spaces around ',' were removed.
[7325]18 */
[3941]19
[9406]20#ifndef __SUBSTRING_H__
21#define __SUBSTRING_H__
[4220]22
[7221]23#include <vector>
24#include <string>
25
26
[4482]27//! A class that can load one string and split it in multipe ones
[7319]28/**
29 * SubString is a very Powerfull way to create a SubSet from a String
30 * It can be used, to Split strings append them and join them again.
31 */
[3941]32class SubString
33{
[7319]34public:
[7474]35  typedef enum {
36    SL_NORMAL,
37    SL_ESCAPE,
38    SL_SAFEMODE,
39    SL_SAFEESCAPE,
40    SL_COMMENT,
41  } SPLIT_LINE_STATE;
42
43
44public:
[7323]45  SubString();
[7474]46  SubString(const std::string& string, char delimiter = ',');
47  SubString(const std::string& string,
48            const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries=false,
49            char escapeChar ='\\', char safemode_char = '"', char comment_char = '\0');
[7319]50  /** @brief create a Substring as a copy of another one. @param subString the SubString to copy. */
[7477]51  SubString(unsigned int argc, const char** argv);
[7319]52  SubString(const SubString& subString) { *this = subString; };
53  SubString(const SubString& subString, unsigned int subSetBegin);
54  SubString(const SubString& subString, unsigned int subSetBegin, unsigned int subSetEnd);
[4220]55  ~SubString();
[4597]56
[7319]57  // operate on the SubString
58  SubString& operator=(const SubString& subString);
[7398]59  bool operator==(const SubString& subString) const;
60  bool compare(const SubString& subString) const;
61  bool compare(const SubString& subString, unsigned int length) const;
[7319]62  SubString operator+(const SubString& subString) const;
63  SubString& operator+=(const SubString& subString);
64  /** @param subString the String to append @returns appended String. @brief added for convenience */
65  SubString& append(const SubString subString) { return (*this += subString); };
66
67  /////////////////////////////////////////
68  // Split and Join the any String. ///////
[7474]69  unsigned int split(const std::string& string = "", char delimiter = ',');
70  unsigned int split(const std::string& string,
71                     const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries = false,
72                     char escapeChar ='\\', char safemode_char = '"', char comment_char = '\0');
[7320]73  std::string join(const std::string& delimiter = " ") const;
[7319]74  ////////////////////////////////////////
[6648]75
[7319]76  // retrieve a SubSet from the String
[9406]77  SubString subSet(unsigned int subSetBegin) const;
78  SubString subSet(unsigned int subSetBegin, unsigned int subSetEnd) const;
[4597]79
[7319]80  // retrieve Information from within
[7340]81  /** @returns true if the SubString is empty */
82  inline bool empty() const { return this->strings.empty(); };
83  /** @returns the count of Strings stored in this substring */
[7319]84  inline unsigned int size() const { return this->strings.size(); };
[7340]85  /** @param i the i'th String @returns the i'th string from the subset of Strings */
[9406]86  inline const std::string& operator[](unsigned int i) const { return this->strings[i]; };
[7340]87  /** @param i the i'th String @returns the i'th string from the subset of Strings */
[8408]88  inline const std::string& getString(unsigned int i) const { return (*this)[i]; };
[9406]89  /** @returns the front of the StringList. */
90  inline const std::string& front() const { return this->strings.front(); };
91  /** @returns the back of the StringList. */
92  inline const std::string& back() const { return this->strings.back(); };
93  /** @brief removes the back of the strings list. */
94  inline void pop_back() { this->strings.pop_back(); };
[7319]95
96  // the almighty algorithm.
[7320]97  static SPLIT_LINE_STATE splitLine(std::vector<std::string>& ret,
98                                    const std::string& line,
[7325]99                                    const std::string& delimiters = SubString::WhiteSpaces,
[7474]100                                    const std::string& delimiterNeighbours = "",
101                                    bool emptyEntries = false,
[7320]102                                    char escape_char = '\\',
103                                    char safemode_char = '"',
104                                    char comment_char = '\0',
[7221]105                                    SPLIT_LINE_STATE start_state = SL_NORMAL);
[7319]106  // debugging.
[4833]107  void debug() const;
108
[7325]109public:
110  static const std::string WhiteSpaces;
111  static const std::string WhiteSpacesWithComma;
112
[7319]113private:
114  std::vector<std::string>  strings;                      //!< strings produced from a single string splitted in multiple strings
[3941]115};
116
[9406]117#endif /* __SUBSTRING_H__ */
Note: See TracBrowser for help on using the repository browser.