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 "warn.hh"
  32
  33 static void
  34 replace_whitespace (string *str)
  35 {
  36   vsize i = 0;
  37   vsize n = str->size ();
  38
  39   while (i < n)
  40     {
  41       char cur = (*str)[i];
  42
  43       // avoid the locale-dependent isspace
  44       if (cur == '\n' || cur == '\t' || cur == '\v')
  45         (*str)[i] = ' ';
  46
  47       vsize char_len = utf8_char_len (cur);
  48
  49       i += char_len;
  50     }
  51 }
  52
  53 MAKE_SCHEME_CALLBACK (Text_interface, interpret_string, 3);
  54 SCM
  55 Text_interface::interpret_string (SCM layout_smob,
  56                                   SCM props,
  57                                   SCM markup)
  58 {
  59   LY_ASSERT_SMOB (Output_def, layout_smob, 1);
  60   LY_ASSERT_TYPE (scm_is_string, markup, 3);
  61
  62   string str = ly_scm2string (markup);
  63   Output_def *layout = unsmob_output_def (layout_smob);
  64   Font_metric *fm = select_encoded_font (layout, props);
  65
  66   replace_whitespace (&str);
  67
  68   /*
  69     We want to filter strings with a music font that pass through
  70     the text interface.  Here the font encoding is checked to see
  71     if it matches one of the music font encodings.  --pmccarty
  72   */
  73   SCM encoding = ly_chain_assoc_get (ly_symbol2scm ("font-encoding"),
  74                                      props,
  75                                      SCM_BOOL_F);
  76   SCM music_encodings = ly_lily_module_constant ("all-music-font-encodings");
  77
  78   bool is_music = (scm_memq (encoding, music_encodings) != SCM_BOOL_F);
  79   return fm->text_stencil (layout, str, is_music).smobbed_copy ();
  80 }
  81
  82 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
  83                                    "Convert a text markup into a stencil."
  84 "  Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
  85 "\n"
  86 "@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
  87 " @code{ly:grob-layout}.  @var{props} is an alist chain, i.e. a list of"
  88 "  alists.  This is typically obtained with"
  89 " @code{(ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))}."
  90 "  @var{markup} is the markup text to be processed.");
  91 SCM
  92 Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
  93 {
  94   if (scm_is_string (markup))
  95     return interpret_string (layout_smob, props, markup);
  96   else if (scm_is_pair (markup))
  97     {
  98       SCM func = scm_car (markup);
  99       SCM args = scm_cdr (markup);
 100       if (!is_markup (markup))
 101         programming_error ("markup head has no markup signature");
 102
 103       return scm_apply_2 (func, layout_smob, props, args);
 104     }
 105   else
 106     {
 107       programming_error ("Object is not a markup. ");
 108       scm_puts ("This object should be a markup: ", scm_current_error_port ());
 109       scm_display (markup, scm_current_error_port ());
 110       scm_puts ("\n", scm_current_error_port ());
 111
 112       Box b;
 113       b[X_AXIS].set_empty ();
 114       b[Y_AXIS].set_empty ();
 115
 116       Stencil s (b, SCM_EOL);
 117       return s.smobbed_copy ();
 118     }
 119 }
 120
 121 MAKE_SCHEME_CALLBACK (Text_interface, print, 1);
 122 SCM
 123 Text_interface::print (SCM grob)
 124 {
 125   Grob *me = unsmob_grob (grob);
 126
 127   SCM t = me->get_property ("text");
 128   SCM chain = Font_interface::text_font_alist_chain (me);
 129   return interpret_markup (me->layout ()->self_scm (), chain, t);
 130 }
 131
 132 /* Ugh. Duplicated from Scheme.  */
 133 bool
 134 Text_interface::is_markup (SCM x)
 135 {
 136   return (scm_is_string (x)
 137           || (scm_is_pair (x)
 138               && SCM_BOOL_F
 139               != scm_object_property (scm_car (x),
 140                                       ly_symbol2scm ("markup-signature"))));
 141 }
 142
 143 bool
 144 Text_interface::is_markup_list (SCM x)
 145 {
 146   SCM music_list_p = ly_lily_module_constant ("markup-list?");
 147   return scm_is_true (scm_call_1 (music_list_p, x));
 148 }
 149
 150
 151 ADD_INTERFACE (Text_interface,
 152                "A Scheme markup text, see @ruser{Formatting text} and"
 153                " @rextend{New markup command definition}.\n"
 154                "\n"
 155                "There are two important commands:"
 156                " @code{ly:text-interface::print}, which is a"
 157                " grob callback, and"
 158                " @code{ly:text-interface::interpret-markup}.",
 159
 160                /* properties */
 161                "baseline-skip "
 162                "text "
 163                "word-space "
 164                "text-direction "
 165                );
 166