Module libxml2 :: Class xpathParserContext

[frames] | no frames]

Class xpathParserContext

source code

Instance Methods

[hide private]

__init__(self, _obj=None)

source code

context(self)
Get the xpathContext from an xpathParserContext

source code

xpathAddValues(self)
Implement the add operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

source code

xpathBooleanFunction(self, nargs)
Implement the boolean() XPath function boolean boolean(object) The boolean function converts its argument to a boolean as follows: - a number is true if and only if it is neither positive or negative zero nor NaN - a node-set is true if and only if it is non-empty - a string is true if and only if its length is non-zero

source code

xpathCeilingFunction(self, nargs)
Implement the ceiling() XPath function number ceiling(number) The ceiling function returns the smallest (closest to negative infinity) number that is not less than the argument and that is an integer.

source code

xpathCompareValues(self, inf, strict)
Implement the compare operation on XPath objects: @arg1 < @arg2 (1, 1, ...

source code

xpathConcatFunction(self, nargs)
Implement the concat() XPath function string concat(string, string, string*) The concat function returns the concatenation of its arguments.

source code

xpathContainsFunction(self, nargs)
Implement the contains() XPath function boolean contains(string, string) The contains function returns true if the first argument string contains the second argument string, and otherwise returns false.

source code

xpathCountFunction(self, nargs)
Implement the count() XPath function number count(node-set)

source code

xpathDivValues(self)
Implement the div operation on XPath objects @arg1 / @arg2: The numeric operators convert their operands to numbers as if by calling the number function.

source code

xpathEqualValues(self)
Implement the equal operation on XPath objects content: @arg1 == @arg2

source code

xpathErr(self, error)
Handle an XPath error

source code

xpathEvalExpr(self)
Parse and evaluate an XPath expression in the given context, then push the result on the context stack

source code

xpathFalseFunction(self, nargs)
Implement the false() XPath function boolean false()

source code

xpathFloorFunction(self, nargs)
Implement the floor() XPath function number floor(number) The floor function returns the largest (closest to positive infinity) number that is not greater than the argument and that is an integer.

source code

xpathFreeParserContext(self)
Free up an xmlXPathParserContext

source code

xpathIdFunction(self, nargs)
Implement the id() XPath function node-set id(object) The id function selects elements by their unique ID (see [5.2.1 Unique IDs]).

source code

xpathLangFunction(self, nargs)
Implement the lang() XPath function boolean lang(string) The lang function returns true or false depending on whether the language of the context node as specified by xml:lang attributes is the same as or is a sublanguage of the language specified by the argument string.

source code

xpathLastFunction(self, nargs)
Implement the last() XPath function number last() The last function returns the number of nodes in the context node list.

source code

xpathLocalNameFunction(self, nargs)
Implement the local-name() XPath function string local-name(node-set?) The local-name function returns a string containing the local part of the name of the node in the argument node-set that is first in document order.

source code

xpathModValues(self)
Implement the mod operation on XPath objects: @arg1 / @arg2 The numeric operators convert their operands to numbers as if by calling the number function.

source code

xpathMultValues(self)
Implement the multiply operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

source code

xpathNamespaceURIFunction(self, nargs)
Implement the namespace-uri() XPath function string namespace-uri(node-set?) The namespace-uri function returns a string containing the namespace URI of the expanded name of the node in the argument node-set that is first in document order.

source code

xpathNextAncestor(self, cur)
Traversal function for the "ancestor" direction the ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; the nodes are ordered in reverse document order; thus the parent is the first node on the axis, and the parent's parent is the second node on the axis

source code

xpathNextAncestorOrSelf(self, cur)
Traversal function for the "ancestor-or-self" direction he ancestor-or-self axis contains the context node and ancestors of the context node in reverse document order; thus the context node is the first node on the axis, and the context node's parent the second; parent here is defined the same as with the parent axis.

source code

xpathNextAttribute(self, cur)
Traversal function for the "attribute" direction TODO: support DTD inherited default attributes

source code

xpathNextChild(self, cur)
Traversal function for the "child" direction The child axis contains the children of the context node in document order.

source code

xpathNextDescendant(self, cur)
Traversal function for the "descendant" direction the descendant axis contains the descendants of the context node in document order; a descendant is a child or a child of a child and so on.

source code

xpathNextDescendantOrSelf(self, cur)
Traversal function for the "descendant-or-self" direction the descendant-or-self axis contains the context node and the descendants of the context node in document order; thus the context node is the first node on the axis, and the first child of the context node is the second node on the axis

source code

xpathNextFollowing(self, cur)
Traversal function for the "following" direction The following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes; the nodes are ordered in document order

source code

xpathNextFollowingSibling(self, cur)
Traversal function for the "following-sibling" direction The following-sibling axis contains the following siblings of the context node in document order.

source code

xpathNextNamespace(self, cur)
Traversal function for the "namespace" direction the namespace axis contains the namespace nodes of the context node; the order of nodes on this axis is implementation-defined; the axis will be empty unless the context node is an element We keep the XML namespace node at the end of the list.

source code

xpathNextParent(self, cur)
Traversal function for the "parent" direction The parent axis contains the parent of the context node, if there is one.

source code

xpathNextPreceding(self, cur)
Traversal function for the "preceding" direction the preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes; the nodes are ordered in reverse document order

source code

xpathNextPrecedingSibling(self, cur)
Traversal function for the "preceding-sibling" direction The preceding-sibling axis contains the preceding siblings of the context node in reverse document order; the first preceding sibling is first on the axis; the sibling preceding that node is the second on the axis and so on.

source code

xpathNextSelf(self, cur)
Traversal function for the "self" direction The self axis contains just the context node itself

source code

xpathNormalizeFunction(self, nargs)
Implement the normalize-space() XPath function string normalize-space(string?) The normalize-space function returns the argument string with white space normalized by stripping leading and trailing whitespace and replacing sequences of whitespace characters by a single space.

source code

xpathNotEqualValues(self)
Implement the equal operation on XPath objects content: @arg1 == @arg2

source code

xpathNotFunction(self, nargs)
Implement the not() XPath function boolean not(boolean) The not function returns true if its argument is false, and false otherwise.

source code

xpathNumberFunction(self, nargs)
Implement the number() XPath function number number(object?)

source code

xpathParseNCName(self)
parse an XML namespace non qualified name.

source code

xpathParseName(self)
parse an XML name [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)*

source code

xpathPopBoolean(self)
Pops a boolean from the stack, handling conversion if needed.

source code

xpathPopNumber(self)
Pops a number from the stack, handling conversion if needed.

source code

xpathPopString(self)
Pops a string from the stack, handling conversion if needed.

source code

xpathPositionFunction(self, nargs)
Implement the position() XPath function number position() The position function returns the position of the context node in the context node list.

source code

xpathRoot(self)
Initialize the context to the root of the document

source code

xpathRoundFunction(self, nargs)
Implement the round() XPath function number round(number) The round function returns the number that is closest to the argument and that is an integer.

source code

xpathStartsWithFunction(self, nargs)
Implement the starts-with() XPath function boolean starts-with(string, string) The starts-with function returns true if the first argument string starts with the second argument string, and otherwise returns false.

source code

xpathStringFunction(self, nargs)
Implement the string() XPath function string string(object?) The string function converts an object to a string as follows: - A node-set is converted to a string by returning the value of the node in the node-set that is first in document order.

source code

xpathStringLengthFunction(self, nargs)
Implement the string-length() XPath function number string-length(string?) The string-length returns the number of characters in the string (see [3.6 Strings]).

source code

xpathSubValues(self)
Implement the subtraction operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

source code

xpathSubstringAfterFunction(self, nargs)
Implement the substring-after() XPath function string substring-after(string, string) The substring-after function returns the substring of the first argument string that follows the first occurrence of the second argument string in the first argument string, or the empty stringi if the first argument string does not contain the second argument string.

source code

xpathSubstringBeforeFunction(self, nargs)
Implement the substring-before() XPath function string substring-before(string, string) The substring-before function returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string, or the empty string if the first argument string does not contain the second argument string.

source code

xpathSubstringFunction(self, nargs)
Implement the substring() XPath function string substring(string, number, number?) The substring function returns the substring of the first argument starting at the position specified in the second argument with length specified in the third argument.

source code

xpathSumFunction(self, nargs)
Implement the sum() XPath function number sum(node-set) The sum function returns the sum of the values of the nodes in the argument node-set.

source code

xpathTranslateFunction(self, nargs)
Implement the translate() XPath function string translate(string, string, string) The translate function returns the first argument string with occurrences of characters in the second argument string replaced by the character at the corresponding position in the third argument string.

source code

xpathTrueFunction(self, nargs)
Implement the true() XPath function boolean true()

source code

xpathValueFlipSign(self)
Implement the unary - operation on an XPath object The numeric operators convert their operands to numbers as if by calling the number function.

source code

xpatherror(self, file, line, no)
Formats an error message.

source code

xpointerEvalRangePredicate(self)
[8] Predicate ::= '[' PredicateExpr ']' [9] PredicateExpr ::= Expr Evaluate a predicate as in xmlXPathEvalPredicate() but for a Location Set instead of a node set

source code

xpointerRangeToFunction(self, nargs)
Implement the range-to() XPointer function

source code

Method Details

[hide private]

xpathCompareValues(self, inf, strict)

source code

Implement the compare operation on XPath objects: @arg1 < @arg2 (1, 1, ... @arg1 <= @arg2 (1, 0, ... @arg1 > @arg2 (0, 1, ... @arg1 >= @arg2 (0, 0, ... When neither object to be compared is a node-set and the operator is <=, <, >=, >, then the objects are compared by converted both objects to numbers and comparing the numbers according to IEEE 754. The < comparison will be true if and only if the first number is less than the second number. The <= comparison will be true if and only if the first number is less than or equal to the second number. The > comparison will be true if and only if the first number is greater than the second number. The >= comparison will be true if and only if the first number is greater than or equal to the second number.

xpathIdFunction(self, nargs)

source code

Implement the id() XPath function node-set id(object) The id function selects elements by their unique ID (see [5.2.1 Unique IDs]). When the argument to id is of type node-set, then the result is the union of the result of applying id to the string value of each of the nodes in the argument node-set. When the argument to id is of any other type, the argument is converted to a string as if by a call to the string function; the string is split into a whitespace-separated list of tokens (whitespace is any sequence of characters matching the production S); the result is a node-set containing the elements in the same document as the context node that have a unique ID equal to any of the tokens in the list.

xpathLangFunction(self, nargs)

source code

Implement the lang() XPath function boolean lang(string) The lang function returns true or false depending on whether the language of the context node as specified by xml:lang attributes is the same as or is a sublanguage of the language specified by the argument string. The language of the context node is determined by the value of the xml:lang attribute on the context node, or, if the context node has no xml:lang attribute, by the value of the xml:lang attribute on the nearest ancestor of the context node that has an xml:lang attribute. If there is no such attribute, then lang

xpathLocalNameFunction(self, nargs)

source code

Implement the local-name() XPath function string local-name(node-set?) The local-name function returns a string containing the local part of the name of the node in the argument node-set that is first in document order. If the node-set is empty or the first node has no name, an empty string is returned. If the argument is omitted it defaults to the context node.

xpathNamespaceURIFunction(self, nargs)

source code

Implement the namespace-uri() XPath function string namespace-uri(node-set?) The namespace-uri function returns a string containing the namespace URI of the expanded name of the node in the argument node-set that is first in document order. If the node-set is empty, the first node has no name, or the expanded name has no namespace URI, an empty string is returned. If the argument is omitted it defaults to the context node.

xpathNormalizeFunction(self, nargs)

source code

Implement the normalize-space() XPath function string normalize-space(string?) The normalize-space function returns the argument string with white space normalized by stripping leading and trailing whitespace and replacing sequences of whitespace characters by a single space. Whitespace characters are the same allowed by the S production in XML. If the argument is omitted, it defaults to the context node converted to a string, in other words the value of the context node.

xpathParseNCName(self)

source code

xpathPopBoolean(self)

source code

Pops a boolean from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

xpathPopNumber(self)

source code

Pops a number from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

xpathPopString(self)

source code

Pops a string from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

xpathPositionFunction(self, nargs)

source code

Implement the position() XPath function number position() The position function returns the position of the context node in the context node list. The first position is 1, and so the last position will be equal to last().

xpathRoundFunction(self, nargs)

source code

Implement the round() XPath function number round(number) The round function returns the number that is closest to the argument and that is an integer. If there are two such numbers, then the one that is even is returned.

xpathStringFunction(self, nargs)

source code

Implement the string() XPath function string string(object?) The string function converts an object to a string as follows: - A node-set is converted to a string by returning the value of the node in the node-set that is first in document order. If the node-set is empty, an empty string is returned. - A number is converted to a string as follows + NaN is converted to the string NaN + positive zero is converted to the string 0 + negative zero is converted to the string 0 + positive infinity is converted to the string Infinity + negative infinity is converted to the string -Infinity + if the number is an integer, the number is represented in decimal form as a Number with no decimal point and no leading zeros, preceded by a minus sign (-) if the number is negative + otherwise, the number is represented in decimal form as a Number including a decimal point with at least one digit before the decimal point and at least one digit after the decimal point, preceded by a minus sign (-) if the number is negative; there must be no leading zeros before the decimal point apart possibly from the one required digit immediately before the decimal point; beyond the one required digit after the decimal point there must be as many, but only as many, more digits as are needed to uniquely distinguish the number from all other IEEE 754 numeric values. - The boolean false value is converted to the string false. The boolean true value is converted to the string true. If the argument is omitted, it defaults to a node-set with the context node as its only member.

xpathStringLengthFunction(self, nargs)

source code

Implement the string-length() XPath function number string-length(string?) The string-length returns the number of characters in the string (see [3.6 Strings]). If the argument is omitted, it defaults to the context node converted to a string, in other words the value of the context node.

xpathSubstringAfterFunction(self, nargs)

source code

Implement the substring-after() XPath function string substring-after(string, string) The substring-after function returns the substring of the first argument string that follows the first occurrence of the second argument string in the first argument string, or the empty stringi if the first argument string does not contain the second argument string. For example, substring-after("1999/04/01","/") returns 04/01, and substring-after("1999/04/01","19") returns 99/04/01.

xpathSubstringBeforeFunction(self, nargs)

source code

Implement the substring-before() XPath function string substring-before(string, string) The substring-before function returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string, or the empty string if the first argument string does not contain the second argument string. For example, substring-before("1999/04/01","/") returns 1999.

xpathSubstringFunction(self, nargs)

source code

Implement the substring() XPath function string substring(string, number, number?) The substring function returns the substring of the first argument starting at the position specified in the second argument with length specified in the third argument. For example, substring("12345",2,3) returns "234". If the third argument is not specified, it returns the substring starting at the position specified in the second argument and continuing to the end of the string. For example, substring("12345",2) returns "2345". More precisely, each character in the string (see [3.6 Strings]) is considered to have a numeric position: the position of the first character is 1, the position of the second character is 2 and so on. The returned substring contains those characters for which the position of the character is greater than or equal to the second argument and, if the third argument is specified, less than the sum of the second and third arguments; the comparisons and addition used for the above follow the standard IEEE 754 rules. Thus: - substring("12345", 1.5, 2.6) returns "234" - substring("12345", 0, 3) returns "12" - substring("12345", 0 div 0, 3) returns "" - substring("12345", 1, 0 div 0) returns "" - substring("12345", -42, 1 div 0) returns "12345" - substring("12345", -1 div 0, 1 div 0) returns ""

xpathTranslateFunction(self, nargs)

source code

Implement the translate() XPath function string translate(string, string, string) The translate function returns the first argument string with occurrences of characters in the second argument string replaced by the character at the corresponding position in the third argument string. For example, translate("bar","abc","ABC") returns the string BAr. If there is a character in the second argument string with no character at a corresponding position in the third argument string (because the second argument string is longer than the third argument string), then occurrences of that character in the first argument string are removed. For example, translate("--aaa--","abc-","ABC")