libaegis/change/attributes.h File Reference

#include <libaegis/change.h>

Go to the source code of this file.

Functions
void	change_attributes_default (cattr_ty *, project_ty *, struct pconf_ty *)
void	change_attributes_copy (struct cattr_ty *, cstate_ty *)
void	change_attributes_verify (string_ty *, cattr_ty *)
void	change_attributes_edit (cattr_ty **, int)
void	change_attributes_append (cstate_ty *cs, const char *name, const char *value)
string_ty *	change_attributes_find (change::pointer cp, string_ty *name)
bool	change_attributes_find_boolean (change::pointer cp, const char *name, bool default_value=false)
void	change_attributes_fixup (cattr_ty *cap)

---

Function Documentation

void change_attributes_append	(	cstate_ty *	cs,
		const char *	name,
		const char *	value
	)

The change_attributes_append function is used to append an attribute to the change's list of attributes. Note this this allow duplicates.

Parameters:

	cs	The chage state to work on.
	name	The name of the attribute, case insensitive. (names atrting with a lower-case letter do not appear in listings)
	value	The value to assign to the attribute.

void change_attributes_copy	(	struct cattr_ty *	,
		cstate_ty *
	)

void change_attributes_default	(	cattr_ty *	,
		project_ty *	,
		struct pconf_ty *
	)

void change_attributes_edit	(	cattr_ty **	,
		int
	)

string_ty* change_attributes_find	(	change::pointer	cp,
		string_ty *	name
	)

The change_attributes_find function is used to find a specific named attribute amongst the given change's attributes. Only the first such attribute is returned.

Parameters:

	cp	The change to be searched.
	name	The name of the attribute to search for.

Returns:

The value of the given attribute, or NULL if not found.

bool change_attributes_find_boolean	(	change::pointer	cp,
		const char *	name,
		bool	default_value = false
	)

The change_attributes_find_boolean function is used to find a specific named attribute amongst the given change's attributes. Only the first such attribute is returned.

Parameters:

	cp	The change to be searched.
	name	The name of the attribute to search for.
	default_value	The default value of the attribute is not present.

Returns:

bool; the value of the attribute interpreted as a boolean (it understands, "yes", "no", "true" and "false"), or the default value if not set or undeciperable.

void change_attributes_fixup

(

cattr_ty *

cap

)

The change_attributes_fixup function is used to trim description and brief description fields. Only cosmetic changes are allowed.

Parameters:

cap

The change attributes in question.

void change_attributes_verify	(	string_ty *	,
		cattr_ty *
	)