search.c 90.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* String search routines for GNU Emacs.
2 3
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1997, 1998, 1999, 2001, 2002,
                 2003, 2004, 2005, 2006, 2007  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"
28
#include "character.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
  /* Syntax table for which the regexp applies.  We need this because
46 47
     of character classes.  If this is t, then the compiled pattern is valid
     for any syntax-table.  */
48
  Lisp_Object syntax_table;
49 50
  struct re_pattern_buffer buf;
  char fastmap[0400];
51 52
  /* Nonzero means regexp was compiled to do full POSIX backtracking.  */
  char posix;
53
};
Jim Blandy's avatar
Jim Blandy committed
54

55 56
/* The instances of that struct.  */
struct regexp_cache searchbufs[REGEXP_CACHE_SIZE];
Jim Blandy's avatar
Jim Blandy committed
57

58 59
/* 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
60 61


Jim Blandy's avatar
Jim Blandy committed
62 63 64 65 66 67 68
/* 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
69 70 71
   been allocated by checking search_regs.num_regs.

   The regex code keeps track of whether it has allocated the search
72 73
   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
74 75 76 77 78
   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
79 80
static struct re_registers search_regs;

Jim Blandy's avatar
Jim Blandy committed
81 82 83 84
/* 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
85

Karl Heuer's avatar
Karl Heuer committed
86
/* error condition signaled when regexp compile_pattern fails */
Jim Blandy's avatar
Jim Blandy committed
87 88 89

Lisp_Object Qinvalid_regexp;

90 91 92
/* Error condition used for failing searches */
Lisp_Object Qsearch_failed;

Richard M. Stallman's avatar
Richard M. Stallman committed
93
Lisp_Object Vsearch_spaces_regexp;
94

95
static void set_search_regs ();
96
static void save_search_regs ();
97 98
static int simple_search ();
static int boyer_moore ();
99
static int search_buffer ();
100
static void matcher_overflow () NO_RETURN;
101

Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107
static void
matcher_overflow ()
{
  error ("Stack overflow in regexp matcher");
}

108 109 110
/* 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.
111
   TRANSLATE is a translation table for ignoring case, or nil for none.
112 113 114 115 116
   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
117
   for this pattern.  0 means backtrack only enough to get a valid match.
Kenichi Handa's avatar
Kenichi Handa committed
118
   MULTIBYTE is nonzero iff a target of match is a multibyte buffer or
119 120 121
   string.

   The behavior also depends on Vsearch_spaces_regexp.  */
Jim Blandy's avatar
Jim Blandy committed
122

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

135
  cp->regexp = Qnil;
136
  cp->buf.translate = (! NILP (translate) ? translate : make_number (0));
137
  cp->posix = posix;
138 139
  cp->buf.multibyte = STRING_MULTIBYTE (pattern);
  cp->buf.target_multibyte = multibyte;
140
  cp->whitespace_regexp = Vsearch_spaces_regexp;
141 142 143 144 145
  /* rms: I think BLOCK_INPUT is not needed here any more,
     because regex.c defines malloc to call xmalloc.
     Using BLOCK_INPUT here means the debugger won't run if an error occurs.
     So let's turn it off.  */
  /*  BLOCK_INPUT;  */
146
  old = re_set_syntax (RE_SYNTAX_EMACS
147
		       | (posix ? 0 : RE_NO_POSIX_BACKTRACKING));
148 149 150
  re_set_whitespace_regexp (NILP (Vsearch_spaces_regexp) ? NULL
			    : SDATA (Vsearch_spaces_regexp));

Kenichi Handa's avatar
Kenichi Handa committed
151 152
  val = (char *) re_compile_pattern ((char *) SDATA (pattern),
				     SBYTES (pattern), &cp->buf);
153

154 155 156 157
  /* If the compiled pattern hard codes some of the contents of the
     syntax-table, it can only be reused with *this* syntax table.  */
  cp->syntax_table = cp->buf.used_syntax ? current_buffer->syntax_table : Qt;

158 159
  re_set_whitespace_regexp (NULL);

160
  re_set_syntax (old);
161
  /* UNBLOCK_INPUT;  */
Jim Blandy's avatar
Jim Blandy committed
162
  if (val)
163
    xsignal1 (Qinvalid_regexp, build_string (val));
Jim Blandy's avatar
Jim Blandy committed
164

165 166 167
  cp->regexp = Fcopy_sequence (pattern);
}

