huh

[lilypond.git] / lily / font-interface.cc

diff --git a/lily/font-interface.cc b/lily/font-interface.cc
index c5c32c2337d2f2df2b08694af97e1786226a718c..7c1fb26bd8aecec2660c2a178935d9fcb9c35aed 100644 (file)
--- a/lily/font-interface.cc
+++ b/lily/font-interface.cc
@@ -39,13 +39,10 @@ Font_interface::font_alist_chain (Grob *me)
     Ugh: why the defaults?
    */
   SCM defaults = ly_cdr (scm_assoc (ly_symbol2scm ("font-defaults"),
-                                   me->paper_l ()->style_sheet_));
-
-  SCM ch = scm_list_n (me->mutable_property_alist_,
-                   me->immutable_property_alist_,
-                   defaults,
-                   SCM_UNDEFINED);
+                                   me->get_paper ()->style_sheet_));
 
+  SCM ch = me->get_property_alist_chain (defaults);
+  
   return ch;
 }
 
@@ -65,8 +62,9 @@ Font_interface::get_default_font (Grob*me)
 }
 
 
-SCM
-ly_font_interface_get_default_font (SCM grob)
+LY_DEFINE(ly_font_interface_get_default_font,
+         "ly-get-default-font", 1 , 0, 0,
+         (SCM grob), "Return the default font for grob @var{gr}.")
 {
   Grob * gr  = unsmob_grob (grob);
   SCM_ASSERT_TYPE(gr, grob, SCM_ARG1, __FUNCTION__, "grob");
@@ -74,8 +72,21 @@ ly_font_interface_get_default_font (SCM grob)
   return Font_interface::get_default_font (gr)->self_scm ();
 }
 
