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 }
  34
  35 Paper_def::~Paper_def ()
  36 {
  37 }
  38
  39 Paper_def::Paper_def (Paper_def const&src)
  40   : Music_output_def (src)
  41 {
  42 }
  43
  44 Real
  45 Paper_def::get_realvar (SCM s) const
  46 {
  47   SCM val = lookup_variable (s);
  48   SCM scale = lookup_variable (ly_symbol2scm ("outputscale"));
  49
  50   Real sc = gh_scm2double (scale);
  51   return gh_scm2double (val) / sc;
  52 }
  53
  54 /*
  55   FIXME. This is broken until we have a generic way of
  56   putting lists inside the \paper block.
  57  */
  58 Interval
  59 Paper_def::line_dimensions_int (int n) const
  60 {
  61   Real lw =  get_realvar (ly_symbol2scm ("linewidth"));
  62   Real ind = n? 0.0:get_realvar (ly_symbol2scm ("indent"));
  63
  64   return Interval (ind, lw);
  65 }
  66
  67
  68
  69
  70 Paper_outputter*
  71 Paper_def::get_paper_outputter (String outname)  const
  72 {
  73   progress_indication (_f ("paper output to `%s'...",
  74                            outname == "-" ? String ("<stdout>") : outname));
  75   progress_indication("\n");
  76
  77   global_input_file->target_strings_.push (outname);
  78   Paper_outputter * po = new Paper_outputter (outname);
  79   Path p = split_path (outname);
  80   p.ext = "";
  81   po->basename_ = p.to_string ();
  82   return po;
  83 }
  84
  85
  86 /*
  87   Todo: use symbols and hashtable idx?
  88 */
  89 Font_metric *
  90 Paper_def::find_font (SCM fn, Real m)
  91 {
  92   SCM key = gh_cons (fn, gh_double2scm (m));
  93   SCM met = scm_assoc (key, scaled_fonts_);
  94
  95   if (gh_pair_p (met))
  96     return unsmob_metrics (ly_cdr (met));
  97
  98   /*
  99     Hmm. We're chaining font - metrics. Should consider wether to merge
 100     virtual-font and scaled_font.
 101    */
 102   Font_metric*  f=0;
 103   if (gh_list_p (fn))
 104     {
 105       f = new Virtual_font_metric (fn, m, this); // TODO: GC protection.
 106
 107       scaled_fonts_ = scm_acons (key, f->self_scm (), scaled_fonts_);
 108       scm_gc_unprotect_object (f->self_scm ());
 109     }
 110   else
 111     {
 112       SCM scale_var = ly_module_lookup (scope_, ly_symbol2scm ("outputscale"));
 113
 114       m /= gh_scm2double (scm_variable_ref (scale_var));
 115
 116       f = all_fonts_global->find_font (ly_scm2string (fn));
 117       SCM val = Scaled_font_metric::make_scaled_font_metric (f, m);
 118       scaled_fonts_ = scm_acons (key, val, scaled_fonts_);
 119       scm_gc_unprotect_object (val);
 120
 121       f = unsmob_metrics (val);
 122     }
 123
 124   return f;
 125 }
 126
 127
 128 /*
 129   Return alist to translate internally used fonts back to real-world
 130   coordinates.  */
 131 SCM
 132 Paper_def::font_descriptions ()const
 133 {
 134   SCM l = SCM_EOL;
 135   for (SCM s = scaled_fonts_; gh_pair_p (s); s = ly_cdr (s))
 136     {
 137       SCM desc = ly_caar (s);
 138       if (!gh_string_p (gh_car (desc)))
 139         continue ;
 140
 141       SCM mdesc = unsmob_metrics (ly_cdar (s))->description_;
 142
 143       l = gh_cons (gh_cons (mdesc, desc), l);
 144     }
 145   return l;
 146 }
 147
 148 Paper_def*
 149 unsmob_paper (SCM x)
 150 {
 151   return dynamic_cast<Paper_def*> (unsmob_music_output_def (x));
 152 }
 153
 154
 155 LY_DEFINE (ly_paper_def_p, "ly:paper-def?",
 156            1, 0,0, (SCM def),
 157            "Is @var{def} a paper definition?")
 158 {
 159   Paper_def *op = dynamic_cast<Paper_def*> (unsmob_music_output_def (def));
 160
 161   bool pap = op;
 162   return gh_bool2scm (pap);
 163 }