Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/Control/FileParser.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     File parser base class declaration
       9                 :            :   \details   File parser base class declaration. File parser base serves as a
      10                 :            :     base class for various file parsers, e.g., input deck parsers. It does
      11                 :            :     generic low-level I/O, e.g., testing whether the file to be parsed exits or
      12                 :            :     not and associated error handling, as well as after-parser diagnostics.
      13                 :            : */
      14                 :            : // *****************************************************************************
      15                 :            : #ifndef FileParser_h
      16                 :            : #define FileParser_h
      17                 :            : 
      18                 :            : #include <vector>
      19                 :            : #include <string>
      20                 :            : 
      21                 :            : namespace tk {
      22                 :            : 
      23                 :            : class Print;
      24                 :            : 
      25                 :            : //! FileParser
      26                 :          0 : class FileParser {
      27                 :            : 
      28                 :            :   protected:
      29                 :            :     //! \brief Constructor
      30                 :            :     explicit FileParser( const std::string& filename );
      31                 :            : 
      32                 :            :     //! \brief Echo errors accumulated during parsing
      33                 :            :     void diagnostics( const tk::Print& print,
      34                 :            :                       const std::vector< std::string >& messages );
      35                 :            : 
      36                 :            :     const std::string m_filename;             //!< Name of file to parse
      37                 :            : };
      38                 :            : 
      39                 :            : } // tk::
      40                 :            : 
      41                 :            : #endif // FileParser_h