Major reorganization work towards supporting app execution on backgro…

…und threads. Ignore-this: 5b696e002b84f1900452be3c5666ab7a This commit is a major reorganization in the app interface. I seperated the gui code from the backend app code. Now the backend talks via an front end interface, and the frontend talks to backend via a backend interface. These interfaces do not assume QT or Lua. This is a step towards the goal of having the backend run on a seperate thread. It also makes it possible in the future to use a different UI. The immediate goal is to try QtQuick instead of QWidgets so that porting to phone becomes easier. Also it opens up possibility of other languages besides Lua, though why would we want that? ;-) darcs-hash:20141018062518-c21fe-9a81c276fd21b68b149b38eb2570717bf796ef79
mempko · Oct 18, 2014 · 80a14a76e352ab2db79de47be8fba9b6e2ed5e81 · 80a14a7
1 parent 34f29d7
commit 80a14a76e352ab2db79de47be8fba9b6e2ed5e81
diff --git a/src/gui/CMakeLists.txt b/src/gui/CMakeLists.txt
@@ -34,10 +34,10 @@ ADD_DEFINITIONS(-std=c++11)
 include_directories(.)
 include_directories(..)

-file(GLOB src *.cpp app/*.cpp lua/*.cpp)
-file(GLOB headers *.hpp app/*.hpp lua/*.hpp)
-file(GLOB forms *.ui app/*.ui lua/*.ui)
-file(GLOB resources *.qrc app/*.qrc lua/*.qrc)
+file(GLOB src *.cpp app/*.cpp lua/*.cpp qtw/*.cpp) 
+file(GLOB headers *.hpp app/*.hpp lua/*.hpp qtw/*.hpp)
+file(GLOB forms *.ui app/*.ui lua/*.ui qtw/*.ui)
+file(GLOB resources *.qrc app/*.qrc lua/*.qrc qtw/*.qrc)

 #qt specific
 QT5_WRAP_CPP(moc_headers ${headers})
diff --git a/src/gui/api/service.hpp b/src/gui/api/service.hpp
@@ -0,0 +1,172 @@
+/*
+ * Copyright (C) 2014  Maxim Noah Khailo
+ *
+ * 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/>.
+ *
+ * In addition, as a special exception, the copyright holders give 
+ * permission to link the code of portions of this program with the 
+ * Botan library under certain conditions as described in each 
+ * individual source file, and distribute linked combinations 
+ * including the two.
+ *
+ * You must obey the GNU General Public License in all respects for 
+ * all of the code used other than Botan. If you modify file(s) with 
+ * this exception, you may extend this exception to your version of the 
+ * file(s), but you are not obligated to do so. If you do not wish to do 
+ * so, delete this exception statement from your version. If you delete 
+ * this exception statement from all source files in the program, then 
+ * also delete it here.
+ */
+#ifndef FIRESTR_GUI_API_SERVICE_H
+#define FIRESTR_GUI_API_SERVICE_H
+
+#include "util/bytes.hpp"
+
+#include <string>
+
+namespace fire 
+{
+    namespace gui 
+    {
+        namespace api 
+        {
+            using ref_id = std::size_t;
+
+            template<class T>
+                struct gen_file_data
+                {
+                    std::string name;
+                    T data;
+                    bool good = false;
+                };
+
+            using file_data = gen_file_data<std::string>;
+            using bin_file_data = gen_file_data<util::bytes>;
+
+            struct frontend
+            {
+                //all widgets
+                virtual void place(ref_id, int r, int c) = 0;
+                virtual void place_across(ref_id id, int r, int c, int row_span, int col_span) = 0;
+                virtual void widget_enable(ref_id, bool) = 0;
+                virtual bool is_widget_enabled(ref_id) = 0;
+
+                //grid
+                virtual void add_grid(ref_id) = 0;
+                virtual void grid_place(ref_id grid_id, ref_id widget_id, int r, int c) = 0;
+                virtual void grid_place_across(ref_id grid_id, ref_id widget_id, int r, int c, int row_span, int col_span) = 0;
+
+                //button
+                virtual void add_button(ref_id, const std::string&) = 0;
+                virtual std::string button_get_text(ref_id) = 0;
+                virtual void button_set_text(ref_id, const std::string&) = 0;
+                virtual void button_set_image(ref_id, ref_id image_id) = 0;
+
+                //make label
+                virtual void add_label(ref_id, const std::string& text) = 0;
+                virtual std::string label_get_text(ref_id) = 0;
+                virtual void label_set_text(ref_id, const std::string& text) = 0;
+
+                //edit
+                virtual void add_edit(ref_id, const std::string& text) = 0;
+                virtual std::string edit_get_text(ref_id) = 0;
+                virtual void edit_set_text(ref_id, const std::string& text) = 0;
+
+                //text edit
+                virtual void add_text_edit(ref_id, const std::string& text) = 0;
+                virtual std::string text_edit_get_text(ref_id) = 0;
+                virtual void text_edit_set_text(ref_id, const std::string& text) = 0;
+
+                //list
+                virtual void add_list(ref_id) = 0;
+                virtual void list_add(ref_id list_id, ref_id widget_id) = 0;
+                virtual void list_remove(ref_id list_id, ref_id widget_id) = 0;
+                virtual size_t list_size(ref_id) = 0;
+                virtual void list_clear(ref_id) = 0;
+
+                //pen
+                virtual void add_pen(ref_id, const std::string& color, int width) = 0;
+                virtual void pen_set_width(ref_id, int width) = 0;
+
+                //draw
+                virtual void add_draw(ref_id, int width, int height) = 0;
+                virtual void draw_line(ref_id, ref_id pen_id, double x1, double y1, double x2, double y2) = 0;
+                virtual void draw_circle(ref_id, ref_id pen_id, double x, double y, double r) = 0;
+                virtual void draw_image(ref_id, ref_id image_id, double x, double y, double w, double h) = 0;
+                virtual void draw_clear(ref_id id) = 0;
+
+                //timer
+                virtual void add_timer(ref_id, int msec) = 0;
+                virtual bool timer_running(ref_id id) = 0;
+                virtual void timer_stop(ref_id id) = 0;
+                virtual void timer_start(ref_id id) = 0;
+                virtual void timer_set_interval(ref_id, int msec) = 0;
+
+                //image
+                virtual bool add_image(ref_id, const util::bytes& d) = 0;
+                virtual int image_width(ref_id) = 0;
+                virtual int image_height(ref_id) = 0;
+
+                //mic
+                virtual void add_mic(ref_id, const std::string& codec) = 0;
+                virtual void mic_start(ref_id) = 0;
+                virtual void mic_stop(ref_id) = 0;
+
+                //speaker
+                virtual void add_speaker(ref_id, const std::string& codec) = 0;
+                virtual void speaker_mute(ref_id) = 0;
+                virtual void speaker_unmute(ref_id) = 0;
+                virtual void speaker_play(ref_id, const util::bytes&) = 0;
+
+                //file
+                virtual file_data open_file() = 0;
+                virtual bin_file_data open_bin_file() = 0;
+                virtual bool save_file(const std::string& suggested_name, const std::string& data) = 0;
+                virtual bool save_bin_file(const std::string& suggested_name, const util::bytes& data) = 0;
+
+                //debug
+                virtual void print(const std::string&) = 0;
+
+                //overall gui
+                virtual void height(int h) = 0;
+                virtual bool visible() = 0;
+                virtual void grow() = 0;
+
+                //errors
+                virtual void report_error(const std::string& e) = 0;
+
+                //control
+                virtual void reset() = 0;
+            };
+
+            struct backend
+            {
+                virtual void button_clicked(ref_id) = 0;
+                virtual void edit_edited(ref_id) = 0;
+                virtual void edit_finished(ref_id) = 0;
+                virtual void text_edit_edited(ref_id) = 0;
+                virtual void timer_triggered(ref_id) = 0;
+                virtual void got_sound(ref_id, const util::bytes&) = 0;
+                virtual void draw_mouse_pressed(ref_id, int button, int x, int y) = 0;
+                virtual void draw_mouse_released(ref_id, int button, int x, int y) = 0;
+                virtual void draw_mouse_dragged(ref_id, int button, int x, int y) = 0;
+                virtual void draw_mouse_moved(ref_id, int x, int y) = 0;
+            };
+
+        }
+    }
+}
+
+#endif
+
diff --git a/src/gui/app/app_editor.cpp b/src/gui/app/app_editor.cpp
@@ -352,14 +352,15 @@ namespace fire
                l->addWidget(_canvas, 0, 0, 1, 4);
                l->addWidget(_output, 1, 0, 1, 4);

+                _front = std::make_shared<qtw::qt_frontend>(_canvas, _canvas_layout, _output);
                _api = std::make_shared<l::lua_api>(
                        _app, 
                        _sender, 
                        _conversation, 
                        _conversation_service, 
-                        _canvas, 
-                        _canvas_layout, 
-                        _output);
+                        _front.get());
+
+                _front->set_backend(_api.get());

                //text edit
                _script = new app_text_editor{_api.get()};
