aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/text/e-completion.c
blob: 1c0f1804b9e83c7863b65ac3ad343863f4a8f605 (plain) (blame)
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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-completion.c - A base class for text completion.
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Miguel de Icaza <miguel@ximian.com>
 *   Adapted by Jon Trowbridge <trow@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#include <config.h>

#include <string.h>
#include <stdio.h>

#include <gtk/gtk.h>

#include "e-util/e-util-marshal.h"
#include "e-util/e-util.h"

#include "e-completion.h"

enum {
    COMPLETION_STARTED,
    COMPLETION_FOUND,
    COMPLETION_CANCELED,
    COMPLETION_FINISHED,
    LAST_SIGNAL
};

static guint e_completion_signals[LAST_SIGNAL] = { 0 };

struct _ECompletionPrivate {
    gboolean searching;
    gboolean done_search;
    gchar *search_text;
    GPtrArray *matches;
    gint pos;
    gint limit;
    double min_score, max_score;
};

static void e_completion_class_init (ECompletionClass *klass);
static void e_completion_init       (ECompletion *complete);
static void e_completion_dispose    (GObject *object);

static void     e_completion_add_match          (ECompletion *complete, ECompletionMatch *);
static void     e_completion_clear_matches      (ECompletion *complete);
#if 0
static gboolean e_completion_sort               (ECompletion *complete);
#endif

G_DEFINE_TYPE (ECompletion, e_completion, GTK_TYPE_OBJECT)

static void
e_completion_class_init (ECompletionClass *klass)
{
    GObjectClass *object_class = (GObjectClass *) klass;

    e_completion_signals[COMPLETION_STARTED] =
        g_signal_new ("completion_started",
                  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (ECompletionClass, completion_started),
                  NULL, NULL,
                  e_util_marshal_NONE__POINTER_INT_INT,
                  G_TYPE_NONE, 3,
                  G_TYPE_POINTER, G_TYPE_INT, G_TYPE_INT);

    e_completion_signals[COMPLETION_FOUND] =
        g_signal_new ("completion_found",
                  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (ECompletionClass, completion_found),
                  NULL, NULL,
                  e_util_marshal_NONE__POINTER,
                  G_TYPE_NONE, 1,
                  G_TYPE_POINTER);

    e_completion_signals[COMPLETION_FINISHED] =
        g_signal_new ("completion_finished",
                  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (ECompletionClass, completion_finished),
                  NULL, NULL,
                  e_util_marshal_NONE__NONE,
                  G_TYPE_NONE, 0);

    object_class->dispose = e_completion_dispose;
}

static void
e_completion_init (ECompletion *complete)
{
    complete->priv = g_new0 (struct _ECompletionPrivate, 1);
    complete->priv->matches = g_ptr_array_new ();
}

static void
e_completion_dispose (GObject *object)
{
    ECompletion *complete = E_COMPLETION (object);

    if (complete->priv) {
        g_free (complete->priv->search_text);
        complete->priv->search_text = NULL;

        e_completion_clear_matches (complete);

        g_ptr_array_free (complete->priv->matches, TRUE);
        complete->priv->matches = NULL;

        g_free (complete->priv);
        complete->priv = NULL;
    }

    if (G_OBJECT_CLASS (e_completion_parent_class)->dispose)
        (G_OBJECT_CLASS (e_completion_parent_class)->dispose) (object);
}

static void
e_completion_add_match (ECompletion *complete, ECompletionMatch *match)
{
    g_return_if_fail (complete && E_IS_COMPLETION (complete));
    g_return_if_fail (match != NULL);

    g_ptr_array_add (complete->priv->matches, match);

    if (complete->priv->matches->len == 1) {

        complete->priv->min_score = complete->priv->max_score = match->score;
        
    } else {

        complete->priv->min_score = MIN (complete->priv->min_score, match->score);
        complete->priv->max_score = MAX (complete->priv->max_score, match->score);

    }
}

static void
e_completion_clear_matches (ECompletion *complete)
{
    ECompletionMatch *match;
    GPtrArray *m;
    int i;

    g_return_if_fail (E_IS_COMPLETION (complete));

    m = complete->priv->matches;
    for (i = 0; i < m->len; i++) {
        match = g_ptr_array_index (m, i);
        e_completion_match_unref (match);
    }
    g_ptr_array_set_size (m, 0);

    complete->priv->min_score = 0;
    complete->priv->max_score = 0;
}

