Types and functions related to magic comments found during parsing. More...
#include "prism/compiler/exported.h"#include "prism/compiler/nonnull.h"#include "prism/ast.h"#include <stddef.h>
Include dependency graph for magic_comments.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
| typedef struct pm_magic_comment_t | pm_magic_comment_t |
| An opaque pointer to a magic comment found while parsing. | |
Functions | |
| PRISM_EXPORTED_FUNCTION pm_location_t | pm_magic_comment_key (const pm_magic_comment_t *magic_comment) PRISM_NONNULL(1) |
| Returns the location of the key associated with the given magic comment. | |
| PRISM_EXPORTED_FUNCTION pm_location_t | pm_magic_comment_value (const pm_magic_comment_t *magic_comment) PRISM_NONNULL(1) |
| Returns the location of the value associated with the given magic comment. | |
| PRISM_EXPORTED_FUNCTION const pm_magic_comment_t * | pm_magic_comment_next (const pm_magic_comment_t *magic_comment) PRISM_NONNULL(1) |
| Returns the magic comment that follows the given magic comment among the magic comments associated with the parser that found it. | |
Detailed Description
Types and functions related to magic comments found during parsing.
Function Documentation
◆ pm_magic_comment_key()
| PRISM_EXPORTED_FUNCTION pm_location_t pm_magic_comment_key | ( | const pm_magic_comment_t * | magic_comment | ) |
Returns the location of the key associated with the given magic comment.
- Parameters
-
magic_comment the magic comment whose key location we want to get
- Returns
- the location of the key associated with the given magic comment
◆ pm_magic_comment_value()
| PRISM_EXPORTED_FUNCTION pm_location_t pm_magic_comment_value | ( | const pm_magic_comment_t * | magic_comment | ) |
Returns the location of the value associated with the given magic comment.
- Parameters
-
magic_comment the magic comment whose value location we want to get
- Returns
- the location of the value associated with the given magic comment
◆ pm_magic_comment_next()
| PRISM_EXPORTED_FUNCTION const pm_magic_comment_t * pm_magic_comment_next | ( | const pm_magic_comment_t * | magic_comment | ) |
Returns the magic comment that follows the given magic comment among the magic comments associated with the parser that found it.
- Parameters
-
magic_comment the magic comment whose successor we want to get
- Returns
- the next magic comment, or NULL if the given magic comment is the last one
