]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/font-interface.cc
2002-07-13 Han-Wen <hanwen@cs.uu.nl>
[lilypond.git] / lily / font-interface.cc
index fa285aef06194b899f0374d77ebd702cdd8f1a4e..28a88c546935d6395a844cb23c01bf0d17a5ec55 100644 (file)
@@ -3,7 +3,7 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2000--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
 #include "warn.hh"
 
 
+/*
+  TODO revise font handling.
+
+
+* relative sizes should relate to staff-space, eg.  font-staff-space
+= 1.2 ^ relative-size
+
+* If a relative size is given, lily should magnify the closest
+design size font to match that. (ie. fonts should have variable
+scaling)
+
+(this requires that fonts are stored as (filename , designsize))
+
+
+  
+ */
+
 SCM
 Font_interface::font_alist_chain (Grob *me)
 {
-  SCM defaults = gh_cdr (scm_assoc (ly_symbol2scm ("font-defaults"),
-                                   me->paper_l ()->style_sheet_ ));
-
-  SCM ch = gh_list (me->mutable_property_alist_,
-                   me->immutable_property_alist_,
-                   defaults,
-                   SCM_UNDEFINED);
+  /*
+    Ugh: why the defaults?
+   */
+  SCM defaults = ly_cdr (scm_assoc (ly_symbol2scm ("font-defaults"),
+                                   me->paper_l ()->style_sheet_));
 
+  SCM ch = me->get_property_alist_chain (defaults);
+  
   return ch;
 }
 
@@ -45,35 +62,66 @@ 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);
-
-  if (!gr)
-    {
-      warning ("ly_font_interface_get_default_font (): invalid argument");
-      return SCM_UNDEFINED;
-    }
+  SCM_ASSERT_TYPE(gr, grob, SCM_ARG1, __FUNCTION__, "grob");
 
   return Font_interface::get_default_font (gr)->self_scm ();
 }
 
+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");
+
+  Font_metric*fm=
+    Font_interface::get_font (gr, gh_cons (alist,
+                                          Font_interface::font_alist_chain (gr)));
+
+  return fm->self_scm();
+}
+
+
+
 Font_metric *
 Font_interface::get_font (Grob *me, SCM chain)
 {
+  SCM name = me->get_grob_property ("font-name");
   
-  SCM ss = me->paper_l ()->style_sheet_;
-
-  SCM proc = gh_cdr (scm_assoc (ly_symbol2scm ("properties-to-font"),
-                               ss));
+  if (!gh_string_p (name))
+    {
+      SCM ss = me->paper_l ()->style_sheet_;
 
-  SCM fonts = gh_cdr (scm_assoc (ly_symbol2scm ("fonts"), ss));
+      SCM proc = ly_cdr (scm_assoc (ly_symbol2scm ("properties-to-font"),
+                                   ss));
 
-  assert (gh_procedure_p (proc));
-  SCM font_name = gh_call2 (proc, fonts, chain);
+      SCM fonts = ly_cdr (scm_assoc (ly_symbol2scm ("fonts"), ss));
 
-  Font_metric *fm = me->paper_l ()->find_font (font_name, 1.0);
+      assert (gh_procedure_p (proc));
+      name = gh_call2 (proc, fonts, 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);
   return fm;
 }
 
@@ -84,11 +132,11 @@ Font_interface::add_style (Grob* me, SCM style, SCM chain)
   
   SCM sheet = me->paper_l ()->style_sheet_;
       
-  SCM style_alist = gh_cdr (scm_assoc (ly_symbol2scm ("style-alist"), sheet));
+  SCM style_alist = ly_cdr (scm_assoc (ly_symbol2scm ("style-alist"), sheet));
   SCM entry = scm_assoc (style, style_alist);
   if (gh_pair_p (entry))
     {
-      chain = gh_cons (gh_cdr (entry), chain);
+      chain = gh_cons (ly_cdr (entry), chain);
     }
   return chain;
 }
@@ -113,114 +161,90 @@ so a 14% speedup.
 
 */
 
-static SCM name_sym, shape_sym, family_sym, series_sym, rel_sz_sym, pt_sz_sym, wild_sym;
+static SCM shape_sym, family_sym, series_sym, rel_sz_sym, design_sz_sym, wild_sym;
 
 
 static void
 init_syms ()
 {
-  name_sym = scm_permanent_object (ly_symbol2scm ("font-name"));
   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"));
-  pt_sz_sym = scm_permanent_object (ly_symbol2scm ("font-point-size"));
+  design_sz_sym = scm_permanent_object (ly_symbol2scm ("font-design-size"));
   wild_sym = scm_permanent_object (ly_symbol2scm ("*"));
-
-  scm_make_gsubr ("ly-get-default-font", 1 , 0, 0, (Scheme_function_unknown) ly_font_interface_get_default_font);
 }
 
