]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/text-interface.cc
Imported Upstream version 2.16.0
[lilypond.git] / lily / text-interface.cc
index 983902f6af2079b97e586e2d6ab7eeeb752c225c..cd906c2e8eb7f791c58f522ea2a74415f27e8423 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 
   LilyPond is free software: you can redistribute it and/or modify
 #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))
     {
-      char cur = (*str)[i];
-
-      // avoid the locale-dependent isspace
-      if (cur == '\n' || cur == '\t' || cur == '\v')
-       (*str)[i] = ' ';
-
-      vsize char_len = utf8_char_len (cur);
+      max_length = max (max_length, scm_to_int
+                        (scm_string_length (scm_caar (s))));
+    }
 
-      i += char_len;
+  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);
@@ -63,7 +77,7 @@ Text_interface::interpret_string (SCM layout_smob,
   Output_def *layout = unsmob_output_def (layout_smob);
   Font_metric *fm = select_encoded_font (layout, props);
 
-  replace_whitespace (&str);
+  replace_special_characters (str, props);
 
   /*
     We want to filter strings with a music font that pass through
@@ -71,8 +85,8 @@ Text_interface::interpret_string (SCM layout_smob,
     if it matches one of the music font encodings.  --pmccarty
   */
   SCM encoding = ly_chain_assoc_get (ly_symbol2scm ("font-encoding"),
-                                    props,
-                                    SCM_BOOL_F);
+                                     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);
@@ -80,14 +94,14 @@ Text_interface::interpret_string (SCM layout_smob,
 }
 
 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 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.");
+                                   "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)
 {
@@ -98,23 +112,51 @@ Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM 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);
+        programming_error ("markup head has no markup signature");
+
+      /* 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 ();
     }
 }
 
@@ -134,10 +176,10 @@ 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"))));
+          || (scm_is_pair (x)
+              && SCM_BOOL_F
+              != scm_object_property (scm_car (x),
+                                      ly_symbol2scm ("markup-signature"))));
 }
 
 bool
@@ -147,20 +189,20 @@ Text_interface::is_markup_list (SCM x)
   return scm_is_true (scm_call_1 (music_list_p, x));
 }
 
-
 ADD_INTERFACE (Text_interface,
-              "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 "
-              "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 "
+              );