blob: 110a4688aa101d8841097cf500c3ca5bd3eceaa9 [file] [log] [blame]
Colin Crossca7648d2010-04-13 19:29:51 -07001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Tom Cherry67dee622017-07-27 12:54:48 -070017#ifndef _INIT_PARSER_H_
18#define _INIT_PARSER_H_
Colin Crossca7648d2010-04-13 19:29:51 -070019
Tom Cherry67dee622017-07-27 12:54:48 -070020#include <map>
21#include <memory>
22#include <string>
23#include <vector>
24
Tom Cherryb592dd82017-08-02 17:01:36 -070025#include "result.h"
26
Tom Cherry67dee622017-07-27 12:54:48 -070027// SectionParser is an interface that can parse a given 'section' in init.
28//
Steven Morelandb480d442017-11-10 12:50:58 -080029// You can implement up to 4 functions below, with ParseSection being mandatory. The first two
30// functions return Result<Success> indicating if they have an error. It will be reported along
31// with the filename and line number of where the error occurred.
Tom Cherry67dee622017-07-27 12:54:48 -070032//
Steven Morelandb480d442017-11-10 12:50:58 -080033// 1) ParseSection
Tom Cherry67dee622017-07-27 12:54:48 -070034// This function is called when a section is first encountered.
35//
Steven Morelandb480d442017-11-10 12:50:58 -080036// 2) ParseLineSection
Tom Cherry67dee622017-07-27 12:54:48 -070037// This function is called on each subsequent line until the next section is encountered.
38//
Steven Morelandb480d442017-11-10 12:50:58 -080039// 3) EndSection
Tom Cherry67dee622017-07-27 12:54:48 -070040// This function is called either when a new section is found or at the end of the file.
41// It indicates that parsing of the current section is complete and any relevant objects should
42// be committed.
43//
Steven Morelandb480d442017-11-10 12:50:58 -080044// 4) EndFile
Tom Cherry67dee622017-07-27 12:54:48 -070045// This function is called at the end of the file.
46// It indicates that the parsing has completed and any relevant objects should be committed.
Colin Crossca7648d2010-04-13 19:29:51 -070047
Tom Cherry81f5d3e2017-06-22 12:53:17 -070048namespace android {
49namespace init {
50
Tom Cherry67dee622017-07-27 12:54:48 -070051class SectionParser {
52 public:
53 virtual ~SectionParser() {}
Tom Cherryb592dd82017-08-02 17:01:36 -070054 virtual Result<Success> ParseSection(std::vector<std::string>&& args,
55 const std::string& filename, int line) = 0;
56 virtual Result<Success> ParseLineSection(std::vector<std::string>&&, int) { return Success(); };
Steven Moreland7d0a5c32017-11-10 14:20:47 -080057 virtual Result<Success> EndSection() { return Success(); };
Tom Cherry67dee622017-07-27 12:54:48 -070058 virtual void EndFile(){};
Colin Cross6310a822010-04-20 14:29:05 -070059};
60
Tom Cherry67dee622017-07-27 12:54:48 -070061class Parser {
62 public:
63 // LineCallback is the type for callbacks that can parse a line starting with a given prefix.
64 //
65 // They take the form of bool Callback(std::vector<std::string>&& args, std::string* err)
66 //
67 // Similar to ParseSection() and ParseLineSection(), this function returns bool with false
68 // indicating a failure and has an std::string* err parameter into which an error string can
69 // be written.
Tom Cherryb592dd82017-08-02 17:01:36 -070070 using LineCallback = std::function<Result<Success>(std::vector<std::string>&&)>;
Tom Cherry67dee622017-07-27 12:54:48 -070071
72 Parser();
73
74 bool ParseConfig(const std::string& path);
75 void AddSectionParser(const std::string& name, std::unique_ptr<SectionParser> parser);
76 void AddSingleLineParser(const std::string& prefix, LineCallback callback);
77
78 private:
79 void ParseData(const std::string& filename, const std::string& data);
80 bool ParseConfigFile(const std::string& path);
81 bool ParseConfigDir(const std::string& path);
82
83 std::map<std::string, std::unique_ptr<SectionParser>> section_parsers_;
84 std::vector<std::pair<std::string, LineCallback>> line_callbacks_;
85};
Colin Crossca7648d2010-04-13 19:29:51 -070086
Tom Cherry81f5d3e2017-06-22 12:53:17 -070087} // namespace init
88} // namespace android
89
Tom Cherry67dee622017-07-27 12:54:48 -070090#endif