Vuo  2.3.2
Classes | Macros | Functions
VuoTree.h File Reference

Description

VuoTree C type definition.

Definition in file VuoTree.h.

Go to the source code of this file.

Classes

struct  VuoList_VuoTree_struct
 List type. More...
 
struct  VuoTree
 Hierarchically structured information. More...
 

Macros

#define VuoTree_REQUIRES_INTERPROCESS_JSON
 This type has a _getInterprocessJson() function. More...
 

Functions

VuoTree VuoTree_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoTree_getJson (const VuoTree value)
 Encodes value as a JSON object that can only be decoded in the same process. More...
 
struct json_objectVuoTree_getInterprocessJson (const VuoTree value)
 Encodes value as a JSON object that can be decoded in a separate process. More...
 
char * VuoTree_getSummary (const VuoTree value)
 Returns a human-readable description of value. More...
 
VuoTree VuoTree_makeEmpty (void)
 Returns a tree with nothing in it. More...
 
VuoTree VuoTree_make (VuoText name, VuoDictionary_VuoText_VuoText attributes, VuoText content, VuoList_VuoTree children)
 Returns a tree that consists of the given components. More...
 
VuoTree VuoTree_makeFromJsonText (VuoText json)
 Returns a tree parsed from json. More...
 
VuoTree VuoTree_makeFromXmlText (VuoText xml, bool includeWhitespace)
 Returns a tree parsed from xml. More...
 
VuoText VuoTree_serializeAsXml (VuoTree tree, bool indent)
 Returns an XML-formatted string representation of a tree. More...
 
VuoText VuoTree_serializeAsJson (VuoTree tree, bool indent)
 Returns an JSON-formatted string representation of a tree. More...
 
void VuoTree_retain (VuoTree value)
 Replaces the auto-generated function. More...
 
void VuoTree_release (VuoTree value)
 Replaces the auto-generated function. More...
 
VuoText VuoTree_getName (VuoTree tree)
 Returns the name of the tree's root item. More...
 
VuoDictionary_VuoText_VuoText VuoTree_getAttributes (VuoTree tree)
 Returns the attributes of the tree's root item. More...
 
VuoText VuoTree_getAttribute (VuoTree tree, VuoText attribute)
 Returns the value of the attribute with the given name in the tree's root item, or an empty text if not found. More...
 
VuoText VuoTree_getContent (VuoTree tree, bool includeDescendants)
 Returns the content of the tree's root item and, optionally, of its descendants. More...
 
VuoList_VuoTree VuoTree_getChildren (VuoTree tree)
 Returns a list of the subtrees that are direct descendants of the tree's root item. More...
 
struct json_objectVuoTree_getContainedValue (VuoTree tree)
 Interprets the content and children of the tree as a JSON representation of a Vuo data type value. More...
 
VuoList_VuoTree VuoTree_findItemsUsingXpath (VuoTree tree, VuoText xpath)
 Returns the subtrees found by searching tree with XPath expression xpath, or an empty list if there's an error. More...
 
VuoList_VuoTree VuoTree_findItemsWithName (VuoTree tree, VuoText name, VuoTextComparison comparison, bool includeDescendants)
 Searches tree for subtrees whose name matches name. More...
 
VuoList_VuoTree VuoTree_findItemsWithAttribute (VuoTree tree, VuoText attribute, VuoText value, VuoTextComparison valueComparison, bool includeDescendants)
 Searches tree for subtrees that have an attribute called attribute (exact match) and its value matches value (based on valueComparison). More...
 
VuoList_VuoTree VuoTree_findItemsWithContent (VuoTree tree, VuoText content, VuoTextComparison comparison, bool includeDescendants)
 Searches tree for subtrees whose content matches name. More...
 
VuoTree VuoTree_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoTree_getString (const VuoTree value)
 Automatically generated function. More...
 
char * VuoTree_getInterprocessString (const VuoTree value)
 Automatically generated function. More...
 
#define VuoList_VuoTree_TYPE_DEFINED
 List type. More...
 
typedef const struct VuoList_VuoTree_structVuoList_VuoTree
 List type. More...
 

Macro Definition Documentation

◆ VuoList_VuoTree_TYPE_DEFINED

#define VuoList_VuoTree_TYPE_DEFINED

List type.

Definition at line 16 of file VuoTree.h.

Typedef Documentation

◆ VuoList_VuoTree

typedef const struct VuoList_VuoTree_struct * VuoList_VuoTree

List type.