search.c 90.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* String search routines for GNU Emacs.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1997, 1998, 1999, 2002, 2003,
3
                 2004, 2005, 2006 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include "lisp.h"
#include "syntax.h"
Karl Heuer's avatar
Karl Heuer committed
26
#include "category.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
28
#include "charset.h"
29
#include "region-cache.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "commands.h"
31
#include "blockinput.h"
32
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
33

Jim Blandy's avatar
Jim Blandy committed
34 35 36
#include <sys/types.h>
#include "regex.h"

37
#define REGEXP_CACHE_SIZE 20
Jim Blandy's avatar
Jim Blandy committed
38

39 40
/* If the regexp is non-nil, then the buffer contains the compiled form
   of that regexp, suitable for searching.  */
41 42
struct regexp_cache
{
43
  struct regexp_cache *next;
44
  Lisp_Object regexp, whitespace_regexp;
45 46
  struct re_pattern_buffer buf;
  char fastmap[0400];
47 48
  /* Nonzero means regexp was compiled to do full POSIX backtracking.  */
  char posix;
49
};
Jim Blandy's avatar
Jim Blandy committed
50

51 52
/* The instances of that struct.  */
struct regexp_cache searchbufs[REGEXP_CACHE_SIZE];
Jim Blandy's avatar
Jim Blandy committed
53

54 55
/* The head of the linked list; points to the most recently used buffer.  */
struct regexp_cache *searchbuf_head;
Jim Blandy's avatar
Jim Blandy committed
56 57


Jim Blandy's avatar
Jim Blandy committed
58 59 60 61 62 63 64
/* Every call to re_match, etc., must pass &search_regs as the regs
   argument unless you can show it is unnecessary (i.e., if re_match
   is certainly going to be called again before region-around-match
   can be called).

   Since the registers are now dynamically allocated, we need to make
   sure not to refer to the Nth register before checking that it has
Jim Blandy's avatar
Jim Blandy committed
65 66 67
   been allocated by checking search_regs.num_regs.

   The regex code keeps track of whether it has allocated the search
68 69
   buffer using bits in the re_pattern_buffer.  This means that whenever
   you compile a new pattern, it completely forgets whether it has
Jim Blandy's avatar
Jim Blandy committed
70 71 72 73 74
   allocated any registers, and will allocate new registers the next
   time you call a searching or matching function.  Therefore, we need
   to call re_set_registers after compiling a new pattern or after
   setting the match registers, so that the regex functions will be
   able to free or re-allocate it properly.  */
Jim Blandy's avatar
Jim Blandy committed
75 76
static struct re_registers search_regs;

Jim Blandy's avatar
Jim Blandy committed
77 78 79 80
/* The buffer in which the last search was performed, or
   Qt if the last search was done in a string;
   Qnil if no searching has been done yet.  */
static Lisp_Object last_thing_searched;
Jim Blandy's avatar
Jim Blandy committed
81

Karl Heuer's avatar
Karl Heuer committed
82
/* error condition signaled when regexp compile_pattern fails */
Jim Blandy's avatar
Jim Blandy committed
83 84 85

Lisp_Object Qinvalid_regexp;

86 87 88
/* Error condition used for failing searches */
Lisp_Object Qsearch_failed;

Richard M. Stallman's avatar
Richard M. Stallman committed
89
Lisp_Object Vsearch_spaces_regexp;
90

91
static void set_search_regs ();
92
static void save_search_regs ();
93 94
static int simple_search ();
static int boyer_moore ();
95
static int search_buffer ();
96
static void matcher_overflow () NO_RETURN;
97

Jim Blandy's avatar
Jim Blandy committed
98 99 100 101 102 103
static void
matcher_overflow ()
{
  error ("Stack overflow in regexp matcher");
}

104 105 106
/* Compile a regexp and signal a Lisp error if anything goes wrong.
   PATTERN is the pattern to compile.
   CP is the place to put the result.
107
   TRANSLATE is a translation table for ignoring case, or nil for none.
108 109 110 111 112
   REGP is the structure that says where to store the "register"
   values that will result from matching this pattern.
   If it is 0, we should compile the pattern not to record any
   subexpression bounds.
   POSIX is nonzero if we want full backtracking (POSIX style)
Karl Heuer's avatar
Karl Heuer committed
113 114 115
   for this pattern.  0 means backtrack only enough to get a valid match.
   MULTIBYTE is nonzero if we want to handle multibyte characters in
   PATTERN.  0 means all multibyte characters are recognized just as
116 117
   sequences of binary data.

Richard M. Stallman's avatar
Richard M. Stallman committed
118
   The behavior also depends on Vsearch_spaces_regexp.  */
Jim Blandy's avatar
Jim Blandy committed
119

120
static void
Karl Heuer's avatar
Karl Heuer committed
121
compile_pattern_1 (cp, pattern, translate, regp, posix, multibyte)
122
     struct regexp_cache *cp;
Jim Blandy's avatar
Jim Blandy committed
123
     Lisp_Object pattern;
124
     Lisp_Object translate;
125
     struct re_registers *regp;
126
     int posix;