void
e_completion_begin_search (ECompletion *complete, const gchar *text, gint pos, gint limit)
{
    ECompletionClass *klass;

    g_return_if_fail (complete != NULL);
    g_return_if_fail (E_IS_COMPLETION (complete));
    g_return_if_fail (text != NULL);

    klass = E_COMPLETION_CLASS (GTK_OBJECT_GET_CLASS (complete));

    g_free (complete->priv->search_text);
    complete->priv->search_text = g_strdup (text);

    complete->priv->pos = pos;
    complete->priv->searching = TRUE;
    complete->priv->done_search = FALSE;

    e_completion_clear_matches (complete);

    complete->priv->limit = limit > 0 ? limit : G_MAXINT;

    g_signal_emit (complete, e_completion_signals[COMPLETION_STARTED], 0, text, pos, limit);
    if (klass->request_completion)
        klass->request_completion (complete, text, pos, limit);
}

gboolean
e_completion_searching (ECompletion *complete)
{
    g_return_val_if_fail (complete != NULL, FALSE);
    g_return_val_if_fail (E_IS_COMPLETION (complete), FALSE);

    return complete->priv->searching;
}

const gchar *
e_completion_search_text (ECompletion *complete)
{
    g_return_val_if_fail (complete != NULL, NULL);
    g_return_val_if_fail (E_IS_COMPLETION (complete), NULL);

    return complete->priv->search_text;
}

gint
e_completion_search_text_pos (ECompletion *complete)
{
    g_return_val_if_fail (complete != NULL, -1);
    g_return_val_if_fail (E_IS_COMPLETION (complete), -1);

    return complete->priv->pos;
}

gint
e_completion_match_count (ECompletion *complete)
{
    g_return_val_if_fail (complete != NULL, 0);
    g_return_val_if_fail (E_IS_COMPLETION (complete), 0);

    return complete->priv->matches->len;
}

void
e_completion_foreach_match (ECompletion *complete, ECompletionMatchFn fn, gpointer closure)
{
    GPtrArray *m;
    int i;

    g_return_if_fail (complete != NULL);
    g_return_if_fail (E_IS_COMPLETION (complete));

    if (fn == NULL)
        return;

    m = complete->priv->matches;
    for (i = 0; i < m->len; i++) {
        ECompletionMatch *match = g_ptr_array_index (m, i);
        fn (match, closure);
    }
}

ECompletion *
e_completion_new (void)
{
    return E_COMPLETION (g_object_new (E_COMPLETION_TYPE, NULL));
}

#if 0
static gboolean
e_completion_sort (ECompletion *complete)
{
    GPtrArray *m;
    int i;
    GList *sort_list = NULL, *j;
    gboolean diff;

    m = complete->priv->matches;

    for (i = 0; i < m->len; i++)
        sort_list = g_list_append (sort_list, 
                       g_ptr_array_index (m, i));
    
    sort_list = g_list_sort (sort_list, (GCompareFunc) e_completion_match_compare_alpha);

    diff = FALSE;

    for (i=0, j=sort_list; i < m->len; i++, j = g_list_next (j)) {
        if (g_ptr_array_index (m, i) == j->data)
            continue;

        diff = TRUE;
        g_ptr_array_index (m, i) = j->data;
    }

    g_list_free (sort_list);

    return diff;
}
#endif

void
e_completion_found_match (ECompletion *complete, ECompletionMatch *match)
{
    g_return_if_fail (complete);
    g_return_if_fail (E_IS_COMPLETION (complete));
    g_return_if_fail (match != NULL);

    if (! complete->priv->searching) {
        g_warning ("e_completion_found_match(...,\"%s\",...) called outside of a search", match->match_text);
        return;
    }

    /* For now, do nothing when we hit the limit --- just don't
     * announce the incoming matches. */
    if (complete->priv->matches->len >= complete->priv->limit) {
        e_completion_match_unref (match);
        return;
    }

    e_completion_add_match (complete, match);

    g_signal_emit (complete, e_completion_signals[COMPLETION_FOUND], 0, match);
}

void
e_completion_end_search (ECompletion *comp)
{
    g_return_if_fail (comp != NULL);
    g_return_if_fail (E_IS_COMPLETION (comp));
    g_return_if_fail (comp->priv->searching);

    if (E_COMPLETION_CLASS (GTK_OBJECT_GET_CLASS (comp))->end_completion) {
        E_COMPLETION_CLASS (GTK_OBJECT_GET_CLASS (comp))->end_completion (comp);
    }
    g_signal_emit (comp, e_completion_signals[COMPLETION_FINISHED], 0);

    comp->priv->searching = FALSE;
    comp->priv->done_search = TRUE;
}