aboutsummaryrefslogtreecommitdiffstats
path: root/include/rba/RBAJsonParser.hpp
blob: 2f9404a5cddfe925ec8a4cdc204a45d198874e10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/**
 * Copyright (c) 2019 DENSO CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * JSON parser class
 */

#ifndef RBAJSONPARSER_HPP
#define RBAJSONPARSER_HPP

#ifdef _MSC_VER
#ifdef _WINDLL
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif
#else
#define DLL_EXPORT
#endif

#include <memory>
#include "RBAModel.hpp"

namespace rba
{

class RBAModel;
// internal {
class RBAExpression;
class RBAModelFactory;
// }

/**
 * @class RBAJsonParser
 * Provides the facility that loads a model file in JSON format and generate a Model object.
 */
class DLL_EXPORT RBAJsonParser
{
public:
  RBAJsonParser();
  RBAJsonParser(const RBAJsonParser&)=delete;
  RBAJsonParser(const RBAJsonParser&&)=delete;
  RBAJsonParser& operator=(const RBAJsonParser&)=delete;
  RBAJsonParser& operator=(const RBAJsonParser&&)=delete;
  virtual ~RBAJsonParser() noexcept;

public:
  /**
   * @brief Loads a JSON file and generates a model object.
   * @param filename Path of JSON file
   * @return Model
   * If the file is not found, returns nullptr.
   *
   * **Example**
   *
   * ```
   *    rba::RBAJsonParser parser;
   *    rba::RBAModel* model = parser.parse("RBAModel.json");
   *    if(model == nullptr) {
   *        std::cout << "ERRROR: Could not read JSON file" << std::endl;
   *        return 1;
   *    }
   *    rba::RBAArbitrator* arb = new rba::RBAArbitrator(model);
   * ```
   */
  RBAModel* parse(const std::string& filename);

  // internal {
  RBAJsonParser(RBAModelFactory* factory);
  // }

private:
  class Impl;
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4251)
#endif
  std::unique_ptr<Impl> impl_;
#ifdef _MSC_VER
#pragma warning(pop)
#endif

};

}

#endif