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		GET-INFO-OF-TYPE, GET-STRING, GET-WORD, IS-PROG-LANG?, LIST-TO-SEP-STRING, MAPCAR, SDOC-METHOD.RETVALS, SDOC-RETVAL.INFO and STRCAT
Location		spres/object.lisp

GET-METHOD-SIGNATURE

(GET-METHOD-SIGNATURE DOC OBJ &KEY (LINKED T) (STYLE :TRADITIONAL)) [function]

Description		obj must be a sdoc-method
Called By		GET-HOVER-DESC, PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK and PRESENT-OBJECT-FULL-METHOD/DOCBOOK
Calls		FIND GET-INFO-OF-TYPE GET-METHOD-ARGUMENTS GET-METHOD-RETVAL GET-STRING GET-WORD LIST-TO-SEP-STRING MAPCAR PUT-TOGETHER-METH-ROW REMOVE SDOC-METHOD.INFO SDS-API-SDOC:GET-VISIBILITY STRIP-INFO-FIELDS
Location		spres/object.lisp

GET-SDOC-TOPLEVEL

(GET-SDOC-TOPLEVEL) [function]

Description		Returns the toplevel sdoc-object.
Called By		LOOK-FOR-NAME-IN-NAMED-PACKAGE and PRINT-HEADER-PACKAGE-HEADER/DOCBOOK
Location		spres/tools.lisp

GET-SPEC-INHERITS

(GET-SPEC-INHERITS INH-LIST TYPE) [function]

Description		Returns only specific inherits satisfying type.
Called By		GET-CLASS-FACTS and GET-CLASS-SIGNATURE
Calls		GET-INFO-OF-TYPE, MAPCAR, SLOT-VALUE, STRING-EQUAL and STRIP-INFO-FIELDS
Location		spres/object.lisp

GET-STRING

(GET-STRING ACC OBJ) [macro]

Description		handy macro for lists who are just a text-string.. for readability
Called By		DB-PRESENT-DOC-LIST, DB-PRESENT-INFO-LIST, DB-PRINT-LOCATION, GET-ENUM-VALUES, GET-METHOD-RETVAL, GET-METHOD-SIGNATURE, GET-VARIABLE-SIGNATURE, PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK and TL-GET-CAT-INFO-STR
Location		spres/base.lisp

GET-VARIABLE-SIGNATURE

(GET-VARIABLE-SIGNATURE DOC OBJ &KEY LINKED STYLE) [function]

Description		obj must be a sdoc-variable
Called By		GET-HOVER-DESC, PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK and PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK
Calls		FIND GET-INFO-OF-TYPE GET-STRING GET-WORD IS-PROG-LANG? LIST-TO-SEP-STRING MAPCAR PUT-TOGETHER-VAR-ROW REMOVE SDOC-INFO.VALUE SDOC-VARIABLE.INFO SDS-API-SDOC:GET-VISIBILITY STRCAT STRIP-INFO-FIELDS TAGGIFY
Location		spres/object.lisp

GET-WORD

(GET-WORD WORD DOCUMENT) [function]

Description		makes a look up for a word in appropriate hash table
Called By		DB-ASSOC-TABLE-AS-TREE DB-PRESENT-CLASS-DETAILS GET-CLASS-FACTS GET-CLASS-SIGNATURE GET-DOC-WORD GET-ENUM-VALUES GET-METHOD-RETVAL GET-METHOD-SIGNATURE GET-VARIABLE-SIGNATURE PRESENT-OBJECT-FULL-CLASS/DOCBOOK PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK PRESENT-OBJECT-TPL/DOCBOOK PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER PRINT-HEADER-PACKAGE-HEADER/DOCBOOK PRINT-PURPOSE-GENERIC-CLASS-PURPOSE
Calls		DOCUMENT.LANG-WORDS, GETHASH and WHEN-VERBOSE
Location		spres/lang.lisp

HANDLE-CALLS-INFO

(HANDLE-CALLS-INFO DOCUMENT DOC-OBJLIST TYPE) [generic]

Description		handles 'calls' keyword
Location		spres/object.lisp

HANDLE-CALLS-INFO

(HANDLE-CALLS-INFO (DOC DOCBOOK-DOCUMENT) DOC-LIST TYPE) [method]

Calls		ALBERT-SETTING DB-PRINT-TABLE EOL ERROR GET-DOC-WORD GET-OBJECT-NAME GET-STRING GET-WORD LIST-TO-SEP-STRING PUT REMOVE-DUPLICATES STABLE-SORT TREE-PUT
Location		spres/r-db.lisp

HANDLE-MOD-INFO

(HANDLE-MOD-INFO DOCUMENT DOC-OBJLIST TYPE) [generic]

Description		handles 'mod' keyword
Location		spres/object.lisp

HANDLE-PARAM-DOC

(HANDLE-PARAM-DOC DOCUMENT DOC-OBJLIST TYPE) [generic]

Description		handles 'param' keyword
Location		spres/object.lisp

HANDLE-PARAM-DOC

(HANDLE-PARAM-DOC (DOC DOCBOOK-DOCUMENT) DOC-LIST TYPE) [method]

Calls		APISPEC-XML:XMLIFY-STRING, EOL, GET-DOC-WORD, GET-STRING, POSITION, PUT, SUBSEQ and TL-CLEAN-FOR-LEADING-STARS
Location		spres/r-db.lisp

HANDLE-SEE-DOC

(HANDLE-SEE-DOC DOCUMENT DOC-OBJLIST TYPE) [generic]

Description		handles 'see' keyword
Location		spres/object.lisp

HANDLE-SEE-DOC

(HANDLE-SEE-DOC (DOC DOCBOOK-DOCUMENT) DOC-LIST TYPE) [method]

