summaryrefslogtreecommitdiff
path: root/src/gui/panels/updating.c
blob: 31f42c310033d111954ff91b1b6f8f2b2537d81a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491

/* Chrysalide - Outil d'analyse de fichiers binaires
 * updating.c - mise à jour des panneaux de l'interface
 *
 * Copyright (C) 2018 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide 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.
 *
 *  Chrysalide 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 Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "updating.h"


#include <malloc.h>


#include "updating-int.h"
#include "../../core/global.h"
#include "../../glibext/delayed-int.h"
#include "../../glibext/signal.h"



/* ---------------------- MECANISMES DE MISE A JOUR DE PANNEAU ---------------------- */


/* Procède à l'initialisation de l'interface de mise à jour. */
static void g_updatable_panel_default_init(GUpdatablePanelInterface *);



/* ---------------------------- AIDE POUR LA MISE A JOUR ---------------------------- */


/* Procédure de mise à jour de panneau graphique (instance) */
struct _GPanelUpdate
{
    GDelayedWork parent;                    /* A laisser en premier        */

    GUpdatablePanel *panel;                 /* Panneau à manipuler         */
    unsigned int uid;                       /* Identifiant complémentaire  */

    size_t max;                             /* Marge de progression finale */
    void *data;                             /* Données utiles au traitement*/
    const char *msg;                        /* Description d'activité      */

};

/* Procédure de mise à jour de panneau graphique (classe) */
struct _GPanelUpdateClass
{
    GDelayedWorkClass parent;               /* A laisser en premier        */

};


/* Initialise la classe des tâches des mises à jour de panneaux. */
static void g_panel_update_class_init(GPanelUpdateClass *);

/* Initialise une tâche d'étude de mise à jour. */
static void g_panel_update_init(GPanelUpdate *);

/* Supprime toutes les références externes. */
static void g_panel_update_dispose(GPanelUpdate *);

/* Procède à la libération totale de la mémoire. */
static void g_panel_update_finalize(GPanelUpdate *);

/* Assure la mise à jour d'un panneau en différé. */
static void g_panel_update_process(GPanelUpdate *, GtkStatusStack *);

/* Marque l'achèvement d'une mise à jour de panneau. */
static void conclude_panel_update(GPanelUpdate *, GUpdatablePanel *);



/* ---------------------------------------------------------------------------------- */
/*                        MECANISMES DE MISE A JOUR DE PANNEAU                        */
/* ---------------------------------------------------------------------------------- */


/* Détermine le type d'une interface pour la mise à jour de panneau. */
G_DEFINE_INTERFACE(GUpdatablePanel, g_updatable_panel, G_TYPE_OBJECT)


/******************************************************************************
*                                                                             *
*  Paramètres  : iface = interface GLib à initialiser.                        *
*                                                                             *
*  Description : Procède à l'initialisation de l'interface de mise à jour.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_updatable_panel_default_init(GUpdatablePanelInterface *iface)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau ciblé par une mise à jour.                   *
*                uid   = identifiant de la phase de traitement.               *
*                count = nombre d'étapes à prévoir dans le traitement. [OUT]  *
*                data  = données sur lesquelles s'appuyer ensuite. [OUT]      *
*                                                                             *
*  Description : Prépare une opération de mise à jour de panneau.             *
*                                                                             *
*  Retour      : Description du message d'information.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_updatable_panel_setup(const GUpdatablePanel *panel, unsigned int uid, size_t *count, void **data)
{
    GUpdatablePanelIface *iface;            /* Interface utilisée          */

    iface = G_UPDATABLE_PANEL_GET_IFACE(panel);

    *data = NULL;

    return iface->setup(panel, uid, count, data);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau ciblé par une mise à jour.                   *
*                                                                             *
*  Description : Obtient le groupe de travail dédié à une mise à jour.        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

