2 * This file is part of DisOrder
3 * Copyright (C) 2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file disobedience/search.c
21 * @brief Search support
23 #include "disobedience.h"
26 int choose_auto_expanding
;
28 GtkWidget
*choose_search_entry
;
29 static GtkWidget
*choose_next
;
30 static GtkWidget
*choose_prev
;
31 static GtkWidget
*choose_clear
;
33 /** @brief True if a search command is in flight */
34 static int choose_searching
;
36 /** @brief True if in-flight search is now known to be obsolete */
37 static int choose_search_obsolete
;
39 /** @brief Current search terms */
40 static char *choose_search_terms
;
42 /** @brief Hash of all search result */
43 static hash
*choose_search_hash
;
45 /** @brief List of invisible search results
47 * This only lists search results not yet known to be visible, and is
50 static char **choose_search_results
;
52 /** @brief Length of @ref choose_search_results */
53 static int choose_n_search_results
;
55 /** @brief Row references for search results */
56 static GtkTreeRowReference
**choose_search_references
;
58 /** @brief Length of @ref choose_search_references */
59 static int choose_n_search_references
;
61 /** @brief Event handle for monitoring newly inserted tracks */
62 static event_handle choose_inserted_handle
;
64 /** @brief Time of last search entry keypress (or 0.0) */
65 static struct timeval choose_search_last_keypress
;
67 /** @brief Timeout ID for search delay */
68 static guint choose_search_timeout_id
;
70 static void choose_search_entry_changed(GtkEditable
*editable
,
73 int choose_is_search_result(const char *track
) {
74 return choose_search_hash
&& hash_find(choose_search_hash
, track
);
77 static int is_prefix(const char *dir
, const char *track
) {
78 size_t nd
= strlen(dir
);
82 && !strncmp(track
, dir
, nd
))
88 /** @brief Do some work towards making @p track visible
89 * @return True if we made it visible or it was missing
91 static int choose_make_one_visible(const char *track
) {
92 //fprintf(stderr, " choose_make_one_visible %s\n", track);
93 /* We walk through nodes at the top level looking for directories that are
94 * prefixes of the target track.
96 * - if we find one and it's expanded we walk through its children
97 * - if we find one and it's NOT expanded then we expand it, and arrange
99 * - if we don't find one then we're probably out of date
102 gboolean itv
= gtk_tree_model_get_iter_first(GTK_TREE_MODEL(choose_store
),
105 const char *dir
= choose_get_track(it
);
107 //fprintf(stderr, " %s\n", dir);
110 itv
= gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store
), it
);
113 GtkTreePath
*path
= gtk_tree_model_get_path(GTK_TREE_MODEL(choose_store
),
115 if(!strcmp(dir
, track
)) {
116 /* We found the track. If everything above it was expanded, it will be
117 * too. So we can report it as visible. */
118 //fprintf(stderr, " found %s\n", track);
119 choose_search_references
[choose_n_search_references
++]
120 = gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
), path
);
121 gtk_tree_path_free(path
);
124 if(is_prefix(dir
, track
)) {
125 /* We found a prefix of the target track. */
126 //fprintf(stderr, " %s is a prefix\n", dir);
127 const gboolean expanded
128 = gtk_tree_view_row_expanded(GTK_TREE_VIEW(choose_view
), path
);
130 //fprintf(stderr, " is apparently expanded\n");
131 /* This directory is expanded, let's make like Augustus Gibbons and
132 * take it to the next level. */
133 GtkTreeIter child
[1]; /* don't know if parent==iter allowed */
134 itv
= gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store
),
138 if(choose_is_placeholder(it
)) {
139 //fprintf(stderr, " %s is expanded, has a placeholder child\n", dir);
140 /* We assume that placeholder children of expanded rows are about to
142 gtk_tree_path_free(path
);
146 //fprintf(stderr, " requesting expansion of %s\n", dir);
147 /* Track is below a non-expanded directory. So let's expand it.
148 * choose_make_visible() will arrange a revisit in due course.
150 * We mark the row as auto-expanded.
152 ++choose_auto_expanding
;
153 gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view
),
156 gtk_tree_path_free(path
);
157 --choose_auto_expanding
;
161 itv
= gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store
), it
);
162 gtk_tree_path_free(path
);
164 /* If we reach the end then we didn't find the track at all. */
165 fprintf(stderr
, "choose_make_one_visible: could not find %s\n",
170 /** @brief Compare two GtkTreeRowReferences
172 * Not very efficient since it does multiple memory operations per
175 static int choose_compare_references(const void *av
, const void *bv
) {
176 GtkTreeRowReference
*a
= *(GtkTreeRowReference
**)av
;
177 GtkTreeRowReference
*b
= *(GtkTreeRowReference
**)bv
;
178 GtkTreePath
*pa
= gtk_tree_row_reference_get_path(a
);
179 GtkTreePath
*pb
= gtk_tree_row_reference_get_path(b
);
180 const int rc
= gtk_tree_path_compare(pa
, pb
);
181 gtk_tree_path_free(pa
);
182 gtk_tree_path_free(pb
);
186 /** @brief Make @p path visible
187 * @param path Row reference to make visible
188 * @param row_align Row alignment (or -ve)
189 * @return 0 on success, nonzero if @p ref has gone stale
191 * If @p row_align is negative no row alignemt is performed. Otherwise
192 * it must be between 0 (the top) and 1 (the bottom).
194 * TODO: if the row is already visible do nothing.
196 static int choose_make_path_visible(GtkTreePath
*path
,
198 /* Make sure that the target's parents are all expanded */
199 gtk_tree_view_expand_to_path(GTK_TREE_VIEW(choose_view
), path
);
200 /* Make sure the target is visible */
201 gtk_tree_view_scroll_to_cell(GTK_TREE_VIEW(choose_view
), path
, NULL
,
208 /** @brief Make @p ref visible
209 * @param ref Row reference to make visible
210 * @param row_align Row alignment (or -ve)
211 * @return 0 on success, nonzero if @p ref has gone stale
213 * If @p row_align is negative no row alignemt is performed. Otherwise
214 * it must be between 0 (the top) and 1 (the bottom).
216 static int choose_make_ref_visible(GtkTreeRowReference
*ref
,
218 GtkTreePath
*path
= gtk_tree_row_reference_get_path(ref
);
221 choose_make_path_visible(path
, row_align
);
222 gtk_tree_path_free(path
);
226 /** @brief Do some work towards ensuring that all search results are visible
228 * Assumes there's at least one results!
230 static void choose_make_visible(const char attribute((unused
)) *event
,
231 void attribute((unused
)) *eventdata
,
232 void attribute((unused
)) *callbackdata
) {
233 //fprintf(stderr, "choose_make_visible\n");
236 for(int n
= 0; n
< choose_n_search_results
; ++n
) {
237 if(!choose_search_results
[n
])
239 if(choose_make_one_visible(choose_search_results
[n
]))
240 choose_search_results
[n
] = 0;
244 //fprintf(stderr, "remaining=%d\n", remaining);
246 /* If there's work left to be done make sure we get a callback when
247 * something changes */
248 if(!choose_inserted_handle
)
249 choose_inserted_handle
= event_register("choose-more-tracks",
250 choose_make_visible
, 0);
252 /* Suppress callbacks if there's nothing more to do */
253 event_cancel(choose_inserted_handle
);
254 choose_inserted_handle
= 0;
255 /* We've expanded everything, now we can mess with the cursor */
256 //fprintf(stderr, "sort %d references\n", choose_n_search_references);
257 qsort(choose_search_references
,
258 choose_n_search_references
,
259 sizeof (GtkTreeRowReference
*),
260 choose_compare_references
);
261 choose_make_ref_visible(choose_search_references
[0], 0.5);
265 /** @brief Called with search results */
266 static void choose_search_completed(void attribute((unused
)) *v
,
268 int nvec
, char **vec
) {
269 //fprintf(stderr, "choose_search_completed\n");
271 popup_protocol_error(0, error
);
274 choose_searching
= 0;
275 /* If the search was obsoleted initiate another one */
276 if(choose_search_obsolete
) {
277 choose_search_obsolete
= 0;
278 choose_search_entry_changed(0, 0);
281 //fprintf(stderr, "*** %d search results\n", nvec);
282 /* We're actually going to use these search results. Autocollapse anything
283 * left over from the old search. */
284 choose_auto_collapse();
285 choose_search_hash
= hash_new(1);
287 for(int n
= 0; n
< nvec
; ++n
)
288 hash_add(choose_search_hash
, vec
[n
], "", HASH_INSERT
);
289 /* Stash results for choose_make_visible */
290 choose_n_search_results
= nvec
;
291 choose_search_results
= vec
;
292 /* Make a big-enough buffer for the results row reference list */
293 choose_n_search_references
= 0;
294 choose_search_references
= xcalloc(nvec
, sizeof (GtkTreeRowReference
*));
295 /* Start making rows visible */
296 choose_make_visible(0, 0, 0);
297 gtk_widget_set_sensitive(choose_next
, TRUE
);
298 gtk_widget_set_sensitive(choose_prev
, TRUE
);
300 gtk_widget_set_sensitive(choose_next
, FALSE
);
301 gtk_widget_set_sensitive(choose_prev
, FALSE
);
302 choose_n_search_results
= 0;
303 choose_search_results
= 0;
304 choose_n_search_references
= 0;
305 choose_search_references
= 0;
307 event_raise("search-results-changed", 0);
310 /** @brief Actually initiate a search */
311 static void initiate_search(void) {
312 //fprintf(stderr, "initiate_search\n");
313 /* If a search is in flight don't initiate a new one until it comes back */
314 if(choose_searching
) {
315 choose_search_obsolete
= 1;
318 char *terms
= xstrdup(gtk_entry_get_text(GTK_ENTRY(choose_search_entry
)));
319 /* Strip leading and trailing space */
322 char *e
= terms
+ strlen(terms
);
323 while(e
> terms
&& e
[-1] == ' ')
326 if(choose_search_terms
&& !strcmp(terms
, choose_search_terms
)) {
327 /* Search terms have not actually changed in any way that matters */
330 /* Remember the current terms */
331 choose_search_terms
= terms
;
333 /* Nothing to search for. Fake a completion call. */
334 choose_search_completed(0, 0, 0, 0);
337 if(disorder_eclient_search(client
, choose_search_completed
, terms
, 0)) {
338 /* Bad search terms. Fake a completion call. */
339 choose_search_completed(0, 0, 0, 0);
342 choose_searching
= 1;
345 static gboolean
choose_search_timeout(gpointer
attribute((unused
)) data
) {
347 xgettimeofday(&now
, NULL
);
348 /*fprintf(stderr, "%ld.%06d choose_search_timeout\n",
349 now.tv_sec, now.tv_usec);*/
350 if(tvdouble(now
) - tvdouble(choose_search_last_keypress
)
351 < SEARCH_DELAY_MS
/ 1000.0) {
352 //fprintf(stderr, " ... too soon\n");
353 return TRUE
; /* Call me again later */
355 //fprintf(stderr, " ... let's go\n");
356 choose_search_last_keypress
.tv_sec
= 0;
357 choose_search_last_keypress
.tv_usec
= 0;
358 choose_search_timeout_id
= 0;
363 /** @brief Called when the search entry changes */
364 static void choose_search_entry_changed
365 (GtkEditable
attribute((unused
)) *editable
,
366 gpointer
attribute((unused
)) user_data
) {
367 xgettimeofday(&choose_search_last_keypress
, NULL
);
368 /*fprintf(stderr, "%ld.%06d choose_search_entry_changed\n",
369 choose_search_last_keypress.tv_sec,
370 choose_search_last_keypress.tv_usec);*/
371 /* If there's already a timeout, remove it */
372 if(choose_search_timeout_id
) {
373 g_source_remove(choose_search_timeout_id
);
374 choose_search_timeout_id
= 0;
376 /* Add a new timeout */
377 choose_search_timeout_id
= g_timeout_add(SEARCH_DELAY_MS
/ 10,
378 choose_search_timeout
,
380 /* We really wanted to tell Glib what time we wanted the callback at rather
381 * than asking for calls at given intervals. But there's no interface for
382 * that, and defining a new source for it seems like overkill if we can
383 * reasonably avoid it. */
386 /** @brief Identify first and last visible paths
388 * We'd like to use gtk_tree_view_get_visible_range() for this, but that was
389 * introduced in GTK+ 2.8, and Fink only has 2.6 (which is around three years
390 * out of date at time of writing), and I'm not yet prepared to rule out Fink
393 static gboolean
choose_get_visible_range(GtkTreeView
*tree_view
,
394 GtkTreePath
**startpathp
,
395 GtkTreePath
**endpathp
) {
396 GdkRectangle visible_tc
[1];
398 /* Get the visible rectangle in tree coordinates */
399 gtk_tree_view_get_visible_rect(tree_view
, visible_tc
);
400 /*fprintf(stderr, "visible: %dx%x at %dx%d\n",
401 visible_tc->width, visible_tc->height,
402 visible_tc->x, visible_tc->y);*/
404 /* Convert top-left visible point to widget coordinates */
406 gtk_tree_view_tree_to_widget_coords(tree_view
,
407 visible_tc
->x
, visible_tc
->y
,
409 //fprintf(stderr, " start widget coords: %dx%d\n", x_wc, y_wc);
410 gtk_tree_view_get_path_at_pos(tree_view
,
417 /* Convert bottom-left visible point to widget coordinates */
418 /* Convert top-left visible point to widget coordinates */
420 gtk_tree_view_tree_to_widget_coords(tree_view
,
422 visible_tc
->y
+ visible_tc
->height
- 1,
424 //fprintf(stderr, " end widget coords: %dx%d\n", x_wc, y_wc);
425 gtk_tree_view_get_path_at_pos(tree_view
,
434 void choose_next_clicked(GtkButton
attribute((unused
)) *button
,
435 gpointer
attribute((unused
)) userdata
) {
436 gtk_widget_grab_focus(choose_view
);
437 if(!choose_n_search_results
)
439 /* Find the last visible row */
440 GtkTreePath
*endpath
;
441 gboolean endvalid
= choose_get_visible_range(GTK_TREE_VIEW(choose_view
),
446 /* Find a the first search result later than it. They're sorted so we could
447 * actually do much better than this if necessary. */
448 for(int n
= 0; n
< choose_n_search_references
; ++n
) {
450 = gtk_tree_row_reference_get_path(choose_search_references
[n
]);
453 if(gtk_tree_path_compare(endpath
, path
) < 0) {
454 choose_make_path_visible(path
, 0.5);
455 gtk_tree_path_free(path
);
458 gtk_tree_path_free(path
);
460 /* We didn't find one. Loop back to the first. */
461 for(int n
= 0; n
< choose_n_search_references
; ++n
) {
463 = gtk_tree_row_reference_get_path(choose_search_references
[n
]);
466 choose_make_path_visible(path
, 0.5);
467 gtk_tree_path_free(path
);
472 void choose_prev_clicked(GtkButton
attribute((unused
)) *button
,
473 gpointer
attribute((unused
)) userdata
) {
474 gtk_widget_grab_focus(choose_view
);
475 /* TODO can we de-dupe with choose_next_clicked? Probably yes. */
476 if(!choose_n_search_results
)
478 /* Find the first visible row */
479 GtkTreePath
*startpath
;
480 gboolean startvalid
= choose_get_visible_range(GTK_TREE_VIEW(choose_view
),
485 /* Find a the last search result earlier than it. They're sorted so we could
486 * actually do much better than this if necessary. */
487 for(int n
= choose_n_search_references
- 1; n
>= 0; --n
) {
489 = gtk_tree_row_reference_get_path(choose_search_references
[n
]);
492 if(gtk_tree_path_compare(startpath
, path
) > 0) {
493 choose_make_path_visible(path
, 0.5);
494 gtk_tree_path_free(path
);
497 gtk_tree_path_free(path
);
499 /* We didn't find one. Loop down to the last. */
500 for(int n
= choose_n_search_references
- 1; n
>= 0; --n
) {
502 = gtk_tree_row_reference_get_path(choose_search_references
[n
]);
505 choose_make_path_visible(path
, 0.5);
506 gtk_tree_path_free(path
);
511 /** @brief Called when the cancel search button is clicked */
512 static void choose_clear_clicked(GtkButton
attribute((unused
)) *button
,
513 gpointer
attribute((unused
)) userdata
) {
514 gtk_entry_set_text(GTK_ENTRY(choose_search_entry
), "");
515 gtk_widget_grab_focus(choose_view
);
516 /* We start things off straight away in this case */
520 /** @brief Called when the user hits ^F to start a new search */
521 void choose_search_new(void) {
522 gtk_editable_select_region(GTK_EDITABLE(choose_search_entry
), 0, -1);
525 /** @brief Create the search widget */
526 GtkWidget
*choose_search_widget(void) {
528 /* Text entry box for search terms */
529 choose_search_entry
= gtk_entry_new();
530 gtk_widget_set_style(choose_search_entry
, tool_style
);
531 g_signal_connect(choose_search_entry
, "changed",
532 G_CALLBACK(choose_search_entry_changed
), 0);
533 gtk_tooltips_set_tip(tips
, choose_search_entry
,
534 "Enter search terms here; search is automatic", "");
536 /* Cancel button to clear the search */
537 choose_clear
= gtk_button_new_from_stock(GTK_STOCK_CANCEL
);
538 gtk_widget_set_style(choose_clear
, tool_style
);
539 g_signal_connect(G_OBJECT(choose_clear
), "clicked",
540 G_CALLBACK(choose_clear_clicked
), 0);
541 gtk_tooltips_set_tip(tips
, choose_clear
, "Clear search terms", "");
543 /* Up and down buttons to find previous/next results; initially they are not
544 * usable as there are no search results. */
545 choose_prev
= iconbutton("up.png", "Previous search result");
546 g_signal_connect(G_OBJECT(choose_prev
), "clicked",
547 G_CALLBACK(choose_prev_clicked
), 0);
548 gtk_widget_set_style(choose_prev
, tool_style
);
549 gtk_widget_set_sensitive(choose_prev
, 0);
550 choose_next
= iconbutton("down.png", "Next search result");
551 g_signal_connect(G_OBJECT(choose_next
), "clicked",
552 G_CALLBACK(choose_next_clicked
), 0);
553 gtk_widget_set_style(choose_next
, tool_style
);
554 gtk_widget_set_sensitive(choose_next
, 0);
556 /* Pack the search tools button together on a line */
557 GtkWidget
*hbox
= gtk_hbox_new(FALSE
/*homogeneous*/, 1/*spacing*/);
558 gtk_box_pack_start(GTK_BOX(hbox
), choose_search_entry
,
559 TRUE
/*expand*/, TRUE
/*fill*/, 0/*padding*/);
560 gtk_box_pack_start(GTK_BOX(hbox
), choose_prev
,
561 FALSE
/*expand*/, FALSE
/*fill*/, 0/*padding*/);
562 gtk_box_pack_start(GTK_BOX(hbox
), choose_next
,
563 FALSE
/*expand*/, FALSE
/*fill*/, 0/*padding*/);
564 gtk_box_pack_start(GTK_BOX(hbox
), choose_clear
,
565 FALSE
/*expand*/, FALSE
/*fill*/, 0/*padding*/);