libyacurs/src/vpack.cc

//
// This file is part of libyacurs.
// Copyright (C) 2013  Rafael Ostertag
//
// This program 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.
//
// This program 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 this program.  If not, see
// <http://www.gnu.org/licenses/>.
//
//
// $Id$

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <algorithm>
#include <cassert>
#include <cstdlib>
#include <functional>

#include "vpack.h"
#include "yacursex.h"

using namespace YACURS;

//
// Functors
//

namespace YACURS {
/**
 * Name space reserved for functors.
 */
namespace FUNCTORS {
namespace VPACK {
/**
 * Realizes widgets.
 *
 * @internal
 *
 * It checks for exceptions when realizing.
 */
class VRealizeWidgets {
   public:
    void operator()(WidgetBase* w) {
        assert(w != 0);
        // It is possible, that upon a resize the
        // widget became to big for the screen, or
        // overshoots it due to its position and
        // size. Packs do not check whether or not
        // statically sized become too big when
        // stacked.
        try {
            w->realize();
        } catch (EXCEPTIONS::BaseCurEx&) {
            w->focusgroup_id(FocusManager::nfgid);
        }
    }
};

/**
 * Calculate the size hint.
 *
 * @internal
 *
 * Functor for calculating the size hint by finding the
 * max columns size and summing up row size.
 */
class VGetMaxSizeHint {
   private:
    Size __size_max;

   public:
    VGetMaxSizeHint() : __size_max(Size::zero()) {}

    VGetMaxSizeHint(const VGetMaxSizeHint& _v) : __size_max(_v.__size_max) {}

    VGetMaxSizeHint& operator=(const VGetMaxSizeHint& _v) {
        __size_max = _v.__size_max;
        return *this;
    }

    void operator()(const WidgetBase* w) {
        assert(w != 0);
        __size_max.cols(std::max(w->size_hint().cols(), __size_max.cols()));
        __size_max.rows(w->size_hint().rows() + __size_max.rows());
    }

    const Size& hint() const { return __size_max; }
};

/**
 * Set size_available() on widgets.
 *
 * Functor for setting available size on Widgets.
 *
 * @internal
 *
 * mainly used when compiling with Solaris Studio.
 */
class VSetSizeAvail {
   private:
    const Size& __avail;

   public:
    VSetSizeAvail(const Size& _avail) : __avail(_avail) {}

    VSetSizeAvail(const VSetSizeAvail& _s) : __avail(_s.__avail) {}

    void operator()(WidgetBase* w) {
        assert(w != 0);
        assert(__avail.rows() > 0);
        assert(__avail.cols() > 0);
        w->size_available(__avail);
    }
};

/**
 * Set size_available on hinted Widgets.
 *
 * Functor for setting size_available on hinted Widgets.
 */
class VSetSizeHinted {
   private:
    Size __const_cols;
    Size __size_used;

   public:
    VSetSizeHinted(const Size& _cc) : __const_cols(_cc), __size_used() {
        assert(__const_cols.cols() > 0);
    }

    VSetSizeHinted(const VSetSizeHinted& _h)
        : __const_cols(_h.__const_cols), __size_used(_h.__size_used) {}

    VSetSizeHinted& operator=(const VSetSizeHinted& _h) {
        __const_cols = _h.__const_cols;
        __size_used = _h.__size_used;
        return *this;
    }

    void operator()(WidgetBase* w) {
        assert(w != 0);
        assert(w->size_hint().rows() > 0);

        // _sa is supposed to hold the constant row
        // value and the hinted cols value as
        // retrieved from calling size_hint() on the
        // Widget
        Size _sa(__const_cols);
        _sa.rows(w->size_hint().rows());

        // Finally, set the available size on the
        // Widget
        w->size_available(_sa);

        // Add the hinted cols to __size_used, so that
        // they can be deducted from the total size
        // available to the pack.
        __size_used.rows(__size_used.rows() + w->size_hint().rows());
    }

    const Size& size_used() const { return __size_used; }
};

/**
 * Calculates and sets the available size for associated
 * widgets.
 *
 * This class is passed in a std::for_each(). Once
 * for_each() is done, finish() must be called, since that
 * will set size on all dynamically sized Widgets.
 */
class VCalcNSetSize {
   private:
    Size _size;
    Size __size_available;
    std::list<WidgetBase*> __dyn_widgets;
    std::list<WidgetBase*> __hinted_widgets;