+ADD_SCM_INIT_FUNC(fi_init_syms, init_syms);
 
 bool
-Font_interface::wild_compare(SCM field_val, SCM val)
+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);
+MAKE_SCHEME_CALLBACK (Font_interface,properties_to_font_name,2);
 SCM
 Font_interface::properties_to_font_name (SCM fonts, SCM alist_chain)
 {
-  SCM name = ly_assoc_chain (name_sym, alist_chain);
-
   SCM shape = SCM_BOOL_F;
   SCM family = SCM_BOOL_F;
   SCM series = SCM_BOOL_F;
 
   
-  SCM point_sz = ly_assoc_chain (pt_sz_sym, alist_chain);
+  SCM point_sz = ly_assoc_chain (design_sz_sym, alist_chain);
   SCM rel_sz = SCM_BOOL_F;
 
-  if (!gh_pair_p (name))
-    {
-       shape = ly_assoc_chain (shape_sym, alist_chain);
-       family = ly_assoc_chain (family_sym, alist_chain);
-       series = ly_assoc_chain (series_sym, alist_chain);
-
-       if (gh_pair_p (shape))
-        shape = gh_cdr (shape);
-       if (gh_pair_p (family))
-        family = gh_cdr (family);
-       if (gh_pair_p (series))
-        series = gh_cdr (series);
-    }
-  else
-    name = gh_cdr (name);
+  shape = ly_assoc_chain (shape_sym, alist_chain);
+  family = ly_assoc_chain (family_sym, alist_chain);
+  series = ly_assoc_chain (series_sym, alist_chain);
+
+  if (gh_pair_p (shape))
+    shape = ly_cdr (shape);
+  if (gh_pair_p (family))
+    family = ly_cdr (family);
+  if (gh_pair_p (series))
+    series = ly_cdr (series);
 
 
   if (gh_pair_p (point_sz))
-    point_sz = gh_cdr (point_sz);
+    point_sz = ly_cdr (point_sz);
   else
     {
       rel_sz = ly_assoc_chain (rel_sz_sym, alist_chain);
       if (gh_pair_p (rel_sz))
-       rel_sz = gh_cdr (rel_sz);
+       rel_sz = ly_cdr (rel_sz);
     }
 
-  for (SCM s = fonts ; gh_pair_p (s); s = gh_cdr (s))
+  for (SCM s = fonts ; gh_pair_p (s); s = ly_cdr (s))
     {
-      SCM qlist = gh_caar (s);
-
-      if (name != SCM_BOOL_F)
-       {
-         if (!wild_compare(scm_list_ref (qlist, gh_int2scm (4)), name))
-           continue;
-       }
-      else
-       {
-         if (!wild_compare(scm_list_ref (qlist, gh_int2scm (1)), series))
-           continue;
-         if (!wild_compare(scm_list_ref (qlist, gh_int2scm (2)), shape))
-           continue;
-         if (!wild_compare(scm_list_ref (qlist, gh_int2scm (3)), family))
-           continue;
-       }
+      SCM qlist = ly_caar (s);
+
+      if (!wild_compare (scm_list_ref (qlist, gh_int2scm (1)), series))
+       continue;
+      if (!wild_compare (scm_list_ref (qlist, gh_int2scm (2)), shape))
+       continue;
+      if (!wild_compare (scm_list_ref (qlist, gh_int2scm (3)), family))
+       continue;
   
-      if (point_sz != SCM_BOOL_F)
-       {
-         // This if statement will always be true since name must 
-         // be SCM_BOOL_F here, right?  /MB
-         if (!wild_compare(scm_list_ref (qlist, gh_int2scm (4)), name))
-           continue;
-       }
-      else
-       {
-         if (!wild_compare(gh_car (qlist), rel_sz))
-           continue;
-       }
-
-      
-      SCM qname = gh_cdar (s);
+      if (point_sz == SCM_BOOL_F && !wild_compare (ly_car (qlist), rel_sz))
+       continue;
+          
+      SCM qname = ly_cdar (s);
       return qname;
     }
 
-  warning (_("couldn't find any font satisfying ") );
-  scm_write (gh_list (name, point_sz, shape, series , family, rel_sz, SCM_UNDEFINED), scm_current_error_port ());
-  scm_flush(scm_current_error_port ());
+  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_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");