lily/text-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Jan Nieuwenhuizen <janneke@gnu.org>
   6
   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.
  11
  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.
  16
  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/>.
  19 */
  20
  21 #include "text-interface.hh"
  22 #include "skyline-pair.hh"
  23
  24 #include "lookup.hh"
  25 #include "config.hh"
  26 #include "font-interface.hh"
  27 #include "grob.hh"
  28 #include "main.hh"
  29 #include "misc.hh"
  30 #include "modified-font-metric.hh"
  31 #include "output-def.hh"
  32 #include "pango-font.hh"
  33 #include "program-option.hh"
  34 #include "international.hh"
  35 #include "warn.hh"
  36
  37 static void
  38 replace_special_characters (string &str, SCM props)
  39 {
  40   SCM replacement_alist = ly_chain_assoc_get (ly_symbol2scm ("replacement-alist"),
  41                                               props,
  42                                               SCM_EOL);
  43
  44   int max_length = 0;
  45   for (SCM s = replacement_alist; scm_is_pair (s); s = scm_cdr (s))
  46     {
  47       max_length = max (max_length, scm_to_int
  48                         (scm_string_length (scm_caar (s))));
  49     }
  50
  51   for (vsize i = 0; i < str.size (); i++)
  52     {
  53       /* Don't match in mid-UTF-8 */
  54       if ((str[i] & 0xc0) == 0x80)
  55         continue;
  56       for (vsize j = max_length + 1; j--;)
  57         {
  58           if (j > str.size () - i)
  59             continue;
  60           string dummy = str.substr (i, j);
  61           SCM ligature = ly_assoc_get (ly_string2scm (dummy),
  62                                        replacement_alist, SCM_BOOL_F);
  63           if (scm_is_true (ligature))
  64             str.replace (i, j, robust_scm2string (ligature, ""));
  65         }
  66     }
  67 }
  68
  69 MAKE_SCHEME_CALLBACK (Text_interface, interpret_string, 3);
  70 SCM
  71 Text_interface::interpret_string (SCM layout_smob,
  72                                   SCM props,
  73                                   SCM markup)
  74 {
  75   LY_ASSERT_SMOB (Output_def, layout_smob, 1);
  76   LY_ASSERT_TYPE (scm_is_string, markup, 3);
  77
  78   string str = ly_scm2string (markup);
  79   Output_def *layout = Output_def::unsmob (layout_smob);
  80   Font_metric *fm = select_encoded_font (layout, props);
  81
  82   replace_special_characters (str, props);
  83
  84   /*
  85     We want to filter strings with a music font that pass through
  86     the text interface.  Here the font encoding is checked to see
  87     if it matches one of the music font encodings.  --pmccarty
  88   */
  89   SCM encoding = ly_chain_assoc_get (ly_symbol2scm ("font-encoding"),
  90                                      props,
  91                                      SCM_BOOL_F);
  92   SCM music_encodings = ly_lily_module_constant ("all-music-font-encodings");
  93
  94   bool is_music = (scm_memq (encoding, music_encodings) != SCM_BOOL_F);
  95   return fm->text_stencil (layout, str, is_music).smobbed_copy ();
  96 }
  97
  98 static size_t markup_depth = 0;
  99
 100 void markup_up_depth (void *) { ++markup_depth; }
 101 void markup_down_depth (void *) { --markup_depth; }
 102
 103 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
 104                                    "Convert a text markup into a stencil."
 105                                    "  Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
 106                                    "\n"
 107                                    "@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
 108                                    " @code{ly:grob-layout}.  @var{props} is an alist chain, i.e. a list of"
 109                                    "  alists.  This is typically obtained with"
 110                                    " @code{(ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))}."
 111                                    "  @var{markup} is the markup text to be processed.");
 112 SCM
 113 Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
 114 {
 115   if (scm_is_string (markup))
 116     return interpret_string (layout_smob, props, markup);
 117   else if (is_markup (markup))
 118     {
 119       SCM func = scm_car (markup);
 120       SCM args = scm_cdr (markup);
 121
 122       /* Check for non-terminating markups, e.g. recursive calls with
 123        * changing arguments */
 124       SCM opt_depth = ly_get_option (ly_symbol2scm ("max-markup-depth"));
 125       size_t max_depth = robust_scm2int (opt_depth, 1024);
 126
 127       // Don't use SCM_F_DYNWIND_REWINDABLE since it may be expensive
 128       // without any obvious use for retaining continuations into
 129       // markup expansion
 130       scm_dynwind_begin ((scm_t_dynwind_flags)0);
 131       // scm_dynwind_rewind_handler (markup_up_depth, 0, SCM_F_WIND_EXPLICITLY);
 132       markup_up_depth (0);
 133       scm_dynwind_unwind_handler (markup_down_depth, 0, SCM_F_WIND_EXPLICITLY);
 134       if (markup_depth > max_depth)
 135         {
 136           string name = ly_symbol2string (scm_procedure_name (func));
 137           // TODO: Also print the arguments of the markup!
 138           non_fatal_error (_f ("Markup depth exceeds maximal value of %d; "
 139                                "Markup: %s", max_depth, name.c_str ()));
 140           return Stencil ().smobbed_copy ();
 141         }
 142
 143       SCM retval = scm_apply_2 (func, layout_smob, props, args);
 144       scm_dynwind_end ();
 145       return retval;
 146     }
 147   else
 148     {
 149       programming_error ("Object is not a markup.");
 150       scm_puts ("This object should be a markup: ", scm_current_error_port ());
 151       scm_display (markup, scm_current_error_port ());
 152       scm_puts ("\n", scm_current_error_port ());
 153
 154       return Stencil ().smobbed_copy ();
 155     }
 156 }
 157
 158 MAKE_SCHEME_CALLBACK (Text_interface, print, 1);
 159 SCM
 160 Text_interface::print (SCM grob)
 161 {
 162   Grob *me = Grob::unsmob (grob);
 163
 164   SCM t = me->get_property ("text");
 165   SCM chain = Font_interface::text_font_alist_chain (me);
 166   return interpret_markup (me->layout ()->self_scm (), chain, t);
 167 }
 168
 169 /* Ugh. Duplicated from Scheme.  */
 170 bool
 171 Text_interface::is_markup (SCM x)
 172 {
 173   return scm_is_string (x)
 174     || (scm_is_pair (x)
 175         && scm_is_true
 176         (scm_object_property (scm_car (x),
 177                               ly_symbol2scm ("markup-signature")))
 178         && scm_is_false
 179         (scm_object_property (scm_car (x),
 180                               ly_symbol2scm ("markup-list-command"))));
 181 }
 182
 183 bool
 184 Text_interface::is_markup_list (SCM x)
 185 {
 186   SCM music_list_p = ly_lily_module_constant ("markup-list?");
 187   return scm_is_true (scm_call_1 (music_list_p, x));
 188 }
 189
 190 ADD_INTERFACE (Text_interface,
 191                "A Scheme markup text, see @ruser{Formatting text} and"
 192                " @rextend{New markup command definition}.\n"
 193                "\n"
 194                "There are two important commands:"
 195                " @code{ly:text-interface::print}, which is a"
 196                " grob callback, and"
 197                " @code{ly:text-interface::interpret-markup}.",
 198
 199                /* properties */
 200                "baseline-skip "
 201                "replacement-alist "
 202                "text "
 203                "word-space "
 204                "text-direction "
 205                "flag-style "
 206               );
 207