Calls		APISPEC-XML:XMLIFY-STRING, EOL, GET-DOC-WORD, GET-STRING, PUT and TL-CLEAN-FOR-LEADING-STARS
Location		spres/r-db.lisp

HAS-SPRES-FLAG?

(HAS-SPRES-FLAG? FLAG) [function]

Called By		PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK, PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK, PRESENT-OBJECT-FULL-METHOD/DOCBOOK, PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK, PRINT-HEADER-PACKAGE-HEADER/DOCBOOK, PUT-TOGETHER-METH-ROW and TL-GET-SECT-HEADING-FROM-TYPE
Calls		FIND
Location		spres/base.lisp

HIERARCHY-SIZE

(HIERARCHY-SIZE HIER) [function]

Description		Returns an integer with an approximate size of the class-hierarchy.
Called By		PRESENT-OBJECT-TPL/DOCBOOK
Calls		WARN
Location		spres/hier.lisp

IDX-ENTRY-NAME

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

(SETF IDX-ENTRY-NAME)

((SETF IDX-ENTRY-NAME) (OBJ IDX-ENTRY)) [function]

IDX-ENTRY-OBJ

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

(SETF IDX-ENTRY-OBJ)

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

IDX-ENTRY-P

(IDX-ENTRY-P OBJ) [predicate]

IDX-ENTRY-PARENT

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

(SETF IDX-ENTRY-PARENT)

((SETF IDX-ENTRY-PARENT) (OBJ IDX-ENTRY)) [function]

INCLUDE-FILE-ENTITY

(INCLUDE-FILE-ENTITY F-OBJ) [function]

Description		Returns a string which is a legal file-inclusion in xml for the given f-obj
Called By		TL-MAKE-NEW-DOCUMENT and TL-MAKE-NEW-OBJ-DOCUMENT
Calls		FILE-INFO-TO-FNAME, MAKE-VALID-ENTITY and STRCAT
Location		spres/files.lisp

INFO-TO-FIELD

(INFO-TO-FIELD DOC FIELD INFO-NAME INFO-LIST) [function]

Calls		EOL, GET-INFO-OF-TYPE, PUT and SLOT-VALUE
Location		spres/tools.lisp

INVOKE-CONTENT-MANAGER

(INVOKE-CONTENT-MANAGER OBJ DOC LIST) [function]

Calls		PRINT-CONTENT-LIST
Location		spres/tools.lisp

IS-PROG-LANG?

(IS-PROG-LANG? LANG) [function]

Called By		GET-CLASS-SIGNATURE, GET-METHOD-RETVAL, GET-VARIABLE-SIGNATURE, PRESENT-OBJECT-PCK-IDX/DOCBOOK, PUT-TOGETHER-METH-ROW, TL-GET-SECT-HEADING-FROM-TYPE, TL-SHOW-LOCATION? and UPDATE-CALLEDBY-INFO!
Location		spres/vars.lisp

IS-VARIABLE-A-CONSTANT?

(IS-VARIABLE-A-CONSTANT? OBJ) [function]

Calls		GET-INFO-OF-TYPE, SDOC-INFO.VALUE, SLOT-VALUE and STRING-EQUAL
Location		spres/r-db.lisp

ITEM-IN-LIST

(ITEM-IN-LIST DOC) [macro]

ITEMIZED-LIST

(ITEMIZED-LIST DOC) [macro]

LINK-TO-CLHS?

(LINK-TO-CLHS? NAME) [function]

Description		Returns either NIL or a link to the CLHS.
Called By		UPDATE-CALLEDBY-INFO!
Calls		GETHASH and STRING-DOWNCASE
Location		spres/hyperspec.lisp

LOOK-FOR-NAME-IN-NAMED-PACKAGE

(LOOK-FOR-NAME-IN-NAMED-PACKAGE NAMED-PACKAGE NAME TYPE) [function]

Description		Looks up a named-package and looks in it for NAME.
Calls		GET-SDOC-TOPLEVEL and LOOK-FOR-NAME-IN
Location		spres/object.lisp

MAKE-CLASS-HIERARCHY

(MAKE-CLASS-HIERARCHY CLASS-TABLE) [function]

Description		It creates and returns a class-hierarchy based on tree-node
Called By		PRESENT-SDOC
Calls		FILTER FIND-CLASS-IN-HIERARCHY GET-INHERIT-OBJ GET-OBJECT-NAME MAKE-TREE-NODE MAPHASH SDOC-INHERIT.NAME SDS-GLOBAL:ID-OBJ-SCOPE SORT TNODE.CLASS TNODE.KIDS TNODE.PARENTS WHEN-VERBOSE
Location		spres/hier.lisp

MAKE-FILE-INFO

(MAKE-FILE-INFO)

MAKE-FORMAT

(MAKE-FORMAT FORMAT-TYPE) [function]

Description		constructor for formats.. supply a symbol identifying the format-type
Calls		MAKE-INSTANCE
Location		spres/base.lisp

MAKE-IDX-ENTRY

(MAKE-IDX-ENTRY)

MAKE-LANGUAGE-TABLE

(MAKE-LANGUAGE-TABLE) [function]

Called By		GET-LANGUAGE
Calls		MAKE-HASH-TABLE
Location		spres/lang.lisp

MAKE-RULE-ARG

(MAKE-RULE-ARG)

MAKE-RULE-DEF

(MAKE-RULE-DEF)

Called By		RL-ENSURE-RULE-FORM
Location		spres/rules/r-lang.lisp

MAKE-RULE-INFO

(MAKE-RULE-INFO)

Called By		RL-CLEAN-BASIC-REQ and RL-ENSURE-RULE
Location		spres/rules/r-lang.lisp

MAKE-TREE-NODE

(MAKE-TREE-NODE CLASS-OBJ &KEY (SCOPE NIL)) [function]

Description		constructor
Called By		MAKE-CLASS-HIERARCHY
Calls		MAKE-INSTANCE
Location		spres/base.lisp

