lily/paper-def.cc

   1 /*
   2   paper-def.cc -- implement Paper_def
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #include <math.h>
  11
  12 #include "virtual-font-metric.hh"
  13 #include "all-font-metrics.hh"
  14 #include "string.hh"
  15 #include "misc.hh"
  16 #include "paper-def.hh"
  17 #include "warn.hh"
  18 #include "scaled-font-metric.hh"
  19 #include "main.hh"
  20 #include "scm-hash.hh"
  21 #include "input-file-results.hh" // urg? header_global
  22 #include "paper-outputter.hh"
  23 #include "ly-module.hh"
  24
  25 /*
  26   This is an almost empty thing. The only substantial thing this class
  27   handles is scaling up and down to real-world dimensions (internally
  28   dimensions are against global staff-space.)
  29  */
  30
  31 Paper_def::Paper_def ()
  32 {
  33   /* Do not remove this statement, scm_make_hash_table may trigger GC.  */
  34   scaled_fonts_ = SCM_EOL;
  35   scaled_fonts_ = scm_c_make_hash_table (11);
  36 }
  37
  38 Paper_def::Paper_def (Paper_def const&src)
  39   : Music_output_def (src)
  40 {
  41   /* Do not remove this statement, scm_make_hash_table may trigger GC.  */
  42   scaled_fonts_ = SCM_EOL;
  43   scaled_fonts_ = scm_c_make_hash_table (11);
  44 }
  45
  46 Paper_def::~Paper_def ()
  47 {
  48 }
  49
  50 void
  51 Paper_def::derived_mark ()
  52 {
  53   scm_gc_mark (scaled_fonts_);
  54 }
  55
  56 Real
  57 Paper_def::get_dimension (SCM s) const
  58 {
  59   SCM val = lookup_variable (s);
  60   SCM scale = lookup_variable (ly_symbol2scm ("outputscale"));
  61
  62   Real sc = ly_scm2double (scale);
  63   return ly_scm2double (val) / sc;
  64 }
  65
  66 /* FIXME.  This is broken until we have a generic way of
  67    putting lists inside the \paper block.  */
  68 Interval
  69 Paper_def::line_dimensions_int (int n) const
  70 {
  71   Real lw =  get_dimension (ly_symbol2scm ("linewidth"));
  72   Real ind = n? 0.0:get_dimension (ly_symbol2scm ("indent"));
  73
  74   return Interval (ind, lw);
  75 }
  76
  77 Paper_outputter*
  78 Paper_def::get_paper_outputter (String outname) const
  79 {
  80   progress_indication (_f ("paper output to `%s'...",
  81                            outname == "-" ? String ("<stdout>") : outname));
  82   global_input_file->target_strings_.push (outname);
  83   Paper_outputter * po = new Paper_outputter (outname);
  84   Path p = split_path (outname);
  85   p.ext = "";
  86   po->basename_ = p.to_string ();
  87   return po;
  88 }
  89
  90 Font_metric*
  91 Paper_def::find_scaled_font (Font_metric *f, Real m, SCM input_enc_name)
  92 {
  93   SCM sizes = scm_hashq_ref (scaled_fonts_, f->self_scm (), SCM_BOOL_F);
  94   if (sizes != SCM_BOOL_F)
  95     {
  96       SCM met = scm_assoc (scm_make_real (m), sizes);
  97       if (is_pair (met))
  98         return unsmob_metrics (ly_cdr (met));
  99     }
 100   else
 101     sizes = SCM_EOL;
 102
 103   /* Hmm. We're chaining font - metrics.  Should consider whether to
 104      merge virtual-font and scaled_font.  */
 105   SCM val = SCM_EOL;
 106   if (Virtual_font_metric * vf = dynamic_cast<Virtual_font_metric*> (f))
 107     {
 108       /* For fontify_atom (), the magnification and name must be known
 109          at the same time. That's impossible for
 110
 111           Scaled (Virtual_font (Font1,Font2))
 112
 113         so we replace by
 114
 115           Virtual_font (Scaled (Font1), Scaled (Font2))  */
 116       SCM lst = SCM_EOL;
 117       SCM *t = &lst;
 118       for (SCM s = vf->get_font_list (); is_pair (s); s = ly_cdr (s))
 119         {
 120           Font_metric *scaled = find_scaled_font (unsmob_metrics (ly_car (s)),
 121                                                   m, input_enc_name);
 122           *t = scm_cons (scaled->self_scm (), SCM_EOL);
 123           t = SCM_CDRLOC(*t);
 124         }
 125
 126       vf = new Virtual_font_metric (lst);
 127       val = vf->self_scm ();
 128     }
 129   else
 130     {
 131       SCM scale_var = ly_module_lookup (scope_, ly_symbol2scm ("outputscale"));
 132
 133       if (!is_symbol (input_enc_name))
 134         {
 135           SCM var = ly_module_lookup (scope_, ly_symbol2scm ("inputencoding"));
 136           input_enc_name = scm_variable_ref (var);
 137         }
 138       m /= ly_scm2double (scm_variable_ref (scale_var));
 139       val = Modified_font_metric::make_scaled_font_metric (input_enc_name,
 140                                                            f, m);
 141     }
 142
 143   sizes = scm_acons (scm_make_real (m), val, sizes);
 144   scm_gc_unprotect_object (val);
 145   scm_hashq_set_x (scaled_fonts_, f->self_scm (), sizes);
 146   return unsmob_metrics (val);
 147 }
 148
 149
 150 /* Return alist to translate internally used fonts back to real-world
 151    coordinates.  */
 152 SCM
 153 Paper_def::font_descriptions () const
 154 {
 155   SCM func = ly_scheme_function ("hash-table->alist");
 156
 157   SCM l = SCM_EOL;
 158   for (SCM s = scm_call_1 (func, scaled_fonts_); is_pair (s); s = ly_cdr (s))
 159     {
 160       SCM entry = ly_car (s);
 161       for (SCM t = ly_cdr (entry); is_pair (t); t  = ly_cdr (t))
 162         {
 163           Font_metric *fm= unsmob_metrics (ly_cdar (t));
 164
 165           if (dynamic_cast<Modified_font_metric*> (fm))
 166             l = scm_cons (fm->self_scm (), l);
 167         }
 168     }
 169   return l;
 170 }
 171
 172 Paper_def*
 173 unsmob_paper (SCM x)
 174 {
 175   return dynamic_cast<Paper_def*> (unsmob_music_output_def (x));
 176 }
 177
 178
 179 LY_DEFINE (ly_paper_def_p, "ly:paper-def?",
 180            1, 0, 0, (SCM def),
 181            "Is @var{def} a paper definition?")
 182 {
 183   Paper_def *op = dynamic_cast<Paper_def*> (unsmob_music_output_def (def));
 184
 185   bool pap = op;
 186   return ly_bool2scm (pap);
 187 }