/*
  This file is part of LilyPond, the GNU music typesetter.

  Copyright (C) 2000--2012 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/>.
*/

#ifndef AXIS_GROUP_INTERFACE_HH
#define AXIS_GROUP_INTERFACE_HH

#include "std-vector.hh"
#include "lily-proto.hh"
#include "grob-interface.hh"
#include "skyline.hh"

class Axis_group_interface
{
  static Real default_outside_staff_padding_;
  public
:
  static SCM generic_group_extent (Grob *me, Axis a);
  static Real get_default_outside_staff_padding ();
  static Interval generic_bound_extent (Grob *me, Grob *common, Axis a);
  static Interval pure_group_height (Grob *me, int start, int end);
  DECLARE_SCHEME_CALLBACK (width, (SCM smob));
  DECLARE_SCHEME_CALLBACK (calc_x_common, (SCM smob));
  DECLARE_SCHEME_CALLBACK (calc_y_common, (SCM smob));
  DECLARE_SCHEME_CALLBACK (height, (SCM smob));
  DECLARE_SCHEME_CALLBACK (pure_height, (SCM smob, SCM start, SCM end));
  DECLARE_SCHEME_CALLBACK (calc_skylines, (SCM smob));
  DECLARE_SCHEME_CALLBACK (combine_skylines, (SCM smob));
  DECLARE_SCHEME_CALLBACK (print, (SCM smob));
  DECLARE_SCHEME_CALLBACK (adjacent_pure_heights, (SCM));
  DECLARE_SCHEME_CALLBACK (calc_staff_staff_spacing, (SCM));
  DECLARE_SCHEME_CALLBACK (calc_pure_staff_staff_spacing, (SCM, SCM, SCM));
  DECLARE_SCHEME_CALLBACK (calc_pure_relevant_grobs, (SCM));
  DECLARE_SCHEME_CALLBACK (calc_pure_relevant_items, (SCM));
  DECLARE_SCHEME_CALLBACK (calc_pure_relevant_spanners, (SCM));
  DECLARE_SCHEME_CALLBACK (calc_pure_y_common, (SCM));
  static SCM internal_calc_pure_relevant_grobs (Grob *, const string&);
  static Interval relative_group_extent (vector<Grob *> const &list,
                                         Grob *common, Axis);
  static Interval relative_maybe_bound_group_extent (vector<Grob *> const &list,
                                                     Grob *common, Axis, bool);
  static Interval relative_pure_height (Grob *me, int start, int end);
  static Interval combine_pure_heights (Grob *me, SCM, int, int);
  static Interval sum_partial_pure_heights (Grob *me, int, int);
  static Interval begin_of_line_pure_height (Grob *me, int);
  static Interval rest_of_line_pure_height (Grob *me, int, int);
  static Interval part_of_line_pure_height (Grob *me, bool begin, int, int);

  static Grob *outside_staff_ancestor (Grob *me);
  static Skyline_pair skyline_spacing (Grob *me);
  static void add_element (Grob *me, Grob *);
  static void set_axes (Grob *, Axis, Axis);
  static bool has_axis (Grob *, Axis);
  static void get_children (Grob *, vector<Grob *> *);
  static Interval staff_extent (Grob *me, Grob *ref, Axis, Grob *staff, Axis);
  static SCM calc_common (Grob *, Axis);
  static Real minimum_distance (Grob *, Grob *, Axis);
  static SCM calc_maybe_pure_staff_staff_spacing (Grob *, bool, int, int);
  DECLARE_GROB_INTERFACE ();
};

#endif /* AXIS_GROUP_INTERFACE_HH */

