TableView Conway's Game of Life example

This new example shows how a Conway's Game of Life implementation can
be created with QML and the new TableView component.

Change-Id: I940210c5e5a0554e6f052ff109070e69e59cab56
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>

1 files changed, 106 insertions, 0 deletions

diff --git a/examples/quick/tableview/gameoflife/gameoflifemodel.h b/examples/quick/tableview/gameoflife/gameoflifemodel.h
new file mode 100644
index 0000000000..3ea1469861
--- /dev/null
+++ b/examples/quick/tableview/gameoflife/gameoflifemodel.h
@@ -0,0 +1,106 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, you may use this file under the terms of the BSD license
+** as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef GAMEOFLIFEMODEL_H
+#define GAMEOFLIFEMODEL_H
+
+#include <array>
+#include <QAbstractTableModel>
+#include <QPoint>
+
+//! [modelclass]
+class GameOfLifeModel : public QAbstractTableModel
+{
+    Q_OBJECT
+
+    Q_ENUMS(Roles)
+public:
+    enum Roles {
+        CellRole
+    };
+
+    QHash<int, QByteArray> roleNames() const override {
+        return {
+            { CellRole, "value" }
+        };
+    }
+
+    explicit GameOfLifeModel(QObject *parent = nullptr);
+
+    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+    int columnCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+    bool setData(const QModelIndex &index, const QVariant &value,
+                 int role = Qt::EditRole) override;
+
+    Qt::ItemFlags flags(const QModelIndex &index) const override;
+
+    Q_INVOKABLE void nextStep();
+    Q_INVOKABLE bool loadFile(const QString &fileName);
+    Q_INVOKABLE void loadPattern(const QString &plainText);
+    Q_INVOKABLE void clear();
+
+private:
+    static constexpr int width = 256;
+    static constexpr int height = 256;
+    static constexpr int size = width * height;
+
+    using StateContainer = std::array<bool, size>;
+    StateContainer m_currentState;
+
+    int cellNeighborsCount(const QPoint &cellCoordinates) const;
+    static bool areCellCoordinatesValid(const QPoint &coordinates);
+    static QPoint cellCoordinatesFromIndex(int cellIndex);
+    static std::size_t cellIndex(const QPoint &coordinates);
+};
+//! [modelclass]
+
+#endif // GAMEOFLIFEMODEL_H