LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
DWARF/editor/CompilationUnit.hpp
Go to the documentation of this file.
1/* Copyright 2022 - 2025 R. Thomas
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15#ifndef LIEF_DWARF_EDITOR_COMPILATION_UNIT_H
16#define LIEF_DWARF_EDITOR_COMPILATION_UNIT_H
17#include <memory>
18#include <string>
19
20#include "LIEF/visibility.h"
25
26namespace LIEF {
27namespace dwarf {
28namespace editor {
29class Function;
30class Variable;
31class Type;
32class EnumType;
33class TypeDef;
34class ArrayType;
35
36namespace details {
37class CompilationUnit;
38}
42 public:
43 CompilationUnit() = delete;
44 CompilationUnit(std::unique_ptr<details::CompilationUnit> impl);
45 CompilationUnit& set_producer(const std::string& producer);
51 std::unique_ptr<Function> create_function(const std::string& name);
54 std::unique_ptr<Variable> create_variable(const std::string& name);
57 std::unique_ptr<Type> create_generic_type(const std::string& name);
60 std::unique_ptr<EnumType> create_enum(const std::string& name);
63 std::unique_ptr<TypeDef> create_typedef(const std::string& name, const Type& type);
67 std::unique_ptr<StructType> create_structure(
70 const std::string& name, StructType::TYPE kind = StructType::TYPE::STRUCT);
71 std::unique_ptr<BaseType> create_base_type(const std::string& name, size_t size,
74 BaseType::ENCODING encoding = BaseType::ENCODING::NONE);
75 std::unique_ptr<FunctionType> create_function_type(const std::string& name);
78 std::unique_ptr<PointerType> create_pointer_type(const Type& ty) {
81 return ty.pointer_to();
82 }
83 std::unique_ptr<Type> create_void_type();
86 std::unique_ptr<ArrayType>
89 create_array(const std::string& name, const Type& type, size_t count);
90
92
93 private:
94 std::unique_ptr<details::CompilationUnit> impl_;
95};
96
97}
98}
99}
100#endif
This class represents an array type (DW_TAG_array_type).
Definition ArrayType.hpp:26
This class represents an editable DWARF compilation unit.
Definition DWARF/editor/CompilationUnit.hpp:41
~CompilationUnit()
std::unique_ptr< Function > create_function(const std::string &name)
Create a new function owned by this compilation unit.
std::unique_ptr< TypeDef > create_typedef(const std::string &name, const Type &type)
Create a typdef with the name provided in the first parameter which aliases the type provided in the ...
CompilationUnit()=delete
CompilationUnit(std::unique_ptr< details::CompilationUnit > impl)
std::unique_ptr< PointerType > create_pointer_type(const Type &ty)
Create a pointer on the provided type.
Definition DWARF/editor/CompilationUnit.hpp:80
std::unique_ptr< Type > create_generic_type(const std::string &name)
Create a DW_TAG_unspecified_type type with the given name.
std::unique_ptr< FunctionType > create_function_type(const std::string &name)
Create a function type with the given name.
std::unique_ptr< Variable > create_variable(const std::string &name)
Create a new global variable owned by this compilation unit.
std::unique_ptr< StructType > create_structure(const std::string &name, StructType::TYPE kind=StructType::TYPE::STRUCT)
Create a struct-like type (struct, class, union) with the given name.
CompilationUnit & set_producer(const std::string &producer)
Set the DW_AT_producer producer attribute.
std::unique_ptr< Type > create_void_type()
Create a void type.
std::unique_ptr< BaseType > create_base_type(const std::string &name, size_t size, BaseType::ENCODING encoding=BaseType::ENCODING::NONE)
Create a primitive type with the given name and size.
std::unique_ptr< EnumType > create_enum(const std::string &name)
Create an enum type (DW_TAG_enumeration_type)
std::unique_ptr< ArrayType > create_array(const std::string &name, const Type &type, size_t count)
Create an array type with the given name, type and size.
This class represents an editable enum type (DW_TAG_enumeration_type)
Definition EnumType.hpp:32
This class represents an editable DWARF function (DW_TAG_subprogram)
Definition DWARF/editor/Function.hpp:38
This class represents a typedef (DW_TAG_typedef).
Definition TypeDef.hpp:26
This class is the base class for any types created when editing DWARF debug info.
Definition DWARF/editor/Type.hpp:36
std::unique_ptr< PointerType > pointer_to() const
Create a pointer type pointing to this type.
This class represents an editable DWARF variable which can be scoped by a function or a compilation u...
Definition editor/Variable.hpp:33
Definition DWARF/editor/CompilationUnit.hpp:36
Definition Editor.hpp:30
Namespace for the DWARF debug format.
Definition DWARF/CompilationUnit.hpp:28
LIEF namespace.
Definition Abstract/Binary.hpp:39
#define LIEF_API
Definition visibility.h:41