APISPEC-XML full listing

Name

APISPEC-XML full listing -- All funcallable objects

Package Content

Methods

%MAKE-ATTR-INFO
 (%MAKE-ATTR-INFO)
Called By 

MAKE-XML-ATTR-INFO

Location 

apispec/xml.lisp

%MAKE-SUB-INFO
 (%MAKE-SUB-INFO)
Called By 

MAKE-XML-SUBELEMENT-INFO

Location 

apispec/xml.lisp

ATTR-COMPARE
 (ATTR-COMPARE NAME ATTR-OBJ) [macro]

COPY-XML-ATTR-INFO
 (COPY-XML-ATTR-INFO (OBJ XML-ATTR-INFO)) [function]

COPY-XML-SUBELEMENT-INFO
 (COPY-XML-SUBELEMENT-INFO (OBJ XML-SUBELEMENT-INFO)) [function]

CREATE-ATTRIBUTE
 (CREATE-ATTRIBUTE XMLOBJ NAME TYPE ACC-PTR) [function]
Description 

see (create-subelement ...)

Calls 

MAKE-XML-ATTR-INFO, SLOT-VALUE and VECTOR-PUSH

Location 

apispec/xml-base.lisp

CREATE-SUBELEMENT
 (CREATE-SUBELEMENT XMLOBJ NAME TYPE ACC-PTR) [function]
Description 