Karl Heuer's avatar
Karl Heuer committed
127
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
128
{
129
  unsigned char *raw_pattern;
130
  int raw_pattern_size;
131
  char *val;
132
  reg_syntax_t old;
Jim Blandy's avatar
Jim Blandy committed
133

134 135 136 137 138 139
  /* MULTIBYTE says whether the text to be searched is multibyte.
     We must convert PATTERN to match that, or we will not really
     find things right.  */

  if (multibyte == STRING_MULTIBYTE (pattern))
    {
140 141
      raw_pattern = (unsigned char *) SDATA (pattern);
      raw_pattern_size = SBYTES (pattern);
142 143 144
    }
  else if (multibyte)
    {
145 146
      raw_pattern_size = count_size_as_multibyte (SDATA (pattern),
						  SCHARS (pattern));
147
      raw_pattern = (unsigned char *) alloca (raw_pattern_size + 1);
148 149
      copy_text (SDATA (pattern), raw_pattern,
		 SCHARS (pattern), 0, 1);
150 151 152 153 154 155 156 157 158
    }
  else
    {
      /* Converting multibyte to single-byte.

	 ??? Perhaps this conversion should be done in a special way
	 by subtracting nonascii-insert-offset from each non-ASCII char,
	 so that only the multibyte chars which really correspond to
	 the chosen single-byte character set can possibly match.  */
159
      raw_pattern_size = SCHARS (pattern);
160
      raw_pattern = (unsigned char *) alloca (raw_pattern_size + 1);
161 162
      copy_text (SDATA (pattern), raw_pattern,
		 SBYTES (pattern), 1, 0);
163 164
    }

165
  cp->regexp = Qnil;
166
  cp->buf.translate = (! NILP (translate) ? translate : make_number (0));
167
  cp->posix = posix;
Karl Heuer's avatar
Karl Heuer committed
168
  cp->buf.multibyte = multibyte;
Richard M. Stallman's avatar
Richard M. Stallman committed
169
  cp->whitespace_regexp = Vsearch_spaces_regexp;
170 171 172
  /* Doing BLOCK_INPUT here has the effect that
     the debugger won't run if an error occurs.
     Why is BLOCK_INPUT needed here?  */
173
  BLOCK_INPUT;
174
  old = re_set_syntax (RE_SYNTAX_EMACS
175
		       | (posix ? 0 : RE_NO_POSIX_BACKTRACKING));
176

Richard M. Stallman's avatar
Richard M. Stallman committed
177 178
  re_set_whitespace_regexp (NILP (Vsearch_spaces_regexp) ? NULL
			    : SDATA (Vsearch_spaces_regexp));
179

180 181
  val = (char *) re_compile_pattern ((char *)raw_pattern,
				     raw_pattern_size, &cp->buf);
182 183 184

  re_set_whitespace_regexp (NULL);

185
  re_set_syntax (old);
186
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
187
  if (val)
188
    xsignal1 (Qinvalid_regexp, build_string (val));
Jim Blandy's avatar
Jim Blandy committed
189

190 191 192
  cp->regexp = Fcopy_sequence (pattern);
}

193 194 195 196 197 198 199
/* Shrink each compiled regexp buffer in the cache
   to the size actually used right now.
   This is called from garbage collection.  */

void
shrink_regexp_cache ()
{
200
  struct regexp_cache *cp;
201 202 203 204 205

  for (cp = searchbuf_head; cp != 0; cp = cp->next)
    {
      cp->buf.allocated = cp->buf.used;
      cp->buf.buffer
206
	= (unsigned char *) xrealloc (cp->buf.buffer, cp->buf.used);
207 208 209
    }
}

210
/* Compile a regexp if necessary, but first check to see if there's one in
211 212
   the cache.
   PATTERN is the pattern to compile.
213
   TRANSLATE is a translation table for ignoring case, or nil for none.
214 215 216 217 218 219
   REGP is the structure that says where to store the "register"
   values that will result from matching this pattern.
   If it is 0, we should compile the pattern not to record any
   subexpression bounds.
   POSIX is nonzero if we want full backtracking (POSIX style)
   for this pattern.  0 means backtrack only enough to get a valid match.  */
220 221

struct re_pattern_buffer *
222
compile_pattern (pattern, regp, translate, posix, multibyte)
223 224
     Lisp_Object pattern;
     struct re_registers *regp;
225
     Lisp_Object translate;
226
     int posix, multibyte;
