lily/text-interface.cc

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