LCOV - code coverage report
Current view: top level - EnergyPlus/InputProcessing - IdfParser.hh (source / functions) Coverage Total Hit
Test: lcov.output.filtered Lines: 100.0 % 7 7
Test Date: 2025-05-22 16:09:37 Functions: 100.0 % 2 2

            Line data    Source code
       1              : // EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
       2              : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
       3              : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
       4              : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
       5              : // contributors. All rights reserved.
       6              : //
       7              : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
       8              : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
       9              : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
      10              : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
      11              : // derivative works, and perform publicly and display publicly, and to permit others to do so.
      12              : //
      13              : // Redistribution and use in source and binary forms, with or without modification, are permitted
      14              : // provided that the following conditions are met:
      15              : //
      16              : // (1) Redistributions of source code must retain the above copyright notice, this list of
      17              : //     conditions and the following disclaimer.
      18              : //
      19              : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
      20              : //     conditions and the following disclaimer in the documentation and/or other materials
      21              : //     provided with the distribution.
      22              : //
      23              : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
      24              : //     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
      25              : //     used to endorse or promote products derived from this software without specific prior
      26              : //     written permission.
      27              : //
      28              : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
      29              : //     without changes from the version obtained under this License, or (ii) Licensee makes a
      30              : //     reference solely to the software portion of its product, Licensee must refer to the
      31              : //     software as "EnergyPlus version X" software, where "X" is the version number Licensee
      32              : //     obtained under this License and may not use a different name for the software. Except as
      33              : //     specifically required in this Section (4), Licensee shall not use in a company name, a
      34              : //     product name, in advertising, publicity, or other promotional activities any name, trade
      35              : //     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
      36              : //     similar designation, without the U.S. Department of Energy's prior written consent.
      37              : //
      38              : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
      39              : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
      40              : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
      41              : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
      42              : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
      43              : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      44              : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
      45              : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
      46              : // POSSIBILITY OF SUCH DAMAGE.
      47              : 
      48              : #ifndef InputProcessing_IdfParser_hh_INCLUDED
      49              : #define InputProcessing_IdfParser_hh_INCLUDED
      50              : 
      51              : #include <string>
      52              : 
      53              : #include <nlohmann/json.hpp>
      54              : #include <unordered_map>
      55              : 
      56              : namespace EnergyPlus {
      57              : class InputProcessorFixture;
      58              : }
      59              : 
      60              : class IdfParser
      61              : {
      62              : public:
      63              :     friend class EnergyPlus::InputProcessorFixture;
      64              :     using json = nlohmann::json;
      65              : 
      66         8514 :     IdfParser() = default;
      67              : 
      68              :     json decode(std::string_view idf, json const &schema);
      69              : 
      70              :     json decode(std::string_view idf, json const &schema, bool &success);
      71              : 
      72              :     json decode(std::string_view idf, size_t idf_size, json const &schema);
      73              : 
      74              :     json decode(std::string_view idf, size_t idf_size, json const &schema, bool &success);
      75              : 
      76              :     std::string encode(json const &root, json const &schema);
      77              : 
      78              :     std::string normalizeObjectType(std::string const &objectType);
      79              : 
      80              :     std::vector<std::string> const &errors();
      81              : 
      82              :     std::vector<std::string> const &warnings();
      83              : 
      84              :     bool hasErrors();
      85              : 
      86              :     enum class Token : size_t
      87              :     {
      88              :         NONE = 0,
      89              :         END,
      90              :         EXCLAMATION,
      91              :         COMMA,
      92              :         SEMICOLON,
      93              :         STRING,
      94              :         NUMBER,
      95              :         INTEGER
      96              :     };
      97              : 
      98              : private:
      99              :     size_t cur_line_num = 1;
     100              :     size_t index_into_cur_line = 0;
     101              :     size_t beginning_of_line_index = 0;
     102              :     size_t idf_size = 0;
     103              :     char s[129] = {};
     104              :     std::unordered_map<std::string, std::string> objectTypeMap;
     105              :     std::vector<std::string> errors_;
     106              :     std::vector<std::string> warnings_;
     107              : 
     108              :     static void increment_both_index(size_t &index, size_t &line_index);
     109              : 
     110              :     static void decrement_both_index(size_t &index, size_t &line_index);
     111              : 
     112              :     json parse_idf(std::string_view idf, size_t &index, bool &success, json const &schema);
     113              : 
     114              :     json parse_object(std::string_view idf, size_t &index, bool &success, json const &schema_loc, json const &obj_loc, int idfObjectCount);
     115              : 
     116              :     json parse_value(std::string_view idf, size_t &index, bool &success, json const &field_loc);
     117              : 
     118              :     // parse_number will return integer, double, or string depending on success of parsing
     119              :     // success will be false, if number cannot be converted to integer or double and string will be returned.
     120              :     json parse_number(std::string_view idf, size_t &index);
     121              : 
     122              :     // parse_integer will return integer or string depending on success of parsing
     123              :     // success will be false, if number cannot be converted to an integer then a string will be returned.
     124              :     json parse_integer(std::string_view idf, size_t &index);
     125              : 
     126              :     std::string parse_string(std::string_view idf, size_t &index);
     127              : 
     128              :     void eat_whitespace(std::string_view idf, size_t &index);
     129              : 
     130              :     void eat_comment(std::string_view idf, size_t &index);
     131              : 
     132              :     Token look_ahead(std::string_view idf, size_t index);
     133              : 
     134              :     Token next_token(std::string_view idf, size_t &index);
     135              : 
     136              :     Token next_limited_token(std::string_view idf, size_t &index);
     137              : 
     138              :     static std::string rtrim(std::string_view s);
     139              : 
     140      1188884 :     static inline std::string convertToUpper(std::string str)
     141              :     {
     142      1188884 :         size_t len = str.size();
     143     37247826 :         for (size_t i = 0; i < len; ++i) {
     144     36058942 :             char c = str[i];
     145     36058942 :             str[i] = ('a' <= c && c <= 'z') ? c ^ 0x20 : c; // ASCII only, which is fine
     146              :         }
     147      1188884 :         return str;
     148              :     }
     149              : };
     150              : 
     151              : #endif // InputProcessing_IdfParser_hh_INCLUDED
        

Generated by: LCOV version 2.0-1