Modeler Extensions Framework
|
Functions | |
void | clemext_host_trace (CLEMEXTHostHandle host, const char *text) |
CLEMEXTStatus | clemext_host_createNewDocument (CLEMEXTHostHandle host, const char *root_element_name, CLEMEXTXMLHandle *doc) |
CLEMEXTStatus | clemext_host_createDocumentFromContents (CLEMEXTHostHandle host, const char *contents, CLEMEXTXMLHandle *doc) |
CLEMEXTStatus | clemext_xml_disposeDocument (CLEMEXTXMLHandle doc) |
CLEMEXTStatus | clemext_xml_doc2string (CLEMEXTXMLHandle xml, char *buffer, size_t buffer_size, size_t *data_size) |
CLEMEXTStatus | clemext_xml_getName (CLEMEXTXMLHandle xml, char *buffer, size_t buffer_size, size_t *data_size) |
CLEMEXTStatus | clemext_xml_getAttribute (CLEMEXTXMLHandle xml, const char *name, char *buffer, size_t buffer_size, size_t *data_size) |
CLEMEXTStatus | clemext_xml_hasAttribute (CLEMEXTXMLHandle xml, const char *name, int *result) |
CLEMEXTStatus | clemext_xml_getElementIterator (CLEMEXTXMLHandle xml, const char *name, CLEMEXTXMLIteratorHandle *iterator) |
CLEMEXTStatus | clemext_xml_getTextIterator (CLEMEXTXMLHandle xml, CLEMEXTXMLIteratorHandle *iterator) |
CLEMEXTStatus | clemext_xml_addAttribute (CLEMEXTXMLHandle xml, const char *attribute_name, const char *attribute_value) |
CLEMEXTStatus | clemext_xml_removeAttribute (CLEMEXTXMLHandle xml, const char *attribute_name) |
CLEMEXTStatus | clemext_xml_addText (CLEMEXTXMLHandle xml, const char *data) |
CLEMEXTStatus | clemext_xml_addElement (CLEMEXTXMLHandle xml, const char *element_name, void **new_element) |
CLEMEXTStatus | clemext_xmliterator_hasMoreItems (CLEMEXTXMLIteratorHandle iterator, int *result) |
CLEMEXTStatus | clemext_xmliterator_nextItem (CLEMEXTXMLIteratorHandle iterator, void **item) |
CLEMEXTStatus | clemext_xmliterator_deleteCurrentItem (CLEMEXTXMLIteratorHandle iterator) |
CLEMEXTStatus | clemext_xmliterator_close (CLEMEXTXMLIteratorHandle iterator) |
CLEMEXT_API CLEMEXTStatus | clemext_peer_call (CLEMEXTPeerHandle peer, const char *fnName, void **in_buffers, void ***out_buffers, CLEMEXTErrorCode *errorCode) |
CLEMEXTStatus | clemext_node_attachJVM (CLEMEXTNodeHandle node, void **jni_env, const char *options, CLEMEXTErrorCode *errorCode) |
CLEMEXTStatus | clemext_node_detachJVM (CLEMEXTNodeHandle node, void *jni_env, CLEMEXTErrorCode *errorCode) |
|
inline |
Called by the module to create a new XML document by parsing a string containing the document contents
host | a CLEMEXTHostHandle (as passed to the module by call clemext_initialise) |
contents | the string to parse to obtain the XML document |
doc | reference to an CLEMEXTXMLHandle in which to the root element in the parsed doc @return CLEMEXT status code |
|
inline |
Called by the module to create a new XML document with a root element of the given name and return a pointer to that element
host | a CLEMEXTHostHandle (as passed to the module by call clemext_initialise) |
root_element_name | the name of the root element of the new doc |
doc | reference to an CLEMEXTXMLHandle in which to the root element in the parsed doc @return CLEMEXT status code |
|
inline |
Called by the module to log some text to a tracing file maintained by clementine (enabled by setting "trace_extension, <N>" in config/options.cfg where N>0
host | a CLEMEXTHostHandle (as passed to the module by call clemext_initialise) |
text | a const char * indicating the UTF-8 encoded text to trace |
|
inline |
|
inline |
CLEMEXT_API CLEMEXTStatus clemext_peer_call | ( | CLEMEXTPeerHandle | peer, |
const char * | fnName, | ||
void ** | in_buffers, | ||
void *** | out_buffers, | ||
CLEMEXTErrorCode * | errorCode | ||
) |
|
inline |
|
inline |
|
inline |
|
inline |
Called by the module to dispose and free XML data strucures associated with the associated element
NOTE: can only be executed on a root element returned by a call to either createNewDocument or createDocumentFromContents.
doc | the root element of an XML document represented by its CLEMEXTXMLHandle |
|
inline |
Called by the module to convert an XML document to a string
Note: can only be called on a root element returned by a call to either createNewDocument or createDocumentFromContents.
xml | the root element represented by its CLEMEXTXMLHandle |
buffer | buffer to receive the result |
buffer_size | the current size of the buffer in bytes |
data_size | pointer to a value set to the number of bytes required to store the result in a buffer |
|
inline |
Called by the module to return the value of a named attribute in an XML element
Note: if the named attribute does not exist an emptystring "" value is returned
xml | the element represented by its CLEMEXTXMLHandle |
name | the name of the attribute |
buffer | buffer to receive the result |
buffer_size | the current size of the buffer in bytes |
data_size | pointer to a value set to the number of bytes required to store the result in a buffer |
|
inline |
Called by the module to open an iterator on the child elements of an element with a particular name
xml | the parent element represented by its CLEMEXTXMLHandle |
name | the name of the child elements to iterate over |
iterator | pointer to an iterator handle, on success set to point to the new iterator |
|
inline |
Called by the module to return the name of the XML element
xml | the element represented by its CLEMEXTXMLHandle |
buffer | buffer to receive the result |
buffer_size | the current size of the buffer in bytes |
data_size | pointer to a value set to the number of bytes required to store the result in a buffer |
|
inline |
Called by the module to open an iterator on the character data contained within an element
xml | the parent element represented by its CLEMEXTXMLHandle |
iterator | pointer to an iterator handle, on success set to point to the new iterator |
|
inline |
Called by the module to check whether an element has a named attribute
xml | the element represented by its CLEMEXTXMLHandle |
name | the name of the attribute to test |
result | pointer to an integer which is set to 1 if the attribute is present, 0 otherwise |
|
inline |
|
inline |
|
inline |
Called by the module to delete the last item returned by clemext_xmliterator_nextItem from its parent
iterator | the iterator (pointer to CLEMEXTXMLIterator pointer) |
|
inline |
|
inline |