doc/TRANE-COMMON.html

   1 <html><head><title>TRANE-COMMON</title></head><body><h3>API for package TRANE-COMMON</h3>
   2 <blockquote>UNDOCUMENTED</blockquote>
   3 <p><b>*config*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
   4 <blockquote>Parsed configuration file.</blockquote>
   5 <blockquote>Initial value: <tt>#S(PY-CONFIGPARSER:CONFIG :DEFAULTS #S(PY-CONFIGPARSER::SECTION :NAME "DEFAULT" :OPTIONS NIL) :SECTIONS (#S(PY-CONFIGPARSER::SECTION :NAME "hunchentoot" :OPTIONS (("address" . "127.0.0.1") ("port" . "4242"))) #S(PY-CONFIGPARSER::SECTION :NAME "db" :OPTIONS (("host" . "127.0.0.1") ("password" . "") ("username" . "japhy") ("database" . "kuchennik"))) #S(PY-CONFIGPARSER::SECTION :NAME "project" :OPTIONS (("version" . "0.alpha") ("name" . "kuchennik")))) :OPTION-NAME-TRANSFORM-FN #<Compiled-function STRING-DOWNCASE #x30004037C60F> :SECTION-NAME-TRANSFORM-FN #<Compiled-function IDENTITY #x3000400DF02F>)</tt></blockquote>
   6 <p><b>*db*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
   7 <blockquote>Database connection specification</blockquote>
   8 <blockquote>Initial value: <tt>("kuchennik" "japhy" "" "127.0.0.1")</tt></blockquote>
   9 <p><b>*init-functions*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
  10 <blockquote>Functions (symbols) that are FUNCALLed on initialization.
  11
  12 No assumption about init function order should be made.</blockquote>
  13 <blockquote>Initial value: <tt>(TRANE-COMMON:START-HUNCHENTOOT TRANE-COMMON::INIT-DB-CONNECTION KUCHENNIK::KUCHENNIK-INIT-HT-DISPATCHER KUCHENNIK::KUCHENNIK-INIT-HT-ENCODING KUCHENNIK::KUCHENNIK-INIT-HT-DISPATCHER KUCHENNIK::KUCHENNIK-INIT-HT-ENCODING TRANE-COMMON:START-HUNCHENTOOT TRANE-COMMON::INIT-DB-CONNECTION)</tt></blockquote>
  14 <p><b>*setup-functions*</b>&nbsp;&nbsp;&nbsp;<i>variable</i></p>
  15 <blockquote>Functions (symbols) that are FUNCALLed on setup.
  16
  17 No assumption about setup function order should be made.</blockquote>
  18 <blockquote>Initial value: <tt>NIL</tt></blockquote>
  19 <p><b>DIRTINESS-MIXIN</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  20 <p><b>DIRTY-P</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  21 <p>(<b>execute*</b> statements &optional query-log)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  22 <blockquote>Execute a possibly nested list of sql STATEMENTS.
  23
  24 STATEMENTS may be either S-SQL expressions, literal SQL strings, or
  25 lists of statements.</blockquote><p>(<b>id</b> object)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
  26 <blockquote>Numeric ID or :NULL for DAOs and, if it makes sense, other objects.
  27
  28 Usually it will be a reader method automatically defined for ID column of a DAO.</blockquote><p>(<b>make-keyword</b> str)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  29 <blockquote>Convert a string or symbol to a keyword.</blockquote><p><b>MARK-AS-DIRTY</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  30 <p>(<b>named-lambda</b> name args &body body)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  31 <blockquote>Version of LAMBDA that returns anonymous function defined with
  32 FLET and named NAME, which it's PRINTed with a name in most Lisp
  33 implementations.</blockquote><p>(<b>null-or</b> v)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  34 <blockquote>If V is NIL or an empty string, return :NULL, otherwise return V.</blockquote><p>(<b>on-init</b> &body body)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  35 <blockquote>BODY should be sequence of DEFUN forms containing functions
  36 that are to be executed on initialization.</blockquote><p>(<b>on-setup</b> &body body)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  37 <blockquote>BODY should be sequence of DEFUN forms containing functions
  38 that are to be executed on setup.</blockquote><p>(<b>random-string</b> &key alphabet min-length max-length)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  39 <blockquote>Simple random string for initial password to use in account activation process.</blockquote><p>(<b>salted-password</b> salt password)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  40 <blockquote>Return Base64-encoded MD5 checksum of SALT concatenated with PASSWORD.</blockquote><p>(<b>slug</b> object)&nbsp;&nbsp;&nbsp;<i>generic-function</i></p>
  41 <blockquote>Get short, unique, urlified name of OBJECT.</blockquote><p>(<b>slug-dao</b> class slug)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  42 <blockquote>Select DAO of CLASS having "slug" column set to SLUG.</blockquote><p><b>SLUGIFY</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  43 <p><b>START-HUNCHENTOOT</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  44 <p>(<b>unless-null</b> v)&nbsp;&nbsp;&nbsp;<i>function</i></p>
  45 <blockquote>If V equals :NULL, return NIL, otherwise return V.</blockquote><p><b>UPDATE-DAO-IF-DIRTY</b></p>&nbsp;&nbsp;&nbsp;<i><font color="FF0000">undocumented</font></i></p>
  46 <font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on Clozure Common Lisp</p></font></body></html>