mirror of
https://github.com/ruby/ruby.git
synced 2026-10-28 16:36:20 +08:00
Kevin Newton
f25e997399
This is as opposed to the *_each APIs we have been using, because that adds the overhead of a passed around callback. https://github.com/ruby/prism/commit/671ddb0022
73 lines
1.9 KiB
C
73 lines
1.9 KiB
C
/**
|
|
* @file comments.h
|
|
*
|
|
* Types and functions related to comments found during parsing.
|
|
*/
|
|
#ifndef PRISM_COMMENTS_H
|
|
#define PRISM_COMMENTS_H
|
|
|
|
#include "prism/compiler/exported.h"
|
|
#include "prism/compiler/nodiscard.h"
|
|
#include "prism/compiler/nonnull.h"
|
|
|
|
#include "prism/ast.h"
|
|
|
|
#include <stddef.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** This is the type of a comment that we've found while parsing. */
|
|
typedef enum {
|
|
PM_COMMENT_INLINE,
|
|
PM_COMMENT_EMBDOC
|
|
} pm_comment_type_t;
|
|
|
|
/** An opaque pointer to a comment found while parsing. */
|
|
typedef struct pm_comment_t pm_comment_t;
|
|
|
|
/**
|
|
* The comments owned by a node, as a slice of the comment attachments of the
|
|
* parser that produced it.
|
|
*/
|
|
typedef struct {
|
|
/** The index of the first attachment owned by the node. */
|
|
uint32_t index;
|
|
|
|
/** The number of attachments owned by the node. */
|
|
uint32_t length;
|
|
} pm_comment_range_t;
|
|
|
|
/**
|
|
* Returns the location associated with the given comment.
|
|
*
|
|
* @param comment the comment whose location we want to get
|
|
* @returns the location associated with the given comment
|
|
*/
|
|
PRISM_EXPORTED_FUNCTION pm_location_t pm_comment_location(const pm_comment_t *comment) PRISM_NONNULL(1);
|
|
|
|
/**
|
|
* Returns the type associated with the given comment.
|
|
*
|
|
* @param comment the comment whose type we want to get
|
|
* @returns the type associated with the given comment. This can either be
|
|
* PM_COMMENT_INLINE or PM_COMMENT_EMBDOC.
|
|
*/
|
|
PRISM_EXPORTED_FUNCTION pm_comment_type_t pm_comment_type(const pm_comment_t *comment) PRISM_NONNULL(1);
|
|
|
|
/**
|
|
* Returns the comment that follows the given comment among the comments
|
|
* associated with the parser that found it.
|
|
*
|
|
* @param comment the comment whose successor we want to get
|
|
* @returns the next comment, or NULL if the given comment is the last one
|
|
*/
|
|
PRISM_EXPORTED_FUNCTION const pm_comment_t * pm_comment_next(const pm_comment_t *comment) PRISM_NONNULL(1);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|