X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ffunction-documentation.cc;h=99fbdfe6c8ce17838c2f58a90f1eba3517995a4d;hb=b872748c6aa8bb721ced458691b38ac2fac5dfc8;hp=f210c6ef152a90433b846b0c40ae5851a519cb21;hpb=00e3e15364b9d3c94cda1bcab9f889bb95f6832d;p=lilypond.git diff --git a/lily/function-documentation.cc b/lily/function-documentation.cc index f210c6ef15..99fbdfe6c8 100644 --- a/lily/function-documentation.cc +++ b/lily/function-documentation.cc @@ -1,12 +1,24 @@ /* - function-documentation.cc -- Scheme doc strings. + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2004--2015 Han-Wen Nienhuys - (c) 2004--2007 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ #include +#include using namespace std; #include "std-string.hh" @@ -14,99 +26,104 @@ using namespace std; #include "warn.hh" /* type predicates. */ -#include "spanner.hh" +#include "global-context.hh" +#include "input.hh" #include "item.hh" +#include "music.hh" +#include "music-function.hh" +#include "paper-score.hh" +#include "performance.hh" +#include "protected-scm.hh" +#include "spanner.hh" +#include "stream-event.hh" +#include "unpure-pure-container.hh" - -static SCM doc_hash_table; +static Protected_scm doc_hash_table; void -ly_check_name (string cxx, string scm_name) +ly_check_name (const string &cxx, const string &scm_name) { string mangle = mangle_cxx_identifier (cxx); if (mangle != scm_name) { - programming_error ("wrong cxx name: " + mangle + ", " + cxx + ", " + scm_name); + programming_error ("wrong cxx name: " + mangle + ", " + cxx + ", " + scm_name); } } - void ly_add_function_documentation (SCM func, - string fname, - string varlist, - string doc) + const string &fname, + const string &varlist, + const string &doc) { if (doc == "") return; - if (!doc_hash_table) - doc_hash_table = scm_permanent_object (scm_c_make_hash_table (59)); + if (!doc_hash_table.is_bound ()) + doc_hash_table = scm_c_make_hash_table (59); string s = string (" - ") + "LilyPond procedure: " + fname + " " + varlist - + "\n" + doc; + + "\n" + doc; scm_set_procedure_property_x (func, ly_symbol2scm ("documentation"), - ly_string2scm (s)); + ly_string2scm (s)); SCM entry = scm_cons (ly_string2scm (varlist), ly_string2scm (doc)); scm_hashq_set_x (doc_hash_table, ly_symbol2scm (fname.c_str ()), entry); } LY_DEFINE (ly_get_all_function_documentation, "ly:get-all-function-documentation", - 0, 0, 0, (), - "Get a hash table with all lilypond Scheme extension functions.") + 0, 0, 0, (), + "Get a hash table with all LilyPond Scheme extension functions.") { return doc_hash_table; } +map type_names; -#include - -map type_names; - void ly_add_type_predicate (void *ptr, - string name) + const string &name) { - type_names[ptr] = name; + type_names[ptr] = name; } string predicate_to_typename (void *ptr) { if (type_names.find (ptr) == type_names.end ()) - return "unknown type"; + { + programming_error ("Unknown type predicate"); + return "unknown type"; + } else return type_names[ptr]; } -static int -arg_dir (int a, int b) -{ - if (&a < &b) - return 1; - else - return -1; -} - - -int function_argument_direction; void init_func_doc () { - function_argument_direction = arg_dir (2,3); - - ly_add_type_predicate ((void*) &scm_is_integer, "integer"); - ly_add_type_predicate ((void*) &scm_is_bool, "boolean"); - ly_add_type_predicate ((void*) &scm_is_pair, "pair"); - ly_add_type_predicate ((void*) &is_number_pair, "number pair"); - ly_add_type_predicate ((void*) &scm_is_number, "number"); - ly_add_type_predicate ((void*) &scm_is_string, "string"); - ly_add_type_predicate ((void*) &ly_is_symbol, "symbol"); - ly_add_type_predicate ((void*) &scm_is_vector, "vector"); - ly_add_type_predicate ((void*) &is_axis, "axis"); - ly_add_type_predicate ((void*) &unsmob_spanner, "spanner"); - ly_add_type_predicate ((void*) &unsmob_item, "item"); + ly_add_type_predicate ((void *) &is_direction, "direction"); + ly_add_type_predicate ((void *) &ly_is_port, "port"); + ly_add_type_predicate ((void *) &ly_cheap_is_list, "list"); + ly_add_type_predicate ((void *) &unsmob, "Global_context"); + ly_add_type_predicate ((void *) &unsmob, "Paper_score"); + ly_add_type_predicate ((void *) &unsmob, "Performance"); + ly_add_type_predicate ((void *) &is_axis, "axis"); + ly_add_type_predicate ((void *) &is_number_pair, "number pair"); + ly_add_type_predicate ((void *) &ly_is_list, "list"); + ly_add_type_predicate ((void *) &ly_is_procedure, "procedure"); + ly_add_type_predicate ((void *) &ly_is_symbol, "symbol"); + ly_add_type_predicate ((void *) &scm_is_bool, "boolean"); + ly_add_type_predicate ((void *) &scm_is_integer, "integer"); + ly_add_type_predicate ((void *) &scm_is_number, "number"); + ly_add_type_predicate ((void *) &scm_is_pair, "pair"); + ly_add_type_predicate ((void *) &scm_is_rational, "rational"); + ly_add_type_predicate ((void *) &scm_is_string, "string"); + ly_add_type_predicate ((void *) &scm_is_vector, "vector"); + ly_add_type_predicate ((void *) &unsmob, "Item"); + ly_add_type_predicate ((void *) &unsmob, "Music"); + ly_add_type_predicate ((void *) &unsmob, "Spanner"); + ly_add_type_predicate ((void *) &unsmob, "Stream_event"); } ADD_SCM_INIT_FUNC (func_doc, init_func_doc);