lily/function-documentation.cc

   1 /*
   2   function-documentation.cc --
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #include <cstring>
  11
  12 #include "protected-scm.hh"
  13 #include "string.hh"
  14
  15 static Protected_scm doc_hash_table ;
  16
  17 void ly_add_function_documentation (SCM func,
  18                                     char const * fname,
  19                                     char const * varlist,
  20                                     char const * doc)
  21 {
  22   if (!strlen (doc))
  23     return;
  24
  25   if (!scm_is_vector (doc_hash_table))
  26     doc_hash_table = scm_make_vector (scm_int2num (59), SCM_EOL);
  27
  28   String s = String (" - ") + "LilyPond procedure: " + fname + " " + varlist
  29     + "\n" + doc ;
  30
  31   scm_set_procedure_property_x (func, ly_symbol2scm ("documentation"),
  32                                 scm_makfrom0str (s.to_str0 ()));
  33   SCM entry = scm_cons (scm_makfrom0str (varlist), scm_makfrom0str (doc));
  34   scm_hashq_set_x (doc_hash_table, ly_symbol2scm (fname), entry);
  35 }
  36
  37
  38 LY_DEFINE (ly_get_all_function_documentation, "ly:get-all-function-documentation",
  39           0,0,0, (),
  40           "Get a hash table with all lilypond Scheme extension functions.")
  41 {
  42   return doc_hash_table;
  43 }