search.c 86.6 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* String search routines for GNU Emacs.
2 3
   Copyright (C) 1985, 86,87,93,94,97,98, 1999, 2004
             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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, 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 44 45 46
  struct regexp_cache *next;
  Lisp_Object regexp;
  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
Lisp_Object Vsearch_whitespace_regexp;

88
static void set_search_regs ();
89
static void save_search_regs ();
90 91
static int simple_search ();
static int boyer_moore ();
92 93
static int search_buffer ();

Jim Blandy's avatar
Jim Blandy committed
94 95 96 97 98 99
static void
matcher_overflow ()
{
  error ("Stack overflow in regexp matcher");
}

100 101 102
/* 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.
103
   TRANSLATE is a translation table for ignoring case, or nil for none.
104 105 106 107 108
   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
109 110 111 112
   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
   sequences of binary data.  */
Jim Blandy's avatar
Jim Blandy committed
113

114
static void
Karl Heuer's avatar
Karl Heuer committed
115
compile_pattern_1 (cp, pattern, translate, regp, posix, multibyte)
116
     struct regexp_cache *cp;
Jim Blandy's avatar
Jim Blandy committed
117
     Lisp_Object pattern;
118
     Lisp_Object translate;
119
     struct re_registers *regp;
120
     int posix;
Karl Heuer's avatar
Karl Heuer committed
121
     int multibyte;
Jim Blandy's avatar
Jim Blandy committed
122
{
123
  unsigned char *raw_pattern;
124
  int raw_pattern_size;
125
  char *val;
126
  reg_syntax_t old;
Jim Blandy's avatar
Jim Blandy committed
127

128 129 130 131 132 133
  /* 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))
    {
134 135
      raw_pattern = (unsigned char *) SDATA (pattern);
      raw_pattern_size = SBYTES (pattern);
136 137 138
    }
  else if (multibyte)
    {
139 140
      raw_pattern_size = count_size_as_multibyte (SDATA (pattern),
						  SCHARS (pattern));
141
      raw_pattern = (unsigned char *) alloca (raw_pattern_size + 1);
142 143
      copy_text (SDATA (pattern), raw_pattern,
		 SCHARS (pattern), 0, 1);
144 145 146 147 148 149 150 151 152
    }
  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.  */
153
      raw_pattern_size = SCHARS (pattern);
154
      raw_pattern = (unsigned char *) alloca (raw_pattern_size + 1);
155 156
      copy_text (SDATA (pattern), raw_pattern,
		 SBYTES (pattern), 1, 0);
157 158
    }

159
  cp->regexp = Qnil;
160
  cp->buf.translate = (! NILP (translate) ? translate : make_number (0));
161
  cp->posix = posix;
Karl Heuer's avatar
Karl Heuer committed
162
  cp->buf.multibyte = multibyte;
163
  BLOCK_INPUT;
164
  old = re_set_syntax (RE_SYNTAX_EMACS
165
		       | (posix ? 0 : RE_NO_POSIX_BACKTRACKING));
166 167 168 169

  re_set_whitespace_regexp (NILP (Vsearch_whitespace_regexp) ? NULL
			    : SDATA (Vsearch_whitespace_regexp));

170 171
  val = (char *) re_compile_pattern ((char *)raw_pattern,
				     raw_pattern_size, &cp->buf);
172 173 174

  re_set_whitespace_regexp (NULL);

175
  re_set_syntax (old);
176
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
177
  if (val)
178
    Fsignal (Qinvalid_regexp, Fcons (build_string (val), Qnil));
Jim Blandy's avatar
Jim Blandy committed
179

180 181 182
  cp->regexp = Fcopy_sequence (pattern);
}

183 184 185 186 187 188 189
/* 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 ()
{
190
  struct regexp_cache *cp;
191 192 193 194 195

  for (cp = searchbuf_head; cp != 0; cp = cp->next)
    {
      cp->buf.allocated = cp->buf.used;
      cp->buf.buffer
196
	= (unsigned char *) xrealloc (cp->buf.buffer, cp->buf.used);
197 198 199
    }
}

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

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

  for (cpp = &searchbuf_head; ; cpp = &cp->next)
    {
      cp = *cpp;
223 224
      /* 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
225 226 227
	 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.  */
228
      if (NILP (cp->regexp))
229
	goto compile_it;
230
      if (SCHARS (cp->regexp) == SCHARS (pattern)
231
	  && STRING_MULTIBYTE (cp->regexp) == STRING_MULTIBYTE (pattern)
232
	  && !NILP (Fstring_equal (cp->regexp, pattern))
233
	  && EQ (cp->buf.translate, (! NILP (translate) ? translate : make_number (0)))
Karl Heuer's avatar
Karl Heuer committed
234 235
	  && cp->posix == posix
	  && cp->buf.multibyte == multibyte)
