Merged layout handler from mainline

Also fixed login dialog layout. This is the layout handler by Guillaume
Melquiond, which he started in commit 59472ef68fdef3f7e8858a81a46e28c127119c58.

2 files changed, 647 insertions, 0 deletions

diff --git a/src/gui/widgets/layout.cpp b/src/gui/widgets/layout.cpp
new file mode 100644
index 00000000..bcc54cf7
--- /dev/null
+++ b/src/gui/widgets/layout.cpp
@@ -0,0 +1,327 @@
+/*
+ *  The Mana World
+ *  Copyright 2007 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World 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 2 of the License, or
+ *  any later version.
+ *
+ *  The Mana World 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 The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <cassert>
+
+#include "layout.h"
+
+ContainerPlacer ContainerPlacer::at(int x, int y)
+{
+    return ContainerPlacer(mContainer, &mCell->at(x, y));
+}
+
+LayoutCell &ContainerPlacer::operator()
+    (int x, int y, gcn::Widget *wg, int w, int h)
+{
+    mContainer->add(wg);
+    return mCell->place(wg, x, y, w, h);
+}
+
+LayoutCell::~LayoutCell()
+{
+    if (mType == ARRAY) delete mArray;
+}
+
+LayoutArray &LayoutCell::getArray()
+{
+    assert(mType != WIDGET);
+    if (mType == ARRAY) return *mArray;
+    mArray = new LayoutArray;
+    mType = ARRAY;
+    mExtent[0] = 1;
+    mExtent[1] = 1;
+    mPadding = 0;
+    mAlign[0] = FILL;
+    mAlign[1] = FILL;
+    return *mArray;
+}
+
+void LayoutCell::reflow(int nx, int ny, int nw, int nh)
+{
+    assert(mType != NONE);
+    nx += mPadding;
+    ny += mPadding;
+    nw -= 2 * mPadding;
+    nh -= 2 * mPadding;
+    if (mType == ARRAY)
+        mArray->reflow(nx, ny, nw, nh);
+    else
+        mWidget->setDimension(gcn::Rectangle(nx, ny, nw, nh));
+}
+
+void LayoutCell::computeSizes()
+{
+    assert(mType == ARRAY);
+
+    for (std::vector< std::vector< LayoutCell * > >::iterator
+         i = mArray->mCells.begin(), i_end = mArray->mCells.end();
+         i != i_end; ++i)
+    {
+        for (std::vector< LayoutCell * >::iterator
+             j = i->begin(), j_end = i->end(); j != j_end; ++j)
+        {
+            LayoutCell *cell = *j;
+            if (cell && cell->mType == ARRAY) cell->computeSizes();
+        }
+    }
+
+    mSize[0] = mArray->getSize(0);
+    mSize[1] = mArray->getSize(1);
+}
+
+LayoutArray::LayoutArray(): mSpacing(4)
+{
+}
+
+LayoutArray::~LayoutArray()
+{
+    for (std::vector< std::vector< LayoutCell * > >::iterator
+         i = mCells.begin(), i_end = mCells.end(); i != i_end; ++i)
+    {
+        for (std::vector< LayoutCell * >::iterator
+             j = i->begin(), j_end = i->end(); j != j_end; ++j)
+        {
+            delete *j;
+        }
+    }
+}
+
+LayoutCell &LayoutArray::at(int x, int y, int w, int h)
+{
+    resizeGrid(x + w, y + h);
+    LayoutCell *&cell = mCells[y][x];
+    if (!cell)
+    {
+        cell = new LayoutCell;
+    }
+    return *cell;
+}
+
+void LayoutArray::resizeGrid(int w, int h)
+{
+    bool extW = w && w > (int)mSizes[0].size(),
+         extH = h && h > (int)mSizes[1].size();
+    if (!extW && !extH) return;
+
+    if (extH)
+    {
+        mSizes[1].resize(h, Layout::AUTO_DEF);
+        mCells.resize(h);
+        if (!extW) w = mSizes[0].size();
+    }
+
+    if (extW)
+    {
+        mSizes[0].resize(w, Layout::AUTO_DEF);
+    }
+
+    for (std::vector< std::vector< LayoutCell * > >::iterator
+         i = mCells.begin(), i_end = mCells.end(); i != i_end; ++i)
+    {
+        i->resize(w, NULL);
+    }
+}
+
+void LayoutArray::setColWidth(int n, int w)
+{
+    resizeGrid(n + 1, 0);
+    mSizes[0][n] = w;
+}
+
+void LayoutArray::setRowHeight(int n, int h)
+{
+    resizeGrid(0, n + 1);
+    mSizes[1][n] = h;
+}
+
+void LayoutArray::matchColWidth(int n1, int n2)
+{
+    resizeGrid(std::max(n1, n2) + 1, 0);
+    std::vector< short > widths = getSizes(0, Layout::AUTO_DEF);
+    int s = std::max(widths[n1], widths[n2]);
+    mSizes[0][n1] = s;
+    mSizes[0][n2] = s;
+}
+
+void LayoutArray::extend(int x, int y, int w, int h)
+{
+    LayoutCell &cell = at(x, y, w, h);
+    cell.mExtent[0] = w;
+    cell.mExtent[1] = h;
+}
+
+LayoutCell &LayoutArray::place(gcn::Widget *widget, int x, int y, int w, int h)
+{
+    LayoutCell &cell = at(x, y, w, h);
+    assert(cell.mType == LayoutCell::NONE);
+    cell.mType = LayoutCell::WIDGET;
+    cell.mWidget = widget;
+    cell.mSize[0] = w == 1 ? widget->getWidth() : 0;
+    cell.mSize[1] = h == 1 ? widget->getHeight() : 0;
+    cell.mExtent[0] = w;
+    cell.mExtent[1] = h;
+    cell.mPadding = 0;
+    cell.mAlign[0] = LayoutCell::FILL;
+    cell.mAlign[1] = LayoutCell::FILL;
+    short &cs = mSizes[0][x], &rs = mSizes[1][y];
+    if (cs == Layout::AUTO_DEF && w == 1) cs = 0;
+    if (rs == Layout::AUTO_DEF && h == 1) rs = 0;
+    return cell;
+}
+
+void LayoutArray::align(int &pos, int &size, int dim,
+                        LayoutCell const &cell, short *sizes) const
+{
+    int size_max = sizes[0];
+    for (int i = 1; i < cell.mExtent[dim]; ++i)
+        size_max += sizes[i] + mSpacing;
+    size = std::min<int>(cell.mSize[dim], size_max);
+
+    switch (cell.mAlign[dim])
+    {
+        case LayoutCell::LEFT:
+            return;
+        case LayoutCell::RIGHT:
+            pos += size_max - size;
+            return;
+        case LayoutCell::CENTER:
+            pos += (size_max - size) / 2;
+            return;
+        case LayoutCell::FILL:
+            size = size_max;
+            return;
+    }
+}
+
+std::vector< short > LayoutArray::getSizes(int dim, int upp) const
+{
+    int gridW = mSizes[0].size(), gridH = mSizes[1].size();
+    std::vector< short > sizes = mSizes[dim];
+
+    // Compute minimum sizes.
+    for (int gridY = 0; gridY < gridH; ++gridY)
+    {
+        for (int gridX = 0; gridX < gridW; ++gridX)
+        {
+            LayoutCell const *cell = mCells[gridY][gridX];
+            if (!cell || cell->mType == LayoutCell::NONE) continue;
+
+            if (cell->mExtent[dim] == 1)
+            {
+                int n = dim == 0 ? gridX : gridY;
+                int s = cell->mSize[dim] + cell->mPadding * 2;
+                if (s > sizes[n]) sizes[n] = s;
+            }
+        }
+    }
+
+    if (upp == Layout::AUTO_DEF) return sizes;
+
+    // Compute the FILL sizes.
+    int nb = sizes.size();
+    int nbFill = 0;
+    for (int i = 0; i < nb; ++i)
+    {
+        if (mSizes[dim][i] <= Layout::AUTO_DEF)
+        {
+            ++nbFill;
+            if (mSizes[dim][i] == Layout::AUTO_SET ||
+                sizes[i] <= Layout::AUTO_DEF)
+            {
+                sizes[i] = 0;
+            }
+        }
+        upp -= sizes[i] + mSpacing;
+    }
+    upp = upp + mSpacing;
+
+    if (nbFill == 0) return sizes;
+
+    for (int i = 0; i < nb; ++i)
+    {
+        if (mSizes[dim][i] > Layout::AUTO_DEF) continue;
+        int s = upp / nbFill;
+        sizes[i] += s;
+        upp -= s;
+        --nbFill;
+    }
+
+    return sizes;
+}
+
+int LayoutArray::getSize(int dim) const
+{
+    std::vector< short > sizes = getSizes(dim, Layout::AUTO_DEF);
+    int size = 0;
+    int nb = sizes.size();
+    for (int i = 0; i < nb; ++i)
+    {
+        if (sizes[i] > Layout::AUTO_DEF) size += sizes[i];
+        size += mSpacing;
+    }
+    return size - mSpacing;
+}
+
+void LayoutArray::reflow(int nx, int ny, int nw, int nh)
+{
+    int gridW = mSizes[0].size(), gridH = mSizes[1].size();
+
+    std::vector< short > widths  = getSizes(0, nw);
+    std::vector< short > heights = getSizes(1, nh);
+
+    int y = ny;
+    for (int gridY = 0; gridY < gridH; ++gridY)
+    {
+        int x = nx;
+        for (int gridX = 0; gridX < gridW; ++gridX)
+        {
+            LayoutCell *cell = mCells[gridY][gridX];
+            if (cell && cell->mType != LayoutCell::NONE)
+            {
+                int dx = x, dy = y, dw, dh;
+                align(dx, dw, 0, *cell, &widths[gridX]);
+                align(dy, dh, 1, *cell, &heights[gridY]);
+                cell->reflow(dx, dy, dw, dh);
+            }
+            x += widths[gridX] + mSpacing;
+        }
+        y += heights[gridY] + mSpacing;
+    }
+}
+
+Layout::Layout(): mComputed(false)
+{
+    getArray();
+    setPadding(6);
+}
+
+void Layout::reflow(int &nw, int &nh)
+{
+    if (!mComputed)
+    {
+        computeSizes();
+        mComputed = true;
+    }
+
+    nw = nw == 0 ? mSize[0] + 2 * mPadding : nw;
+    nh = nh == 0 ? mSize[1] + 2 * mPadding : nh;
+    LayoutCell::reflow(0, 0, nw, nh);
+}
diff --git a/src/gui/widgets/layout.h b/src/gui/widgets/layout.h
new file mode 100644
index 00000000..d631c154
--- /dev/null
+++ b/src/gui/widgets/layout.h
@@ -0,0 +1,320 @@
+/*
+ *  The Mana World
+ *  Copyright 2007 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World 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 2 of the License, or
+ *  any later version.
+ *
+ *  The Mana World 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 The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef _TMW_WIDGET_LAYOUT_H__
+#define _TMW_WIDGET_LAYOUT_H__
+
+#include <vector>
+
+#include <guichan/widgets/container.hpp>
+
+class LayoutCell;
+
+/**
+ * This class is a helper for adding widgets to nested tables in a window.
+ */
+class ContainerPlacer
+{
+    public:
+
+        ContainerPlacer(gcn::Container *c = NULL, LayoutCell *l = NULL):
+            mContainer(c), mCell(l)
+        {}
+
+        /**
+         * Gets the pointed cell.
+         */
+        LayoutCell &getCell()
+        { return *mCell; }
+
+        /**
+         * Returns a placer for the same container but to an inner cell.
+         */
+        ContainerPlacer at(int x, int y);
+
+        /**
+         * Adds the given widget to the container and places it in the layout.
+         * @see LayoutArray::place
+         */
+        LayoutCell &operator()
+            (int x, int y, gcn::Widget *, int w = 1, int h = 1);
+
+    private:
+
+        gcn::Container *mContainer;
+        LayoutCell *mCell;
+};
+
+/**
+ * This class contains a rectangular array of cells.
+ */
+class LayoutArray
+{
+    friend class LayoutCell;
+
+    public:
+
+        LayoutArray();
+
+        ~LayoutArray();
+
+        /**
+         * Returns a reference on the cell at given position.
+         */
+        LayoutCell &at(int x, int y, int w = 1, int h = 1);
+
+        /**
+         * Places a widget in a given cell.
+         * @param w number of columns the widget spawns.
+         * @param h number of rows the widget spawns.
+         * @note When @a w is 1, the width of column @a x is reset to zero if
+         *       it was AUTO_DEF. Similarly for @a h.
+         */
+        LayoutCell &place(gcn::Widget *, int x, int y, int w = 1, int h = 1);
+
+        /**
+         * Sets the minimum width of a column.
+         */
+        void setColWidth(int n, int w);
+
+        /**
+         * Sets the minimum height of a row.
+         */
+        void setRowHeight(int n, int h);
+
+        /**
+         * Sets the widths of two columns to the maximum of their widths.
+         */
+        void matchColWidth(int n1, int n2);
+
+        /**
+         * Spawns a cell over several columns/rows.
+         */
+        void extend(int x, int y, int w, int h);
+
+        /**
+         * Computes and sets the positions of all the widgets.
+         * @param nW width of the array, used to resize the AUTO_ columns.
+         * @param nH height of the array, used to resize the AUTO_ rows.
+         */
+        void reflow(int nX, int nY, int nW, int nH);
+
+    private:
+
+        // Copy not allowed, as the array owns all its cells.
+        LayoutArray(LayoutArray const &);
+        LayoutArray &operator=(LayoutArray const &);
+
+        /**
+         * Gets the position and size of a widget along a given axis
+         */
+        void align(int &pos, int &size, int dim,
+                   LayoutCell const &cell, short *sizes) const;
+
+        /**
+         * Ensures the private vectors are large enough.
+         */
+        void resizeGrid(int w, int h);
+
+        /**
+         * Gets the column/row sizes along a given axis.
+         * @param upp target size for the array. Ignored if AUTO_DEF.
+         */
+        std::vector< short > getSizes(int dim, int upp) const;
+
+        /**
+         * Gets the total size along a given axis.
+         */
+        int getSize(int dim) const;
+
+        std::vector< short > mSizes[2];
+        std::vector< std::vector < LayoutCell * > > mCells;
+
+        char mSpacing;
+};
+
+/**
+ * This class describes the formatting of a widget in the cell of a layout
+ * table. Horizontally, a widget can either fill the width of the cell (minus
+ * the cell padding), or it can retain its size and be flushed left, or flush
+ * right, or centered in the cell. The process is similar for the vertical
+ * alignment, except that top is represented by LEFT and bottom by RIGHT.
+ */
+class LayoutCell
+{
+    friend class Layout;
+    friend class LayoutArray;
+
+    public:
+
+        enum Alignment
+        {
+            LEFT, RIGHT, CENTER, FILL
+        };
+
+        LayoutCell(): mType(NONE) {}
+
+        ~LayoutCell();
+
+        /**
+         * Sets the padding around the cell content.
+         */
+        LayoutCell &setPadding(int p)
+        { mPadding = p; return *this; }
+
+        /**
+         * Sets the horizontal alignment of the cell content.
+         */
+        LayoutCell &setHAlign(Alignment a)
+        { mAlign[0] = a; return *this; }
+
+        /**
+         * Sets the vertical alignment of the cell content.
+         */
+        LayoutCell &setVAlign(Alignment a)
+        { mAlign[1] = a; return *this; }
+
+        /**
+         * @see LayoutArray::at
+         */
+        LayoutCell &at(int x, int y)
+        { return getArray().at(x, y); }
+
+        /**
+         * @see LayoutArray::place
+         */
+        LayoutCell &place(gcn::Widget *wg, int x, int y, int w = 1, int h = 1)
+        { return getArray().place(wg, x, y, w, h); }
+
+        /**
+         * @see LayoutArray::matchColWidth
+         */
+        void matchColWidth(int n1, int n2)
+        { getArray().matchColWidth(n1, n2); }
+
+        /**
+         * @see LayoutArray::setColWidth
+         */
+        void setColWidth(int n, int w)
+        { getArray().setColWidth(n, w); }
+
+        /**
+         * @see LayoutArray::setRowHeight
+         */
+        void setRowHeight(int n, int h)
+        { getArray().setRowHeight(n, h); }
+
+        /**
+         * @see LayoutArray::extend.
+         */
+        void extend(int x, int y, int w, int h)
+        { getArray().extend(x, y, w, h); }
+
+        /**
+         * Sets the minimum widths and heights of this cell and of all the
+         * inner cells.
+         */
+        void computeSizes();
+
+    private:
+
+        // Copy not allowed, as the cell may own an array.
+        LayoutCell(LayoutCell const &);
+        LayoutCell &operator=(LayoutCell const &);
+
+        union
+        {
+            gcn::Widget *mWidget;
+            LayoutArray *mArray;
+        };
+
+        enum
+        {
+            NONE, WIDGET, ARRAY
+        };
+
+        /**
+         * Returns the embedded array. Creates it if the cell does not contain
+         * anything yet. Aborts if it contains a widget.
+         */
+        LayoutArray &getArray();
+
+        /**
+         * @see LayoutArray::reflow
+         */
+        void reflow(int nx, int ny, int nw, int nh);
+
+        short mSize[2];
+        char mPadding;
+        char mExtent[2];
+        char mAlign[2];
+        char mNbFill[2];
+        char mType;
+};
+
+/**
+ * This class is an helper for setting the position of widgets. They are
+ * positioned along the cells of some rectangular tables. The layout may either
+ * be a single table or a tree of nested tables.
+ *
+ * The size of a given table column can either be set manually or be chosen
+ * from the widest widget of the column. An empty column has a AUTO_DEF width,
+ * which means it will be extended so that the layout fits its minimum width.
+ *
+ * The process is similar for table rows. By default, there is a spacing of 4
+ * pixels between rows and between columns, and a margin of 6 pixels around the
+ * whole layout.
+ */
+class Layout: public LayoutCell
+{
+    public:
+
+        Layout();
+
+        /**
+         * Sets the margin around the layout.
+         */
+        void setMargin(int m)
+        { setPadding(m); }
+
+        /**
+         * Sets the positions of all the widgets.
+         * @see LayoutArray::reflow
+         */
+        void reflow(int &nW, int &nH);
+
+        /**
+         * When the minimum size of the layout is less than the available size,
+         * the remaining pixels are equally split amongst the FILL items.
+         */
+        enum
+        {
+            AUTO_DEF = -42, /**< Default value, behaves like AUTO_ADD. */
+            AUTO_SET = -43, /**< Uses the share as the new size. */
+            AUTO_ADD = -44  /**< Adds the share to the current size. */
+        };
+
+    private:
+
+        bool mComputed;
+};
+
+#endif