magic_comment.h

#ifndef LIB_RUBY_PARSER_MAGIC_COMMENT_H
#define LIB_RUBY_PARSER_MAGIC_COMMENT_H

#include <stddef.h>
#include "loc.h"

/// @defgroup magic_comment Magic Comments
/// @brief A set of structs and functions to work with magic comments
/// @{
/// @}

/// Equivalent of `lib_ruby_parser::source::MagicCommentKind`
/// @ingroup magic_comment
typedef enum
{
    LIB_RUBY_PARSER_MAGIC_COMMENT_KIND_ENCODING,
    LIB_RUBY_PARSER_MAGIC_COMMENT_KIND_FROZEN_STRING_LITERAL,
    LIB_RUBY_PARSER_MAGIC_COMMENT_KIND_WARN_INDENT,
    LIB_RUBY_PARSER_MAGIC_COMMENT_KIND_SHAREABLE_CONSTANT_VALUE,
} LIB_RUBY_PARSER_MagicCommentKind;

/// Equivalent of `lib_ruby_parser::source::MagicComment`
/// @ingroup magic_comment
typedef struct
{
    /// Kind of the magic comment
    LIB_RUBY_PARSER_MagicCommentKind kind;
    /// Location of the magic comment key
    LIB_RUBY_PARSER_Loc key_l;
    /// Location of the magic comment value
    LIB_RUBY_PARSER_Loc value_l;
} LIB_RUBY_PARSER_MagicComment;

/// Equivalent of `Vec<lib_ruby_parser::source::MagicComment>`
/// @ingroup magic_comment
typedef struct
{
    size_t capacity;
    LIB_RUBY_PARSER_MagicComment *ptr;
    size_t len;
} LIB_RUBY_PARSER_MagicCommentList;

/// MagicCommentList destructor.
/// Just like Rust/C++ destructor it performs cleanup of "embedded" resources.
/// i.e. it doesn't call `free` on a given pointer.
/// @ingroup magic_comment
void LIB_RUBY_PARSER_drop_magic_comment_list(LIB_RUBY_PARSER_MagicCommentList *magic_comment_list);

#endif // LIB_RUBY_PARSER_MAGIC_COMMENT_H