bash/lib/readline/histsearch.c

/* histsearch.c -- searching the history list. */

/* Copyright (C) 1989, 1992-2009,2017,2021-2024 Free Software Foundation, Inc.

   This file contains the GNU History Library (History), a set of
   routines for managing the text of previously typed lines.

   History is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   History is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with History.  If not, see <http://www.gnu.org/licenses/>.
*/

#define READLINE_LIBRARY

#if defined (HAVE_CONFIG_H)
#  include <config.h>
#endif

#include <stdio.h>
#if defined (HAVE_STDLIB_H)
#  include <stdlib.h>
#else
#  include "ansi_stdlib.h"
#endif /* HAVE_STDLIB_H */

#if defined (HAVE_UNISTD_H)
#  ifdef _MINIX
#    include <sys/types.h>
#  endif
#  include <unistd.h>
#endif

#if defined (HAVE_FNMATCH)
#  include <fnmatch.h>
#endif

#include "history.h"
#include "histlib.h"
#include "xmalloc.h"

#include "rlmbutil.h"

/* The list of alternate characters that can delimit a history search
   string. */
char *history_search_delimiter_chars = (char *)NULL;

static int history_search_internal (const char *, int, int, int);

/* Search the history for STRING, starting at history_offset.
   If LISTDIR < 0, then the search is through previous entries, else
   through subsequent. If ANCHORED is non-zero, the string must
   appear at the beginning of a history line, otherwise, the string
   may appear anywhere in the line. If the search is not anchored, LINEDIR
   determines how the line is searched: if it is < 0, the search proceeds
   from the end of the line to the beginning, otherwise the substring search
   starts at the beginning of each history entry. If PATSEARCH is non-zero,
   and fnmatch(3) is available, fnmatch is used to match the string instead
   of a simple string comparison. If IGNORECASE is set, the string comparison
   is performed case-insensitively. If the string is found, then
   current_history () is the history entry, and the value of this
   function is the offset in the line of that history entry in which the
   string was found. Otherwise, nothing is changed, and a -1 is returned. */

static int
history_search_internal (const char *string, int listdir, int linedir, int flags)
{
  int i, reverse;
  char *line;
  size_t string_len, line_len;
  int line_index;		/* can't be unsigned */
  int anchored, patsearch, igncase;
  int found, mb_cur_max;
  HIST_ENTRY **the_history; 	/* local */

  i = history_offset;
  reverse = (listdir < 0);
  anchored = (flags & ANCHORED_SEARCH);
#if defined (HAVE_FNMATCH)
  patsearch = (flags & PATTERN_SEARCH);
#else
  patsearch = 0;
#endif
  igncase = (flags & CASEFOLD_SEARCH);

  /* Take care of trivial cases first. */
  if (string == 0 || *string == '\0')
    return (-1);

  if (!history_length || ((i >= history_length) && !reverse))
    return (-1);

  if (reverse && (i >= history_length))
    i = history_length - 1;

  mb_cur_max = MB_CUR_MAX;

#define NEXT_LINE() do { if (reverse) i--; else i++; } while (0)

  the_history = history_list ();
  string_len = strlen (string);
  while (1)
    {
      /* Search each line in the history list for STRING. */

      /* At limit for direction? */
      if ((reverse && i < 0) || (!reverse && i == history_length))
	return (-1);

      line = the_history[i]->line;
      line_len = line_index = strlen (line);

      /* If STRING is longer than line, no match. */
      if (patsearch == 0 && (string_len > line_index))
	{
	  NEXT_LINE ();
	  continue;
	}

      /* Handle anchored searches first. */
      if (anchored == ANCHORED_SEARCH)
	{
	  found = 0;
#if defined (HAVE_FNMATCH)
	  if (patsearch)
	    found = fnmatch (string, line, 0) == 0;
	  else
#endif
	  if (igncase)
	    {
#if defined (HANDLE_MULTIBYTE)
	      if (mb_cur_max > 1)	/* no rl_byte_oriented equivalent */
		found = _rl_mb_strcaseeqn (string, string_len,
					   line, line_len,
					   string_len, 0);
	      else
#endif
		found = strncasecmp (string, line, string_len) == 0;
	    }
	  else
	    found = STREQN (string, line, string_len);

	  if (found)
	    {
	      history_offset = i;
	      return (0);
	    }

	  NEXT_LINE ();
	  continue;
	}

      /* Do substring search. */
      if (linedir < 0)		/* search backwards from end */
	{
	  size_t ll;

	  ll = (patsearch == 0) ? string_len : 1;
	  line_index -= ll;
	  found = 0;

	  while (line_index >= 0)
	    {
#if defined (HAVE_FNMATCH)
	      if (patsearch)
		found = fnmatch (string, line + line_index, 0) == 0;
	      else
#endif
	      if (igncase)
		{
#if defined (HANDLE_MULTIBYTE)
		  if (mb_cur_max > 1)	/* no rl_byte_oriented equivalent */
		    found = _rl_mb_strcaseeqn (string, string_len,
					       line + line_index, ll,
					       string_len, 0);
		  else
#endif
		  found = strncasecmp (string, line + line_index, string_len) == 0;
		}
	      else
	        found = STREQN (string, line + line_index, string_len);

	      if (found)
		{
		  history_offset = i;
		  return (line_index);
		}
	      line_index--;
	      ll++;
	    }
	}
      else
	{
	  register int limit;
	  size_t ll;

	  ll = line_len;
	  limit = line_index - string_len + 1;
	  line_index = 0;
	  found = 0;

	  while (line_index < limit)
	    {
#if defined (HAVE_FNMATCH)
	      if (patsearch)
		found = fnmatch (string, line + line_index, 0) == 0;
	      else
#endif
	      if (igncase)
		{
#if defined (HANDLE_MULTIBYTE)
		  if (mb_cur_max > 1)	/* no rl_byte_oriented equivalent */
		    found = _rl_mb_strcaseeqn (string, string_len,
					       line + line_index, ll,
					       string_len, 0);
		  else
#endif
		  found = strncasecmp (string, line + line_index, string_len) == 0;
		}
	      else
		found = STREQN (string, line + line_index, string_len);

	      if (found)
		{
		  history_offset = i;
		  return (line_index);
		}
	      line_index++;
	      ll--;
	    }
	}
      NEXT_LINE ();
    }
}

