SPRES-IMPL full listing

%ADD-DOC-KWD-MAPPINGS

(%ADD-DOC-KWD-MAPPINGS TABLE) [function]

Description		adds doc kwd mappings to the given table.
Calls		(SETF GETHASH)
Location		spres/configure.lisp

%CHECK-FOR-CLASS-MOD

(%CHECK-FOR-CLASS-MOD OBJ CLASS-MOD) [function]

Called By		TL-IS-INTERFACE? and TL-IS-STRUCT?
Calls		FIND, GET-INFO-OF-TYPE, MAPCAR, SLOT-VALUE and STRIP-INFO-FIELDS
Location		spres/tools.lisp

%FIND-CLASS-IN-HIERARCHY

(%FIND-CLASS-IN-HIERARCHY HIER THE-CLASS) [function]

Description		Searches through given HIERARCHY hier for given class-name. Recursive
Called By		%FIND-CLASS-IN-HIERARCHY and FIND-CLASS-IN-HIERARCHY
Calls		%FIND-CLASS-IN-HIERARCHY, GET-OBJECT-NAME, STRING=, TNODE.CLASS and TNODE.KIDS
Location		spres/hier.lisp

%GET-INDENT

(%GET-INDENT NUM) [function]

Description		returns indent as string
Calls		MAKE-STRING
Location		spres/hier.lisp

%STRIP-SETF

(%STRIP-SETF X) [function]

Called By		TL-SORT-BY-NAME
Calls		CHAR-EQUAL, SCHAR and SUBSEQ
Location		spres/tools.lisp

ADD-SPRES-FLAG!

(ADD-SPRES-FLAG! FLAG) [function]

Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK, PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK, PRESENT-OBJECT-FULL-METHOD/DOCBOOK and PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK
Location		spres/base.lisp

CHECK-FOR-ID

(CHECK-FOR-ID OBJ) [function]

Description		checks if there is an id for obj.
Calls		GETHASH
Location		spres/base.lisp

CHECK-FOR-LANGUAGE

(CHECK-FOR-LANGUAGE NAME) [function]

Description		Returns entry in table of installed languages.
Called By		REMOVE-LANGUAGE and SET-LANGUAGE
Calls		GETHASH and STRING-DOWNCASE
Location		spres/lang.lisp

COLLECT-PARENT-PATH

(COLLECT-PARENT-PATH OBJ) [function]

Description		Returns the parents of OBJ in a list.
Called By		COLLECT-PARENT-PATH
Calls		COLLECT-PARENT-PATH and PARENT-OF
Location		spres/tools.lisp

COPY-FILE-INFO

(COPY-FILE-INFO (OBJ FILE-INFO)) [function]

COPY-IDX-ENTRY

(COPY-IDX-ENTRY (OBJ IDX-ENTRY)) [function]

COPY-RULE-ARG

(COPY-RULE-ARG (OBJ RULE-ARG)) [function]

COPY-RULE-DEF

(COPY-RULE-DEF (OBJ RULE-DEF)) [function]

COPY-RULE-INFO

(COPY-RULE-INFO (OBJ RULE-INFO)) [function]

COUNT-OBJ-TYPES

(COUNT-OBJ-TYPES LIST SOME-TYPE) [function]

Description		Counts and returns number of types.
Called By		COUNT-OBJ-TYPES and GET-CLASS-FACTS
Calls		COUNT-OBJ-TYPES and GET-OBJECT-CONTENT
Location		spres/object.lisp

DB-ASSOC-TABLE-AS-TREE

(DB-ASSOC-TABLE-AS-TREE DOC OBJ ASSOC-LIST &KEY (STYLE :TABLE) (TITLE NIL)) [function]

Description		Returns an association-list back as an appropriate DB-tree. Known styles are :variablelist and :table
Called By		DB-PRESENT-CLASS-DETAILS
Calls		GET-WORD, MAPCAR and WARN
Location		spres/r-db.lisp

DB-GET-DTD

(DB-GET-DTD) [function]

Description		Returns a string with the chosen docbook dtd.
Called By		PRINT-HEADER-DOCUMENT-HEADER/DOCBOOK
Location		spres/r-db.lisp