168 169 170 171 172 173 174
/* 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 ()
{
175
  struct regexp_cache *cp;
176 177 178 179 180

  for (cp = searchbuf_head; cp != 0; cp = cp->next)
    {
      cp->buf.allocated = cp->buf.used;
      cp->buf.buffer
181
	= (unsigned char *) xrealloc (cp->buf.buffer, cp->buf.used);
182 183 184
    }
}

185 186
/* Clear the regexp cache w.r.t. a particular syntax table,
   because it was changed.
187 188 189 190 191 192 193 194 195
   There is no danger of memory leak here because re_compile_pattern
   automagically manages the memory in each re_pattern_buffer struct,
   based on its `allocated' and `buffer' values.  */
void
clear_regexp_cache ()
{
  int i;

  for (i = 0; i < REGEXP_CACHE_SIZE; ++i)
196 197 198 199 200
    /* It's tempting to compare with the syntax-table we've actually changd,
       but it's not sufficient because char-table inheritance mewans that
       modifying one syntax-table can change others at the same time.  */
    if (!EQ (searchbufs[i].syntax_table, Qt))
      searchbufs[i].regexp = Qnil;
201 202
}

203
/* Compile a regexp if necessary, but first check to see if there's one in
204 205
   the cache.
   PATTERN is the pattern to compile.
206
   TRANSLATE is a translation table for ignoring case, or nil for none.
207 208 209 210 211 212
   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.  */
213 214

struct re_pattern_buffer *
215
compile_pattern (pattern, regp, translate, posix, multibyte)
216 217
     Lisp_Object pattern;
     struct re_registers *regp;
218
     Lisp_Object translate;
219
     int posix, multibyte;