adds a subelement to given xmlobj. Needs name and type and an acc-ptr (just a symbol which can be used with (slot-value ..)

Calls 

MAKE-XML-SUBELEMENT-INFO, SLOT-VALUE and VECTOR-PUSH

Location 

apispec/xml-base.lisp

ELEMENT-CONTENT
 (ELEMENT-CONTENT XMLOBJ CONTENT XTOOL) [generic]
Description 

This function deals with textual content being added to an element. See init-Attributes for advice on how to proceed with the implementation.

Location 

apispec/xml.lisp

ELEMENT-CONTENT
 (ELEMENT-CONTENT (XMLOBJ XML-CLASS) CONTENT XTOOL) [method]
Calls 

(SETF SLOT-VALUE), MY-SUB-FIND, SLOT-VALUE, XML-SUBELEMENT-INFO-PTR and XML-TOOL.WHO-CONTENT

Location 

apispec/xml-base.lisp

ELEMENT-END
 (ELEMENT-END XMLOBJ NAME XTOOL) [generic]
Description 

Returns a boolean value indicating whether it is ending or not. See basic implementation.

Location 

apispec/xml.lisp

ELEMENT-END
 (ELEMENT-END (XMLOBJ XML-CLASS) NAME XTOOL) [method]
Calls 

(SETF XML-TOOL.WANT-CONTENT), GET-ELEMENT-NAME and STRING-EQUAL

Location 

apispec/xml-base.lisp

ELEMENT-START
 (ELEMENT-START XMLOBJ NAME ATTRS XTOOL) [generic]
Description 

This function makes sure that the xmlobj is added in the right place in it's parent. It should return the xmlobj. See initAttributes for advice on how to proceed with implementation.

Location 

apispec/xml.lisp

GET-INDENT
 (GET-INDENT HOWMANY) [macro]
Description 

This macro expands into code which returns a SIMPLE-BASE-STRING with space indenting

Location 

apispec/xml-base.lisp

INIT-ATTRIBUTES
 (INIT-ATTRIBUTES XMLOBJ ATTRS) [generic]
Description 

This generic function is called add attributes in an alist to an already created object. The default implementation has a slightly complicated functionality and one should probably mostly limit onseself to :AFTER methods.

Location 

apispec/xml.lisp

INIT-ATTRIBUTES
 (INIT-ATTRIBUTES (XMLOBJ XML-CLASS) ATTRS) [method]
Calls 

(SETF SLOT-VALUE), MY-ATTR-FIND, SLOT-VALUE, SYMBOL-NAME and XML-ATTR-INFO-PTR

Location 

apispec/xml-base.lisp

MAKE-XML-ATTR-INFO
 (MAKE-XML-ATTR-INFO NAME TYPE SLOT-NAME) [function]
Description 

Returns an object of type XML-Attr-Info

Called By 

CREATE-ATTRIBUTE

Calls 

%MAKE-ATTR-INFO and INTERN

Location 

apispec/xml-base.lisp

MAKE-XML-SUBELEMENT-INFO
 (MAKE-XML-SUBELEMENT-INFO NAME ITSTYPE PTR) [function]
Description 

Returns an object of type XML-SubElement-Info

Called By 

CREATE-SUBELEMENT

Calls 

%MAKE-SUB-INFO and INTERN

Location 

apispec/xml-base.lisp

MAKE-XML-TOOL
 (MAKE-XML-TOOL FACTORY) [function]
Description 

Returns an object of type XML-Tool initialised with necessary factory

Called By 

ANALYSE-FILES, CONVERT-CSF-TO-SDOC, LINK-CSF-FILES and PARSE-TYPED-XML-FILE

Calls 

MAKE-INSTANCE

Location 

apispec/xml-base.lisp

PARSE-ATTRIBUTE
 (PARSE-ATTRIBUTE STR) [function]
Description 

Parses an attribute and returns a CONS with the info

Location 

apispec/xml-base.lisp

PARSE-ELEMENT-CONTENT
 (PARSE-ELEMENT-CONTENT XTOOL CONTENT) [generic]
Description 

This function should call element-Content if the wantc-ontent flag in xtool is non-nil.

Called By 

PARSE-SEXP-OBJ

Location 

apispec/xml.lisp

PARSE-ELEMENT-CONTENT
 (PARSE-ELEMENT-CONTENT (XTOOL XML-TOOL) CONTENT) [method]
Calls 

ELEMENT-CONTENT, XML-TOOL.STACK and XML-TOOL.WANT-CONTENT

Location 

apispec/xml-base.lisp

PARSE-ELEMENT-END
 (PARSE-ELEMENT-END XTOOL NAME) [generic]
Description 

This function should pop off the top of the stack in xtool of element-End returns non-nil.

Called By 

PARSE-SEXP-OBJ

Location 

apispec/xml.lisp

PARSE-ELEMENT-END
 (PARSE-ELEMENT-END (XTOOL XML-TOOL) NAME) [method]
Calls 

ELEMENT-END, POP and XML-TOOL.STACK

Location 

apispec/xml-base.lisp

PARSE-ELEMENT-START
 (PARSE-ELEMENT-START XTOOL NAME ATTRS) [generic]
Description 

This function which has default implementation can be specialised on the xml-tool and is also given a name of the new object and an alist of attrs. It is supposed to initialise topObjects and the stack of the xml-tool as well. It is meant to call element-Start and then push the object returned from element-Start onto the stack in xtool.

Called By 

PARSE-SEXP-OBJ

Location 

apispec/xml.lisp

PARSE-ELEMENT-START
 (PARSE-ELEMENT-START (XTOOL XML-TOOL) NAME ATTRS) [method]
Calls 

ELEMENT-START, INIT-ATTRIBUTES, PRODUCE-XML-OBJECT, XML-TOOL.FACTORY, XML-TOOL.STACK and XML-TOOL.TOP-OBJECTS

Location 

apispec/xml-base.lisp

PARSE-SEXP-OBJ
 (PARSE-SEXP-OBJ OBJ XML-TOOL) [function]
Called By 

PARSE-SEXP-OBJ and READ-SX-FILE

Calls 

PARSE-ELEMENT-CONTENT, PARSE-ELEMENT-END, PARSE-ELEMENT-START, PARSE-SEXP-OBJ and SYMBOL-NAME

Location 

apispec/xml-sexp.lisp

PARSE-TYPED-XML-FILE
 (PARSE-TYPED-XML-FILE FNAME FACTORY TYPE) [function]
Description 

Returns the top-objects or NIL

Called By 

PARSE-APISPEC-FILE, PARSE-CSF-FILE, PARSE-MODSPEC-FILE and PARSE-SDOC-FILE

Calls 

FIGURE-OUT-FNAME, MAKE-XML-TOOL, PARSE-XML, WARN and XML-TOOL.TOP-OBJECTS

Location 

apispec/xml-base.lisp

PARSE-XML
 (PARSE-XML FILE-NAME XML-TOOL) [function]
Description 

Takes two arguments, file-name which is a string and xml-tool which should be an instance inited with a factory. Returns nil on failure.

Called By 

LINK-CSF-FILES and PARSE-TYPED-XML-FILE

Calls 

PARSE-XML-FILE and READ-SX-FILE

Location 

apispec/xml-base.lisp

PARSE-XML-FILE
 (PARSE-XML-FILE FILE-NAME) [function]
Description 

takes a string as argument and calls xml2sexp. returns name of file with esis, or nil if something screwed up.

Called By 

PARSE-XML

Calls 

MAKE-TEMPORARY-FILENAME, RUN-EXTERNAL-PROGRAM, WHEN-VERBOSE and WIPE-FILE

Location 

apispec/xml-base.lisp

PRINT-AS-XML
 (PRINT-AS-XML XMLOBJ STREAM XTOOL) [generic]
Description 

This function can be specialised for individual objects (xmlobj). The xtool argument should be an object of class XML-Tool.

Called By 

ANALYSE-FILES, CONVERT-CSF-TO-SDOC and LINK-CSF-FILES

Location 

apispec/xml.lisp

PRINT-AS-XML
 (PRINT-AS-XML (XMLOBJ XML-CLASS) STREAM XTOOL) [method]
Calls 

GET-ELEMENT-NAME, GET-INDENT, SLOT-VALUE, TERPRI, WRITE-CHAR, WRITE-STRING and XML-TOOL.INDENT

Location 

apispec/xml-base.lisp

PRINT-OBJECT
 (PRINT-OBJECT (INST XML-TOOL) STREAM) [method]
 (PRINT-OBJECT (INST XML-FACTORY) STREAM) [method]

PRODUCE-XML-OBJECT
 (PRODUCE-XML-OBJECT FACTORY CLASSNAME) [generic]
Description 

The default implementation will give an error, and this function should be implemented for each factory-class you use. It returns a fresh object of class XML-Class. The classname argument is a simple-base-string.

Location 

apispec/xml.lisp

PRODUCE-XML-OBJECT
 (PRODUCE-XML-OBJECT (FACTORY XML-FACTORY) CLASSNAME) [method]
Calls 

ERROR

Location 

apispec/xml-base.lisp

READ-ESIS-FILE
 (READ-ESIS-FILE FILENAME XML-TOOL) [function]
Description 

filename is assumed to be a pathname and xml-tool a real xml-tool inited with a factory

Calls 

EAT-FILE and WIPE-FILE

Location 

apispec/xml-esis.lisp

READ-SX-FILE
 (READ-SX-FILE FNAME XML-TOOL) [function]
Called By 

PARSE-XML

Calls 

LOAD, PARSE-SEXP-OBJ and WHEN-VERBOSE

Location 

apispec/xml-sexp.lisp

REGISTER-OBJECT
 (REGISTER-OBJECT (OBJ XML-CLASS) CONTEXT) [method]
Calls 

DO-ITERATION

Location 

apispec/xml-base.lisp

SUBELEMENT-COMPARE
 (SUBELEMENT-COMPARE NAME SUB-OBJ) [macro]

VERIFY-OBJECT
 (VERIFY-OBJECT (OBJ XML-CLASS) CONTEXT) [method]
Called By 

CONVERT-CSF-TO-SDOC

Calls 

DO-ITERATION

Location 

apispec/xml-base.lisp

VERIFY-OBJECT-ACTUAL
 (VERIFY-OBJECT-ACTUAL OBJ CONTEXT WHEN) [method]

WRITE-STRING-WITH-MAPPING
 (WRITE-STRING-WITH-MAPPING STRING STREAM) [function]
Description 

Write string to stream using mappings in *external-format-mapping*. Toy version.

Location 

apispec/xml-base.lisp

XML-ATTR-INFO-NAME
 (XML-ATTR-INFO-NAME (OBJ XML-ATTR-INFO)) [function]

(SETF XML-ATTR-INFO-NAME)
 ((SETF XML-ATTR-INFO-NAME) (OBJ XML-ATTR-INFO)) [function]

XML-ATTR-INFO-P
 (XML-ATTR-INFO-P OBJ) [predicate]

XML-ATTR-INFO-PTR
 (XML-ATTR-INFO-PTR (OBJ XML-ATTR-INFO)) [function]

(SETF XML-ATTR-INFO-PTR)
 ((SETF XML-ATTR-INFO-PTR) (OBJ XML-ATTR-INFO)) [function]

XML-ATTR-INFO-THE-TYPE
 (XML-ATTR-INFO-THE-TYPE (OBJ XML-ATTR-INFO)) [function]

(SETF XML-ATTR-INFO-THE-TYPE)
 ((SETF XML-ATTR-INFO-THE-TYPE) (OBJ XML-ATTR-INFO)) [function]

XML-SUBELEMENT-INFO-NAME
 (XML-SUBELEMENT-INFO-NAME (OBJ XML-SUBELEMENT-INFO)) [function]

(SETF XML-SUBELEMENT-INFO-NAME)
 ((SETF XML-SUBELEMENT-INFO-NAME) (OBJ XML-SUBELEMENT-INFO)) [function]

XML-SUBELEMENT-INFO-P
 (XML-SUBELEMENT-INFO-P OBJ) [predicate]

XML-SUBELEMENT-INFO-PTR
 (XML-SUBELEMENT-INFO-PTR (OBJ XML-SUBELEMENT-INFO)) [function]

(SETF XML-SUBELEMENT-INFO-PTR)
 ((SETF XML-SUBELEMENT-INFO-PTR) (OBJ XML-SUBELEMENT-INFO)) [function]

XML-SUBELEMENT-INFO-THE-TYPE
 (XML-SUBELEMENT-INFO-THE-TYPE (OBJ XML-SUBELEMENT-INFO)) [function]

(SETF XML-SUBELEMENT-INFO-THE-TYPE)
 ((SETF XML-SUBELEMENT-INFO-THE-TYPE) (OBJ XML-SUBELEMENT-INFO)) [function]

XMLIFY-STRING
 (XMLIFY-STRING STR) [function]
Description 

I don't know if it is any fast. I hope so. Uses *tmpres* to save new string in.

Called By 

DB-PRESENT-DOC-LIST, DB-PRESENT-INFO-LIST, DB-PRINT-TABLE, GET-CLASS-FACTS, POSSIBLY-CVS-LINK, PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK, PRESENT-OBJECT-FULL-METHOD/DOCBOOK, PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK and PRINT-HEADER-PACKAGE-HEADER/DOCBOOK

Calls 

MAKE-STRING

Location 

apispec/xml-base.lisp

This documentation was generated 27 Oct 2003 from the original sources by Albert v.0.4.9.