summaryrefslogtreecommitdiff
path: root/src/core/parser/stack/ImportIncludeHandler.hpp
blob: 61686397ad976dcfc0e4bec40beb1fae250172fd (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
101
102
103
104
105
106
/*
    Ousía
    Copyright (C) 2014, 2015  Benjamin Paaßen, Andreas Stöckel

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file ImportIncludeHandler.hpp
 *
 * Contains the conceptually similar handlers for the "include" and "import"
 * commands.
 *
 * @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
 */

#ifndef _OUSIA_IMPORT_INCLUDE_HANDLER_HPP_
#define _OUSIA_IMPORT_INCLUDE_HANDLER_HPP_

#include <core/common/Variant.hpp>

#include "Handler.hpp"

namespace ousia {
namespace parser_stack {

/**
 * The ImportHandler is responsible for handling the "import" command. An import
 * creates a reference to a specified file. The specified file is parsed (if
 * this has not already been done) outside of the context of the current file.
 * If the specified resource has already been parsed, a reference to the already
 * parsed file is inserted. Imports are only possible before no other content
 * has been parsed.
 */
class ImportHandler : public StaticFieldHandler {
public:
	using StaticFieldHandler::StaticFieldHandler;

	void doHandle(const Variant &fieldData,
	              Variant::mapType &args) override;

	/**
	 * Creates a new instance of the ImportHandler.
	 *
	 * @param handlerData is the data that is passed to the constructor of the
	 * Handler base class and used there to e.g. access the ParserContext and
	 * the Callbacks instance.
	 */
	static Handler *create(const HandlerData &handlerData)
	{
		return new ImportHandler{handlerData, "src"};
	}
};

/**
 * The IncludeHandler is responsible for handling the "include" command. The
 * included file is parsed in the context of the current file and will change
 * the content that is currently being parsed. Includes are possible at (almost)
 * any position in the source file.
 */
class IncludeHandler : public StaticFieldHandler {
public:
	using StaticFieldHandler::StaticFieldHandler;

	void doHandle(const Variant &fieldData,
	              Variant::mapType &args) override;

	/**
	 * Creates a new instance of the IncludeHandler.
	 *
	 * @param handlerData is the data that is passed to the constructor of the
	 * Handler base class and used there to e.g. access the ParserContext and
	 * the Callbacks instance.
	 */
	static Handler *create(const HandlerData &handlerData)
	{
		return new IncludeHandler{handlerData, "src"};
	}
};

namespace States {
/**
 * State representing the "import" command.
 */
extern const State Import;

/**
 * State representing the "include" command.
 */
extern const State Include;
}

}
}
#endif