220 221 222 223 224 225
{
  struct regexp_cache *cp, **cpp;

  for (cpp = &searchbuf_head; ; cpp = &cp->next)
    {
      cp = *cpp;
226 227
      /* 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
228 229 230
	 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.  */
231
      if (NILP (cp->regexp))
232
	goto compile_it;
233
      if (SCHARS (cp->regexp) == SCHARS (pattern)
234
	  && STRING_MULTIBYTE (cp->regexp) == STRING_MULTIBYTE (pattern)
235
	  && !NILP (Fstring_equal (cp->regexp, pattern))
236
	  && EQ (cp->buf.translate, (! NILP (translate) ? translate : make_number (0)))
Karl Heuer's avatar
Karl Heuer committed
237
	  && cp->posix == posix
238
	  && cp->buf.target_multibyte == multibyte
239 240
	  && (EQ (cp->syntax_table, Qt)
	      || EQ (cp->syntax_table, current_buffer->syntax_table))
241
	  && !NILP (Fequal (cp->whitespace_regexp, Vsearch_spaces_regexp)))
242 243
	break;

244 245 246
      /* 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.  */
247 248
      if (cp->next == 0)
	{
249
	compile_it:
Karl Heuer's avatar
Karl Heuer committed
250
	  compile_pattern_1 (cp, pattern, translate, regp, posix, multibyte);
251 252 253 254 255 256 257 258 259 260
	  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
261

262 263 264 265 266
  /* 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);

267
  return &cp->buf;
Jim Blandy's avatar
Jim Blandy committed
268 269 270
}


271 272
static Lisp_Object
looking_at_1 (string, posix)
Jim Blandy's avatar
Jim Blandy committed
273
     Lisp_Object string;
274
     int posix;
Jim Blandy's avatar
Jim Blandy committed
275 276 277 278 279
{
  Lisp_Object val;
  unsigned char *p1, *p2;
  int s1, s2;
  register int i;
280
  struct re_pattern_buffer *bufp;
Jim Blandy's avatar
Jim Blandy committed
281

282 283 284
  if (running_asynch_code)
    save_search_regs ();

285 286 287 288
  /* 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;

289
  CHECK_STRING (string);
290 291
  bufp = compile_pattern (string, &search_regs,
			  (!NILP (current_buffer->case_fold_search)
292
			   ? current_buffer->case_canon_table : Qnil),
293 294
			  posix,
			  !NILP (current_buffer->enable_multibyte_characters));
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299 300 301 302

  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;
303
  s1 = GPT_BYTE - BEGV_BYTE;
Jim Blandy's avatar
Jim Blandy committed
304
  p2 = GAP_END_ADDR;
305
  s2 = ZV_BYTE - GPT_BYTE;
Jim Blandy's avatar
Jim Blandy committed
306 307 308
  if (s1 < 0)
    {
      p2 = p1;
309
      s2 = ZV_BYTE - BEGV_BYTE;
Jim Blandy's avatar
Jim Blandy committed
310 311 312 313
      s1 = 0;
    }
  if (s2 < 0)
    {
314
      s1 = ZV_BYTE - BEGV_BYTE;
Jim Blandy's avatar
Jim Blandy committed
315 316
      s2 = 0;
    }
317 318

  re_match_object = Qnil;
319

320
  i = re_match_2 (bufp, (char *) p1, s1, (char *) p2, s2,
321 322
		  PT_BYTE - BEGV_BYTE, &search_regs,
		  ZV_BYTE - BEGV_BYTE);
323
  immediate_quit = 0;
324

Jim Blandy's avatar
Jim Blandy committed
325 326 327 328
  if (i == -2)
    matcher_overflow ();

  val = (0 <= i ? Qt : Qnil);
329 330 331 332 333 334 335 336 337
  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);
	}
338
  XSETBUFFER (last_thing_searched, current_buffer);
Jim Blandy's avatar
Jim Blandy committed
339 340 341
  return val;
}

342
DEFUN ("looking-at", Flooking_at, Slooking_at, 1, 1, 0,
343 344 345 346 347
       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)
348
     Lisp_Object regexp;
349
{
350
  return looking_at_1 (regexp, 0);
351 352 353
}

DEFUN ("posix-looking-at", Fposix_looking_at, Sposix_looking_at, 1, 1, 0,
354 355 356 357 358 359
       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)
360
     Lisp_Object regexp;
361
{
362
  return looking_at_1 (regexp, 1);
363 364 365 366
}

static Lisp_Object
string_match_1 (regexp, string, start, posix)
Jim Blandy's avatar
Jim Blandy committed
367
     Lisp_Object regexp, string, start;
368
     int posix;
Jim Blandy's avatar
Jim Blandy committed
369 370
{
  int val;
371
  struct re_pattern_buffer *bufp;
372 373
  int pos, pos_byte;
  int i;
Jim Blandy's avatar
Jim Blandy committed
374

375 376 377
  if (running_asynch_code)
    save_search_regs ();

378 379
  CHECK_STRING (regexp);
  CHECK_STRING (string);
Jim Blandy's avatar
Jim Blandy committed
380 381

  if (NILP (start))
382
    pos = 0, pos_byte = 0;
Jim Blandy's avatar
Jim Blandy committed
383 384
  else
    {
385
      int len = SCHARS (string);
Jim Blandy's avatar
Jim Blandy committed
386

387
      CHECK_NUMBER (start);
388 389 390 391
      pos = XINT (start);
      if (pos < 0 && -pos <= len)
	pos = len + pos;
      else if (0 > pos || pos > len)
Jim Blandy's avatar
Jim Blandy committed
392
	args_out_of_range (string, start);
393
      pos_byte = string_char_to_byte (string, pos);
Jim Blandy's avatar
Jim Blandy committed
394 395
    }

396 397 398 399
  /* 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;

400 401
  bufp = compile_pattern (regexp, &search_regs,
			  (!NILP (current_buffer->case_fold_search)
402
			   ? current_buffer->case_canon_table : Qnil),
403 404
			  posix,
			  STRING_MULTIBYTE (string));
Jim Blandy's avatar
Jim Blandy committed
405
  immediate_quit = 1;
406
  re_match_object = string;
407

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

  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
428
}
Richard M. Stallman's avatar
Richard M. Stallman committed
429

430
DEFUN ("string-match", Fstring_match, Sstring_match, 2, 3, 0,
431
       doc: /* Return index of start of first match for REGEXP in STRING, or nil.
Richard M. Stallman's avatar
Richard M. Stallman committed
432
Matching ignores case if `case-fold-search' is non-nil.
433 434 435
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
436 437 438 439
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. */)
440
     (regexp, string, start)
441 442 443 444 445 446
     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,
447 448 449 450 451 452 453 454
       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)
455 456 457 458 459
     Lisp_Object regexp, string, start;
{
  return string_match_1 (regexp, string, start, 1);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
460 461 462 463 464 465 466 467 468
/* 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;
469
  struct re_pattern_buffer *bufp;
Richard M. Stallman's avatar
Richard M. Stallman committed
470

471 472
  bufp = compile_pattern (regexp, 0, Qnil,
			  0, STRING_MULTIBYTE (string));
Richard M. Stallman's avatar
Richard M. Stallman committed
473
  immediate_quit = 1;
474
  re_match_object = string;
475

476 477 478
  val = re_search (bufp, (char *) SDATA (string),
		   SBYTES (string), 0,
		   SBYTES (string), 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
479 480 481
  immediate_quit = 0;
  return val;
}
Karl Heuer's avatar
Karl Heuer committed
482 483 484

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

extern Lisp_Object Vascii_downcase_table;

int
491
fast_c_string_match_ignore_case (regexp, string)
Karl Heuer's avatar
Karl Heuer committed
492
     Lisp_Object regexp;
493
     const char *string;
Karl Heuer's avatar
Karl Heuer committed
494 495 496 497 498
{
  int val;
  struct re_pattern_buffer *bufp;
  int len = strlen (string);

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

/* 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;

519
  bufp = compile_pattern (regexp, 0, Vascii_canon_table,
520 521 522 523 524 525 526 527 528 529
			  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;
}
530 531 532 533 534 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

/* 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
568 569

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

573 574
   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
575

576 577 578
   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
579
int
580 581 582 583 584
scan_buffer (target, start, end, count, shortage, allow_quit)
     register int target;
     int start, end;
     int count;
     int *shortage;
585
     int allow_quit;
Jim Blandy's avatar
Jim Blandy committed
586
{
587
  struct region_cache *newline_cache;
588
  int direction;
Jim Blandy's avatar
Jim Blandy committed
589

590 591 592 593 594 595 596 597 598 599
  if (count > 0)
    {
      direction = 1;
      if (! end) end = ZV;
    }
  else
    {
      direction = -1;
      if (! end) end = BEGV;
    }
Jim Blandy's avatar
Jim Blandy committed
600

601 602
  newline_cache_on_off (current_buffer);
  newline_cache = current_buffer->newline_cache;
Jim Blandy's avatar
Jim Blandy committed
603 604 605 606

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

607
  immediate_quit = allow_quit;
Jim Blandy's avatar
Jim Blandy committed
608

Jim Blandy's avatar
Jim Blandy committed
609
  if (count > 0)
610
    while (start != end)
Jim Blandy's avatar
Jim Blandy committed
611
      {
612 613 614 615 616
        /* 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.  */
617 618
	int ceiling_byte = CHAR_TO_BYTE (end) - 1;
	int start_byte = CHAR_TO_BYTE (start);
619
	int tem;
620 621 622 623 624 625 626 627

        /* 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
628 629
                   (current_buffer, newline_cache, start_byte, &next_change))
              start_byte = next_change;
630
            immediate_quit = allow_quit;
631

632 633 634
            /* START should never be after END.  */
            if (start_byte > ceiling_byte)
              start_byte = ceiling_byte;
635 636 637

            /* Now the text after start is an unknown region, and
               next_change is the position of the next known region. */
638
            ceiling_byte = min (next_change - 1, ceiling_byte);
639 640 641 642 643 644
          }

        /* 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.  */
645 646
	tem = BUFFER_CEILING_OF (start_byte);
	ceiling_byte = min (tem, ceiling_byte);
647 648

        {
649
          /* The termination address of the dumb loop.  */
650 651 652 653
          register unsigned char *ceiling_addr
	    = BYTE_POS_ADDR (ceiling_byte) + 1;
          register unsigned char *cursor
	    = BYTE_POS_ADDR (start_byte);
654 655 656 657 658 659 660 661 662 663 664 665 666 667
          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,
668 669
                                   start_byte + scan_start - base,
                                   start_byte + cursor - base);
670 671 672 673 674 675 676

              /* Did we find the target character?  */
              if (cursor < ceiling_addr)
                {
                  if (--count == 0)
                    {
                      immediate_quit = 0;
677
                      return BYTE_TO_CHAR (start_byte + cursor - base + 1);
678 679 680 681 682
                    }
                  cursor++;
                }
            }

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

        /* Consult the newline cache, if appropriate.  */
        if (target == '\n' && newline_cache)
          {
            int next_change;
            immediate_quit = 0;
            while (region_cache_backward
700 701
                   (current_buffer, newline_cache, start_byte, &next_change))
              start_byte = next_change;
702
            immediate_quit = allow_quit;
703 704

            /* Start should never be at or before end.  */
705 706
            if (start_byte <= ceiling_byte)
              start_byte = ceiling_byte + 1;
707 708 709

            /* Now the text before start is an unknown region, and
               next_change is the position of the next known region. */
710
            ceiling_byte = max (next_change, ceiling_byte);
711 712 713
          }

        /* Stop scanning before the gap.  */
