1 /******************************************************************
\r
3 * Copyright 2015 Samsung Electronics All Rights Reserved.
\r
7 * Licensed under the Apache License, Version 2.0 (the "License");
\r
8 * you may not use this file except in compliance with the License.
\r
9 * You may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * Unless required by applicable law or agreed to in writing, software
\r
14 * distributed under the License is distributed on an "AS IS" BASIS,
\r
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * See the License for the specific language governing permissions and
\r
17 * limitations under the License.
\r
19 ******************************************************************/
\r
22 * @file IncludeResolver.h
\r
24 * @brief This file provides APIs for resolving included files.
\r
27 #ifndef INCLUDE_RESOLVER_H
\r
28 #define INCLUDE_RESOLVER_H
\r
30 #include "yaml-cpp/yaml.h"
\r
34 #include "yaml-cpp/exceptions.h"
\r
35 #include "RamlExceptions.h"
\r
40 * @class IncludeResolver
\r
41 * @brief This class provides a set of APIs for resolving included files.
\r
43 class IncludeResolver
\r
46 /** FileType - enumeration for Included File types*/
\r
49 NODE, JSON, FILE, NOTAG , ERROR
\r
54 * This method is for reading a file specified in YamlNode and parse it to
\r
55 * getting the created RootNode from RAML file.
\r
57 * @param yamlFile - Reference to YamlNode specifying the FileName.
\r
59 * @return pointer to root node from the Parsed file.
\r
61 YAML::Node readToYamlNode(const YAML::Node &yamlFile );
\r
64 * This method is for reading a file specified in YamlNode and parse the specified Json file.
\r
66 * @param jsonFile - Reference to YamlNode specifying the FileName.
\r
68 * @return cJSON pointer to CJson object.
\r
70 cJSON *readToJson(const YAML::Node &jsonFile );
\r
73 * This method is for reading a file specified in YamlNode and parse the content of file.
\r
75 * @param file - Reference to YamlNode specifying the FileName.
\r
77 * @return contents of the file.
\r
79 std::string readFromFile(const YAML::Node &file );
\r
82 * This method is checking the file type specified in YamlNode.
\r
84 * @param yamlNode - Reference to YamlNode specifying the FileName.
\r
86 * @return FileType type of file.
\r
88 FileType getFileType(const YAML::Node &yamlNode );
\r
91 * This method is for reading a file specified and parse the content of file.
\r
93 * @param jsonFileName - FileName of Json file to be read.
\r
95 * @return pointer to CJson object.
\r
97 cJSON *readToJson(const std::string &jsonFileName);
\r
100 * Constructor of IncludeResolver.
\r
102 IncludeResolver() {}
\r
105 * Constructor of IncludeResolver.
\r
107 * @param path - configuration file path.
\r
110 IncludeResolver(const std::string &path) : m_path(path) {}
\r
113 std::string m_path;
\r
116 /** IncludeResolverPtr - shared Ptr to IncludeResolver.*/
\r
117 typedef std::shared_ptr<IncludeResolver> IncludeResolverPtr;
\r