xml_resource_node.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "../api_core.h"
33 #include "../Resources/xml_resource_document.h"
34 #include "../IOData/file_system.h"
35 #include <memory>
36 
37 namespace clan
38 {
41 
42 class DomElement;
43 class XMLResourceDocument;
44 class XMLResourceNode_Impl;
45 
47 class CL_API_CORE XMLResourceNode
48 {
51 
52 public:
54 
55  ~XMLResourceNode();
56 
60 
61 public:
62  bool is_null() const;
63 
65  std::string get_type() const;
66 
68  std::string get_name() const;
69 
71  DomElement &get_element();
72 
74  XMLResourceDocument get_document();
75 
77  FileSystem get_file_system() const;
78 
80  std::string get_base_path() const;
81 
85 
86 public:
88 
93  IODevice open_file(const std::string &filename,
95  unsigned int access = File::access_read,
96  unsigned int share = File::share_all,
97  unsigned int flags = 0) const;
98 
100  bool operator ==(const XMLResourceNode &other) const;
101 
105 
106 private:
107 
112  XMLResourceNode(DomElement element, XMLResourceDocument &resource_document);
113 
114  std::shared_ptr<XMLResourceNode_Impl> impl;
115 
116  friend class XMLResourceDocument;
118 };
119 
120 }
121 
I/O Device interface.
Definition: iodevice.h:51
DOM Element class.
Definition: dom_element.h:60
Virtual File System (VFS).
Definition: file_system.h:48
Generic read access.
Definition: file.h:68
Open existing file. Fails if it does not exist.
Definition: file.h:100
All other sharing flags combined.
Definition: file.h:90
OpenMode
File opening modes.
Definition: file.h:94
XML Resource Document.
Definition: xml_resource_document.h:49
Resource node for a XMLResourceDocument.
Definition: xml_resource_node.h:47