Line data    Source code

       1             : // EnergyPlus, Copyright (c) 1996-2024, 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_CsvParser_hh_INCLUDED
      49             : #define InputProcessing_CsvParser_hh_INCLUDED
      50             : 
      51             : #include <string>
      52             : #include <string_view>
      53             : 
      54             : #include <nlohmann/json.hpp>
      55             : #include <unordered_map>
      56             : 
      57             : namespace EnergyPlus {
      58             : class InputProcessorFixture;
      59             : }
      60             : 
      61             : class CsvParser
      62             : {
      63             : public:
      64             :     friend class EnergyPlus::InputProcessorFixture;
      65             :     using json = nlohmann::json;
      66             : 
      67          10 :     CsvParser() = default;
      68             : 
      69             :     // Skipping 1 row is assumed to be the header row and will be recorded as such.
      70             :     // Otherwise, if rows_to_skip == 0 or >1 then there will be no header
      71             :     json decode(std::string_view csv, char t_delimiter = ',', int t_rows_to_skip = 0);
      72             : 
      73             :     std::vector<std::pair<std::string, bool>> const &errors();
      74             : 
      75             :     bool hasErrors();
      76             : 
      77             :     enum class Token : size_t
      78             :     {
      79             :         NONE,
      80             :         FILE_END,
      81             :         DELIMITER,
      82             :         LINE_END,
      83             :         VALUE,
      84             :         Num
      85             :     };
      86             : 
      87             : private:
      88             :     bool success = false;
      89             :     size_t cur_line_num = 1;
      90             :     size_t index_into_cur_line = 0;
      91             :     size_t beginning_of_line_index = 0;
      92             :     size_t csv_size = 0;
      93             :     char delimiter = ',';
      94             :     int rows_to_skip = 0;
      95             :     char s[129] = {};
      96             :     std::vector<std::pair<std::string, bool>> errors_; // the boolean is for continuing lines
      97             : 
      98             :     static void increment_both_index(size_t &index, size_t &line_index);
      99             : 
     100             :     static void decrement_both_index(size_t &index, size_t &line_index);
     101             : 
     102             :     void skip_rows(std::string_view csv, size_t &index);
     103             : 
     104             :     int find_number_columns(std::string_view csv, size_t &index);
     105             : 
     106             :     json parse_csv(std::string_view csv, size_t &index);
     107             : 
     108             :     void parse_header(std::string_view csv, size_t &index, json &header);
     109             : 
     110             :     void parse_line(std::string_view csv, size_t &index, json &columns);
     111             : 
     112             :     json parse_value(std::string_view csv, size_t &index);
     113             : 
     114             :     //            json parse_number(std::string_view csv, size_t &index);
     115             : 
     116             :     //            std::string parse_string(std::string_view csv, size_t &index);
     117             : 
     118             :     Token look_ahead(std::string_view csv, size_t index);
     119             : 
     120             :     Token next_token(std::string_view csv, size_t &index);
     121             : 
     122             :     static std::string_view rtrim(std::string_view str);
     123             : 
     124             :     void eat_whitespace(std::string_view csv, size_t &index);
     125             : 
     126             :     static inline std::string convertToUpper(std::string str)
     127             :     {
     128             :         size_t len = str.size();
     129             :         for (size_t i = 0; i < len; ++i) {
     130             :             char c = str[i];
     131             :             str[i] = ('a' <= c && c <= 'z') ? c ^ 0x20 : c; // ASCII only, which is fine
     132             :         }
     133             :         return str;
     134             :     }
     135             : };
     136             : 
     137             : #endif // InputProcessing_CsvParser_hh_INCLUDED