2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
4 * Copyright (c) 2000-2003 by Alfons Hoogervorst <alfons@proteus.demon.nl>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 #include <gdk/gdkkeysyms.h>
29 #include <gtk/gtkmain.h>
30 #include <gtk/gtkwindow.h>
31 #include <gtk/gtkentry.h>
32 #include <gtk/gtkeditable.h>
33 #include <gtk/gtkclist.h>
34 #include <gtk/gtkscrolledwindow.h>
38 #if (HAVE_WCTYPE_H && HAVE_WCHAR_H)
43 #include "addressbook.h"
44 #include "addr_compl.h"
51 * The address book is read into memory. We set up an address list
52 * containing all address book entries. Next we make the completion
53 * list, which contains all the completable strings, and store a
54 * reference to the address entry it belongs to.
55 * After calling the g_completion_complete(), we get a reference
56 * to a valid email address.
58 * Completion is very simplified. We never complete on another prefix,
59 * i.e. we neglect the next smallest possible prefix for the current
60 * completion cache. This is simply done so we might break up the
61 * addresses a little more (e.g. break up alfons@proteus.demon.nl into
62 * something like alfons, proteus, demon, nl; and then completing on
63 * any of those words).
67 * Reference to address index.
69 static AddressIndex *_addressIndex_ = NULL;
72 * address_entry - structure which refers to the original address entry in the
82 * completion_entry - structure used to complete addresses, with a reference
83 * the the real address information.
87 gchar *string; /* string to complete */
88 address_entry *ref; /* address the string belongs to */
91 /*******************************************************************************/
93 static gint g_ref_count; /* list ref count */
94 static GList *g_completion_list; /* list of strings to be checked */
95 static GList *g_address_list; /* address storage */
96 static GCompletion *g_completion; /* completion object */
98 /* To allow for continuing completion we have to keep track of the state
99 * using the following variables. No need to create a context object. */
101 static gint g_completion_count; /* nr of addresses incl. the prefix */
102 static gint g_completion_next; /* next prev address */
103 static GSList *g_completion_addresses; /* unique addresses found in the
105 static gchar *g_completion_prefix; /* last prefix. (this is cached here
106 * because the prefix passed to g_completion
107 * is g_strdown()'ed */
109 /*******************************************************************************/
112 * Function used by GTK to find the string data to be used for completion.
113 * \param data Pointer to data being processed.
115 static gchar *completion_func(gpointer data)
117 g_return_val_if_fail(data != NULL, NULL);
119 return ((completion_entry *)data)->string;
123 * Initialize all completion index data.
125 static void init_all(void)
127 g_completion = g_completion_new(completion_func);
128 g_return_if_fail(g_completion != NULL);
132 * Free up all completion index data.
134 static void free_all(void)
138 walk = g_list_first(g_completion_list);
139 for (; walk != NULL; walk = g_list_next(walk)) {
140 completion_entry *ce = (completion_entry *) walk->data;
144 g_list_free(g_completion_list);
145 g_completion_list = NULL;
147 walk = g_address_list;
148 for (; walk != NULL; walk = g_list_next(walk)) {
149 address_entry *ae = (address_entry *) walk->data;
154 g_list_free(g_address_list);
155 g_address_list = NULL;
157 g_completion_free(g_completion);
162 * Append specified address entry to the index.
163 * \param str Index string value.
164 * \param ae Entry containing address data.
166 static void add_address1(const char *str, address_entry *ae)
168 completion_entry *ce1;
169 ce1 = g_new0(completion_entry, 1),
170 ce1->string = g_utf8_strdown(str, -1);
171 /* GCompletion list is case sensitive */
172 g_strdown(ce1->string);
175 g_completion_list = g_list_prepend(g_completion_list, ce1);
179 * Adds address to the completion list. This function looks complicated, but
180 * it's only allocation checks. Each value will be included in the index.
181 * \param name Recipient name.
182 * \param address EMail address.
183 * \param alias Alias to append.
184 * \return <code>0</code> if entry appended successfully, or <code>-1</code>
187 static gint add_address(const gchar *name, const gchar *address, const gchar *alias)
191 if (!name || !address) return -1;
193 ae = g_new0(address_entry, 1);
195 g_return_val_if_fail(ae != NULL, -1);
197 ae->name = g_strdup(name);
198 ae->address = g_strdup(address);
200 g_address_list = g_list_prepend(g_address_list, ae);
202 add_address1(name, ae);
203 add_address1(address, ae);
204 add_address1(alias, ae);
210 * Read address book, creating all entries in the completion index.
212 static void read_address_book(void) {
213 addrindex_load_completion( _addressIndex_, add_address );
214 g_address_list = g_list_reverse(g_address_list);
215 g_completion_list = g_list_reverse(g_completion_list);
219 * Test whether there is a completion pending.
220 * \return <code>TRUE</code> if pending.
222 static gboolean is_completion_pending(void)
224 /* check if completion pending, i.e. we might satisfy a request for the next
225 * or previous address */
226 return g_completion_count;
230 * Clear the completion cache.
232 static void clear_completion_cache(void)
234 if (is_completion_pending()) {
235 if (g_completion_prefix)
236 g_free(g_completion_prefix);
238 if (g_completion_addresses) {
239 g_slist_free(g_completion_addresses);
240 g_completion_addresses = NULL;
243 g_completion_count = g_completion_next = 0;
248 * Prepare completion index. This function should be called prior to attempting
249 * address completion.
250 * \return The number of addresses in the completion list.
252 gint start_address_completion(void)
254 clear_completion_cache();
257 /* open the address book */
259 /* merge the completion entry list into g_completion */
260 if (g_completion_list)
261 g_completion_add_items(g_completion, g_completion_list);
264 debug_print("start_address_completion ref count %d\n", g_ref_count);
266 return g_list_length(g_completion_list);
270 * Retrieve a possible address (or a part) from an entry box. To make life
271 * easier, we only look at the last valid address component; address
272 * completion only works at the last string component in the entry box.
274 * \param entry Address entry field.
275 * \param start_pos Address of start position of address.
276 * \return Possible address.
278 static gchar *get_address_from_edit(GtkEntry *entry, gint *start_pos)
280 const gchar *edit_text, *p;
282 gboolean in_quote = FALSE;
283 gboolean in_bracket = FALSE;
286 edit_text = gtk_entry_get_text(entry);
287 if (edit_text == NULL) return NULL;
289 cur_pos = gtk_editable_get_position(GTK_EDITABLE(entry));
291 /* scan for a separator. doesn't matter if walk points at null byte. */
292 for (p = g_utf8_offset_to_pointer(edit_text, cur_pos);
294 p = g_utf8_prev_char(p)) {
297 } else if (!in_quote) {
298 if (!in_bracket && *p == ',') {
300 } else if (*p == '<')
307 /* have something valid */
308 if (g_utf8_strlen(p, -1) == 0)
311 #define IS_VALID_CHAR(x) \
312 (isalnum(x) || (x) == '"' || (x) == '<' || (((unsigned char)(x)) > 0x7f))
314 /* now scan back until we hit a valid character */
315 for (; *p && !IS_VALID_CHAR(*p); p = g_utf8_next_char(p))
320 if (g_utf8_strlen(p, -1) == 0)
323 if (start_pos) *start_pos = g_utf8_pointer_to_offset(edit_text, p);
331 * Replace an incompleted address with a completed one.
332 * \param entry Address entry field.
333 * \param newtext New text.
334 * \param start_pos Insertion point in entry field.
336 static void replace_address_in_edit(GtkEntry *entry, const gchar *newtext,
339 if (!newtext) return;
340 gtk_editable_delete_text(GTK_EDITABLE(entry), start_pos, -1);
341 gtk_editable_insert_text(GTK_EDITABLE(entry), newtext, strlen(newtext),
343 gtk_editable_set_position(GTK_EDITABLE(entry), -1);
347 * Attempt to complete an address, and returns the number of addresses found.
348 * Use <code>get_complete_address()</code> to get an entry from the index.
350 * \param str Search string to find.
351 * \return Zero if no match was found, otherwise the number of addresses; the
352 * original prefix (search string) will appear at index 0.
354 guint complete_address(const gchar *str)
359 completion_entry *ce;
361 g_return_val_if_fail(str != NULL, 0);
363 /* g_completion is case sensitive */
364 d = g_utf8_strdown(str, -1);
366 clear_completion_cache();
367 g_completion_prefix = g_strdup(str);
369 result = g_completion_complete(g_completion, d, NULL);
371 count = g_list_length(result);
373 /* create list with unique addresses */
374 for (cpl = 0, result = g_list_first(result);
376 result = g_list_next(result)) {
377 ce = (completion_entry *)(result->data);
378 if (NULL == g_slist_find(g_completion_addresses,
381 g_completion_addresses =
382 g_slist_append(g_completion_addresses,
386 count = cpl + 1; /* index 0 is the original prefix */
387 g_completion_next = 1; /* we start at the first completed one */
389 g_free(g_completion_prefix);
390 g_completion_prefix = NULL;
393 g_completion_count = count;
401 * Return a complete address from the index.
402 * \param index Index of entry that was found (by the previous call to
403 * <code>complete_address()</code>
404 * \return Completed address string; this should be freed when done.
406 gchar *get_complete_address(gint index)
408 const address_entry *p;
409 gchar *address = NULL;
411 if (index < g_completion_count) {
413 address = g_strdup(g_completion_prefix);
415 /* get something from the unique addresses */
416 p = (address_entry *)g_slist_nth_data
417 (g_completion_addresses, index - 1);
419 if (!p->name || p->name[0] == '\0')
420 address = g_strdup_printf(p->address);
421 else if (strchr_with_skip_quote(p->name, '"', ','))
422 address = g_strdup_printf
423 ("\"%s\" <%s>", p->name, p->address);
425 address = g_strdup_printf
426 ("%s <%s>", p->name, p->address);
435 * Return the next complete address match from the completion index.
436 * \return Completed address string; this should be freed when done.
438 static gchar *get_next_complete_address(void)
440 if (is_completion_pending()) {
443 res = get_complete_address(g_completion_next);
444 g_completion_next += 1;
445 if (g_completion_next >= g_completion_count)
446 g_completion_next = 0;
454 * Return a count of the completed matches in the completion index.
455 * \return Number of matched entries.
457 static guint get_completion_count(void)
459 if (is_completion_pending())
460 return g_completion_count;
466 * Invalidate address completion index. This function should be called whenever
467 * the address book changes. This forces data to be read into the completion
469 * \return Number of entries in index.
471 gint invalidate_address_completion(void)
474 /* simply the same as start_address_completion() */
475 debug_print("Invalidation request for address completion\n");
479 g_completion_add_items(g_completion, g_completion_list);
480 clear_completion_cache();
483 return g_list_length(g_completion_list);
487 * Finished with completion index. This function should be called after
488 * matching addresses.
489 * \return Reference count.
491 gint end_address_completion(void)
493 clear_completion_cache();
495 if (0 == --g_ref_count)
498 debug_print("end_address_completion ref count %d\n", g_ref_count);
504 * Define the structure of the completion window.
506 typedef struct _CompletionWindow CompletionWindow;
507 struct _CompletionWindow {
518 static CompletionWindow *_compWindow_ = NULL;
521 * Mutex to protect callback from multiple threads.
523 static pthread_mutex_t _completionMutex_ = PTHREAD_MUTEX_INITIALIZER;
526 * Completion queue list.
528 static GList *_displayQueue_ = NULL;
533 static gint _queryID_ = 0;
536 * Completion idle ID.
538 static guint _completionIdleID_ = 0;
541 * address completion entry ui. the ui (completion list was inspired by galeon's
542 * auto completion list). remaining things powered by sylpheed's completion engine.
545 #define ENTRY_DATA_TAB_HOOK "tab_hook" /* used to lookup entry */
547 static void address_completion_mainwindow_set_focus (GtkWindow *window,
550 static gboolean address_completion_entry_key_pressed (GtkEntry *entry,
553 static gboolean address_completion_complete_address_in_entry
556 static void address_completion_create_completion_window (GtkEntry *entry);
558 static void completion_window_select_row(GtkCList *clist,
562 CompletionWindow *compWin );
564 static gboolean completion_window_button_press
566 GdkEventButton *event,
567 CompletionWindow *compWin );
569 static gboolean completion_window_key_press
572 CompletionWindow *compWin );
573 static void address_completion_create_completion_window( GtkEntry *entry_ );
576 * Create a completion window object.
577 * \return Initialized completion window.
579 static CompletionWindow *addrcompl_create_window( void ) {
580 CompletionWindow *cw;
582 cw = g_new0( CompletionWindow, 1 );
584 cw->searchTerm = NULL;
593 * Destroy completion window.
594 * \param cw Window to destroy.
596 static void addrcompl_destroy_window( CompletionWindow *cw ) {
597 /* Remove idler function... or application may not terminate */
598 if( _completionIdleID_ != 0 ) {
599 gtk_idle_remove( _completionIdleID_ );
600 _completionIdleID_ = 0;
603 /* Now destroy window */
605 /* Clear references to widgets */
611 gtk_widget_hide( cw->window );
612 gtk_widget_destroy( cw->window );
619 * Free up completion window.
620 * \param cw Window to free.
622 static void addrcompl_free_window( CompletionWindow *cw ) {
624 addrcompl_destroy_window( cw );
626 g_free( cw->searchTerm );
627 cw->searchTerm = NULL;
629 /* Clear references */
638 * Advance selection to previous/next item in list.
639 * \param clist List to process.
640 * \param forward Set to <i>TRUE</i> to select next or <i>FALSE</i> for
643 static void completion_window_advance_selection(GtkCList *clist, gboolean forward)
647 g_return_if_fail(clist != NULL);
649 if( clist->selection ) {
650 row = GPOINTER_TO_INT(clist->selection->data);
651 row = forward ? ( row + 1 ) : ( row - 1 );
652 gtk_clist_freeze(clist);
653 gtk_clist_select_row(clist, row, 0);
654 gtk_clist_thaw(clist);
659 /* completion_window_accept_selection() - accepts the current selection in the
660 * clist, and destroys the window */
661 static void completion_window_accept_selection(GtkWidget **window,
665 gchar *address = NULL, *text = NULL;
666 gint cursor_pos, row;
668 g_return_if_fail(window != NULL);
669 g_return_if_fail(*window != NULL);
670 g_return_if_fail(clist != NULL);
671 g_return_if_fail(entry != NULL);
672 g_return_if_fail(clist->selection != NULL);
674 /* FIXME: I believe it's acceptable to access the selection member directly */
675 row = GPOINTER_TO_INT(clist->selection->data);
677 /* we just need the cursor position */
678 address = get_address_from_edit(entry, &cursor_pos);
680 gtk_clist_get_text(clist, row, 0, &text);
681 replace_address_in_edit(entry, text, cursor_pos);
683 clear_completion_cache();
684 gtk_widget_destroy(*window);
690 * Resize window to accommodate maximum number of address entries.
691 * \param cw Completion window.
693 static void addrcompl_resize_window( CompletionWindow *cw ) {
695 gint x, y, width, height, depth;
697 /* Get current geometry of window */
698 gdk_window_get_geometry( cw->window->window, &x, &y, &width, &height, &depth );
700 gtk_widget_size_request( cw->clist, &r );
701 gtk_widget_set_size_request( cw->window, width, r.height );
702 gtk_widget_show_all( cw->window );
703 gtk_widget_size_request( cw->clist, &r );
705 /* Adjust window height to available screen space */
706 if( ( y + r.height ) > gdk_screen_height() ) {
707 gtk_window_set_policy( GTK_WINDOW( cw->window ), TRUE, FALSE, FALSE );
708 gtk_widget_set_size_request( cw->window, width, gdk_screen_height() - y );
713 * Add an address the completion window address list.
714 * \param cw Completion window.
715 * \param address Address to add.
717 static void addrcompl_add_entry( CompletionWindow *cw, gchar *address ) {
718 gchar *text[] = { NULL, NULL };
720 /* printf( "\t\tAdding :%s\n", address ); */
722 gtk_clist_append( GTK_CLIST(cw->clist), text );
726 addrcompl_resize_window( cw );
727 gtk_grab_add( cw->window );
729 if( cw->listCount == 1 ) {
730 /* Select first row for now */
731 gtk_clist_select_row( GTK_CLIST(cw->clist), 0, 0);
733 else if( cw->listCount == 2 ) {
734 /* Move off first row */
735 gtk_clist_select_row( GTK_CLIST(cw->clist), 1, 0);
740 * Completion idle function. This function is called by the main (UI) thread
741 * during UI idle time while an address search is in progress. Items from the
742 * display queue are processed and appended to the address list.
744 * \param data Target completion window to receive email addresses.
745 * \return <i>TRUE</i> to ensure that idle event do not get ignored.
747 static gboolean addrcompl_idle( gpointer data ) {
750 CompletionWindow *cw;
752 /* Process all entries in display queue */
753 pthread_mutex_lock( & _completionMutex_ );
754 if( _displayQueue_ ) {
756 node = _displayQueue_;
758 address = node->data;
759 /* printf( "address ::: %s :::\n", address ); */
760 addrcompl_add_entry( cw, address );
762 node = g_list_next( node );
764 g_list_free( _displayQueue_ );
765 _displayQueue_ = NULL;
767 pthread_mutex_unlock( & _completionMutex_ );
773 * Callback entry point. The background thread (if any) appends the address
774 * list to the display queue.
775 * \param queryID Query ID of search request.
776 * \param listEMail List of zero of more email objects that met search
778 * \param target Target object to received data.
780 static gint addrcompl_callback(
781 gint queryID, GList *listEMail, gpointer target )
786 /* printf( "addrcompl_callback::queryID=%d\n", queryID ); */
787 pthread_mutex_lock( & _completionMutex_ );
789 if( queryID == _queryID_ ) {
790 /* Append contents to end of display queue */
793 ItemEMail *email = node->data;
795 address = addritem_format_email( email );
796 /* printf( "\temail/address ::%s::\n", address ); */
797 _displayQueue_ = g_list_append( _displayQueue_, address );
798 node = g_list_next( node );
802 pthread_mutex_unlock( & _completionMutex_ );
803 /* printf( "addrcompl_callback...done\n" ); */
809 * Clear the display queue.
811 static void addrcompl_clear_queue( void ) {
812 /* Clear out display queue */
813 pthread_mutex_lock( & _completionMutex_ );
815 g_list_free( _displayQueue_ );
816 _displayQueue_ = NULL;
818 pthread_mutex_unlock( & _completionMutex_ );
822 * Add a single address entry into the display queue.
823 * \param address Address to append.
825 static void addrcompl_add_queue( gchar *address ) {
826 pthread_mutex_lock( & _completionMutex_ );
827 _displayQueue_ = g_list_append( _displayQueue_, address );
828 pthread_mutex_unlock( & _completionMutex_ );
832 * Load list with entries from local completion index.
833 * \param cw Completion window.
835 static void addrcompl_load_local( CompletionWindow *cw ) {
838 for (count = 0; count < get_completion_count(); count++) {
841 address = get_complete_address( count );
842 /* printf( "\taddress ::%s::\n", address ); */
844 /* Append contents to end of display queue */
845 addrcompl_add_queue( address );
852 static void addrcompl_start_search( void ) {
855 searchTerm = g_strdup( _compWindow_->searchTerm );
857 /* Setup the search */
858 _queryID_ = addrindex_setup_search(
859 _addressIndex_, searchTerm, _compWindow_, addrcompl_callback );
860 g_free( searchTerm );
861 /* printf( "addrcompl_start_search::queryID=%d\n", _queryID_ ); */
863 /* Load local stuff */
864 addrcompl_load_local( _compWindow_ );
866 /* Sit back and wait until something happens */
868 gtk_idle_add( ( GtkFunction ) addrcompl_idle, _compWindow_ );
869 /* printf( "addrindex_start_search::queryID=%d\n", _queryID_ ); */
871 addrindex_start_search( _addressIndex_, _queryID_ );
875 * Apply the current selection in the list to the entry field. Focus is also
876 * moved to the next widget so that Tab key works correctly.
877 * \param clist List to process.
878 * \param entry Address entry field.
880 static void completion_window_apply_selection(GtkCList *clist, GtkEntry *entry)
882 gchar *address = NULL, *text = NULL;
883 gint cursor_pos, row;
886 g_return_if_fail(clist != NULL);
887 g_return_if_fail(entry != NULL);
888 g_return_if_fail(clist->selection != NULL);
890 /* First remove the idler */
891 if( _completionIdleID_ != 0 ) {
892 gtk_idle_remove( _completionIdleID_ );
893 _completionIdleID_ = 0;
896 /* Process selected item */
897 row = GPOINTER_TO_INT(clist->selection->data);
899 address = get_address_from_edit(entry, &cursor_pos);
901 gtk_clist_get_text(clist, row, 0, &text);
902 replace_address_in_edit(entry, text, cursor_pos);
904 /* Move focus to next widget */
905 parent = GTK_WIDGET(entry)->parent;
907 gtk_widget_child_focus( parent, GTK_DIR_TAB_FORWARD );
912 * Start address completion. Should be called when creating the main window
913 * containing address completion entries.
914 * \param mainwindow Main window.
916 void address_completion_start(GtkWidget *mainwindow)
918 start_address_completion();
920 /* register focus change hook */
921 g_signal_connect(G_OBJECT(mainwindow), "set_focus",
922 G_CALLBACK(address_completion_mainwindow_set_focus),
927 * Need unique data to make unregistering signal handler possible for the auto
930 #define COMPLETION_UNIQUE_DATA (GINT_TO_POINTER(0xfeefaa))
933 * Register specified entry widget for address completion.
934 * \param entry Address entry field.
936 void address_completion_register_entry(GtkEntry *entry)
938 g_return_if_fail(entry != NULL);
939 g_return_if_fail(GTK_IS_ENTRY(entry));
941 /* add hooked property */
942 g_object_set_data(G_OBJECT(entry), ENTRY_DATA_TAB_HOOK, entry);
944 /* add keypress event */
945 g_signal_connect_closure
946 (GTK_OBJECT(entry), "key_press_event",
947 g_cclosure_new(G_CALLBACK(address_completion_entry_key_pressed),
948 COMPLETION_UNIQUE_DATA,
954 * Unregister specified entry widget from address completion operations.
955 * \param entry Address entry field.
957 void address_completion_unregister_entry(GtkEntry *entry)
959 GtkObject *entry_obj;
961 g_return_if_fail(entry != NULL);
962 g_return_if_fail(GTK_IS_ENTRY(entry));
964 entry_obj = g_object_get_data(G_OBJECT(entry), ENTRY_DATA_TAB_HOOK);
965 g_return_if_fail(entry_obj);
966 g_return_if_fail(entry_obj == GTK_OBJECT(entry));
968 /* has the hooked property? */
969 g_object_set_data(G_OBJECT(entry), ENTRY_DATA_TAB_HOOK, NULL);
971 /* remove the hook */
972 g_signal_handlers_disconnect_by_func(G_OBJECT(entry),
973 G_CALLBACK(address_completion_entry_key_pressed),
974 COMPLETION_UNIQUE_DATA);
978 * End address completion. Should be called when main window with address
979 * completion entries terminates. NOTE: this function assumes that it is
980 * called upon destruction of the window.
981 * \param mainwindow Main window.
983 void address_completion_end(GtkWidget *mainwindow)
985 /* if address_completion_end() is really called on closing the window,
986 * we don't need to unregister the set_focus_cb */
987 end_address_completion();
990 /* if focus changes to another entry, then clear completion cache */
991 static void address_completion_mainwindow_set_focus(GtkWindow *window,
996 if (widget && GTK_IS_ENTRY(widget) &&
997 g_object_get_data(G_OBJECT(widget), ENTRY_DATA_TAB_HOOK)) {
998 clear_completion_cache();
1003 * Listener that watches for tab or other keystroke in address entry field.
1004 * \param entry Address entry field.
1005 * \param ev Event object.
1006 * \param data User data.
1007 * \return <i>TRUE</i>.
1009 static gboolean address_completion_entry_key_pressed(GtkEntry *entry,
1013 if (ev->keyval == GDK_Tab) {
1014 addrcompl_clear_queue();
1016 if( address_completion_complete_address_in_entry( entry, TRUE ) ) {
1017 /* route a void character to the default handler */
1018 /* this is a dirty hack; we're actually changing a key
1019 * reported by the system. */
1020 ev->keyval = GDK_AudibleBell_Enable;
1021 ev->state &= ~GDK_SHIFT_MASK;
1024 address_completion_create_completion_window(entry);
1026 /* Start remote queries */
1027 addrcompl_start_search();
1034 } else if (ev->keyval == GDK_Shift_L
1035 || ev->keyval == GDK_Shift_R
1036 || ev->keyval == GDK_Control_L
1037 || ev->keyval == GDK_Control_R
1038 || ev->keyval == GDK_Caps_Lock
1039 || ev->keyval == GDK_Shift_Lock
1040 || ev->keyval == GDK_Meta_L
1041 || ev->keyval == GDK_Meta_R
1042 || ev->keyval == GDK_Alt_L
1043 || ev->keyval == GDK_Alt_R) {
1044 /* these buttons should not clear the cache... */
1046 clear_completion_cache();
1051 * Initialize search term for address completion.
1052 * \param entry Address entry field.
1054 static gboolean address_completion_complete_address_in_entry(GtkEntry *entry,
1057 gint ncount, cursor_pos;
1058 gchar *searchTerm, *new = NULL;
1060 g_return_val_if_fail(entry != NULL, FALSE);
1062 if (!GTK_WIDGET_HAS_FOCUS(entry)) return FALSE;
1064 /* get an address component from the cursor */
1065 searchTerm = get_address_from_edit( entry, &cursor_pos );
1066 if( ! searchTerm ) return FALSE;
1067 /* printf( "search for :::%s:::\n", searchTerm ); */
1069 /* Clear any existing search */
1070 if( _compWindow_->searchTerm ) {
1071 g_free( _compWindow_->searchTerm );
1073 _compWindow_->searchTerm = g_strdup( searchTerm );
1075 /* Perform search on local completion index */
1076 ncount = complete_address( searchTerm );
1078 new = get_next_complete_address();
1082 /* Make sure that drop-down appears uniform! */
1084 addrcompl_add_queue( g_strdup( searchTerm ) );
1086 g_free( searchTerm );
1092 * Create new address completion window for specified entry.
1093 * \param entry_ Entry widget to associate with window.
1095 static void address_completion_create_completion_window( GtkEntry *entry_ )
1097 gint x, y, height, width, depth;
1098 GtkWidget *scroll, *clist;
1101 GtkWidget *entry = GTK_WIDGET(entry_);
1103 /* Create new window and list */
1104 window = gtk_window_new(GTK_WINDOW_POPUP);
1105 clist = gtk_clist_new(1);
1107 /* Destroy any existing window */
1108 addrcompl_destroy_window( _compWindow_ );
1110 /* Create new object */
1111 _compWindow_->window = window;
1112 _compWindow_->entry = entry;
1113 _compWindow_->clist = clist;
1114 _compWindow_->listCount = 0;
1116 scroll = gtk_scrolled_window_new(NULL, NULL);
1117 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scroll),
1118 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
1119 gtk_container_add(GTK_CONTAINER(window), scroll);
1120 gtk_container_add(GTK_CONTAINER(scroll), clist);
1121 gtk_clist_set_selection_mode(GTK_CLIST(clist), GTK_SELECTION_SINGLE);
1123 /* Use entry widget to create initial window */
1124 gdk_window_get_geometry(entry->window, &x, &y, &width, &height, &depth);
1125 gdk_window_get_deskrelative_origin (entry->window, &x, &y);
1127 gtk_window_move(GTK_WINDOW(window), x, y);
1129 /* Resize window to fit initial (empty) address list */
1130 gtk_widget_size_request( clist, &r );
1131 gtk_widget_set_size_request( window, width, r.height );
1132 gtk_widget_show_all( window );
1133 gtk_widget_size_request( clist, &r );
1135 /* Setup handlers */
1136 g_signal_connect(G_OBJECT(clist), "select_row",
1137 G_CALLBACK(completion_window_select_row),
1139 g_signal_connect(G_OBJECT(window),
1140 "button-press-event",
1141 G_CALLBACK(completion_window_button_press),
1143 g_signal_connect(G_OBJECT(window),
1145 G_CALLBACK(completion_window_key_press),
1147 gdk_pointer_grab(window->window, TRUE,
1148 GDK_POINTER_MOTION_MASK | GDK_BUTTON_PRESS_MASK |
1149 GDK_BUTTON_RELEASE_MASK,
1150 NULL, NULL, GDK_CURRENT_TIME);
1151 gtk_grab_add( window );
1153 /* this gets rid of the irritating focus rectangle that doesn't
1154 * follow the selection */
1155 GTK_WIDGET_UNSET_FLAGS(clist, GTK_CAN_FOCUS);
1159 * Respond to select row event in clist object. selection sends completed
1160 * address to entry. Note: event is NULL if selected by anything else than a
1162 * \param widget Window object.
1163 * \param event Event.
1164 * \param compWind Reference to completion window.
1166 static void completion_window_select_row(GtkCList *clist, gint row, gint col,
1168 CompletionWindow *compWin )
1172 g_return_if_fail(compWin != NULL);
1174 entry = GTK_ENTRY(compWin->entry);
1175 g_return_if_fail(entry != NULL);
1177 /* Don't update unless user actually selects ! */
1178 if (!event || event->type != GDK_BUTTON_RELEASE)
1181 /* User selected address by releasing the mouse in drop-down list*/
1182 completion_window_apply_selection( clist, entry );
1184 clear_completion_cache();
1185 addrcompl_destroy_window( _compWindow_ );
1189 * Respond to button press in completion window. Check if mouse click is
1190 * anywhere outside the completion window. In that case the completion
1191 * window is destroyed, and the original searchTerm is restored.
1193 * \param widget Window object.
1194 * \param event Event.
1195 * \param compWin Reference to completion window.
1197 static gboolean completion_window_button_press(GtkWidget *widget,
1198 GdkEventButton *event,
1199 CompletionWindow *compWin )
1201 GtkWidget *event_widget, *entry;
1204 gboolean restore = TRUE;
1206 g_return_val_if_fail(compWin != NULL, FALSE);
1208 entry = compWin->entry;
1209 g_return_val_if_fail(entry != NULL, FALSE);
1211 /* Test where mouse was clicked */
1212 event_widget = gtk_get_event_widget((GdkEvent *)event);
1213 if (event_widget != widget) {
1214 while (event_widget) {
1215 if (event_widget == widget)
1217 else if (event_widget == entry) {
1221 event_widget = event_widget->parent;
1226 /* Clicked outside of completion window - restore */
1227 searchTerm = _compWindow_->searchTerm;
1228 g_free(get_address_from_edit(GTK_ENTRY(entry), &cursor_pos));
1229 replace_address_in_edit(GTK_ENTRY(entry), searchTerm, cursor_pos);
1232 clear_completion_cache();
1233 addrcompl_destroy_window( _compWindow_ );
1239 * Respond to key press in completion window.
1240 * \param widget Window object.
1241 * \param event Event.
1242 * \param compWind Reference to completion window.
1244 static gboolean completion_window_key_press(GtkWidget *widget,
1246 CompletionWindow *compWin )
1248 GdkEventKey tmp_event;
1255 g_return_val_if_fail(compWin != NULL, FALSE);
1257 entry = compWin->entry;
1258 clist = compWin->clist;
1259 g_return_val_if_fail(entry != NULL, FALSE);
1261 /* allow keyboard navigation in the alternatives clist */
1262 if (event->keyval == GDK_Up || event->keyval == GDK_Down ||
1263 event->keyval == GDK_Page_Up || event->keyval == GDK_Page_Down) {
1264 completion_window_advance_selection
1266 event->keyval == GDK_Down ||
1267 event->keyval == GDK_Page_Down ? TRUE : FALSE);
1272 /* also make tab / shift tab go to next previous completion entry. we're
1273 * changing the key value */
1274 if (event->keyval == GDK_Tab || event->keyval == GDK_ISO_Left_Tab) {
1275 event->keyval = (event->state & GDK_SHIFT_MASK)
1276 ? GDK_Up : GDK_Down;
1277 /* need to reset shift state if going up */
1278 if (event->state & GDK_SHIFT_MASK)
1279 event->state &= ~GDK_SHIFT_MASK;
1280 completion_window_advance_selection(GTK_CLIST(clist),
1281 event->keyval == GDK_Down ? TRUE : FALSE);
1286 /* make tab move to next field */
1287 if( event->keyval == GDK_Tab ) {
1288 /* Reference to parent */
1289 parent = GTK_WIDGET(entry)->parent;
1291 /* Discard the window */
1292 clear_completion_cache();
1293 addrcompl_destroy_window( _compWindow_ );
1295 /* Move focus to next widget */
1297 gtk_widget_child_focus( parent, GTK_DIR_TAB_FORWARD );
1302 /* make backtab move to previous field */
1303 if( event->keyval == GDK_ISO_Left_Tab ) {
1304 /* Reference to parent */
1305 parent = GTK_WIDGET(entry)->parent;
1307 /* Discard the window */
1308 clear_completion_cache();
1309 addrcompl_destroy_window( _compWindow_ );
1311 /* Move focus to previous widget */
1313 gtk_widget_child_focus( parent, GTK_DIR_TAB_BACKWARD );
1318 /* look for presses that accept the selection */
1319 if (event->keyval == GDK_Return || event->keyval == GDK_space) {
1320 /* User selected address with a key press */
1322 /* Display selected address in entry field */
1323 completion_window_apply_selection(
1324 GTK_CLIST(clist), GTK_ENTRY(entry) );
1326 /* Discard the window */
1327 clear_completion_cache();
1328 addrcompl_destroy_window( _compWindow_ );
1332 /* key state keys should never be handled */
1333 if (event->keyval == GDK_Shift_L
1334 || event->keyval == GDK_Shift_R
1335 || event->keyval == GDK_Control_L
1336 || event->keyval == GDK_Control_R
1337 || event->keyval == GDK_Caps_Lock
1338 || event->keyval == GDK_Shift_Lock
1339 || event->keyval == GDK_Meta_L
1340 || event->keyval == GDK_Meta_R
1341 || event->keyval == GDK_Alt_L
1342 || event->keyval == GDK_Alt_R) {
1346 /* some other key, let's restore the searchTerm (orignal text) */
1347 searchTerm = _compWindow_->searchTerm;
1348 g_free(get_address_from_edit(GTK_ENTRY(entry), &cursor_pos));
1349 replace_address_in_edit(GTK_ENTRY(entry), searchTerm, cursor_pos);
1351 /* make sure anything we typed comes in the edit box */
1352 tmp_event.type = event->type;
1353 tmp_event.window = entry->window;
1354 tmp_event.send_event = TRUE;
1355 tmp_event.time = event->time;
1356 tmp_event.state = event->state;
1357 tmp_event.keyval = event->keyval;
1358 tmp_event.length = event->length;
1359 tmp_event.string = event->string;
1360 gtk_widget_event(entry, (GdkEvent *)&tmp_event);
1362 /* and close the completion window */
1363 clear_completion_cache();
1364 addrcompl_destroy_window( _compWindow_ );
1370 * ============================================================================
1371 * Publically accessible functions.
1372 * ============================================================================
1376 * Setup completion object.
1377 * \param addrIndex Address index object.
1379 void addrcompl_initialize( AddressIndex *addrIndex ) {
1380 g_return_if_fail( addrIndex != NULL );
1381 _addressIndex_ = addrIndex;
1383 /* printf( "addrcompl_initialize...\n" ); */
1384 if( ! _compWindow_ ) {
1385 _compWindow_ = addrcompl_create_window();
1388 _completionIdleID_ = 0;
1389 /* printf( "addrcompl_initialize...done\n" ); */
1393 * Teardown completion object.
1395 void addrcompl_teardown( void ) {
1396 /* printf( "addrcompl_teardown...\n" ); */
1397 addrcompl_free_window( _compWindow_ );
1398 _compWindow_ = NULL;
1399 if( _displayQueue_ ) {
1400 g_list_free( _displayQueue_ );
1402 _displayQueue_ = NULL;
1403 _completionIdleID_ = 0;
1404 _addressIndex_ = NULL;
1405 /* printf( "addrcompl_teardown...done\n" ); */