   public:
    VCalcNSetSize(const Size& _av)
        : _size(), __size_available(_av), __dyn_widgets(), __hinted_widgets() {
        assert(__size_available.rows() > 0);
        assert(__size_available.cols() > 0);
    }

    VCalcNSetSize(const VCalcNSetSize& _c)
        : _size(_c._size),
          __size_available(_c.__size_available),
          __dyn_widgets(_c.__dyn_widgets),
          __hinted_widgets(_c.__hinted_widgets) {}

    VCalcNSetSize& operator=(const VCalcNSetSize& _c) {
        _size = _c._size;
        __size_available = _c.__size_available;
        __dyn_widgets = _c.__dyn_widgets;
        __hinted_widgets = _c.__hinted_widgets;
        return *this;
    }

    void operator()(WidgetBase* w) {
        assert(w != 0);

        // First, reset the size, so that we can
        // identify dynamically sized Widgets
        w->reset_size();

        if (w->size() == Size::zero()) {
            // That's a dynamically sized widget, thus
            // add it to one of the lists for later
            // processing.
            //
            // if it is capable of giving a hint, add
            // it to the __hinted_widgets list which
            // is treated separately from
            // __dyn_widgets. But only if the hint
            // does not exceed the available size.
            if (w->size_hint().rows() > 0 &&
                w->size_hint().rows() <= __size_available.rows())
                __hinted_widgets.push_back(w);
            else
                __dyn_widgets.push_back(w);

            return;
        }

        _size.rows(_size.rows() + w->size().rows());
        _size.cols(std::max(_size.cols(), w->size().cols()));
        if (_size.rows() > __size_available.rows() ||
            _size.cols() > __size_available.cols())
            throw EXCEPTIONS::AreaExceeded();
        // Also set the size availabe for the
        // widget. Dynamically sized widgets are
        // handled when CalcNSetSize::finish() is
        // called.
        w->size_available(w->size());
    }

    void finish() {
        if (__dyn_widgets.empty() && __hinted_widgets.empty()) {
            // There are no dynamically sized widgets,
            // there is nothing left to do
            return;
        }
        // In order to process hinted widgets, get the
        // cols. We only consider Widgets hinting on
        // rows
        Size cols_unhinted(0, __size_available.cols());

        VSetSizeHinted hinted_size(
            std::for_each(__hinted_widgets.begin(), __hinted_widgets.end(),
                          VSetSizeHinted(cols_unhinted)));

        // Bail out if there are no unhinted dynamic
        // widgets
        if (__dyn_widgets.empty()) return;

        // There are dynamically sized widgets. So
        // let's find out the how much space is
        // available for them
        Size remaining_size(__size_available - _size);

        remaining_size -= hinted_size.size_used();

        // We ignore remaining_size.cols() because we
        // vertically stack widgets and the
        // dynamically sized widgets get the amount of
        // _size.cols()
        if (remaining_size.rows() < 1) throw EXCEPTIONS::InvalidSize();

        // This gives the size for each dynamically
        // sized Widget. The remaining size will be
        // divided equally among all dynamically sized
        // widgets.
        Size per_dyn_widget(remaining_size.rows() / __dyn_widgets.size(),
                            __size_available.cols());

        // Set the size for each widget.
        //
        // The following doesn't work when compiling
        // with Solaris Studio on Solaris, so we use a
        // Function Object:
        //
        // std::for_each(__dyn_widgets.begin(),
        //                __dyn_widgets.end(),
        //                std::bind2nd(std::mem_fun<void,WidgetBase,const
        //                Size&>(&WidgetBase::size_available),per_dyn_widget));
        std::for_each(__dyn_widgets.begin(), __dyn_widgets.end(),
                      VSetSizeAvail(per_dyn_widget));
    }
};

/**
 * Functor calculating the size only if no dynamically
 * sized Widgets are associated. Else it will return
 * Size::zero().
 *
 * Used in calc_size_non_dynamic().
 */
class VCalcSizeNonDynamic {
   private:
    Size _size;
    bool _had_dynamic;