(SETF DB-GET-DTD)

((SETF DB-GET-DTD) DTD-SPEC) [function]

Description		Registers a docbook dtd for use.
Called By		PRESENT-OBJECT-TPL/DOCBOOK
Location		spres/r-db.lisp

DB-GET-ID-PREFIX

(DB-GET-ID-PREFIX OBJ) [function]

Description		Tries to create an id for an object. returns a string.
Location		spres/r-db.lisp

DB-INSERT-INDEX

(DB-INSERT-INDEX DOC FROM-LIST COLUMNS &KEY (ONLY-LINK-EXISTING T)) [function]

Description		Inserts an index gathered from FROM-LIST and presents it in COLUMNS columns.
Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK and PRESENT-OBJECT-PCK-IDX/DOCBOOK
Calls		EOL, FLATTEN, FORMAT, IDX-ENTRY-OBJ, IDX-ENTRY-PARENT, MAKE-OBJ-LINK, PUT and SORT-IDX-LIST
Location		spres/r-db.lisp

DB-PRESENT-CLASS-DETAILS

(DB-PRESENT-CLASS-DETAILS DOC OBJ) [function]

Description		Presents class-details in a refsect in doc.
Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK
Calls		DB-ASSOC-TABLE-AS-TREE, GET-CLASS-FACTS, GET-CLASS-SIGNATURE, GET-WORD, TL-IS-STRUCT? and TREE-PUT
Location		spres/r-db.lisp

DB-PRESENT-DOC-LIST

(DB-PRESENT-DOC-LIST DOC-LIST DOC TYPE &KEY SUPPRESS-WRAPPER) [function]

Description		Takes a doc-list and presents it to the given doc object
Called By		PRESENT-OBJECT-FULL-ENUM/DOCBOOK, PRESENT-OBJECT-FULL-METHOD/DOCBOOK, PRESENT-OBJECT-FULL-TYPESPEC/DOCBOOK and PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK
Calls		APISPEC-XML:XMLIFY-STRING EOL FUNCALL GET-DOC-HANDLER GET-DOC-WORD GET-STRING GETHASH MAKE-HASH-TABLE MAPCAR MAPHASH PUT SOME TL-CLEAN-FOR-LEADING-STARS
Location		spres/r-db.lisp

DB-PRESENT-INFO-LIST

(DB-PRESENT-INFO-LIST INFO-LIST DOC TYPE &KEY SUPPRESS-WRAPPER) [function]

Description		Takes a doc-list and presents it to the given doc object
Called By		PRESENT-OBJECT-FULL-METHOD/DOCBOOK, PRESENT-OBJECT-FULL-TYPESPEC/DOCBOOK and PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK
Calls		APISPEC-XML:XMLIFY-STRING EOL FUNCALL GET-DOC-WORD GET-INFO-HANDLER GET-STRING GETHASH MAKE-HASH-TABLE MAPHASH PUT SDOC-INFO.TYPE TL-CLEAN-FOR-LEADING-STARS
Location		spres/r-db.lisp

DB-PRINT-LOCATION

(DB-PRINT-LOCATION LOC-LIST DOC TYPE &KEY SUPPRESS-WRAPPER) [function]

Description		Takes a doc-list and presents it to the given doc object
Called By		PRESENT-OBJECT-FULL-ENUM/DOCBOOK, PRESENT-OBJECT-FULL-METHOD/DOCBOOK, PRESENT-OBJECT-FULL-TYPESPEC/DOCBOOK and PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK
Calls		EOL, GET-DOC-WORD, GET-STRING and PUT
Location		spres/r-db.lisp

DB-PRINT-TABLE

(DB-PRINT-TABLE DOC STRING-LIST &KEY TITLE (COLUMNS 3) (XMLIFY T)) [function]

Description		Prints the string-list as a table.
Called By		PRINT-HEADER-PACKAGE-HEADER/DOCBOOK
Calls		APISPEC-XML:XMLIFY-STRING, EOL and PUT
Location		spres/r-db.lisp

DEF-RULE-FORM

(DEF-RULE-FORM NAME ARGS &OPTIONAL VARIATION) [macro]

