lily/text-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2011 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
  23 #include "config.hh"
  24 #include "font-interface.hh"
  25 #include "grob.hh"
  26 #include "main.hh"
  27 #include "misc.hh"
  28 #include "modified-font-metric.hh"
  29 #include "output-def.hh"
  30 #include "pango-font.hh"
  31 #include "program-option.hh"
  32 #include "international.hh"
  33 #include "warn.hh"
  34
  35 static void
  36 replace_special_characters (string *str, SCM props)
  37 {
  38   vsize i = 0;
  39   SCM replacement_alist = ly_chain_assoc_get (ly_symbol2scm ("replacement-alist"),
  40                                               props,
  41                                               SCM_EOL);
  42
  43   int max_length = 0;
  44   for (SCM s = replacement_alist; scm_is_pair (s); s = scm_cdr (s))
  45     {
  46       max_length = max (max_length, scm_to_int
  47                         (scm_string_length (scm_caar (s))));
  48     }
  49
  50   while (i <= str->size ())
  51     {
  52       for (vsize j = max_length + 1; j--;)
  53         {
  54           string dummy = str->substr (i, j);
  55           string ligature = robust_scm2string
  56                             (ly_assoc_get (ly_string2scm (dummy),
  57                                            replacement_alist, SCM_BOOL_F), "");
  58           if (ligature != "")
  59             str->replace (i, j, ligature);
  60         }
  61       i += utf8_char_len ((*str)[i]);
  62     }
  63 }
  64
  65 MAKE_SCHEME_CALLBACK (Text_interface, interpret_string, 3);
  66 SCM
  67 Text_interface::interpret_string (SCM layout_smob,
  68                                   SCM props,
  69                                   SCM markup)
  70 {
  71   LY_ASSERT_SMOB (Output_def, layout_smob, 1);
  72   LY_ASSERT_TYPE (scm_is_string, markup, 3);
  73
  74   string str = ly_scm2string (markup);
  75   Output_def *layout = unsmob_output_def (layout_smob);
  76   Font_metric *fm = select_encoded_font (layout, props);
  77
  78   replace_special_characters (&str, props);
  79
  80   /*
  81     We want to filter strings with a music font that pass through
  82     the text interface.  Here the font encoding is checked to see
  83     if it matches one of the music font encodings.  --pmccarty
  84   */
  85   SCM encoding = ly_chain_assoc_get (ly_symbol2scm ("font-encoding"),
  86                                      props,
  87                                      SCM_BOOL_F);
  88   SCM music_encodings = ly_lily_module_constant ("all-music-font-encodings");
  89
  90   bool is_music = (scm_memq (encoding, music_encodings) != SCM_BOOL_F);
  91   return fm->text_stencil (layout, str, is_music).smobbed_copy ();
  92 }
  93
  94 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
  95                                    "Convert a text markup into a stencil."
  96                                    "  Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
  97                                    "\n"
  98                                    "@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
  99                                    " @code{ly:grob-layout}.  @var{props} is an alist chain, i.e. a list of"
 100                                    "  alists.  This is typically obtained with"
 101                                    " @code{(ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))}."
 102                                    "  @var{markup} is the markup text to be processed.");
 103 SCM
 104 Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
 105 {
 106   if (scm_is_string (markup))
 107     return interpret_string (layout_smob, props, markup);
 108   else if (scm_is_pair (markup))
 109     {
 110       SCM func = scm_car (markup);
 111       SCM args = scm_cdr (markup);
 112       if (!is_markup (markup))
 113         programming_error ("markup head has no markup signature");
 114
 115       /* Use a hare/tortoise algorithm to detect whether we are in a cycle,
 116        * i.e. whether we have already encountered the same markup in the
 117        * current branch of the markup tree structure. */
 118       static vector<SCM> encountered_markups;
 119       size_t depth = encountered_markups.size ();
 120       if (depth > 0)
 121         {
 122           int slow = depth / 2;
 123           if (ly_is_equal (encountered_markups[slow], markup))
 124             {
 125               string name = ly_symbol2string (scm_procedure_name (func));
 126               // TODO: Also print the arguments of the markup!
 127               non_fatal_error (_f ("Cyclic markup detected: %s", name));
 128               return Stencil ().smobbed_copy ();
 129             }
 130         }
 131
 132       /* Check for non-terminating markups, e.g. recursive calls with
 133        * changing arguments */
 134       SCM opt_depth = ly_get_option (ly_symbol2scm ("max-markup-depth"));
 135       size_t max_depth = robust_scm2int (opt_depth, 1024);
 136       if (depth > max_depth)
 137         {
 138           string name = ly_symbol2string (scm_procedure_name (func));
 139           // TODO: Also print the arguments of the markup!
 140           non_fatal_error (_f ("Markup depth exceeds maximal value of %d; "
 141                                "Markup: %s", max_depth, name.c_str ()));
 142           return Stencil ().smobbed_copy ();
 143         }
 144
 145       encountered_markups.push_back (markup);
 146       SCM retval = scm_apply_2 (func, layout_smob, props, args);
 147       encountered_markups.pop_back ();
 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_BOOL_F
 179               != scm_object_property (scm_car (x),
 180                                       ly_symbol2scm ("markup-signature"))));
 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               );
 206