Internal helpers for custom attribute operations on ojson nodes. More...

#include <jsoncons/json.hpp>
#include <string>
#include "fdl/fdl_core.h"
#include "fdl_constants.h"

Typedefs
using	fdl::detail::custom_attr::ojson = jsoncons::ojson
	Alias for ordered JSON type.

Functions
std::string	fdl::detail::custom_attr::make_key (const char *name)
	Build the internal key by prepending '_' to the user-visible name.

bool	fdl::detail::custom_attr::has (const ojson node, const char name)
	Check if a custom attribute exists on a node.

fdl_custom_attr_type_t	fdl::detail::custom_attr::get_type (const ojson node, const char name)
	Get the type of a custom attribute.

int	fdl::detail::custom_attr::set_string (ojson node, const char name, const char *value)
	Set a string custom attribute.

int	fdl::detail::custom_attr::set_int (ojson node, const char name, int64_t value)
	Set an integer custom attribute.

int	fdl::detail::custom_attr::set_float (ojson node, const char name, double value)
	Set a floating-point custom attribute.

int	fdl::detail::custom_attr::set_bool (ojson node, const char name, int value)
	Set a boolean custom attribute.

const char *	fdl::detail::custom_attr::get_string (const ojson node, const char name)
	Get a string custom attribute.

int	fdl::detail::custom_attr::get_int (const ojson node, const char name, int64_t *out)
	Get an integer custom attribute.

int	fdl::detail::custom_attr::get_float (const ojson node, const char name, double *out)
	Get a floating-point custom attribute.

int	fdl::detail::custom_attr::get_bool (const ojson node, const char name, int *out)
	Get a boolean custom attribute.

int	fdl::detail::custom_attr::set_point_f64 (ojson node, const char name, double x, double y)
	Set a point_f64 custom attribute.

int	fdl::detail::custom_attr::get_point_f64 (const ojson node, const char name, double x, double y)
	Get a point_f64 custom attribute.

int	fdl::detail::custom_attr::set_dims_f64 (ojson node, const char name, double width, double height)
	Set a dims_f64 custom attribute.

int	fdl::detail::custom_attr::get_dims_f64 (const ojson node, const char name, double width, double height)
	Get a dims_f64 custom attribute.

int	fdl::detail::custom_attr::set_dims_i64 (ojson node, const char name, int64_t width, int64_t height)
	Set a dims_i64 custom attribute.

int	fdl::detail::custom_attr::get_dims_i64 (const ojson node, const char name, int64_t width, int64_t height)
	Get a dims_i64 custom attribute.

int	fdl::detail::custom_attr::remove (ojson node, const char name)
	Remove a custom attribute.

uint32_t	fdl::detail::custom_attr::count (const ojson *node)
	Count the number of custom attributes on a node.

const char *	fdl::detail::custom_attr::name_at (const ojson *node, uint32_t index)
	Get the name of a custom attribute by index.

Detailed Description

Internal helpers for custom attribute operations on ojson nodes.

Custom attributes are user-defined keys prefixed with '_' in the FDL JSON. Users pass attribute names without the prefix; the library prepends it internally. All functions operate on a single ojson node (the target object) and are called from the C ABI wrappers with the document mutex held.

Function Documentation

◆ make_key()

std::string fdl::detail::custom_attr::make_key ( const char * name )

Build the internal key by prepending '_' to the user-visible name.

Parameters

name	User-visible attribute name (without '_' prefix).

Returns: Internal key string (e.g., "_vendor" for "vendor").

◆ has()

bool fdl::detail::custom_attr::has	(	const ojson *	node,
		const char *	name
	)

Check if a custom attribute exists on a node.

Parameters

node	Target JSON node.
name	User-visible attribute name.

Returns: True if the '_'-prefixed key exists.

◆ get_type()

fdl_custom_attr_type_t fdl::detail::custom_attr::get_type	(	const ojson *	node,
		const char *	name
	)

Get the type of a custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.

Returns: One of FDL_CUSTOM_ATTR_TYPE_* constants.

◆ set_string()

int fdl::detail::custom_attr::set_string	(	ojson *	node,
		const char *	name,
		const char *	value
	)

Set a string custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
value	String value to set.

Returns: 0 on success, -1 on type mismatch.

◆ set_int()

int fdl::detail::custom_attr::set_int	(	ojson *	node,
		const char *	name,
		int64_t	value
	)

Set an integer custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
value	Integer value to set.

Returns: 0 on success, -1 on type mismatch.

◆ set_float()

int fdl::detail::custom_attr::set_float	(	ojson *	node,
		const char *	name,
		double	value
	)

Set a floating-point custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
value	Double value to set.

Returns: 0 on success, -1 on type mismatch.