236 237
	break;

238 239 240
      /* 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.  */
241 242
      if (cp->next == 0)
	{
243
	compile_it:
Karl Heuer's avatar
Karl Heuer committed
244
	  compile_pattern_1 (cp, pattern, translate, regp, posix, multibyte);
245 246 247 248 249 250 251 252 253 254
	  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
255

256 257 258 259 260
  /* 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);

261
  return &cp->buf;
Jim Blandy's avatar
Jim Blandy committed
262 263 264 265 266 267 268 269 270 271 272 273 274
}

/* Error condition used for failing searches */
Lisp_Object Qsearch_failed;

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

286 287 288
  if (running_asynch_code)
    save_search_regs ();

289
  CHECK_STRING (string);
290 291
  bufp = compile_pattern (string, &search_regs,
			  (!NILP (current_buffer->case_fold_search)
292
			   ? DOWNCASE_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
  bufp = compile_pattern (regexp, &search_regs,
			  (!NILP (current_buffer->case_fold_search)
398
			   ? DOWNCASE_TABLE : Qnil),
399 400
			  posix,
			  STRING_MULTIBYTE (string));
Jim Blandy's avatar
Jim Blandy committed
401
  immediate_quit = 1;
402
  re_match_object = string;
403

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

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

426
DEFUN ("string-match", Fstring_match, Sstring_match, 2, 3, 0,
427 428 429 430 431
       doc: /* Return index of start of first match for REGEXP in STRING, or nil.
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
432 433 434 435
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. */)
436
     (regexp, string, start)
437 438 439 440 441 442
     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,
443 444 445 446 447 448 449 450
       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)
451 452 453 454 455
     Lisp_Object regexp, string, start;
{
  return string_match_1 (regexp, string, start, 1);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
456 457 458 459 460 461 462 463 464
/* 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;
465
  struct re_pattern_buffer *bufp;
Richard M. Stallman's avatar
Richard M. Stallman committed
466

467 468
  bufp = compile_pattern (regexp, 0, Qnil,
			  0, STRING_MULTIBYTE (string));
Richard M. Stallman's avatar
Richard M. Stallman committed
469
  immediate_quit = 1;
470
  re_match_object = string;
471

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

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

extern Lisp_Object Vascii_downcase_table;

int
487
fast_c_string_match_ignore_case (regexp, string)
Karl Heuer's avatar
Karl Heuer committed
488
     Lisp_Object regexp;
489
     const char *string;
Karl Heuer's avatar
Karl Heuer committed
490 491 492 493 494
{
  int val;
  struct re_pattern_buffer *bufp;
  int len = strlen (string);

495
  regexp = string_make_unibyte (regexp);
496
  re_match_object = Qt;
Karl Heuer's avatar
Karl Heuer committed
497
  bufp = compile_pattern (regexp, 0,
498
			  Vascii_downcase_table, 0,
499
			  0);
Karl Heuer's avatar
Karl Heuer committed
500 501 502 503 504
  immediate_quit = 1;
  val = re_search (bufp, string, len, 0, len, 0);
  immediate_quit = 0;
  return val;
}
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525

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

  bufp = compile_pattern (regexp, 0, Vascii_downcase_table,
			  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;
}
526 527 528 529 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

/* 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
564 565

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

569 570
   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
571

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

586 587 588 589 590 591 592 593 594 595
  if (count > 0)
    {
      direction = 1;
      if (! end) end = ZV;
    }
  else
    {
      direction = -1;
      if (! end) end = BEGV;
    }
Jim Blandy's avatar
Jim Blandy committed
596

597 598
  newline_cache_on_off (current_buffer);
  newline_cache = current_buffer->newline_cache;
Jim Blandy's avatar
Jim Blandy committed
599 600 601 602

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

603
  immediate_quit = allow_quit;
Jim Blandy's avatar
Jim Blandy committed
604

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

        /* 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
624 625
                   (current_buffer, newline_cache, start_byte, &next_change))
              start_byte = next_change;
626
            immediate_quit = allow_quit;
627

628 629 630
            /* START should never be after END.  */
            if (start_byte > ceiling_byte)
              start_byte = ceiling_byte;
631 632 633

            /* Now the text after start is an unknown region, and
               next_change is the position of the next known region. */
634
            ceiling_byte = min (next_change - 1, ceiling_byte);
635 636 637 638 639 640
          }

        /* 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.  */
641 642
	tem = BUFFER_CEILING_OF (start_byte);
	ceiling_byte = min (tem, ceiling_byte);
643 644

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

              /* Did we find the target character?  */
              if (cursor < ceiling_addr)
                {
                  if (--count == 0)
                    {
                      immediate_quit = 0;
673
                      return BYTE_TO_CHAR (start_byte + cursor - base + 1);
674 675 676 677 678
                    }
                  cursor++;
                }
            }

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

        /* Consult the newline cache, if appropriate.  */
        if (target == '\n' && newline_cache)
          {
            int next_change;
            immediate_quit = 0;
            while (region_cache_backward
696 697
                   (current_buffer, newline_cache, start_byte, &next_change))
              start_byte = next_change;
698
            immediate_quit = allow_quit;
699 700

            /* Start should never be at or before end.  */
701 702
            if (start_byte <= ceiling_byte)
              start_byte = ceiling_byte + 1;
703 704 705

            /* Now the text before start is an unknown region, and
               next_change is the position of the next known region. */
706
            ceiling_byte = max (next_change, ceiling_byte);
707 708 709
          }

        /* Stop scanning before the gap.  */
710 711
	tem = BUFFER_FLOOR_OF (start_byte - 1);
	ceiling_byte = max (tem, ceiling_byte);
712 713 714

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

              /* Did we find the target character?  */
              if (cursor >= ceiling_addr)
                {
                  if (++count >= 0)
                    {
                      immediate_quit = 0;
739
                      return BYTE_TO_CHAR (start_byte + cursor - base);
740 741 742 743 744
                    }
                  cursor--;
                }
            }

