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