lily/text-interface.cc

   1 /*
   2   text-interface.cc -- implement Text_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #include "text-interface.hh"
  11
  12
  13 #include "main.hh"
  14 #include "config.hh"
  15 #include "pango-font.hh"
  16 #include "warn.hh"
  17 #include "grob.hh"
  18 #include "font-interface.hh"
  19 #include "output-def.hh"
  20 #include "modified-font-metric.hh"
  21
  22 static void
  23 replace_whitespace (string *str)
  24 {
  25   vsize i = 0;
  26   vsize n = str->size ();
  27
  28   while (i < n)
  29     {
  30       vsize char_len = 1;
  31       char cur = (*str)[i];
  32
  33       if ((cur & 0x11100000) == 0x11100000)
  34         char_len = 3;
  35       else if ((cur & 0x11000000) == 0x11000000)
  36         char_len = 2;
  37       else if (cur & 0x10000000)
  38         programming_error ("invalid utf-8 string");
  39
  40       /* avoid the locale-dependent isspace */
  41       if (cur == '\n' || cur == '\t' || cur == '\v')
  42         (*str)[i] = ' ';
  43
  44       i += char_len;
  45     }
  46 }
  47
  48 MAKE_SCHEME_CALLBACK (Text_interface, interpret_string, 3);
  49 SCM
  50 Text_interface::interpret_string (SCM layout_smob,
  51                                   SCM props,
  52                                   SCM markup)
  53 {
  54   LY_ASSERT_SMOB (Output_def, layout_smob, 1);
  55   LY_ASSERT_TYPE (scm_is_string, markup, 3);
  56
  57   string str = ly_scm2string (markup);
  58   Output_def *layout = unsmob_output_def (layout_smob);
  59   Font_metric *fm = select_encoded_font (layout, props);
  60
  61   replace_whitespace (&str);
  62   return fm->word_stencil (str).smobbed_copy ();
  63 }
  64
  65 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Text_interface, interpret_markup, 3, 0,
  66                                    "Convert a text markup into a stencil."
  67 "  Takes three arguments, @var{layout}, @var{props}, and @var{markup}.\n"
  68 "\n"
  69 "@var{layout} is a @code{\\layout} block; it may be obtained from a grob with"
  70 " @code{ly:grob-layout}.  @var{props} is a alist chain, ie. a list of alists."
  71 "  This is typically obtained with"
  72 " @code{(ly:grob-alist-chain (ly:layout-lookup layout 'text-font-defaults))}."
  73 "  @var{markup} is the markup text to be processed.");
  74 SCM
  75 Text_interface::interpret_markup (SCM layout_smob, SCM props, SCM markup)
  76 {
  77   if (scm_is_string (markup))
  78     return interpret_string (layout_smob, props, markup);
  79   else if (scm_is_pair (markup))
  80     {
  81       SCM func = scm_car (markup);
  82       SCM args = scm_cdr (markup);
  83       if (!is_markup (markup))
  84         programming_error ("markup head has no markup signature");
  85
  86       return scm_apply_2 (func, layout_smob, props, args);
  87     }
  88   else
  89     {
  90       programming_error ("Object is not a markup. ");
  91       scm_puts ("This object should be a markup: ", scm_current_error_port ());
  92       scm_display (markup, scm_current_error_port ());
  93       scm_puts ("\n", scm_current_error_port ());
  94
  95       Box b;
  96       b[X_AXIS].set_empty ();
  97       b[Y_AXIS].set_empty ();
  98
  99       Stencil s (b, SCM_EOL);
 100       return s.smobbed_copy ();
 101     }
 102 }
 103
 104 MAKE_SCHEME_CALLBACK (Text_interface, print, 1);
 105 SCM
 106 Text_interface::print (SCM grob)
 107 {
 108   Grob *me = unsmob_grob (grob);
 109
 110   SCM t = me->get_property ("text");
 111   SCM chain = Font_interface::text_font_alist_chain (me);
 112   return interpret_markup (me->layout ()->self_scm (), chain, t);
 113 }
 114
 115 /* Ugh. Duplicated from Scheme.  */
 116 bool
 117 Text_interface::is_markup (SCM x)
 118 {
 119   return (scm_is_string (x)
 120           || (scm_is_pair (x)
 121               && SCM_BOOL_F
 122               != scm_object_property (scm_car (x),
 123                                       ly_symbol2scm ("markup-signature"))));
 124 }
 125
 126 bool
 127 Text_interface::is_markup_list (SCM x)
 128 {
 129   SCM music_list_p = ly_lily_module_constant ("markup-list?");
 130   return scm_is_true (scm_call_1 (music_list_p, x));
 131 }
 132
 133
 134 ADD_INTERFACE (Text_interface,
 135                "A scheme markup text, see @ruser{Text markup} and "
 136                "@ruser{New markup command definition}. "
 137                "\n\n"
 138                "There are two important commands: ly:text-interface::print, which is a "
 139                "grob callback, and ly:text-interface::interpret-markup ",
 140
 141                /* props */
 142                "baseline-skip "
 143                "text "
 144                "word-space "
 145                "text-direction "
 146                );
 147