wgroup_id_t g_updatable_panel_get_group(const GUpdatablePanel *panel)
{
    wgroup_id_t result;                     /* Identifiant à retourner     */
    GUpdatablePanelIface *iface;            /* Interface utilisée          */

    iface = G_UPDATABLE_PANEL_GET_IFACE(panel);

    result = iface->get_group(panel);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau ciblé par une mise à jour.                   *
*                uid   = identifiant de la phase de traitement.               *
*                data  = données préparées par l'appelant.                    *
*                                                                             *
*  Description : Bascule l'affichage d'un panneau avant mise à jour.          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : Cette fonction est appelée depuis le contexte principal.     *
*                                                                             *
******************************************************************************/

void g_updatable_panel_introduce(const GUpdatablePanel *panel, unsigned int uid, void *data)
{
    GUpdatablePanelIface *iface;            /* Interface utilisée          */

    iface = G_UPDATABLE_PANEL_GET_IFACE(panel);

    iface->introduce(panel, uid, data);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel  = panneau ciblé par une mise à jour.                  *
*                uid    = identifiant de la phase de traitement.              *
*                status = barre de statut à tenir informée.                   *
*                id     = identifiant pour le suivi de la progression.        *
*                data   = données préparées par l'appelant.                   *
*                                                                             *
*  Description : Réalise une opération de mise à jour de panneau.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_updatable_panel_process(const GUpdatablePanel *panel, unsigned int uid, GtkStatusStack *status, activity_id_t id, void *data)
{
    GUpdatablePanelIface *iface;            /* Interface utilisée          */

    iface = G_UPDATABLE_PANEL_GET_IFACE(panel);

    iface->process(panel, uid, status, id, data);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau ciblé par une mise à jour.                   *
*                uid   = identifiant de la phase de traitement.               *
*                data  = données préparées par l'appelant.                    *
*                                                                             *
*  Description : Bascule l'affichage d'un panneau après mise à jour.          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : Cette fonction est appelée depuis le contexte principal.     *
*                                                                             *
******************************************************************************/

void g_updatable_panel_conclude(GUpdatablePanel *panel, unsigned int uid, void *data)
{
    GUpdatablePanelIface *iface;            /* Interface utilisée          */

    iface = G_UPDATABLE_PANEL_GET_IFACE(panel);

    iface->conclude(panel, uid, data);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = panneau ciblé par une mise à jour.                   *
*                uid   = identifiant de la phase de traitement.               *
*                data  = données en place à nettoyer avant suppression.       *
*                                                                             *
*  Description : Supprime les données dynamiques utilisées à la mise à jour.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_updatable_panel_clean_data(GUpdatablePanel *panel, unsigned int uid, void *data)
{
    GUpdatablePanelIface *iface;            /* Interface utilisée          */

    iface = G_UPDATABLE_PANEL_GET_IFACE(panel);

    if (iface->clean != NULL && data != NULL)
        iface->clean(panel, uid, data);

}



/* ---------------------------------------------------------------------------------- */
/*                              AIDE POUR LA MISE A JOUR                              */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour les tâches de mise à jour de panneau. */
G_DEFINE_TYPE(GPanelUpdate, g_panel_update, G_TYPE_DELAYED_WORK);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des tâches des mises à jour de panneaux.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_panel_update_class_init(GPanelUpdateClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */
    GDelayedWorkClass *work;                /* Version en classe parente   */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_panel_update_dispose;
    object->finalize = (GObjectFinalizeFunc)g_panel_update_finalize;

    work = G_DELAYED_WORK_CLASS(klass);

    work->run = (run_task_fc)g_panel_update_process;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : update = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise une tâche d'étude de mise à jour.                 *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_panel_update_init(GPanelUpdate *update)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : update = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_panel_update_dispose(GPanelUpdate *update)
{
    g_object_unref(G_OBJECT(update->panel));

    G_OBJECT_CLASS(g_panel_update_parent_class)->dispose(G_OBJECT(update));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : update = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_panel_update_finalize(GPanelUpdate *update)
{
    g_updatable_panel_clean_data(update->panel, update->uid, update->data);

    if (update->data != NULL)
        free(update->data);

    G_OBJECT_CLASS(g_panel_update_parent_class)->finalize(G_OBJECT(update));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = interface permettant une mise à jour de panneau.     *
*                uid   = identifiant à associer à la procédure.               *
*                                                                             *
*  Description : Crée une tâche de mise à jour non bloquante.                 *
*                                                                             *
*  Retour      : Tâche créée.                                                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GPanelUpdate *g_panel_update_new(GUpdatablePanel *panel, unsigned int uid)
{
    GPanelUpdate *result;                   /* Tâche à retourner           */

    result = g_object_new(G_TYPE_PANEL_UPDATE, NULL);

    g_object_ref(G_OBJECT(panel));
    result->panel = panel;

    result->uid = uid;

    result->msg = g_updatable_panel_setup(panel, uid, &result->max, &result->data);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : update = opération de mise à jour à mener.                   *
*                status = barre de statut à tenir informée.                   *
*                                                                             *
*  Description : Assure la mise à jour d'un panneau en différé.               *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_panel_update_process(GPanelUpdate *update, GtkStatusStack *status)
{
    activity_id_t id;                       /* Identifiant de progression  */

    id = gtk_status_stack_add_activity(status, update->msg, update->max);

    g_updatable_panel_process(update->panel, update->uid, status, id, update->data);

    gtk_status_stack_remove_activity(status, id);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : update = tâche venant de se terminer.                        *
*                panel  = interface visée par la procédure.                   *
*                                                                             *
*  Description : Marque l'achèvement d'une mise à jour de panneau.            *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void conclude_panel_update(GPanelUpdate *update, GUpdatablePanel *panel)
{
    g_updatable_panel_conclude(panel, update->uid, update->data);

}



/* ---------------------------------------------------------------------------------- */
/*                            ENCAPSULATION DE HAUT NIVEAU                            */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = interface permettant une mise à jour de panneau.     *
*                uid   = identifiant à associer à la procédure.               *
*                                                                             *
*  Description : Prépare et lance l'actualisation d'un panneau.               *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : Cette fonction est à appeler depuis le contexte principal.   *
*                                                                             *
******************************************************************************/

void run_panel_update(GUpdatablePanel *panel, unsigned int uid)
{
    GWorkQueue *queue;                      /* Gestionnaire de tâches      */
    wgroup_id_t gid;                        /* Groupe de travail à utiliser*/
    GPanelUpdate *update;                   /* Procédure de mise à jour    */

    update = g_panel_update_new(panel, uid);

    g_signal_connect_to_main(update, "work-completed", G_CALLBACK(conclude_panel_update), panel,
                             g_cclosure_marshal_VOID__VOID);

    g_updatable_panel_introduce(panel, uid, update->data);

    queue = get_work_queue();

    gid = g_updatable_panel_get_group(panel);

    g_work_queue_schedule_work(queue, G_DELAYED_WORK(update), gid);

}