]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/text-item.cc
move from abe.ly
[lilypond.git] / lily / text-item.cc
index c715035e4954d9c1d0853ce2d1f78601328582e8..098ef17402e5cad7cba87197374826aee0c61181 100644 (file)
 
   source file of the GNU LilyPond music typesetter
   
(c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
  */
+#include <math.h>
 
+#include "warn.hh"
 #include "text-item.hh"
 #include "paper-def.hh"
-#include "lookup.hh"
+#include "font-interface.hh"
 #include "staff-symbol-referencer.hh"
 #include "staff-symbol-referencer.hh"
 #include "main.hh"
 #include "all-font-metrics.hh"
 #include "afm.hh"
+#include "lookup.hh"
+#include "virtual-font-metric.hh"
 
 /*
-  text: string | (markup sentence)
-  markup: markup-symbol | (markup-symbol . parameter)
-  sentence: text | sentence text
-  
 
-  Properties:
+  TEXT: STRING
+        | (MARKUP? TEXT+)
+        ;
 
-  * Font:
-  ---* Type:
-  ------* Series: medium, bold
-  ------* Shape: upright, italic, slanted
-  ------* Family: roman, music, orator, typewriter
+  HEAD: MARKUP-ITEM | (MARKUP-ITEM+)
 
-  ---* Size:
-  ------* size: ...,-2,-1,0,1,2,... (style-sheet -> cmrXX, fetaXX)
-  ------* points: 11,13,16,20,23,26 (for feta)
-  ------* magnification: UNSIGNED
+  MARKUP-ITEM: PROPERTY | ABBREV | FONT-STYLE
+  PROPERTY: (key . value)
+  ABBREV: rows lines roman music bold italic named super sub text
+   
+*/
 
-  * Typesetting:
-  ---* kern: INT (staff-space)
-  ---* align: horizontal/vertical / lines / rows
- */
 Molecule
-Text_item::text2molecule (Score_element *me, SCM text, SCM properties
+Text_item::text2molecule (Grob *me, SCM text, SCM alist_chain
 {
   if (gh_string_p (text))
-    return string2molecule (me, text, properties);
-  else if (gh_list_p (text))
+    return string2molecule (me, text, alist_chain);
+  else if (gh_pair_p (text))
     {
-      if (!gh_pair_p (gh_car (text)) && gh_string_p (gh_car (text)))
-       return string2molecule (me, gh_car (text), properties);
+      /* urg, why not just do  this in markup_text2molecule ? */
+      if (gh_string_p (ly_car (text)))
+       return markup_text2molecule (me,
+                                    gh_append2 (scm_list_n (SCM_EOL,
+                                                        SCM_UNDEFINED),
+                                                text),
+                                    alist_chain);
+      /*
+       Allow (faulty) texts that are in an extra list:
+       #'(("foo"))
+       */
+      else if (scm_ilength (text) <= 1)
+       return text2molecule (me, ly_car (text), alist_chain);
       else
-       return markup_sentence2molecule (me, text, properties);
+       return markup_text2molecule (me, text, alist_chain);
     }
   return Molecule ();
 }
 
+
+MAKE_SCHEME_CALLBACK(Text_item,text_to_molecule,3);
+SCM
+Text_item::text_to_molecule (SCM grob, SCM props, SCM markup)
+{
+  Grob *me = unsmob_grob (grob);
+  
+  return Text_item::text2molecule (me, markup, props).smobbed_copy();
+}
+
+
 Molecule
-Text_item::string2molecule (Score_element *me, SCM text, SCM properties)
+Text_item::string2molecule (Grob *me, SCM text, SCM alist_chain)
 {
-  SCM style = scm_assoc (ly_symbol2scm ("font-style"), properties);
-  SCM paper = me->get_elt_property ("style-sheet");
-  SCM font_name;
-  if (gh_pair_p (style))
-    {
-      SCM f = me->get_elt_property ("style-to-font-name");
-      font_name = gh_call2 (f, paper, gh_cdr (style));
-    }
+  SCM style = ly_assoc_chain (ly_symbol2scm ("font-style"),
+                             alist_chain);
+  if (gh_pair_p (style) && gh_symbol_p (ly_cdr (style)))
+    alist_chain = Font_interface::add_style (me, ly_cdr (style), alist_chain);
+
+  Font_metric *fm = Font_interface::get_font (me, alist_chain);
+  
+  SCM lookup = ly_assoc_chain (ly_symbol2scm ("lookup"), alist_chain);
+    
+  Molecule mol;
+  if (gh_pair_p (lookup) && ly_cdr (lookup) ==ly_symbol2scm ("name"))
+    mol = lookup_character (me, fm, text);
   else
+    mol = lookup_text (me, fm, text);
+  
+  return mol;
+}
+
+Molecule
+Text_item::lookup_character (Grob *, Font_metric*fm, SCM char_name)
+{
+  return fm->find_by_name (ly_scm2string (char_name));
+}
+
+
+
+Molecule
+Text_item::lookup_text (Grob *, Font_metric*fm, SCM text)
+{
+  SCM list = scm_list_n (ly_symbol2scm ("text"), text, SCM_UNDEFINED);
+
+  if (dynamic_cast<Virtual_font_metric*> (fm))
     {
-      SCM f = me->get_elt_property ("properties-to-font-name");
-      font_name = gh_call2 (f, paper, properties);
+      /*
+       ARGH.
+       */
+      programming_error ("Can't use virtual font for text.");
     }
-  String font_str = "roman";
-  if (gh_string_p (font_name))
-    font_str = ly_scm2string (font_name);
-    
-  SCM magnification = me->get_elt_property ("font-magnification");
-
-  Font_metric* metric_l = 0;
-  if (gh_number_p (magnification))
-    metric_l = all_fonts_global_p->find_scaled (font_str,
-                                               gh_scm2int (magnification));
   else
-    metric_l = all_fonts_global_p->find_font (font_str);
+    list = fontify_atom (fm, list);
+  
+  return Molecule (fm->text_dimension (ly_scm2string (text)), list);
+}
 
-  SCM list = gh_list (ly_symbol2scm ("text"), text, SCM_UNDEFINED);
-  list = fontify_atom (metric_l, list);
 
-  return Molecule (metric_l->text_dimension (ly_scm2string (text)), list);
-}
+/*
+  TODO:
+
+  DOCME.
+
 
+  MARKUP_TEXT must be compound (may not be simple string.)
+  
+ */
 Molecule
-Text_item::markup_sentence2molecule (Score_element *me, SCM markup_sentence,
-                                    SCM properties)
+Text_item::markup_text2molecule (Grob *me, SCM markup_text,
+                                SCM alist_chain)
 {
-  SCM markup = gh_car (markup_sentence);
-  SCM sentence = gh_cdr (markup_sentence);
-  SCM f = me->get_elt_property ("markup-to-properties");
+  SCM f = me->get_paper ()->lookup_variable (ly_symbol2scm ("markup-to-properties"));
   
-  SCM p = gh_cons (gh_call1 (f, markup), properties);
+  SCM markup = ly_car (markup_text);
+  SCM text = ly_cdr (markup_text);
 
-  Axis align = X_AXIS;
-  SCM a = scm_assoc (ly_symbol2scm ("align"), p);
-  if (gh_pair_p (a) && gh_number_p (gh_cdr (a)))
-    align = (Axis)gh_scm2int (gh_cdr (a));
+  /* ARGRGRRGRARGRA
+   */
 
-  Molecule mol;
-  while (gh_pair_p (sentence))
+  SCM abbrev = me->get_paper ()->lookup_variable (ly_symbol2scm ("abbreviation-alist"));
+  SCM style = me->get_paper ()->lookup_variable (ly_symbol2scm ("style-alist"));
+  
+  SCM p = gh_cons (scm_call_3 (f, abbrev, style, markup), alist_chain);
+
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+
+  /*
+    Line mode is default.
+   */
+  Axis axis = X_AXIS;
+
+  SCM a = ly_assoc_chain (ly_symbol2scm ("axis"), p);
+  if (gh_pair_p (a) && ly_axis_p (ly_cdr (a)))
+    axis = (Axis)gh_scm2int (ly_cdr (a));
+
+  Real baseline_skip = 0;
+  SCM b = ly_assoc_chain (ly_symbol2scm ("baseline-skip"), p);
+  if (gh_pair_p (b) && gh_number_p (ly_cdr (b)))
+    baseline_skip = gh_scm2double (ly_cdr (b)) * staff_space;
+  
+  Real kern[2] = {0,0};
+
+  SCM k = ly_assoc_chain (ly_symbol2scm ("kern"), p);
+  if (gh_pair_p (k) && gh_number_p (ly_cdr (k)))
+    kern[axis] = gh_scm2double (ly_cdr (k)) * staff_space;
+                            
+  Real raise = 0;
+  SCM r = ly_assoc_chain (ly_symbol2scm ("raise"), p);
+  if (gh_pair_p (r) && gh_number_p (ly_cdr (r)))
+    raise = gh_scm2double (ly_cdr (r)) * staff_space;
+  
+
+  Interval extent;
+  bool extent_b = false;
+  SCM e = ly_assoc_chain (ly_symbol2scm ("extent"), p);
+  if (gh_pair_p (e) && ly_number_pair_p (ly_cdr (e)))
     {
-      Molecule m = text2molecule (me, gh_car (sentence), p);
+      extent = Interval (gh_scm2double (ly_cadr (e)) * staff_space,
+                      gh_scm2double (ly_cddr (e)) * staff_space);
+      extent_b = true;
+    }
+
+  Offset o (kern[X_AXIS], raise - kern[Y_AXIS]);
+  
+  Molecule mol = Lookup::filledbox (Box (Interval (0,0), Interval (0,0)));
+
+  SCM cp = ly_deep_copy (p);
+  if (raise)
+    {
+      SCM cr = ly_assoc_chain (ly_symbol2scm ("raise"), cp);
+      scm_set_cdr_x (cr, gh_int2scm (0));
+    }
+  
+  while (gh_pair_p (text))
+    {
+      Molecule m = text2molecule (me, ly_car (text), cp);
+
       if (!m.empty_b ())
-       mol.add_at_edge (align, align == X_AXIS ? RIGHT : DOWN, m, 0);
-      sentence = gh_cdr (sentence);
+       {
+         m.translate_axis (mol.extent (axis)[axis == X_AXIS ? RIGHT : DOWN]
+                           - (axis == Y_AXIS ? baseline_skip : 0),
+                           axis);
+         mol.add_molecule (m);
+       }
+      text = ly_cdr (text);
+    }
+  
+  
+  /* Set extend to markup evented value. */
+  if (extent_b)
+    {
+      Box b = mol.extent_box ();
+      SCM expr = mol.get_expr ();
+
+      b[axis] = extent;
+      mol = Molecule (b, expr);
     }
+  
+  mol.translate (o);
+  
   return mol;
 }
 
 MAKE_SCHEME_CALLBACK (Text_item, brew_molecule, 1);
 SCM 
-Text_item::brew_molecule (SCM smob) 
+Text_item::brew_molecule (SCM smob)
 {
-  Score_element *me = unsmob_element (smob);
+  Grob *me = unsmob_grob (smob);
   
-  SCM text = me->get_elt_property ("scm-text");
-  Molecule mol;
-  if (text == SCM_EOL)
-    {
-      SCM style = me->get_elt_property ("style");
-      String st = gh_string_p (style) ?  ly_scm2string (style) : "";
-      SCM text = me->get_elt_property ("text");
-      String t = gh_string_p (text) ? ly_scm2string (text) : "";
-      
-      mol = me->paper_l ()->lookup_l (0)->text (st, t, me->paper_l ());
-    }
-  else
-    mol = text2molecule (me, text,
-                        gh_append2 (me->immutable_property_alist_,
-                                    me->mutable_property_alist_));
+  SCM text = me->get_grob_property ("text");
+
+  SCM properties = Font_interface::font_alist_chain (me);
+  Molecule mol = Text_item::text2molecule (me, text, properties);
 
-  SCM space = me->get_elt_property ("word-space");
+  SCM space = me->get_grob_property ("word-space");
   if (gh_number_p (space))
     {
       Molecule m;
       m.set_empty (false);
       mol.add_at_edge (X_AXIS, RIGHT, m, gh_scm2double (space)
-                      * Staff_symbol_referencer::staff_space (me));
+                      * Staff_symbol_referencer::staff_space (me), 0);
     }
-  return mol.create_scheme (); 
+  return mol.smobbed_copy (); 
+}
+
+
+
+ADD_INTERFACE (Text_item,"text-interface",
+  "A scheme markup text, see @ref{Markup functions}.",
+  "text baseline-skip word-space");
+
+
+/*
+  Ugh. Duplicated from Scheme.
+ */
+bool
+new_markup_p (SCM x)
+{
+  return
+    gh_string_p (x) ||
+    (gh_pair_p (x)
+     && SCM_BOOL_F != scm_object_property (gh_car (x), ly_symbol2scm ("markup-signature")));
 }
 
+SCM
+new_markup_brewer ()
+{
+  static SCM proc ;
+
+  if (!proc)
+    proc = scm_c_eval_string ("brew-new-markup-molecule");
+
+  return proc;
+}