227 228 229 230 231 232
{
  struct regexp_cache *cp, **cpp;

  for (cpp = &searchbuf_head; ; cpp = &cp->next)
    {
      cp = *cpp;
233 234
      /* Entries are initialized to nil, and may be set to nil by
	 compile_pattern_1 if the pattern isn't valid.  Don't apply
Ken Raeburn's avatar
Ken Raeburn committed
235 236 237
	 string accessors in those cases.  However, compile_pattern_1
	 is only applied to the cache entry we pick here to reuse.  So
	 nil should never appear before a non-nil entry.  */
238
      if (NILP (cp->regexp))
239
	goto compile_it;
240
      if (SCHARS (cp->regexp) == SCHARS (pattern)
241
	  && STRING_MULTIBYTE (cp->regexp) == STRING_MULTIBYTE (pattern)
242
	  && !NILP (Fstring_equal (cp->regexp, pattern))
243
	  && EQ (cp->buf.translate, (! NILP (translate) ? translate : make_number (0)))
Karl Heuer's avatar
Karl Heuer committed
244
	  && cp->posix == posix
245
	  && cp->buf.multibyte == multibyte
Richard M. Stallman's avatar
Richard M. Stallman committed
246
	  && !NILP (Fequal (cp->whitespace_regexp, Vsearch_spaces_regexp)))
247 248
	break;

249 250 251
      /* If we're at the end of the cache, compile into the nil cell
	 we found, or the last (least recently used) cell with a
	 string value.  */
252 253
      if (cp->next == 0)
	{
254
	compile_it:
Karl Heuer's avatar
Karl Heuer committed
255
	  compile_pattern_1 (cp, pattern, translate, regp, posix, multibyte);
256 257 258 259 260 261 262 263 264 265
	  break;
	}
    }

  /* When we get here, cp (aka *cpp) contains the compiled pattern,
     either because we found it in the cache or because we just compiled it.
     Move it to the front of the queue to mark it as most recently used.  */
  *cpp = cp->next;
  cp->next = searchbuf_head;
  searchbuf_head = cp;
Jim Blandy's avatar
Jim Blandy committed
266

267 268 269 270 271
  /* Advise the searching functions about the space we have allocated
     for register data.  */
  if (regp)
    re_set_registers (&cp->buf, regp, regp->num_regs, regp->start, regp->end);

272
  return &cp->buf;
Jim Blandy's avatar
Jim Blandy committed
273 274 275
}


276 277
static Lisp_Object
looking_at_1 (string, posix)
Jim Blandy's avatar
Jim Blandy committed
278
     Lisp_Object string;
279
     int posix;