@@ -398,6 +399,8 @@ namespace fire
                connect(t2, SIGNAL(timeout()), this, SLOT(update()));
                t2->start(TIMER_UPDATE);

+                INVARIANT(_front);
+                INVARIANT(_api);
                INVARIANT(_app);
                INVARIANT(_conversation);
                INVARIANT(_mail);
diff --git a/src/gui/app/app_editor.hpp b/src/gui/app/app_editor.hpp
@@ -39,6 +39,7 @@
 #include "message/mailbox.hpp"
 #include "messages/sender.hpp"
 #include "gui/lua/api.hpp"
+#include "gui/qtw/frontend.hpp"
 #include "gui/app/app_service.hpp"
 #include "util/crstring.hpp"

@@ -203,6 +204,7 @@ namespace fire
                    util::bytes _data_bytes;
                    list* _data_items;

+                    qtw::qt_frontend_ptr _front;
                    lua::lua_api_ptr _api;
                    app_ptr _app;
                    std::string _prev_code;
diff --git a/src/gui/app/script_app.cpp b/src/gui/app/script_app.cpp
@@ -153,9 +153,18 @@ namespace fire
                _canvas_layout = new QGridLayout{_canvas};
                layout()->addWidget(_canvas, 0,0,2,1);

+                _front = std::make_shared<qtw::qt_frontend>(_canvas, _canvas_layout, nullptr);
+
                _mail = std::make_shared<m::mailbox>(_id);
                _sender = std::make_shared<ms::sender>(_conversation->user_service(), _mail);