◆ set_bool()

int fdl::detail::custom_attr::set_bool	(	ojson *	node,
		const char *	name,
		int	value
	)

Set a boolean custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
value	Boolean value (non-zero = true, zero = false).

Returns: 0 on success, -1 on type mismatch.

◆ get_string()

const char * fdl::detail::custom_attr::get_string	(	const ojson *	node,
		const char *	name
	)

Get a string custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.

Returns: Thread-local C string pointer, or nullptr if absent or wrong type.

◆ get_int()

int fdl::detail::custom_attr::get_int	(	const ojson *	node,
		const char *	name,
		int64_t *	out
	)

Get an integer custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.
out	Output pointer for the integer value.

Returns: 0 on success, -1 if absent or wrong type.

◆ get_float()

int fdl::detail::custom_attr::get_float	(	const ojson *	node,
		const char *	name,
		double *	out
	)

Get a floating-point custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.
out	Output pointer for the double value.

Returns: 0 on success, -1 if absent or wrong type.

◆ get_bool()

int fdl::detail::custom_attr::get_bool	(	const ojson *	node,
		const char *	name,
		int *	out
	)

Get a boolean custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.
out	Output pointer for the boolean value (FDL_TRUE or FDL_FALSE).

Returns: 0 on success, -1 if absent or wrong type.

◆ set_point_f64()

int fdl::detail::custom_attr::set_point_f64	(	ojson *	node,
		const char *	name,
		double	x,
		double	y
	)

Set a point_f64 custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
x	X coordinate.
y	Y coordinate.

Returns: 0 on success, -1 on type mismatch.

◆ get_point_f64()

int fdl::detail::custom_attr::get_point_f64	(	const ojson *	node,
		const char *	name,
		double *	x,
		double *	y
	)

Get a point_f64 custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.
x	Output pointer for X coordinate.
y	Output pointer for Y coordinate.

Returns: 0 on success, -1 if absent or wrong type.

◆ set_dims_f64()

int fdl::detail::custom_attr::set_dims_f64	(	ojson *	node,
		const char *	name,
		double	width,
		double	height
	)

Set a dims_f64 custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
width	Width value.
height	Height value.

Returns: 0 on success, -1 on type mismatch.

◆ get_dims_f64()

int fdl::detail::custom_attr::get_dims_f64	(	const ojson *	node,
		const char *	name,
		double *	width,
		double *	height
	)

Get a dims_f64 custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.
width	Output pointer for width.
height	Output pointer for height.

Returns: 0 on success, -1 if absent or wrong type.

◆ set_dims_i64()

int fdl::detail::custom_attr::set_dims_i64	(	ojson *	node,
		const char *	name,
		int64_t	width,
		int64_t	height
	)

Set a dims_i64 custom attribute.

Fails if the key exists with a different type.

Parameters

node	Target JSON node.
name	User-visible attribute name.
width	Width value.
height	Height value.

Returns: 0 on success, -1 on type mismatch.

◆ get_dims_i64()

int fdl::detail::custom_attr::get_dims_i64	(	const ojson *	node,
		const char *	name,
		int64_t *	width,
		int64_t *	height
	)

Get a dims_i64 custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.
width	Output pointer for width.
height	Output pointer for height.

Returns: 0 on success, -1 if absent or wrong type.

◆ remove()

int fdl::detail::custom_attr::remove	(	ojson *	node,
		const char *	name
	)

Remove a custom attribute.

Parameters

node	Target JSON node.
name	User-visible attribute name.

Returns: 0 if removed, -1 if not found.

◆ count()

uint32_t fdl::detail::custom_attr::count ( const ojson * node )

Count the number of custom attributes on a node.

Parameters

node	Target JSON node.

Returns: Number of '_'-prefixed keys.

◆ name_at()

const char * fdl::detail::custom_attr::name_at	(	const ojson *	node,
		uint32_t	index
	)

Get the name of a custom attribute by index.

Returns names without the '_' prefix. The index refers to the order among custom attributes only (not all keys).

Parameters

node	Target JSON node.
index	Zero-based index among custom attributes.

Returns: Thread-local C string pointer, or nullptr if index is out of range.

Typedefs

Functions

Detailed Description

Function Documentation

◆ make_key()

◆ has()

◆ get_type()

◆ set_string()

◆ set_int()

◆ set_float()

◆ set_bool()

◆ get_string()

◆ get_int()

◆ get_float()

◆ get_bool()

◆ set_point_f64()

◆ get_point_f64()

◆ set_dims_f64()

◆ get_dims_f64()

◆ set_dims_i64()

◆ get_dims_i64()

◆ remove()

◆ count()

◆ name_at()