-SCM
-ly_font_interface_get_font (SCM grob, SCM alist)
+LY_DEFINE(ly_font_interface_get_font,"ly-get-font", 2, 0, 0,
+         (SCM grob, SCM alist),
+         "Return a font metric satisfying the font-qualifiers in @var{alist}.
+
+
+The font object represents the metric information of a font. Every font
+that is loaded into LilyPond can be accessed via Scheme. 
+
+LilyPond only needs to know the dimension of glyph to be able to process
+them. This information is stored in font metric files. LilyPond can read
+two types of font-metrics: @TeX{} Font Metric files (TFM files) and
+Adobe Font Metric files (AFM files).  LilyPond will always try to load
+AFM files first since they are more versatile.
+
+")
 {
   Grob * gr  = unsmob_grob (grob);
   SCM_ASSERT_TYPE(gr, grob, SCM_ARG1, __FUNCTION__, "grob");
@@ -96,7 +107,7 @@ Font_interface::get_font (Grob *me, SCM chain)
   
   if (!gh_string_p (name))
     {
-      SCM ss = me->paper_l ()->style_sheet_;
+      SCM ss = me->get_paper ()->style_sheet_;
 
       SCM proc = ly_cdr (scm_assoc (ly_symbol2scm ("properties-to-font"),
                                    ss));
@@ -110,7 +121,7 @@ Font_interface::get_font (Grob *me, SCM chain)
   SCM mag = me->get_grob_property ("font-magnification");
   Real rmag = gh_number_p (mag) ? gh_scm2double (mag) : 1.0;
   
-  Font_metric *fm = me->paper_l ()->find_font (name, rmag);
+  Font_metric *fm = me->get_paper ()->find_font (name, rmag);
   return fm;
 }
 
@@ -119,7 +130,7 @@ Font_interface::add_style (Grob* me, SCM style, SCM chain)
 {
   assert (gh_symbol_p (style));
   
-  SCM sheet = me->paper_l ()->style_sheet_;
+  SCM sheet = me->get_paper ()->style_sheet_;
       
   SCM style_alist = ly_cdr (scm_assoc (ly_symbol2scm ("style-alist"), sheet));
   SCM entry = scm_assoc (style, style_alist);
@@ -150,7 +161,7 @@ so a 14% speedup.
 
 */
 
-static SCM shape_sym, family_sym, series_sym, rel_sz_sym, design_sz_sym, wild_sym;
+static SCM shape_sym, family_sym, series_sym, rel_str0_sym, design_str0_sym, wild_sym;
 
 
 static void
@@ -159,16 +170,12 @@ init_syms ()
   shape_sym  = scm_permanent_object (ly_symbol2scm ("font-shape"));
   family_sym = scm_permanent_object (ly_symbol2scm ("font-family"));
   series_sym = scm_permanent_object (ly_symbol2scm ("font-series"));
-  rel_sz_sym = scm_permanent_object (ly_symbol2scm ("font-relative-size"));
-  design_sz_sym = scm_permanent_object (ly_symbol2scm ("font-design-size"));
+  rel_str0_sym = scm_permanent_object (ly_symbol2scm ("font-relative-size"));
+  design_str0_sym = scm_permanent_object (ly_symbol2scm ("font-design-size"));
   wild_sym = scm_permanent_object (ly_symbol2scm ("*"));
-
-  scm_c_define_gsubr ("ly-get-default-font", 1 , 0, 0,
-                     (Scheme_function_unknown) ly_font_interface_get_default_font);
-  scm_c_define_gsubr ("ly-get-font", 2, 0, 0,
-                     (Scheme_function_unknown) ly_font_interface_get_font);
 }
 
+ADD_SCM_INIT_FUNC(fi_init_syms, init_syms);
 
 bool
 Font_interface::wild_compare (SCM field_val, SCM val)
@@ -176,8 +183,6 @@ Font_interface::wild_compare (SCM field_val, SCM val)
   return (val == SCM_BOOL_F || field_val == wild_sym || field_val == val);
 }
 
-ADD_SCM_INIT_FUNC (Font_interface_syms,init_syms);
-
 
 MAKE_SCHEME_CALLBACK (Font_interface,properties_to_font_name,2);
 SCM
@@ -188,8 +193,8 @@ Font_interface::properties_to_font_name (SCM fonts, SCM alist_chain)
   SCM series = SCM_BOOL_F;
 
   
-  SCM point_sz = ly_assoc_chain (design_sz_sym, alist_chain);
-  SCM rel_sz = SCM_BOOL_F;
+  SCM point_str0 = ly_assoc_chain (design_str0_sym, alist_chain);
+  SCM rel_str0 = SCM_BOOL_F;
 
   shape = ly_assoc_chain (shape_sym, alist_chain);
   family = ly_assoc_chain (family_sym, alist_chain);
@@ -203,13 +208,13 @@ Font_interface::properties_to_font_name (SCM fonts, SCM alist_chain)
     series = ly_cdr (series);
 
 
-  if (gh_pair_p (point_sz))
-    point_sz = ly_cdr (point_sz);
+  if (gh_pair_p (point_str0))
+    point_str0 = ly_cdr (point_str0);
   else
     {
-      rel_sz = ly_assoc_chain (rel_sz_sym, alist_chain);
-      if (gh_pair_p (rel_sz))
-       rel_sz = ly_cdr (rel_sz);
+      rel_str0 = ly_assoc_chain (rel_str0_sym, alist_chain);
+      if (gh_pair_p (rel_str0))
+       rel_str0 = ly_cdr (rel_str0);
     }
 
   for (SCM s = fonts ; gh_pair_p (s); s = ly_cdr (s))
@@ -223,7 +228,7 @@ Font_interface::properties_to_font_name (SCM fonts, SCM alist_chain)
       if (!wild_compare (scm_list_ref (qlist, gh_int2scm (3)), family))
        continue;
   
-      if (point_sz == SCM_BOOL_F && !wild_compare (ly_car (qlist), rel_sz))
+      if (point_str0 == SCM_BOOL_F && !wild_compare (ly_car (qlist), rel_str0))
        continue;
           
       SCM qname = ly_cdar (s);
@@ -231,9 +236,15 @@ Font_interface::properties_to_font_name (SCM fonts, SCM alist_chain)
     }
 
   warning (_ ("couldn't find any font satisfying "));
-  scm_write (scm_list_n (point_sz, shape, series , family, rel_sz, SCM_UNDEFINED), scm_current_error_port ());
+  scm_write (scm_list_n (point_str0, shape, series , family, rel_str0, SCM_UNDEFINED), scm_current_error_port ());
   scm_flush (scm_current_error_port ());
  
   return ly_str02scm ("cmr10");
   
 }
+
+
+
+ADD_INTERFACE (Font_interface, "font-interface",
+  "Any symbol that is typeset through fixed sets of glyphs (ie. fonts)",
+  "font-magnification font-style font font-series font-shape font-family font-name font-design-size font-relative-size");