Ruby: pm_diagnostic_t Struct Reference

Ruby 3.3.4p94 (2024-07-09 revision be1089c8ec5ba40e09b1553e36b3174bf4014d9d)

Data Fields
pm_diagnostic_t Struct Reference

This struct represents a diagnostic generated during parsing. More...

`#include <diagnostic.h>`

## Data Fields
pm_list_node_t | node
| The embedded base node.
pm_location_t | location
| The location of the diagnostic in the source.
const char * | message
| The message associated with the diagnostic.
bool | owned
| Whether or not the memory related to the message of this diagnostic is owned by this diagnostic.
Data Fields inherited from pm_list_node
struct pm_list_node * | next
| A pointer to the next node in the list.

## Detailed Description

This struct represents a diagnostic generated during parsing.

Definition at line 22 of file diagnostic.h.

## Field Documentation

## ◆ location

pm_location_t pm_diagnostic_t::location

The location of the diagnostic in the source.

Definition at line 27 of file diagnostic.h.

Referenced by pm_diagnostic_list_append(), and pm_diagnostic_list_append_format().

## ◆ message

const char* pm_diagnostic_t::message

The message associated with the diagnostic.

Definition at line 30 of file diagnostic.h.

Referenced by pm_diagnostic_list_free().

## ◆ node

pm_list_node_t pm_diagnostic_t::node

The embedded base node.

Definition at line 24 of file diagnostic.h.

## ◆ owned

bool pm_diagnostic_t::owned

Whether or not the memory related to the message of this diagnostic is owned by this diagnostic.

If it is, it needs to be freed when the diagnostic is freed.

Definition at line 37 of file diagnostic.h.

Referenced by pm_diagnostic_list_free().

The documentation for this struct was generated from the following file:

- prism/diagnostic.h