714 715
	tem = BUFFER_FLOOR_OF (start_byte - 1);
	ceiling_byte = max (tem, ceiling_byte);
716 717 718

        {
          /* The termination address of the dumb loop.  */
719 720
          register unsigned char *ceiling_addr = BYTE_POS_ADDR (ceiling_byte);
          register unsigned char *cursor = BYTE_POS_ADDR (start_byte - 1);
721 722 723 724 725 726 727 728 729 730 731 732 733
          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,
734 735
                                   start_byte + cursor - base,
                                   start_byte + scan_start - base);
736 737 738 739 740 741 742

              /* Did we find the target character?  */
              if (cursor >= ceiling_addr)
                {
                  if (++count >= 0)
                    {
                      immediate_quit = 0;
743
                      return BYTE_TO_CHAR (start_byte + cursor - base);
744 745 746 747 748
                    }
                  cursor--;
                }
            }

749
	  start = BYTE_TO_CHAR (start_byte + cursor - base);
750 751 752
        }
      }

Jim Blandy's avatar
Jim Blandy committed
753 754
  immediate_quit = 0;
  if (shortage != 0)
Jim Blandy's avatar
Jim Blandy committed
755
    *shortage = count * direction;
756
  return start;
Jim Blandy's avatar
Jim Blandy committed
757
}
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773

