summaryrefslogtreecommitdiff
path: root/src/glibext/singleton.c
blob: f0ce86fc3d681ac87d426b29364451b3f0760015 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * singleton.c - réduction du nombre d'instances d'un même type
 *
 * Copyright (C) 2021 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "singleton.h"


#include <assert.h>


#include "singleton-int.h"



/* ------------------ INTERFACE POUR CANDIDAT A UNE CENTRALISATION ------------------ */

/* Procède à l'initialisation de l'interface de rassemblement. */
static void g_singleton_candidate_default_init(GSingletonCandidateInterface *);



/* ------------------------- COLLECTION D'INSTANCES UNIQUES ------------------------- */


/* Définition d'un compacteur d'instances de types (instance) */
struct _GSingletonFactory
{
    GObject parent;                         /* A laisser en premier        */

    GHashTable *table;                      /* Suivi des conservations     */
    GMutex access;                          /* Verrou pour la concurrence  */

};

/* Définition d'un compacteur d'instances de types (classe) */
struct _GSingletonFactoryClass
{
    GObjectClass parent;                    /* A laisser en premier        */

};


/* Initialise la classe des compacteurs d'instances de types. */
static void g_singleton_factory_class_init(GSingletonFactoryClass *);

/* Initialise une instance de compacteur d'instances de types. */
static void g_singleton_factory_init(GSingletonFactory *);

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

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



/* ---------------------------------------------------------------------------------- */
/*                    INTERFACE POUR CANDIDAT A UNE CENTRALISATION                    */
/* ---------------------------------------------------------------------------------- */


/* Détermine le type d'une interface pour la lecture de binaire. */
G_DEFINE_INTERFACE(GSingletonCandidate, g_singleton_candidate, G_TYPE_OBJECT)


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

static void g_singleton_candidate_default_init(GSingletonCandidateInterface *iface)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : candidate = objet dont l'instance se veut unique.            *
*                                                                             *
*  Description : Fournit l'empreinte d'un candidat à une centralisation.      *
*                                                                             *
*  Retour      : Empreinte de l'élément représenté.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

guint g_singleton_candidate_hash(const GSingletonCandidate *candidate)
{
    guint result;                           /* Valeur à retourner          */
    GSingletonCandidateIface *iface;        /* Interface utilisée          */

    iface = G_SINGLETON_CANDIDATE_GET_IFACE(candidate);

    result = iface->hash(candidate);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : candidate = objet dont l'instance se veut unique.            *
*                other     = second élément à analyser.                       *
*                                                                             *
*  Description : Détermine si deux candidats à l'unicité sont identiques.     *
*                                                                             *
*  Retour      : Bilan de la comparaison.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

gboolean g_singleton_candidate_is_equal(const GSingletonCandidate *candidate, const GSingletonCandidate *other)
{
    gboolean result;                        /* Bilan à renvoyer            */
    GSingletonCandidateIface *iface;        /* Interface utilisée          */

    iface = G_SINGLETON_CANDIDATE_GET_IFACE(candidate);

    result = iface->is_equal(candidate, other);

    return result;

}



/******************************************************************************
*                                                                             *
*  Paramètres  : candidate = objet dont l'instance se veut unique.            *
*                soon      = indique un traitement démarré et en cours.       *
*                                                                             *
*  Description : Marque un candidat comme traité ou en cours de traitement.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_singleton_candidate_mark_as_processed(GSingletonCandidate *candidate, bool soon)
{
    GSingletonCandidateIface *iface;        /* Interface utilisée          */

    iface = G_SINGLETON_CANDIDATE_GET_IFACE(candidate);

    iface->mark(candidate, soon);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : candidate = objet dont l'instance se veut unique.            *
*                soon      = indique un traitement démarré et en cours.       *
*                                                                             *
*  Description : Indique si un objet marqué comme unique.                     *
*                                                                             *
*  Retour      : true si l'objet est traité ou en phase de l'être, ou false.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_singleton_candidate_is_processed(const GSingletonCandidate *candidate, bool soon)
{
    bool result;                            /* Statut à retourner          */
    GSingletonCandidateIface *iface;        /* Interface utilisée          */

    iface = G_SINGLETON_CANDIDATE_GET_IFACE(candidate);

    result = iface->is_processed(candidate, soon);

    return result;


}



/* ---------------------------------------------------------------------------------- */
/*                           COLLECTION D'INSTANCES UNIQUES                           */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour une mémoire de types d'objets. */
G_DEFINE_TYPE(GSingletonFactory, g_singleton_factory, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des compacteurs d'instances de types.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_singleton_factory_class_init(GSingletonFactoryClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_singleton_factory_dispose;
    object->finalize = (GObjectFinalizeFunc)g_singleton_factory_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : factory = instance à initialiser.                            *
*                                                                             *
*  Description : Initialise une instance de compacteur d'instances de types.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_singleton_factory_init(GSingletonFactory *factory)
{
    factory->table = g_hash_table_new_full((GHashFunc)g_singleton_candidate_hash,
                                           (GEqualFunc)g_singleton_candidate_is_equal,
                                           g_object_unref, NULL);

    g_mutex_init(&factory->access);

}


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

static void g_singleton_factory_dispose(GSingletonFactory *factory)
{
    if (factory->table != NULL)
    {
        g_hash_table_unref(factory->table);
        factory->table = NULL;
    }

    G_OBJECT_CLASS(g_singleton_factory_parent_class)->dispose(G_OBJECT(factory));

}


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

static void g_singleton_factory_finalize(GSingletonFactory *factory)
{
    g_mutex_clear(&factory->access);

    G_OBJECT_CLASS(g_singleton_factory_parent_class)->finalize(G_OBJECT(factory));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Crée un compacteur d'instances de types.                     *
*                                                                             *
*  Retour      : Instance mise en place.                                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GSingletonFactory *g_singleton_factory_new(void)
{
    GSingletonFactory *result;                    /* Structure à retourner       */

    result = g_object_new(G_TYPE_SINGLETON_FACTORY, NULL);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : factory   = gestionnaire d'instances uniques à consulter.    *
*                candidate = instance à conserver ou oublier.                 *
*                                                                             *
*  Description : Fournit l'instance unique correspondant à un objet.          *
*                                                                             *
*  Retour      : Instance unique à utiliser.                                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GSingletonCandidate *g_singleton_factory_get_instance(GSingletonFactory *factory, GSingletonCandidate *candidate)
{
    GSingletonCandidate *result;            /* Instance unique à retourner */
#ifndef NDEBUG
    gboolean status;                         /* Validation d'une opération */
#endif

    g_mutex_lock(&factory->access);

    if (g_hash_table_contains(factory->table, candidate))
    {
#ifndef NDEBUG
        status = g_hash_table_lookup_extended(factory->table, candidate, (void **)&result, NULL);
        assert(status);
#else
        g_hash_table_lookup_extended(factory->table, candidate, (void **)&result, NULL);
#endif

    }

    else
    {
        g_object_ref(G_OBJECT(candidate));

#ifndef NDEBUG
        status = g_hash_table_add(factory->table, candidate);
        assert(status);
#else
        g_hash_table_add(factory->table, candidate);
#endif

        result = candidate;

    }

    g_object_ref(G_OBJECT(result));

    g_mutex_unlock(&factory->access);

    return result;

}