Ruby: prism/diagnostic.c Source File

Ruby 3.3.7p123 (2025-01-15 revision be31f993d7fa0219d85f7b3c694d454da4ecc10b)

diagnostic.c
1#include "prism/diagnostic.h"
2
53static const char* const diagnostic_messages[PM_DIAGNOSTIC_ID_LEN] = {
54 [PM_ERR_ALIAS_ARGUMENT] = "invalid argument being passed to `alias`; expected a bare word, symbol, constant, or global variable",
55 [PM_ERR_AMPAMPEQ_MULTI_ASSIGN] = "unexpected `&&=` in a multiple assignment",
56 [PM_ERR_ARGUMENT_AFTER_BLOCK] = "unexpected argument after a block argument",
57 [PM_ERR_ARGUMENT_AFTER_FORWARDING_ELLIPSES] = "unexpected argument after `...`",
58 [PM_ERR_ARGUMENT_BARE_HASH] = "unexpected bare hash argument",
59 [PM_ERR_ARGUMENT_BLOCK_MULTI] = "multiple block arguments; only one block is allowed",
60 [PM_ERR_ARGUMENT_FORMAL_CLASS] = "invalid formal argument; formal argument cannot be a class variable",
61 [PM_ERR_ARGUMENT_FORMAL_CONSTANT] = "invalid formal argument; formal argument cannot be a constant",
62 [PM_ERR_ARGUMENT_FORMAL_GLOBAL] = "invalid formal argument; formal argument cannot be a global variable",
63 [PM_ERR_ARGUMENT_FORMAL_IVAR] = "invalid formal argument; formal argument cannot be an instance variable",
64 [PM_ERR_ARGUMENT_FORWARDING_UNBOUND] = "unexpected `...` in an non-parenthesized call",
65 [PM_ERR_ARGUMENT_NO_FORWARDING_AMP] = "unexpected `&` when the parent method is not forwarding",
66 [PM_ERR_ARGUMENT_NO_FORWARDING_ELLIPSES] = "unexpected `...` when the parent method is not forwarding",
67 [PM_ERR_ARGUMENT_NO_FORWARDING_STAR] = "unexpected `*` when the parent method is not forwarding",
68 [PM_ERR_ARGUMENT_SPLAT_AFTER_ASSOC_SPLAT] = "unexpected `*` splat argument after a `**` keyword splat argument",
69 [PM_ERR_ARGUMENT_SPLAT_AFTER_SPLAT] = "unexpected `*` splat argument after a `*` splat argument",
70 [PM_ERR_ARGUMENT_TERM_PAREN] = "expected a `)` to close the arguments",
71 [PM_ERR_ARGUMENT_UNEXPECTED_BLOCK] = "unexpected `{` after a method call without parenthesis",
72 [PM_ERR_ARRAY_ELEMENT] = "expected an element for the array",
73 [PM_ERR_ARRAY_EXPRESSION] = "expected an expression for the array element",
74 [PM_ERR_ARRAY_EXPRESSION_AFTER_STAR] = "expected an expression after `*` in the array",
75 [PM_ERR_ARRAY_SEPARATOR] = "expected a `,` separator for the array elements",
76 [PM_ERR_ARRAY_TERM] = "expected a `]` to close the array",
77 [PM_ERR_BEGIN_LONELY_ELSE] = "unexpected `else` in `begin` block; a `rescue` clause must precede `else`",
78 [PM_ERR_BEGIN_TERM] = "expected an `end` to close the `begin` statement",
79 [PM_ERR_BEGIN_UPCASE_BRACE] = "expected a `{` after `BEGIN`",
80 [PM_ERR_BEGIN_UPCASE_TERM] = "expected a `}` to close the `BEGIN` statement",
81 [PM_ERR_BEGIN_UPCASE_TOPLEVEL] = "BEGIN is permitted only at toplevel",
82 [PM_ERR_BLOCK_PARAM_LOCAL_VARIABLE] = "expected a local variable name in the block parameters",
83 [PM_ERR_BLOCK_PARAM_PIPE_TERM] = "expected the block parameters to end with `|`",
84 [PM_ERR_BLOCK_TERM_BRACE] = "expected a block beginning with `{` to end with `}`",
85 [PM_ERR_BLOCK_TERM_END] = "expected a block beginning with `do` to end with `end`",
86 [PM_ERR_CANNOT_PARSE_EXPRESSION] = "cannot parse the expression",
87 [PM_ERR_CANNOT_PARSE_STRING_PART] = "cannot parse the string part",
88 [PM_ERR_CASE_EXPRESSION_AFTER_CASE] = "expected an expression after `case`",
89 [PM_ERR_CASE_EXPRESSION_AFTER_WHEN] = "expected an expression after `when`",
90 [PM_ERR_CASE_MATCH_MISSING_PREDICATE] = "expected a predicate for a case matching statement",
91 [PM_ERR_CASE_MISSING_CONDITIONS] = "expected a `when` or `in` clause after `case`",
92 [PM_ERR_CASE_TERM] = "expected an `end` to close the `case` statement",
93 [PM_ERR_CLASS_IN_METHOD] = "unexpected class definition in a method definition",
94 [PM_ERR_CLASS_NAME] = "expected a constant name after `class`",
95 [PM_ERR_CLASS_SUPERCLASS] = "expected a superclass after `<`",
96 [PM_ERR_CLASS_TERM] = "expected an `end` to close the `class` statement",
97 [PM_ERR_CLASS_UNEXPECTED_END] = "unexpected `end`, expecting ';' or '\\n'",
98 [PM_ERR_CONDITIONAL_ELSIF_PREDICATE] = "expected a predicate expression for the `elsif` statement",
99 [PM_ERR_CONDITIONAL_IF_PREDICATE] = "expected a predicate expression for the `if` statement",
100 [PM_ERR_CONDITIONAL_PREDICATE_TERM] = "expected `then` or `;` or '\\n'",
101 [PM_ERR_CONDITIONAL_TERM] = "expected an `end` to close the conditional clause",
102 [PM_ERR_CONDITIONAL_TERM_ELSE] = "expected an `end` to close the `else` clause",
103 [PM_ERR_CONDITIONAL_UNLESS_PREDICATE] = "expected a predicate expression for the `unless` statement",
104 [PM_ERR_CONDITIONAL_UNTIL_PREDICATE] = "expected a predicate expression for the `until` statement",
105 [PM_ERR_CONDITIONAL_WHILE_PREDICATE] = "expected a predicate expression for the `while` statement",
106 [PM_ERR_CONSTANT_PATH_COLON_COLON_CONSTANT] = "expected a constant after the `::` operator",
107 [PM_ERR_DEF_ENDLESS] = "could not parse the endless method body",
108 [PM_ERR_DEF_ENDLESS_SETTER] = "invalid method name; a setter method cannot be defined in an endless method definition",
109 [PM_ERR_DEF_NAME] = "expected a method name",
110 [PM_ERR_DEF_NAME_AFTER_RECEIVER] = "expected a method name after the receiver",
111 [PM_ERR_DEF_PARAMS_TERM] = "expected a delimiter to close the parameters",
112 [PM_ERR_DEF_PARAMS_TERM_PAREN] = "expected a `)` to close the parameters",
113 [PM_ERR_DEF_RECEIVER] = "expected a receiver for the method definition",
114 [PM_ERR_DEF_RECEIVER_TERM] = "expected a `.` or `::` after the receiver in a method definition",
115 [PM_ERR_DEF_TERM] = "expected an `end` to close the `def` statement",
116 [PM_ERR_DEFINED_EXPRESSION] = "expected an expression after `defined?`",
117 [PM_ERR_EMBDOC_TERM] = "could not find a terminator for the embedded document",
118 [PM_ERR_EMBEXPR_END] = "expected a `}` to close the embedded expression",
119 [PM_ERR_EMBVAR_INVALID] = "invalid embedded variable",
120 [PM_ERR_END_UPCASE_BRACE] = "expected a `{` after `END`",
121 [PM_ERR_END_UPCASE_TERM] = "expected a `}` to close the `END` statement",
122 [PM_ERR_ESCAPE_INVALID_CONTROL] = "invalid control escape sequence",
123 [PM_ERR_ESCAPE_INVALID_CONTROL_REPEAT] = "invalid control escape sequence; control cannot be repeated",
124 [PM_ERR_ESCAPE_INVALID_HEXADECIMAL] = "invalid hexadecimal escape sequence",
125 [PM_ERR_ESCAPE_INVALID_META] = "invalid meta escape sequence",
126 [PM_ERR_ESCAPE_INVALID_META_REPEAT] = "invalid meta escape sequence; meta cannot be repeated",
127 [PM_ERR_ESCAPE_INVALID_UNICODE] = "invalid Unicode escape sequence",
128 [PM_ERR_ESCAPE_INVALID_UNICODE_CM_FLAGS] = "invalid Unicode escape sequence; Unicode cannot be combined with control or meta flags",
129 [PM_ERR_ESCAPE_INVALID_UNICODE_LITERAL] = "invalid Unicode escape sequence; multiple codepoints are not allowed in a character literal",
130 [PM_ERR_ESCAPE_INVALID_UNICODE_LONG] = "invalid Unicode escape sequence; maximum length is 6 digits",
131 [PM_ERR_ESCAPE_INVALID_UNICODE_TERM] = "invalid Unicode escape sequence; needs closing `}`",
132 [PM_ERR_EXPECT_ARGUMENT] = "expected an argument",
133 [PM_ERR_EXPECT_EOL_AFTER_STATEMENT] = "expected a newline or semicolon after the statement",
134 [PM_ERR_EXPECT_EXPRESSION_AFTER_AMPAMPEQ] = "expected an expression after `&&=`",
135 [PM_ERR_EXPECT_EXPRESSION_AFTER_PIPEPIPEEQ] = "expected an expression after `||=`",
136 [PM_ERR_EXPECT_EXPRESSION_AFTER_COMMA] = "expected an expression after `,`",
137 [PM_ERR_EXPECT_EXPRESSION_AFTER_EQUAL] = "expected an expression after `=`",
138 [PM_ERR_EXPECT_EXPRESSION_AFTER_LESS_LESS] = "expected an expression after `<<`",
139 [PM_ERR_EXPECT_EXPRESSION_AFTER_LPAREN] = "expected an expression after `(`",
140 [PM_ERR_EXPECT_EXPRESSION_AFTER_OPERATOR] = "expected an expression after the operator",
141 [PM_ERR_EXPECT_EXPRESSION_AFTER_SPLAT] = "expected an expression after `*` splat in an argument",
142 [PM_ERR_EXPECT_EXPRESSION_AFTER_SPLAT_HASH] = "expected an expression after `**` in a hash",
143 [PM_ERR_EXPECT_EXPRESSION_AFTER_STAR] = "expected an expression after `*`",
144 [PM_ERR_EXPECT_IDENT_REQ_PARAMETER] = "expected an identifier for the required parameter",
145 [PM_ERR_EXPECT_LPAREN_REQ_PARAMETER] = "expected a `(` to start a required parameter",
146 [PM_ERR_EXPECT_RBRACKET] = "expected a matching `]`",
147 [PM_ERR_EXPECT_RPAREN] = "expected a matching `)`",
148 [PM_ERR_EXPECT_RPAREN_AFTER_MULTI] = "expected a `)` after multiple assignment",
149 [PM_ERR_EXPECT_RPAREN_REQ_PARAMETER] = "expected a `)` to end a required parameter",
150 [PM_ERR_EXPECT_STRING_CONTENT] = "expected string content after opening string delimiter",
151 [PM_ERR_EXPECT_WHEN_DELIMITER] = "expected a delimiter after the predicates of a `when` clause",
152 [PM_ERR_EXPRESSION_BARE_HASH] = "unexpected bare hash in expression",
153 [PM_ERR_FOR_COLLECTION] = "expected a collection after the `in` in a `for` statement",
154 [PM_ERR_FOR_INDEX] = "expected an index after `for`",
155 [PM_ERR_FOR_IN] = "expected an `in` after the index in a `for` statement",
156 [PM_ERR_FOR_TERM] = "expected an `end` to close the `for` loop",
157 [PM_ERR_HASH_EXPRESSION_AFTER_LABEL] = "expected an expression after the label in a hash",
158 [PM_ERR_HASH_KEY] = "expected a key in the hash literal",
159 [PM_ERR_HASH_ROCKET] = "expected a `=>` between the hash key and value",
160 [PM_ERR_HASH_TERM] = "expected a `}` to close the hash literal",
161 [PM_ERR_HASH_VALUE] = "expected a value in the hash literal",
162 [PM_ERR_HEREDOC_TERM] = "could not find a terminator for the heredoc",
163 [PM_ERR_INCOMPLETE_QUESTION_MARK] = "incomplete expression at `?`",
164 [PM_ERR_INCOMPLETE_VARIABLE_CLASS] = "incomplete class variable",
165 [PM_ERR_INCOMPLETE_VARIABLE_INSTANCE] = "incomplete instance variable",
166 [PM_ERR_INVALID_ENCODING_MAGIC_COMMENT] = "unknown or invalid encoding in the magic comment",
167 [PM_ERR_INVALID_FLOAT_EXPONENT] = "invalid exponent",
168 [PM_ERR_INVALID_NUMBER_BINARY] = "invalid binary number",
169 [PM_ERR_INVALID_NUMBER_DECIMAL] = "invalid decimal number",
170 [PM_ERR_INVALID_NUMBER_HEXADECIMAL] = "invalid hexadecimal number",
171 [PM_ERR_INVALID_NUMBER_OCTAL] = "invalid octal number",
172 [PM_ERR_INVALID_NUMBER_UNDERSCORE] = "invalid underscore placement in number",
173 [PM_ERR_INVALID_PERCENT] = "invalid `%` token", // TODO WHAT?
174 [PM_ERR_INVALID_TOKEN] = "invalid token", // TODO WHAT?
175 [PM_ERR_INVALID_VARIABLE_GLOBAL] = "invalid global variable",
176 [PM_ERR_LAMBDA_OPEN] = "expected a `do` keyword or a `{` to open the lambda block",
177 [PM_ERR_LAMBDA_TERM_BRACE] = "expected a lambda block beginning with `{` to end with `}`",
178 [PM_ERR_LAMBDA_TERM_END] = "expected a lambda block beginning with `do` to end with `end`",
179 [PM_ERR_LIST_I_LOWER_ELEMENT] = "expected a symbol in a `%i` list",
180 [PM_ERR_LIST_I_LOWER_TERM] = "expected a closing delimiter for the `%i` list",
181 [PM_ERR_LIST_I_UPPER_ELEMENT] = "expected a symbol in a `%I` list",
182 [PM_ERR_LIST_I_UPPER_TERM] = "expected a closing delimiter for the `%I` list",
183 [PM_ERR_LIST_W_LOWER_ELEMENT] = "expected a string in a `%w` list",
184 [PM_ERR_LIST_W_LOWER_TERM] = "expected a closing delimiter for the `%w` list",
185 [PM_ERR_LIST_W_UPPER_ELEMENT] = "expected a string in a `%W` list",
186 [PM_ERR_LIST_W_UPPER_TERM] = "expected a closing delimiter for the `%W` list",
187 [PM_ERR_MALLOC_FAILED] = "failed to allocate memory",
188 [PM_ERR_MIXED_ENCODING] = "UTF-8 mixed within %s source",
189 [PM_ERR_MODULE_IN_METHOD] = "unexpected module definition in a method definition",
190 [PM_ERR_MODULE_NAME] = "expected a constant name after `module`",
191 [PM_ERR_MODULE_TERM] = "expected an `end` to close the `module` statement",
192 [PM_ERR_MULTI_ASSIGN_MULTI_SPLATS] = "multiple splats in multiple assignment",
193 [PM_ERR_NOT_EXPRESSION] = "expected an expression after `not`",
194 [PM_ERR_NUMBER_LITERAL_UNDERSCORE] = "number literal ending with a `_`",
195 [PM_ERR_NUMBERED_PARAMETER_NOT_ALLOWED] = "numbered parameters are not allowed when an ordinary parameter is defined",
196 [PM_ERR_NUMBERED_PARAMETER_OUTER_SCOPE] = "numbered parameter is already used in outer scope",
197 [PM_ERR_OPERATOR_MULTI_ASSIGN] = "unexpected operator for a multiple assignment",
198 [PM_ERR_OPERATOR_WRITE_ARGUMENTS] = "unexpected operator after a call with arguments",
199 [PM_ERR_OPERATOR_WRITE_BLOCK] = "unexpected operator after a call with a block",
200 [PM_ERR_PARAMETER_ASSOC_SPLAT_MULTI] = "unexpected multiple `**` splat parameters",
201 [PM_ERR_PARAMETER_BLOCK_MULTI] = "multiple block parameters; only one block is allowed",
202 [PM_ERR_PARAMETER_CIRCULAR] = "parameter default value references itself",
203 [PM_ERR_PARAMETER_METHOD_NAME] = "unexpected name for a parameter",
204 [PM_ERR_PARAMETER_NAME_REPEAT] = "repeated parameter name",
205 [PM_ERR_PARAMETER_NO_DEFAULT] = "expected a default value for the parameter",
206 [PM_ERR_PARAMETER_NO_DEFAULT_KW] = "expected a default value for the keyword parameter",
207 [PM_ERR_PARAMETER_NUMBERED_RESERVED] = "%.2s is reserved for numbered parameters",
208 [PM_ERR_PARAMETER_ORDER] = "unexpected parameter order",
209 [PM_ERR_PARAMETER_SPLAT_MULTI] = "unexpected multiple `*` splat parameters",
210 [PM_ERR_PARAMETER_STAR] = "unexpected parameter `*`",
211 [PM_ERR_PARAMETER_UNEXPECTED_FWD] = "unexpected `...` in parameters",
212 [PM_ERR_PARAMETER_WILD_LOOSE_COMMA] = "unexpected `,` in parameters",
213 [PM_ERR_PATTERN_EXPRESSION_AFTER_BRACKET] = "expected a pattern expression after the `[` operator",
214 [PM_ERR_PATTERN_EXPRESSION_AFTER_COMMA] = "expected a pattern expression after `,`",
215 [PM_ERR_PATTERN_EXPRESSION_AFTER_HROCKET] = "expected a pattern expression after `=>`",
216 [PM_ERR_PATTERN_EXPRESSION_AFTER_IN] = "expected a pattern expression after the `in` keyword",
217 [PM_ERR_PATTERN_EXPRESSION_AFTER_KEY] = "expected a pattern expression after the key",
218 [PM_ERR_PATTERN_EXPRESSION_AFTER_PAREN] = "expected a pattern expression after the `(` operator",
219 [PM_ERR_PATTERN_EXPRESSION_AFTER_PIN] = "expected a pattern expression after the `^` pin operator",
220 [PM_ERR_PATTERN_EXPRESSION_AFTER_PIPE] = "expected a pattern expression after the `|` operator",
221 [PM_ERR_PATTERN_EXPRESSION_AFTER_RANGE] = "expected a pattern expression after the range operator",
222 [PM_ERR_PATTERN_EXPRESSION_AFTER_REST] = "unexpected pattern expression after the `**` expression",
223 [PM_ERR_PATTERN_HASH_KEY] = "expected a key in the hash pattern",
224 [PM_ERR_PATTERN_HASH_KEY_LABEL] = "expected a label as the key in the hash pattern", // TODO // THIS // AND // ABOVE // IS WEIRD
225 [PM_ERR_PATTERN_IDENT_AFTER_HROCKET] = "expected an identifier after the `=>` operator",
226 [PM_ERR_PATTERN_LABEL_AFTER_COMMA] = "expected a label after the `,` in the hash pattern",
227 [PM_ERR_PATTERN_REST] = "unexpected rest pattern",
228 [PM_ERR_PATTERN_TERM_BRACE] = "expected a `}` to close the pattern expression",
229 [PM_ERR_PATTERN_TERM_BRACKET] = "expected a `]` to close the pattern expression",
230 [PM_ERR_PATTERN_TERM_PAREN] = "expected a `)` to close the pattern expression",
231 [PM_ERR_PIPEPIPEEQ_MULTI_ASSIGN] = "unexpected `||=` in a multiple assignment",
232 [PM_ERR_REGEXP_TERM] = "expected a closing delimiter for the regular expression",
233 [PM_ERR_RESCUE_EXPRESSION] = "expected a rescued expression",
234 [PM_ERR_RESCUE_MODIFIER_VALUE] = "expected a value after the `rescue` modifier",
235 [PM_ERR_RESCUE_TERM] = "expected a closing delimiter for the `rescue` clause",
236 [PM_ERR_RESCUE_VARIABLE] = "expected an exception variable after `=>` in a rescue statement",
237 [PM_ERR_RETURN_INVALID] = "invalid `return` in a class or module body",
238 [PM_ERR_STATEMENT_ALIAS] = "unexpected an `alias` at a non-statement position",
239 [PM_ERR_STATEMENT_POSTEXE_END] = "unexpected an `END` at a non-statement position",
240 [PM_ERR_STATEMENT_PREEXE_BEGIN] = "unexpected a `BEGIN` at a non-statement position",
241 [PM_ERR_STATEMENT_UNDEF] = "unexpected an `undef` at a non-statement position",
242 [PM_ERR_STRING_CONCATENATION] = "expected a string for concatenation",
243 [PM_ERR_STRING_INTERPOLATED_TERM] = "expected a closing delimiter for the interpolated string",
244 [PM_ERR_STRING_LITERAL_TERM] = "expected a closing delimiter for the string literal",
245 [PM_ERR_SYMBOL_INVALID] = "invalid symbol", // TODO expected symbol? prism.c ~9719
246 [PM_ERR_SYMBOL_TERM_DYNAMIC] = "expected a closing delimiter for the dynamic symbol",
247 [PM_ERR_SYMBOL_TERM_INTERPOLATED] = "expected a closing delimiter for the interpolated symbol",
248 [PM_ERR_TERNARY_COLON] = "expected a `:` after the true expression of a ternary operator",
249 [PM_ERR_TERNARY_EXPRESSION_FALSE] = "expected an expression after `:` in the ternary operator",
250 [PM_ERR_TERNARY_EXPRESSION_TRUE] = "expected an expression after `?` in the ternary operator",
251 [PM_ERR_UNDEF_ARGUMENT] = "invalid argument being passed to `undef`; expected a bare word, constant, or symbol argument",
252 [PM_ERR_UNARY_RECEIVER_BANG] = "expected a receiver for unary `!`",
253 [PM_ERR_UNARY_RECEIVER_MINUS] = "expected a receiver for unary `-`",
254 [PM_ERR_UNARY_RECEIVER_PLUS] = "expected a receiver for unary `+`",
255 [PM_ERR_UNARY_RECEIVER_TILDE] = "expected a receiver for unary `~`",
256 [PM_ERR_UNTIL_TERM] = "expected an `end` to close the `until` statement",
257 [PM_ERR_VOID_EXPRESSION] = "unexpected void value expression",
258 [PM_ERR_WHILE_TERM] = "expected an `end` to close the `while` statement",
259 [PM_ERR_WRITE_TARGET_IN_METHOD] = "dynamic constant assignment",
260 [PM_ERR_WRITE_TARGET_READONLY] = "immutable variable as a write target",
261 [PM_ERR_WRITE_TARGET_UNEXPECTED] = "unexpected write target",
262 [PM_ERR_XSTRING_TERM] = "expected a closing delimiter for the `%x` or backtick string",
263 [PM_WARN_AMBIGUOUS_FIRST_ARGUMENT_MINUS] = "ambiguous first argument; put parentheses or a space even after `-` operator",
264 [PM_WARN_AMBIGUOUS_FIRST_ARGUMENT_PLUS] = "ambiguous first argument; put parentheses or a space even after `+` operator",
265 [PM_WARN_AMBIGUOUS_PREFIX_STAR] = "ambiguous `*` has been interpreted as an argument prefix",
266 [PM_WARN_AMBIGUOUS_SLASH] = "ambiguous `/`; wrap regexp in parentheses or add a space after `/` operator",
267 [PM_WARN_END_IN_METHOD] = "END in method; use at_exit",
268};
269
270static const char*
271pm_diagnostic_message(pm_diagnostic_id_t diag_id) {
272 assert(diag_id < PM_DIAGNOSTIC_ID_LEN);
273
274 const char *message = diagnostic_messages[diag_id];
275 assert(message);
276
277 return message;
278}
279
283bool
284pm_diagnostic_list_append(pm_list_t *list, const uint8_t *start, const uint8_t *end, pm_diagnostic_id_t diag_id) {
285 pm_diagnostic_t *diagnostic = (pm_diagnostic_t *) calloc(sizeof(pm_diagnostic_t), 1);
286 if (diagnostic == NULL) return false;
287
288 *diagnostic = (pm_diagnostic_t) {
289 .location = { start, end },
290 .message = pm_diagnostic_message(diag_id),
291 .owned = false
292 };
293
294 pm_list_append(list, (pm_list_node_t *) diagnostic);
295 return true;
296}
297
302bool
303pm_diagnostic_list_append_format(pm_list_t *list, const uint8_t *start, const uint8_t *end, pm_diagnostic_id_t diag_id, ...) {
304 va_list arguments;
305 va_start(arguments, diag_id);
306
307 const char *format = pm_diagnostic_message(diag_id);
308 int result = vsnprintf(NULL, 0, format, arguments);
309 va_end(arguments);
310
311 if (result < 0) {
312 return false;
313 }
314
315 pm_diagnostic_t *diagnostic = (pm_diagnostic_t *) calloc(sizeof(pm_diagnostic_t), 1);
316 if (diagnostic == NULL) {
317 return false;
318 }
319
320 size_t length = (size_t) (result + 1);
321 char *message = (char *) malloc(length);
322 if (message == NULL) {
323 free(diagnostic);
324 return false;
325 }
326
327 va_start(arguments, diag_id);
328 vsnprintf(message, length, format, arguments);
329 va_end(arguments);
330
331 *diagnostic = (pm_diagnostic_t) {
332 .location = { start, end },
333 .message = message,
334 .owned = true
335 };
336
337 pm_list_append(list, (pm_list_node_t *) diagnostic);
338 return true;
339}
340
344void
345pm_diagnostic_list_free(pm_list_t *list) {
346 pm_list_node_t *node, *next;
347
348 for (node = list->head; node != NULL; node = next) {
349 next = node->next;
350 pm_diagnostic_t *diagnostic = (pm_diagnostic_t *) node;
351
352 if (diagnostic->owned) free((void *) diagnostic->message);
353 free(diagnostic);
354 }
355}
diagnostic.h
A list of diagnostics generated during parsing.
pm_diagnostic_id_t
pm_diagnostic_id_t
The diagnostic IDs of all of the diagnostics, used to communicate the types of errors between the par...
Definition diagnostic.h:44
pm_list_node_t
struct pm_list_node pm_list_node_t
This struct represents an abstract linked list that provides common functionality.
pm_diagnostic_t
This struct represents a diagnostic generated during parsing.
Definition diagnostic.h:22
pm_diagnostic_t::message
const char * message
The message associated with the diagnostic.
Definition diagnostic.h:30
pm_diagnostic_t::owned
bool owned
Whether or not the memory related to the message of this diagnostic is owned by this diagnostic.
Definition diagnostic.h:37
pm_list_node::next
struct pm_list_node * next
A pointer to the next node in the list.
Definition pm_list.h:48
pm_list_t
This represents the overall linked list.
Definition pm_list.h:55
pm_list_t::head
pm_list_node_t * head
A pointer to the head of the list.
Definition pm_list.h:60