MAKE-VALID-ENTITY

(MAKE-VALID-ENTITY WORD &KEY (ALLOW NIL)) [function]

Description		translates the word into something eatable as entity and id in sml and label in tex. It is returned as a _string_
Called By		INCLUDE-FILE-ENTITY, PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK, PRESENT-OBJECT-TPL/DOCBOOK, PRINT-HEADER-PACKAGE-HEADER/DOCBOOK, SEARCH-FOR-FILE-NAMES and TL-MAKE-NEW-DOCUMENT
Location		spres/tools.lisp

PERMUTE-FNAME-AND-ADD

(PERMUTE-FNAME-AND-ADD F-OBJ TABLE) [function]

Description		permutes the fname with counter till it is addable to the given table.
Called By		PERMUTE-FNAME-AND-ADD and SEARCH-FOR-FILE-NAMES
Calls		(SETF GETHASH), FILE-INFO-COUNTER, FILE-INFO-TO-FNAME, GETHASH and PERMUTE-FNAME-AND-ADD
Location		spres/files.lisp

POSSIBLY-CVS-LINK

(POSSIBLY-CVS-LINK LOC-OBJ) [function]

Description		Returns either a link to a cvs tree or the loc-obj.
Calls		ALBERT-SETTING, APISPEC-XML:XMLIFY-STRING, SDOC-LOCATION.FILE, SETTING-OR-DEFAULT and STRCAT
Location		spres/r-db.lisp

PRESENT-BOOK

(PRESENT-BOOK TPL-OBJECT) [function]

Description		Outputs a book of the given top-level object
Called By		PRESENT-SDOC
Calls		ALBERT-SETTING CALCULATE-FILE-LIST DOCUMENT.DIRECTORY DOCUMENT.FILENAME GET-FILE-EXTENSION IGNORE-ERRORS MAKE-DOCUMENT PRESENT-DOCUMENT PRESENT-OBJECT REGISTER-CLHS-ROOT TL-ENSURE-FILE-DIRS WHEN-VERBOSE
Location		spres/object.lisp

PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK

