DEX/File.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_FILE_H
#define LIEF_DEX_FILE_H
#include <string_view>
#include <memory>
 
#include "LIEF/Object.hpp"
#include "LIEF/visibility.h"
 
#include "LIEF/DEX/Header.hpp"
#include "LIEF/DEX/MapList.hpp"
#include "LIEF/DEX/deopt.hpp"
#include "LIEF/DEX/instructions.hpp"
#include "LIEF/DEX/types.hpp"
 
 
namespace LIEF::DEX {
class Parser;
class Class;
class Method;
class Type;
class Prototype;
class Field;

class LIEF_API File : public Object {
  friend class Parser;
 
  public:
  using classes_t = std::unordered_map<std::string, Class*>;
  using classes_list_t = std::vector<std::unique_ptr<Class>>;
  using it_classes = ref_iterator<classes_list_t&, Class*>;
  using it_const_classes = const_ref_iterator<const classes_list_t&, const Class*>;
 
  using methods_t = std::vector<std::unique_ptr<Method>>;
  using it_methods = ref_iterator<methods_t&, Method*>;
  using it_const_methods = const_ref_iterator<const methods_t&, const Method*>;
 
  using strings_t = std::vector<std::unique_ptr<std::string>>;
  using it_strings = ref_iterator<strings_t&, std::string*>;
  using it_const_strings =
      const_ref_iterator<const strings_t&, const std::string*>;
 
  using types_t = std::vector<std::unique_ptr<Type>>;
  using it_types = ref_iterator<types_t&, Type*>;
  using it_const_types = const_ref_iterator<const types_t&, const Type*>;
 
  using prototypes_t = std::vector<std::unique_ptr<Prototype>>;
  using it_prototypes = ref_iterator<prototypes_t&, Prototype*>;
  using it_const_prototypes =
      const_ref_iterator<const prototypes_t&, const Prototype*>;
 
  using fields_t = std::vector<std::unique_ptr<Field>>;
  using it_fields = ref_iterator<fields_t&, Field*>;
  using it_const_fields = const_ref_iterator<const fields_t&, const Field*>;
 
  public:
  File& operator=(const File& copy) = delete;
  File(const File& copy) = delete;

  dex_version_t version() const;

  std::string_view name() const;
 
  void name(const std::string& name);

  std::string_view location() const;
  void location(const std::string& location);

  const Header& header() const LIEF_LIFETIMEBOUND;
  Header& header() LIEF_LIFETIMEBOUND;

  it_const_classes classes() const LIEF_LIFETIMEBOUND;
  it_classes classes() LIEF_LIFETIMEBOUND;

  bool has_class(const std::string& class_name) const;

  const Class* get_class(const std::string& class_name) const LIEF_LIFETIMEBOUND;
 
  Class* get_class(const std::string& class_name) LIEF_LIFETIMEBOUND;

  const Class* get_class(size_t index) const LIEF_LIFETIMEBOUND;
 
  Class* get_class(size_t index) LIEF_LIFETIMEBOUND;

  dex2dex_info_t dex2dex_info() const;

  std::string dex2dex_json_info() const;

  it_const_methods methods() const LIEF_LIFETIMEBOUND;
  it_methods methods() LIEF_LIFETIMEBOUND;

  it_const_fields fields() const LIEF_LIFETIMEBOUND;
  it_fields fields() LIEF_LIFETIMEBOUND;

  it_const_strings strings() const LIEF_LIFETIMEBOUND;
  it_strings strings() LIEF_LIFETIMEBOUND;

  it_const_types types() const LIEF_LIFETIMEBOUND;
  it_types types() LIEF_LIFETIMEBOUND;

  it_prototypes prototypes() LIEF_LIFETIMEBOUND;
  it_const_prototypes prototypes() const LIEF_LIFETIMEBOUND;

  const MapList& map() const;
  MapList& map();

  std::string save(const std::string& path = "", bool deoptimize = true) const;
 
  std::vector<uint8_t> raw(bool deoptimize = true) const;
 
  void accept(Visitor& visitor) const override;
 
 
  ~File() override;
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const File& file);
 
  private:
  File();
 
  void add_class(std::unique_ptr<Class> cls);
 
  static void deoptimize_nop(uint8_t* inst_ptr, uint32_t value);
  static void deoptimize_return(uint8_t* inst_ptr, uint32_t value);
  static void deoptimize_invoke_virtual(uint8_t* inst_ptr, uint32_t value,
                                        OPCODES new_inst);
  static void deoptimize_instance_field_access(uint8_t* inst_ptr, uint32_t value,
                                               OPCODES new_inst);
 
  std::string name_;
  std::string location_;
 
  Header header_;
  classes_t classes_;
  methods_t methods_;
  fields_t fields_;
  strings_t strings_;
  types_t types_;
  prototypes_t prototypes_;
  MapList map_;
 
  classes_list_t class_list_;
  std::vector<uint8_t> original_data_;
};
 
}
 
 
#endif