types.hpp

Go to the documentation of this file.

// AI Generated 2026 Ryan P. Nicholl  <rnicholl@protonmail.com>
// SPDX-License-Identifier: Apache-2.0

 
#ifndef RPNX_CORTADO_TYPES_HPP
#define RPNX_CORTADO_TYPES_HPP
 
#include <cstddef>
#include <cstdint>
#include <rpnx/macros.hpp>
#include <string>
#include <variant>
#include <vector>

namespace rpnx::cortado
{
    inline constexpr std::uint32_t class_file_magic = 0xCAFEBABEU;

    enum class constant_pool_tag : std::uint8_t { utf8 = 1, integer = 3, floating_point = 4, long_integer = 5, double_precision = 6, class_reference = 7, string = 8, field_reference = 9, method_reference = 10, interface_method_reference = 11, name_and_type = 12, method_handle = 15, method_type = 16, dynamic = 17, invoke_dynamic = 18, module = 19, package = 20 };

    struct constant_pool_index
    {
        std::uint16_t value{}; 
        RPNX_MEMBER_METADATA(constant_pool_index, value);
    };

    struct bootstrap_method_index
    {
        std::uint16_t value{}; 
        RPNX_MEMBER_METADATA(bootstrap_method_index, value);
    };

    struct class_file_version
    {
        std::uint16_t minor{}; 
        std::uint16_t major{}; 
        RPNX_MEMBER_METADATA(class_file_version, minor, major);
    };

    enum class method_handle_reference_kind : std::uint8_t { get_field = 1, get_static = 2, put_field = 3, put_static = 4, invoke_virtual = 5, invoke_static = 6, invoke_special = 7, new_invoke_special = 8, invoke_interface = 9 };

    enum class class_access_flags : std::uint16_t { none = 0, is_public = 0x0001, is_final = 0x0010, invokes_special_super = 0x0020, is_interface = 0x0200, is_abstract = 0x0400, is_synthetic = 0x1000, is_annotation = 0x2000, is_enum = 0x4000, is_module = 0x8000 };

    [[nodiscard]] constexpr class_access_flags operator|(class_access_flags left, class_access_flags right) noexcept
    {
        return static_cast< class_access_flags >(static_cast< std::uint16_t >(left) | static_cast< std::uint16_t >(right));
    }

    enum class field_access_flags : std::uint16_t { none = 0, is_public = 0x0001, is_private = 0x0002, is_protected = 0x0004, is_static = 0x0008, is_final = 0x0010, is_volatile = 0x0040, is_transient = 0x0080, is_synthetic = 0x1000, is_enum = 0x4000 };

    [[nodiscard]] constexpr field_access_flags operator|(field_access_flags left, field_access_flags right) noexcept
    {
        return static_cast< field_access_flags >(static_cast< std::uint16_t >(left) | static_cast< std::uint16_t >(right));
    }

    enum class method_access_flags : std::uint16_t { none = 0, is_public = 0x0001, is_private = 0x0002, is_protected = 0x0004, is_static = 0x0008, is_final = 0x0010, is_synchronized = 0x0020, is_bridge = 0x0040, has_variable_arguments = 0x0080, is_native = 0x0100, is_abstract = 0x0400, is_strict = 0x0800, is_synthetic = 0x1000 };

    [[nodiscard]] constexpr method_access_flags operator|(method_access_flags left, method_access_flags right) noexcept
    {
        return static_cast< method_access_flags >(static_cast< std::uint16_t >(left) | static_cast< std::uint16_t >(right));
    }