Jim Blandy's avatar
Jim Blandy committed
280 281 282 283 284
{
  Lisp_Object val;
  unsigned char *p1, *p2;
  int s1, s2;
  register int i;
285
  struct re_pattern_buffer *bufp;
Jim Blandy's avatar
Jim Blandy committed
286

287 288 289
  if (running_asynch_code)
    save_search_regs ();

290 291 292 293
  /* This is so set_image_of_range_1 in regex.c can find the EQV table.  */
  XCHAR_TABLE (current_buffer->case_canon_table)->extras[2]
    = current_buffer->case_eqv_table;

294
  CHECK_STRING (string);
295 296
  bufp = compile_pattern (string, &search_regs,
			  (!NILP (current_buffer->case_fold_search)
297
			   ? current_buffer->case_canon_table : Qnil),
298 299
			  posix,
			  !NILP (current_buffer->enable_multibyte_characters));
Jim Blandy's avatar
Jim Blandy committed
300 301 302 303 304 305 306 307

  immediate_quit = 1;
  QUIT;			/* Do a pending quit right away, to avoid paradoxical behavior */

  /* Get pointers and sizes of the two strings
     that make up the visible portion of the buffer. */

  p1 = BEGV_ADDR;
308
  s1 = GPT_BYTE - BEGV_BYTE;
Jim Blandy's avatar
Jim Blandy committed
309
  p2 = GAP_END_ADDR;
310
  s2 = ZV_BYTE - GPT_BYTE;
Jim Blandy's avatar
Jim Blandy committed
311 312 313
  if (s1 < 0)
    {
      p2 = p1;
314
      s2 = ZV_BYTE - BEGV_BYTE;
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318
      s1 = 0;
    }
  if (s2 < 0)
    {
319
      s1 = ZV_BYTE - BEGV_BYTE;
Jim Blandy's avatar
Jim Blandy committed
320 321
      s2 = 0;
    }
322 323

  re_match_object = Qnil;
324

325
  i = re_match_2 (bufp, (char *) p1, s1, (char *) p2, s2,
326 327
		  PT_BYTE - BEGV_BYTE, &search_regs,
		  ZV_BYTE - BEGV_BYTE);
328
  immediate_quit = 0;
329

Jim Blandy's avatar
Jim Blandy committed
330 331 332 333
  if (i == -2)
    matcher_overflow ();

  val = (0 <= i ? Qt : Qnil);
334 335 336 337 338 339 340 341 342
  if (i >= 0)
    for (i = 0; i < search_regs.num_regs; i++)
      if (search_regs.start[i] >= 0)
	{
	  search_regs.start[i]
	    = BYTE_TO_CHAR (search_regs.start[i] + BEGV_BYTE);
	  search_regs.end[i]
	    = BYTE_TO_CHAR (search_regs.end[i] + BEGV_BYTE);
	}
343
  XSETBUFFER (last_thing_searched, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
344 345 346
  return val;
}

347
DEFUN ("looking-at", Flooking_at, Slooking_at, 1, 1, 0,
348 349 350 351 352
       doc: /* Return t if text after point matches regular expression REGEXP.
This function modifies the match data that `match-beginning',
`match-end' and `match-data' access; save and restore the match
data if you want to preserve them.  */)
     (regexp)
353
     Lisp_Object regexp;
354
{
355
  return looking_at_1 (regexp, 0);
356 357 358
}

DEFUN ("posix-looking-at", Fposix_looking_at, Sposix_looking_at, 1, 1, 0,
359 360 361 362 363 364
       doc: /* Return t if text after point matches regular expression REGEXP.
Find the longest match, in accord with Posix regular expression rules.
This function modifies the match data that `match-beginning',
`match-end' and `match-data' access; save and restore the match
data if you want to preserve them.  */)
     (regexp)
365
     Lisp_Object regexp;
366
{
367
  return looking_at_1 (regexp, 1);
368 369 370 371
}

static Lisp_Object
string_match_1 (regexp, string, start, posix)
Jim Blandy's avatar
Jim Blandy committed
372
     Lisp_Object regexp, string, start;
373
     int posix;
Jim Blandy's avatar
Jim Blandy committed
374 375
{
  int val;
376
  struct re_pattern_buffer *bufp;
377 378
  int pos, pos_byte;
  int i;
Jim Blandy's avatar
Jim Blandy committed
379

380 381 382
  if (running_asynch_code)
    save_search_regs ();

383 384
  CHECK_STRING (regexp);
  CHECK_STRING (string);
Jim Blandy's avatar
Jim Blandy committed
385 386

  if (NILP (start))
387
    pos = 0, pos_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
388 389
  else
    {
390
      int len = SCHARS (string);
Jim Blandy's avatar
Jim Blandy committed
391

392
      CHECK_NUMBER (start);
393 394 395 396
      pos = XINT (start);
      if (pos < 0 && -pos <= len)
	pos = len + pos;
      else if (0 > pos || pos > len)
Jim Blandy's avatar
Jim Blandy committed
397
	args_out_of_range (string, start);
398
      pos_byte = string_char_to_byte (string, pos);
Jim Blandy's avatar
Jim Blandy committed
399 400
    }

401 402 403 404
  /* This is so set_image_of_range_1 in regex.c can find the EQV table.  */
  XCHAR_TABLE (current_buffer->case_canon_table)->extras[2]
    = current_buffer->case_eqv_table;

405 406
  bufp = compile_pattern (regexp, &search_regs,
			  (!NILP (current_buffer->case_fold_search)
407
			   ? current_buffer->case_canon_table : Qnil),
408 409
			  posix,
			  STRING_MULTIBYTE (string));
Jim Blandy's avatar
Jim Blandy committed
410
  immediate_quit = 1;
411
  re_match_object = string;
412

413 414 415
  val = re_search (bufp, (char *) SDATA (string),
		   SBYTES (string), pos_byte,
		   SBYTES (string) - pos_byte,
Jim Blandy's avatar
Jim Blandy committed
416 417
		   &search_regs);
  immediate_quit = 0;
Jim Blandy's avatar
Jim Blandy committed
418
  last_thing_searched = Qt;
Jim Blandy's avatar
Jim Blandy committed
419 420 421
  if (val == -2)
    matcher_overflow ();
  if (val < 0) return Qnil;
422 423 424 425 426 427 428 429 430 431 432

  for (i = 0; i < search_regs.num_regs; i++)
    if (search_regs.start[i] >= 0)
      {
	search_regs.start[i]
	  = string_byte_to_char (string, search_regs.start[i]);
	search_regs.end[i]
	  = string_byte_to_char (string, search_regs.end[i]);
      }

  return make_number (string_byte_to_char (string, val));
Jim Blandy's avatar
Jim Blandy committed
433
}
Richard M. Stallman's avatar
Richard M. Stallman committed
434

435
DEFUN ("string-match", Fstring_match, Sstring_match, 2, 3, 0,
436
       doc: /* Return index of start of first match for REGEXP in STRING, or nil.
Richard M. Stallman's avatar
Richard M. Stallman committed
437
Matching ignores case if `case-fold-search' is non-nil.
438 439 440
If third arg START is non-nil, start search at that index in STRING.
For index of first char beyond the match, do (match-end 0).
`match-end' and `match-beginning' also give indices of substrings
441 442 443 444
matched by parenthesis constructs in the pattern.

You can use the function `match-string' to extract the substrings
matched by the parenthesis constructions in REGEXP. */)
445
     (regexp, string, start)
446 447 448 449 450 451
     Lisp_Object regexp, string, start;
{
  return string_match_1 (regexp, string, start, 0);
}

DEFUN ("posix-string-match", Fposix_string_match, Sposix_string_match, 2, 3, 0,
452 453 454 455 456 457 458 459
       doc: /* Return index of start of first match for REGEXP in STRING, or nil.
Find the longest match, in accord with Posix regular expression rules.
Case is ignored if `case-fold-search' is non-nil in the current buffer.
If third arg START is non-nil, start search at that index in STRING.
For index of first char beyond the match, do (match-end 0).
`match-end' and `match-beginning' also give indices of substrings
matched by parenthesis constructs in the pattern.  */)
     (regexp, string, start)
460 461 462 463 464
     Lisp_Object regexp, string, start;
{
  return string_match_1 (regexp, string, start, 1);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
465 466 467 468 469 470 471 472 473
/* Match REGEXP against STRING, searching all of STRING,
   and return the index of the match, or negative on failure.
   This does not clobber the match data.  */

int
fast_string_match (regexp, string)
     Lisp_Object regexp, string;
{
  int val;
474
  struct re_pattern_buffer *bufp;
Richard M. Stallman's avatar
Richard M. Stallman committed
475

476 477
  bufp = compile_pattern (regexp, 0, Qnil,
			  0, STRING_MULTIBYTE (string));
Richard M. Stallman's avatar
Richard M. Stallman committed
478
  immediate_quit = 1;
479
  re_match_object = string;
480

481 482 483
  val = re_search (bufp, (char *) SDATA (string),
		   SBYTES (string), 0,
		   SBYTES (string), 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
484 485 486
  immediate_quit = 0;
  return val;
}
Karl Heuer's avatar
Karl Heuer committed
487 488 489

/* Match REGEXP against STRING, searching all of STRING ignoring case,
   and return the index of the match, or negative on failure.
490 491
   This does not clobber the match data.
   We assume that STRING contains single-byte characters.  */
Karl Heuer's avatar
Karl Heuer committed
492 493 494 495

extern Lisp_Object Vascii_downcase_table;

int
496
fast_c_string_match_ignore_case (regexp, string)
Karl Heuer's avatar
Karl Heuer committed
497
     Lisp_Object regexp;
498
     const char *string;
Karl Heuer's avatar
Karl Heuer committed
499 500 501 502 503
{
  int val;
  struct re_pattern_buffer *bufp;
  int len = strlen (string);

504
  regexp = string_make_unibyte (regexp);
505
  re_match_object = Qt;
Karl Heuer's avatar
Karl Heuer committed
506
  bufp = compile_pattern (regexp, 0,
507
			  Vascii_canon_table, 0,
508
			  0);
Karl Heuer's avatar
Karl Heuer committed
509 510 511 512 513
  immediate_quit = 1;
  val = re_search (bufp, string, len, 0, len, 0);
  immediate_quit = 0;
  return val;
}
514 515 516 517 518 519 520 521 522 523

/* Like fast_string_match but ignore case.  */

int
fast_string_match_ignore_case (regexp, string)
     Lisp_Object regexp, string;
{
  int val;
  struct re_pattern_buffer *bufp;

524
  bufp = compile_pattern (regexp, 0, Vascii_canon_table,
525 526 527 528 529 530 531 532 533 534
			  0, STRING_MULTIBYTE (string));
  immediate_quit = 1;
  re_match_object = string;

  val = re_search (bufp, (char *) SDATA (string),
		   SBYTES (string), 0,
		   SBYTES (string), 0);
  immediate_quit = 0;
  return val;
}
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

/* The newline cache: remembering which sections of text have no newlines.  */

/* If the user has requested newline caching, make sure it's on.
   Otherwise, make sure it's off.
   This is our cheezy way of associating an action with the change of
   state of a buffer-local variable.  */
static void
newline_cache_on_off (buf)
     struct buffer *buf;
{
  if (NILP (buf->cache_long_line_scans))
    {
      /* It should be off.  */
      if (buf->newline_cache)
        {
          free_region_cache (buf->newline_cache);
          buf->newline_cache = 0;
        }
    }
  else
    {
      /* It should be on.  */
      if (buf->newline_cache == 0)
        buf->newline_cache = new_region_cache ();
    }
}


/* Search for COUNT instances of the character TARGET between START and END.

   If COUNT is positive, search forwards; END must be >= START.
   If COUNT is negative, search backwards for the -COUNTth instance;
      END must be <= START.
   If COUNT is zero, do anything you please; run rogue, for all I care.

   If END is zero, use BEGV or ZV instead, as appropriate for the
   direction indicated by COUNT.
Jim Blandy's avatar
Jim Blandy committed
573 574

   If we find COUNT instances, set *SHORTAGE to zero, and return the
Richard M. Stallman's avatar
Richard M. Stallman committed
575
   position past the COUNTth match.  Note that for reverse motion
Richard M. Stallman's avatar
Richard M. Stallman committed
576
   this is not the same as the usual convention for Emacs motion commands.
Jim Blandy's avatar
Jim Blandy committed
577

578 579
   If we don't find COUNT instances before reaching END, set *SHORTAGE
   to the number of TARGETs left unfound, and return END.
Jim Blandy's avatar
Jim Blandy committed
580

581 582 583
   If ALLOW_QUIT is non-zero, set immediate_quit.  That's good to do
   except when inside redisplay.  */

Andreas Schwab's avatar
Andreas Schwab committed
584
int
585 586 587 588 589
scan_buffer (target, start, end, count, shortage, allow_quit)
     register int target;
     int start, end;
     int count;
     int *shortage;
590
     int allow_quit;
Jim Blandy's avatar
Jim Blandy committed
591
{
592
  struct region_cache *newline_cache;
593
  int direction;
Jim Blandy's avatar
Jim Blandy committed
594

595 596 597 598 599 600 601 602 603 604
  if (count > 0)
    {
      direction = 1;
      if (! end) end = ZV;
    }
  else
    {
      direction = -1;
      if (! end) end = BEGV;
    }
Jim Blandy's avatar
Jim Blandy committed
605

606 607
  newline_cache_on_off (current_buffer);
  newline_cache = current_buffer->newline_cache;
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611

  if (shortage != 0)
    *shortage = 0;

612
  immediate_quit = allow_quit;
Jim Blandy's avatar
Jim Blandy committed
613

Jim Blandy's avatar
Jim Blandy committed
614
  if (count > 0)
615
    while (start != end)
Jim Blandy's avatar
Jim Blandy committed
616
      {
617 618 619 620 621
        /* Our innermost scanning loop is very simple; it doesn't know
           about gaps, buffer ends, or the newline cache.  ceiling is
           the position of the last character before the next such
           obstacle --- the last character the dumb search loop should
           examine.  */
622 623
	int ceiling_byte = CHAR_TO_BYTE (end) - 1;
	int start_byte = CHAR_TO_BYTE (start);
624
	int tem;
625 626 627 628 629 630 631 632

        /* If we're looking for a newline, consult the newline cache
           to see where we can avoid some scanning.  */
        if (target == '\n' && newline_cache)
          {
            int next_change;
            immediate_quit = 0;
            while (region_cache_forward
633 634
                   (current_buffer, newline_cache, start_byte, &next_change))
              start_byte = next_change;
635
            immediate_quit = allow_quit;
636

637 638 639
            /* START should never be after END.  */
            if (start_byte > ceiling_byte)
              start_byte = ceiling_byte;
640 641 642

            /* Now the text after start is an unknown region, and
               next_change is the position of the next known region. */
643
            ceiling_byte = min (next_change - 1, ceiling_byte);
644 645 646 647 648 649
          }

        /* The dumb loop can only scan text stored in contiguous
           bytes. BUFFER_CEILING_OF returns the last character
           position that is contiguous, so the ceiling is the
           position after that.  */
650 651
	tem = BUFFER_CEILING_OF (start_byte);
	ceiling_byte = min (tem, ceiling_byte);
652 653

        {
654
          /* The termination address of the dumb loop.  */
655 656 657 658
          register unsigned char *ceiling_addr
	    = BYTE_POS_ADDR (ceiling_byte) + 1;
          register unsigned char *cursor
	    = BYTE_POS_ADDR (start_byte);
659 660 661 662 663 664 665 666 667 668 669 670 671 672
          unsigned char *base = cursor;

          while (cursor < ceiling_addr)
            {
              unsigned char *scan_start = cursor;

              /* The dumb loop.  */
              while (*cursor != target && ++cursor < ceiling_addr)
                ;

              /* If we're looking for newlines, cache the fact that
                 the region from start to cursor is free of them. */
              if (target == '\n' && newline_cache)
                know_region_cache (current_buffer, newline_cache,
673 674
                                   start_byte + scan_start - base,
                                   start_byte + cursor - base);
675 676 677 678 679 680 681

              /* Did we find the target character?  */
              if (cursor < ceiling_addr)
                {
                  if (--count == 0)
                    {
                      immediate_quit = 0;
682
                      return BYTE_TO_CHAR (start_byte + cursor - base + 1);
683 684 685 686 687
                    }
                  cursor++;
                }
            }

688
          start = BYTE_TO_CHAR (start_byte + cursor - base);
689
        }
Jim Blandy's avatar
Jim Blandy committed
690 691
      }
  else
692 693 694
    while (start > end)
      {
        /* The last character to check before the next obstacle.  */
695 696
	int ceiling_byte = CHAR_TO_BYTE (end);
	int start_byte = CHAR_TO_BYTE (start);
697
	int tem;
698 699 700 701 702 703 704

        /* Consult the newline cache, if appropriate.  */
        if (target == '\n' && newline_cache)
          {
            int next_change;
            immediate_quit = 0;
            while (region_cache_backward
705 706
                   (current_buffer, newline_cache, start_byte, &next_change))
              start_byte = next_change;
707
            immediate_quit = allow_quit;
708 709

            /* Start should never be at or before end.  */
710 711
            if (start_byte <= ceiling_byte)
              start_byte = ceiling_byte + 1;
712 713 714

            /* Now the text before start is an unknown region, and
               next_change is the position of the next known region. */
715
            ceiling_byte = max (next_change, ceiling_byte);
716 717 718
          }

        /* Stop scanning before the gap.  */
719 720
	tem = BUFFER_FLOOR_OF (start_byte - 1);
	ceiling_byte = max (tem, ceiling_byte);
721 722 723

        {
          /* The termination address of the dumb loop.  */
724 725
          register unsigned char *ceiling_addr = BYTE_POS_ADDR (ceiling_byte);
          register unsigned char *cursor = BYTE_POS_ADDR (start_byte - 1);
726 727 728 729 730 731 732 733 734 735 736 737 738
          unsigned char *base = cursor;

          while (cursor >= ceiling_addr)
            {
              unsigned char *scan_start = cursor;

              while (*cursor != target && --cursor >= ceiling_addr)
                ;

              /* If we're looking for newlines, cache the fact that
                 the region from after the cursor to start is free of them.  */
              if (target == '\n' && newline_cache)
                know_region_cache (current_buffer, newline_cache,
739 740
                                   start_byte + cursor - base,
                                   start_byte + scan_start - base);
741 742 743 744 745 746 747

              /* Did we find the target character?  */
              if (cursor >= ceiling_addr)
                {
                  if (++count >= 0)
                    {
                      immediate_quit = 0;
748
                      return BYTE_TO_CHAR (start_byte + cursor - base);
749 750 751 752 753
                    }
                  cursor--;
                }
            }

754
	  start = BYTE_TO_CHAR (start_byte + cursor - base);
755 756 757
        }
      }

Jim Blandy's avatar
Jim Blandy committed
758 759
  immediate_quit = 0;
  if (shortage != 0)
Jim Blandy's avatar
Jim Blandy committed
760
    *shortage = count * direction;
761
  return start;
Jim Blandy's avatar
Jim Blandy committed
762
}
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778

/* Search for COUNT instances of a line boundary, which means either a
   newline or (if selective display enabled) a carriage return.
   Start at START.  If COUNT is negative, search backwards.

   We report the resulting position by calling TEMP_SET_PT_BOTH.

   If we find COUNT instances. we position after (always after,
   even if scanning backwards) the COUNTth match, and return 0.

   If we don't find COUNT instances before reaching the end of the
   buffer (or the beginning, if scanning backwards), we return
   the number of line boundaries left unfound, and position at
   the limit we bumped up against.

   If ALLOW_QUIT is non-zero, set immediate_quit.  That's good to do
779
   except in special cases.  */
Jim Blandy's avatar
Jim Blandy committed
780

781
int
782 783 784 785 786
scan_newline (start, start_byte, limit, limit_byte, count, allow_quit)
     int start, start_byte;
     int limit, limit_byte;
     register int count;
     int allow_quit;
787
{
788 789 790 791 792 793 794 795
  int direction = ((count > 0) ? 1 : -1);

  register unsigned char *cursor;
  unsigned char *base;

  register int ceiling;
  register unsigned char *ceiling_addr;

796 797
  int old_immediate_quit = immediate_quit;

798 799 800
  /* The code that follows is like scan_buffer
     but checks for either newline or carriage return.  */

801 802
  if (allow_quit)
    immediate_quit++;
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822

  start_byte = CHAR_TO_BYTE (start);

  if (count > 0)
    {
      while (start_byte < limit_byte)
	{
	  ceiling =  BUFFER_CEILING_OF (start_byte);
	  ceiling = min (limit_byte - 1, ceiling);
	  ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
	  base = (cursor = BYTE_POS_ADDR (start_byte));
	  while (1)
	    {
	      while (*cursor != '\n' && ++cursor != ceiling_addr)
		;

	      if (cursor != ceiling_addr)
		{
		  if (--count == 0)
		    {
823
		      immediate_quit = old_immediate_quit;
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
		      start_byte = start_byte + cursor - base + 1;
		      start = BYTE_TO_CHAR (start_byte);
		      TEMP_SET_PT_BOTH (start, start_byte);
		      return 0;
		    }
		  else
		    if (++cursor == ceiling_addr)
		      break;
		}
	      else
		break;
	    }
	  start_byte += cursor - base;
	}
    }
  else
    {
      while (start_byte > limit_byte)
	{
	  ceiling = BUFFER_FLOOR_OF (start_byte - 1);
	  ceiling = max (limit_byte, ceiling);
	  ceiling_addr = BYTE_POS_ADDR (ceiling) - 1;
	  base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
	  while (1)
	    {
	      while (--cursor != ceiling_addr && *cursor != '\n')
		;

	      if (cursor != ceiling_addr)
		{
		  if (++count == 0)
		    {
856
		      immediate_quit = old_immediate_quit;
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
		      /* Return the position AFTER the match we found.  */
		      start_byte = start_byte + cursor - base + 1;
		      start = BYTE_TO_CHAR (start_byte);
		      TEMP_SET_PT_BOTH (start, start_byte);
		      return 0;
		    }
		}
	      else
		break;
	    }
	  /* Here we add 1 to compensate for the last decrement
	     of CURSOR, which took it past the valid range.  */
	  start_byte += cursor - base + 1;
	}
    }

  TEMP_SET_PT_BOTH (limit, limit_byte);
874
  immediate_quit = old_immediate_quit;
875 876

  return count * direction;
877 878
}

Jim Blandy's avatar
Jim Blandy committed
879
int
880
find_next_newline_no_quit (from, cnt)
Jim Blandy's avatar
Jim Blandy committed
881 882
     register int from, cnt;
{
883
  return scan_buffer ('\n', from, 0, cnt, (int *) 0, 0);
884 885 886 887 888
}

/* Like find_next_newline, but returns position before the newline,
   not after, and only search up to TO.  This isn't just
   find_next_newline (...)-1, because you might hit TO.  */
889

890 891
int
find_before_next_newline (from, to, cnt)
892
     int from, to, cnt;
893 894 895 896 897 898
{
  int shortage;
  int pos = scan_buffer ('\n', from, to, cnt, &shortage, 1);

  if (shortage == 0)
    pos--;
899

900
  return pos;
Jim Blandy's avatar
Jim Blandy committed
901 902 903 904 905
}

/* Subroutines of Lisp buffer search functions. */

static Lisp_Object
906
search_command (string, bound, noerror, count, direction, RE, posix)
Jim Blandy's avatar
Jim Blandy committed
907 908 909
     Lisp_Object string, bound, noerror, count;
     int direction;
     int RE;
910
     int posix;
Jim Blandy's avatar
Jim Blandy committed
911 912
{
  register int np;
913
  int lim, lim_byte;
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917
  int n = direction;

  if (!NILP (count))
    {
918
      CHECK_NUMBER (count);
Jim Blandy's avatar
Jim Blandy committed
919 920 921
      n *= XINT (count);
    }

922
  CHECK_STRING (string);
Jim Blandy's avatar
Jim Blandy committed
923
  if (NILP (bound))
924 925 926 927 928 929
    {
      if (n > 0)
	lim = ZV, lim_byte = ZV_BYTE;
      else
	lim = BEGV, lim_byte = BEGV_BYTE;
    }
Jim Blandy's avatar
Jim Blandy committed
930 931
  else
    {
932
      CHECK_NUMBER_COERCE_MARKER (bound);
Jim Blandy's avatar
Jim Blandy committed
933
      lim = XINT (bound);
934
      if (n > 0 ? lim < PT : lim > PT)
Jim Blandy's avatar
Jim Blandy committed
935 936
	error ("Invalid search bound (wrong side of point)");
      if (lim > ZV)
937
	lim = ZV, lim_byte = ZV_BYTE;
938
      else if (lim < BEGV)
939
	lim = BEGV, lim_byte = BEGV_BYTE;
940 941
      else
	lim_byte = CHAR_TO_BYTE (lim);
Jim Blandy's avatar
Jim Blandy committed
942 943
    }

944 945 946 947
  /* This is so set_image_of_range_1 in regex.c can find the EQV table.  */
  XCHAR_TABLE (current_buffer->case_canon_table)->extras[2]
    = current_buffer->case_eqv_table;

948
  np = search_buffer (string, PT, PT_BYTE, lim, lim_byte, n, RE,
Jim Blandy's avatar
Jim Blandy committed
949
		      (!NILP (current_buffer->case_fold_search)
950
		       ? current_buffer->case_canon_table
951
		       : Qnil),
Jim Blandy's avatar
Jim Blandy committed
952
		      (!NILP (current_buffer->case_fold_search)
953
		       ? current_buffer->case_eqv_table
954
		       : Qnil),
955
		      posix);
Jim Blandy's avatar
Jim Blandy committed
956 957 958
  if (np <= 0)
    {
      if (NILP (noerror))
959 960
	xsignal1 (Qsearch_failed, string);

Jim Blandy's avatar
Jim Blandy committed
961 962 963 964
      if (!EQ (noerror, Qt))
	{
	  if (lim < BEGV || lim > ZV)
	    abort ();
965
	  SET_PT_BOTH (lim, lim_byte);
966 967 968
	  return Qnil;
#if 0 /* This would be clean, but maybe programs depend on
	 a value of nil here.  */
969
	  np = lim;
970
#endif
Jim Blandy's avatar
Jim Blandy committed
971
	}
972 973
      else
	return Qnil;
Jim Blandy's avatar
Jim Blandy committed
974 975 976 977 978 979 980 981 982 983
    }

  if (np < BEGV || np > ZV)
    abort ();

  SET_PT (np);

  return make_number (np);
}

984 985
/* Return 1 if REGEXP it matches just one constant string.  */

Karl Heuer's avatar
Karl Heuer committed
986 987 988 989
static int
trivial_regexp_p (regexp)
     Lisp_Object regexp;
{
990 991
  int len = SBYTES (regexp);
  unsigned char *s = SDATA (regexp);
Karl Heuer's avatar
Karl Heuer committed
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
  while (--len >= 0)
    {
      switch (*s++)
	{
	case '.': case '*': case '+': case '?': case '[': case '^': case '$':
	  return 0;
	case '\\':
	  if (--len < 0)
	    return 0;
	  switch (*s++)
	    {
	    case '|': case '(': case ')': case '`': case '\'': case 'b':
	    case 'B': case '<': case '>': case 'w': case 'W': case 's':
1005
	    case 'S': case '=': case '{': case '}': case '_':
Karl Heuer's avatar
Karl Heuer committed
1006
	    case 'c': case 'C':	/* for categoryspec and notcategoryspec */
1007
	    case '1': case '2': case '3': case '4': case '5':
Karl Heuer's avatar
Karl Heuer committed
1008 1009 1010 1011 1012 1013 1014 1015
	    case '6': case '7': case '8': case '9':
	      return 0;
	    }
	}
    }
  return 1;
}

1016
/* Search for the n'th occurrence of STRING in the current buffer,
Jim Blandy's avatar
Jim Blandy committed
1017
   starting at position POS and stopping at position LIM,
1018
   treating STRING as a literal string if RE is false or as
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021 1022 1023
   a regular expression if RE is true.

   If N is positive, searching is forward and LIM must be greater than POS.
   If N is negative, searching is backward and LIM must be less than POS.

1024
   Returns -x if x occurrences remain to be found (x > 0),
Jim Blandy's avatar
Jim Blandy committed
1025
   or else the position at the beginning of the Nth occurrence
1026 1027 1028 1029
   (if searching backward) or the end (if searching forward).

   POSIX is nonzero if we want full backtracking (POSIX style)
   for this pattern.  0 means backtrack only enough to get a valid match.  */
Jim Blandy's avatar
Jim Blandy committed
1030

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
#define TRANSLATE(out, trt, d)			\
do						\
  {						\
    if (! NILP (trt))				\
      {						\
	Lisp_Object temp;			\
	temp = Faref (trt, make_number (d));	\
	if (INTEGERP (temp))			\
	  out = XINT (temp);			\
	else					\
	  out = d;				\
      }						\
    else					\
      out = d;					\
  }						\
while (0)
1047

1048
static int