The xml.location Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The xml.location Reference Manual

This is the xml.location Reference Manual, version 0.2.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:31:58 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

#+TITLE:  xml.location README
#+AUTHOR: Jan Moringen
#+EMAIL:  jmoringe@techfak.uni-bielefeld.de

* Introduction
  The =xml.location= system provides manipulation of and a conversion
  mechanisms for XML data:
  + Typed, XPath-based location bindings
  + Extensible Lisp -> XML and XML -> Lisp conversion
  + Creation of XPath-specified XML structures
  + Automatic compile-time parsing of XML documents and XPaths

  This means, when working with an XML document
#+BEGIN_SRC xml
old text
#+END_SRC
we can write
#+BEGIN_SRC lisp
(let ((document (cxml:parse "old text" (stp:make-builder))))
  (with-locations (((:name name)                          "node()")
                   (text                                  "node()/text()")
                   ((:@ (foo "foo") :type '(list number)) "node()"))       document
    (setf text "new text"
          foo  '(4 5))
    (values name text foo (stp:serialize document (cxml:make-string-sink)))))
=>
(values
 "root"
 "new text"
 (4 5)
 "
new text")
#+END_SRC
* Tutorial
  The simplest case of using =xml.location= looks like this:
#+BEGIN_SRC lisp -n
(let ((loc (xml.location:loc "bar baz" "node()")))
  (values
   (xml.location:name loc)
   (xml.location:@    loc "a" :type 'integer)
   (xml.location:@    loc "b" :type '(list symbol))))
=> (values "foo" 1 (C D))
#+END_SRC
  The first line uses the =xml.location:loc= function to construct a
  =xml.location:location= object for the document ~bar baz~ and the XPath =node()=. In lines 3 -5, the
  following things are extracted and returned as Lisp objects:
  1. the name of the root node (using the =xml.location:name=
     accessor)
  2. the value of the attribute "a", interpreted as =integer= (using
     the =xml.location:@= attribute accessor)
  3. the value of the attribute "b", interpreted as =list= of =symbol=
     s

  The accessors =xml.location:name=, =xml.location:@= and
  =xml.location:val= are =setf= able places:
#+BEGIN_SRC lisp
  (let ((loc (xml.location:loc "" "node()[@pred-attr='baz']"
                                :if-no-match :create)))
    (setf (xml.location:@ loc "old-attr" :type 'number) 2
          (xml.location:@ loc "new-attr")               "foo")
    loc)
  => #<(LOCATION 3 MIXINS) node()[@pred-attr='baz'] in  {FAC7D81}>
#+END_SRC
  Note how =:if-no-match :create= causes specified locations to be
  created if they do not exist already --- including things specified
  in form of predicates in some cases.

  In both previous examples, a single =xml.location:location= object
  was used multiple times. Such cases can be simplified using the
  =xml.location:with-locations-r/o= and =xml.location:with-locations=
  macros. The former binds variables to values extracted from XML
  locations while the latter uses symbol macros to make XML locations
  =setf= able places:
#+BEGIN_SRC lisp
(xml.location:with-locations
    (((:name name)                             "node()")
     (text                                     "bla/text()")
     ((:@ (my-foo "foo") :type '(list number)) "node()")
     ((:@ bar)                                 "node()"))
    "foo"
  ;; Set values of generalized variables
  (setf name   "frooble"
        my-foo '(5 6)
        bar    42
        text   "bubba")

  ;; Extract values from generalized variables
  (values name my-foo bar text))
=> (values "frooble" (5 6) "42" "bubba")
#+END_SRC
* TODO Namespaces
* Conversion Infrastructure
  The core of the conversion infrastructure consists of two
  operations:
  + Lisp -> XML conversion
  + XML -> Lisp conversion
  Actually, there are several details which lead to a greater number
  of conversions, but all of these are special cases of the
  aforementioned two conversions.
** TODO Lisp to XML conversion
** TODO XML to Lisp conversion
** Adding Conversions
   There are several possible ways to define to/from XML conversion
   methods for a type:
   1. Types that have obvious string representations
   2. Types that require a structured representation
   3. Types that require a structured representation and have internal
      structure that can be represented in several different ways
   Types of the first kind often work without the definition of
   additional methods since the default behavior for to/from string
   conversion uses =read= and =print= which is often sufficient.

   For the second kind of type, at least the following two methods
   have to be defined:
#+BEGIN_SRC lisp
  (defmethod ->xml ((value MY-TYPE)
                    (dest  stp:element)
                    (type  t))
    "Store VALUE in XML element DEST."
    ;; actual conversion code
    )

  (defmethod xml-> ((value stp:element)
                    (type  'MY-TYPE))
    "Retrieve an instance of MY-TYPE from the XML element VALUE."
    ;; actual conversion code
    )
#+END_SRC

* TODO Reference


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 xml.location

Maintainer

Jan Moringen <jmoringe@techfak.uni-bielefeld.de>

Author

Jan Moringen <jmoringe@techfak.uni-bielefeld.de>

License

LLGPLv3

Description

This system provides a convenient interface for manipulating XML data. It is inspired by the xmltio library.

Version

0.2.0

Dependencies
Source

xml.location.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 xml.location/src

Dependency

compat.lisp (file)

Parent

xml.location (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 xml.location.asd

Location

xml.location.asd

Systems

xml.location (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 xml.location/compat.lisp

Parent

xml.location (system)

Location

src/compat.lisp

Packages

xml.location.compat

Exported Definitions

define-dynamic-class-family (macro)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 xml.location/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

xml.location


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 xml.location/src/types.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/types.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 xml.location/src/conditions.lisp

Dependency

types.lisp (file)

Parent

src (module)

Location

src/conditions.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 xml.location/src/variables.lisp

Dependency

conditions.lisp (file)

Parent

src (module)

Location

src/variables.lisp

Exported Definitions

*cl-namespaces* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 xml.location/src/protocol.lisp

Dependency

variables.lisp (file)

Parent

src (module)

Location

src/protocol.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 xml.location/src/xpath-creation.lisp

Dependency

protocol.lisp (file)

Parent

src (module)

Location

src/xpath-creation.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 xml.location/src/location.lisp

Dependency

xpath-creation.lisp (file)

Parent

src (module)

Location

src/location.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 xml.location/src/singleton-location.lisp

Dependency

location.lisp (file)

Parent

src (module)

Location

src/singleton-location.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 xml.location/src/multi-location.lisp

Dependency

singleton-location.lisp (file)

Parent

src (module)

Location

src/multi-location.lisp

Exported Definitions
Internal Definitions

location-attribute (method)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 xml.location/src/location-mixins.lisp

Dependency

multi-location.lisp (file)

Parent

src (module)

Location

src/location-mixins.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 xml.location/src/conversion.lisp

Dependency

location-mixins.lisp (file)

Parent

src (module)

Location

src/conversion.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 xml.location/src/construction.lisp

Dependency

conversion.lisp (file)

Parent

src (module)

Location

src/construction.lisp

Exported Definitions
Internal Definitions

%compute-location-class (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.15 xml.location/src/macros.lisp

Dependency

construction.lisp (file)

Parent

src (module)

Location

src/macros.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 xml.location.compat

Internal compatibility package.

Source

compat.lisp (file)

Use List
Exported Definitions

define-dynamic-class-family (macro)

Internal Definitions

Previous: , Up: Packages   [Contents][Index]

5.2 xml.location

This package contains the public interface of the cmxl-location system. The main entry point is the generic function ‘loc’, which creates ‘location’ instances from XML documents and XPaths. The resulting objects can be queried and modified using the location-* accessors and the generic functions ‘name’, ‘val’ and ‘@’.

Source

package.lisp (file)

Nickname

xloc

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *cl-namespaces*

Namespace list with a made-up Common Lisp namespace. This namespace should be used when Common Lisp-specific data has to be stored in XML documents in order to represent objects without loss of information.

Package

xml.location

Source

variables.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: define-dynamic-class-family NAME &rest DOC-AND-OPTIONS

Define a family of classes in the category NAME. Classes in the family are fully specified by their respective sets of superclasses. No further structure is added.

For a family named NAME, the following things are defined:
+ *NAME-classes* [variable]
+ make-NAME-class [generic function]
+ make-NAME-class list [method]
+ ensure-NAME-class [function]
+ NAME-classes [function]

Unless the :package option is supplied, all names will be interned in NAME’s package. Using the :package option, a different package can be specified. When supplied, the value of the :package option is evaluated.

Valid options and their respective defaults are:
+ package [(package-name (symbol-package name))]
The package in which defined variables and functions will be placed. + metaclass [’standard-class]
The metaclass that should be used for classes in the family.
+ common-superclasses [nil]
A list of superclasses that should be added to all classes in the family. List elements can either be classes or lists of the
form (PLACEMENT CLASS) where PLACEMENT is either :start or :end and CLASS is a class. PLACEMENT controls where a superclass is inserted into the list of superclasses. The default placement is :end.
+ sort-mixins? [nil]
If non-nil, the list of mixin classes is sorted (according to their ‘class-name’s as strings) prior to looking for or creating a dynamic class.

Generated documentation is available for the symbol NAME using type :dynamic-class-family.

Package

xml.location.compat

Source

compat.lisp (file)

Macro: with-locations (&rest BINDINGS-AND-OPTIONS) DOCUMENT &body BODY

Execute body with certain variables, specified by BINDINGS bound to
locations in DOCUMENT. DOCUMENT has to be of type
‘stp:document’.

BINDINGS-AND-OPTIONS specifies let-like (generalized) variable
bindings according to the following syntax:
BINDINGS ::= (BINDING* OPTION*)
BINDING ::= (VAR-SPEC XPATH [ARG*])
VAR-SPEC ::= NAME-SPEC | VAL-SPEC | @-SPEC | LOC-SPEC
NAME-SPEC ::= (:name SYMBOL [:prefix? BOOL])
VAL-SPEC ::= SYMBOL | (:val SYMBOL [:type TYPE])
@-SPEC ::= (:@ @-NAME [:type TYPE])
@-NAME ::= SYMBOL | (SYMBOL "STRING")
LOC-SPEC ::= (:loc SYMBOL)
OPTION ::= KEY VALUE

In all cases, SYMBOL is the name of the generalized variable that is
created by the binding. If the (SYMBOL "STRING") form of @-NAME is
used, STRING specifies the name of the attribute independently of the
variable name, otherwise the name of attribute is computed as (string
SYMBOL).

Instead of the keywords :name, :val and :@ symbols of the same name in
the xml.location package can be used.

Example:
XLOC> (xloc:with-locations-r/o
(((:@ (description-brief "brief")) "package/description") (description-long "package/description/text()") (author "package/author/text()") (dependencies "package/depend/@package" :if-multiple-matches :all) (build-dependencies "package/rosbuild2/depend/@package" :if-multiple-matches :all)
((:val messages :type ’list) "package/rosbuild2/msgs/text()") ((:val services :type ’list) "package/rosbuild2/srvs/text()")) doc (values author messages))
=> "Joe User" ’("msg/bla.msg")

Package

xml.location

Source

macros.lisp (file)

Macro: with-locations-r/o (&rest BINDINGS-AND-OPTIONS) DOCUMENT &body BODY

Like ‘with-locations’, but binding places are not ‘setf’-able.

Package

xml.location

Source

macros.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: ->xml-conversion-error VALUE TYPE DESTINATION &optional FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signal an ‘->xml-conversion-error’ with data VALUE, TYPE and DESTINATION and optional FORMAT-CONTROL and FORMAT-ARGUMENTS.

Package

xml.location

Source

conditions.lisp (file)

Function: ensure-location-class MIXINS

Find or make the dynamic class composed of MIXINS.

Package

xml.location

Source

protocol.lisp (file)

Function: location-classes ()

Return list of all classes in the family.

Package

xml.location

Source

protocol.lisp (file)

Function: xml->-conversion-error VALUE TYPE &optional FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Signal an ‘xml->-conversion-error’ with data VALUE and TYPE and optional FORMAT-CONTROL and FORMAT-ARGUMENTS.

Package

xml.location

Source

conditions.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: ->xml VALUE DEST TYPE &key INNER-TYPES &allow-other-keys

Convert VALUE to a suitable type and store the result of the conversion in the XML node DEST. Should return VALUE.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: ->xml (VALUE list) (DEST (eql string)) (TYPE (eql type)) &key &allow-other-keys

Convert VALUE to string by ‘prin1’ing it.

Source

conversion.lisp (file)

Method: ->xml (VALUE sequence) (DEST (eql string)) TYPE &key INNER-TYPES &allow-other-keys

Convert sequence VALUE to string by ‘format’ting.

Source

conversion.lisp (file)

Method: ->xml (VALUE string) (DEST (eql string)) TYPE &key &allow-other-keys

Fast-path method for string VALUE.

Source

conversion.lisp (file)

Method: ->xml VALUE (DEST (eql string)) TYPE &key &allow-other-keys

Convert VALUE to requested type string by ‘prin1’ing it.

Source

conversion.lisp (file)

Method: ->xml (VALUE string) (DEST node) (TYPE (eql string)) &key &allow-other-keys

Catch-all for STP nodes that do not have an obvious string interpretation.

Source

conversion.lisp (file)

Method: ->xml (VALUE string) (DEST attribute) TYPE &key &allow-other-keys

Fast-path method for storing string VALUE into text node DEST.

Source

conversion.lisp (file)

Method: ->xml VALUE (DEST attribute) TYPE &key &allow-other-keys

Convert VALUE to string and store in DEST.

Source

conversion.lisp (file)

Method: ->xml (VALUE string) (DEST text) TYPE &key &allow-other-keys

Fast-path method for storing string VALUE into text node DEST.

Source

conversion.lisp (file)

Method: ->xml VALUE (DEST text) TYPE &key INNER-TYPES &allow-other-keys

Convert VALUE to string and store in DEST.

Source

conversion.lisp (file)

Method: ->xml VALUE (DEST document) TYPE &rest ARGS &key &allow-other-keys

Convert VALUE to string and store in DEST.

Source

conversion.lisp (file)

Method: ->xml VALUE DEST (TYPE list) &key &allow-other-keys around

Split composite type specification TYPE into head and tail.

Source

conversion.lisp (file)

Method: ->xml VALUE DEST (TYPE list) &key &allow-other-keys

Intended mainly to catch the case in which TYPE is nil.

Source

conversion.lisp (file)

Method: ->xml VALUE DEST TYPE &key INNER-TYPES around
Generic Function: @ LOCATION NAME &key TYPE &allow-other-keys

Return the value of the attribute named NAME of the node represented by LOCATION. If TYPE is supplied, a type conversion may be performed. LOCATION has to represent an element node. If NAME is a qualified name of the form PREFIX:LOCAL-NAME, LOCATION has to contain an entry for PREFIX in its namespace table.

Package

xml.location

Source

protocol.lisp (file)

Writer

(setf @) (generic function)

Methods
Method: @ (LOCATION ignore-empty-result-mixin) NAME &key &allow-other-keys around
Source

location-mixins.lisp (file)

Method: @ (LOCATION multi-location) (NAME string) &key TYPE
Source

multi-location.lisp (file)

Method: @ (LOCATION singleton-location) (NAME string) &key TYPE
Source

singleton-location.lisp (file)

Generic Function: (setf @) NEW-VALUE LOCATION NAME &key TYPE &allow-other-keys

Set NEW-VALUE as the value of the attribute named NAME of the node represented by LOCATION. If TYPE is supplied, a type conversion may be performed prior to assigning the value. LOCATION has to represent an element node. If NAME is a qualified name of the form PREFIX:LOCAL-NAME, LOCATION has to contain an entry for PREFIX in its namespace table.

Package

xml.location

Source

protocol.lisp (file)

Reader

@ (generic function)

Methods
Method: (setf @) NEW-VALUE (LOCATION ignore-empty-result-mixin) NAME &key &allow-other-keys around
Source

location-mixins.lisp (file)

Method: (setf @) NEW-VALUE (LOCATION multi-location) (NAME string) &key TYPE
Source

multi-location.lisp (file)

Method: (setf @) NEW-VALUE (LOCATION singleton-location) (NAME string) &key TYPE
Source

singleton-location.lisp (file)

Method: (setf @) (NEW-VALUE list) (LOCATION append-nodes-mixin) (NAME string) &key TYPE
Source

location-mixins.lisp (file)

Generic Function: conversion-error-destination CONDITION
Package

xml.location

Methods
Method: conversion-error-destination (CONDITION ->xml-conversion-error)
Source

conditions.lisp (file)

Generic Function: conversion-error-function CONDITION
Package

xml.location

Methods
Method: conversion-error-function (CONDITION no-conversion-method-mixin)
Source

conditions.lisp (file)

Generic Function: conversion-error-type CONDITION
Package

xml.location

Methods
Method: conversion-error-type (CONDITION conversion-error)
Source

conditions.lisp (file)

Generic Function: conversion-error-value CONDITION
Package

xml.location

Methods
Method: conversion-error-value (CONDITION conversion-error)
Source

conditions.lisp (file)

Generic Function: create-xpath DOCUMENT PATH

Ensure that the nodes referenced in PATH actually exist in DOCUMENT, creating them if necessary.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: create-xpath (DOCUMENT node) (PATH list)
Source

xpath-creation.lisp (file)

Method: create-xpath (DOCUMENT node) (PATH string)
Source

xpath-creation.lisp (file)

Generic Function: invalid-binding-form-form CONDITION
Package

xml.location

Methods
Method: invalid-binding-form-form (CONDITION invalid-binding-form)
Source

conditions.lisp (file)

Generic Function: invalid-binding-form-name CONDITION
Package

xml.location

Methods
Method: invalid-binding-form-name (CONDITION no-such-accessor-form)
Source

conditions.lisp (file)

Generic Function: invalid-binding-form-spec CONDITION
Package

xml.location

Methods
Method: invalid-binding-form-spec (CONDITION no-such-accessor-form)
Source

conditions.lisp (file)

Generic Function: loc DOCUMENT PATH &rest ARGS &key NAMESPACES IF-NO-MATCH IF-MULTIPLE-MATCHES ASSIGN-MODE &allow-other-keys

Construct and return a new location object that represents the nodes resulting from applying the XPath PATH to the XML document DOCUMENT. ARGS are passed to the ‘make-instance’ call that creates a ‘location’ instance.

NAMESPACES can be an alist of the form

((PREFIX . NAMESPACE)*)

that specifies XML namespaces that should be made available in PATH.

IF-NO-MATCH specifies the policy for dealing with the situation that the node set produced by evaluating PATH on DOCUMENT is empty. Valid values:

:error (the default)

Signal an ‘empty-result-set’ error.

:create

Try to create a location which matches PATH in DOCUMENT, then return the created location.

:do-nothing.

Return a location object that does not have an associated location in document.

IF-MULTIPLE-MATCHES specifies the policy for dealing with the situation that the node set produced by evaluating PATH on DOCUMENT consists of multiple nodes. Valid values are:

:error (the default)

Signal a ‘too-many-matches-in-result-set’ error.

:first

Return a location object corresponding to the first location in DOCUMENT which matches PATH.

:any

Return a location object corresponding to an arbitrary location in DOCUMENT which matches PATH.

:last.

Return a location object corresponding to the last location in DOCUMENT which matches PATH.

:all

Return a location object corresponding to the set of matching locations. Operations on the location object affect all locations simultaneously.

ASSIGN-MODE specifies the semantics of assigning values to ‘val’ places of the location:

:set

An assigned value replaces the previous value.

:append

Subsequently assigned values are stored in newly appended sibling locations.

The type of the returned ‘location’ instance can depend on the arguments but is a sub-type of ‘location’.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: loc DOCUMENT (PATH function) &rest ARGS around

Interpret PATH as compiled XPath, skipping the compilation step.

Source

construction.lisp (file)

Method: loc (DOCUMENT string) PATH &rest ARGS

Parse DOCUMENT as XML document before constructing the location.

Source

construction.lisp (file)

Method: loc (DOCUMENT node) (PATH string) &rest ARGS &key IF-MULTIPLE-MATCHES IF-NO-MATCH ASSIGN-MODE &allow-other-keys

Create a location for DOCUMENT and PATH. The class of the location instance is determined based on the values of IF-MULTIPLE-MATCHES and IF-NO-MATCH.

Source

construction.lisp (file)

Method: loc (LOCATION multi-location) PATH &rest ARGS &key &allow-other-keys
Source

multi-location.lisp (file)

Method: loc (LOCATION singleton-location) PATH &rest ARGS &key &allow-other-keys
Source

singleton-location.lisp (file)

Generic Function: location-document LOCATION

Return the document (an stp:node instance) associated to LOCATION.

Package

xml.location

Source

protocol.lisp (file)

Writer

(setf location-document) (generic function)

Methods
Method: location-document (LOCATION location)

The XML document to which the location refers.

Source

location.lisp (file)

Generic Function: (setf location-document) NEW-VALUE LOCATION

Set NEW-VALUE as LOCATION’s associated document. NEW-VALUE has to be an stp:node instance.

Package

xml.location

Source

protocol.lisp (file)

Reader

location-document (generic function)

Methods
Method: (setf location-document) NEW-VALUE (LOCATION location)

The XML document to which the location refers.

Source

location.lisp (file)

Method: (setf location-document) NEW-VALUE (LOCATION location) after

Reset computed result of LOCATION when the document is changed.

Source

location.lisp (file)

Generic Function: location-error-document CONDITION
Package

xml.location

Methods
Method: location-error-document (CONDITION location-error)
Source

conditions.lisp (file)

Generic Function: location-error-path CONDITION
Package

xml.location

Methods
Method: location-error-path (CONDITION location-error)
Source

conditions.lisp (file)

Generic Function: location-namespaces OBJECT
Generic Function: (setf location-namespaces) NEW-VALUE OBJECT
Package

xml.location

Methods
Method: location-namespaces (LOCATION location)
Method: (setf location-namespaces) NEW-VALUE (LOCATION location)

An alist of namespaces that should be available in the XPath of the location.

Source

location.lisp (file)

Method: (setf location-namespaces) NEW-VALUE (LOCATION location) after

Reset computed result of LOCATION when namespaces are changed.

Source

location.lisp (file)

Generic Function: location-path LOCATION

Return the XPath of LOCATION.

Package

xml.location

Source

protocol.lisp (file)

Writer

(setf location-path) (generic function)

Methods
Method: location-path (LOCATION location)

An XPath that selects nodes in the document of the location.

Source

location.lisp (file)

Generic Function: (setf location-path) NEW-VALUE LOCATION

Set NEW-VALUE as LOCATION’s associated XPath. NEW-VALUE has to be a string.

Package

xml.location

Source

protocol.lisp (file)

Reader

location-path (generic function)

Methods
Method: (setf location-path) NEW-VALUE (LOCATION location)

An XPath that selects nodes in the document of the location.

Source

location.lisp (file)

Method: (setf location-path) NEW-VALUE (LOCATION location) after

Reset computed result of LOCATION when the path is changed.

Source

location.lisp (file)

Generic Function: location-result LOCATION

Return the node or node set that has been produced by evaluating LOCATION’s associated XPath on LOCATION’s associated document.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: location-result (LOCATION location)

The node-set produced by evaluating the XPath of the location to the document of the location.

Source

location.lisp (file)

Generic Function: make-location-class MIXINS

Dynamically make a class composed of MIXINS.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: make-location-class (MIXINS list)
Generic Function: name LOCATION &key PREFIX? &allow-other-keys

Return the name of the node represented by LOCATION.
If PREFIX? is non-nil, the concatenation of the prefix and the local name is returned.

Package

xml.location

Source

protocol.lisp (file)

Writer

(setf name) (generic function)

Methods
Method: name (LOCATION ignore-empty-result-mixin) &key &allow-other-keys around
Source

location-mixins.lisp (file)

Method: name (LOCATION multi-location) &key PREFIX?
Source

multi-location.lisp (file)

Method: name (LOCATION singleton-location) &key PREFIX?
Source

singleton-location.lisp (file)

Generic Function: (setf name) NEW-VALUE LOCATION

Set NEW-VALUE as the local name of the node represented by LOCATION. If NEW-VALUE is a qualified name of the form PREFIX:LOCAL-NAME, LOCATION has to have an entry for PREFIX in its namespace table.

Package

xml.location

Source

protocol.lisp (file)

Reader

name (generic function)

Methods
Method: (setf name) NEW-VALUE (LOCATION ignore-empty-result-mixin) around
Source

location-mixins.lisp (file)

Method: (setf name) (NEW-VALUE list) (LOCATION multi-location)
Source

multi-location.lisp (file)

Method: (setf name) (NEW-VALUE string) (LOCATION multi-location)
Source

multi-location.lisp (file)

Method: (setf name) (NEW-VALUE list) (LOCATION singleton-location)
Source

singleton-location.lisp (file)

Method: (setf name) (NEW-VALUE string) (LOCATION singleton-location)
Source

singleton-location.lisp (file)

Method: (setf name) (NEW-VALUE string) (LOCATION location) around

Determine whether NEW-VALUE is qualified and call and appropriate next method.

Source

location.lisp (file)

Generic Function: result-condition-result CONDITION
Package

xml.location

Methods
Method: result-condition-result (CONDITION result-condition)
Source

conditions.lisp (file)

Generic Function: val LOCATION &key TYPE &allow-other-keys

Return the value of the node represented by LOCATION. If TYPE is supplied, a type conversion may be performed. When LOCATION represents an element node, TYPE has to be supplied. For attribute and text nodes, the text value is returned in that case.

Package

xml.location

Source

protocol.lisp (file)

Writer

(setf val) (generic function)

Methods
Method: val (LOCATION ignore-empty-result-mixin) &key &allow-other-keys around
Source

location-mixins.lisp (file)

Method: val (LOCATION multi-location) &key TYPE
Source

multi-location.lisp (file)

Method: val (LOCATION singleton-location) &key TYPE
Source

singleton-location.lisp (file)

Generic Function: (setf val) NEW-VALUE LOCATION &key TYPE &allow-other-keys

Set NEW-VALUE as the value of the node represented by LOCATION. If TYPE is supplied, a type conversion may be performed prior to assigning the value. When LOCATION represents an element node, TYPE has to be supplied. For attribute and text nodes, NEW-VALUE has to be a string in that case.

Package

xml.location

Source

protocol.lisp (file)

Reader

val (generic function)

Methods
Method: (setf val) NEW-VALUE (LOCATION ignore-empty-result-mixin) &key &allow-other-keys around
Source

location-mixins.lisp (file)

Method: (setf val) NEW-VALUE (LOCATION multi-location) &key TYPE
Source

multi-location.lisp (file)

Method: (setf val) NEW-VALUE (LOCATION singleton-location) &key TYPE
Source

singleton-location.lisp (file)

Method: (setf val) NEW-VALUE (LOCATION append-nodes-mixin) &key &allow-other-keys after

Sibling creation invalidates our previous XPath evaluation result, so we have to re-evaluate.

Source

location-mixins.lisp (file)

Method: (setf val) (NEW-VALUE list) (LOCATION append-nodes-mixin) &key TYPE
Source

location-mixins.lisp (file)

Method: (setf val) NEW-VALUE (LOCATION append-nodes-mixin) &key TYPE
Source

location-mixins.lisp (file)

Generic Function: xml-> VALUE TYPE &key INNER-TYPES &allow-other-keys

Convert VALUE to the type designated by TYPE and, possibly INNER-TYPES. The result of the conversion is returned.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: xml-> (VALUE node) (TYPE symbol) &key &allow-other-keys

Interpret TYPE as a class name. Try to create an instance and load the contents of VALUE into that instance.

Source

conversion.lisp (file)

Method: xml-> (VALUE node) (TYPE class) &key &allow-other-keys

Interpret TYPE as a class name. Try to create an instance and load the contents of VALUE into that instance.

Source

conversion.lisp (file)

Method: xml-> (VALUE string) (TYPE (eql type)) &key &allow-other-keys

Convert string VALUE to a Common Lisp type.

Source

conversion.lisp (file)

Method: xml-> (VALUE string) (TYPE (eql list)) &key INNER-TYPES

Convert intermediate string VALUE to requested list type TYPE.

Source

conversion.lisp (file)

Method: xml-> (VALUE string) (TYPE (eql string)) &key &allow-other-keys

Fast-path method for string VALUE.

Source

conversion.lisp (file)

Method: xml-> (VALUE string) TYPE &key &allow-other-keys

Convert intermediate string VALUE to requested type TYPE.

Source

conversion.lisp (file)

Method: xml-> (VALUE node) (TYPE (eql string)) &key &allow-other-keys

Catch-all method for STP nodes that have no obvious string interpretation.

Source

conversion.lisp (file)

Method: xml-> (VALUE attribute) (TYPE (eql string)) &key &allow-other-keys

Fast-path method for attribute nodes if TYPE is string.

Source

conversion.lisp (file)

Method: xml-> (VALUE attribute) TYPE &rest ARGS &key &allow-other-keys

Extract attribute value from VALUE for further conversion.

Source

conversion.lisp (file)

Method: xml-> (VALUE text) (TYPE (eql string)) &key &allow-other-keys

Fast-path method for text nodes if TYPE is string.

Source

conversion.lisp (file)

Method: xml-> (VALUE text) TYPE &rest ARGS &key &allow-other-keys

Extract text from text node VALUE for further conversion.

Source

conversion.lisp (file)

Method: xml-> (VALUE document) TYPE &rest ARGS &key &allow-other-keys
Source

conversion.lisp (file)

Method: xml-> VALUE (TYPE list) &key &allow-other-keys around

Split composite type specification TYPE into head and tail.

Source

conversion.lisp (file)

Method: xml-> VALUE (TYPE list) &key &allow-other-keys

Intended mainly to catch the case in which TYPE is nil.

Source

conversion.lisp (file)

Method: xml-> VALUE TYPE &key INNER-TYPES around
Generic Function: xpath-creation-error-location CONDITION
Package

xml.location

Methods
Method: xpath-creation-error-location (CONDITION xpath-creation-error)
Source

conditions.lisp (file)

Generic Function: xpath-creation-error-name CONDITION
Package

xml.location

Methods
Method: xpath-creation-error-name (CONDITION xpath-creation-error)
Source

conditions.lisp (file)

Generic Function: xpath-creation-error-predicate CONDITION
Package

xml.location

Methods
Method: xpath-creation-error-predicate (CONDITION xpath-creation-error)
Source

conditions.lisp (file)

Generic Function: xpath-creation-error-type CONDITION
Package

xml.location

Methods
Method: xpath-creation-error-type (CONDITION xpath-creation-error)
Source

conditions.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Conditions

Condition: ->xml-conversion-error ()

This error is signaled when storing a value into an XML location with a certain type fails.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

conversion-error (condition)

Direct subclasses

no-->xml-conversion-method (condition)

Direct methods

conversion-error-destination (method)

Direct slots
Slot: destination

The destination of the failed conversion. Usually an XML node.

Initargs

:destination

Readers

conversion-error-destination (generic function)

Direct Default Initargs
InitargValue
:destination(more-conditions:missing-required-initarg (quote xml.location:->xml-conversion-error) :destination)
Condition: conversion-error ()

This error is signaled when a conversion fails.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: value

The value for which the conversion failed.

Initargs

:value

Readers

conversion-error-value (generic function)

Slot: type

The type involved in the failed conversion.

Initargs

:type

Readers

conversion-error-type (generic function)

Direct Default Initargs
InitargValue
:format-argumentsnil
:format-control""
Condition: empty-result-set ()

This error is signaled when an XPath evaluation produces an empty result in a context that requires a non-empty result set.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:resultnil
Condition: invalid-binding-form ()

This error is signaled when an invalid binding form is encountered during expansion of the ‘with-locations’ macro.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

no-such-accessor-form (condition)

Direct methods

invalid-binding-form-form (method)

Direct slots
Slot: form

The invalid binding form.

Initargs

:form

Readers

invalid-binding-form-form (generic function)

Condition: invalid-result-type ()

This error is signaled when an XPath evaluation produces a result which is not of the correct type for the context in which it occurs.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses
Condition: location-error ()

This condition class can be used to discriminate location-related errors.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: document

The document of the location that caused the error.

Initargs

:document

Readers

location-error-document (generic function)

Slot: path

The XPath of the location that caused the error.

Initargs

:path

Readers

location-error-path (generic function)

Direct Default Initargs
InitargValue
:path(more-conditions:missing-required-initarg (quote xml.location:location-error) :path)
:document(more-conditions:missing-required-initarg (quote xml.location:location-error) :document)
Condition: missing-xpath-source ()

This condition is signaled when recompilation of an XPath would be required but the XPath source is not available. This can happen, for example, when the namespace table of a location is changed.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Condition: no-->xml-conversion-method ()

This error is signaled when no method is available to store a value into an XML location with a certain type.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:function(quote xml.location:->xml)
Condition: no-conversion-method-mixin ()

This condition class can be mixed into condition classes that indicate a conversion failure because of a missing conversion method.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Direct methods

conversion-error-function (method)

Direct slots
Slot: function

The name of the conversion function for which no suitable method could be found.

Initargs

:function

Readers

conversion-error-function (generic function)

Direct Default Initargs
InitargValue
:function(more-conditions:missing-required-initarg (quote xml.location:no-conversion-method-mixin) :function)
Condition: no-such-accessor-form ()

This error is signaled if a binding form is encountered within a use of in the ‘with-locations’ macro which contains an unknown accessor.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

invalid-binding-form (condition)

Direct methods
Direct slots
Slot: spec

The accessor specification which contains the unknown accessor.

Initargs

:spec

Readers

invalid-binding-form-spec (generic function)

Slot: name

The unknown accessor.

Initargs

:name

Readers

invalid-binding-form-name (generic function)

Condition: no-xml->-conversion-method ()

This error is signaled when no method is available to convert an XML location into a Lisp object with a certain type.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:function(quote xml.location:xml->)
Condition: result-condition ()

Subclasses of this condition are signaled when an XPath evaluation produces a result that is invalid in the a particular context.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Direct methods

result-condition-result (method)

Direct slots
Slot: result

The invalid result.

Initargs

:result

Readers

result-condition-result (generic function)

Direct Default Initargs
InitargValue
:result(more-conditions:missing-required-initarg (quote xml.location:result-condition) :result)
Condition: too-many-matches-in-result-set ()

This error is signaled when an XPath evaluation produces a result set that consists of multiple elements in a context that permits at most one element.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses
Direct methods

location-error-expected (method)

Direct slots
Slot: expected

The number of elements the result set should have had.

Initargs

:expected

Readers

location-error-expected (generic function)

Condition: xml->-conversion-error ()

This error is signaled when converting an XML location into a Lisp object with a certain type fails.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

conversion-error (condition)

Direct subclasses

no-xml->-conversion-method (condition)

Condition: xpath-creation-error ()

This error is signaled when the creation of a node based on a XPath fragment fails.

Package

xml.location

Source

conditions.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods
Direct slots
Slot: location

The location at which a node should have been added according to the XPath.

Initargs

:location

Readers

xpath-creation-error-location (generic function)

Slot: type

The type of the XPath fragment for which the creation of a node failed.

Initargs

:type

Readers

xpath-creation-error-type (generic function)

Slot: name

The name mentioned in the XPath fragment for which the creation of a node failed.

Initargs

:name

Readers

xpath-creation-error-name (generic function)

Slot: predicate

The predicate of the XPath fragment for which the creation of a node failed.

Initargs

:predicate

Readers

xpath-creation-error-predicate (generic function)

Direct Default Initargs
InitargValue
:format-argumentsnil
:format-control""
:predicate(more-conditions:missing-required-initarg (quote xml.location:xpath-creation-error) :predicate)
:name(more-conditions:missing-required-initarg (quote xml.location:xpath-creation-error) :name)
:type(more-conditions:missing-required-initarg (quote xml.location:xpath-creation-error) :type)
:location(more-conditions:missing-required-initarg (quote xml.location:xpath-creation-error) :location)

Previous: , Up: Exported definitions   [Contents][Index]

6.1.6 Classes

Class: append-nodes-mixin ()

This mixin changes the default replacing assignment behavior to an appending assignment behavior. That is, assignments to the ‘val’ place of locations create siblings of the node designated by the final XPath component and assign values to these new nodes.

Package

xml.location

Source

location-mixins.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: create-missing-nodes-mixin ()

This class adds the automatic creation of XML nodes that are references in the path but missing in the document to location classes.

Package

xml.location

Source

location-mixins.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: location ()

A location consists of an XML document and an XPath that refers to nodes in the document. Technically the location uses the node set resulting from evaluating the XPath on the document as a concrete representation of this relation. Operation on the location are carried out on the node or nodes of the node set.

Package

xml.location

Source

location.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: document

The XML document to which the location refers.

Type

cxml-stp:node

Initargs

:document

Readers

location-document (generic function)

Writers

(setf location-document) (generic function)

Slot: namespaces

An alist of namespaces that should be available in the XPath of the location.

Type

list

Readers

location-namespaces (generic function)

Writers

(setf location-namespaces) (generic function)

Slot: path

An XPath that selects nodes in the document of the location.

Type

(or null string)

Initargs

:path

Readers

location-path (generic function)

Writers

(setf location-path) (generic function)

Slot: compiled-path

Compiled version of the XPath of the location.

Type

(or null function)

Initargs

:compiled-path

Readers

location-compiled-path (generic function)

Writers

(setf location-compiled-path) (generic function)

Slot: result

The node-set produced by evaluating the XPath of the location to the document of the location.

Type

(or null xpath:node-set)

Initargs

:result

Readers

location-result (generic function)

Direct Default Initargs
InitargValue
:namespacesxpath::*initial-namespaces*
Class: multi-location ()

Instances of this class represent and operate on a set of XPath matches in a single document simultaneously.

Package

xml.location

Source

multi-location.lisp (file)

Direct superclasses

location (class)

Direct methods
Class: singleton-location ()

This location class consists of an XML document along with an XPath that produces exactly one match in the document.

Package

xml.location

Source

singleton-location.lisp (file)

Direct superclasses

location (class)

Direct methods
Direct slots
Slot: if-no-match

Policy for the situation that the XPath evaluates to an empty node set.

Type

xml.location::if-no-match-policy-designator

Initargs

:if-no-match

Initform

:error

Slot: if-multiple-matches

Policy for the situation that the XPath
evaluates to a node set that consists of more than one nodes.

Type

(member :error :first :last :any)

Initargs

:if-multiple-matches

Initform

:any

Readers

location-if-multiple-matches (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *location-classes*

Association of lists of mixins to previously created classes.

Package

xml.location

Source

protocol.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: %add-available-conversion-methods CONDITION STREAM

Print a list of methods of the generic function associated to CONDITION onto STREAM.

Package

xml.location

Source

conditions.lisp (file)

Function: %add-available-conversion-methods-for-function FUNCTION STREAM

Format the list of methods of the generic function designated by NAME onto STREAM.

Package

xml.location

Source

conditions.lisp (file)

Function: %compute-location-class &rest ARGS &key IF-MULTIPLE-MATCHES IF-NO-MATCH ASSIGN-MODE &allow-other-keys

Compute a location class based on the values of IF-MULTIPLE-MATCHES and IF-NO-MATCH. This is a separate function to make it usable in compiler macros.

Package

xml.location

Source

construction.lisp (file)

Function: %ensure-class-name CLASS-OR-NAME
Package

xml.location.compat

Source

compat.lisp (file)

Function: %expand-xpath-element SPEC
Package

xml.location

Source

xpath-creation.lisp (file)

Function: %location-error-document-string CONDITION

Return a serialization of the XML document associated with CONDITION.

Package

xml.location

Source

conditions.lisp (file)

Function: %make-key/sorted MIXINS

Return a key for the dynamic class described by MIXINS.

Package

xml.location.compat

Source

compat.lisp (file)

Function: %make-key/unsorted MIXINS

Return a key for the dynamic class described by MIXINS.

Package

xml.location.compat

Source

compat.lisp (file)

Function: %make-location-and-place-forms DOCUMENT BINDINGS &key GLOBAL-ARGS WRITABLE?

Generate location and place forms for DOCUMENT and BINDINGS. When WRITABLE? is non-nil, locations are created in the document if necessary. Return two values:
+ A list of location forms
+ A list of place forms

Package

xml.location

Source

macros.lisp (file)

Function: %make-location-form DOCUMENT PATH ARGS

Make a form that creates the ‘location’ instance for DOCUMENT, PATH and ARGS. Return two values:
+ a symbol for the variable that will hold the location instance + a form that should be evaluated to compute the location instance or nil, if a location variable emitted earlier can be reused.

Package

xml.location

Source

macros.lisp (file)

Function: %maybe-add-default-namespaces NAMESPACES

Add default namespaces as defined by ‘xpath::*dynamic-namespaces*’ to NAMESPACES.

Package

xml.location

Source

location.lisp (file)

Function: %parse-bindings-and-options BINDINGS-AND-OPTIONS

Separate BINDINGS-AND-OPTIONS into binding forms and
options. Return two values: the collected binding forms and a plist containing the collected options.

Package

xml.location

Source

macros.lisp (file)

Function: %parse-doc-and-options DOC-AND-OPTIONS

Parse DOC-AND-OPTIONS which is expected to be a list of the form ([DOC] (:NAME VALUE)*).
Return a list of the form
(DOC :NAME1 VALUE1 ...)
in which DOC may be nil.

Package

xml.location.compat

Source

compat.lisp (file)

Function: %parse-list-of-atoms STRING
Package

xml.location

Source

conversion.lisp (file)

Function: %process-superclass-specs SPECS

Parse superclass specs SPECS and return two values: superclasses that should be inserted at the start of the list of direct superclasses and superclasses that should inserted at the end of the list of direct superclasses.

Package

xml.location.compat

Source

compat.lisp (file)

Function: %signal-no-such-accessor-form SPEC ARGS
Package

xml.location

Source

macros.lisp (file)

Function: %split-at-whitespace STRING
Package

xml.location

Source

conversion.lisp (file)

Function: clear-location-classes! ()

Clear all previously defined dynamic classes.

Package

xml.location

Source

protocol.lisp (file)

Function: ensure-find-class CLASS-OR-NAME
Package

xml.location.compat

Source

compat.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Generic functions

Generic Function: %parse-access-spec SPEC &rest ARGS &key INNER-SPECS ARGS &allow-other-keys
Package

xml.location

Source

macros.lisp (file)

Methods
Method: %parse-access-spec (SPEC (eql @)) &rest ARGS
Method: %parse-access-spec (SPEC (eql @)) &key INNER-SPECS ARGS
Method: %parse-access-spec (SPEC (eql val)) &rest ARGS
Method: %parse-access-spec (SPEC (eql val)) &key INNER-SPECS ARGS
Method: %parse-access-spec (SPEC (eql name)) &rest ARGS
Method: %parse-access-spec (SPEC (eql name)) &key INNER-SPECS ARGS
Method: %parse-access-spec (SPEC (eql loc)) &key INNER-SPECS ARGS
Method: %parse-access-spec (SPEC symbol) &rest ARGS
Method: %parse-access-spec (SPEC list) &rest ARGS
Method: %parse-access-spec (SPEC (eql nil)) &key INNER-SPECS
Method: %parse-access-spec SPEC &key INNER-SPECS
Generic Function: compile! LOCATION

Compile XPath associated to LOCATION.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: compile! (LOCATION location)

Compile the XPath and store the result.

Source

location.lisp (file)

Method: compile! (LOCATION location) before

Check whether the XPath source is available.

Source

location.lisp (file)

Generic Function: create-xpath-element LOCATION TYPE NAME PREDICATE &rest PREDICATES

Create the XPath element designated by TYPE, NAME and PREDICATE in LOCATION.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: create-xpath-element (LOCATION element) (TYPE (eql attribute)) (NAME (eql *)) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION element) (TYPE (eql attribute)) (NAME string) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) NAME (PREDICATE list) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) (NAME list) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) (NAME string) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) NAME (PREDICATE integer) &rest PREDICATES around
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) NAME (PREDICATE integer) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) (NAME (eql text)) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) (NAME (eql *)) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Method: create-xpath-element (LOCATION node) (TYPE (eql child)) (NAME (eql node)) (PREDICATE (eql nil)) &rest PREDICATES
Source

xpath-creation.lisp (file)

Generic Function: create-xpath-sibling DOCUMENT PATH

Create a "sibling" path of PATH by duplicating the node
designated by PATH and appending the result to the children of the parent of the node designated by PATH.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: create-xpath-sibling (DOCUMENT node) (PATH list)
Source

xpath-creation.lisp (file)

Method: create-xpath-sibling (DOCUMENT node) (PATH string)
Source

xpath-creation.lisp (file)

Generic Function: evaluate! LOCATION

Evaluate XPath associated to LOCATION on the document associated to LOCATION.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: evaluate! (LOCATION singleton-location) around
Source

singleton-location.lisp (file)

Method: evaluate! (LOCATION location)

Evaluate the XPath on the document and store the resulting node set.

Source

location.lisp (file)

Generic Function: location-attribute LOCATION NAME &key URI IF-DOES-NOT-EXIST &allow-other-keys

Return the attribute(s) designated by NAME in LOCATION.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: location-attribute (LOCATION append-nodes-mixin) (NAME string) &key URI
Source

location-mixins.lisp (file)

Method: location-attribute (LOCATION create-missing-nodes-mixin) (NAME string) &key URI
Source

location-mixins.lisp (file)

Method: location-attribute (LOCATION multi-location) (NAME string) &key URI IF-DOES-NOT-EXIST
Source

multi-location.lisp (file)

Method: location-attribute (LOCATION singleton-location) (NAME string) &key URI IF-DOES-NOT-EXIST
Source

singleton-location.lisp (file)

Method: location-attribute (LOCATION singleton-location) (NAME string) &key &allow-other-keys before
Source

singleton-location.lisp (file)

Method: location-attribute (LOCATION location) (NAME string) &rest ARGS &key &allow-other-keys around

Handle qualified attribute names.

Source

location.lisp (file)

Generic Function: location-compiled-path OBJECT
Generic Function: (setf location-compiled-path) NEW-VALUE OBJECT
Package

xml.location

Methods
Method: location-compiled-path (LOCATION location)
Method: (setf location-compiled-path) NEW-VALUE (LOCATION location)

Compiled version of the XPath of the location.

Source

location.lisp (file)

Method: (setf location-compiled-path) NEW-VALUE (LOCATION location) after

Reset computed result of LOCATION when the compiled path is changed.

Source

location.lisp (file)

Generic Function: location-error-expected CONDITION
Package

xml.location

Methods
Method: location-error-expected (CONDITION too-many-matches-in-result-set)
Source

conditions.lisp (file)

Generic Function: location-if-multiple-matches OBJECT
Package

xml.location

Methods
Method: location-if-multiple-matches (SINGLETON-LOCATION singleton-location)

Policy for the situation that the XPath
evaluates to a node set that consists of more than one nodes.

Source

singleton-location.lisp (file)

Generic Function: maybe-decode-qname LOCATION NAME

If NAME is qualified, decode it into local-name prefix and uri using the configured namespaces of LOCATION. Return the components as multiple value. If NAME is not qualified, the secondary and tertiary values are both nil.

Package

xml.location

Source

protocol.lisp (file)

Methods
Method: maybe-decode-qname (LOCATION location) (NAME string)

If NAME is qualified, decode it into local-name prefix and uri using the configured namespaces of LOCATION. Return the components as multiple value. If NAME is not qualified, the secondary and tertiary values are both nil.

Source

location.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Classes

Class: ignore-empty-result-mixin ()

This mixin class adds the behavior of turning the methods ‘name’, ‘val’ and ‘@’ (and their ‘setf’ variants) into no-ops if the result set is empty.

Package

xml.location

Source

location-mixins.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Types

Type: assign-mode-designator ()
Package

xml.location

Source

types.lisp (file)

Type: if-multiple-matches-policy-designator ()
Package

xml.location

Source

types.lisp (file)

Type: if-no-match-policy-designator ()
Package

xml.location

Source

types.lisp (file)

Type: superclass-spec ()
Package

xml.location.compat

Source

compat.lisp (file)

Type: superclass-spec-end ()

Superclass spec for appending a superclass at the end of the list of direct superclasses.

Package

xml.location.compat

Source

compat.lisp (file)

Type: superclass-spec-simple ()

A simple superclass spec is a class name.

Package

xml.location.compat

Source

compat.lisp (file)

Type: superclass-spec-start ()

Superclass spec for appending a superclass at the start of the list of direct superclasses.

Package

xml.location.compat

Source

compat.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   X  
Index Entry  Section

F
File, Lisp, xml.location.asd: The xml<dot>location<dot>asd file
File, Lisp, xml.location/compat.lisp: The xml<dot>location/compat<dot>lisp file
File, Lisp, xml.location/src/conditions.lisp: The xml<dot>location/src/conditions<dot>lisp file
File, Lisp, xml.location/src/construction.lisp: The xml<dot>location/src/construction<dot>lisp file
File, Lisp, xml.location/src/conversion.lisp: The xml<dot>location/src/conversion<dot>lisp file
File, Lisp, xml.location/src/location-mixins.lisp: The xml<dot>location/src/location-mixins<dot>lisp file
File, Lisp, xml.location/src/location.lisp: The xml<dot>location/src/location<dot>lisp file
File, Lisp, xml.location/src/macros.lisp: The xml<dot>location/src/macros<dot>lisp file
File, Lisp, xml.location/src/multi-location.lisp: The xml<dot>location/src/multi-location<dot>lisp file
File, Lisp, xml.location/src/package.lisp: The xml<dot>location/src/package<dot>lisp file
File, Lisp, xml.location/src/protocol.lisp: The xml<dot>location/src/protocol<dot>lisp file
File, Lisp, xml.location/src/singleton-location.lisp: The xml<dot>location/src/singleton-location<dot>lisp file
File, Lisp, xml.location/src/types.lisp: The xml<dot>location/src/types<dot>lisp file
File, Lisp, xml.location/src/variables.lisp: The xml<dot>location/src/variables<dot>lisp file
File, Lisp, xml.location/src/xpath-creation.lisp: The xml<dot>location/src/xpath-creation<dot>lisp file

L
Lisp File, xml.location.asd: The xml<dot>location<dot>asd file
Lisp File, xml.location/compat.lisp: The xml<dot>location/compat<dot>lisp file
Lisp File, xml.location/src/conditions.lisp: The xml<dot>location/src/conditions<dot>lisp file
Lisp File, xml.location/src/construction.lisp: The xml<dot>location/src/construction<dot>lisp file
Lisp File, xml.location/src/conversion.lisp: The xml<dot>location/src/conversion<dot>lisp file
Lisp File, xml.location/src/location-mixins.lisp: The xml<dot>location/src/location-mixins<dot>lisp file
Lisp File, xml.location/src/location.lisp: The xml<dot>location/src/location<dot>lisp file
Lisp File, xml.location/src/macros.lisp: The xml<dot>location/src/macros<dot>lisp file
Lisp File, xml.location/src/multi-location.lisp: The xml<dot>location/src/multi-location<dot>lisp file
Lisp File, xml.location/src/package.lisp: The xml<dot>location/src/package<dot>lisp file
Lisp File, xml.location/src/protocol.lisp: The xml<dot>location/src/protocol<dot>lisp file
Lisp File, xml.location/src/singleton-location.lisp: The xml<dot>location/src/singleton-location<dot>lisp file
Lisp File, xml.location/src/types.lisp: The xml<dot>location/src/types<dot>lisp file
Lisp File, xml.location/src/variables.lisp: The xml<dot>location/src/variables<dot>lisp file
Lisp File, xml.location/src/xpath-creation.lisp: The xml<dot>location/src/xpath-creation<dot>lisp file

M
Module, xml.location/src: The xml<dot>location/src module

X
xml.location.asd: The xml<dot>location<dot>asd file
xml.location/compat.lisp: The xml<dot>location/compat<dot>lisp file
xml.location/src: The xml<dot>location/src module
xml.location/src/conditions.lisp: The xml<dot>location/src/conditions<dot>lisp file
xml.location/src/construction.lisp: The xml<dot>location/src/construction<dot>lisp file
xml.location/src/conversion.lisp: The xml<dot>location/src/conversion<dot>lisp file
xml.location/src/location-mixins.lisp: The xml<dot>location/src/location-mixins<dot>lisp file
xml.location/src/location.lisp: The xml<dot>location/src/location<dot>lisp file
xml.location/src/macros.lisp: The xml<dot>location/src/macros<dot>lisp file
xml.location/src/multi-location.lisp: The xml<dot>location/src/multi-location<dot>lisp file
xml.location/src/package.lisp: The xml<dot>location/src/package<dot>lisp file
xml.location/src/protocol.lisp: The xml<dot>location/src/protocol<dot>lisp file
xml.location/src/singleton-location.lisp: The xml<dot>location/src/singleton-location<dot>lisp file
xml.location/src/types.lisp: The xml<dot>location/src/types<dot>lisp file
xml.location/src/variables.lisp: The xml<dot>location/src/variables<dot>lisp file
xml.location/src/xpath-creation.lisp: The xml<dot>location/src/xpath-creation<dot>lisp file

Jump to:   F   L   M   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (   -   @  
C   D   E   F   G   I   L   M   N   R   V   W   X  
Index Entry  Section

%
%add-available-conversion-methods: Internal functions
%add-available-conversion-methods-for-function: Internal functions
%compute-location-class: Internal functions
%ensure-class-name: Internal functions
%expand-xpath-element: Internal functions
%location-error-document-string: Internal functions
%make-key/sorted: Internal functions
%make-key/unsorted: Internal functions
%make-location-and-place-forms: Internal functions
%make-location-form: Internal functions
%maybe-add-default-namespaces: Internal functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-access-spec: Internal generic functions
%parse-bindings-and-options: Internal functions
%parse-doc-and-options: Internal functions
%parse-list-of-atoms: Internal functions
%process-superclass-specs: Internal functions
%signal-no-such-accessor-form: Internal functions
%split-at-whitespace: Internal functions

(
(setf @): Exported generic functions
(setf @): Exported generic functions
(setf @): Exported generic functions
(setf @): Exported generic functions
(setf @): Exported generic functions
(setf location-compiled-path): Internal generic functions
(setf location-compiled-path): Internal generic functions
(setf location-compiled-path): Internal generic functions
(setf location-document): Exported generic functions
(setf location-document): Exported generic functions
(setf location-document): Exported generic functions
(setf location-namespaces): Exported generic functions
(setf location-namespaces): Exported generic functions
(setf location-namespaces): Exported generic functions
(setf location-path): Exported generic functions
(setf location-path): Exported generic functions
(setf location-path): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf val): Exported generic functions
(setf val): Exported generic functions
(setf val): Exported generic functions
(setf val): Exported generic functions
(setf val): Exported generic functions
(setf val): Exported generic functions
(setf val): Exported generic functions

-
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml: Exported generic functions
->xml-conversion-error: Exported functions

@
@: Exported generic functions
@: Exported generic functions
@: Exported generic functions
@: Exported generic functions

C
clear-location-classes!: Internal functions
compile!: Internal generic functions
compile!: Internal generic functions
compile!: Internal generic functions
conversion-error-destination: Exported generic functions
conversion-error-destination: Exported generic functions
conversion-error-function: Exported generic functions
conversion-error-function: Exported generic functions
conversion-error-type: Exported generic functions
conversion-error-type: Exported generic functions
conversion-error-value: Exported generic functions
conversion-error-value: Exported generic functions
create-xpath: Exported generic functions
create-xpath: Exported generic functions
create-xpath: Exported generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-element: Internal generic functions
create-xpath-sibling: Internal generic functions
create-xpath-sibling: Internal generic functions
create-xpath-sibling: Internal generic functions

D
define-dynamic-class-family: Exported macros

E
ensure-find-class: Internal functions
ensure-location-class: Exported functions
evaluate!: Internal generic functions
evaluate!: Internal generic functions
evaluate!: Internal generic functions

F
Function, %add-available-conversion-methods: Internal functions
Function, %add-available-conversion-methods-for-function: Internal functions
Function, %compute-location-class: Internal functions
Function, %ensure-class-name: Internal functions
Function, %expand-xpath-element: Internal functions
Function, %location-error-document-string: Internal functions
Function, %make-key/sorted: Internal functions
Function, %make-key/unsorted: Internal functions
Function, %make-location-and-place-forms: Internal functions
Function, %make-location-form: Internal functions
Function, %maybe-add-default-namespaces: Internal functions
Function, %parse-bindings-and-options: Internal functions
Function, %parse-doc-and-options: Internal functions
Function, %parse-list-of-atoms: Internal functions
Function, %process-superclass-specs: Internal functions
Function, %signal-no-such-accessor-form: Internal functions
Function, %split-at-whitespace: Internal functions
Function, ->xml-conversion-error: Exported functions
Function, clear-location-classes!: Internal functions
Function, ensure-find-class: Internal functions
Function, ensure-location-class: Exported functions
Function, location-classes: Exported functions
Function, xml->-conversion-error: Exported functions

G
Generic Function, %parse-access-spec: Internal generic functions
Generic Function, (setf @): Exported generic functions
Generic Function, (setf location-compiled-path): Internal generic functions
Generic Function, (setf location-document): Exported generic functions
Generic Function, (setf location-namespaces): Exported generic functions
Generic Function, (setf location-path): Exported generic functions
Generic Function, (setf name): Exported generic functions
Generic Function, (setf val): Exported generic functions
Generic Function, ->xml: Exported generic functions
Generic Function, @: Exported generic functions
Generic Function, compile!: Internal generic functions
Generic Function, conversion-error-destination: Exported generic functions
Generic Function, conversion-error-function: Exported generic functions
Generic Function, conversion-error-type: Exported generic functions
Generic Function, conversion-error-value: Exported generic functions
Generic Function, create-xpath: Exported generic functions
Generic Function, create-xpath-element: Internal generic functions
Generic Function, create-xpath-sibling: Internal generic functions
Generic Function, evaluate!: Internal generic functions
Generic Function, invalid-binding-form-form: Exported generic functions
Generic Function, invalid-binding-form-name: Exported generic functions
Generic Function, invalid-binding-form-spec: Exported generic functions
Generic Function, loc: Exported generic functions
Generic Function, location-attribute: Internal generic functions
Generic Function, location-compiled-path: Internal generic functions
Generic Function, location-document: Exported generic functions
Generic Function, location-error-document: Exported generic functions
Generic Function, location-error-expected: Internal generic functions
Generic Function, location-error-path: Exported generic functions
Generic Function, location-if-multiple-matches: Internal generic functions
Generic Function, location-namespaces: Exported generic functions
Generic Function, location-path: Exported generic functions
Generic Function, location-result: Exported generic functions
Generic Function, make-location-class: Exported generic functions
Generic Function, maybe-decode-qname: Internal generic functions
Generic Function, name: Exported generic functions
Generic Function, result-condition-result: Exported generic functions
Generic Function, val: Exported generic functions
Generic Function, xml->: Exported generic functions
Generic Function, xpath-creation-error-location: Exported generic functions
Generic Function, xpath-creation-error-name: Exported generic functions
Generic Function, xpath-creation-error-predicate: Exported generic functions
Generic Function, xpath-creation-error-type: Exported generic functions

I
invalid-binding-form-form: Exported generic functions
invalid-binding-form-form: Exported generic functions
invalid-binding-form-name: Exported generic functions
invalid-binding-form-name: Exported generic functions
invalid-binding-form-spec: Exported generic functions
invalid-binding-form-spec: Exported generic functions

L
loc: Exported generic functions
loc: Exported generic functions
loc: Exported generic functions
loc: Exported generic functions
loc: Exported generic functions
loc: Exported generic functions
location-attribute: Internal generic functions
location-attribute: Internal generic functions
location-attribute: Internal generic functions
location-attribute: Internal generic functions
location-attribute: Internal generic functions
location-attribute: Internal generic functions
location-attribute: Internal generic functions
location-classes: Exported functions
location-compiled-path: Internal generic functions
location-compiled-path: Internal generic functions
location-document: Exported generic functions
location-document: Exported generic functions
location-error-document: Exported generic functions
location-error-document: Exported generic functions
location-error-expected: Internal generic functions
location-error-expected: Internal generic functions
location-error-path: Exported generic functions
location-error-path: Exported generic functions
location-if-multiple-matches: Internal generic functions
location-if-multiple-matches: Internal generic functions
location-namespaces: Exported generic functions
location-namespaces: Exported generic functions
location-path: Exported generic functions
location-path: Exported generic functions
location-result: Exported generic functions
location-result: Exported generic functions

M
Macro, define-dynamic-class-family: Exported macros
Macro, with-locations: Exported macros
Macro, with-locations-r/o: Exported macros
make-location-class: Exported generic functions
make-location-class: Exported generic functions
maybe-decode-qname: Internal generic functions
maybe-decode-qname: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, %parse-access-spec: Internal generic functions
Method, (setf @): Exported generic functions
Method, (setf @): Exported generic functions
Method, (setf @): Exported generic functions
Method, (setf @): Exported generic functions
Method, (setf location-compiled-path): Internal generic functions
Method, (setf location-compiled-path): Internal generic functions
Method, (setf location-document): Exported generic functions
Method, (setf location-document): Exported generic functions
Method, (setf location-namespaces): Exported generic functions
Method, (setf location-namespaces): Exported generic functions
Method, (setf location-path): Exported generic functions
Method, (setf location-path): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf val): Exported generic functions
Method, (setf val): Exported generic functions
Method, (setf val): Exported generic functions
Method, (setf val): Exported generic functions
Method, (setf val): Exported generic functions
Method, (setf val): Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, ->xml: Exported generic functions
Method, @: Exported generic functions
Method, @: Exported generic functions
Method, @: Exported generic functions
Method, compile!: Internal generic functions
Method, compile!: Internal generic functions
Method, conversion-error-destination: Exported generic functions
Method, conversion-error-function: Exported generic functions
Method, conversion-error-type: Exported generic functions
Method, conversion-error-value: Exported generic functions
Method, create-xpath: Exported generic functions
Method, create-xpath: Exported generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-element: Internal generic functions
Method, create-xpath-sibling: Internal generic functions
Method, create-xpath-sibling: Internal generic functions
Method, evaluate!: Internal generic functions
Method, evaluate!: Internal generic functions
Method, invalid-binding-form-form: Exported generic functions
Method, invalid-binding-form-name: Exported generic functions
Method, invalid-binding-form-spec: Exported generic functions
Method, loc: Exported generic functions
Method, loc: Exported generic functions
Method, loc: Exported generic functions
Method, loc: Exported generic functions
Method, loc: Exported generic functions
Method, location-attribute: Internal generic functions
Method, location-attribute: Internal generic functions
Method, location-attribute: Internal generic functions
Method, location-attribute: Internal generic functions
Method, location-attribute: Internal generic functions
Method, location-attribute: Internal generic functions
Method, location-compiled-path: Internal generic functions
Method, location-document: Exported generic functions
Method, location-error-document: Exported generic functions
Method, location-error-expected: Internal generic functions
Method, location-error-path: Exported generic functions
Method, location-if-multiple-matches: Internal generic functions
Method, location-namespaces: Exported generic functions
Method, location-path: Exported generic functions
Method, location-result: Exported generic functions
Method, make-location-class: Exported generic functions
Method, maybe-decode-qname: Internal generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, result-condition-result: Exported generic functions
Method, val: Exported generic functions
Method, val: Exported generic functions
Method, val: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xml->: Exported generic functions
Method, xpath-creation-error-location: Exported generic functions
Method, xpath-creation-error-name: Exported generic functions
Method, xpath-creation-error-predicate: Exported generic functions
Method, xpath-creation-error-type: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions

R
result-condition-result: Exported generic functions
result-condition-result: Exported generic functions

V
val: Exported generic functions
val: Exported generic functions
val: Exported generic functions
val: Exported generic functions

W
with-locations: Exported macros
with-locations-r/o: Exported macros

X
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->: Exported generic functions
xml->-conversion-error: Exported functions
xpath-creation-error-location: Exported generic functions
xpath-creation-error-location: Exported generic functions
xpath-creation-error-name: Exported generic functions
xpath-creation-error-name: Exported generic functions
xpath-creation-error-predicate: Exported generic functions
xpath-creation-error-predicate: Exported generic functions
xpath-creation-error-type: Exported generic functions
xpath-creation-error-type: Exported generic functions

Jump to:   %   (   -   @  
C   D   E   F   G   I   L   M   N   R   V   W   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   D   E   F   I   L   N   P   R   S   T   V  
Index Entry  Section

*
*cl-namespaces*: Exported special variables
*location-classes*: Internal special variables

C
compiled-path: Exported classes

D
destination: Exported conditions
document: Exported conditions
document: Exported classes

E
expected: Exported conditions

F
form: Exported conditions
function: Exported conditions

I
if-multiple-matches: Exported classes
if-no-match: Exported classes

L
location: Exported conditions

N
name: Exported conditions
name: Exported conditions
namespaces: Exported classes

P
path: Exported conditions
path: Exported classes
predicate: Exported conditions

R
result: Exported conditions
result: Exported classes

S
Slot, compiled-path: Exported classes
Slot, destination: Exported conditions
Slot, document: Exported conditions
Slot, document: Exported classes
Slot, expected: Exported conditions
Slot, form: Exported conditions
Slot, function: Exported conditions
Slot, if-multiple-matches: Exported classes
Slot, if-no-match: Exported classes
Slot, location: Exported conditions
Slot, name: Exported conditions
Slot, name: Exported conditions
Slot, namespaces: Exported classes
Slot, path: Exported conditions
Slot, path: Exported classes
Slot, predicate: Exported conditions
Slot, result: Exported conditions
Slot, result: Exported classes
Slot, spec: Exported conditions
Slot, type: Exported conditions
Slot, type: Exported conditions
Slot, value: Exported conditions
spec: Exported conditions
Special Variable, *cl-namespaces*: Exported special variables
Special Variable, *location-classes*: Internal special variables

T
type: Exported conditions
type: Exported conditions

V
value: Exported conditions

Jump to:   *  
C   D   E   F   I   L   N   P   R   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   -  
A   C   E   I   L   M   N   P   R   S   T   X  
Index Entry  Section

-
->xml-conversion-error: Exported conditions

A
append-nodes-mixin: Exported classes
assign-mode-designator: Internal types

C
Class, append-nodes-mixin: Exported classes
Class, create-missing-nodes-mixin: Exported classes
Class, ignore-empty-result-mixin: Internal classes
Class, location: Exported classes
Class, multi-location: Exported classes
Class, singleton-location: Exported classes
Condition, ->xml-conversion-error: Exported conditions
Condition, conversion-error: Exported conditions
Condition, empty-result-set: Exported conditions
Condition, invalid-binding-form: Exported conditions
Condition, invalid-result-type: Exported conditions
Condition, location-error: Exported conditions
Condition, missing-xpath-source: Exported conditions
Condition, no-->xml-conversion-method: Exported conditions
Condition, no-conversion-method-mixin: Exported conditions
Condition, no-such-accessor-form: Exported conditions
Condition, no-xml->-conversion-method: Exported conditions
Condition, result-condition: Exported conditions
Condition, too-many-matches-in-result-set: Exported conditions
Condition, xml->-conversion-error: Exported conditions
Condition, xpath-creation-error: Exported conditions
conversion-error: Exported conditions
create-missing-nodes-mixin: Exported classes

E
empty-result-set: Exported conditions

I
if-multiple-matches-policy-designator: Internal types
if-no-match-policy-designator: Internal types
ignore-empty-result-mixin: Internal classes
invalid-binding-form: Exported conditions
invalid-result-type: Exported conditions

L
location: Exported classes
location-error: Exported conditions

M
missing-xpath-source: Exported conditions
multi-location: Exported classes

N
no-->xml-conversion-method: Exported conditions
no-conversion-method-mixin: Exported conditions
no-such-accessor-form: Exported conditions
no-xml->-conversion-method: Exported conditions

P
Package, xml.location: The xml<dot>location package
Package, xml.location.compat: The xml<dot>location<dot>compat package

R
result-condition: Exported conditions

S
singleton-location: Exported classes
superclass-spec: Internal types
superclass-spec-end: Internal types
superclass-spec-simple: Internal types
superclass-spec-start: Internal types
System, xml.location: The xml<dot>location system

T
too-many-matches-in-result-set: Exported conditions
Type, assign-mode-designator: Internal types
Type, if-multiple-matches-policy-designator: Internal types
Type, if-no-match-policy-designator: Internal types
Type, superclass-spec: Internal types
Type, superclass-spec-end: Internal types
Type, superclass-spec-simple: Internal types
Type, superclass-spec-start: Internal types

X
xml->-conversion-error: Exported conditions
xml.location: The xml<dot>location system
xml.location: The xml<dot>location package
xml.location.compat: The xml<dot>location<dot>compat package
xpath-creation-error: Exported conditions

Jump to:   -  
A   C   E   I   L   M   N   P   R   S   T   X