lily/output-def-scheme.cc

   1 /*
   2   output-def-scheme.cc -- implement Output_def bindings
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "font-metric.hh"
  10 #include "pango-font.hh"
  11 #include "modified-font-metric.hh"
  12 #include "output-def.hh"
  13 #include "ly-module.hh"
  14 #include "context-def.hh"
  15 #include "lily-parser.hh"
  16
  17 LY_DEFINE (ly_layout_lookup, "ly:output-def-lookup",
  18            2, 1, 0, (SCM pap, SCM sym, SCM def),
  19            "Lookup @var{sym} in @var{pap}. "
  20            "Return the value or @var{def} (which defaults to  @code{'()}) if undefined.")
  21 {
  22   Output_def *op = unsmob_output_def (pap);
  23   SCM_ASSERT_TYPE (op, pap, SCM_ARG1, __FUNCTION__, "Output_def");
  24   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  25
  26   SCM answer = op->lookup_variable (sym);
  27   if (answer == SCM_UNDEFINED)
  28     {
  29       if (def == SCM_UNDEFINED)
  30         def = SCM_EOL;
  31
  32       answer = def;
  33     }
  34
  35   return answer;
  36 }
  37
  38 LY_DEFINE (ly_output_def_scope, "ly:output-def-scope",
  39            1, 0, 0, (SCM def),
  40            "Get the variable scope inside @var{def}.")
  41 {
  42   Output_def *op = unsmob_output_def (def);
  43   SCM_ASSERT_TYPE (op, def, SCM_ARG1, __FUNCTION__, "Output definition");
  44   return op->scope_;
  45 }
  46
  47 LY_DEFINE (ly_output_def_parent, "ly:output-def-parent",
  48            1, 0, 0, (SCM def),
  49            "Get the parent output-def of @var{def}.")
  50 {
  51   Output_def *op = unsmob_output_def (def);
  52   SCM_ASSERT_TYPE (op, def, SCM_ARG1, __FUNCTION__, "Output definition");
  53   return op->parent_ ? op->parent_->self_scm () : SCM_EOL;
  54 }
  55
  56 LY_DEFINE (ly_output_def_clone, "ly:output-def-clone",
  57            1, 0, 0, (SCM def),
  58            "Clone @var{def}.")
  59 {
  60   Output_def *op = unsmob_output_def (def);
  61   SCM_ASSERT_TYPE (op, def, SCM_ARG1, __FUNCTION__, "Output definition");
  62
  63   Output_def *clone = op->clone ();
  64   return clone->unprotect ();
  65 }
  66
  67 LY_DEFINE (ly_output_description, "ly:output-description",
  68            1, 0, 0, (SCM output_def),
  69            "Return the description of translators in @var{output-def}.")
  70 {
  71   Output_def *id = unsmob_output_def (output_def);
  72
  73   SCM al = ly_module2alist (id->scope_);
  74   SCM ell = SCM_EOL;
  75   for (SCM s = al; scm_is_pair (s); s = scm_cdr (s))
  76     {
  77       Context_def *td = unsmob_context_def (scm_cdar (s));
  78       SCM key = scm_caar (s);
  79       if (td && key == td->get_context_name ())
  80         ell = scm_cons (scm_cons (key, td->to_alist ()), ell);
  81     }
  82   return ell;
  83 }
  84
  85 LY_DEFINE (ly_layout_def_p, "ly:layout-def?",
  86            1, 0, 0, (SCM def),
  87            "Is @var{def} a layout definition?")
  88 {
  89   return ly_bool2scm (unsmob_output_def (def));
  90 }
  91
  92 LY_DEFINE (ly_paper_outputscale, "ly:paper-outputscale",
  93            1, 0, 0, (SCM bp),
  94            "Get output-scale for BP.")
  95 {
  96   Output_def *b = unsmob_output_def (bp);
  97   SCM_ASSERT_TYPE (b, bp, SCM_ARG1, __FUNCTION__, "paper");
  98   return scm_from_double (output_scale (b));
  99 }
 100
 101 /*
 102   Cannot put in scope, but need a separate function, since we don't
 103   want to allow this in --safe.
 104  */
 105 LY_DEFINE (ly_output_def_parser, "ly:output-def-parser",
 106            1, 0, 0, (SCM odef),
 107            "Return the parser where @var{odef} is coming from.")
 108 {
 109   Output_def *b = unsmob_output_def (odef);
 110   SCM_ASSERT_TYPE (b, odef, SCM_ARG1, __FUNCTION__, "paper");
 111
 112   return b->get_parser()->self_scm ();
 113 }
 114
 115
 116 LY_DEFINE (ly_make_output_def, "ly:make-output-def",
 117            0, 0, 0, (),
 118            "Make a output def.")
 119 {
 120   Output_def *bp = new Output_def;
 121   return bp->unprotect ();
 122 }
 123
 124 LY_DEFINE (ly_paper_get_font, "ly:paper-get-font", 2, 0, 0,
 125            (SCM paper_smob, SCM chain),
 126
 127            "Return a font metric satisfying the font-qualifiers "
 128            "in the alist chain @var{chain}.\n"
 129            "(An alist chain is a list of alists, "
 130            "containing grob properties).\n")
 131 {
 132   Output_def *paper = unsmob_output_def (paper_smob);
 133   SCM_ASSERT_TYPE (paper, paper_smob, SCM_ARG1,
 134                    __FUNCTION__, "paper definition");
 135
 136   Font_metric *fm = select_font (paper, chain);
 137   return fm->self_scm ();
 138 }
 139
 140 LY_DEFINE (ly_paper_get_number, "ly:paper-get-number", 2, 0, 0,
 141            (SCM layout_smob, SCM name),
 142            "Return the layout variable @var{name}.")
 143 {
 144   Output_def *layout = unsmob_output_def (layout_smob);
 145   SCM_ASSERT_TYPE (layout, layout_smob, SCM_ARG1,
 146                    __FUNCTION__, "layout definition");
 147   return scm_from_double (layout->get_dimension (name));
 148 }
 149
 150 LY_DEFINE (ly_paper_fonts, "ly:paper-fonts",
 151            1, 0, 0,
 152            (SCM bp),
 153            "Return fonts from the @code{\\paper} block @var{bp}.")
 154 {
 155   Output_def *b = unsmob_output_def (bp);
 156
 157   SCM_ASSERT_TYPE (b, bp, SCM_ARG1, __FUNCTION__, "paper");
 158
 159   SCM tab1 = b->lookup_variable (ly_symbol2scm ("scaled-fonts"));
 160   SCM tab2 = b->lookup_variable (ly_symbol2scm ("pango-fonts"));
 161
 162   SCM alist1 = SCM_EOL;
 163   if (scm_hash_table_p (tab1) == SCM_BOOL_T)
 164     {
 165       alist1 = scm_append (ly_alist_vals (ly_hash2alist (tab1)));
 166
 167       alist1 = ly_alist_vals (alist1);
 168     }
 169
 170   SCM alist2 = SCM_EOL;
 171   if (scm_hash_table_p (tab2) == SCM_BOOL_T)
 172     {
 173       // strip original-fonts/pango-font-descriptions
 174       alist2 = scm_append (ly_alist_vals (ly_hash2alist (tab2)));
 175
 176       // strip size factors
 177       alist2 = ly_alist_vals (alist2);
 178     }
 179
 180   SCM alist = scm_append (scm_list_2 (alist1, alist2));
 181   SCM font_list = SCM_EOL;
 182   for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 183     {
 184       SCM entry = scm_car (s);
 185
 186       Font_metric *fm = unsmob_metrics (entry);
 187
 188       if (dynamic_cast<Modified_font_metric *> (fm)
 189           || dynamic_cast<Pango_font *> (fm))
 190         font_list = scm_cons (fm->self_scm (), font_list);
 191     }
 192
 193   return font_list;
 194 }