lily/balloon.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "text-interface.hh"
  21 #include "grob.hh"
  22 #include "item.hh"
  23 #include "line-interface.hh"
  24 #include "lookup.hh"
  25 #include "font-interface.hh"
  26 #include "lily-guile.hh"
  27 #include "output-def.hh"
  28 #include "misc.hh"
  29 #include "spanner.hh"
  30
  31 class Balloon_interface
  32 {
  33 public:
  34   DECLARE_SCHEME_CALLBACK (print, (SCM));
  35   DECLARE_SCHEME_CALLBACK (print_spanner, (SCM));
  36   DECLARE_GROB_INTERFACE ();
  37
  38   static SCM internal_balloon_print (Grob *me, Grob *p, Offset off);
  39 };
  40
  41 MAKE_SCHEME_CALLBACK (Balloon_interface, print, 1);
  42 SCM
  43 Balloon_interface::print (SCM smob)
  44 {
  45   Grob *me = unsmob_grob (smob);
  46
  47   if (Item *item = dynamic_cast<Item *> (me))
  48     if (!Item::break_visible (item))
  49       return SCM_EOL;
  50
  51   Grob *p = me->get_parent (X_AXIS);
  52
  53   Offset off (me->relative_coordinate (p, X_AXIS),
  54               me->relative_coordinate (p, Y_AXIS));
  55
  56   return internal_balloon_print (me, p, off);
  57 }
  58
  59 MAKE_SCHEME_CALLBACK (Balloon_interface, print_spanner, 1);
  60 SCM
  61 Balloon_interface::print_spanner (SCM smob)
  62 {
  63   Spanner *me = unsmob_spanner (smob);
  64   Spanner *orig = dynamic_cast<Spanner *> (me->original ());
  65
  66   if (orig)
  67     {
  68       Direction spanner_placement = robust_scm2dir (me->get_property ("spanner-placement"), LEFT);
  69
  70       Spanner *wanted = (spanner_placement != RIGHT)
  71                         ? orig->broken_intos_[0]
  72                         : orig->broken_intos_.back ();
  73
  74       if (me != wanted)
  75         return SCM_EOL;
  76     }
  77
  78   Spanner *p = dynamic_cast<Spanner *> (me->get_parent (Y_AXIS));
  79
  80   if (!p)
  81     return SCM_EOL;
  82
  83   Offset off (me->relative_coordinate (me->get_bound (LEFT), X_AXIS),
  84               me->relative_coordinate (p, Y_AXIS));
  85   return internal_balloon_print (me, p, off);
  86 }
  87
  88 SCM
  89 Balloon_interface::internal_balloon_print (Grob *me, Grob *p, Offset off)
  90 {
  91   Box b (p->extent (p, X_AXIS),
  92          p->extent (p, Y_AXIS));
  93   Real padding = robust_scm2double (me->get_property ("padding"), .1);
  94   b.widen (padding, padding);
  95
  96   // FIXME
  97   Stencil fr;
  98   if (to_boolean (me->get_property ("annotation-balloon")))
  99     fr = Lookup::frame (b, 0.1, 0.05);
 100
 101   SCM bt = me->get_property ("text");
 102   SCM chain = Font_interface::text_font_alist_chain (me);
 103   SCM stencil = Text_interface::interpret_markup (me->layout ()->self_scm (),
 104                                                   chain, bt);
 105   Stencil *text_stil = unsmob_stencil (stencil);
 106
 107   Offset z1;
 108
 109   for (int i = X_AXIS; i < NO_AXES; i++)
 110     {
 111       Axis a ((Axis)i);
 112       z1[a] = b[a].linear_combination (sign (off[a]));
 113       text_stil->align_to (a, -sign (off[a]));
 114     }
 115
 116   Offset z2 = z1 + off;
 117
 118   if (to_boolean (me->get_property ("annotation-line")))
 119     fr.add_stencil (Line_interface::line (me, z1, z2));
 120
 121   text_stil->translate (z2);
 122   fr.add_stencil (*text_stil);
 123
 124   fr.translate (-off);
 125   return fr.smobbed_copy ();
 126 }
 127
 128 ADD_INTERFACE (Balloon_interface,
 129                "A collection of routines to put text balloons around an"
 130                " object.",
 131
 132                /* properties */
 133                "annotation-balloon "
 134                "annotation-line "
 135                "padding "
 136                "spanner-placement "
 137                "text "
 138               );
 139