signatures.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_SIGNATURES_HPP
#define RPNX_CORTADO_SIGNATURES_HPP
 
#include <cstddef>
#include <optional>
#include <rpnx/cortado/descriptors.hpp>
#include <rpnx/cortado/errors.hpp>
#include <string>
#include <string_view>
#include <variant>
#include <vector>
 
namespace rpnx::cortado
{
    struct signature_parse_options
    {
        std::size_t maximum_nesting_depth{256}; 
        std::size_t maximum_nodes{65'536}; 
        RPNX_MEMBER_METADATA(signature_parse_options, maximum_nesting_depth, maximum_nodes);
    };
 
    struct class_type_signature;
    struct type_variable_signature;
    struct array_type_signature;

    struct reference_type_signature
    {
        using value_type = rpnx::variant< class_type_signature, type_variable_signature, array_type_signature >;
        value_type value; 
        RPNX_MEMBER_METADATA(reference_type_signature, value);
    };

    struct java_type_signature
    {
        using value_type = rpnx::variant< primitive_type_descriptor, reference_type_signature >;
        value_type value; 
        RPNX_MEMBER_METADATA(java_type_signature, value);
    };

    struct any_type_argument
    {
        RPNX_EMPTY_METADATA(any_type_argument);
    };

    struct exact_type_argument
    {
        reference_type_signature type; 
        RPNX_MEMBER_METADATA(exact_type_argument, type);
    };

    struct extends_type_argument
    {
        reference_type_signature bound; 
        RPNX_MEMBER_METADATA(extends_type_argument, bound);
    };

    struct super_type_argument
    {
        reference_type_signature bound; 
        RPNX_MEMBER_METADATA(super_type_argument, bound);
    };

    using type_argument = std::variant< any_type_argument, exact_type_argument, extends_type_argument, super_type_argument >;

    struct simple_class_type_signature
    {
        std::string identifier; 
        std::vector< type_argument > arguments; 
        RPNX_MEMBER_METADATA(simple_class_type_signature, identifier, arguments);
    };

    struct class_type_signature
    {
        std::string package_name; 
        simple_class_type_signature outer_class; 
        std::vector< simple_class_type_signature > nested_classes; 
        RPNX_MEMBER_METADATA(class_type_signature, package_name, outer_class, nested_classes);
    };

    struct type_variable_signature
    {
        std::string identifier; 
        RPNX_MEMBER_METADATA(type_variable_signature, identifier);
    };

    struct array_type_signature
    {
        java_type_signature component; 
        RPNX_MEMBER_METADATA(array_type_signature, component);
    };

    struct type_parameter
    {
        std::string identifier; 
        std::optional< reference_type_signature > class_bound; 
        std::vector< reference_type_signature > interface_bounds; 
        RPNX_MEMBER_METADATA(type_parameter, identifier, class_bound, interface_bounds);
    };

    struct class_signature
    {
        std::vector< type_parameter > type_parameters; 
        class_type_signature superclass; 
        std::vector< class_type_signature > superinterfaces; 
        RPNX_MEMBER_METADATA(class_signature, type_parameters, superclass, superinterfaces);
    };

    using method_result_signature = std::variant< void_type_descriptor, java_type_signature >;

    using throws_signature = std::variant< class_type_signature, type_variable_signature >;

    struct method_signature
    {
        std::vector< type_parameter > type_parameters; 
        std::vector< java_type_signature > parameters; 
        method_result_signature result; 
        std::vector< throws_signature > throws_signatures; 
        RPNX_MEMBER_METADATA(method_signature, type_parameters, parameters, result, throws_signatures);
    };

    [[nodiscard]] reference_type_signature parse_field_signature(std::string_view text, signature_parse_options const& options = {});

    [[nodiscard]] class_signature parse_class_signature(std::string_view text, signature_parse_options const& options = {});

    [[nodiscard]] method_signature parse_method_signature(std::string_view text, signature_parse_options const& options = {});

    [[nodiscard]] std::string serialize_field_signature(reference_type_signature const& signature);

    [[nodiscard]] std::string serialize_class_signature(class_signature const& signature);

    [[nodiscard]] std::string serialize_method_signature(method_signature const& signature);
} // namespace rpnx::cortado
 
#endif // RPNX_CORTADO_SIGNATURES_HPP