lily/include/output-def.hh

   1 /*
   2   music-output-def.hh -- declare Output_def
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #ifndef MUSIC_OUTPUT_DEF_HH
  10 #define MUSIC_OUTPUT_DEF_HH
  11
  12 #include "std-string.hh"
  13 #include "lily-proto.hh"
  14 #include "virtual-methods.hh"
  15 #include "smobs.hh"
  16 #include "input.hh"
  17
  18 /*
  19   Output settings for a block of music.
  20
  21   This devolved into a rather empty class. The distinction between
  22   various instances is made in the parser, which creates
  23   midi/layout/paper blocks depending on the keyword read.
  24
  25   The data structure is set up as recursive: the definitions not
  26   supplied in layout are looked up in paper. This is done through
  27   the parent_ field of Output_def. However, such nesting is limited to
  28   two levels,
  29
  30   * first because the parser hard-codes the different types
  31   of output block.
  32
  33   * Second, because the prime benefit of multiple levels
  34   (eg. paper containing layout for a score, containing layout of a
  35   \score embedded in \markup) requires scaling the Stencils (eg. the
  36   one coming from score at markup level)
  37
  38  */
  39 class Output_def
  40 {
  41
  42 public:
  43   VIRTUAL_COPY_CONSTRUCTOR (Output_def, Output_def);
  44   DECLARE_SMOBS (Output_def, );
  45
  46 public:
  47   SCM scope_;
  48   Output_def *parent_;
  49
  50   Input input_origin_;
  51   string user_key_;
  52
  53   Lily_parser *parser_;
  54   Lily_parser *get_parser () const;
  55
  56   Output_def (Output_def const&);
  57   Output_def ();
  58
  59   /*
  60     variables.
  61    */
  62   SCM c_variable (string id) const;
  63   SCM lookup_variable (SCM sym) const;
  64   void set_variable (SCM sym, SCM val);
  65   Real get_dimension (SCM symbol) const;
  66 };
  67 SCM get_font_table (Output_def *def);
  68 void assign_context_def (Output_def *m, SCM transdef);
  69 SCM find_context_def (Output_def const *m, SCM name);
  70
  71 Interval line_dimensions_int (Output_def*def, int);
  72
  73
  74 Font_metric *select_encoded_font (Output_def *layout, SCM chain);
  75 Font_metric *select_font (Output_def *layout, SCM chain);
  76
  77 DECLARE_UNSMOB (Output_def, output_def);
  78
  79
  80 Font_metric* find_pango_font (Output_def *layout,  SCM descr, Real factor);
  81 Font_metric *find_scaled_font (Output_def *od, Font_metric *f, Real magnification);
  82 Output_def *scale_output_def (Output_def *def, Real scale);
  83
  84 Real output_scale (Output_def*);
  85
  86 #endif /* MUSIC_OUTPUT_DEF_HH */