]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/output-def-scheme.cc
Web-ja: update introduction
[lilypond.git] / lily / output-def-scheme.cc
index 56e77256755ce6e265536b4c164d87cfe3122803..65673c8a9ec71a6238104e70621f1313b224f810 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  output-def-scheme.cc -- implement Output_def bindings
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "output-def.hh"
 #include "lily-parser.hh"
 
 LY_DEFINE (ly_output_def_lookup, "ly:output-def-lookup",
-          2, 1, 0, (SCM pap, SCM sym, SCM def),
-          "Look up @var{sym} in the @var{pap} output definition"
-          " (e.g., @code{\\paper}).  Return the value or @var{def}"
-          " (which defaults to @code{'()}) if undefined.")
+          2, 1, 0, (SCM def, SCM sym, SCM val),
+          "Return the value of @var{sym} in output definition @var{def}"
+          " (e.g., @code{\\paper}).  If no value is found, return"
+          " @var{val} or @code{'()} if @var{val} is undefined.")
 {
-  LY_ASSERT_SMOB (Output_def, pap, 1);
-  Output_def *op = unsmob_output_def (pap);
+  LY_ASSERT_SMOB (Output_def, def, 1);
+  Output_def *op = unsmob<Output_def> (def);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
   SCM answer = op->lookup_variable (sym);
-  if (answer == SCM_UNDEFINED)
+  if (SCM_UNBNDP (answer))
     {
-      if (def == SCM_UNDEFINED)
-       def = SCM_EOL;
+      if (SCM_UNBNDP (val))
+       val = SCM_EOL;
 
-      answer = def;
+      answer = val;
     }
 
   return answer;
@@ -38,19 +49,19 @@ LY_DEFINE (ly_output_def_lookup, "ly:output-def-lookup",
 
 LY_DEFINE (ly_output_def_scope, "ly:output-def-scope",
           1, 0, 0, (SCM def),
-          "Get the variable scope inside @var{def}.")
+          "Return the variable scope inside @var{def}.")
 {
   LY_ASSERT_SMOB (Output_def, def, 1);
-  Output_def *op = unsmob_output_def (def);
+  Output_def *op = unsmob<Output_def> (def);
   return op->scope_;
 }
 
 LY_DEFINE (ly_output_def_parent, "ly:output-def-parent",
           1, 0, 0, (SCM def),
-          "Get the parent output definition of @var{def}.")
+          "Return the parent output definition of @var{def}.")
 {
   LY_ASSERT_SMOB (Output_def, def, 1);
-  Output_def *op = unsmob_output_def (def);
+  Output_def *op = unsmob<Output_def> (def);
   return op->parent_ ? op->parent_->self_scm () : SCM_EOL;
 }
 
