]> git.donarmstrong.com Git - lilypond.git/blob - lily/paper-def.cc
* input/regression/spacing-knee.ly: docstring
[lilypond.git] / 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--2003 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-modules.hh"
24
25
26 /*
27   This is an almost empty thing. The only substantial thing this class
28   handles, is scaling up and down to real-world dimensions (internally
29   dimensions are against global staff-space.)
30   
31  */
32 Paper_def::Paper_def ()
33 {
34 }
35
36 Paper_def::~Paper_def ()
37 {
38 }
39
40 Paper_def::Paper_def (Paper_def const&src)
41   : Music_output_def (src)
42 {
43 }
44
45
46 Real
47 Paper_def::get_var (String s) const
48 {
49   return get_realvar (ly_symbol2scm (s.to_str0 ()));
50 }
51
52 Real
53 Paper_def::get_realvar (SCM s) const
54 {
55   SCM val = lookup_variable (s);
56   SCM scale = lookup_variable (ly_symbol2scm ("outputscale"));
57   
58   Real sc = gh_scm2double (scale);
59   return gh_scm2double (val) / sc;
60 }
61
62 /*
63   FIXME. This is broken until we have a generic way of
64   putting lists inside the \paper block.
65  */
66 Interval
67 Paper_def::line_dimensions_int (int n) const
68 {
69   Real lw =  get_var ("linewidth");
70   Real ind = n? 0.0:get_var ("indent");
71
72   return Interval (ind, lw);
73 }
74
75
76
77 int Paper_def::score_count_ = 0;
78
79 int
80 Paper_def::get_next_score_count () const
81 {
82   return score_count_ ++;
83 }
84
85 void
86 Paper_def::reset_score_count ()
87 {
88   score_count_ = 0;
89 }
90
91
92 Paper_outputter*
93 Paper_def::get_paper_outputter () 
94 {
95   String outname = outname_string (); 
96   progress_indication (_f ("paper output to `%s'...",
97                            outname == "-" ? String ("<stdout>") : outname));
98
99   global_input_file->target_strings_.push (outname);
100   Paper_outputter * po = new Paper_outputter (outname);
101   Path p = split_path (outname);
102   p.ext = "";
103   po->basename_ = p.to_string ();
104   return po;
105 }
106
107
108 /*
109   todo: use symbols and hashtable idx?
110
111
112 */
113 Font_metric *
114 Paper_def::find_font (SCM fn, Real m)
115 {
116   SCM key = gh_cons (fn, gh_double2scm (m));
117   SCM met = scm_assoc (key, scaled_fonts_);
118
119   if (gh_pair_p (met))
120     return unsmob_metrics (ly_cdr (met));
121
122   /*
123     Hmm. We're chaining font - metrics. Should consider wether to merge
124     virtual-font and scaled_font.
125    */
126   Font_metric*  f=0;
127   if (gh_list_p (fn))
128     {
129       f = new Virtual_font_metric (fn, m, this);
130     }
131   else
132     {
133       SCM scale_var = ly_module_lookup (scope_, ly_symbol2scm ("outputscale"));
134
135       m /= gh_scm2double (scm_variable_ref (scale_var));
136
137       f = all_fonts_global->find_font (ly_scm2string (fn));
138       SCM val = Scaled_font_metric::make_scaled_font_metric (f, m);
139       scaled_fonts_ = scm_acons (key, val, scaled_fonts_);
140       f = unsmob_metrics (val);
141       scm_gc_unprotect_object (val);
142     }
143
144   return f;
145 }
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 l = SCM_EOL;
155   for (SCM s = scaled_fonts_; gh_pair_p (s); s = ly_cdr (s))
156     {
157       SCM desc = ly_caar (s);
158       SCM mdesc = unsmob_metrics (ly_cdar (s))->description_;
159
160       l = gh_cons (gh_cons (mdesc, desc), l);
161     }
162   return l;
163 }