/*
- text-interface.cc -- implement Text_interface
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Copyright (C) 1998--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
Jan Nieuwenhuizen <janneke@gnu.org>
+
+ 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 <http://www.gnu.org/licenses/>.
*/
#include "text-interface.hh"
+#include "skyline-pair.hh"
-
-#include "main.hh"
+#include "lookup.hh"
#include "config.hh"
-#include "pango-font.hh"
-#include "warn.hh"
-#include "grob.hh"
#include "font-interface.hh"
-#include "output-def.hh"
+#include "grob.hh"
+#include "main.hh"
+#include "misc.hh"
#include "modified-font-metric.hh"
+#include "output-def.hh"
+#include "pango-font.hh"
+#include "program-option.hh"
+#include "international.hh"
+#include "warn.hh"
static void
-replace_whitespace (string *str)
+replace_special_characters (string &str, SCM props)
{
- vsize i = 0;
- vsize n = str->size ();
+ SCM replacement_alist = ly_chain_assoc_get (ly_symbol2scm ("replacement-alist"),
+ props,
+ SCM_EOL);
- while (i < n)
+ int max_length = 0;
+ for (SCM s = replacement_alist; scm_is_pair (s); s = scm_cdr (s))
{
- vsize char_len = 1;
- char cur = (*str)[i];
-
- // U+10000 - U+10FFFF
- if ((cur & 0x11110000) == 0x11110000)
- char_len = 4;
- // U+0800 - U+FFFF
- else if ((cur & 0x11100000) == 0x11100000)
- char_len = 3;
- // U+0080 - U+07FF
- else if ((cur & 0x11000000) == 0x11000000)
- char_len = 2;
- else if (cur & 0x10000000)
- programming_error ("invalid utf-8 string");
- else
- // avoid the locale-dependent isspace
- if (cur == '\n' || cur == '\t' || cur == '\v')
- (*str)[i] = ' ';
-
- i += char_len;
+ max_length = max (max_length, scm_to_int
+ (scm_string_length (scm_caar (s))));
+ }
+
+ for (vsize i = 0; i < str.size (); i++)
+ {
+ /* Don't match in mid-UTF-8 */
+ if ((str[i] & 0xc0) == 0x80)
+ continue;
+ for (vsize j = max_length + 1; j--;)
+ {
+ if (j > str.size () - i)
+ continue;
+ string dummy = str.substr (i, j);
+ SCM ligature = ly_assoc_get (ly_string2scm (dummy),
+ replacement_alist, SCM_BOOL_F);
+ if (scm_is_true (ligature))
+ str.replace (i, j, robust_scm2string (ligature, ""));
+ }
}
}
MAKE_SCHEME_CALLBACK (Text_interface, interpret_string, 3);
SCM
Text_interface::interpret_string (SCM layout_smob,
- SCM props,
- SCM markup)
+ SCM props,
+ SCM markup)
{
LY_ASSERT_SMOB (Output_def, layout_smob, 1);
LY_ASSERT_TYPE (scm_is_string, markup, 3);
Output_def *layout = unsmob_output_def (layout_smob);
Font_metric *fm = select_encoded_font (layout, props);
- replace_whitespace (&str);
- return fm->word_stencil (str).smobbed_copy ();
+ replace_special_characters (str, props);
+
+ /*
+ We want to filter strings with a music font that pass through
+ the text interface. Here the font encoding is checked to see
+ if it matches one of the music font encodings. --pmccarty
+ */
+ SCM encoding = ly_chain_assoc_get (ly_symbol2scm ("font-encoding"),
+ props,
+ SCM_BOOL_F);
+ SCM music_encodings = ly_lily_module_constant ("all-music-font-encodings");
+
+ bool is_music = (scm_memq (encoding, music_encodings) != SCM_BOOL_F);
+ return fm->text_stencil (layout, str, is_music).smobbed_copy ();
}
MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
- "Convert a text markup into a stencil."
-" Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
-"\n"
-"@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
-" @code{ly:grob-layout}. @var{props} is a alist chain, ie. a list of alists."
-" This is typically obtained with"
-" @code{(ly:grob-alist-chain (ly:layout-lookup layout 'text-font-defaults))}."
-" @var{markup} is the markup text to be processed.");
+ "Convert a text markup into a stencil."
+ " Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
+ "\n"
+ "@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
+ " @code{ly:grob-layout}. @var{props} is an alist chain, i.e. a list of"
+ " alists. This is typically obtained with"
+ " @code{(ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))}."
+ " @var{markup} is the markup text to be processed.");
SCM
Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
{
if (scm_is_string (markup))
return interpret_string (layout_smob, props, markup);
- else if (scm_is_pair (markup))
+ else if (is_markup (markup))
{
SCM func = scm_car (markup);
SCM args = scm_cdr (markup);
- if (!is_markup (markup))
- programming_error ("markup head has no markup signature");
- return scm_apply_2 (func, layout_smob, props, args);
+ /* Use a hare/tortoise algorithm to detect whether we are in a cycle,
+ * i.e. whether we have already encountered the same markup in the
+ * current branch of the markup tree structure. */
+ static vector<SCM> encountered_markups;
+ size_t depth = encountered_markups.size ();
+ if (depth > 0)
+ {
+ int slow = depth / 2;
+ if (ly_is_equal (encountered_markups[slow], markup))
+ {
+ string name = ly_symbol2string (scm_procedure_name (func));
+ // TODO: Also print the arguments of the markup!
+ non_fatal_error (_f ("Cyclic markup detected: %s", name));
+ return Stencil ().smobbed_copy ();
+ }
+ }
+
+ /* Check for non-terminating markups, e.g. recursive calls with
+ * changing arguments */
+ SCM opt_depth = ly_get_option (ly_symbol2scm ("max-markup-depth"));
+ size_t max_depth = robust_scm2int (opt_depth, 1024);
+ if (depth > max_depth)
+ {
+ string name = ly_symbol2string (scm_procedure_name (func));
+ // TODO: Also print the arguments of the markup!
+ non_fatal_error (_f ("Markup depth exceeds maximal value of %d; "
+ "Markup: %s", max_depth, name.c_str ()));
+ return Stencil ().smobbed_copy ();
+ }
+
+ encountered_markups.push_back (markup);
+ SCM retval = scm_apply_2 (func, layout_smob, props, args);
+ encountered_markups.pop_back ();
+ return retval;
}
else
{
- programming_error ("Object is not a markup. ");
+ programming_error ("Object is not a markup.");
scm_puts ("This object should be a markup: ", scm_current_error_port ());
scm_display (markup, scm_current_error_port ());
scm_puts ("\n", scm_current_error_port ());
- Box b;
- b[X_AXIS].set_empty ();
- b[Y_AXIS].set_empty ();
-
- Stencil s (b, SCM_EOL);
- return s.smobbed_copy ();
+ return Stencil ().smobbed_copy ();
}
}
bool
Text_interface::is_markup (SCM x)
{
- return (scm_is_string (x)
- || (scm_is_pair (x)
- && SCM_BOOL_F
- != scm_object_property (scm_car (x),
- ly_symbol2scm ("markup-signature"))));
+ return scm_is_string (x)
+ || (scm_is_pair (x)
+ && scm_is_true
+ (scm_object_property (scm_car (x),
+ ly_symbol2scm ("markup-signature")))
+ && scm_is_false
+ (scm_object_property (scm_car (x),
+ ly_symbol2scm ("markup-list-command"))));
}
bool
return scm_is_true (scm_call_1 (music_list_p, x));
}
-
ADD_INTERFACE (Text_interface,
- "A Scheme markup text, see @ruser{Text markup} and"
- " @ruser{New markup command definition}.\n"
- "\n"
- "There are two important commands:"
- " @code{ly:text-interface::print}, which is a"
- " grob callback, and"
- " @code{ly:text-interface::interpret-markup}.",
-
- /* properties */
- "baseline-skip "
- "text "
- "word-space "
- "text-direction "
- );
+ "A Scheme markup text, see @ruser{Formatting text} and"
+ " @rextend{New markup command definition}.\n"
+ "\n"
+ "There are two important commands:"
+ " @code{ly:text-interface::print}, which is a"
+ " grob callback, and"
+ " @code{ly:text-interface::interpret-markup}.",
+
+ /* properties */
+ "baseline-skip "
+ "replacement-alist "
+ "text "
+ "word-space "
+ "text-direction "
+ "flag-style "
+ );