summaryrefslogtreecommitdiff
path: root/src/gui/panels/log.c
blob: 607269c8fb24bb499f96974b4218409c0a5eeddc (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
492
493
494
495
496
497

/* Chrysalide - Outil d'analyse de fichiers binaires
 * log.c - panneau d'affichage des messages système
 *
 * Copyright (C) 2009-2013 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "log.h"


#include <malloc.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <gtk/gtk.h>


#include "panel-int.h"
#include "../core/panels.h"



/* Colonnes de la liste des messages */
typedef enum _LogColumn
{
    LGC_PICTURE,                            /* Image de représentation     */
    LGC_STRING,                             /* Chaîne de caractères        */

    LGC_COUNT                               /* Nombre de colonnes          */

} LogColumn;


/* Paramètres à transmettre pour un affichage */
typedef struct _log_data
{
    GPanelItem *item;                       /* Intermédiaire mis en place  */
    LogMessageType type;                    /* Type de message à afficher  */
    char *msg;                              /* Contenu du message          */

} log_data;

/* Paramètres à transmettre pour un défilement */
typedef struct _scroll_data
{
    GtkTreeView *treeview;                  /* Affichage de la liste       */
    GtkTreePath *path;                      /* Chemin d'accès à cibler     */

} scroll_data;


/* Panneau d'accueil (instance) */
struct _GLogPanel
{
    GPanelItem parent;                      /* A laisser en premier        */

};


/* Panneau d'accueil (classe) */
struct _GLogPanelClass
{
    GPanelItemClass parent;                 /* A laisser en premier        */

};


/* Initialise la classe des panneaux d'affichage des messages. */
static void g_log_panel_class_init(GLogPanelClass *);

/* Initialise une instance de panneau d'affichage des messages. */
static void g_log_panel_init(GLogPanel *);

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

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

/* Affiche un message dans le journal des messages système. */
static void _log_simple_message(LogMessageType, char *);

/* Affiche un message dans le journal des messages système. */
static gboolean log_message(log_data *);



/* Indique le type définit pour un panneau d'affichage de messages. */
G_DEFINE_TYPE(GLogPanel, g_log_panel, G_TYPE_PANEL_ITEM);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des panneaux d'affichage des messages.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_log_panel_class_init(GLogPanelClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */
    GPanelItemClass *panel;                 /* Version parente de la classe*/

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_log_panel_dispose;
    object->finalize = (GObjectFinalizeFunc)g_log_panel_finalize;

    panel = G_PANEL_ITEM_CLASS(klass);

    panel->unique = true;
    panel->bindings = "<Shift>F1";

}


/******************************************************************************
*                                                                             *
*  Paramètres  : panel = instance à initialiser.                              *
*                                                                             *
*  Description : Initialise une instance de panneau d'affichage des messages. *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_log_panel_init(GLogPanel *panel)
{
    GEditorItem *base;                      /* Version basique d'instance  */
    GPanelItem *pitem;                      /* Version parente du panneau  */
    GtkWidget *scrolled;                    /* Fenêtre avec défilements    */
    GtkTreeStore *store;                    /* Modèle de gestion           */
    GtkWidget *treeview;                    /* Affichage de la liste       */
    GtkCellRenderer *renderer;              /* Moteur de rendu de colonne  */
    GtkTreeViewColumn *column;              /* Colonne de la liste         */

    /* Eléments de base */

    base = G_EDITOR_ITEM(panel);

    base->name = PANEL_LOG_ID;

    pitem = G_PANEL_ITEM(panel);

    pitem->personality = PIP_SINGLETON;
    pitem->lname = _("Misc information");
    pitem->dock_at_startup = true;
    pitem->path = strdup("S");

    /* Représentation graphique */

    scrolled = gtk_scrolled_window_new(NULL, NULL);
    gtk_widget_show(scrolled);

    base->widget = scrolled;

    /* Construction graphique */

    gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
    gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);

    store = gtk_tree_store_new(LGC_COUNT, G_TYPE_STRING, G_TYPE_STRING);
    g_object_set_data(G_OBJECT(scrolled), "store", store);

    treeview = gtk_tree_view_new_with_model(GTK_TREE_MODEL(store));
    g_object_set_data(G_OBJECT(scrolled), "treeview", treeview);
    gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(treeview), FALSE);
    gtk_widget_show(treeview);
    gtk_container_add(GTK_CONTAINER(scrolled), treeview);

    g_object_unref(G_OBJECT(store));

    column = gtk_tree_view_column_new();
    gtk_tree_view_column_set_visible(column, FALSE);
    gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);
    gtk_tree_view_set_expander_column(GTK_TREE_VIEW(treeview), column);

    column = gtk_tree_view_column_new();

    renderer = gtk_cell_renderer_pixbuf_new();
    gtk_tree_view_column_pack_start(column, renderer, FALSE);
    gtk_tree_view_column_add_attribute(column, renderer, "stock-id", LGC_PICTURE);

    renderer = gtk_cell_renderer_text_new();
    gtk_tree_view_column_pack_start(column, renderer, TRUE);
    gtk_tree_view_column_add_attribute(column, renderer, "markup", LGC_STRING);

    gtk_tree_view_append_column(GTK_TREE_VIEW(treeview), column);

}


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

static void g_log_panel_dispose(GLogPanel *panel)
{
    G_OBJECT_CLASS(g_log_panel_parent_class)->dispose(G_OBJECT(panel));

}


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

