2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
23 #include "std-string.hh"
24 #include "lily-guile.hh"
27 /* type predicates. */
28 #include "global-context.hh"
32 #include "music-function.hh"
33 #include "paper-score.hh"
34 #include "performance.hh"
36 #include "stream-event.hh"
37 #include "unpure-pure-container.hh"
42 static SCM doc_hash_table;
45 ly_check_name (const string &cxx, const string &scm_name)
47 string mangle = mangle_cxx_identifier (cxx);
48 if (mangle != scm_name)
50 programming_error ("wrong cxx name: " + mangle + ", " + cxx + ", " + scm_name);
55 ly_add_function_documentation (SCM func,
57 const string &varlist,
64 doc_hash_table = scm_permanent_object (scm_c_make_hash_table (59));
66 string s = string (" - ") + "LilyPond procedure: " + fname + " " + varlist
69 scm_set_procedure_property_x (func, ly_symbol2scm ("documentation"),
71 SCM entry = scm_cons (ly_string2scm (varlist), ly_string2scm (doc));
72 scm_hashq_set_x (doc_hash_table, ly_symbol2scm (fname.c_str ()), entry);
75 LY_DEFINE (ly_get_all_function_documentation, "ly:get-all-function-documentation",
77 "Get a hash table with all LilyPond Scheme extension functions.")
79 return doc_hash_table;
82 map<void *, string> type_names;
85 ly_add_type_predicate (void *ptr,
88 type_names[ptr] = name;
92 predicate_to_typename (void *ptr)
94 if (type_names.find (ptr) == type_names.end ())
96 programming_error ("Unknown type predicate");
97 return "unknown type";
100 return type_names[ptr];
106 ly_add_type_predicate ((void *) &is_direction, "direction");
107 ly_add_type_predicate ((void *) &ly_is_port, "port");
108 ly_add_type_predicate ((void *) &ly_cheap_is_list, "list");
109 ly_add_type_predicate ((void *) &unsmob<Global_context>, "Global_context");
110 ly_add_type_predicate ((void *) &unsmob<Paper_score>, "Paper_score");
111 ly_add_type_predicate ((void *) &unsmob<Performance>, "Performance");
112 ly_add_type_predicate ((void *) &is_axis, "axis");
113 ly_add_type_predicate ((void *) &is_number_pair, "number pair");
114 ly_add_type_predicate ((void *) &ly_is_list, "list");
115 ly_add_type_predicate ((void *) &ly_is_procedure, "procedure");
116 ly_add_type_predicate ((void *) &ly_is_symbol, "symbol");
117 ly_add_type_predicate ((void *) &scm_is_bool, "boolean");
118 ly_add_type_predicate ((void *) &scm_is_integer, "integer");
119 ly_add_type_predicate ((void *) &scm_is_number, "number");
120 ly_add_type_predicate ((void *) &scm_is_pair, "pair");
121 ly_add_type_predicate ((void *) &scm_is_rational, "rational");
122 ly_add_type_predicate ((void *) &scm_is_string, "string");
123 ly_add_type_predicate ((void *) &scm_is_vector, "vector");
124 ly_add_type_predicate ((void *) &unsmob<Item>, "Item");
125 ly_add_type_predicate ((void *) &unsmob<Music>, "Music");
126 ly_add_type_predicate ((void *) &unsmob<Spanner>, "Spanner");
127 ly_add_type_predicate ((void *) &unsmob<Stream_event>, "Stream_event");
130 ADD_SCM_INIT_FUNC (func_doc, init_func_doc);