DocumentWidget: Page load progress indicator

Show clearly that something is happening, even though we don't know the exact duration of the operation.

1 files changed, 158 insertions, 0 deletions

diff --git a/src/ui/indicatorwidget.c b/src/ui/indicatorwidget.c
new file mode 100644
index 00000000..d43e23d9
--- /dev/null
+++ b/src/ui/indicatorwidget.c
@@ -0,0 +1,158 @@
+/* Copyright 2020 Jaakko Keränen <jaakko.keranen@iki.fi>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. 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.
+
+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. */
+
+#include "indicatorwidget.h"
+#include "paint.h"
+#include "util.h"
+#include "app.h"
+#include "command.h"
+
+#include <SDL_timer.h>
+
+static int timerId_;   /* common timer for all indicators */
+static int animCount_; /* number of animating indicators */
+
+static uint32_t postRefresh_(uint32_t interval, void *context) {
+    iUnused(context);
+    postRefresh_App();
+    return interval;
+}
+
+static void startTimer_(void) {
+    animCount_++;
+    if (!timerId_) {
+        timerId_ = SDL_AddTimer(1000 / 60, postRefresh_, NULL);
+    }
+}
+
+static void stopTimer_(void) {
+    iAssert(animCount_ > 0);
+    if (--animCount_ == 0) {
+        iAssert(timerId_);
+        SDL_RemoveTimer(timerId_);
+        timerId_ = 0;
+    }
+}
+
+struct Impl_IndicatorWidget{
+    iWidget widget;
+    iAnim   pos;
+};
+
+iDefineObjectConstruction(IndicatorWidget)
+
+iLocalDef iBool isActive_IndicatorWidget_(const iIndicatorWidget *d) {
+    return isSelected_Widget(d);
+}
+
+static void setActive_IndicatorWidget_(iIndicatorWidget *d, iBool set) {
+    setFlags_Widget(as_Widget(d), selected_WidgetFlag, set);
+}
+
+void init_IndicatorWidget(iIndicatorWidget *d) {
+    iWidget *w = &d->widget;
+    init_Widget(w);
+    init_Anim(&d->pos, 0);
+}
+
+static void startTimer_IndicatorWidget_(iIndicatorWidget *d) {
+    if (!isActive_IndicatorWidget_(d)) {
+        startTimer_();
+        setActive_IndicatorWidget_(d, iTrue);
+    }
+}
+
+static void stopTimer_IndicatorWidget_(iIndicatorWidget *d) {
+    if (isActive_IndicatorWidget_(d)) {
+        stopTimer_();
+        setActive_IndicatorWidget_(d, iFalse);
+    }
+}
+
+void deinit_IndicatorWidget(iIndicatorWidget *d) {
+    stopTimer_IndicatorWidget_(d);
+}
+
+static iBool isCompleted_IndicatorWidget_(const iIndicatorWidget *d) {
+    return targetValue_Anim(&d->pos) == 1.0f;
+}
+
+void draw_IndicatorWidget_(const iIndicatorWidget *d) {
+    const float pos = value_Anim(&d->pos);
+    if (pos > 0.0f && pos < 1.0f) {
+        const iWidget *w = &d->widget;
+        const iRect rect = innerBounds_Widget(w);
+        iPaint p;
+        init_Paint(&p);
+        drawHLine_Paint(&p,
+                        topLeft_Rect(rect),
+                        pos * width_Rect(rect),
+                        isCompleted_IndicatorWidget_(d) ? uiTextAction_ColorId
+                                                        : uiTextCaution_ColorId);
+    }
+}
+
+iBool processEvent_IndicatorWidget_(iIndicatorWidget *d, const SDL_Event *ev) {
+    iWidget *w = &d->widget;
+    if (ev->type == SDL_USEREVENT && ev->user.code == refresh_UserEventCode) {
+        if (isFinished_Anim(&d->pos)) {
+            stopTimer_IndicatorWidget_(d);
+        }
+    }
+    else if (isCommand_SDLEvent(ev)) {
+        const char *cmd = command_UserEvent(ev);
+        if (startsWith_CStr(cmd, "document.request.")) {
+            if (pointerLabel_Command(cmd, "doc") == parent_Widget(w)) {
+                cmd += 17;
+                if (equal_Command(cmd, "started")) {
+                    setValue_Anim(&d->pos, 0, 0);
+                    setValue_Anim(&d->pos, 0.75f, 4000);
+                    setFlags_Anim(&d->pos, easeOut_AnimFlag, iTrue);
+                    startTimer_IndicatorWidget_(d);
+                }
+                else if (equal_Command(cmd, "finished")) {
+                    if (value_Anim(&d->pos) > 0.01f) {
+                        setValue_Anim(&d->pos, 1.0f, 250);
+                        setFlags_Anim(&d->pos, easeOut_AnimFlag, iFalse);
+                        startTimer_IndicatorWidget_(d);
+                    }
+                    else {
+                        setValue_Anim(&d->pos, 0, 0);
+                        stopTimer_IndicatorWidget_(d);
+                        refresh_Widget(d);
+                    }
+                }
+                else if (equal_Command(cmd, "cancelled")) {
+                    setValue_Anim(&d->pos, 0, 0);
+                    stopTimer_IndicatorWidget_(d);
+                    refresh_Widget(d);
+                }
+            }
+        }
+    }
+    return iFalse;
+}
+
+iBeginDefineSubclass(IndicatorWidget, Widget)
+    .draw         = (iAny *) draw_IndicatorWidget_,
+    .processEvent = (iAny *) processEvent_IndicatorWidget_,
+iEndDefineSubclass(IndicatorWidget)