    struct utf8_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::utf8; 
        static constexpr std::size_t slot_count = 1; 
        std::string bytes; 
        RPNX_MEMBER_METADATA(utf8_constant, bytes);
    };

    struct integer_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::integer;
        static constexpr std::size_t slot_count = 1;
        std::uint32_t bits{}; 
        RPNX_MEMBER_METADATA(integer_constant, bits);
    };

    struct float_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::floating_point;
        static constexpr std::size_t slot_count = 1;
        std::uint32_t bits{}; 
        RPNX_MEMBER_METADATA(float_constant, bits);
    };

    struct long_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::long_integer;
        static constexpr std::size_t slot_count = 2;
        std::uint64_t bits{}; 
        RPNX_MEMBER_METADATA(long_constant, bits);
    };

    struct double_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::double_precision;
        static constexpr std::size_t slot_count = 2;
        std::uint64_t bits{}; 
        RPNX_MEMBER_METADATA(double_constant, bits);
    };

    struct class_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::class_reference;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index name_index; 
        RPNX_MEMBER_METADATA(class_constant, name_index);
    };

    struct string_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::string;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index string_index; 
        RPNX_MEMBER_METADATA(string_constant, string_index);
    };

    struct fieldref_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::field_reference;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index class_index; 
        constant_pool_index name_and_type_index; 
        RPNX_MEMBER_METADATA(fieldref_constant, class_index, name_and_type_index);
    };

    struct methodref_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::method_reference;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index class_index; 
        constant_pool_index name_and_type_index; 
        RPNX_MEMBER_METADATA(methodref_constant, class_index, name_and_type_index);
    };

    struct interface_methodref_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::interface_method_reference;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index class_index; 
        constant_pool_index name_and_type_index; 
        RPNX_MEMBER_METADATA(interface_methodref_constant, class_index, name_and_type_index);
    };

    struct name_and_type_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::name_and_type;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index name_index; 
        constant_pool_index descriptor_index; 
        RPNX_MEMBER_METADATA(name_and_type_constant, name_index, descriptor_index);
    };

    struct method_handle_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::method_handle;
        static constexpr std::size_t slot_count = 1;
        method_handle_reference_kind reference_kind{method_handle_reference_kind::get_field}; 
        constant_pool_index reference_index; 
        RPNX_MEMBER_METADATA(method_handle_constant, reference_kind, reference_index);
    };

    struct method_type_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::method_type;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index descriptor_index; 
        RPNX_MEMBER_METADATA(method_type_constant, descriptor_index);
    };

    struct dynamic_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::dynamic;
        static constexpr std::size_t slot_count = 1;
        bootstrap_method_index bootstrap_method_attr_index; 
        constant_pool_index name_and_type_index; 
        RPNX_MEMBER_METADATA(dynamic_constant, bootstrap_method_attr_index, name_and_type_index);
    };

    struct invoke_dynamic_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::invoke_dynamic;
        static constexpr std::size_t slot_count = 1;
        bootstrap_method_index bootstrap_method_attr_index; 
        constant_pool_index name_and_type_index; 
        RPNX_MEMBER_METADATA(invoke_dynamic_constant, bootstrap_method_attr_index, name_and_type_index);
    };

    struct module_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::module;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index name_index; 
        RPNX_MEMBER_METADATA(module_constant, name_index);
    };

    struct package_constant
    {
        static constexpr constant_pool_tag tag = constant_pool_tag::package;
        static constexpr std::size_t slot_count = 1;
        constant_pool_index name_index; 
        RPNX_MEMBER_METADATA(package_constant, name_index);
    };

    using constant_pool_entry = std::variant< utf8_constant, integer_constant, float_constant, long_constant, double_constant, class_constant, string_constant, fieldref_constant, methodref_constant, interface_methodref_constant, name_and_type_constant, method_handle_constant, method_type_constant, dynamic_constant, invoke_dynamic_constant, module_constant, package_constant >;

    enum class compression_method : std::uint16_t { stored = 0, deflated = 8 };

    enum class jar_entry_flags : std::uint16_t { none = 0, utf8_names = 0x0800 };

    struct zip_dos_time
    {
        std::uint16_t encoded_value{}; 
        RPNX_MEMBER_METADATA(zip_dos_time, encoded_value);
    };

    struct zip_dos_date
    {
        std::uint16_t encoded_value{}; 
        RPNX_MEMBER_METADATA(zip_dos_date, encoded_value);
    };

    struct zip_internal_attributes
    {
        std::uint16_t encoded_value{}; 
        RPNX_MEMBER_METADATA(zip_internal_attributes, encoded_value);
    };

    struct zip_external_attributes
    {
        std::uint32_t encoded_value{}; 
        RPNX_MEMBER_METADATA(zip_external_attributes, encoded_value);
    };

    struct jar_entry
    {
        std::string name; 
        std::vector< std::byte > extra; 
        std::string comment; 
        std::vector< std::byte > data; 
        compression_method compression{compression_method::deflated}; 
        jar_entry_flags flags{jar_entry_flags::none}; 
        zip_dos_time modification_time; 
        zip_dos_date modification_date; 
        zip_internal_attributes internal_attributes; 
        zip_external_attributes external_attributes; 
        RPNX_MEMBER_METADATA(jar_entry, name, extra, comment, data, compression, flags, modification_time, modification_date, internal_attributes, external_attributes);
    };

    struct jar_file
    {
        std::vector< jar_entry > entries; 
        std::string comment; 
        RPNX_MEMBER_METADATA(jar_file, entries, comment);
    };

    struct jar_read_options
    {
        std::size_t maximum_entry_uncompressed_size{256U * 1024U * 1024U}; 
        std::size_t maximum_total_uncompressed_size{1024U * 1024U * 1024U}; 
        RPNX_MEMBER_METADATA(jar_read_options, maximum_entry_uncompressed_size, maximum_total_uncompressed_size);
    };
} // namespace rpnx::cortado
 
#endif // RPNX_CORTADO_TYPES_HPP