Description		Defines a rule-form, with the given name. The list args contains the arguments where each argument is a list: (REQ-KEYWORD LOC-VAR-NAME REBIND-VAR) REQ-KEYWORD is e.g ?class and refers to the keyword to use in a :req argument for dispatch LOC-VAR-NAME is the name of the local variable within the rule REBIND-VAR is the name of the var to rebind to point to the LOC-VAR-NAME. It's mainly for convenience, and when NIL it is skipped The list VARIATION contains keywords that might be interpreted in special ways.
Location		spres/rules/r-lang.lisp

DEF-RULE-INFO

(DEF-RULE-INFO INFORMATION) [macro]

Description		Defines a presentation rule to be followed later.
Location		spres/rules/r-lang.lisp

DEFINE-FORMAT

(DEFINE-FORMAT NAME KEY) [macro]

Calls		CONCAT-PNAMES
Location		spres/base.lisp

DEFINE-LANGUAGE

(DEFINE-LANGUAGE NAME CODE) [macro]

Calls		CONCAT-PNAMES and GENSYM
Location		spres/lang.lisp

DOCBOOK-PAGE-TITLE

(DOCBOOK-PAGE-TITLE DOC OBJECT) [generic]

Description		Returns a string to use as page-title for an object in docbook, or NIL if default should be used.
Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK
Location		spres/base.lisp

DOCBOOK-PAGE-TITLE

(DOCBOOK-PAGE-TITLE DOC OBJECT) [method]

DRAW-HIERARCHY

(DRAW-HIERARCHY DOC OBJ THE-HIERARCHY) [function]

Description		Draws hierarchy somehow.
Calls		FIND-CLASS-IN-HIERARCHY, SDOC-CLASS.PARENTS, TNODE.KIDS and WARN
Location		spres/hier.lisp

EOL

(EOL) [function]

Called By		DB-INSERT-INDEX DB-PRESENT-DOC-LIST DB-PRESENT-INFO-LIST DB-PRINT-LOCATION DB-PRINT-TABLE INFO-TO-FIELD PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK PRESENT-OBJECT-FULL-CLASS/DOCBOOK PRESENT-OBJECT-FULL-ENUM/DOCBOOK PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK PRESENT-OBJECT-FULL-METHOD/DOCBOOK PRESENT-OBJECT-FULL-MODULE/DOCBOOK PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK PRESENT-OBJECT-FULL-TYPESPEC/DOCBOOK PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK PRESENT-OBJECT-PCK-IDX/DOCBOOK PRESENT-OBJECT-TPL/DOCBOOK PRINT-CLASS-HIERARCHY PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER PRINT-HEADER-BOOK-HEADER/DOCBOOK PRINT-HEADER-DOCUMENT-HEADER/DOCBOOK PRINT-HEADER-PACKAGE-HEADER/DOCBOOK PRINT-PURPOSE-GENERIC-CLASS-PURPOSE PRINT-PURPOSE-GENERIC-FUN-PURPOSE TL-MAKE-NEW-DOCUMENT TL-MAKE-NEW-OBJ-DOCUMENT
Location		spres/base.lisp

ESTABLISH-DOC-HANDLER&

(ESTABLISH-DOC-HANDLER& KEY FUN) [function]

Description		adds a function to *special-doc-handlers*. Such a function should take three arguments.. the document, the list of doc-obj to handle and a special argument (type T) with extra info (usually a keyword, e.g :class).
Calls		(SETF GETHASH)
Location		spres/object.lisp

ESTABLISH-INFO-HANDLER&

(ESTABLISH-INFO-HANDLER& KEY FUN) [function]

Description		adds a function to *special-info-handlers*. Such a function should take three arguments.. the document, the list of info-obj to handle and a special argument (type T) with extra info (usually a keyword, e.g :class).
Calls		(SETF GETHASH)
Location		spres/object.lisp

FILE-INFO-COUNTER

(FILE-INFO-COUNTER (OBJ FILE-INFO)) [function]

(SETF FILE-INFO-COUNTER)

((SETF FILE-INFO-COUNTER) (OBJ FILE-INFO)) [function]

FILE-INFO-DIR

(FILE-INFO-DIR (OBJ FILE-INFO)) [function]

(SETF FILE-INFO-DIR)

