Cairo Public Interface Methods

When path is a CaString

Path must name the path of the object to fetch. path must be either a relative or absolute path. If CaString is a relative path (does not begin with '/'), the current working path must be prefixed to it by the Cairo Public Interface implementation. An example of an absolute path is /core/classes/HTMLDocument. An example of a relative path is about/company/stats.

When path is a handle

path must be the handle returned by a prior invocation of get(). Handles uniquely identify a resource, and as such, the current working path must not be applied to the handle.

Path is a CaList

Path must contain either all CaStrings or a CaBinary as the first element and CaStrings for the rest of the elements.

Path must already have been split into its individual components. For instance, the path /core/classes/HTMLDocument must become the list [/, core, classes, HTMLDocument]. The type (and value) of the first element of the list determines the behavior that the Cairo Public Interface implementation should take.

If the first element of the list is the CaString /, the list must be viewed as an absolute path. (Cairo Public Interface implementations must remove this leading element before allowing it to be processed by a Natroun driver.) If the first element is any other CaString, the list must be treated as a relative path and must have the current working path prefixed to it by the Cairo Public Interface implementation.

If the first component of the list is not a CaString, it must be a handle from a previous get() operation. The Cairo Public Interface implementation must pass the list unmodified to a Natroun driver.

opts is a dictionary providing a variable number of arguments to the Cairo Public Interface implementation . The table below lists the required options and how they must be supported. If an option is not supplied, the Cairo Public Interface implementation must assume the default value presented below. If the Cairo Public Interface implementation does not understand an option provided in the dictionary, it must ignore it and pass it onto the Natroun drivers.