xml_token.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28
29
30 #pragma once
31
32 #include <vector>
33 #include <utility>
34
35 namespace clan
36 {
39
41 class XMLToken
42 {
45
46 public:
47 XMLToken() : type(NULL_TOKEN), variant(SINGLE)
48 {
49 }
50
54
55 public:
56 enum TokenType
57 {
58 NULL_TOKEN = 0,
59 ELEMENT_TOKEN = 1,
60 TEXT_TOKEN = 3,
61 CDATA_SECTION_TOKEN = 4,
62 ENTITY_REFERENCE_TOKEN = 5,
63 ENTITY_TOKEN = 6,
64 PROCESSING_INSTRUCTION_TOKEN = 7,
65 COMMENT_TOKEN = 8,
66 DOCUMENT_TYPE_TOKEN = 10,
67 NOTATION_TOKEN = 12
68 };
69
70 enum TokenVariant
71 {
72 BEGIN = 1,
73 END = 2,
74 SINGLE = 3
75 };
76
77 // Attribute name/value pair.
78 typedef std::pair<std::string, std::string> Attribute;
79
81 TokenType type;
82
84 TokenVariant variant;
85
87 std::string name;
88
90 std::string value;
91
93 std::vector<Attribute> attributes;
94
98
99 public:
100
104
105 private:
107 };
108
109 }
110
clan::XMLToken::CDATA_SECTION_TOKEN
Definition: xml_token.h:61
clan
Definition: clanapp.h:35
clan::XMLToken::END
Definition: xml_token.h:73
clan::XMLToken
XML token in a XML file.
Definition: xml_token.h:41
clan::XMLToken::TEXT_TOKEN
Definition: xml_token.h:60
clan::XMLToken::variant
TokenVariant variant
The token variant.
Definition: xml_token.h:84
clan::XMLToken::NOTATION_TOKEN
Definition: xml_token.h:67
clan::XMLToken::ELEMENT_TOKEN
Definition: xml_token.h:59
clan::XMLToken::PROCESSING_INSTRUCTION_TOKEN
Definition: xml_token.h:64
clan::XMLToken::NULL_TOKEN
Definition: xml_token.h:58
clan::XMLToken::name
std::string name
The name of the token.
Definition: xml_token.h:87
clan::StyleTokenType::string
@ keyword
clan::XMLToken::attributes
std::vector< Attribute > attributes
All the attributes attached to the token.
Definition: xml_token.h:93
clan::XMLToken::type
TokenType type
The token type.
Definition: xml_token.h:81
clan::XMLToken::TokenVariant
TokenVariant
Definition: xml_token.h:70
clan::XMLToken::TokenType
TokenType
Definition: xml_token.h:56
clan::XMLToken::BEGIN
Definition: xml_token.h:72
clan::XMLToken::DOCUMENT_TYPE_TOKEN
Definition: xml_token.h:66
clan::XMLToken::XMLToken
XMLToken()
Definition: xml_token.h:47
clan::XMLToken::COMMENT_TOKEN
Definition: xml_token.h:65
clan::XMLToken::value
std::string value
Returns the value of the token.
Definition: xml_token.h:90
clan::XMLToken::ENTITY_REFERENCE_TOKEN
Definition: xml_token.h:62
clan::XMLToken::ENTITY_TOKEN
Definition: xml_token.h:63
clan::XMLToken::SINGLE
Definition: xml_token.h:74
clan::XMLToken::Attribute
std::pair< std::string, std::string > Attribute
Definition: xml_token.h:78