LIEF: Library to Instrument Executable Formats Version 0.16.0
Loading...
Searching...
No Matches
ResourceNode.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2024 R. Thomas
2 * Copyright 2017 - 2024 Quarkslab
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#ifndef LIEF_PE_RESOURCE_NODE_H
17#define LIEF_PE_RESOURCE_NODE_H
18#include <string>
19#include <vector>
20#include <memory>
21
22#include "LIEF/Object.hpp"
23#include "LIEF/visibility.h"
24#include "LIEF/iterators.hpp"
25
26namespace LIEF {
27namespace PE {
28
30class ResourceData;
31
32class Parser;
33class Builder;
34class LIEF_API ResourceNode : public Object {
37
38 friend class Parser;
39 friend class Builder;
40
41 public:
42 using childs_t = std::vector<std::unique_ptr<ResourceNode>>;
43 using it_childs = ref_iterator<childs_t&, ResourceNode*>;
44 using it_const_childs = const_ref_iterator<const childs_t&, ResourceNode*>;
45 enum class TYPE {
48 UNKNOWN = 0,
50 DIRECTORY,
51 };
52
53 ResourceNode(const ResourceNode& other);
54 ResourceNode& operator=(const ResourceNode& other);
55
56 ResourceNode(ResourceNode&& other);
57 ResourceNode& operator=(ResourceNode&& other);
58
59 void swap(ResourceNode& other);
60
61 ~ResourceNode() override;
62
63 virtual std::unique_ptr<ResourceNode> clone() const = 0;
64 uint32_t id() const {
68 return id_;
69 }
70 const std::u16string& name() const {
73 return name_;
74 }
75 it_childs childs() {
78 return childs_;
79 }
80 it_const_childs childs() const {
81 return childs_;
82 }
83 bool has_name() const {
86 return static_cast<bool>(id() & 0x80000000);
87 }
88 uint32_t depth() const {
91 return depth_;
92 }
93 bool is_directory() const {
102 return type_ == TYPE::DIRECTORY;
103 }
104 bool is_data() const {
113 return type_ == TYPE::DATA;
114 }
115
116 void id(uint32_t id) {
117 id_ = id;
118 }
119 void name(const std::string& name);
120
121 void name(std::u16string name) {
122 name_ = std::move(name);
123 }
124 ResourceNode& add_child(const ResourceDirectory& child);
127 ResourceNode& add_child(const ResourceData& child);
130 void delete_child(uint32_t id);
133 void delete_child(const ResourceNode& node);
136
137 void accept(Visitor& visitor) const override;
138
139 LIEF_API friend std::ostream& operator<<(std::ostream& os, const ResourceNode& node);
140
141 protected:
142 ResourceNode();
143 ResourceNode(TYPE type);
144 childs_t::iterator insert_child(std::unique_ptr<ResourceNode> child);
145 TYPE type_ = TYPE::UNKNOWN;
146 uint32_t id_ = 0;
147 std::u16string name_;
148 childs_t childs_;
149 uint32_t depth_ = 0;
150};
151}
152}
153#endif /* RESOURCENODE_H */
Object.hpp
LIEF::PE::Builder
Class that is used to rebuild a raw PE binary from a PE::Binary object.
Definition PE/Builder.hpp:45
LIEF::PE::Parser
Main interface to parse PE binaries. In particular the static functions: Parser::parse should be used...
Definition PE/Parser.hpp:47
LIEF::PE::ResourceData
Class which represents a Data Node in the PE resources tree.
Definition ResourceData.hpp:32
LIEF::PE::ResourceDirectory
Definition ResourceDirectory.hpp:33
LIEF::PE::ResourceNode
Class which represents a Node in the resource tree.
Definition ResourceNode.hpp:36
LIEF::PE::ResourceNode::is_directory
bool is_directory() const
True if the current entry is a ResourceDirectory.
Definition ResourceNode.hpp:101
LIEF::PE::ResourceNode::delete_child
void delete_child(uint32_t id)
Delete the node with the given id
LIEF::PE::ResourceNode::add_child
ResourceNode & add_child(const ResourceDirectory &child)
Add a ResourceDirectory to the current node.
LIEF::PE::ResourceNode::childs
it_const_childs childs() const
Definition ResourceNode.hpp:80
LIEF::PE::ResourceNode::operator=
ResourceNode & operator=(const ResourceNode &other)
LIEF::PE::ResourceNode::name
const std::u16string & name() const
Name of the entry.
Definition ResourceNode.hpp:72
LIEF::PE::ResourceNode::is_data
bool is_data() const
True if the current entry is a ResourceData.
Definition ResourceNode.hpp:112
LIEF::PE::ResourceNode::depth
uint32_t depth() const
Current depth of the Node in the resource tree.
Definition ResourceNode.hpp:90
LIEF::PE::ResourceNode::ResourceNode
ResourceNode(ResourceNode &&other)
LIEF::PE::ResourceNode::has_name
bool has_name() const
True if the entry uses a name as ID
Definition ResourceNode.hpp:85
LIEF::PE::ResourceNode::delete_child
void delete_child(const ResourceNode &node)
Delete the given node from the node's children.
LIEF::PE::ResourceNode::ResourceNode
ResourceNode(const ResourceNode &other)
LIEF::PE::ResourceNode::clone
virtual std::unique_ptr< ResourceNode > clone() const =0
LIEF::PE::ResourceNode::id
uint32_t id() const
Integer that identifies the Type, Name, or Language ID of the entry depending on its depth in the tre...
Definition ResourceNode.hpp:67
LIEF::PE::ResourceNode::childs
it_childs childs()
Iterator on node's children.
Definition ResourceNode.hpp:77
LIEF::PE::ResourceNode::swap
void swap(ResourceNode &other)
LIEF::PE::ResourceNode::name
void name(std::u16string name)
Definition ResourceNode.hpp:121
LIEF::PE::ResourceNode::accept
void accept(Visitor &visitor) const override
LIEF::PE::ResourceNode::add_child
ResourceNode & add_child(const ResourceData &child)
Add a ResourceData to the current node.
LIEF::PE::ResourceNode::name
void name(const std::string &name)
LIEF::PE::ResourceNode::id
void id(uint32_t id)
Definition ResourceNode.hpp:116
LIEF::PE::ResourceNode::operator<<
friend std::ostream & operator<<(std::ostream &os, const ResourceNode &node)
LIEF::PE::ResourceNode::operator=
ResourceNode & operator=(ResourceNode &&other)
LIEF::PE::ResourceNode::~ResourceNode
~ResourceNode() override
iterators.hpp
LIEF::PE
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
LIEF::PE::PE_SECTION_TYPES::DATA
@ DATA
Definition PE/enums.hpp:670
LIEF
LIEF namespace.
Definition Abstract/Binary.hpp:36
visibility.h
LIEF_API
#define LIEF_API
Definition visibility.h:41