]> git.donarmstrong.com Git - lilypond.git/blob - lily/function-documentation.cc
Docs-hu: Translated Community Updated macro translations Fixed some translations...
[lilypond.git] / lily / function-documentation.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 2004--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
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.
10
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.
15
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/>.
18 */
19
20 #include <cstring>
21 using namespace std;
22
23 #include "std-string.hh"
24 #include "lily-guile.hh"
25 #include "warn.hh"
26
27
28 static SCM doc_hash_table;
29
30 void
31 ly_check_name (string cxx, string scm_name)
32 {
33   string mangle = mangle_cxx_identifier (cxx);
34   if (mangle != scm_name)
35     {
36       programming_error ("wrong cxx name: " + mangle + ", " + cxx +  ", " + scm_name);
37     }
38 }
39
40
41 void
42 ly_add_function_documentation (SCM func,
43                                     string fname,
44                                     string varlist,
45                                     string doc)
46 {
47   if (doc == "")
48     return;
49
50   if (!doc_hash_table)
51     doc_hash_table = scm_permanent_object (scm_c_make_hash_table (59));
52
53   string s = string (" - ") + "LilyPond procedure: " + fname + " " + varlist
54     + "\n" + doc;
55
56   scm_set_procedure_property_x (func, ly_symbol2scm ("documentation"),
57                                 ly_string2scm (s));
58   SCM entry = scm_cons (ly_string2scm (varlist), ly_string2scm (doc));
59   scm_hashq_set_x (doc_hash_table, ly_symbol2scm (fname.c_str ()), entry);
60 }
61
62 LY_DEFINE (ly_get_all_function_documentation, "ly:get-all-function-documentation",
63            0, 0, 0, (),
64            "Get a hash table with all LilyPond Scheme extension functions.")
65 {
66   return doc_hash_table;
67 }
68
69
70 #include <map>
71
72 map<void *, string>  type_names;
73   
74 void
75 ly_add_type_predicate (void *ptr,
76                        string name)
77 {
78   type_names[ptr] = name; 
79 }
80
81 string
82 predicate_to_typename (void *ptr)
83 {
84   if (type_names.find (ptr) == type_names.end ())
85     {
86       programming_error ("Unknown type predicate");
87       return "unknown type";
88     }
89   else
90     return type_names[ptr];
91 }
92
93 /* type predicates. */
94 #include "spanner.hh"
95 #include "item.hh"
96 #include "music.hh"
97 #include "music-function.hh"
98 #include "performance.hh"
99 #include "paper-score.hh"
100 #include "global-context.hh"
101 #include "input.hh"
102
103 void
104 init_func_doc ()
105 {
106   ly_add_type_predicate ((void*) &is_direction, "direction");
107   ly_add_type_predicate ((void*) &is_music_function, "Music_function");
108   ly_add_type_predicate ((void*) &ly_is_port, "port");
109   ly_add_type_predicate ((void*) &ly_cheap_is_list, "list");
110   ly_add_type_predicate ((void*) &unsmob_global_context, "Global_context");
111   ly_add_type_predicate ((void*) &unsmob_input, "Input");
112   ly_add_type_predicate ((void*) &unsmob_moment, "Moment");
113   ly_add_type_predicate ((void*) &unsmob_paper_score, "Paper_score");
114   ly_add_type_predicate ((void*) &unsmob_performance, "Performance");
115
116   ly_add_type_predicate ((void*) &is_axis, "axis");
117   ly_add_type_predicate ((void*) &is_number_pair, "number pair");
118   ly_add_type_predicate ((void*) &ly_is_list, "list");
119   ly_add_type_predicate ((void*) &ly_is_procedure, "procedure");
120   ly_add_type_predicate ((void*) &ly_is_symbol, "symbol");
121   ly_add_type_predicate ((void*) &scm_is_bool, "boolean");
122   ly_add_type_predicate ((void*) &scm_is_integer, "integer");
123   ly_add_type_predicate ((void*) &scm_is_number, "number");
124   ly_add_type_predicate ((void*) &scm_is_pair, "pair");
125   ly_add_type_predicate ((void*) &scm_is_rational, "rational");
126   ly_add_type_predicate ((void*) &scm_is_string, "string");
127   ly_add_type_predicate ((void*) &scm_is_vector, "vector");
128   ly_add_type_predicate ((void*) &unsmob_item, "Item");
129   ly_add_type_predicate ((void*) &unsmob_music, "Music");
130   ly_add_type_predicate ((void*) &unsmob_spanner, "Spanner");
131 }
132
133 ADD_SCM_INIT_FUNC (func_doc, init_func_doc);