General Links
SDS Homepage
 
General Documentation
Main index
Copyright notices
What is SDS
Installing SDS
SDS HowTo
Using SDS
Language frontends
FAQ
Plans/further releases
 
Developer Documentation
Architecture description
Developer How-To
XML-system for classes
CSF Specification
CSF DTD Documentation
SDOC Info
Develop code in Lisp
 
Email page maintainer
stig@ii.uib.no
 
Hosted at

SF project page

  

Lisp Development

The Common Lisp source is the result of exploration and me learning Lisp. As a result of this, the code varies in complexity, level of optimisation and has varying naming-standards. This file will try to document some of the code at least.

XML-system

The XML-system uses generated APIs for the XML-objects. The core functionality is in apispec/ and consists of the core XML-functionality and various macros to make api-specification easier.

Which files do what?

FilePurpose
apispec/api-base.lisp 
apispec/api-cpp.lispthe code for generating c++ APIs
apispec/api-extra.lispextra functions for the APISpec API
apispec/api-generate.lispthe program which generates/updates APIs
apispec/api-html.lispthe code for generating html of the API
apispec/api-java.lispthe code for generating java APIs
apispec/api-lisp.lispthe code for generating lisp APIs
apispec/api-python.lispthe code for generating python APIs
apispec/base.lisptakes care of basic functionality for the whole system
apispec/packages.lisppackage declarations for apispec
apispec/settings.lispconstants set when configuring the system
apispec/xml-base.lisptakes care of low-level xml issues
apispec/xml-esis.lisptakes care of access to xml-parser through shell-call
apispec/xml-sexp.lispreads xml in sexp form
apispec/xml.lispthis is the APISPEC-XML module
base/convenience.lispvarious convenience macros
base/defaults.lispdefaults for SDS
base/global.lispmain utilities for SDS
base/memoize.lisp 
base/msgs.lisperror-messages and warnings in SDS
base/option.lispoption parsing
base/settings.lispconstants set when configuring the system
base/tools.lispvarious general tools
build.lispbuilds the system
defsystem.lisp 
initsystem.lisp 
lisp2csf/borrowed.lispborrowed code to make lisp2csf work
lisp2csf/cleaning.lisppreprocesses lisp-code for safer reading
lisp2csf/lisp2csf.lispreads lisp-code and generates CSF
packages.lispall defpackage declarations
port/ext.lisp 
port/net.lisp 
port/proc.lisp 
port/shell.lisp 
port/sys.lisp 
server/basic.lispbasic settings for servers
server/portable.lispa server built atop CLOCC's PORT
server/unused.lisp 
specs/csf-base.lisp 
specs/csf-extra.lispextra functions for the CSF API
specs/csf-prettify.lispcode to prettify csf-structures
specs/csf-verify.lispcode to verify csf-structures
specs/mod-base.lisp 
specs/mod-extra.lispextra functions for the Modspec API
specs/prefs-base.lisp 
specs/prefs-extra.lispextra functions for the Prefs API
specs/sdoc-base.lisp 
specs/sdoc-extra.lispextra functions for the SDOC API
specs/sdoc-prettify.lispcode to prettify sdoc-structures
spres/base.lispthe central part of spres package
spres/configure.lispspres configurations
spres/generated.lisp 
spres/hier.lisputilities for the class-hierarchy
spres/hyperspec.lisplinks to the hyperspec
spres/interface.lispthe spres entry-point
spres/lang.lisplanguages is my guess
spres/object.lisputilities for presenting objects
spres/r-db.lispdocbook definitions for generated code
spres/rules/basic.lispthe base-rules and unplaced rules
spres/rules/method.lispthe rules for methods
spres/rules/class.lispthe rules for classes
spres/rules/sort.lispsorting of content for presentation
spres/rules/method.lispthe rules for methods
spres/rules/package.lispthe rules for packages
spres/r-lang.lisprule-code
spres/rules/sort.lispsorting of content for presentation
spres/rules/variable.lispthe rules for methods
spres/tools.lispvarious tool-functions for spres-code
spres/use.lispthe spres entry-point
spres/vars.lispthe central variables of the spres package
tests/base.lispbase code for customising xptest to Langband
tests/lisp2csf.lisplisp2csf testing
tests/program.lisptesting program
tests/simple.lispsimple testing
tests/test-package.lisppackage def for sds testing
tests/xp-package.lisp 
tests/xptest-example.lisp 
tests/xptestsuite.lisp 
tools/convert.lisputilities for converting between objects
tools/linker.lispthe CSF Linker
tools/programs.lispall programs seen from shell-perspective
tools/various.lispvarious high-level testing stuff