latest/doxygen/PE_2Symbol_8hpp_source.html

/* Copyright 2017 - 2025 R. Thomas

 * Copyright 2017 - 2025 Quarkslab

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

#ifndef LIEF_PE_SYMBOLS_H

#define LIEF_PE_SYMBOLS_H


#include <ostream>

#include <memory>

#include <vector>


#include "LIEF/iterators.hpp"

#include "LIEF/Object.hpp"

#include "LIEF/visibility.h"


#include "LIEF/Abstract/Symbol.hpp"


namespace LIEF {

class BinaryStream;


namespace PE {

class AuxiliarySymbol;

class COFFString;

class Parser;

class LIEF_API Symbol : public LIEF::Symbol {

  public:

  using auxiliary_symbols_t = std::vector<std::unique_ptr<AuxiliarySymbol>>;

  using it_auxiliary_symbols_t = ref_iterator<auxiliary_symbols_t&, AuxiliarySymbol*>;

  using it_const_auxiliary_symbols_t = const_ref_iterator<const auxiliary_symbols_t&, AuxiliarySymbol*>;


  static std::unique_ptr<Symbol> parse(Parser& ctx, BinaryStream& stream, size_t* idx);


  Symbol();

  Symbol(const Symbol&);

  Symbol& operator=(const Symbol&);


  Symbol(Symbol&&);

  Symbol& operator=(Symbol&&);

  static constexpr auto SYM_SEC_IDX_DEBUG = -2;  static constexpr auto SYM_SEC_IDX_ABS = -1;  static constexpr auto SYM_SEC_IDX_UNDEF = 0;


  static constexpr auto SYM_COMPLEX_TYPE_SHIFT = 4;

  enum class STORAGE_CLASS : int32_t {

    INVALID = 0xFF,


    END_OF_FUNCTION  = -1,

    NONE             = 0,

    AUTOMATIC        = 1,

    EXTERNAL         = 2,

    STATIC           = 3,

    REGISTER         = 4,

    EXTERNAL_DEF     = 5,

    LABEL            = 6,

    UNDEFINED_LABEL  = 7,

    MEMBER_OF_STRUCT = 8,

    ARGUMENT         = 9,

    STRUCT_TAG       = 10,

    MEMBER_OF_UNION  = 11,

    UNION_TAG        = 12,

    TYPE_DEFINITION  = 13,

    UNDEFINED_STATIC = 14,

    ENUM_TAG         = 15,

    MEMBER_OF_ENUM   = 16,

    REGISTER_PARAM   = 17,

    BIT_FIELD        = 18,

    BLOCK            = 100,

    FUNCTION         = 101,

    END_OF_STRUCT    = 102,

    FILE             = 103,

    SECTION          = 104,

    WEAK_EXTERNAL    = 105,

    CLR_TOKEN        = 107

  };