-                _api = std::make_shared<l::lua_api>(_app, _sender, _conversation, _conversation_service, _canvas, _canvas_layout);
+                _api = std::make_shared<l::lua_api>(
+                        _app, 
+                        _sender, 
+                        _conversation, 
+                        _conversation_service, 
+                        _front.get());
+
+                _front->set_backend(_api.get());
                _api->who_started_id = _from_id;

                //run script
@@ -167,6 +176,9 @@ namespace fire
                _mail_service = new mail_service{_mail, this};
                _mail_service->start();

+                INVARIANT(_api);
+                INVARIANT(_mail_service);
+                INVARIANT(_front);
                INVARIANT(_conversation);
                INVARIANT(_mail);
                INVARIANT(_sender);
diff --git a/src/gui/app/script_app.hpp b/src/gui/app/script_app.hpp
@@ -36,6 +36,7 @@
 #include "gui/app/app_service.hpp"
 #include "gui/list.hpp"
 #include "gui/lua/api.hpp"
+#include "gui/qtw/frontend.hpp"
 #include "gui/mail_service.hpp"
 #include "gui/message.hpp"

@@ -107,6 +108,7 @@ namespace fire

                private:
                    mail_service* _mail_service;
+                    qtw::qt_frontend_ptr _front;
                    lua::lua_api_ptr _api;
                    QWidget* _canvas;
                    QGridLayout* _canvas_layout;