A tokenizer for strings. More...
#include <Bpp/Text/StringTokenizer.h>
Inheritance diagram for bpp::StringTokenizer:
Collaboration diagram for bpp::StringTokenizer:
Public Member Functions | |
| StringTokenizer (const std::string &s, const std::string &delimiters=" \\", bool solid=false, bool allowEmptyTokens=false) | |
| Build a new StringTokenizer from a string. More... | |
| virtual | ~StringTokenizer () |
| StringTokenizer () | |
| const std::string & | nextToken () |
| Get the next available token. If no token is availbale, throw an Exception. More... | |
| bool | hasMoreToken () const |
| Tell if some tokens are still available. More... | |
| size_t | numberOfRemainingTokens () const |
| Tell how many tokens are available. More... | |
| const std::string & | getToken (size_t pos) const |
| Get a particular token. More... | |
| const std::deque< std::string > & | getTokens () const |
| Retrieve all tokens. More... | |
| void | removeEmptyTokens () |
| remove all empty token from the current position. More... | |
| std::string | unparseRemainingTokens () const |
Protected Attributes | |
| std::deque< std::string > | tokens_ |
| Where the tokens are stored. More... | |
| std::deque< std::string > | splits_ |
| size_t | currentPosition_ |
| the current position in the token list. More... | |
Detailed Description
A tokenizer for strings.
Splits a string according to a given (set of) delimiter(s).
Definition at line 21 of file StringTokenizer.h.
Constructor & Destructor Documentation
◆ StringTokenizer() [1/2]
| StringTokenizer::StringTokenizer | ( | const std::string & | s, |
| const std::string & | delimiters = " \t\n\f\r", |
||
| bool | solid = false, |
||
| bool | allowEmptyTokens = false |
||
| ) |
Build a new StringTokenizer from a string.
- Parameters
-
s The string to parse. delimiters Chars that must be considered as delimiters. solid If true, delimiters is considered as a single bloc delimiter. allowEmptyTokens Tell if empty tokens are allowed or should be ignored.
Definition at line 10 of file StringTokenizer.cpp.
◆ ~StringTokenizer()
|
inlinevirtual |
Definition at line 42 of file StringTokenizer.h.
◆ StringTokenizer() [2/2]
|
inline |
Definition at line 45 of file StringTokenizer.h.
Member Function Documentation
◆ getToken()
|
inline |
Get a particular token.
Do not move the iterator.
- Parameters
-
pos The index of the token.
- Returns
- the token at position 'pos'.
Definition at line 84 of file StringTokenizer.h.
Referenced by bpp::NumCalcApplicationTools::seqFromString().
◆ getTokens()
|
inline |
Retrieve all tokens.
- Returns
- A reference toward the vector of tokens.
Definition at line 91 of file StringTokenizer.h.
References removeEmptyTokens(), tokens_, and unparseRemainingTokens().
Referenced by bpp::Table< T >::addColumn(), bpp::Table< T >::addRow(), bpp::DataTable::read(), and bpp::Table< T >::read().
◆ hasMoreToken()
|
inline |
Tell if some tokens are still available.
- Returns
- True if some tokens are still available.
Definition at line 64 of file StringTokenizer.h.
Referenced by bpp::KeyvalTools::changeKeyvals(), bpp::ParameterList::getMatchingParameterNames(), bpp::ApplicationTools::getMatrixParameter(), bpp::NumCalcApplicationTools::getVector(), bpp::ApplicationTools::matchingParameters(), bpp::KeyvalTools::multipleKeyvals(), bpp::NestedStringTokenizer::nextToken(), nextToken(), bpp::AttributesTools::parseOptions(), bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), and bpp::NumCalcApplicationTools::seqFromString().
◆ nextToken()
|
inline |
Get the next available token. If no token is availbale, throw an Exception.
- Returns
- The next token if there is one.
Definition at line 54 of file StringTokenizer.h.
References hasMoreToken().
Referenced by bpp::KeyvalTools::changeKeyvals(), bpp::ParameterList::getMatchingParameterNames(), bpp::ApplicationTools::getMatrixParameter(), bpp::NumCalcApplicationTools::getVector(), bpp::ApplicationTools::getVectorParameter(), bpp::ApplicationTools::matchingParameters(), bpp::KeyvalTools::multipleKeyvals(), bpp::AttributesTools::parseOptions(), bpp::BppODiscreteDistributionFormat::readDiscreteDistribution(), and bpp::NumCalcApplicationTools::seqFromString().
◆ numberOfRemainingTokens()
|
inline |
Tell how many tokens are available.
- Returns
- the number of tokens available.
Definition at line 74 of file StringTokenizer.h.
References currentPosition_.
Referenced by bpp::ApplicationTools::getMatrixParameter(), bpp::ApplicationTools::getVectorOfVectorsParameter(), bpp::ApplicationTools::getVectorParameter(), bpp::NumCalcApplicationTools::seqFromString(), and unparseRemainingTokens().
◆ removeEmptyTokens()
| void StringTokenizer::removeEmptyTokens | ( | ) |
remove all empty token from the current position.
Definition at line 65 of file StringTokenizer.cpp.
References currentPosition_, and tokens_.
Referenced by getTokens().
◆ unparseRemainingTokens()
| std::string StringTokenizer::unparseRemainingTokens | ( | ) | const |
- Returns
- The remaining tokens as if the original corresponding string was not parsed.
Definition at line 74 of file StringTokenizer.cpp.
References currentPosition_, numberOfRemainingTokens(), splits_, and tokens_.
Referenced by getTokens().
Member Data Documentation
◆ currentPosition_
|
protected |
the current position in the token list.
Definition at line 29 of file StringTokenizer.h.
Referenced by bpp::NestedStringTokenizer::nextToken(), numberOfRemainingTokens(), removeEmptyTokens(), and unparseRemainingTokens().
◆ splits_
|
protected |
Definition at line 26 of file StringTokenizer.h.
Referenced by StringTokenizer(), and unparseRemainingTokens().
◆ tokens_
|
protected |
Where the tokens are stored.
Definition at line 25 of file StringTokenizer.h.
Referenced by getTokens(), bpp::NestedStringTokenizer::NestedStringTokenizer(), bpp::NestedStringTokenizer::nextToken(), removeEmptyTokens(), StringTokenizer(), and unparseRemainingTokens().
The documentation for this class was generated from the following files:
- Bpp/Text/StringTokenizer.h
- Bpp/Text/StringTokenizer.cpp