((SETF FILE-INFO-DIR) (OBJ FILE-INFO)) [function]

FILE-INFO-FNAME

(FILE-INFO-FNAME (OBJ FILE-INFO)) [function]

(SETF FILE-INFO-FNAME)

((SETF FILE-INFO-FNAME) (OBJ FILE-INFO)) [function]

FILE-INFO-ID

(FILE-INFO-ID (OBJ FILE-INFO)) [function]

(SETF FILE-INFO-ID)

((SETF FILE-INFO-ID) (OBJ FILE-INFO)) [function]

FILE-INFO-P

(FILE-INFO-P OBJ) [predicate]

FILE-INFO-TO-FNAME

(FILE-INFO-TO-FNAME F-OBJ) [function]

Description		Translates the file-info obj into a filename string
Called By		INCLUDE-FILE-ENTITY, PERMUTE-FNAME-AND-ADD, SEARCH-FOR-FILE-NAMES, TL-MAKE-NEW-DOCUMENT and TL-MAKE-NEW-OBJ-DOCUMENT
Calls		FILE-INFO-COUNTER, FILE-INFO-DIR, FILE-INFO-FNAME, FORMAT, NAMESTRING, NON-NEGATIVE-INTEGER?, PATHNAMEP and STRCAT
Location		spres/files.lisp

FILTER-AWAY

(FILTER-AWAY THE-LIST PREDICATE) [function]

Description		works as REMOVE-IF but returns the removed values as second value
Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK, PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK and PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER
Calls		FUNCALL and NREVERSE
Location		spres/tools.lisp

FIND-CLASS-IN-HIERARCHY

(FIND-CLASS-IN-HIERARCHY HIER THE-CLASS) [function]

Called By		DRAW-HIERARCHY, MAKE-CLASS-HIERARCHY and TL-MAKE-LINK-FOR-CLASS
Calls		%FIND-CLASS-IN-HIERARCHY and WARN
Location		spres/hier.lisp

FIND-RELATED-METHODS

(FIND-RELATED-METHODS OBJ) [function]

Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK
Calls		%CHECK-FOR-METHOD-DISPATCH
Location		spres/object.lisp

GENERATE-RULE-CODE

(GENERATE-RULE-CODE FILENAME) [function]

Description		generates code for the rules to the given file
Calls		FORMAT, MAKE-HASH-TABLE, MAPHASH and RL-GENERATE-METHOD
Location		spres/rules/r-lang.lisp

GET-CLASS-FACTS

(GET-CLASS-FACTS DOC OBJ) [function]

Description		Returns a list of fun facts about a class.
Called By		DB-PRESENT-CLASS-DETAILS
Calls		ALBERT-SETTING APISPEC-XML:XMLIFY-STRING COUNT-OBJ-TYPES GET-INHERIT-OBJ GET-OBJECT-NAME GET-SPEC-INHERITS GET-WORD LIST-TO-SEP-STRING MAKE-ENTRY MAKE-OBJ-LINK MAPCAR NREVERSE SDOC-LOCATION.FILE SETTING-OR-DEFAULT SLOT-VALUE STRCAT
Location		spres/object.lisp

GET-CLASS-SIGNATURE

(GET-CLASS-SIGNATURE DOC OBJ &KEY (LINKED T)) [function]

Description		Returns a class-signature.
Called By		DB-PRESENT-CLASS-DETAILS and GET-HOVER-DESC
Calls		GET-CLASS-WORD GET-INHERIT-OBJ GET-OBJECT-NAME GET-SPEC-INHERITS GET-WORD IS-PROG-LANG? LIST-TO-SEP-STRING MAKE-INCL-STR MAPCAR SDS-API-SDOC:GET-VISIBILITY STRCAT TL-IS-INTERFACE? TL-IS-STRUCT?
Location		spres/object.lisp

GET-DOC-HANDLER

(GET-DOC-HANDLER KEY) [function]

Description		gets a function from *special-doc-handlers*
Called By		DB-PRESENT-DOC-LIST
Calls		GETHASH
Location		spres/object.lisp

GET-DOC-WORD

(GET-DOC-WORD WORD DOCUMENT) [function]

