src/libshared/src/Pig.h

   1 ////////////////////////////////////////////////////////////////////////////////
   2 //
   3 // Copyright 2015 - 2017, Paul Beckingham, Federico Hernandez.
   4 //
   5 // Permission is hereby granted, free of charge, to any person obtaining a copy
   6 // of this software and associated documentation files (the "Software"), to deal
   7 // in the Software without restriction, including without limitation the rights
   8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 // copies of the Software, and to permit persons to whom the Software is
  10 // furnished to do so, subject to the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be included
  13 // in all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21 // SOFTWARE.
  22 //
  23 // http://www.opensource.org/licenses/mit-license.php
  24 //
  25 ////////////////////////////////////////////////////////////////////////////////
  26
  27 #ifndef INCLUDED_PIG
  28 #define INCLUDED_PIG
  29
  30 #include <string>
  31 #include <vector>
  32 #include <memory>
  33
  34 class Pig
  35 {
  36 public:
  37   explicit Pig (const std::string&);
  38
  39   bool skip (int);
  40   bool skipN (const int quantity = 1);
  41   bool skipWS ();
  42   bool skipLiteral (const std::string&);
  43   bool skipPartial (const std::string&, std::string&);
  44
  45   bool getUntil (int, std::string&);
  46   bool getUntilWS (std::string&);
  47   bool getCharacter (int&);
  48   bool getDigit (int&);
  49   bool getDigit2 (int&);
  50   bool getDigit3 (int&);
  51   bool getDigit4 (int&);
  52   bool getDigits (int&);
  53   bool getHexDigit (int&);
  54   bool getNumber (std::string&);
  55   bool getNumber (double&);
  56   bool getDecimal (std::string&);
  57   bool getDecimal (double&);
  58   bool getQuoted (int, std::string&);
  59   bool getOneOf (const std::vector <std::string>&, std::string&);
  60   bool getHMS (int&, int&, int&);
  61   bool getRemainder (std::string&);
  62
  63   bool eos () const;
  64   int peek () const;
  65   std::string peek (const int) const;
  66   std::string::size_type cursor () const;
  67   std::string::size_type save ();
  68   std::string::size_type restore ();
  69   std::string::size_type restoreTo (std::string::size_type);
  70
  71   std::string substr (std::string::size_type, std::string::size_type) const;
  72   std::string str () const;
  73   std::string dump () const;
  74
  75 private:
  76   std::shared_ptr<std::string> _text;
  77   std::string::size_type       _cursor {0};
  78   std::string::size_type       _saved  {0};
  79 };
  80
  81 #endif