man m17nPlist () - Property List objects and API for them.
NAME
Property List - Property List objects and API for them.
Typedefs
typedef MPlist MPlist
Type of property list objects.
Functions
MPlist * mplist_deserialize (MText *mt)
Generate a property list by deserializaing an M-text.
MPlist * mplist ()
Create a property list object.
MPlist * mplist_copy (MPlist *plist)
Copy a property list.
MPlist * mplist_put (MPlist *plist, MSymbol key, void *val)
Set the value of a property in a property list.
void * mplist_get (MPlist *plist, MSymbol key)
Get the value of a property in a property list.
MPlist * mplist_add (MPlist *plist, MSymbol key, void *val)
Add a property at the end of a property list.
MPlist * mplist_push (MPlist *plist, MSymbol key, void *val)
Add a property at the beginning of a property list.
void * mplist_pop (MPlist *plist)
Remove a property at the beginning of a property list.
MPlist * mplist_find_by_key (MPlist *plist, MSymbol key)
Find a property of a specific key in a property list.
MPlist * mplist_find_by_value (MPlist *plist, void *val)
Find a property of a specific value in a property list.
MPlist * mplist_next (MPlist *plist)
Return the next sublist of a property list.
MPlist * mplist_set (MPlist *plist, MSymbol key, void *val)
Set the first property in a property list.
int mplist_length (MPlist *plist)
Return the length of a property list.
MSymbol mplist_key (MPlist *plist)
Return the key of the first property in a property list.
void * mplist_value (MPlist *plist)
Return the value of the first property in a property list.
Variables
MSymbol Minteger
Symbol whose name is 'integer'.
MSymbol Mplist
Symbol whose name is 'plist'.
MSymbol Mtext
Symbol whose name is 'mtext'.
Detailed Description
A property list (or plist for short) is a list of zero or more properties. A property consists of a key and a value, where key is a symbol and value is anything that can be cast to (void *).
If the key of a property is a managing key, its value is a managed object. A property list itself is a managed objects.
Typedef Documentation
typedef struct MPlist MPlist
The type MPlist is for a property list object. Its internal structure is concealed from application programs.
Variable Documentation
MSymbol Minteger
The symbol Minteger has the name 'integer'. A value of a property whose key is Minteger must be an integer.
MSymbol Mplist
The symbol Mplist has the name 'plist'. It is a managing key. A value of a property whose key is Mplist must be a plist.
MSymbol Mtext
The symbol Mtext has the name 'mtext'. It is a managing key. A value of a property whose key is Mtext must be an M-text.