Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/StringParser.hpp
       4                 :            :   \copyright 2012-2015 J. Bakosi,
       5                 :            :              2016-2018 Los Alamos National Security, LLC.,
       6                 :            :              2019-2021 Triad National Security, LLC.
       7                 :            :              All rights reserved. See the LICENSE file for details.
       8                 :            :   \brief     String parser base class declaration
       9                 :            :   \details   String parser base class declaration. String parser base serves as
      10                 :            :     a base class for various string parsers, e.g., command-line parsers. It does
      11                 :            :     generic after-parser diagnostics.
      12                 :            : */
      13                 :            : // *****************************************************************************
      14                 :            : #ifndef StringParser_h
      15                 :            : #define StringParser_h
      16                 :            : 
      17                 :            : #include <iosfwd>
      18                 :            : #include <vector>
      19                 :            : 
      20                 :            : #include "Print.hpp"
      21                 :            : 
      22                 :            : namespace tk {
      23                 :            : 
      24                 :            : //! StringParser
      25                 :            : class StringParser {
      26                 :            : 
      27                 :            :   protected:
      28                 :            :     //! Constructor from C++-style std::string
      29                 :            :     //! \param[in] string String to be parsed
      30                 :          1 :     explicit StringParser( const std::string& string ) : m_string( string ) {}
      31                 :            : 
      32                 :            :     //! Constructor from C-style command-line argument string
      33                 :            :     explicit StringParser( int argc, char** argv );
      34                 :            : 
      35                 :            :     //! \brief Echo errors and warnings accumulated during parsing
      36                 :            :     void diagnostics( const Print& print,
      37                 :            :                       const std::vector< std::string >& messages );
      38                 :            : 
      39                 :            :     std::string m_string;                     //!< String to parse
      40                 :            : };
      41                 :            : 
      42                 :            : } // tk::
      43                 :            : 
      44                 :            : #endif // StringParser_h