static void g_log_panel_finalize(GLogPanel *panel)
{
    G_OBJECT_CLASS(g_log_panel_parent_class)->finalize(G_OBJECT(panel));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Crée un panneau d'affichage des messages système.            *
*                                                                             *
*  Retour      : Adresse de la structure mise en place.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GPanelItem *g_log_panel_new(void)
{
    GPanelItem *result;                     /* Structure à retourner       */

    result = g_object_new(G_TYPE_LOG_PANEL, NULL);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = espèce du message à ajouter.                          *
*                msg  = message à faire apparaître à l'écran.                 *
*                                                                             *
*  Description : Affiche un message dans le journal des messages système.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void log_simple_message(LogMessageType type, const char *msg)
{
    _log_simple_message(type, strdup(msg));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = espèce du message à ajouter.                          *
*                msg  = message à faire apparaître à l'écran.                 *
*                                                                             *
*  Description : Affiche un message dans le journal des messages système.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void _log_simple_message(LogMessageType type, char *msg)
{
    GPanelItem *item;                       /* Intermédiaire mis en place  */
    log_data *data;                         /* Paramètres à joindre        */

    item = get_panel_item_by_name(PANEL_LOG_ID);

    data = (log_data *)calloc(1, sizeof(log_data));

    data->item = item;
    data->type = type;
    data->msg = msg;

    g_object_ref(G_OBJECT(data->item));

    g_main_context_invoke(NULL, (GSourceFunc)log_message, data);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : type = espèce du message à ajouter.                          *
*                fmt  = format du message à faire apparaître à l'écran.       *
*                ...  = éventuels arguments venant compléter le message.      *
*                                                                             *
*  Description : Affiche un message dans le journal des messages système.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void log_variadic_message(LogMessageType type, const char *fmt, ...)
{
    size_t len;                             /* Taille tampon disponible    */
    char *buffer;                           /* Tampon du msg reconstitué   */
    int ret;                                /* Bilan d'une impression      */
    char *ptr;                              /* Nouvelle allocation         */
    va_list ap;                             /* Liste d'arguments variable  */

    len = VARIADIC_LOG_BUFSIZE;
    buffer = calloc(len, sizeof(char));

    while (buffer != NULL)
    {
        va_start(ap, fmt);
        ret = vsnprintf(buffer, len, fmt, ap);
        va_end(ap);

        if (ret >= 0 && ret < len) break;

        else
        {
            if (ret > -1) len += 1;     /* glibc 2.1 */
            else len *= 2;              /* glibc 2.0 */

            if ((ptr = realloc(buffer, len)) == NULL)
            {
                free(buffer);
                buffer = NULL;
            }
            else buffer = ptr;

        }

    }

    _log_simple_message(type, buffer);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : data = paramètres destinés à l'affichage d'un message.       *
*                                                                             *
*  Description : Affiche un message dans le journal des messages système.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : Cette fonction, et c'est tout son intérêt, est toujours      *
*                exécutée dans le contexte GTK principal.                     *
*                                                                             *
******************************************************************************/

static gboolean log_message(log_data *data)
{
    GtkWidget *panel;                       /* Panneau à traiter           */
    GtkTreeStore *store;                    /* Modèle de gestion           */
    GtkTreeIter iter;                       /* Point d'insertion           */
    GtkTreeView *treeview;                  /* Affichage de la liste       */
    GtkTreePath *path;                      /* Chemin d'accès à la ligne   */
    scroll_data *sdata;                     /* Paramètres de défilement    */

    /* Mise en place du message */

    panel = g_editor_item_get_widget(G_EDITOR_ITEM(data->item));

    store = g_object_get_data(G_OBJECT(panel), "store");

    gtk_tree_store_append(store, &iter, NULL);

    switch (data->type)
    {
        case LMT_INFO:
            gtk_tree_store_set(store, &iter,
                               LGC_PICTURE, "gtk-info",
                               LGC_STRING, data->msg,
                               -1);
            break;

        case LMT_BAD_BINARY:
            gtk_tree_store_set(store, &iter,
                               LGC_PICTURE, "gtk-dialog-warning",
                               LGC_STRING, data->msg,
                               -1);
            break;

        case LMT_PROCESS:
            gtk_tree_store_set(store, &iter,
                               LGC_PICTURE, "gtk-execute",
                               LGC_STRING, data->msg,
                               -1);
            break;

        case LMT_ERROR:
            gtk_tree_store_set(store, &iter,
                               LGC_PICTURE, "gtk-dialog-error",
                               LGC_STRING, data->msg,
                               -1);
            break;

        case LMT_WARNING:
            gtk_tree_store_set(store, &iter,
                               LGC_PICTURE, "gtk-dialog-warning",
                               LGC_STRING, data->msg,
                               -1);
            break;

        default:
            gtk_tree_store_set(store, &iter,
                               LGC_STRING, data->msg,
                               -1);
            break;

    }

    /* Défilement pour pointer à l'affichage */

    gboolean wait_for_scrolling(scroll_data *_data)
    {
        gtk_tree_view_scroll_to_cell(_data->treeview, _data->path, NULL, FALSE, 0.0, 0.0);

        g_object_unref(G_OBJECT(_data->treeview));
        gtk_tree_path_free(_data->path);

        free(_data);

        return G_SOURCE_REMOVE;

    }

    treeview = GTK_TREE_VIEW(g_object_get_data(G_OBJECT(panel), "treeview"));
    path = gtk_tree_model_get_path(GTK_TREE_MODEL(store), &iter);

    sdata = (scroll_data *)calloc(1, sizeof(log_data));

    sdata->treeview = treeview;
    sdata->path = path;

    g_object_ref(G_OBJECT(sdata->treeview));

    g_idle_add((GSourceFunc)wait_for_scrolling, sdata);

    /* Nettoyage de la mémoire */

    g_object_unref(G_OBJECT(data->item));

    free(data->msg);

    free(data);

    return G_SOURCE_REMOVE;

}