(PRESENT-OBJECT-FULL-CATEGORY/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full category.
Calls		APISPEC-XML:XMLIFY-STRING CONCATENATE EOL ERROR GET-ENCLOSING-PACKAGE GET-METHOD-SIGNATURE GET-OBJECT-NAME GET-SIMPLE-ANCHOR GET-STRING GET-VARIABLE-SIGNATURE HAS-SPRES-FLAG? IS-EXPORTED? PUT REMOVE-DUPLICATES SLOT-VALUE WARN
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-CLASS/DOCBOOK

(PRESENT-OBJECT-FULL-CLASS/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full class.
Calls		ADD-SPRES-FLAG! ALBERT-SETTING DB-INSERT-INDEX DB-PRESENT-CLASS-DETAILS DOC DOCBOOK-PAGE-TITLE EOL FILTER-AWAY FIND-RELATED-METHODS GET-OBJECT-NAME GET-WORD MAKE-OBJ-ID PRESENT-OBJECT PRESENT-WITH-CONTENT-MANAGER PRINT-PURPOSE PUT REMOVE-SPRES-FLAG! SDOC-CLASS.DOC SET-DIFFERENCE SETTING-OR-DEFAULT SHOULD-HAVE-INDIVIDUAL-FILE-P SLOT-VALUE STRING-EQUAL WITH-OK-OBJ-DOCUMENT
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-ENUM/DOCBOOK

(PRESENT-OBJECT-FULL-ENUM/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full enum.
Calls		DB-PRESENT-DOC-LIST, DB-PRINT-LOCATION, EOL, GET-OBJECT-NAME, GET-SIMPLE-ANCHOR, MAKE-OBJ-ID, PUT, SLOT-VALUE, STRCAT, TL-SHOW-LOCATION? and TREE-PUT
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK

(PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents lisp-specifics for a package.
Calls		ADD-SPRES-FLAG! ALBERT-SETTING DOC EOL FILTER FILTER-AWAY GET-EXPORT-TABLE GET-OBJECT-NAME HAS-SPRES-FLAG? IS-EXPORTED? MAKE-FILE-INFO MAKE-VALID-ENTITY PRESENT-OBJECT PRESENT-OBJS-IN-PACKAGE PRINT-HEADER PUT REGISTER-SEPARATE-DOCUMENT REMOVE-SPRES-FLAG! REVERSE RULE-NOTIFY-START SHOULD-HAVE-INDIVIDUAL-FILE-P SLOT-VALUE STRCAT TL-SORT-BY-NAME WITH-OK-DOCUMENT
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-METHOD/DOCBOOK

(PRESENT-OBJECT-FULL-METHOD/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full method.
Calls		ADD-SPRES-FLAG! ALBERT-SETTING APISPEC-XML:XMLIFY-STRING CONCATENATE DB-PRESENT-DOC-LIST DB-PRESENT-INFO-LIST DB-PRINT-LOCATION EOL FLATTEN GET-ENCLOSING-PACKAGE GET-INFO-EXCEPT-TYPES GET-METHOD-SIGNATURE GET-OBJECT-NAME GET-SIMPLE-ANCHOR HAS-SPRES-FLAG? IS-EXPORTED? MAKE-OBJ-ID MAPCAR PRESENT-OBJECT PUT REMOVE-SPRES-FLAG! SDOC-METHOD.CONTENT SDOC-METHOD.DOC SDOC-METHOD.INFO SLOT-VALUE TL-SHOW-LOCATION?
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-MODULE/DOCBOOK

(PRESENT-OBJECT-FULL-MODULE/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a module.
Calls		EOL, GET-OBJECT-NAME, PRESENT-OBJECT, PRINT-HEADER, PUT, RULE-NOTIFY-START and SLOT-VALUE
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK

(PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full GF.
Calls		ADD-SPRES-FLAG! APISPEC-XML:XMLIFY-STRING DOC EOL GET-OBJECT-NAME GET-WORD MAKE-OBJ-ID PRESENT-WITH-CONTENT-MANAGER PRINT-PURPOSE PUT REMOVE-SPRES-FLAG! SDOC-METHOD.DOC SLOT-VALUE WARN WITH-OK-OBJ-DOCUMENT
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-TYPESPEC/DOCBOOK

(PRESENT-OBJECT-FULL-TYPESPEC/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full typespec.
Calls		DB-PRESENT-DOC-LIST DB-PRESENT-INFO-LIST DB-PRINT-LOCATION EOL GET-INFO-EXCEPT-TYPES GET-OBJECT-NAME GET-SIMPLE-ANCHOR MAKE-OBJ-ID PUT SLOT-VALUE STRCAT TL-SHOW-LOCATION? TREE-PUT
Location		spres/generated.lisp

PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK

(PRESENT-OBJECT-FULL-VARIABLE/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Presents a full variable.
Calls		DB-PRESENT-DOC-LIST DB-PRESENT-INFO-LIST DB-PRINT-LOCATION EOL GET-INFO-EXCEPT-TYPES GET-OBJECT-NAME GET-SIMPLE-ANCHOR GET-VARIABLE-SIGNATURE HAS-SPRES-FLAG? IS-EXPORTED? MAKE-OBJ-ID PUT SLOT-VALUE TL-SHOW-LOCATION? TREE-PUT WARN
Location		spres/generated.lisp

PRESENT-OBJECT-PCK-IDX/DOCBOOK

(PRESENT-OBJECT-PCK-IDX/DOCBOOK OBJ DOC CONTEXT) [function]

Description		index a package
Calls		DB-INSERT-INDEX, EOL, GET-OBJECT-NAME, IS-PROG-LANG?, PUT, RULE-NOTIFY-START and SLOT-VALUE
Location		spres/generated.lisp

PRESENT-OBJECT-TPL/DOCBOOK

(PRESENT-OBJECT-TPL/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Toplevel Docbook basically
Calls		(SETF DB-GET-DTD) ALBERT-SETTING DOC EOL GET-WORD HIERARCHY-SIZE IS-EMPTY? MAKE-FILE-INFO MAKE-VALID-ENTITY NOTEVERY PRESENT-OBJECT PRINT-CLASS-HIERARCHY PRINT-HEADER PUT REGISTER-SEPARATE-DOCUMENT RULE-NOTIFY-START SLOT-VALUE WHEN-VERBOSE WITH-OK-DOCUMENT
Location		spres/generated.lisp

PRESENT-TABLE

(PRESENT-TABLE DOC OBJLIST STYLE) [generic]

Description		Makes a table of the objects in list in given style
Location		spres/base.lisp

PRESENT-WITH-CONTENT-MANAGER

(PRESENT-WITH-CONTENT-MANAGER OBJ DOC LIST) [macro]

Called By		PRESENT-OBJECT-FULL-CLASS/DOCBOOK and PRESENT-OBJECT-FULL-TPL-METHOD/DOCBOOK
Location		spres/tools.lisp

PRINT-CLASS-HIERARCHY

(PRINT-CLASS-HIERARCHY (DOC DOCBOOK-DOCUMENT) HIER INDENT) [method]

Called By		PRESENT-OBJECT-TPL/DOCBOOK and PRINT-CLASS-HIERARCHY
Calls		EOL, MAKE-STRING, PRINT-CLASS-HIERARCHY, PUT, TL-MAKE-LINK-FOR-CLASS and TNODE.KIDS
Location		spres/hier.lisp

PRINT-CLASS-HIERARCY

(PRINT-CLASS-HIERARCY DOC HIERARCHY INDENT) [generic]

Description		Prints a class hierarchy to the given document.
Location		spres/base.lisp

PRINT-CLASS-HIERARCY

(PRINT-CLASS-HIERARCY DOC HIERARCHY INDENT) [method]

Calls		ERROR
Location		spres/base.lisp

PRINT-CONTENT-LIST

(PRINT-CONTENT-LIST OBJ DOC CONTENT-LIST) [generic]

Description		Prints the 'content'-list of OBJ to DOC.
Called By		INVOKE-CONTENT-MANAGER
Location		spres/base.lisp

PRINT-CONTENT-LIST

(PRINT-CONTENT-LIST OBJ DOC CONTENT-LIST) [method]

Calls		PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER and WARN
Location		spres/generated.lisp

PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER

(PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER OBJ DOC CONTENT-LIST) [function]

Description		A positively evil way to sort content.
Calls		EOL, ERROR, FILTER-AWAY, GET-WORD, PRESENT-OBJECT, PUT, SHOULD-HAVE-INDIVIDUAL-FILE-P, TL-DIVIDE-AND-ORDER-OBJECTS, TL-GET-NEXT-SECTION-STATE and TL-GET-SECT-HEADING-FROM-TYPE
Location		spres/generated.lisp

PRINT-HEADER-BOOK-HEADER/DOCBOOK

(PRINT-HEADER-BOOK-HEADER/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Prints a book header for docbook.
Calls		ALBERT-SETTING, EOL, EVERY, FORMAT, GET-DATE-STRING-FOR-TODAY, PATHNAMEP, PROBE-FILE, PUT, RULE-NOTIFY-START and SETTING-OR-DEFAULT
Location		spres/generated.lisp

PRINT-HEADER-DOCUMENT-HEADER/DOCBOOK

(PRINT-HEADER-DOCUMENT-HEADER/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Prints the header of the document.
Calls		DB-GET-DTD, EOL, HASH-TABLE-COUNT, PUT and RULE-NOTIFY-START
Location		spres/generated.lisp

PRINT-HEADER-PACKAGE-HEADER/DOCBOOK

(PRINT-HEADER-PACKAGE-HEADER/DOCBOOK OBJ DOC CONTEXT) [function]

Description		Prints a package header for docbook.
Calls		APISPEC-XML:XMLIFY-STRING DB-PRINT-TABLE EOL GET-OBJECT-NAME GET-SDOC-TOPLEVEL GET-WORD HAS-SPRES-FLAG? LIST-TO-SEP-STRING MAKE-OBJ-ID MAKE-OBJ-LINK MAKE-VALID-ENTITY MAPCAR NREVERSE PUT RECURSIVELY-LOOKUP-NAME RULE-NOTIFY-START SORT STRCAT TL-GET-FIELDS TREE-PUT
Location		spres/generated.lisp

PRINT-OBJECT

(PRINT-OBJECT (INST TREE-NODE) STREAM) [method] (PRINT-OBJECT (INST SPRES-FORMAT) STREAM) [method]

PRINT-PURPOSE-GENERIC-CLASS-PURPOSE

(PRINT-PURPOSE-GENERIC-CLASS-PURPOSE OBJ DOC CONTEXT) [function]

Calls		ALBERT-SETTING, EOL, GET-INHERIT-OBJ, GET-WORD, LIST-TO-SEP-STRING, MAPCAR, PUT, SLOT-VALUE, STRCAT, STRING-EQUAL and TL-IS-STRUCT?
Location		spres/generated.lisp

PRINT-PURPOSE-GENERIC-FUN-PURPOSE

(PRINT-PURPOSE-GENERIC-FUN-PURPOSE OBJ DOC CONTEXT) [function]

Calls		ALBERT-SETTING, EOL, IS-GENERIC-FUN?, PUT, TL-GET-FIELDS and WARN
Location		spres/generated.lisp

PRT-HIER

(PRT-HIER HIER &OPTIONAL (INDENT 0)) [function]

Called By		PRT-HIER
Calls		FORMAT, GET-OBJECT-NAME, PRT-HIER, SUBSEQ, TNODE.CLASS and TNODE.KIDS
Location		spres/hier.lisp

PUT-TOGETHER-METH-ROW

(PUT-TOGETHER-METH-ROW DOC RETVAL DESC-WORD NAME ARGUMENTS TYPE-LIST &KEY VISIB (STYLE :TRADITIONAL) (LINKED T)) [function]

Description		Pieces together a method-row from arguments.
Called By		GET-METHOD-SIGNATURE
Calls		GET-LINKED-WORD, GET-SIMPLE-ANCHOR, HAS-SPRES-FLAG?, IS-PROG-LANG?, STRCAT and TAGGIFY
Location		spres/object.lisp

REGISTER-CLHS-ROOT

(REGISTER-CLHS-ROOT ROOT) [function]

Description		Registers the clhs-root for later use.
Called By		PRESENT-BOOK
Location		spres/hyperspec.lisp

REGISTER-CREATED-ID

(REGISTER-CREATED-ID OBJ ID) [function]

Description		Registers a created id for an obj.
Calls		(SETF GETHASH)
Location		spres/base.lisp

REGISTER-OBJECT-ACTUAL

(REGISTER-OBJECT-ACTUAL (OBJ SDOC-CLASS) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-PACKAGE) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-MODULE) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-TOPLEVEL) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-CATEGORY) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-METHOD) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-ENUM) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-VARIABLE) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-TYPESPEC) CONTEXT WHEN) [method] (REGISTER-OBJECT-ACTUAL (OBJ SDOC-DIRECTIVE) CONTEXT WHEN) [method]

REGISTER-SEPARATE-DOCUMENT

(REGISTER-SEPARATE-DOCUMENT FILEINFO) [function]

Description		Registers the file-info object so that it will be counted.
Called By		PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK and PRESENT-OBJECT-TPL/DOCBOOK
Calls		(SETF GETHASH)
Location		spres/files.lisp

REMOVE-LANGUAGE

(REMOVE-LANGUAGE LANG-TABLE) [function]

Called By		SET-LANGUAGE
Calls		CHECK-FOR-LANGUAGE, FUNCALL and WARN
Location		spres/lang.lisp

REMOVE-SPRES-FLAG!

(REMOVE-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
Calls		DELETE
Location		spres/base.lisp

REP-TABLE-TO-LIST

(REP-TABLE-TO-LIST TABLE) [function]

Description		collects the actual objects of the table into a new list
Calls		MAPHASH
Location		spres/tools.lisp

RL-CLEAN-BASIC-REQ

(RL-CLEAN-BASIC-REQ RULE) [function]

Description		no side-effects.. returns a new rule without basic keywords in the demand list.
Calls		(SETF RULE-INFO-DEMANDS), CHAR, MAKE-RULE-INFO, REMOVE, RL-GET-RULE-DEF, RULE-INFO-DESC, RULE-INFO-KEY, RULE-INFO-NAME, RULE-INFO-VARIATION, SYMBOL-NAME and WARN
Location		spres/rules/r-lang.lisp

RL-CLEAN-TABLES

(RL-CLEAN-TABLES) [function]

Description		Cleans all rule-tables.
Calls		(SETF FILL-POINTER) and CLRHASH
Location		spres/rules/r-lang.lisp

RL-ENSURE-RULE

(RL-ENSURE-RULE INFORMATION FUNCTION) [function]

Description		ensures that the given rule is registered.
Calls		(SETF AREF), (SETF GETHASH), ERROR, GETHASH, MAKE-RULE-INFO, POSITION, VECTOR-PUSH-EXTEND and WARN
Location		spres/rules/r-lang.lisp

RL-ENSURE-RULE-FORM

(RL-ENSURE-RULE-FORM KEY ARGS VARIATION) [function]

Description		ensures that the rule-form is registered.
Calls		(SETF GETHASH), (SETF RULE-DEF-ON-FALL-THROUGH), (SETF RULE-DEF-PRINT-EXECUTE), FIND and MAKE-RULE-DEF
Location		spres/rules/r-lang.lisp

RL-GENERATE-METHOD

(RL-GENERATE-METHOD OUT-STREAM SIGNATURE RULES) [function]

Description		Generates a method and it's functions.
Called By		GENERATE-RULE-CODE
Calls		ERROR FILTER FIND GETHASH LAST MAPCAR PPRINT PROG1 REMOVE RL-GET-ARG-NAMES RL-GET-RULE-DEF RL-MAKE-COND-CLAUSE RL-MAKE-DEFUN-NAME RULE-ARG-NAME RULE-ARG-REBIND RULE-DEF-ARGS RULE-DEF-ON-FALL-THROUGH RULE-DEF-PRINT-EXECUTE RULE-INFO-DEMANDS RULE-INFO-DESC RULE-INFO-KEY RULE-INFO-NAME RULE-INFO-VARIATION STABLE-SORT TERPRI WARN
Location		spres/rules/r-lang.lisp

RL-GET-ARG-NAMES

(RL-GET-ARG-NAMES RULE) [function]

Description		Return a list of variable-names
Called By		RL-GENERATE-METHOD and RL-MAKE-COND-CLAUSE
Calls		MAPCAR, RL-GET-RULE-DEF, RULE-DEF-ARGS and RULE-INFO-NAME
Location		spres/rules/r-lang.lisp

RL-GET-POSS-QUOTED-VAL

(RL-GET-POSS-QUOTED-VAL DEM) [function]

Description		Returns the value of a symbol and bypasses any quote.
Called By		RL-GET-SIGNATURE
Location		spres/rules/r-lang.lisp

RL-GET-RULE-DEF

(RL-GET-RULE-DEF NAME) [function]

Called By		RL-CLEAN-BASIC-REQ, RL-GENERATE-METHOD, RL-GET-ARG-NAMES and RL-GET-SIGNATURE
Calls		GETHASH
Location		spres/rules/r-lang.lisp

RL-GET-SIGNATURE

(RL-GET-SIGNATURE RULE) [function]

Description		Returns the appropriate signature for the given rule.
Calls		FIND, NREVERSE, RL-GET-POSS-QUOTED-VAL, RL-GET-RULE-DEF, RL-VERIFY-DEMANDS, RULE-ARG-KEYWORD, RULE-DEF-ARGS, RULE-INFO-DEMANDS and RULE-INFO-NAME
Location		spres/rules/r-lang.lisp

RL-MAKE-COND-CLAUSE

(RL-MAKE-COND-CLAUSE RULE) [function]

Description		Returns an appropriate COND-clause for a rule.
Called By		RL-GENERATE-METHOD
Calls		RL-GET-ARG-NAMES, RL-MAKE-DEFUN-NAME, RULE-INFO-DEMANDS, RULE-INFO-KEY and RULE-INFO-NAME
Location		spres/rules/r-lang.lisp

RL-MAKE-DEFUN-NAME

(RL-MAKE-DEFUN-NAME RULE-NAME KEY) [function]

Called By		RL-GENERATE-METHOD and RL-MAKE-COND-CLAUSE
Calls		CONCAT-PNAMES
Location		spres/rules/r-lang.lisp

RL-VERIFY-DEMANDS

(RL-VERIFY-DEMANDS DEMANDS) [function]

Description		Verifies that the demand-list is peachy. Not complete.
Called By		RL-GET-SIGNATURE
Calls		WARN
Location		spres/rules/r-lang.lisp

RULE-ARG-KEYWORD

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

(SETF RULE-ARG-KEYWORD)

((SETF RULE-ARG-KEYWORD) (OBJ RULE-ARG)) [function]

RULE-ARG-NAME

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

(SETF RULE-ARG-NAME)

((SETF RULE-ARG-NAME) (OBJ RULE-ARG)) [function]

RULE-ARG-P

(RULE-ARG-P OBJ) [predicate]

RULE-ARG-REBIND

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

(SETF RULE-ARG-REBIND)

((SETF RULE-ARG-REBIND) (OBJ RULE-ARG)) [function]

RULE-DEF-ARGS

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

(SETF RULE-DEF-ARGS)

((SETF RULE-DEF-ARGS) (OBJ RULE-DEF)) [function]

RULE-DEF-NAME

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

(SETF RULE-DEF-NAME)

((SETF RULE-DEF-NAME) (OBJ RULE-DEF)) [function]

RULE-DEF-ON-FALL-THROUGH

(RULE-DEF-ON-FALL-THROUGH (OBJ RULE-DEF)) [function]

(SETF RULE-DEF-ON-FALL-THROUGH)

((SETF RULE-DEF-ON-FALL-THROUGH) (OBJ RULE-DEF)) [function]

Called By		RL-ENSURE-RULE-FORM
Location		spres/rules/r-lang.lisp

RULE-DEF-P

(RULE-DEF-P OBJ) [predicate]

RULE-DEF-PRINT-EXECUTE

(RULE-DEF-PRINT-EXECUTE (OBJ RULE-DEF)) [function]

(SETF RULE-DEF-PRINT-EXECUTE)

((SETF RULE-DEF-PRINT-EXECUTE) (OBJ RULE-DEF)) [function]

Called By		RL-ENSURE-RULE-FORM
Location		spres/rules/r-lang.lisp

RULE-INFO-DEMANDS

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

(SETF RULE-INFO-DEMANDS)

((SETF RULE-INFO-DEMANDS) (OBJ RULE-INFO)) [function]

Called By		RL-CLEAN-BASIC-REQ
Location		spres/rules/r-lang.lisp

RULE-INFO-DESC

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

(SETF RULE-INFO-DESC)

((SETF RULE-INFO-DESC) (OBJ RULE-INFO)) [function]

RULE-INFO-KEY

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

(SETF RULE-INFO-KEY)

((SETF RULE-INFO-KEY) (OBJ RULE-INFO)) [function]

RULE-INFO-NAME

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

(SETF RULE-INFO-NAME)

((SETF RULE-INFO-NAME) (OBJ RULE-INFO)) [function]

RULE-INFO-P

(RULE-INFO-P OBJ) [predicate]

RULE-INFO-VARIATION

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

(SETF RULE-INFO-VARIATION)

((SETF RULE-INFO-VARIATION) (OBJ RULE-INFO)) [function]

RULE-NOTIFY-START

(RULE-NOTIFY-START KEY) [macro]

Called By		PRESENT-OBJECT-FULL-GENERIC-PACKAGE/DOCBOOK, PRESENT-OBJECT-FULL-MODULE/DOCBOOK, PRESENT-OBJECT-PCK-IDX/DOCBOOK, PRESENT-OBJECT-TPL/DOCBOOK, PRINT-HEADER-BOOK-HEADER/DOCBOOK, PRINT-HEADER-DOCUMENT-HEADER/DOCBOOK and PRINT-HEADER-PACKAGE-HEADER/DOCBOOK
Location		spres/base.lisp

SEARCH-FOR-FILE-NAMES

(SEARCH-FOR-FILE-NAMES OBJ-LIST TABLE) [function]

Description		goes recursively through the object list and adds any filenames to the table
Calls		(SETF GETHASH) CALCULATE-FILE-LIST FILE-INFO-TO-FNAME GET-OBJECT-NAME GET-SUGGESTED-FILE-NAME GETHASH IS-EMPTY? MAKE-VALID-ENTITY NAMESTRING PATHNAME PERMUTE-FNAME-AND-ADD SHOULD-HAVE-INDIVIDUAL-FILE-P STRCAT
Location		spres/files.lisp

SEARCH-HELPER

(SEARCH-HELPER PARENT KIDS TYPE CUR-PATH) [function]

Description		This function basically does the job for the generic function search-for-types-in-sdoc-tree and relies on the methods to supply correct arguments
Calls		SEARCH-FOR-TYPES-IN-SDOC-TREE and TYPE-OF
Location		spres/tools.lisp

SET-LANGUAGE

(SET-LANGUAGE LANG LANG-TABLE) [function]

Called By		GET-LANGUAGE
Calls		CHECK-FOR-LANGUAGE, FUNCALL, REMOVE-LANGUAGE and WARN
Location		spres/lang.lisp

SORT-IDX-LIST

(SORT-IDX-LIST IDX-LIST) [function]

Description		Sorts and returns the idx-list.
Called By		DB-INSERT-INDEX
Calls		STABLE-SORT
Location		spres/tools.lisp

SPLIT-SYM-PREFIX

(SPLIT-SYM-PREFIX SYM) [function]

Calls		POSITION and SUBSEQ
Location		spres/object.lisp

SYM-HAS-PREFIX?

(SYM-HAS-PREFIX? SYM) [function]

Calls		POSITION
Location		spres/object.lisp

TL-ADD-TO-CATEGORY

(TL-ADD-TO-CATEGORY CAT OBJ) [function]

Description		Adds an object to a category.
Called By		TL-MERGE-LIST
Calls		(SETF PARENT-OF), (SETF SDOC-CATEGORY.CONTENT) and SDOC-CATEGORY.CONTENT
Location		spres/tools.lisp

TL-CATEGORISE-DUPLICATES

(TL-CATEGORISE-DUPLICATES THE-LIST &KEY TYPE) [function]

Description		Makes (simple) categories of objects that match names.
Calls		ARRANGE-DUPLICATES, GET-OBJECT-NAME and TL-MAKE-CATEGORY
Location		spres/tools.lisp

TL-CLEAN-FOR-LEADING-STARS

(TL-CLEAN-FOR-LEADING-STARS STR) [function]

Description		makes sure comments look sane when output. Contains a check on language.. the same string is returned in languages where leading star isn't common. Hack as needed.
Called By		DB-PRESENT-DOC-LIST and DB-PRESENT-INFO-LIST
Calls		IN-STR and WITH-INPUT-FROM-STRING
Location		spres/tools.lisp

TL-DIVIDE-AND-ORDER-OBJECTS

(TL-DIVIDE-AND-ORDER-OBJECTS OBJ-LIST LANG &KEY (ALSO-SORT NIL)) [function]

Description		Divides the object-list from settings depending on language and returns a list of buckets.
Called By		PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER
Calls		MAKE-ARRAY and TYPE-OF
Location		spres/tools.lisp

TL-ENSURE-FILE-DIRS

(TL-ENSURE-FILE-DIRS FILE-TABLE BASE-DIR) [function]

Description		given a file-table and a pathname base-dir. Calls sds-global:make-sure-dirs-exist.
Called By		PRESENT-BOOK
Location		spres/files.lisp

TL-FIND-OUT-DIR

(TL-FIND-OUT-DIR FORMAT) [function]

Description		Returns a pathname for the out-dir.
Called By		PRESENT-SDOC
Calls		ALBERT-SETTING, ENSURE-DIR-NAME, MERGE-PATHNAMES, PATHNAME, PATHNAMEP and TL-GET-OUTDIR-PREF
Location		spres/files.lisp

TL-GET-CAT-INFO-STR

(TL-GET-CAT-INFO-STR CAT) [function]

Description		returns a string with info about a cat. [DEBUGGING FUN]
Calls		FORMAT, GET-OBJECT-NAME, GET-STRING, MAPCAR and SLOT-VALUE
Location		spres/tools.lisp

TL-GET-FIELDS

(TL-GET-FIELDS TYPE OBJ) [function]

Called By		GET-EXPORT-TABLE, PRINT-HEADER-PACKAGE-HEADER/DOCBOOK and PRINT-PURPOSE-GENERIC-FUN-PURPOSE
Calls		GET-INFO-OF-TYPE, MAPCAR, SLOT-VALUE and STRIP-INFO-FIELDS
Location		spres/tools.lisp

TL-GET-NEXT-SECTION-STATE

(TL-GET-NEXT-SECTION-STATE CUR-STATE) [function]

Description		Returns a cons with the next state and the name of the tag.
Called By		PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER
Location		spres/tools.lisp

TL-GET-OK-OBJ-DOCUMENT

(TL-GET-OK-OBJ-DOCUMENT OBJ OLD-DOC) [function]

Description		Returns a new document if the OBJ requires an idividual file, otherwise returns the given document.
Calls		SHOULD-HAVE-INDIVIDUAL-FILE-P and TL-MAKE-NEW-OBJ-DOCUMENT
Location		spres/files.lisp

TL-GET-OUTDIR-PREF

(TL-GET-OUTDIR-PREF FORMAT) [function]

Description		Returns the actual outdir-preference in the given output-preference. Returns the actual pref and not a list. Returns NIL on failure.
Called By		TL-FIND-OUT-DIR
Calls		ALBERT-SETTING, FORMAT.NAME and WARN
Location		spres/files.lisp

TL-GET-SECT-HEADING-FROM-TYPE

(TL-GET-SECT-HEADING-FROM-TYPE TYPE) [function]

Description		Returns a section heading based on type.
Called By		PRINT-CONTENT-LIST-CLEVER-SORT-OF-CONTENT-PRESENTER
Calls		ERROR, HAS-SPRES-FLAG?, IS-PROG-LANG?, SDOC-CATEGORY.TYPE and WARN
Location		spres/tools.lisp

TL-IS-INTERFACE?

(TL-IS-INTERFACE? OBJ) [function]

Description		Checks if a class is an interface.
Called By		GET-CLASS-SIGNATURE
Calls		%CHECK-FOR-CLASS-MOD
Location		spres/tools.lisp

TL-IS-STRUCT?

(TL-IS-STRUCT? OBJ) [function]

Description		Checks if a class is a struct.
Called By		DB-PRESENT-CLASS-DETAILS, GET-CLASS-SIGNATURE and PRINT-PURPOSE-GENERIC-CLASS-PURPOSE
Calls		%CHECK-FOR-CLASS-MOD
Location		spres/tools.lisp

TL-MAKE-CATEGORY

(TL-MAKE-CATEGORY &KEY TYPE NAME OBJ-LIST PARENT) [function]

Description		Creates and returns an appropriate category object.
Called By		TL-CATEGORISE-DUPLICATES and TL-MERGE-LIST
Calls		(SETF SDOC-CATEGORY.CONTENT), (SETF SDOC-CATEGORY.ID), (SETF SDOC-CATEGORY.NAME), (SETF SDOC-CATEGORY.TYPE), MAKE-SDOC-CATEGORY and REVERSE
Location		spres/tools.lisp

TL-MAKE-LINK-FOR-CLASS

(TL-MAKE-LINK-FOR-CLASS THE-CLASS) [function]

Description		Tries to make a link for a class-name or returns the name.
Called By		PRINT-CLASS-HIERARCHY
Calls		FIND-CLASS-IN-HIERARCHY, GET-OBJECT-NAME, MAKE-OBJ-LINK, TNODE.CLASS and TNODE.SCOPE
Location		spres/tools.lisp

TL-MAKE-NEW-DOCUMENT

(TL-MAKE-NEW-DOCUMENT FILENAME OLD-DOC) [function]

Calls		EOL, FILE-INFO-TO-FNAME, INCLUDE-FILE-ENTITY, MAKE-DOCUMENT, MAKE-VALID-ENTITY and PUT
Location		spres/files.lisp

TL-MAKE-NEW-OBJ-DOCUMENT

(TL-MAKE-NEW-OBJ-DOCUMENT OBJ &OPTIONAL OLD-DOC) [function]

Description		presents an independent file..
Called By		TL-GET-OK-OBJ-DOCUMENT
Calls		EOL, FILE-INFO-TO-FNAME, GET-OBJECT-ID, GETHASH, INCLUDE-FILE-ENTITY, MAKE-DOCUMENT and PUT
Location		spres/files.lisp

TL-MAKE-STRING-DESC

(TL-MAKE-STRING-DESC OBJ) [function]

Calls		GET-OBJECT-NAME
Location		spres/tools.lisp

TL-MERGE-LIST

(TL-MERGE-LIST DOC THE-LIST) [function]

Description		Tries to merge the list appropriately. The list should be sorted.
Calls		ADD-TO-GROUP, CLEAN-GATHERING, GET-OBJECT-NAME, MAKE-GROUP, MERGABLE-OBJS?, NREVERSE, PARENT-OF, TL-ADD-TO-CATEGORY, TL-MAKE-CATEGORY and TYPE-OF
Location		spres/tools.lisp

TL-MERGE-TWO-PATHS

(TL-MERGE-TWO-PATHS NEW-PATH BASE) [function]

Description		Tries to merge two paths..
Calls		MAKE-PATHNAME, PATHNAME-DIRECTORY, PATHNAME-NAME and PATHNAME-TYPE
Location		spres/tools.lisp

TL-POSSIBLE-CLOSE-DOCUMENT

(TL-POSSIBLE-CLOSE-DOCUMENT OBJ DOC) [function]

Description		If the object OBJ requires it's own file, close this file, assuming it was opened by WITH-OK-DOCUMENT and therefore is safe. The closed document is also presented.
Calls		PRESENT-DOCUMENT and SHOULD-HAVE-INDIVIDUAL-FILE-P
Location		spres/files.lisp