validation.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_VALIDATION_HPP
#define RPNX_CORTADO_VALIDATION_HPP
 
#include <cstddef>
#include <cstdint>
#include <rpnx/cortado/attributes.hpp>
#include <string>
#include <vector>
 
namespace rpnx::cortado
{
    enum class validation_code : std::uint16_t { invalid_version, invalid_constant_pool_index, invalid_constant_pool_reference_kind, feature_not_supported_by_version, invalid_flags, invalid_descriptor, invalid_attribute_name, duplicate_attribute, missing_code_attribute, unexpected_code_attribute, invalid_code, invalid_branch_target, invalid_switch_table, invalid_exception_range, invalid_stack_map, invalid_annotation, invalid_module_structure, resource_limit_exceeded };

    enum class validation_location_kind : std::uint8_t { class_file, constant_pool, interface, field, method, class_attribute, field_attribute, method_attribute, code, code_attribute, record_component };

    struct validation_location
    {
        validation_location_kind kind{validation_location_kind::class_file}; 
        std::size_t primary_index{}; 
        std::size_t secondary_index{}; 
        code_offset offset{}; 
        RPNX_MEMBER_METADATA(validation_location, kind, primary_index, secondary_index, offset);
    };

    struct validation_diagnostic
    {
        validation_code code{validation_code::invalid_version}; 
        validation_location location; 
        std::string message; 
        RPNX_MEMBER_METADATA(validation_diagnostic, code, location, message);
    };

    struct validation_options
    {
        std::size_t maximum_diagnostics{256}; 
        std::size_t maximum_nesting_depth{256}; 
        std::size_t maximum_structure_nodes{1'000'000}; 
        bool validate_instruction_constant_types{true}; 
        RPNX_MEMBER_METADATA(validation_options, maximum_diagnostics, maximum_nesting_depth, maximum_structure_nodes, validate_instruction_constant_types);
    };

    struct validation_report
    {
        std::vector< validation_diagnostic > diagnostics; 

        [[nodiscard]] bool valid() const noexcept;
 
        RPNX_MEMBER_METADATA(validation_report, diagnostics);
    };

    [[nodiscard]] validation_report validate_class_file(class_file const& value, validation_options const& options = {});
} // namespace rpnx::cortado
 
#endif // RPNX_CORTADO_VALIDATION_HPP