1 /* isearch.c - incremental searching */
3 /* **************************************************************** */
5 /* I-Search and Searching */
7 /* **************************************************************** */
9 /* Copyright (C) 1987-2008 Free Software Foundation, Inc.
11 This file is part of the GNU Readline Library (Readline), a library
12 for reading lines of text with interactive input and history editing.
14 Readline is free software: you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
19 Readline is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with Readline. If not, see <http://www.gnu.org/licenses/>.
28 #define READLINE_LIBRARY
30 #if defined (HAVE_CONFIG_H)
34 #include <sys/types.h>
38 #if defined (HAVE_UNISTD_H)
42 #if defined (HAVE_STDLIB_H)
45 # include "ansi_stdlib.h"
54 #include "rlprivate.h"
57 /* Variables exported to other files in the readline library. */
58 char *_rl_isearch_terminators
= (char *)NULL
;
60 _rl_search_cxt
*_rl_iscxt
= 0;
62 /* Variables imported from other files in the readline library. */
63 extern HIST_ENTRY
*_rl_saved_line_for_history
;
65 static int rl_search_history
PARAMS((int, int));
67 static _rl_search_cxt
*_rl_isearch_init
PARAMS((int));
68 static void _rl_isearch_fini
PARAMS((_rl_search_cxt
*));
69 static int _rl_isearch_cleanup
PARAMS((_rl_search_cxt
*, int));
71 /* Last line found by the current incremental search, so we don't `find'
72 identical lines many times in a row. Now part of isearch context. */
73 /* static char *prev_line_found; */
75 /* Last search string and its length. */
76 static char *last_isearch_string
;
77 static int last_isearch_string_len
;
79 static char * const default_isearch_terminators
= "\033\012";
82 _rl_scxt_alloc (type
, flags
)
87 cxt
= (_rl_search_cxt
*)xmalloc (sizeof (_rl_search_cxt
));
92 cxt
->search_string
= 0;
93 cxt
->search_string_size
= cxt
->search_string_index
= 0;
96 cxt
->allocated_line
= 0;
97 cxt
->hlen
= cxt
->hindex
= 0;
99 cxt
->save_point
= rl_point
;
100 cxt
->save_mark
= rl_mark
;
101 cxt
->save_line
= where_history ();
102 cxt
->last_found_line
= cxt
->save_line
;
103 cxt
->prev_line_found
= 0;
105 cxt
->save_undo_list
= 0;
107 cxt
->history_pos
= 0;
113 cxt
->sline_len
= cxt
->sline_index
= 0;
115 cxt
->search_terminators
= 0;
121 _rl_scxt_dispose (cxt
, flags
)
125 FREE (cxt
->search_string
);
126 FREE (cxt
->allocated_line
);
132 /* Search backwards through the history looking for a string which is typed
133 interactively. Start with the current line. */
135 rl_reverse_search_history (sign
, key
)
138 return (rl_search_history (-sign
, key
));
141 /* Search forwards through the history looking for a string which is typed
142 interactively. Start with the current line. */
144 rl_forward_search_history (sign
, key
)
147 return (rl_search_history (sign
, key
));
150 /* Display the current state of the search in the echo-area.
151 SEARCH_STRING contains the string that is being searched for,
152 DIRECTION is zero for forward, or non-zero for reverse,
153 WHERE is the history list number of the current line. If it is
154 -1, then this line is the starting one. */
156 rl_display_search (search_string
, reverse_p
, where
)
158 int reverse_p
, where
;
161 int msglen
, searchlen
;
163 searchlen
= (search_string
&& *search_string
) ? strlen (search_string
) : 0;
165 message
= (char *)xmalloc (searchlen
+ 33);
171 sprintf (message
, "[%d]", where
+ history_base
);
172 msglen
= strlen (message
);
176 message
[msglen
++] = '(';
180 strcpy (message
+ msglen
, "reverse-");
184 strcpy (message
+ msglen
, "i-search)`");
189 strcpy (message
+ msglen
, search_string
);
193 strcpy (message
+ msglen
, "': ");
195 rl_message ("%s", message
);
197 (*rl_redisplay_function
) ();
200 static _rl_search_cxt
*
201 _rl_isearch_init (direction
)
208 cxt
= _rl_scxt_alloc (RL_SEARCH_ISEARCH
, 0);
210 cxt
->sflags
|= SF_REVERSE
;
212 cxt
->search_terminators
= _rl_isearch_terminators
? _rl_isearch_terminators
213 : default_isearch_terminators
;
215 /* Create an arrary of pointers to the lines that we want to search. */
216 hlist
= history_list ();
217 rl_maybe_replace_line ();
220 for (i
= 0; hlist
[i
]; i
++);
222 /* Allocate space for this many lines, +1 for the current input line,
223 and remember those lines. */
224 cxt
->lines
= (char **)xmalloc ((1 + (cxt
->hlen
= i
)) * sizeof (char *));
225 for (i
= 0; i
< cxt
->hlen
; i
++)
226 cxt
->lines
[i
] = hlist
[i
]->line
;
228 if (_rl_saved_line_for_history
)
229 cxt
->lines
[i
] = _rl_saved_line_for_history
->line
;
232 /* Keep track of this so we can free it. */
233 cxt
->allocated_line
= (char *)xmalloc (1 + strlen (rl_line_buffer
));
234 strcpy (cxt
->allocated_line
, &rl_line_buffer
[0]);
235 cxt
->lines
[i
] = cxt
->allocated_line
;
240 /* The line where we start the search. */
241 cxt
->history_pos
= cxt
->save_line
;
245 /* Initialize search parameters. */
246 cxt
->search_string
= (char *)xmalloc (cxt
->search_string_size
= 128);
247 cxt
->search_string
[cxt
->search_string_index
= 0] = '\0';
249 /* Normalize DIRECTION into 1 or -1. */
250 cxt
->direction
= (direction
>= 0) ? 1 : -1;
252 cxt
->sline
= rl_line_buffer
;
253 cxt
->sline_len
= strlen (cxt
->sline
);
254 cxt
->sline_index
= rl_point
;
256 _rl_iscxt
= cxt
; /* save globally */
262 _rl_isearch_fini (cxt
)
265 /* First put back the original state. */
266 strcpy (rl_line_buffer
, cxt
->lines
[cxt
->save_line
]);
268 rl_restore_prompt ();
270 /* Save the search string for possible later use. */
271 FREE (last_isearch_string
);
272 last_isearch_string
= cxt
->search_string
;
273 last_isearch_string_len
= cxt
->search_string_index
;
274 cxt
->search_string
= 0;
276 if (cxt
->last_found_line
< cxt
->save_line
)
277 rl_get_previous_history (cxt
->save_line
- cxt
->last_found_line
, 0);
279 rl_get_next_history (cxt
->last_found_line
- cxt
->save_line
, 0);
281 /* If the string was not found, put point at the end of the last matching
282 line. If last_found_line == orig_line, we didn't find any matching
283 history lines at all, so put point back in its original position. */
284 if (cxt
->sline_index
< 0)
286 if (cxt
->last_found_line
== cxt
->save_line
)
287 cxt
->sline_index
= cxt
->save_point
;
289 cxt
->sline_index
= strlen (rl_line_buffer
);
290 rl_mark
= cxt
->save_mark
;
293 rl_point
= cxt
->sline_index
;
294 /* Don't worry about where to put the mark here; rl_get_previous_history
295 and rl_get_next_history take care of it. */
301 _rl_search_getchar (cxt
)
306 /* Read a key and decide how to proceed. */
307 RL_SETSTATE(RL_STATE_MOREINPUT
);
308 c
= cxt
->lastc
= rl_read_key ();
309 RL_UNSETSTATE(RL_STATE_MOREINPUT
);
311 #if defined (HANDLE_MULTIBYTE)
312 if (MB_CUR_MAX
> 1 && rl_byte_oriented
== 0)
313 c
= cxt
->lastc
= _rl_read_mbstring (cxt
->lastc
, cxt
->mb
, MB_LEN_MAX
);
319 /* Process just-read character C according to isearch context CXT. Return
320 -1 if the caller should just free the context and return, 0 if we should
321 break out of the loop, and 1 if we should continue to read characters. */
323 _rl_isearch_dispatch (cxt
, c
)
327 int n
, wstart
, wlen
, limit
, cval
;
328 rl_command_func_t
*f
;
330 f
= (rl_command_func_t
*)NULL
;
334 cxt
->sflags
|= SF_FAILED
;
335 cxt
->history_pos
= cxt
->last_found_line
;
339 /* Translate the keys we do something with to opcodes. */
340 if (c
>= 0 && _rl_keymap
[c
].type
== ISFUNC
)
342 f
= _rl_keymap
[c
].function
;
344 if (f
== rl_reverse_search_history
)
345 cxt
->lastc
= (cxt
->sflags
& SF_REVERSE
) ? -1 : -2;
346 else if (f
== rl_forward_search_history
)
347 cxt
->lastc
= (cxt
->sflags
& SF_REVERSE
) ? -2 : -1;
348 else if (f
== rl_rubout
)
350 else if (c
== CTRL ('G'))
352 else if (c
== CTRL ('W')) /* XXX */
354 else if (c
== CTRL ('Y')) /* XXX */
358 /* The characters in isearch_terminators (set from the user-settable
359 variable isearch-terminators) are used to terminate the search but
360 not subsequently execute the character as a command. The default
361 value is "\033\012" (ESC and C-J). */
362 if (strchr (cxt
->search_terminators
, cxt
->lastc
))
364 /* ESC still terminates the search, but if there is pending
365 input or if input arrives within 0.1 seconds (on systems
366 with select(2)) it is used as a prefix character
367 with rl_execute_next. WATCH OUT FOR THIS! This is intended
368 to allow the arrow keys to be used like ^F and ^B are used
369 to terminate the search and execute the movement command.
370 XXX - since _rl_input_available depends on the application-
371 settable keyboard timeout value, this could alternatively
372 use _rl_input_queued(100000) */
373 if (cxt
->lastc
== ESC
&& _rl_input_available ())
374 rl_execute_next (ESC
);
378 #define ENDSRCH_CHAR(c) \
379 ((CTRL_CHAR (c) || META_CHAR (c) || (c) == RUBOUT) && ((c) != CTRL ('G')))
381 #if defined (HANDLE_MULTIBYTE)
382 if (MB_CUR_MAX
> 1 && rl_byte_oriented
== 0)
384 if (cxt
->lastc
>= 0 && (cxt
->mb
[0] && cxt
->mb
[1] == '\0') && ENDSRCH_CHAR (cxt
->lastc
))
386 /* This sets rl_pending_input to c; it will be picked up the next
387 time rl_read_key is called. */
388 rl_execute_next (cxt
->lastc
);
394 if (cxt
->lastc
>= 0 && ENDSRCH_CHAR (cxt
->lastc
))
396 /* This sets rl_pending_input to LASTC; it will be picked up the next
397 time rl_read_key is called. */
398 rl_execute_next (cxt
->lastc
);
402 /* Now dispatch on the character. `Opcodes' affect the search string or
403 state. Other characters are added to the string. */
408 if (cxt
->search_string_index
== 0)
410 if (last_isearch_string
)
412 cxt
->search_string_size
= 64 + last_isearch_string_len
;
413 cxt
->search_string
= (char *)xrealloc (cxt
->search_string
, cxt
->search_string_size
);
414 strcpy (cxt
->search_string
, last_isearch_string
);
415 cxt
->search_string_index
= last_isearch_string_len
;
416 rl_display_search (cxt
->search_string
, (cxt
->sflags
& SF_REVERSE
), -1);
421 else if (cxt
->sflags
& SF_REVERSE
)
423 else if (cxt
->sline_index
!= cxt
->sline_len
)
429 /* switch directions */
431 cxt
->direction
= -cxt
->direction
;
432 if (cxt
->direction
< 0)
433 cxt
->sflags
|= SF_REVERSE
;
435 cxt
->sflags
&= ~SF_REVERSE
;
438 /* delete character from search string. */
439 case -3: /* C-H, DEL */
440 /* This is tricky. To do this right, we need to keep a
441 stack of search positions for the current search, with
442 sentinels marking the beginning and end. But this will
443 do until we have a real isearch-undo. */
444 if (cxt
->search_string_index
== 0)
447 cxt
->search_string
[--cxt
->search_string_index
] = '\0';
450 case -4: /* C-G, abort */
451 rl_replace_line (cxt
->lines
[cxt
->save_line
], 0);
452 rl_point
= cxt
->save_point
;
453 rl_mark
= cxt
->save_mark
;
460 /* skip over portion of line we already matched and yank word */
461 wstart
= rl_point
+ cxt
->search_string_index
;
462 if (wstart
>= rl_end
)
468 /* if not in a word, move to one. */
469 cval
= _rl_char_value (rl_line_buffer
, wstart
);
470 if (_rl_walphabetic (cval
) == 0)
475 n
= MB_NEXTCHAR (rl_line_buffer
, wstart
, 1, MB_FIND_NONZERO
);;
478 cval
= _rl_char_value (rl_line_buffer
, n
);
479 if (_rl_walphabetic (cval
) == 0)
481 n
= MB_NEXTCHAR (rl_line_buffer
, n
, 1, MB_FIND_NONZERO
);;
483 wlen
= n
- wstart
+ 1;
484 if (cxt
->search_string_index
+ wlen
+ 1 >= cxt
->search_string_size
)
486 cxt
->search_string_size
+= wlen
+ 1;
487 cxt
->search_string
= (char *)xrealloc (cxt
->search_string
, cxt
->search_string_size
);
489 for (; wstart
< n
; wstart
++)
490 cxt
->search_string
[cxt
->search_string_index
++] = rl_line_buffer
[wstart
];
491 cxt
->search_string
[cxt
->search_string_index
] = '\0';
495 /* skip over portion of line we already matched and yank rest */
496 wstart
= rl_point
+ cxt
->search_string_index
;
497 if (wstart
>= rl_end
)
502 n
= rl_end
- wstart
+ 1;
503 if (cxt
->search_string_index
+ n
+ 1 >= cxt
->search_string_size
)
505 cxt
->search_string_size
+= n
+ 1;
506 cxt
->search_string
= (char *)xrealloc (cxt
->search_string
, cxt
->search_string_size
);
508 for (n
= wstart
; n
< rl_end
; n
++)
509 cxt
->search_string
[cxt
->search_string_index
++] = rl_line_buffer
[n
];
510 cxt
->search_string
[cxt
->search_string_index
] = '\0';
513 /* Add character to search string and continue search. */
515 if (cxt
->search_string_index
+ 2 >= cxt
->search_string_size
)
517 cxt
->search_string_size
+= 128;
518 cxt
->search_string
= (char *)xrealloc (cxt
->search_string
, cxt
->search_string_size
);
520 #if defined (HANDLE_MULTIBYTE)
521 if (MB_CUR_MAX
> 1 && rl_byte_oriented
== 0)
524 for (j
= 0, l
= strlen (cxt
->mb
); j
< l
; )
525 cxt
->search_string
[cxt
->search_string_index
++] = cxt
->mb
[j
++];
529 cxt
->search_string
[cxt
->search_string_index
++] = c
;
530 cxt
->search_string
[cxt
->search_string_index
] = '\0';
534 for (cxt
->sflags
&= ~(SF_FOUND
|SF_FAILED
);; )
536 limit
= cxt
->sline_len
- cxt
->search_string_index
+ 1;
538 /* Search the current line. */
539 while ((cxt
->sflags
& SF_REVERSE
) ? (cxt
->sline_index
>= 0) : (cxt
->sline_index
< limit
))
541 if (STREQN (cxt
->search_string
, cxt
->sline
+ cxt
->sline_index
, cxt
->search_string_index
))
543 cxt
->sflags
|= SF_FOUND
;
547 cxt
->sline_index
+= cxt
->direction
;
549 if (cxt
->sflags
& SF_FOUND
)
552 /* Move to the next line, but skip new copies of the line
553 we just found and lines shorter than the string we're
557 /* Move to the next line. */
558 cxt
->history_pos
+= cxt
->direction
;
560 /* At limit for direction? */
561 if ((cxt
->sflags
& SF_REVERSE
) ? (cxt
->history_pos
< 0) : (cxt
->history_pos
== cxt
->hlen
))
563 cxt
->sflags
|= SF_FAILED
;
567 /* We will need these later. */
568 cxt
->sline
= cxt
->lines
[cxt
->history_pos
];
569 cxt
->sline_len
= strlen (cxt
->sline
);
571 while ((cxt
->prev_line_found
&& STREQ (cxt
->prev_line_found
, cxt
->lines
[cxt
->history_pos
])) ||
572 (cxt
->search_string_index
> cxt
->sline_len
));
574 if (cxt
->sflags
& SF_FAILED
)
577 /* Now set up the line for searching... */
578 cxt
->sline_index
= (cxt
->sflags
& SF_REVERSE
) ? cxt
->sline_len
- cxt
->search_string_index
: 0;
581 if (cxt
->sflags
& SF_FAILED
)
583 /* We cannot find the search string. Ding the bell. */
585 cxt
->history_pos
= cxt
->last_found_line
;
589 /* We have found the search string. Just display it. But don't
590 actually move there in the history list until the user accepts
592 if (cxt
->sflags
& SF_FOUND
)
594 cxt
->prev_line_found
= cxt
->lines
[cxt
->history_pos
];
595 rl_replace_line (cxt
->lines
[cxt
->history_pos
], 0);
596 rl_point
= cxt
->sline_index
;
597 cxt
->last_found_line
= cxt
->history_pos
;
598 rl_display_search (cxt
->search_string
, (cxt
->sflags
& SF_REVERSE
), (cxt
->history_pos
== cxt
->save_line
) ? -1 : cxt
->history_pos
);
605 _rl_isearch_cleanup (cxt
, r
)
610 _rl_isearch_fini (cxt
);
611 _rl_scxt_dispose (cxt
, 0);
614 RL_UNSETSTATE(RL_STATE_ISEARCH
);
619 /* Search through the history looking for an interactively typed string.
620 This is analogous to i-search. We start the search in the current line.
621 DIRECTION is which direction to search; >= 0 means forward, < 0 means
624 rl_search_history (direction
, invoking_key
)
625 int direction
, invoking_key
;
627 _rl_search_cxt
*cxt
; /* local for now, but saved globally */
630 RL_SETSTATE(RL_STATE_ISEARCH
);
631 cxt
= _rl_isearch_init (direction
);
633 rl_display_search (cxt
->search_string
, (cxt
->sflags
& SF_REVERSE
), -1);
635 /* If we are using the callback interface, all we do is set up here and
636 return. The key is that we leave RL_STATE_ISEARCH set. */
637 if (RL_ISSTATE (RL_STATE_CALLBACK
))
643 c
= _rl_search_getchar (cxt
);
644 /* We might want to handle EOF here (c == 0) */
645 r
= _rl_isearch_dispatch (cxt
, cxt
->lastc
);
650 /* The searching is over. The user may have found the string that she
651 was looking for, or else she may have exited a failing search. If
652 LINE_INDEX is -1, then that shows that the string searched for was
653 not found. We use this to determine where to place rl_point. */
654 return (_rl_isearch_cleanup (cxt
, r
));
657 #if defined (READLINE_CALLBACKS)
658 /* Called from the callback functions when we are ready to read a key. The
659 callback functions know to call this because RL_ISSTATE(RL_STATE_ISEARCH).
660 If _rl_isearch_dispatch finishes searching, this function is responsible
661 for turning off RL_STATE_ISEARCH, which it does using _rl_isearch_cleanup. */
663 _rl_isearch_callback (cxt
)
668 c
= _rl_search_getchar (cxt
);
669 /* We might want to handle EOF here */
670 r
= _rl_isearch_dispatch (cxt
, cxt
->lastc
);
672 return (r
<= 0) ? _rl_isearch_cleanup (cxt
, r
) : 0;