Abstract/Function.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2026 R. Thomas
 * Copyright 2017 - 2026 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_ABSTRACT_FUNCTION_H
#define LIEF_ABSTRACT_FUNCTION_H
 
#include <string_view>
#include <string>
#include <vector>
 
#include "LIEF/Abstract/Symbol.hpp"
#include "LIEF/enums.hpp"
#include "LIEF/visibility.h"
 
namespace LIEF {

class LIEF_API Function : public Symbol {
  public:
  enum class FLAGS : uint32_t {
    NONE = 0,
    CONSTRUCTOR = 1 << 0,

    DESTRUCTOR = 1 << 1,

    DEBUG_INFO = 1 << 2,

    EXPORTED = 1 << 3,

    IMPORTED = 1 << 4,
  };
 
  public:
  Function() = default;
  Function(std::string_view name) :
    Symbol(std::string(name)) {}
  Function(uint64_t address) :
    Function("", address) {}
  Function(std::string_view name, uint64_t address) :
    Symbol(std::string(name), address) {}
  Function(std::string_view name, uint64_t address, FLAGS flags) :
    Function(name, address) {
    flags_ = flags;
  }
 
  Function(const Function&) = default;
  Function& operator=(const Function&) = default;
 
  ~Function() override = default;

  std::vector<FLAGS> flags_list() const;
 
  FLAGS flags() const {
    return flags_;
  }

  Function& add(FLAGS f) {
    flags_ = (FLAGS)((uint32_t)flags_ | (uint32_t)f);
    return *this;
  }

  bool has(FLAGS f) const {
    return ((uint32_t)flags_ & (uint32_t)f) != 0;
  }

  uint64_t address() const {
    return value_;
  }
 
  void address(uint64_t address) {
    value_ = address;
  }
 
  void accept(Visitor& visitor) const override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                           const Function& entry);
 
  protected:
  FLAGS flags_ = FLAGS::NONE;
};
 
LIEF_API const char* to_string(Function::FLAGS e);
}
 
ENABLE_BITMASK_OPERATORS(LIEF::Function::FLAGS);
 
#endif