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_strdup(str);
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;
284 wchar_t rfc_mail_sep;
288 gboolean in_quote = FALSE;
289 gboolean in_bracket = FALSE;
292 if (mbtowc(&rfc_mail_sep, ",", 1) < 0) return NULL;
293 if (mbtowc("e, "\"", 1) < 0) return NULL;
294 if (mbtowc(<, "<", 1) < 0) return NULL;
295 if (mbtowc(>, ">", 1) < 0) return NULL;
297 edit_text = gtk_entry_get_text(entry);
298 if (edit_text == NULL) return NULL;
300 wtext = strdup_mbstowcs(edit_text);
301 g_return_val_if_fail(wtext != NULL, NULL);
303 cur_pos = gtk_editable_get_position(GTK_EDITABLE(entry));
305 /* scan for a separator. doesn't matter if walk points at null byte. */
306 for (wp = wtext + cur_pos; wp > wtext; wp--) {
309 else if (!in_quote) {
310 if (!in_bracket && *wp == rfc_mail_sep)
319 /* have something valid */
320 if (wcslen(wp) == 0) {
325 #define IS_VALID_CHAR(x) \
326 (iswalnum(x) || (x) == quote || (x) == lt || ((x) > 0x7f))
328 /* now scan back until we hit a valid character */
329 for (; *wp && !IS_VALID_CHAR(*wp); wp++)
334 if (wcslen(wp) == 0) {
339 if (start_pos) *start_pos = wp - wtext;
341 str = strdup_wcstombs(wp);
348 * Replace an incompleted address with a completed one.
349 * \param entry Address entry field.
350 * \param newtext New text.
351 * \param start_pos Insertion point in entry field.
353 static void replace_address_in_edit(GtkEntry *entry, const gchar *newtext,
356 if (!newtext) return;
357 gtk_editable_delete_text(GTK_EDITABLE(entry), start_pos, -1);
358 gtk_editable_insert_text(GTK_EDITABLE(entry), newtext, strlen(newtext),
360 gtk_editable_set_position(GTK_EDITABLE(entry), -1);
364 * Attempt to complete an address, and returns the number of addresses found.
365 * Use <code>get_complete_address()</code> to get an entry from the index.
367 * \param str Search string to find.
368 * \return Zero if no match was found, otherwise the number of addresses; the
369 * original prefix (search string) will appear at index 0.
371 guint complete_address(const gchar *str)
376 completion_entry *ce;
378 g_return_val_if_fail(str != NULL, 0);
380 Xstrdup_a(d, str, return 0);
382 clear_completion_cache();
383 g_completion_prefix = g_strdup(str);
385 /* g_completion is case sensitive */
387 result = g_completion_complete(g_completion, d, NULL);
389 count = g_list_length(result);
391 /* create list with unique addresses */
392 for (cpl = 0, result = g_list_first(result);
394 result = g_list_next(result)) {
395 ce = (completion_entry *)(result->data);
396 if (NULL == g_slist_find(g_completion_addresses,
399 g_completion_addresses =
400 g_slist_append(g_completion_addresses,
404 count = cpl + 1; /* index 0 is the original prefix */
405 g_completion_next = 1; /* we start at the first completed one */
407 g_free(g_completion_prefix);
408 g_completion_prefix = NULL;
411 g_completion_count = count;
416 * Return a complete address from the index.
417 * \param index Index of entry that was found (by the previous call to
418 * <code>complete_address()</code>
419 * \return Completed address string; this should be freed when done.
421 gchar *get_complete_address(gint index)
423 const address_entry *p;
424 gchar *address = NULL;
426 if (index < g_completion_count) {
428 address = g_strdup(g_completion_prefix);
430 /* get something from the unique addresses */
431 p = (address_entry *)g_slist_nth_data
432 (g_completion_addresses, index - 1);
434 if (!p->name || p->name[0] == '\0')
435 address = g_strdup_printf(p->address);
436 else if (strchr_with_skip_quote(p->name, '"', ','))
437 address = g_strdup_printf
438 ("\"%s\" <%s>", p->name, p->address);
440 address = g_strdup_printf
441 ("%s <%s>", p->name, p->address);
450 * Return the next complete address match from the completion index.
451 * \return Completed address string; this should be freed when done.
453 static gchar *get_next_complete_address(void)
455 if (is_completion_pending()) {
458 res = get_complete_address(g_completion_next);
459 g_completion_next += 1;
460 if (g_completion_next >= g_completion_count)
461 g_completion_next = 0;
469 * Return a count of the completed matches in the completion index.
470 * \return Number of matched entries.
472 static guint get_completion_count(void)
474 if (is_completion_pending())
475 return g_completion_count;
481 * Invalidate address completion index. This function should be called whenever
482 * the address book changes. This forces data to be read into the completion
484 * \return Number of entries in index.
486 gint invalidate_address_completion(void)
489 /* simply the same as start_address_completion() */
490 debug_print("Invalidation request for address completion\n");
494 g_completion_add_items(g_completion, g_completion_list);
495 clear_completion_cache();
498 return g_list_length(g_completion_list);
502 * Finished with completion index. This function should be called after
503 * matching addresses.
504 * \return Reference count.
506 gint end_address_completion(void)
508 clear_completion_cache();
510 if (0 == --g_ref_count)
513 debug_print("end_address_completion ref count %d\n", g_ref_count);
519 * Define the structure of the completion window.
521 typedef struct _CompletionWindow CompletionWindow;
522 struct _CompletionWindow {
533 static CompletionWindow *_compWindow_ = NULL;
536 * Mutex to protect callback from multiple threads.
538 static pthread_mutex_t _completionMutex_ = PTHREAD_MUTEX_INITIALIZER;
541 * Completion queue list.
543 static GList *_displayQueue_ = NULL;
548 static gint _queryID_ = 0;
551 * Completion idle ID.
553 static guint _completionIdleID_ = 0;
556 * address completion entry ui. the ui (completion list was inspired by galeon's
557 * auto completion list). remaining things powered by sylpheed's completion engine.
560 #define ENTRY_DATA_TAB_HOOK "tab_hook" /* used to lookup entry */
562 static void address_completion_mainwindow_set_focus (GtkWindow *window,
565 static gboolean address_completion_entry_key_pressed (GtkEntry *entry,
568 static gboolean address_completion_complete_address_in_entry
571 static void address_completion_create_completion_window (GtkEntry *entry);
573 static void completion_window_select_row(GtkCList *clist,
577 CompletionWindow *compWin );
579 static gboolean completion_window_button_press
581 GdkEventButton *event,
582 CompletionWindow *compWin );
584 static gboolean completion_window_key_press
587 CompletionWindow *compWin );
588 static void address_completion_create_completion_window( GtkEntry *entry_ );
591 * Create a completion window object.
592 * \return Initialized completion window.
594 static CompletionWindow *addrcompl_create_window( void ) {
595 CompletionWindow *cw;
597 cw = g_new0( CompletionWindow, 1 );
599 cw->searchTerm = NULL;
608 * Destroy completion window.
609 * \param cw Window to destroy.
611 static void addrcompl_destroy_window( CompletionWindow *cw ) {
612 /* Remove idler function... or application may not terminate */
613 if( _completionIdleID_ != 0 ) {
614 gtk_idle_remove( _completionIdleID_ );
615 _completionIdleID_ = 0;
618 /* Now destroy window */
620 /* Clear references to widgets */
626 gtk_widget_hide( cw->window );
627 gtk_widget_destroy( cw->window );
634 * Free up completion window.
635 * \param cw Window to free.
637 static void addrcompl_free_window( CompletionWindow *cw ) {
639 addrcompl_destroy_window( cw );
641 g_free( cw->searchTerm );
642 cw->searchTerm = NULL;
644 /* Clear references */
653 * Advance selection to previous/next item in list.
654 * \param clist List to process.
655 * \param forward Set to <i>TRUE</i> to select next or <i>FALSE</i> for
658 static void completion_window_advance_selection(GtkCList *clist, gboolean forward)
662 g_return_if_fail(clist != NULL);
664 if( clist->selection ) {
665 row = GPOINTER_TO_INT(clist->selection->data);
666 row = forward ? ( row + 1 ) : ( row - 1 );
667 gtk_clist_freeze(clist);
668 gtk_clist_select_row(clist, row, 0);
669 gtk_clist_thaw(clist);
674 /* completion_window_accept_selection() - accepts the current selection in the
675 * clist, and destroys the window */
676 static void completion_window_accept_selection(GtkWidget **window,
680 gchar *address = NULL, *text = NULL;
681 gint cursor_pos, row;
683 g_return_if_fail(window != NULL);
684 g_return_if_fail(*window != NULL);
685 g_return_if_fail(clist != NULL);
686 g_return_if_fail(entry != NULL);
687 g_return_if_fail(clist->selection != NULL);
689 /* FIXME: I believe it's acceptable to access the selection member directly */
690 row = GPOINTER_TO_INT(clist->selection->data);
692 /* we just need the cursor position */
693 address = get_address_from_edit(entry, &cursor_pos);
695 gtk_clist_get_text(clist, row, 0, &text);
696 replace_address_in_edit(entry, text, cursor_pos);
698 clear_completion_cache();
699 gtk_widget_destroy(*window);
705 * Resize window to accommodate maximum number of address entries.
706 * \param cw Completion window.
708 static void addrcompl_resize_window( CompletionWindow *cw ) {
710 gint x, y, width, height, depth;
712 /* Get current geometry of window */
713 gdk_window_get_geometry( cw->window->window, &x, &y, &width, &height, &depth );
715 gtk_widget_size_request( cw->clist, &r );
716 gtk_widget_set_usize( cw->window, width, r.height );
717 gtk_widget_show_all( cw->window );
718 gtk_widget_size_request( cw->clist, &r );
720 /* Adjust window height to available screen space */
721 if( ( y + r.height ) > gdk_screen_height() ) {
722 gtk_window_set_policy( GTK_WINDOW( cw->window ), TRUE, FALSE, FALSE );
723 gtk_widget_set_usize( cw->window, width, gdk_screen_height() - y );
728 * Add an address the completion window address list.
729 * \param cw Completion window.
730 * \param address Address to add.
732 static void addrcompl_add_entry( CompletionWindow *cw, gchar *address ) {
733 gchar *text[] = { NULL, NULL };
735 /* printf( "\t\tAdding :%s\n", address ); */
737 gtk_clist_append( GTK_CLIST(cw->clist), text );
741 addrcompl_resize_window( cw );
742 gtk_grab_add( cw->window );
744 if( cw->listCount == 1 ) {
745 /* Select first row for now */
746 gtk_clist_select_row( GTK_CLIST(cw->clist), 0, 0);
748 else if( cw->listCount == 2 ) {
749 /* Move off first row */
750 gtk_clist_select_row( GTK_CLIST(cw->clist), 1, 0);
755 * Completion idle function. This function is called by the main (UI) thread
756 * during UI idle time while an address search is in progress. Items from the
757 * display queue are processed and appended to the address list.
759 * \param data Target completion window to receive email addresses.
760 * \return <i>TRUE</i> to ensure that idle event do not get ignored.
762 static gboolean addrcompl_idle( gpointer data ) {
765 CompletionWindow *cw;
767 /* Process all entries in display queue */
768 pthread_mutex_lock( & _completionMutex_ );
769 if( _displayQueue_ ) {
771 node = _displayQueue_;
773 address = node->data;
774 /* printf( "address ::: %s :::\n", address ); */
775 addrcompl_add_entry( cw, address );
777 node = g_list_next( node );
779 g_list_free( _displayQueue_ );
780 _displayQueue_ = NULL;
782 pthread_mutex_unlock( & _completionMutex_ );
788 * Callback entry point. The background thread (if any) appends the address
789 * list to the display queue.
790 * \param queryID Query ID of search request.
791 * \param listEMail List of zero of more email objects that met search
793 * \param target Target object to received data.
795 static gint addrcompl_callback(
796 gint queryID, GList *listEMail, gpointer target )
801 /* printf( "addrcompl_callback::queryID=%d\n", queryID ); */
802 pthread_mutex_lock( & _completionMutex_ );
804 if( queryID == _queryID_ ) {
805 /* Append contents to end of display queue */
808 ItemEMail *email = node->data;
810 address = addritem_format_email( email );
811 /* printf( "\temail/address ::%s::\n", address ); */
812 _displayQueue_ = g_list_append( _displayQueue_, address );
813 node = g_list_next( node );
817 pthread_mutex_unlock( & _completionMutex_ );
818 /* printf( "addrcompl_callback...done\n" ); */
824 * Clear the display queue.
826 static void addrcompl_clear_queue( void ) {
827 /* Clear out display queue */
828 pthread_mutex_lock( & _completionMutex_ );
830 g_list_free( _displayQueue_ );
831 _displayQueue_ = NULL;
833 pthread_mutex_unlock( & _completionMutex_ );
837 * Add a single address entry into the display queue.
838 * \param address Address to append.
840 static void addrcompl_add_queue( gchar *address ) {
841 pthread_mutex_lock( & _completionMutex_ );
842 _displayQueue_ = g_list_append( _displayQueue_, address );
843 pthread_mutex_unlock( & _completionMutex_ );
847 * Load list with entries from local completion index.
848 * \param cw Completion window.
850 static void addrcompl_load_local( CompletionWindow *cw ) {
853 for (count = 0; count < get_completion_count(); count++) {
856 address = get_complete_address( count );
857 /* printf( "\taddress ::%s::\n", address ); */
859 /* Append contents to end of display queue */
860 addrcompl_add_queue( address );
867 static void addrcompl_start_search( void ) {
870 searchTerm = g_strdup( _compWindow_->searchTerm );
872 /* Setup the search */
873 _queryID_ = addrindex_setup_search(
874 _addressIndex_, searchTerm, _compWindow_, addrcompl_callback );
875 g_free( searchTerm );
876 /* printf( "addrcompl_start_search::queryID=%d\n", _queryID_ ); */
878 /* Load local stuff */
879 addrcompl_load_local( _compWindow_ );
881 /* Sit back and wait until something happens */
883 gtk_idle_add( ( GtkFunction ) addrcompl_idle, _compWindow_ );
884 /* printf( "addrindex_start_search::queryID=%d\n", _queryID_ ); */
886 addrindex_start_search( _addressIndex_, _queryID_ );
890 * Apply the current selection in the list to the entry field. Focus is also
891 * moved to the next widget so that Tab key works correctly.
892 * \param clist List to process.
893 * \param entry Address entry field.
895 static void completion_window_apply_selection(GtkCList *clist, GtkEntry *entry)
897 gchar *address = NULL, *text = NULL;
898 gint cursor_pos, row;
901 g_return_if_fail(clist != NULL);
902 g_return_if_fail(entry != NULL);
903 g_return_if_fail(clist->selection != NULL);
905 /* First remove the idler */
906 if( _completionIdleID_ != 0 ) {
907 gtk_idle_remove( _completionIdleID_ );
908 _completionIdleID_ = 0;
911 /* Process selected item */
912 row = GPOINTER_TO_INT(clist->selection->data);
914 address = get_address_from_edit(entry, &cursor_pos);
916 gtk_clist_get_text(clist, row, 0, &text);
917 replace_address_in_edit(entry, text, cursor_pos);
919 /* Move focus to next widget */
920 parent = GTK_WIDGET(entry)->parent;
922 gtk_container_focus( GTK_CONTAINER(parent), GTK_DIR_TAB_FORWARD );
927 * Start address completion. Should be called when creating the main window
928 * containing address completion entries.
929 * \param mainwindow Main window.
931 void address_completion_start(GtkWidget *mainwindow)
933 start_address_completion();
935 /* register focus change hook */
936 gtk_signal_connect(GTK_OBJECT(mainwindow), "set_focus",
937 GTK_SIGNAL_FUNC(address_completion_mainwindow_set_focus),
942 * Need unique data to make unregistering signal handler possible for the auto
945 #define COMPLETION_UNIQUE_DATA (GINT_TO_POINTER(0xfeefaa))
948 * Register specified entry widget for address completion.
949 * \param entry Address entry field.
951 void address_completion_register_entry(GtkEntry *entry)
953 g_return_if_fail(entry != NULL);
954 g_return_if_fail(GTK_IS_ENTRY(entry));
956 /* add hooked property */
957 gtk_object_set_data(GTK_OBJECT(entry), ENTRY_DATA_TAB_HOOK, entry);
959 /* add keypress event */
960 gtk_signal_connect_full(GTK_OBJECT(entry), "key_press_event",
961 GTK_SIGNAL_FUNC(address_completion_entry_key_pressed),
963 COMPLETION_UNIQUE_DATA,
970 * Unregister specified entry widget from address completion operations.
971 * \param entry Address entry field.
973 void address_completion_unregister_entry(GtkEntry *entry)
975 GtkObject *entry_obj;
977 g_return_if_fail(entry != NULL);
978 g_return_if_fail(GTK_IS_ENTRY(entry));
980 entry_obj = gtk_object_get_data(GTK_OBJECT(entry), ENTRY_DATA_TAB_HOOK);
981 g_return_if_fail(entry_obj);
982 g_return_if_fail(entry_obj == GTK_OBJECT(entry));
984 /* has the hooked property? */
985 gtk_object_set_data(GTK_OBJECT(entry), ENTRY_DATA_TAB_HOOK, NULL);
987 /* remove the hook */
988 gtk_signal_disconnect_by_func(GTK_OBJECT(entry),
989 GTK_SIGNAL_FUNC(address_completion_entry_key_pressed),
990 COMPLETION_UNIQUE_DATA);
994 * End address completion. Should be called when main window with address
995 * completion entries terminates. NOTE: this function assumes that it is
996 * called upon destruction of the window.
997 * \param mainwindow Main window.
999 void address_completion_end(GtkWidget *mainwindow)
1001 /* if address_completion_end() is really called on closing the window,
1002 * we don't need to unregister the set_focus_cb */
1003 end_address_completion();
1006 /* if focus changes to another entry, then clear completion cache */
1007 static void address_completion_mainwindow_set_focus(GtkWindow *window,
1012 clear_completion_cache();
1016 * Listener that watches for tab or other keystroke in address entry field.
1017 * \param entry Address entry field.
1018 * \param ev Event object.
1019 * \param data User data.
1020 * \return <i>TRUE</i>.
1022 static gboolean address_completion_entry_key_pressed(GtkEntry *entry,
1026 if (ev->keyval == GDK_Tab) {
1027 addrcompl_clear_queue();
1029 if( address_completion_complete_address_in_entry( entry, TRUE ) ) {
1030 /* route a void character to the default handler */
1031 /* this is a dirty hack; we're actually changing a key
1032 * reported by the system. */
1033 ev->keyval = GDK_AudibleBell_Enable;
1034 ev->state &= ~GDK_SHIFT_MASK;
1035 gtk_signal_emit_stop_by_name(GTK_OBJECT(entry),
1039 address_completion_create_completion_window(entry);
1041 /* Start remote queries */
1042 addrcompl_start_search();
1047 } else if (ev->keyval == GDK_Shift_L
1048 || ev->keyval == GDK_Shift_R
1049 || ev->keyval == GDK_Control_L
1050 || ev->keyval == GDK_Control_R
1051 || ev->keyval == GDK_Caps_Lock
1052 || ev->keyval == GDK_Shift_Lock
1053 || ev->keyval == GDK_Meta_L
1054 || ev->keyval == GDK_Meta_R
1055 || ev->keyval == GDK_Alt_L
1056 || ev->keyval == GDK_Alt_R) {
1057 /* these buttons should not clear the cache... */
1059 clear_completion_cache();
1064 * Initialize search term for address completion.
1065 * \param entry Address entry field.
1067 static gboolean address_completion_complete_address_in_entry(GtkEntry *entry,
1070 gint ncount, cursor_pos;
1071 gchar *searchTerm, *new = NULL;
1073 g_return_val_if_fail(entry != NULL, FALSE);
1075 if (!GTK_WIDGET_HAS_FOCUS(entry)) return FALSE;
1077 /* get an address component from the cursor */
1078 searchTerm = get_address_from_edit( entry, &cursor_pos );
1079 if( ! searchTerm ) return FALSE;
1080 /* printf( "search for :::%s:::\n", searchTerm ); */
1082 /* Clear any existing search */
1083 if( _compWindow_->searchTerm ) {
1084 g_free( _compWindow_->searchTerm );
1086 _compWindow_->searchTerm = g_strdup( searchTerm );
1088 /* Perform search on local completion index */
1089 ncount = complete_address( searchTerm );
1091 new = get_next_complete_address();
1095 /* Make sure that drop-down appears uniform! */
1097 addrcompl_add_queue( g_strdup( searchTerm ) );
1099 g_free( searchTerm );
1105 * Create new address completion window for specified entry.
1106 * \param entry_ Entry widget to associate with window.
1108 static void address_completion_create_completion_window( GtkEntry *entry_ )
1110 gint x, y, height, width, depth;
1111 GtkWidget *scroll, *clist;
1114 GtkWidget *entry = GTK_WIDGET(entry_);
1116 /* Create new window and list */
1117 window = gtk_window_new(GTK_WINDOW_POPUP);
1118 clist = gtk_clist_new(1);
1120 /* Destroy any existing window */
1121 addrcompl_destroy_window( _compWindow_ );
1123 /* Create new object */
1124 _compWindow_->window = window;
1125 _compWindow_->entry = entry;
1126 _compWindow_->clist = clist;
1127 _compWindow_->listCount = 0;
1129 scroll = gtk_scrolled_window_new(NULL, NULL);
1130 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scroll),
1131 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
1132 gtk_container_add(GTK_CONTAINER(window), scroll);
1133 gtk_container_add(GTK_CONTAINER(scroll), clist);
1134 gtk_clist_set_selection_mode(GTK_CLIST(clist), GTK_SELECTION_SINGLE);
1136 /* Use entry widget to create initial window */
1137 gdk_window_get_geometry(entry->window, &x, &y, &width, &height, &depth);
1138 gdk_window_get_deskrelative_origin (entry->window, &x, &y);
1140 gtk_widget_set_uposition(window, x, y);
1142 /* Resize window to fit initial (empty) address list */
1143 gtk_widget_size_request( clist, &r );
1144 gtk_widget_set_usize( window, width, r.height );
1145 gtk_widget_show_all( window );
1146 gtk_widget_size_request( clist, &r );
1148 /* Setup handlers */
1149 gtk_signal_connect(GTK_OBJECT(clist), "select_row",
1150 GTK_SIGNAL_FUNC(completion_window_select_row),
1152 gtk_signal_connect(GTK_OBJECT(window),
1153 "button-press-event",
1154 GTK_SIGNAL_FUNC(completion_window_button_press),
1156 gtk_signal_connect(GTK_OBJECT(window),
1158 GTK_SIGNAL_FUNC(completion_window_key_press),
1160 gdk_pointer_grab(window->window, TRUE,
1161 GDK_POINTER_MOTION_MASK | GDK_BUTTON_PRESS_MASK |
1162 GDK_BUTTON_RELEASE_MASK,
1163 NULL, NULL, GDK_CURRENT_TIME);
1164 gtk_grab_add( window );
1166 /* this gets rid of the irritating focus rectangle that doesn't
1167 * follow the selection */
1168 GTK_WIDGET_UNSET_FLAGS(clist, GTK_CAN_FOCUS);
1172 * Respond to select row event in clist object. selection sends completed
1173 * address to entry. Note: event is NULL if selected by anything else than a
1175 * \param widget Window object.
1176 * \param event Event.
1177 * \param compWind Reference to completion window.
1179 static void completion_window_select_row(GtkCList *clist, gint row, gint col,
1181 CompletionWindow *compWin )
1185 g_return_if_fail(compWin != NULL);
1187 entry = GTK_ENTRY(compWin->entry);
1188 g_return_if_fail(entry != NULL);
1190 /* Don't update unless user actually selects ! */
1191 if (!event || event->type != GDK_BUTTON_RELEASE)
1194 /* User selected address by releasing the mouse in drop-down list*/
1195 completion_window_apply_selection( clist, entry );
1197 clear_completion_cache();
1198 addrcompl_destroy_window( _compWindow_ );
1202 * Respond to button press in completion window. Check if mouse click is
1203 * anywhere outside the completion window. In that case the completion
1204 * window is destroyed, and the original searchTerm is restored.
1206 * \param widget Window object.
1207 * \param event Event.
1208 * \param compWin Reference to completion window.
1210 static gboolean completion_window_button_press(GtkWidget *widget,
1211 GdkEventButton *event,
1212 CompletionWindow *compWin )
1214 GtkWidget *event_widget, *entry;
1217 gboolean restore = TRUE;
1219 g_return_val_if_fail(compWin != NULL, FALSE);
1221 entry = compWin->entry;
1222 g_return_val_if_fail(entry != NULL, FALSE);
1224 /* Test where mouse was clicked */
1225 event_widget = gtk_get_event_widget((GdkEvent *)event);
1226 if (event_widget != widget) {
1227 while (event_widget) {
1228 if (event_widget == widget)
1230 else if (event_widget == entry) {
1234 event_widget = event_widget->parent;
1239 /* Clicked outside of completion window - restore */
1240 searchTerm = _compWindow_->searchTerm;
1241 g_free(get_address_from_edit(GTK_ENTRY(entry), &cursor_pos));
1242 replace_address_in_edit(GTK_ENTRY(entry), searchTerm, cursor_pos);
1245 clear_completion_cache();
1246 addrcompl_destroy_window( _compWindow_ );
1252 * Respond to key press in completion window.
1253 * \param widget Window object.
1254 * \param event Event.
1255 * \param compWind Reference to completion window.
1257 static gboolean completion_window_key_press(GtkWidget *widget,
1259 CompletionWindow *compWin )
1261 GdkEventKey tmp_event;
1268 g_return_val_if_fail(compWin != NULL, FALSE);
1270 entry = compWin->entry;
1271 clist = compWin->clist;
1272 g_return_val_if_fail(entry != NULL, FALSE);
1274 /* allow keyboard navigation in the alternatives clist */
1275 if (event->keyval == GDK_Up || event->keyval == GDK_Down ||
1276 event->keyval == GDK_Page_Up || event->keyval == GDK_Page_Down) {
1277 completion_window_advance_selection
1279 event->keyval == GDK_Down ||
1280 event->keyval == GDK_Page_Down ? TRUE : FALSE);
1285 /* also make tab / shift tab go to next previous completion entry. we're
1286 * changing the key value */
1287 if (event->keyval == GDK_Tab || event->keyval == GDK_ISO_Left_Tab) {
1288 event->keyval = (event->state & GDK_SHIFT_MASK)
1289 ? GDK_Up : GDK_Down;
1290 /* need to reset shift state if going up */
1291 if (event->state & GDK_SHIFT_MASK)
1292 event->state &= ~GDK_SHIFT_MASK;
1293 completion_window_advance_selection(GTK_CLIST(clist),
1294 event->keyval == GDK_Down ? TRUE : FALSE);
1299 /* make tab move to next field */
1300 if( event->keyval == GDK_Tab ) {
1301 /* Reference to parent */
1302 parent = GTK_WIDGET(entry)->parent;
1304 /* Discard the window */
1305 clear_completion_cache();
1306 addrcompl_destroy_window( _compWindow_ );
1308 /* Move focus to next widget */
1310 gtk_container_focus( GTK_CONTAINER(parent), GTK_DIR_TAB_FORWARD );
1315 /* make backtab move to previous field */
1316 if( event->keyval == GDK_ISO_Left_Tab ) {
1317 /* Reference to parent */
1318 parent = GTK_WIDGET(entry)->parent;
1320 /* Discard the window */
1321 clear_completion_cache();
1322 addrcompl_destroy_window( _compWindow_ );
1324 /* Move focus to previous widget */
1326 gtk_container_focus( GTK_CONTAINER(parent), GTK_DIR_TAB_BACKWARD );
1331 /* look for presses that accept the selection */
1332 if (event->keyval == GDK_Return || event->keyval == GDK_space) {
1333 /* User selected address with a key press */
1335 /* Display selected address in entry field */
1336 completion_window_apply_selection(
1337 GTK_CLIST(clist), GTK_ENTRY(entry) );
1339 /* Discard the window */
1340 clear_completion_cache();
1341 addrcompl_destroy_window( _compWindow_ );
1345 /* key state keys should never be handled */
1346 if (event->keyval == GDK_Shift_L
1347 || event->keyval == GDK_Shift_R
1348 || event->keyval == GDK_Control_L
1349 || event->keyval == GDK_Control_R
1350 || event->keyval == GDK_Caps_Lock
1351 || event->keyval == GDK_Shift_Lock
1352 || event->keyval == GDK_Meta_L
1353 || event->keyval == GDK_Meta_R
1354 || event->keyval == GDK_Alt_L
1355 || event->keyval == GDK_Alt_R) {
1359 /* some other key, let's restore the searchTerm (orignal text) */
1360 searchTerm = _compWindow_->searchTerm;
1361 g_free(get_address_from_edit(GTK_ENTRY(entry), &cursor_pos));
1362 replace_address_in_edit(GTK_ENTRY(entry), searchTerm, cursor_pos);
1364 /* make sure anything we typed comes in the edit box */
1365 tmp_event.type = event->type;
1366 tmp_event.window = entry->window;
1367 tmp_event.send_event = TRUE;
1368 tmp_event.time = event->time;
1369 tmp_event.state = event->state;
1370 tmp_event.keyval = event->keyval;
1371 tmp_event.length = event->length;
1372 tmp_event.string = event->string;
1373 gtk_widget_event(entry, (GdkEvent *)&tmp_event);
1375 /* and close the completion window */
1376 clear_completion_cache();
1377 addrcompl_destroy_window( _compWindow_ );
1383 * ============================================================================
1384 * Publically accessible functions.
1385 * ============================================================================
1389 * Setup completion object.
1390 * \param addrIndex Address index object.
1392 void addrcompl_initialize( AddressIndex *addrIndex ) {
1393 g_return_if_fail( addrIndex != NULL );
1394 _addressIndex_ = addrIndex;
1396 /* printf( "addrcompl_initialize...\n" ); */
1397 if( ! _compWindow_ ) {
1398 _compWindow_ = addrcompl_create_window();
1401 _completionIdleID_ = 0;
1402 /* printf( "addrcompl_initialize...done\n" ); */
1406 * Teardown completion object.
1408 void addrcompl_teardown( void ) {
1409 /* printf( "addrcompl_teardown...\n" ); */
1410 addrcompl_free_window( _compWindow_ );
1411 _compWindow_ = NULL;
1412 if( _displayQueue_ ) {
1413 g_list_free( _displayQueue_ );
1415 _displayQueue_ = NULL;
1416 _completionIdleID_ = 0;
1417 _addressIndex_ = NULL;
1418 /* printf( "addrcompl_teardown...done\n" ); */