2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Jan Nieuwenhuizen <janneke@gnu.org>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "text-interface.hh"
24 #include "font-interface.hh"
28 #include "modified-font-metric.hh"
29 #include "output-def.hh"
30 #include "pango-font.hh"
31 #include "program-option.hh"
32 #include "international.hh"
36 replace_special_characters (string &str, SCM props)
38 SCM replacement_alist = ly_chain_assoc_get (ly_symbol2scm ("replacement-alist"),
43 for (SCM s = replacement_alist; scm_is_pair (s); s = scm_cdr (s))
45 max_length = max (max_length, scm_to_int
46 (scm_string_length (scm_caar (s))));
49 for (vsize i = 0; i < str.size (); i++)
51 /* Don't match in mid-UTF-8 */
52 if ((str[i] & 0xc0) == 0x80)
54 for (vsize j = max_length + 1; j--;)
56 if (j > str.size () - i)
58 string dummy = str.substr (i, j);
59 SCM ligature = ly_assoc_get (ly_string2scm (dummy),
60 replacement_alist, SCM_BOOL_F);
61 if (scm_is_true (ligature))
62 str.replace (i, j, robust_scm2string (ligature, ""));
67 MAKE_SCHEME_CALLBACK (Text_interface, interpret_string, 3);
69 Text_interface::interpret_string (SCM layout_smob,
73 LY_ASSERT_SMOB (Output_def, layout_smob, 1);
74 LY_ASSERT_TYPE (scm_is_string, markup, 3);
76 string str = ly_scm2string (markup);
77 Output_def *layout = unsmob_output_def (layout_smob);
78 Font_metric *fm = select_encoded_font (layout, props);
80 replace_special_characters (str, props);
83 We want to filter strings with a music font that pass through
84 the text interface. Here the font encoding is checked to see
85 if it matches one of the music font encodings. --pmccarty
87 SCM encoding = ly_chain_assoc_get (ly_symbol2scm ("font-encoding"),
90 SCM music_encodings = ly_lily_module_constant ("all-music-font-encodings");
92 bool is_music = (scm_memq (encoding, music_encodings) != SCM_BOOL_F);
93 return fm->text_stencil (layout, str, is_music).smobbed_copy ();
96 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
97 "Convert a text markup into a stencil."
98 " Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
100 "@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
101 " @code{ly:grob-layout}. @var{props} is an alist chain, i.e. a list of"
102 " alists. This is typically obtained with"
103 " @code{(ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))}."
104 " @var{markup} is the markup text to be processed.");
106 Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
108 if (scm_is_string (markup))
109 return interpret_string (layout_smob, props, markup);
110 else if (scm_is_pair (markup))
112 SCM func = scm_car (markup);
113 SCM args = scm_cdr (markup);
114 if (!is_markup (markup))
115 programming_error ("markup head has no markup signature");
117 /* Use a hare/tortoise algorithm to detect whether we are in a cycle,
118 * i.e. whether we have already encountered the same markup in the
119 * current branch of the markup tree structure. */
120 static vector<SCM> encountered_markups;
121 size_t depth = encountered_markups.size ();
124 int slow = depth / 2;
125 if (ly_is_equal (encountered_markups[slow], markup))
127 string name = ly_symbol2string (scm_procedure_name (func));
128 // TODO: Also print the arguments of the markup!
129 non_fatal_error (_f ("Cyclic markup detected: %s", name));
130 return Stencil ().smobbed_copy ();
134 /* Check for non-terminating markups, e.g. recursive calls with
135 * changing arguments */
136 SCM opt_depth = ly_get_option (ly_symbol2scm ("max-markup-depth"));
137 size_t max_depth = robust_scm2int (opt_depth, 1024);
138 if (depth > max_depth)
140 string name = ly_symbol2string (scm_procedure_name (func));
141 // TODO: Also print the arguments of the markup!
142 non_fatal_error (_f ("Markup depth exceeds maximal value of %d; "
143 "Markup: %s", max_depth, name.c_str ()));
144 return Stencil ().smobbed_copy ();
147 encountered_markups.push_back (markup);
148 SCM retval = scm_apply_2 (func, layout_smob, props, args);
149 encountered_markups.pop_back ();
154 programming_error ("Object is not a markup.");
155 scm_puts ("This object should be a markup: ", scm_current_error_port ());
156 scm_display (markup, scm_current_error_port ());
157 scm_puts ("\n", scm_current_error_port ());
159 return Stencil ().smobbed_copy ();
163 MAKE_SCHEME_CALLBACK (Text_interface, print, 1);
165 Text_interface::print (SCM grob)
167 Grob *me = unsmob_grob (grob);
169 SCM t = me->get_property ("text");
170 SCM chain = Font_interface::text_font_alist_chain (me);
171 return interpret_markup (me->layout ()->self_scm (), chain, t);
174 /* Ugh. Duplicated from Scheme. */
176 Text_interface::is_markup (SCM x)
178 return (scm_is_string (x)
181 != scm_object_property (scm_car (x),
182 ly_symbol2scm ("markup-signature"))));
186 Text_interface::is_markup_list (SCM x)
188 SCM music_list_p = ly_lily_module_constant ("markup-list?");
189 return scm_is_true (scm_call_1 (music_list_p, x));
192 ADD_INTERFACE (Text_interface,
193 "A Scheme markup text, see @ruser{Formatting text} and"
194 " @rextend{New markup command definition}.\n"
196 "There are two important commands:"
197 " @code{ly:text-interface::print}, which is a"
198 " grob callback, and"
199 " @code{ly:text-interface::interpret-markup}.",