pm_newline_list.h File Reference

A list of byte offsets of newlines in a string. More...

#include "prism/defines.h"
#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdlib.h>

Include dependency graph for pm_newline_list.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pm_newline_list_t
	A list of offsets of newlines in a string. More...
struct	pm_line_column_t
	A line and column in a string. More...

Functions
bool	pm_newline_list_init (pm_newline_list_t *list, const uint8_t *start, size_t capacity)
	Initialize a new newline list with the given capacity.
void	pm_newline_list_clear (pm_newline_list_t *list)
	Clear out the newlines that have been appended to the list.
bool	pm_newline_list_append (pm_newline_list_t *list, const uint8_t *cursor)
	Append a new offset to the newline list.
int32_t	pm_newline_list_line (const pm_newline_list_t *list, const uint8_t *cursor, int32_t start_line)
	Returns the line of the given offset.
pm_line_column_t	pm_newline_list_line_column (const pm_newline_list_t *list, const uint8_t *cursor, int32_t start_line)
	Returns the line and column of the given offset.
void	pm_newline_list_free (pm_newline_list_t *list)
	Free the internal memory allocated for the newline list.

Detailed Description

A list of byte offsets of newlines in a string.

When compiling the syntax tree, it's necessary to know the line and column of many nodes. This is necessary to support things like error messages, tracepoints, etc.

It's possible that we could store the start line, start column, end line, and end column on every node in addition to the offsets that we already store, but that would be quite a lot of memory overhead.

Function Documentation

pm_newline_list_init()

bool pm_newline_list_init	(	pm_newline_list_t *	list,
		const uint8_t *	start,
		size_t	capacity
	)

Initialize a new newline list with the given capacity.

Returns true if the allocation of the offsets succeeds, otherwise returns false.

Parameters

list	The list to initialize.
start	A pointer to the start of the source string.
capacity	The initial capacity of the list.

Returns

True if the allocation of the offsets succeeds, otherwise false.

Returns true if the allocation of the offsets succeeds, otherwise returns false.

pm_newline_list_clear()

void pm_newline_list_clear

(

pm_newline_list_t *

list

)

Clear out the newlines that have been appended to the list.

Parameters

list	The list to clear.

pm_newline_list_append()

bool pm_newline_list_append	(	pm_newline_list_t *	list,
		const uint8_t *	cursor
	)

Append a new offset to the newline list.

Returns true if the reallocation of the offsets succeeds (if one was necessary), otherwise returns false.

Parameters

list	The list to append to.
cursor	A pointer to the offset to append.

Returns

True if the reallocation of the offsets succeeds (if one was necessary), otherwise false.

Returns true if the reallocation of the offsets succeeds (if one was necessary), otherwise returns false.

pm_newline_list_line()

int32_t pm_newline_list_line	(	const pm_newline_list_t *	list,
		const uint8_t *	cursor,
		int32_t	start_line
	)

Returns the line of the given offset.

If the offset is not in the list, the line of the closest offset less than the given offset is returned.

Parameters

list	The list to search.
cursor	A pointer to the offset to search for.
start_line	The line to start counting from.

Returns

The line of the given offset.

If the offset is not in the list, the line of the closest offset less than the given offset is returned.

pm_newline_list_line_column()

pm_line_column_t pm_newline_list_line_column	(	const pm_newline_list_t *	list,
		const uint8_t *	cursor,
		int32_t	start_line
	)

Returns the line and column of the given offset.

If the offset is not in the list, the line and column of the closest offset less than the given offset are returned.

Parameters

list	The list to search.
cursor	A pointer to the offset to search for.
start_line	The line to start counting from.

Returns

The line and column of the given offset.

If the offset is not in the list, the line and column of the closest offset less than the given offset are returned.

pm_newline_list_free()

void pm_newline_list_free

(

pm_newline_list_t *

list

)

Free the internal memory allocated for the newline list.

Parameters

list	The list to free.