int
_hs_history_patsearch (const char *string, int listdir, int linedir, int flags)
{
  char *pat;
  size_t len, start;
  int ret, unescaped_backslash;

#if defined (HAVE_FNMATCH)
  /* Assume that the string passed does not have a leading `^' and any
     anchored search request is captured in FLAGS */
  len = strlen (string);
  ret = len - 1;
  /* fnmatch is required to reject a pattern that ends with an unescaped
     backslash */
  if (unescaped_backslash = (string[ret] == '\\'))
    {
      while (ret > 0 && string[--ret] == '\\')
	unescaped_backslash = 1 - unescaped_backslash;
    }
  if (unescaped_backslash)
    return -1;
  pat = (char *)xmalloc (len + 3);
  /* If the search string is not anchored, we'll be calling fnmatch (assuming
     we have it). Prefix a `*' to the front of the search string so we search
     anywhere in the line. */
  if ((flags & ANCHORED_SEARCH) == 0 && string[0] != '*')
    {
      pat[0] = '*';
      start = 1;
      len++;
    }
  else
    {
      start = 0;
    }

  /* Attempt to reduce the number of searches by tacking a `*' onto the end
     of a pattern that doesn't have one.  Assume a pattern that ends in a
     backslash contains an even number of trailing backslashes; we check
     above */
  strcpy (pat + start, string);
  if (pat[len - 1] != '*')
    {
      pat[len] = '*';		/* XXX */
      pat[len+1] = '\0';
    }
#else
  pat = string;
#endif

  ret = history_search_internal (pat, listdir, linedir, flags|PATTERN_SEARCH);

  if (pat != string)
    xfree (pat);
  return ret;
}
	
/* Do a non-anchored search for STRING through the history list in direction
   LISTDIR. */
int
history_search (const char *string, int listdir)
{
  return (history_search_internal (string, listdir, listdir, NON_ANCHORED_SEARCH));
}

/* Do an anchored search for string through the history list in direction
   LISTDIR. */
int
history_search_prefix (const char *string, int listdir)
{
  return (history_search_internal (string, listdir, listdir, ANCHORED_SEARCH));
}

/* Perform a history search for STRING, letting the caller specify the flags.
   At some point, make this public for users of the history library. */
int
_hs_history_search (const char *string, int listdir, int linedir, int flags)
{
  return (history_search_internal (string, listdir, linedir, flags));
}

/* Search for STRING in the history list.  LISTDIR is < 0 for searching
   backwards through the list.  POS is an absolute index into the history
   list where the search should begin. */
int
history_search_pos (const char *string, int listdir, int pos)
{
  int ret, old;

  old = where_history ();
  history_set_pos (pos);
  if (history_search (string, listdir) == -1)
    {
      history_set_pos (old);
      return (-1);
    }
  ret = where_history ();
  history_set_pos (old);
  return ret;
}