]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/text-interface.cc
Issue 1388: Initial work to support opentype font features.
[lilypond.git] / lily / text-interface.cc
index 8f2f7edc062d2f2a8fb31f2720c38fea0d13d5a8..bad6d50281f626ccce966a8e15200b9a4f80ea8d 100644 (file)
 /*
-  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--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1998--2015 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"
+#include "lily-imports.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);
+
+  int max_length = 0;
+  for (SCM s = replacement_alist; scm_is_pair (s); s = scm_cdr (s))
+    {
+      max_length = max (max_length, scm_to_int
+                        (scm_string_length (scm_caar (s))));
+    }
 
-  while (i < n)
+  for (vsize i = 0; i < str.size (); i++)
     {
-      vsize char_len = 1;
-      char cur = (*str)[i];
-      
-      // U+10000 - U+10FFFF
-      if ((cur & 0xF0) == 0xF0)
-       char_len = 4;
-      // U+0800 - U+FFFF
-      else if ((cur & 0xE0) == 0xE0)
-       char_len = 3;
-      // U+0080 - U+07FF
-      else if ((cur & 0xC0) == 0xC0)
-       char_len = 2;
-      else if (cur & 0x80)
-       programming_error ("invalid utf-8 string");
-      else
-       // avoid the locale-dependent isspace
-       if (cur == '\n' || cur == '\t' || cur == '\v')
-         (*str)[i] = ' ';
-
-      i += char_len;
+      /* 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);
 
   string str = ly_scm2string (markup);
-  Output_def *layout = unsmob_output_def (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 use "glyph-string" in the SVG backend for all
-    music fonts (Emmentaler and Aybabtu) that pass through the
-    text interface.  Here the font encoding is checked to see if
-    it matches one of the music font encodings.  --pmccarty
+    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");
+                                     props,
+                                     SCM_BOOL_F);
+  SCM music_encodings = Lily::all_music_font_encodings;
+
+  SCM features = ly_chain_assoc_get (ly_symbol2scm ("font-features"),
+                                     props,
+                                     SCM_BOOL_F);
+
+  // The font-features value is stored in a scheme list. This joins the entries
+  // with commas for processing with pango.
+  string features_str = string ();
+  if (scm_is_pair (features))
+    {
+      bool first = true;
+      for (SCM s = features; scm_is_pair (s); s = scm_cdr (s))
+        {
+          SCM feature = scm_car (s);
+          if (scm_is_string (feature))
+            {
+              if (first)
+                {
+                  first = false;
+                }
+              else
+                {
+                  features_str += ",";
+                }
+              features_str += ly_scm2string (feature);
+            }
+          else
+            {
+              scm_misc_error (__FUNCTION__, "Found non-string in font-features list", SCM_EOL);
+            }
+        }
+    }
+  else if (!scm_is_false (features))
+    {
+      scm_misc_error (__FUNCTION__, "Expecting a list for font-features value", SCM_EOL);
+    }
 
-  if (scm_memq (encoding, music_encodings) != SCM_BOOL_F)
-    return fm->word_stencil (str, true).smobbed_copy ();
-  else
-    return fm->word_stencil (str, false).smobbed_copy ();
+  bool is_music = scm_is_true (scm_memq (encoding, music_encodings));
+  return fm->text_stencil (layout, str, is_music, features_str).smobbed_copy ();
 }
 
+static size_t markup_depth = 0;
+
+void markup_up_depth (void *) { ++markup_depth; }
+void markup_down_depth (void *) { --markup_depth; }
+
 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)
 {
   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);
+      /* 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);
+
+      // Don't use SCM_F_DYNWIND_REWINDABLE since it may be expensive
+      // without any obvious use for retaining continuations into
+      // markup expansion
+      scm_dynwind_begin ((scm_t_dynwind_flags)0);
+      // scm_dynwind_rewind_handler (markup_up_depth, 0, SCM_F_WIND_EXPLICITLY);
+      markup_up_depth (0);
+      scm_dynwind_unwind_handler (markup_down_depth, 0, SCM_F_WIND_EXPLICITLY);
+      if (markup_depth > max_depth)
+        {
+          scm_dynwind_end ();
+          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 ();
+        }
+
+      SCM retval = scm_apply_2 (func, layout_smob, props, args);
+      scm_dynwind_end ();
+      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 ();
     }
 }
 
@@ -125,7 +197,7 @@ MAKE_SCHEME_CALLBACK (Text_interface, print, 1);
 SCM
 Text_interface::print (SCM grob)
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = unsmob<Grob> (grob);
 
   SCM t = me->get_property ("text");
   SCM chain = Font_interface::text_font_alist_chain (me);
@@ -136,34 +208,37 @@ Text_interface::print (SCM grob)
 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
 Text_interface::is_markup_list (SCM x)
 {
-  SCM music_list_p = ly_lily_module_constant ("markup-list?");
-  return scm_is_true (scm_call_1 (music_list_p, x));
+  return scm_is_true (Lily::markup_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 "
+               "flag-style "
+              );