DEX/Method.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_DEX_METHOD_H
#define LIEF_DEX_METHOD_H
 
#include <string_view>
#include <climits>
#include <vector>
 
#include "LIEF/Object.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/DEX/CodeInfo.hpp"
#include "LIEF/DEX/deopt.hpp"
#include "LIEF/DEX/enums.hpp"
 
 
namespace LIEF::DEX {
class Parser;
class Class;
class Prototype;

class LIEF_API Method : public Object {
  friend class Parser;
 
  public:
  using access_flags_list_t = std::vector<ACCESS_FLAGS>;
 
  public:
  using bytecode_t = std::vector<uint8_t>;
  Method();
  Method(std::string name, Class* parent = nullptr);
 
  Method(const Method&);
  Method& operator=(const Method&);

  std::string_view name() const;

  bool has_class() const;

  const Class* cls() const;
  Class* cls();

  uint64_t code_offset() const;

  const bytecode_t& bytecode() const;

  size_t index() const;

  bool is_virtual() const;

  const Prototype* prototype() const;
  Prototype* prototype();
 
  void insert_dex2dex_info(uint32_t pc, uint32_t index);
 
  void accept(Visitor& visitor) const override;
 
  const dex2dex_method_info_t& dex2dex_info() const;

  bool has(ACCESS_FLAGS f) const;

  access_flags_list_t access_flags() const;
 
  // CodeInfo to get additional data about a method i.e. argument count
  const CodeInfo& code_info() const;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const Method& mtd);
 
  ~Method() override;
 
  private:
  void set_virtual(bool v);
 
  private:
  std::string name_;
  Class* parent_ = nullptr;
  Prototype* prototype_ = nullptr;
  uint32_t access_flags_ = ACCESS_FLAGS::ACC_UNKNOWN;
  uint32_t original_index_ = UINT_MAX;
  bool is_virtual_ = false;
 
  uint64_t code_offset_ = 0;
  std::vector<uint8_t> bytecode_;
 
  CodeInfo code_info_;
 
  dex2dex_method_info_t dex2dex_info_;
};
 
} // Namespace DEX
// Namespace LIEF
#endif