5.8.4 Caret

typedef struct SerdCaretImpl SerdCaret

The origin of a statement in a text document.

SerdCaret *serd_caret_new(SerdAllocator *allocator, const SerdNode *name, unsigned line, unsigned col)

Create a new caret.

Note that, to minimise model overhead, the caret does not own the name node, so name must have a longer lifetime than the caret for it to be valid. That is, serd_caret_name() will return exactly the pointer name, not a copy.

Parameters

  • allocator – Allocator to use for caret memory.

  • name – The name of the document or stream (usually a file URI)

  • line – The line number in the document (1-based)

  • col – The column number in the document (1-based)

Returns

A new caret that must be freed with serd_caret_free()

SerdCaret *serd_caret_copy(SerdAllocator *allocator, const SerdCaret *caret)

Return a copy of caret

void serd_caret_free(SerdAllocator *allocator, SerdCaret *caret)

Free caret

bool serd_caret_equals(const SerdCaret *lhs, const SerdCaret *rhs)

Return true iff lhs is equal to rhs

const SerdNode *serd_caret_name(const SerdCaret *caret)

Return the document name.

This is typically a file URI, but may be a descriptive string node for statements that originate from streams.

unsigned serd_caret_line(const SerdCaret *caret)

Return the one-relative line number in the document.

unsigned serd_caret_column(const SerdCaret *caret)

Return the zero-relative column number in the line.