@@ -59,7 +70,7 @@ LY_DEFINE (ly_output_def_set_variable_x, "ly:output-def-set-variable!",
            "Set an output definition @var{def} variable @var{sym} to @var{val}.")
 {
   LY_ASSERT_SMOB (Output_def, def, 1);
-  Output_def *output_def = unsmob_output_def (def);
+  Output_def *output_def = unsmob<Output_def> (def);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
   output_def->set_variable (sym, val);
   return SCM_UNSPECIFIED;
@@ -70,7 +81,7 @@ LY_DEFINE (ly_output_def_clone, "ly:output-def-clone",
           "Clone output definition @var{def}.")
 {
   LY_ASSERT_SMOB (Output_def, def, 1);
-  Output_def *op = unsmob_output_def (def);
+  Output_def *op = unsmob<Output_def> (def);
 
   Output_def *clone = op->clone ();
   return clone->unprotect ();
@@ -80,33 +91,55 @@ LY_DEFINE (ly_output_description, "ly:output-description",
           1, 0, 0, (SCM output_def),
           "Return the description of translators in @var{output-def}.")
 {
-  Output_def *id = unsmob_output_def (output_def);
+  LY_ASSERT_SMOB (Output_def, output_def, 1);
+
+  Output_def *id = unsmob<Output_def> (output_def);
 
   SCM al = ly_module_2_alist (id->scope_);
   SCM ell = SCM_EOL;
   for (SCM s = al; scm_is_pair (s); s = scm_cdr (s))
     {
-      Context_def *td = unsmob_context_def (scm_cdar (s));
+      Context_def *td = unsmob<Context_def> (scm_cdar (s));
       SCM key = scm_caar (s);
-      if (td && key == td->get_context_name ())
-       ell = scm_cons (scm_cons (key, td->to_alist ()), ell);
+      if (td && scm_is_eq (key, td->get_context_name ()))
+        ell = scm_cons (scm_cons (key, td->to_alist ()), ell);
     }
   return ell;
 }
 
-LY_DEFINE (ly_output_def_p, "ly:output-def?",
-          1, 0, 0, (SCM def),
-          "Is @var{def} a layout definition?")
+LY_DEFINE (ly_output_find_context_def, "ly:output-find-context-def",
+          1, 1, 0, (SCM output_def, SCM context_name),
+          "Return an alist of all context defs (matching @var{context-name}"
+          "if given) in @var{output-def}.")
 {
-  return ly_bool2scm (unsmob_output_def (def));
+  LY_ASSERT_SMOB (Output_def, output_def, 1);
+  if (!SCM_UNBNDP (context_name))
+    LY_ASSERT_TYPE (ly_is_symbol, context_name, 2);
+
+  Output_def *id = unsmob<Output_def> (output_def);
+
+  SCM al = ly_module_2_alist (id->scope_);
+  SCM ell = SCM_EOL;
+  for (SCM s = al; scm_is_pair (s); s = scm_cdr (s))
+    {
+      SCM p = scm_car (s);
+      Context_def *td = unsmob<Context_def> (scm_cdr (p));
+      if (td && scm_is_eq (scm_car (p), td->get_context_name ())
+         && (SCM_UNBNDP (context_name) || td->is_alias (context_name)))
+       ell = scm_cons (p, ell);
+    }
+  return ell;
 }
 
+const char
+* const Output_def::type_p_name_ = "ly:output-def?";
+
 LY_DEFINE (ly_paper_outputscale, "ly:paper-outputscale",
-          1, 0, 0, (SCM bp),
-          "Get output-scale for @var{bp}.")
+          1, 0, 0, (SCM def),
+          "Return the output-scale for output definition @var{def}.")
 {
-  LY_ASSERT_SMOB (Output_def, bp, 1);
-  Output_def *b = unsmob_output_def (bp);
+  LY_ASSERT_SMOB (Output_def, def, 1);
+  Output_def *b = unsmob<Output_def> (def);
   return scm_from_double (output_scale (b));
 }
 
@@ -118,41 +151,43 @@ LY_DEFINE (ly_make_output_def, "ly:make-output-def",
   return bp->unprotect ();
 }
 
-LY_DEFINE (ly_paper_get_font, "ly:paper-get-font", 2, 0, 0,
-          (SCM paper_smob, SCM chain),
-          "Return a font metric satisfying the font-qualifiers"
-          " in the alist chain @var{chain}.  (An alist chain is a"
-          " list of alists, containing grob properties.)")
+LY_DEFINE (ly_paper_get_font, "ly:paper-get-font",
+          2, 0, 0, (SCM def, SCM chain),
+          "Find a font metric in output definition @var{def} satisfying"
+          " the font-qualifiers in alist chain @var{chain}, and return"
+          " it.  (An alist chain is a list of alists, containing grob"
+          " properties.)")
 {
-  LY_ASSERT_SMOB (Output_def, paper_smob, 1);
+  LY_ASSERT_SMOB (Output_def, def, 1);
 
-  Output_def *paper = unsmob_output_def (paper_smob);
+  Output_def *paper = unsmob<Output_def> (def);
   Font_metric *fm = select_font (paper, chain);
   return fm->self_scm ();
 }
 
-LY_DEFINE (ly_paper_get_number, "ly:paper-get-number", 2, 0, 0,
-          (SCM layout_smob, SCM name),
-          "Return the layout variable @var{name}.")
+LY_DEFINE (ly_paper_get_number, "ly:paper-get-number",
+          2, 0, 0, (SCM def, SCM sym),
+          "Return the value of variable @var{sym} in output definition"
+          " @var{def} as a double.")
 {
-  LY_ASSERT_SMOB (Output_def, layout_smob, 1);
-  Output_def *layout = unsmob_output_def (layout_smob);
-  return scm_from_double (layout->get_dimension (name));
+  LY_ASSERT_SMOB (Output_def, def, 1);
+  Output_def *layout = unsmob<Output_def> (def);
+  return scm_from_double (layout->get_dimension (sym));
 }
 
 LY_DEFINE (ly_paper_fonts, "ly:paper-fonts",
-          1, 0, 0,
-          (SCM bp),
-          "Return fonts from the @code{\\paper} block @var{bp}.")
+          1, 0, 0, (SCM def),
+          "Return a list containing the fonts from output definition"
+          " @var{def} (e.g., @code{\\paper}).")
 {
-  LY_ASSERT_SMOB (Output_def, bp, 1);
-  Output_def *b = unsmob_output_def (bp);
+  LY_ASSERT_SMOB (Output_def, def, 1);
+  Output_def *b = unsmob<Output_def> (def);
 
   SCM tab1 = b->lookup_variable (ly_symbol2scm ("scaled-fonts"));
   SCM tab2 = b->lookup_variable (ly_symbol2scm ("pango-fonts"));
 
   SCM alist1 = SCM_EOL;
-  if (scm_hash_table_p (tab1) == SCM_BOOL_T)
+  if (to_boolean (scm_hash_table_p (tab1)))
     {
       alist1 = scm_append (ly_alist_vals (ly_hash2alist (tab1)));
 
@@ -160,7 +195,7 @@ LY_DEFINE (ly_paper_fonts, "ly:paper-fonts",
     }
 
   SCM alist2 = SCM_EOL;
-  if (scm_hash_table_p (tab2) == SCM_BOOL_T)
+  if (scm_is_true (scm_hash_table_p (tab2)))
     {
       // strip original-fonts/pango-font-descriptions
       alist2 = scm_append (ly_alist_vals (ly_hash2alist (tab2)));
@@ -175,7 +210,7 @@ LY_DEFINE (ly_paper_fonts, "ly:paper-fonts",
     {
       SCM entry = scm_car (s);
 
-      Font_metric *fm = unsmob_metrics (entry);
+      Font_metric *fm = unsmob<Font_metric> (entry);
 
       if (dynamic_cast<Modified_font_metric *> (fm)
          || dynamic_cast<Pango_font *> (fm))