Description		Returns a translated word for a documentation kwd
Called By		DB-PRESENT-DOC-LIST, DB-PRESENT-INFO-LIST and DB-PRINT-LOCATION
Calls		GET-WORD and GETHASH
Location		spres/lang.lisp

GET-ENUM-VALUES

(GET-ENUM-VALUES ENUM-OBJ DOC) [function]

Description		Returns a string with enum-values neatly organised
Calls		GET-STRING, GET-WORD, LIST-TO-SEP-STRING, MAPCAR, SDOC-ENUM.VALUES, SDOC-ENUMVAL.VALUE and STRCAT
Location		spres/object.lisp

GET-EXPORT-TABLE

(GET-EXPORT-TABLE OBJ) [function]

Description		Returns an export-table for the given package object.
Called By		PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK
Calls		(SETF GETHASH), MAKE-HASH-TABLE and TL-GET-FIELDS
Location		spres/object.lisp

GET-FILE-EXTENSION

(GET-FILE-EXTENSION DOCUMENT) [generic]

Description		Returns a string, e.g '.foo' with extension for DOCUMENT files.
Called By		PRESENT-BOOK
Location		spres/base.lisp

GET-FILE-EXTENSION

(GET-FILE-EXTENSION (DOC DOCBOOK-DOCUMENT)) [method]

Calls		GET-FILE-EXTENSION-FILE-EXTENSION/DOCBOOK
Location		spres/generated.lisp

GET-FILE-EXTENSION-FILE-EXTENSION/DOCBOOK

(GET-FILE-EXTENSION-FILE-EXTENSION/DOCBOOK DOC) [function]

Description		returns a file-extension
Location		spres/generated.lisp

GET-FORMAT-CONSTR

(GET-FORMAT-CONSTR THE-FORMAT) [function]

Description		Tries to find the given format and returns a list of constructors that satisfy the string naming THE-FORMAT. If the format was not found, NIL is returned. If the format is named "all", all formats are returned.
Called By		PRESENT-SDOC
Calls		GETHASH, HASH-TABLE-COUNT, HTBL-TO-LIST, STRING-DOWNCASE, STRING-EQUAL, WARN and WHEN-VERBOSE
Location		spres/base.lisp

GET-HOVER-DESC

(GET-HOVER-DESC DOC OBJ) [function]

Calls		GET-CLASS-SIGNATURE, GET-METHOD-SIGNATURE, GET-OBJECT-NAME, GET-VARIABLE-SIGNATURE and STRCAT
Location		spres/r-db.lisp

GET-INFO-HANDLER

(GET-INFO-HANDLER KEY) [function]

Description		gets a function from *special-info-handlers*
Called By		DB-PRESENT-INFO-LIST
Calls		GETHASH
Location		spres/object.lisp

GET-INHERIT-OBJ

(GET-INHERIT-OBJ CLASS-OBJ) [function]

Description		Returns the INHERIT object in the given SDOC-CLASS
Called By		GET-CLASS-FACTS, GET-CLASS-SIGNATURE, MAKE-CLASS-HIERARCHY and PRINT-PURPOSE-GENERIC-CLASS-PURPOSE
Calls		SDOC-CLASS.PARENTS
Location		spres/hier.lisp

GET-LANGUAGE

(GET-LANGUAGE LANG) [function]

Called By		PRESENT-SDOC
Calls		MAKE-LANGUAGE-TABLE and SET-LANGUAGE
Location		spres/lang.lisp

GET-LINKED-WORD

(GET-LINKED-WORD DOC WORD LINK-TYPE &KEY DESC) [generic]

Description		Returns a linked word fitting for a document object DOC.
Called By		PUT-TOGETHER-METH-ROW
Location		spres/base.lisp

GET-LINKED-WORD

(GET-LINKED-WORD (DOC DOCBOOK-DOCUMENT) WORD LINK-TYPE &KEY (DESC NIL)) [method]

Calls		GET-SIMPLE-LINK and STRCAT
Location		spres/tools.lisp

GET-METHOD-RETVAL

(GET-METHOD-RETVAL METH-OBJ DOC) [function]

Description		Returns a string with the return value of the METH-OBJ.
Called By		GET-METHOD-SIGNATURE
Calls