   public:
    VCalcSizeNonDynamic() : _size(), _had_dynamic(false) {}

    VCalcSizeNonDynamic(const VCalcSizeNonDynamic& r)
        : _size(r._size), _had_dynamic(r._had_dynamic) {}

    VCalcSizeNonDynamic& operator=(const VCalcSizeNonDynamic& r) {
        _size = r._size;
        _had_dynamic = r._had_dynamic;
        return *this;
    }

    void operator()(const WidgetBase* w) {
        assert(w != 0);

        // Do nothing if we already found a dynamic
        // widget
        if (_had_dynamic) return;

        if (w->size() == Size::zero()) {
            // found a dynamic widget. Reset size and
            // mark
            _had_dynamic = true;
            _size = Size::zero();
            return;
        }

        _size.rows(_size.rows() + w->size().rows());
        _size.cols(std::max(_size.cols(), w->size().cols()));
    }

    const Size& size() const { return _size; }
};

/**
 * Sets the position of a given Widget.
 *
 * Sets the position of a given Widget and updates an
 * internal Coordinate object in manner, that subsequent
 * positions will not overwrite previous Widgets on the
 * screen.
 *
 * The position will be advanced from top to bottom
 * (i.e. vertically).
 */
class VSetPosWidget {
   private:
    /**
     * Position of wich is used in the call to
     * WidgetBase::position().
     */
    Coordinates _pos;

   public:
    /**
     * @param _start the first call of the object
     * will put the Widget at this position.
     */
    VSetPosWidget(const Coordinates& _start) : _pos(_start) {}

    VSetPosWidget(const VSetPosWidget& o) : _pos(o._pos) {}

    /**
     * Call WidgetBase::postion().
     *
     * Call WidgetBase::position() and update _pos;
     *
     * @param w pointer to Widget.
     */
    void operator()(WidgetBase* w) {
        w->position(_pos);
        _pos.y(_pos.y() + w->size().rows());
    }
};
}  // namespace VPACK
}  // namespace FUNCTORS
}  // namespace YACURS

//
// Private
//

//
// Protected
//

void VPack::recalc_size() {
    assert(WidgetBase::size_available() != Size::zero());

    FUNCTORS::VPACK::VCalcNSetSize calc(WidgetBase::size_available());
    calc = std::for_each(widget_list.begin(), widget_list.end(), calc);

    // This is imperative, in order to set the size_available on any
    // dynamically sized Widgets.
    calc.finish();
}

Size VPack::calc_size_non_dynamic() const {
    FUNCTORS::VPACK::VCalcSizeNonDynamic _s;

    _s = std::for_each(widget_list.begin(), widget_list.end(), _s);
    return _s.size();
}

//
// Public
//
VPack::VPack() : Pack{} {}

VPack::~VPack() {}

Size VPack::size_hint() const {
    if (!hinting()) return Size::zero();

    // remember that Packs may return either component >0 when
    // hinting, see also comment on VGetMaxSizeHint
    FUNCTORS::VPACK::VGetMaxSizeHint shint;

    shint = std::for_each(widget_list.begin(), widget_list.end(), shint);
    return shint.hint();
}

void VPack::realize() {
    REALIZE_ENTER;

    assert(WidgetBase::size_available().rows() > 0);
    assert(WidgetBase::size_available().cols() > 0);

    try {
        recalc_size();
    } catch (EXCEPTIONS::AreaExceeded&) {
        // Back off
        std::for_each(widget_list.begin(), widget_list.end(),
                      std::mem_fun(&WidgetBase::unrealize));

        realization(UNREALIZED);
        return;
    }

    // Set position for each associated widget. That's the only reason
    // we implement realize() in a derived class, i.e. here
    std::for_each(widget_list.begin(), widget_list.end(),
                  FUNCTORS::VPACK::VSetPosWidget(position()));

    // We have to catch exceptions, but continue. The
    //
    //    std::for_each(widget_list.begin(),
    //		  widget_list.end(),
    //		  std::mem_fun(&WidgetBase::realize));
    //
    // can't be used for that.
    std::for_each(widget_list.begin(), widget_list.end(),
                  FUNCTORS::VPACK::VRealizeWidgets());

    REALIZE_LEAVE;
}