LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
ResourcesManager.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2025 R. Thomas
2 * Copyright 2017 - 2025 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_RESOURCES_MANAGER_H
17#define LIEF_PE_RESOURCES_MANAGER_H
18#include <ostream>
19
20#include "LIEF/errors.hpp"
21#include "LIEF/visibility.h"
22#include "LIEF/Object.hpp"
23#include "LIEF/iterators.hpp"
24
30
31namespace LIEF {
32class VectorStream;
33
34namespace PE {
35class ResourceNode;
36
39 public:
40
43 enum class TYPE {
44 CURSOR = 1,
45 BITMAP = 2,
46 ICON = 3,
47 MENU = 4,
48 DIALOG = 5,
49 STRING = 6,
51 FONT = 8,
53 RCDATA = 10,
57 VERSION = 16,
60 VXD = 20,
62 ANIICON = 22,
63 HTML = 23,
65 };
66
67 public:
70
71 using icons_t = std::vector<ResourceIcon>;
73
74 using accelerators_t = std::vector<ResourceAccelerator>;
76
79 std::u16string string;
80 uint32_t id = 0;
81
82 std::string string_u8() const;
83
84 bool is_defined() const {
85 return !string.empty();
86 }
87
88 operator bool() const {
89 return is_defined();
90 }
91
92 friend LIEF_API
93 std::ostream& operator<<(std::ostream& os, const string_entry_t& str)
94 {
95 os << std::to_string(str.id) << ", " << str.string_u8();
96 return os;
97 }
98 };
99
100 using strings_table_t = std::vector<string_entry_t>;
101
104 resources_{&rsrc}
105 {}
106
108 Object(other),
109 resources_(other.resources_)
110 // Skip (on purpose) the `dialogs_` cache
111 {}
112
114 if (&other != this) {
115 Object::operator=(other);
116 resources_ = other.resources_;
117 // Skip (on purpose) the `dialogs_` cache
118 }
119 return *this;
120 }
121
124
125 ~ResourcesManager() override = default;
126
130 return const_cast<ResourceNode*>(
131 static_cast<const ResourcesManager*>(this)->get_node_type(type));
132 }
133 const ResourceNode* get_node_type(TYPE type) const;
134
136 std::vector<TYPE> get_types() const;
137
139 bool has_type(TYPE type) const {
140 return get_node_type(type) != nullptr;
141 }
142
144 bool has_manifest() const {
145 return get_node_type(TYPE::MANIFEST) != nullptr;
146 }
147
150 std::string manifest() const;
151
154 void manifest(const std::string& manifest);
155
157 bool has_version() const {
158 return get_node_type(TYPE::VERSION) != nullptr;
159 }
160
162 std::vector<ResourceVersion> version() const;
163
165 bool has_icons() const {
166 return get_node_type(TYPE::ICON) != nullptr &&
168 }
169
172
174 void add_icon(const ResourceIcon& icon);
175
176 void change_icon(const ResourceIcon& original, const ResourceIcon& newone);
177
179 bool has_dialogs() const {
180 return get_node_type(TYPE::DIALOG) != nullptr;
181 }
182
185
187 bool has_string_table() const {
188 return get_node_type(TYPE::STRING) != nullptr;
189 }
190
193
195 bool has_html() const {
196 return get_node_type(TYPE::HTML) != nullptr;
197 }
198
200 std::vector<std::string> html() const;
201
203 bool has_accelerator() const {
204 return get_node_type(TYPE::ACCELERATOR) != nullptr;
205 }
206
209
211 std::string print(uint32_t depth = 0) const;
212
213 void accept(Visitor& visitor) const override;
214
215 LIEF_API friend std::ostream& operator<<(std::ostream& os, const ResourcesManager& m);
216
217 private:
218 void print_tree(const ResourceNode& node, std::ostringstream& stream,
219 uint32_t current_depth, uint32_t max_depth,
220 const ResourceNode* parent = nullptr,
221 std::string header = "", bool is_last = false) const;
222 ResourceNode* resources_ = nullptr;
223 mutable dialogs_t dialogs_;
224};
225
227
228} // namespace PE
229} // namespace LIEF
230
231#endif
Object & operator=(const Object &other)
std::vector< std::unique_ptr< ResourceDialog > > dialogs_t
Definition ResourceDialog.hpp:43
Definition ResourceIcon.hpp:37
Class which represents a Node in the resource tree.
Definition ResourceNode.hpp:46
std::vector< ResourceIcon > icons_t
Definition ResourcesManager.hpp:71
void add_icon(const ResourceIcon &icon)
Add an icon to the resources.
bool has_version() const
true if resources a LIEF::PE::ResourceVersion
Definition ResourcesManager.hpp:157
bool has_html() const
true if the resources contain html
Definition ResourcesManager.hpp:195
std::vector< ResourceVersion > version() const
Return a list of verison info (VS_VERSIONINFO).
it_const_accelerators accelerator() const
Return the list of the accelerator in the resource.
it_const_dialogs dialogs() const
Return the list of the dialogs present in the resource.
ResourceNode * get_node_type(TYPE type)
Return the ResourceNode associated with the given TYPE or a nullptr if not found;.
Definition ResourcesManager.hpp:129
bool has_type(TYPE type) const
true if the resource has the given TYPE node
Definition ResourcesManager.hpp:139
~ResourcesManager() override=default
bool has_icons() const
true if resources contain a LIEF::PE::ResourceIcon
Definition ResourcesManager.hpp:165
bool has_manifest() const
true if resources contain the Manifest element
Definition ResourcesManager.hpp:144
std::vector< string_entry_t > strings_table_t
Definition ResourcesManager.hpp:100
std::vector< ResourceAccelerator > accelerators_t
Definition ResourcesManager.hpp:74
std::string print(uint32_t depth=0) const
Print the resource tree to the given depth.
void change_icon(const ResourceIcon &original, const ResourceIcon &newone)
ResourcesManager(ResourceNode &rsrc)
Definition ResourcesManager.hpp:103
std::vector< TYPE > get_types() const
List of TYPE present in the resources.
const_ref_iterator< const dialogs_t &, const ResourceDialog * > it_const_dialogs
Definition ResourcesManager.hpp:69
const_ref_iterator< accelerators_t > it_const_accelerators
Definition ResourcesManager.hpp:75
it_const_icons icons() const
Return the list of the icons present in the resources.
TYPE
The different types of resources From https://learn.microsoft.com/en-us/windows/win32/menurc/resource...
Definition ResourcesManager.hpp:43
@ VERSION
Definition ResourcesManager.hpp:57
@ MANIFEST
Definition ResourcesManager.hpp:64
@ FONTDIR
Definition ResourcesManager.hpp:50
@ GROUP_ICON
Definition ResourcesManager.hpp:56
@ MENU
Definition ResourcesManager.hpp:47
@ FONT
Definition ResourcesManager.hpp:51
@ HTML
Definition ResourcesManager.hpp:63
@ DIALOG
Definition ResourcesManager.hpp:48
@ ANIICON
Definition ResourcesManager.hpp:62
@ GROUP_CURSOR
Definition ResourcesManager.hpp:55
@ STRING
Definition ResourcesManager.hpp:49
@ BITMAP
Definition ResourcesManager.hpp:45
@ RCDATA
Definition ResourcesManager.hpp:53
@ ANICURSOR
Definition ResourcesManager.hpp:61
@ MESSAGETABLE
Definition ResourcesManager.hpp:54
@ CURSOR
Definition ResourcesManager.hpp:44
@ ACCELERATOR
Definition ResourcesManager.hpp:52
@ DLGINCLUDE
Definition ResourcesManager.hpp:58
@ ICON
Definition ResourcesManager.hpp:46
@ PLUGPLAY
Definition ResourcesManager.hpp:59
@ VXD
Definition ResourcesManager.hpp:60
bool has_string_table() const
true if the resources contain a string table
Definition ResourcesManager.hpp:187
const_ref_iterator< icons_t > it_const_icons
Definition ResourcesManager.hpp:72
std::string manifest() const
Return the manifest as a std::string or an empty string if not found or corrupted.
ResourcesManager(const ResourcesManager &other)
Definition ResourcesManager.hpp:107
bool has_accelerator() const
true if the resources contain accelerator info
Definition ResourcesManager.hpp:203
friend std::ostream & operator<<(std::ostream &os, const ResourcesManager &m)
ResourceDialog::dialogs_t dialogs_t
Definition ResourcesManager.hpp:68
ResourcesManager & operator=(ResourcesManager &&)=default
bool has_dialogs() const
true if resources contain dialogs
Definition ResourcesManager.hpp:179
strings_table_t string_table() const
Return the list of the strings embedded in the string table (RT_STRING).
const ResourceNode * get_node_type(TYPE type) const
void accept(Visitor &visitor) const override
ResourcesManager & operator=(const ResourcesManager &other)
Definition ResourcesManager.hpp:113
std::vector< std::string > html() const
Return the list of the html resources.
ResourcesManager(ResourcesManager &&)=default
void manifest(const std::string &manifest)
Change or set the manifest. If the manifest node path does not exist, all required nodes are created.
Definition VectorStream.hpp:29
Definition Visitor.hpp:210
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
const char * to_string(CODE_PAGES e)
LIEF namespace.
Definition Abstract/Binary.hpp:40
ref_iterator< CT, U, typename decay_t< CT >::const_iterator > const_ref_iterator
Iterator which return const ref on container's values.
Definition iterators.hpp:257
This structure represent an entry in the string table (RT_STRING).
Definition ResourcesManager.hpp:78
std::string string_u8() const
friend std::ostream & operator<<(std::ostream &os, const string_entry_t &str)
Definition ResourcesManager.hpp:93
std::u16string string
Definition ResourcesManager.hpp:79
bool is_defined() const
Definition ResourcesManager.hpp:84
uint32_t id
Definition ResourcesManager.hpp:80
#define LIEF_API
Definition visibility.h:41