745
	  start = BYTE_TO_CHAR (start_byte + cursor - base);
746 747 748
        }
      }

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

772
int
773 774 775 776 777
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;
778
{
779 780 781 782 783 784 785 786
  int direction = ((count > 0) ? 1 : -1);

  register unsigned char *cursor;
  unsigned char *base;

  register int ceiling;
  register unsigned char *ceiling_addr;

787 788
  int old_immediate_quit = immediate_quit;

789 790 791
  /* The code that follows is like scan_buffer
     but checks for either newline or carriage return.  */

792 793
  if (allow_quit)
    immediate_quit++;
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813

  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)
		    {
814
		      immediate_quit = old_immediate_quit;
815 816 817 818 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
		      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)
		    {
847
		      immediate_quit = old_immediate_quit;
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
		      /* 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);
865
  immediate_quit = old_immediate_quit;
866 867

  return count * direction;
868 869
}

Jim Blandy's avatar
Jim Blandy committed
870
int
871
find_next_newline_no_quit (from, cnt)
Jim Blandy's avatar
Jim Blandy committed
872 873
     register int from, cnt;
{
874
  return scan_buffer ('\n', from, 0, cnt, (int *) 0, 0);
875 876 877 878 879
}

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

881 882
int
find_before_next_newline (from, to, cnt)
883
     int from, to, cnt;
884 885 886 887 888 889
{
  int shortage;
  int pos = scan_buffer ('\n', from, to, cnt, &shortage, 1);

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

891
  return pos;
Jim Blandy's avatar
Jim Blandy committed
892 893 894 895 896
}

/* Subroutines of Lisp buffer search functions. */

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

  if (!NILP (count))
    {
909
      CHECK_NUMBER (count);
Jim Blandy's avatar
Jim Blandy committed
910 911 912
      n *= XINT (count);
    }

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

935
  np = search_buffer (string, PT, PT_BYTE, lim, lim_byte, n, RE,
Jim Blandy's avatar
Jim Blandy committed
936
		      (!NILP (current_buffer->case_fold_search)
937
		       ? current_buffer->case_canon_table
938
		       : Qnil),
Jim Blandy's avatar
Jim Blandy committed
939
		      (!NILP (current_buffer->case_fold_search)
940
		       ? current_buffer->case_eqv_table
941
		       : Qnil),
942
		      posix);
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946 947 948 949 950
  if (np <= 0)
    {
      if (NILP (noerror))
	return signal_failure (string);
      if (!EQ (noerror, Qt))
	{
	  if (lim < BEGV || lim > ZV)
	    abort ();
951
	  SET_PT_BOTH (lim, lim_byte);
952 953 954
	  return Qnil;
#if 0 /* This would be clean, but maybe programs depend on
	 a value of nil here.  */
955
	  np = lim;
956
#endif
Jim Blandy's avatar
Jim Blandy committed
957
	}
958 959
      else
	return Qnil;
Jim Blandy's avatar
Jim Blandy committed
960 961 962 963 964 965 966 967 968 969
    }

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

  SET_PT (np);

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

Karl Heuer's avatar
Karl Heuer committed
972 973 974 975
static int
trivial_regexp_p (regexp)
     Lisp_Object regexp;
{
976 977
  int len = SBYTES (regexp);
  unsigned char *s = SDATA (regexp);
Karl Heuer's avatar
Karl Heuer committed
978 979 980 981 982 983 984 985 986 987 988 989 990
  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':
991
	    case 'S': case '=': case '{': case '}': case '_':
Karl Heuer's avatar
Karl Heuer committed
992
	    case 'c': case 'C':	/* for categoryspec and notcategoryspec */
993