StringParse Class Reference

Utility object for parsing a string into tokens and returning them as a variety of types. More...

#include <StringParse.h>

Inheritance diagram for StringParse:

Collaboration diagram for StringParse:

Public Member Functions
	StringParse (const std::string &input)
	Constructor, taking a string of whitespace-separated tokens. More...
template<typename T >
T	piece (size_t num) const
	Templated function to get the num'th token as any numeric type. More...
template<>
std::string	piece (size_t num) const
	Function to get the num'th token as a string. More...

Public Attributes
T	elements
	STL member. More...

Detailed Description

Utility object for parsing a string into tokens and returning them as a variety of types.

This code is used to parse a string, tokenising space-separated parts into component 'pieces'.

Methods can then be called to

1. Return the nth component as a string (piece method)
2. Return the nth component as an integer (intpiece and longpiece methods) if conversion is possible (returns -1 if it is off the end and 0 if it cannot be converted)
3. Return the nth component as a double (numpiece method) if conversion is possible (returns -1.1 if it is off the end and 0 if it cannot be converted)

Note that the 'num' index used to retrieve the pieces starts at 1, not the C-conventional 0.

Author

Ian Hinchliffe, April 2000

Yun-Ha.Shin, June 2006

Andy Buckley, September 2012

Andrii Verbytskyi, Jul 2023

Andrii Verbytskyi, May 2024

Definition at line 33 of file StringParse.h.

Constructor & Destructor Documentation

StringParse()

StringParse::StringParse ( const std::string &  input )

inline

Constructor, taking a string of whitespace-separated tokens.

Definition at line 37 of file StringParse.h.

                                      {
    std::istringstream instring(input);
    std::string token;
    while (instring >> token) this->push_back(token);
  }

Member Function Documentation

piece() [1/2]

template<typename T >

T StringParse::piece ( size_t  num ) const

inline

Templated function to get the num'th token as any numeric type.

https://en.cppreference.com/w/cpp/utility/from_chars

Definition at line 44 of file StringParse.h.

                                                  {
    if (num > this->size()) return {-1};
    std::string token = this->at(num-1);
    T result{-1};
    auto [ptr, ec] = std::from_chars(token.data(), token.data() + token.size(), result);
    if (ec == std::errc() && ptr == token.data() + token.size()) return result;
    if (ec == std::errc::invalid_argument || ptr != token.data() + token.size() ) return {-1}; //std::cout << "This number cannot be parsed.\n"; 
    if (ec == std::errc::result_out_of_range) return {-1}; //std::cout << "This number is out of range of the return type.\n";
    return {-1};
  }

piece() [2/2]

template<>

std::string StringParse::piece

(

size_t

num

)

const

Function to get the num'th token as a string.

Definition at line 57 of file StringParse.h.

                                                         {
    return num > this->size() ? std::string{} : this->at(num-1);
}

Member Data Documentation

elements

T std::vector< T >::elements

inherited

STL member.

---

The documentation for this class was generated from the following file:

• StringParse.h