/* 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
774
   except in special cases.  */
Jim Blandy's avatar
Jim Blandy committed
775

776
int
777 778 779 780 781
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;
782
{
783 784 785 786 787 788 789 790
  int direction = ((count > 0) ? 1 : -1);

  register unsigned char *cursor;
  unsigned char *base;

  register int ceiling;
  register unsigned char *ceiling_addr;

791 792
  int old_immediate_quit = immediate_quit;

793 794 795
  /* The code that follows is like scan_buffer
     but checks for either newline or carriage return.  */

796 797
  if (allow_quit)
    immediate_quit++;
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817

  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)
		    {
818
		      immediate_quit = old_immediate_quit;
819 820 821 822 823 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
		      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)
		    {
851
		      immediate_quit = old_immediate_quit;
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
		      /* 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);
869
  immediate_quit = old_immediate_quit;
870 871

  return count * direction;
872 873
}

Jim Blandy's avatar
Jim Blandy committed
874
int
875
find_next_newline_no_quit (from, cnt)
Jim Blandy's avatar
Jim Blandy committed
876 877
     register int from, cnt;
{
878
  return scan_buffer ('\n', from, 0, cnt, (int *) 0, 0);
879 880 881 882 883
}

/* 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.  */
884

885 886
int
find_before_next_newline (from, to, cnt)
887
     int from, to, cnt;
888 889 890 891 892 893
{
  int shortage;
  int pos = scan_buffer ('\n', from, to, cnt, &shortage, 1);

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

895
  return pos;
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900
}

/* Subroutines of Lisp buffer search functions. */

static Lisp_Object
901
search_command (string, bound, noerror, count, direction, RE, posix)
Jim Blandy's avatar
Jim Blandy committed
902 903 904
     Lisp_Object string, bound, noerror, count;
     int direction;
     int RE;
905
     int posix;
Jim Blandy's avatar
Jim Blandy committed
906 907
{
  register int np;
908
  int lim, lim_byte;
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912
  int n = direction;

  if (!NILP (count))
    {
913
      CHECK_NUMBER (count);
Jim Blandy's avatar
Jim Blandy committed
914 915 916
      n *= XINT (count);
    }

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

939 940 941 942
  /* 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;

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

Jim Blandy's avatar
Jim Blandy committed
956 957 958 959
      if (!EQ (noerror, Qt))
	{
	  if (lim < BEGV || lim > ZV)
	    abort ();
960
	  SET_PT_BOTH (lim, lim_byte);
961 962 963
	  return Qnil;
#if 0 /* This would be clean, but maybe programs depend on
	 a value of nil here.  */
964
	  np = lim;
965
#endif
Jim Blandy's avatar
Jim Blandy committed
966
	}