syntax.c 77.3 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
/* GNU Emacs routines to deal with syntax tables; also word and list parsing.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985, 87, 93, 94, 95, 1997 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
3 4 5 6 7

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
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
20 21


22
#include <config.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
23 24 25 26
#include <ctype.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
27
#include "charset.h"
28 29 30 31

/* Make syntax table lookup grant data in gl_state.  */
#define SYNTAX_ENTRY_VIA_PROPERTY

Richard M. Stallman's avatar
Richard M. Stallman committed
32
#include "syntax.h"
33 34 35 36 37 38 39 40
#include "intervals.h"

/* We use these constants in place for comment-style and
   string-ender-char to distinguish  comments/strings started by
   comment_fence and string_fence codes.  */

#define ST_COMMENT_STYLE (256 + 1)
#define ST_STRING_STYLE (256 + 2)
Karl Heuer's avatar
Karl Heuer committed
41
#include "category.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
42

43
Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
44

45 46 47
static void scan_sexps_forward ();
static int char_quoted ();

Richard M. Stallman's avatar
Richard M. Stallman committed
48
int words_include_escapes;
49
int parse_sexp_lookup_properties;
Richard M. Stallman's avatar
Richard M. Stallman committed
50

51 52 53 54 55
/* Used as a temporary in SYNTAX_ENTRY and other macros in syntax.h,
   if not compiled with GCC.  No need to mark it, since it is used
   only very temporarily.  */
Lisp_Object syntax_temp;

56 57 58 59
/* This is the internal form of the parse state used in parse-partial-sexp.  */

struct lisp_parse_state
  {
60 61 62 63
    int depth;		/* Depth at end of parsing.  */
    int instring;	/* -1 if not within string, else desired terminator.  */
    int incomment;	/* Nonzero if within a comment at end of parsing.  */
    int comstyle;	/* comment style a=0, or b=1, or ST_COMMENT_STYLE.  */
64 65 66
    int quoted;		/* Nonzero if just after an escape char at end of parsing */
    int thislevelstart;	/* Char number of most recent start-of-expression at current level */
    int prevlevelstart; /* Char number of start of containing expression */
67
    int location;	/* Char number at which parsing stopped.  */
68
    int mindepth;	/* Minimum depth seen while scanning.  */
69
    int comstr_start;	/* Position just after last comment/string starter.  */
70 71
  };

72 73 74 75 76 77 78 79 80 81 82 83
/* These variables are a cache for finding the start of a defun.
   find_start_pos is the place for which the defun start was found.
   find_start_value is the defun start position found for it.
   find_start_buffer is the buffer it was found in.
   find_start_begv is the BEGV value when it was found.
   find_start_modiff is the value of MODIFF when it was found.  */

static int find_start_pos;
static int find_start_value;
static struct buffer *find_start_buffer;
static int find_start_begv;
static int find_start_modiff;
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189


struct gl_state_s gl_state;		/* Global state of syntax parser.  */

INTERVAL interval_of ();
#define INTERVALS_AT_ONCE 10		/* 1 + max-number of intervals
					   to scan to property-change.  */

/* 
   Update gl_state to an appropriate interval which contains POS.  The
   sign of COUNT give the relative position of POS wrt the previously
   valid interval.  If INIT, only [be]_property fields of gl_state are
   valid at start, the  rest is filled basing on OBJECT.

   `gl_state.*_i' are the intervals, and pos is further in the search
   direction than the intervals - or in an interval.  We update the
   current syntax-table basing on the property of this interval, and
   update the interval to start further than POS - or be
   NULL_INTERVAL.  We also update lim_property to be the next value of
   pos to call this subroutine again - or be before/after the
   start/end of OBJECT.  */

void
update_syntax_table (pos, count, init, object)
     int pos, count, init;
     Lisp_Object object;
{
  Lisp_Object tmp_table;
  int cnt = 0, doing_extra = 0, invalidate = 1;
  INTERVAL i, oldi;

  if (init)
    {
      gl_state.start = gl_state.b_property;
      gl_state.stop = gl_state.e_property;
      gl_state.forward_i = interval_of (pos, object);
      i = gl_state.backward_i = gl_state.forward_i;
      gl_state.left_ok = gl_state.right_ok = 1;
      invalidate = 0;
      if (NULL_INTERVAL_P (i))
	return;
      gl_state.b_property = i->position - 1;
      gl_state.e_property = INTERVAL_LAST_POS (i);
      goto update;
    }
  oldi = i = count > 0 ? gl_state.forward_i : gl_state.backward_i;

  /* We are guarantied to be called with pos either in i, of further off.  */
  if (NULL_INTERVAL_P (i))
    error ("Error in syntax_table logic for to-the-end intervals");
  else if (pos < i->position)		/* Move left.  */
    {
      if (count > 0)
	error ("Error in syntax_table logic for intervals <-.");
      /* Update the interval.  */
      i = update_interval (i, pos);
      if (oldi->position != INTERVAL_LAST_POS (i))
	{
	  invalidate = 0;
	  gl_state.right_ok = 1;	/* Invalidate the other end.  */
	  gl_state.forward_i = i;
	  gl_state.e_property = INTERVAL_LAST_POS (i);
	}
    } 
  else if (pos >= INTERVAL_LAST_POS (i)) /* Move right.  */
    {
      if (count < 0)
	error ("Error in syntax_table logic for intervals ->.");
      /* Update the interval.  */
      i = update_interval (i, pos);
      if (i->position != INTERVAL_LAST_POS (oldi))
	{
	  invalidate = 0;
	  gl_state.left_ok = 1;		/* Invalidate the other end.  */
	  gl_state.backward_i = i;
	  gl_state.b_property = i->position - 1;
	}
    }
  else if (count > 0 ? gl_state.right_ok : gl_state.left_ok)
    {
      /* We do not need to recalculate tmp_table.  */
      tmp_table = gl_state.old_prop;
    }

  update:
  tmp_table = textget (i->plist, Qsyntax_table);

  if (invalidate)
    invalidate = !EQ (tmp_table, gl_state.old_prop); /* Need to invalidate? */
      
  if (invalidate)			/* Did not get to adjacent interval.  */
    {					/* with the same table => */
					/* invalidate the old range.  */
      if (count > 0)
	{
	  gl_state.backward_i = i;
	  gl_state.left_ok = 1;		/* Invalidate the other end.  */
	  gl_state.b_property = i->position - 1;
	} 
      else 
	{
	  gl_state.forward_i = i;	
	  gl_state.right_ok = 1;	/* Invalidate the other end.  */
	  gl_state.e_property = INTERVAL_LAST_POS (i);
	}
    }
190

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
  gl_state.current_syntax_table = tmp_table;
  gl_state.old_prop = tmp_table;
  if (Fsyntax_table_p (tmp_table) == Qt)
    {
      gl_state.use_global = 0;
    } 
  else if (CONSP (tmp_table))
    {
      gl_state.use_global = 1;
      gl_state.global_code = tmp_table;
    }
  else 
    {
      gl_state.use_global = 0;
      gl_state.current_syntax_table = current_buffer->syntax_table;
    }

  while (!NULL_INTERVAL_P (i))
    {
      if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
	{
	  if (count > 0)
	    gl_state.right_ok = 0;
	  else 
	    gl_state.left_ok = 0;
	  break;	  
	}
      else if (cnt == INTERVALS_AT_ONCE) 
	{
	  if (count > 0)
	    gl_state.right_ok = 1;
	  else 
	    gl_state.left_ok = 1;
	  break;
	}
      cnt++;
      i = count > 0 ? next_interval (i) : previous_interval (i);
    }
  if (NULL_INTERVAL_P (i)) 
    {					/* This property goes to the end.  */
      if (count > 0)
	gl_state.e_property = gl_state.stop;
      else
	gl_state.b_property = gl_state.start;
    } 
  else 
    {
      if (count > 0) 
	{
	  gl_state.e_property = i->position;
	  gl_state.forward_i = i;
	}
      else 
	{
	  gl_state.b_property = i->position + LENGTH (i) - 1;
	  gl_state.backward_i = i;
	}
    }    
}

/* Returns TRUE if char at POS is quoted.
   Global syntax-table data should be set up already to be good at pos
   or after.  On return global syntax data is good for lookup at POS. */

static int
char_quoted (pos)
     register int pos;
{
  register enum syntaxcode code;
  register int beg = BEGV;
  register int quoted = 0;
  int temp_pos = pos;

  DEC_POS (temp_pos);
  while (temp_pos >= beg
	 && ( UPDATE_SYNTAX_TABLE_BACKWARD (temp_pos), 1)
	 && ((code = SYNTAX (FETCH_CHAR (temp_pos))) == Scharquote
	     || code == Sescape))
    {
      temp_pos--, quoted = !quoted;
    }
  UPDATE_SYNTAX_TABLE (pos);
  return quoted;
}

276 277
/* Find a defun-start that is the last one before POS (or nearly the last).
   We record what we find, so that another call in the same area
278 279 280 281 282
   can return the same value right away.  

   There is no promise at which position the global syntax data is
   valid on return from the subroutine, so the caller should explicitly
   update the global data.  */
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

static int
find_defun_start (pos)
     int pos;
{
  int tem;
  int shortage;

  /* Use previous finding, if it's valid and applies to this inquiry.  */
  if (current_buffer == find_start_buffer
      /* Reuse the defun-start even if POS is a little farther on.
	 POS might be in the next defun, but that's ok.
	 Our value may not be the best possible, but will still be usable.  */
      && pos <= find_start_pos + 1000
      && pos >= find_start_value
      && BEGV == find_start_begv
      && MODIFF == find_start_modiff)
    return find_start_value;

  /* Back up to start of line.  */
303
  tem = scan_buffer ('\n', pos, BEGV, -1, &shortage, 1);
304

305 306 307 308 309
  /* We optimize syntax-table lookup for rare updates.  Thus we accept
     only those `^\s(' which are good in global _and_ text-property
     syntax-tables.  */
  gl_state.current_syntax_table = current_buffer->syntax_table;
  gl_state.use_global = 0;
310 311 312 313
  while (tem > BEGV)
    {
      /* Open-paren at start of line means we found our defun-start.  */
      if (SYNTAX (FETCH_CHAR (tem)) == Sopen)
314 315 316 317 318 319 320 321
	{
	  SETUP_SYNTAX_TABLE (tem + 1, -1);	/* Try again... */
	  if (SYNTAX (FETCH_CHAR (tem)) == Sopen)
	    break;
	  /* Now fallback to the default value.  */
	  gl_state.current_syntax_table = current_buffer->syntax_table;
	  gl_state.use_global = 0;
	}
322
      /* Move to beg of previous line.  */
323
      tem = scan_buffer ('\n', tem, BEGV, -2, &shortage, 1);
324 325 326 327 328 329 330 331 332 333 334 335
    }

  /* Record what we found, for the next try.  */
  find_start_value = tem;
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

  return find_start_value;
}

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
/* Checks whether FROM is the end of comment.  Does not try to
   fallback more than to STOP.
   Returns -1 if cannot find comment ending at from, otherwise start
   of comment.  Global syntax data remains valid for
   backward search starting at the returned value (or at FROM, if
   the search was not successful).  */

static int
back_comment (from, stop)
     int from, stop;
{
  /* Look back, counting the parity of string-quotes,
     and recording the comment-starters seen.
     When we reach a safe place, assume that's not in a string;
     then step the main scan to the earliest comment-starter seen
     an even number of string quotes away from the safe place.

     OFROM[I] is position of the earliest comment-starter seen
     which is I+2X quotes from the comment-end.
     PARITY is current parity of quotes from the comment end.  */
  int parity = 0;
  int my_stringend = 0;
  int string_lossage = 0;
  int comment_end = from;
  int comstart_pos = 0;
  int comstart_parity = 0;
  int scanstart = from - 1;
  register enum syntaxcode code;
  int c, comstyle = 0;

  /* At beginning of range to scan, we're outside of strings;
     that determines quote parity to the comment-end.  */
  while (from != stop)
    {
      /* Move back and examine a character.  */
      DEC_POS (from);
      UPDATE_SYNTAX_TABLE_BACKWARD (from);

      c = FETCH_CHAR (from);
      code = SYNTAX (c);

      /* If this char is the second of a 2-char comment sequence,
	 back up and give the pair the appropriate syntax.  */
      if (from > stop && SYNTAX_COMEND_SECOND (c)
	  && SYNTAX_COMEND_FIRST (FETCH_CHAR (from - 1)))
	{
	  code = Sendcomment;
	  DEC_POS (from);
	  /* This is apparently the best we can do: */
	  UPDATE_SYNTAX_TABLE_BACKWARD (from);
	  c = FETCH_CHAR (from);
	}
			
      /* If this char starts a 2-char comment start sequence,
	 treat it like a 1-char comment starter.  */
      if (from < scanstart && SYNTAX_COMSTART_FIRST (c)
	  && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from + 1))
	  && comstyle == SYNTAX_COMMENT_STYLE (FETCH_CHAR (from + 1)))
	code = Scomment;

      /* Ignore escaped characters.  */
      if (char_quoted (from))
	continue;

      /* Track parity of quotes.  */
      if (code == Sstring)
	{
	  parity ^= 1;
	  if (my_stringend == 0)
	    my_stringend = c;
	  /* If we have two kinds of string delimiters.
	     There's no way to grok this scanning backwards.  */
	  else if (my_stringend != c)
	    string_lossage = 1;
	}

      if (code == Sstring_fence || code == Scomment_fence)
	{
	  parity ^= 1;
	  if (my_stringend == 0)
	    my_stringend = 
		code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE;
	  /* If we have two kinds of string delimiters.
	     There's no way to grok this scanning backwards.  */
	  else if (my_stringend != (code == Sstring_fence 
				    ? ST_STRING_STYLE : ST_COMMENT_STYLE))
	    string_lossage = 1;
	}

      /* Record comment-starters according to that
	 quote-parity to the comment-end.  */
      if (code == Scomment)
	{
	  comstart_parity = parity;
	  comstart_pos = from;
	}

      /* If we find another earlier comment-ender,
	 any comment-starts earlier than that don't count
	 (because they go with the earlier comment-ender).  */
      if (code == Sendcomment
	  && SYNTAX_COMMENT_STYLE (FETCH_CHAR (from)) == comstyle)
	break;

      /* Assume a defun-start point is outside of strings.  */
      if (code == Sopen
	  && (from == stop || FETCH_CHAR (from - 1) == '\n'))
	break;
    }

  if (comstart_pos == 0)
    {
      from = comment_end;
      UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
    }
  /* If the earliest comment starter
     is followed by uniform paired string quotes or none,
     we know it can't be inside a string
     since if it were then the comment ender would be inside one.
     So it does start a comment.  Skip back to it.  */
  else if (comstart_parity == 0 && !string_lossage) 
    {
      from = comstart_pos;
      /* Globals are correct now.  */
    }
  else
    {
      /* We had two kinds of string delimiters mixed up
	 together.  Decode this going forwards.
	 Scan fwd from the previous comment ender
	 to the one in question; this records where we
	 last passed a comment starter.  */
      struct lisp_parse_state state;
      scan_sexps_forward (&state, find_defun_start (comment_end),
			  comment_end - 1, -10000, 0, Qnil, 0);
      if (state.incomment)
	{
	  /* scan_sexps_forward changed the direction of search in
	     global variables, so we need to update it completely.  */
	  
	  from = state.comstr_start;
	}
      else
	{
	  from = comment_end;	  
	}
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
    }
    
  return from;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
488
DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
489
  "Return t if OBJECT is a syntax table.\n\
490
Currently, any char-table counts as a syntax table.")
491 492
  (object)
     Lisp_Object object;
Richard M. Stallman's avatar
Richard M. Stallman committed
493
{
494 495
  if (CHAR_TABLE_P (object)
      && XCHAR_TABLE (object)->purpose == Qsyntax_table)
Richard M. Stallman's avatar
Richard M. Stallman committed
496 497 498 499
    return Qt;
  return Qnil;
}

500
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
501 502 503
check_syntax_table (obj)
     Lisp_Object obj;
{
504 505 506
  if (!(CHAR_TABLE_P (obj)
	&& XCHAR_TABLE (obj)->purpose == Qsyntax_table))
    wrong_type_argument (Qsyntax_table_p, obj);
Richard M. Stallman's avatar
Richard M. Stallman committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
}   

DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
  "Return the current syntax table.\n\
This is the one specified by the current buffer.")
  ()
{
  return current_buffer->syntax_table;
}

DEFUN ("standard-syntax-table", Fstandard_syntax_table,
   Sstandard_syntax_table, 0, 0, 0,
  "Return the standard syntax table.\n\
This is the one used for new buffers.")
  ()
{
  return Vstandard_syntax_table;
}

DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
  "Construct a new syntax table and return it.\n\
It is a copy of the TABLE, which defaults to the standard syntax table.")
  (table)
     Lisp_Object table;
{
532 533
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
534
  if (!NILP (table))
535 536 537 538 539
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
540 541 542 543 544 545 546 547 548 549

  /* Only the standard syntax table should have a default element.
     Other syntax tables should inherit from parents instead.  */
  XCHAR_TABLE (copy)->defalt = Qnil;

  /* Copied syntax tables should all have parents.
     If we copied one with no parent, such as the standard syntax table,
     use the standard syntax table as the copy's parent.  */
  if (NILP (XCHAR_TABLE (copy)->parent))
    Fset_char_table_parent (copy, Vstandard_syntax_table);
550
  return copy;
Richard M. Stallman's avatar
Richard M. Stallman committed
551 552 553 554 555 556 557 558
}

DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
  "Select a new syntax table for the current buffer.\n\
One argument, a syntax table.")
  (table)
     Lisp_Object table;
{
559
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
560 561
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
562 563
  current_buffer->local_var_flags
    |= XFASTINT (buffer_local_flags.syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
564 565 566 567 568
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
569
 This is used by modify-syntax-entry, and other things.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
570 571 572 573 574 575

unsigned char syntax_spec_code[0400] =
  { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
576
    (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
Richard M. Stallman's avatar
Richard M. Stallman committed
577 578 579 580 581 582
        (char) Smath, 0377, 0377, (char) Squote,
    (char) Sopen, (char) Sclose, 0377, 0377,
	0377, (char) Swhitespace, (char) Spunct, (char) Scharquote,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
    0377, 0377, 0377, 0377,
	(char) Scomment, 0377, (char) Sendcomment, 0377,
583
    (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377,   /* @, A ... */
Richard M. Stallman's avatar
Richard M. Stallman committed
584 585 586 587 588 589
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
    0377, 0377, 0377, 0377, (char) Sescape, 0377, 0377, (char) Ssymbol,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,   /* `, a, ... */
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
590
    0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592
  };

593
/* Indexed by syntax code, give the letter that describes it.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
594

595
char syntax_code_spec[16] =
Richard M. Stallman's avatar
Richard M. Stallman committed
596
  {
597 598
    ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
    '!', '|'
Richard M. Stallman's avatar
Richard M. Stallman committed
599
  };
Karl Heuer's avatar
Karl Heuer committed
600 601 602 603 604 605 606 607

/* Indexed by syntax code, give the object (cons of syntax code and
   nil) to be stored in syntax table.  Since these objects can be
   shared among syntax tables, we generate them in advance.  By
   sharing objects, the function `describe-syntax' can give a more
   compact listing.  */
static Lisp_Object Vsyntax_code_object;

Richard M. Stallman's avatar
Richard M. Stallman committed
608

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
/* Look up the value for CHARACTER in syntax table TABLE's parent
   and its parents.  SYNTAX_ENTRY calls this, when TABLE itself has nil
   for CHARACTER.  It's actually used only when not compiled with GCC.  */

Lisp_Object
syntax_parent_lookup (table, character)
     Lisp_Object table;
     int character;
{
  Lisp_Object value;

  while (1)
    {
      table = XCHAR_TABLE (table)->parent;
      if (NILP (table))
	return Qnil;

      value = XCHAR_TABLE (table)->contents[character];
      if (!NILP (value))
	return value;
    }
}

Richard M. Stallman's avatar
Richard M. Stallman committed
632
DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
633 634 635
  "Return the syntax code of CHARACTER, described by a character.\n\
For example, if CHARACTER is a word constituent,\n\
the character `w' is returned.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
636 637
The characters that correspond to various syntax codes\n\
are listed in the documentation of `modify-syntax-entry'.")
638 639
  (character)
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
640
{
641
  int char_int;
642 643 644
  gl_state.current_syntax_table = current_buffer->syntax_table;

  gl_state.use_global = 0;
645 646
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
647
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
648 649 650
}

DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
651 652 653
  "Return the matching parenthesis of CHARACTER, or nil if none.")
  (character)
     Lisp_Object character;
654
{
655
  int char_int, code;
656 657
  gl_state.current_syntax_table = current_buffer->syntax_table;
  gl_state.use_global = 0;
658 659
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
660
  code = SYNTAX (char_int);
661
  if (code == Sopen || code == Sclose)
662
    return make_number (SYNTAX_MATCH (char_int));
663
  return Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
664 665 666 667 668 669
}

/* This comment supplies the doc string for modify-syntax-entry,
   for make-docfile to see.  We cannot put this in the real DEFUN
   due to limits in the Unix cpp.

670
DEFUN ("modify-syntax-entry", foo, bar, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
671 672 673 674
  "Set syntax for character CHAR according to string S.\n\
The syntax is changed only for table TABLE, which defaults to\n\
 the current buffer's syntax table.\n\
The first character of S should be one of the following:\n\
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679
  Space or -  whitespace syntax.    w   word constituent.\n\
  _           symbol constituent.   .   punctuation.\n\
  (           open-parenthesis.     )   close-parenthesis.\n\
  \"           string quote.         \\   escape.\n\
  $           paired delimiter.     '   expression quote or prefix operator.\n\
680
  <           comment starter.      >   comment ender.\n\
681
  /           character-quote.      @   inherit from `standard-syntax-table'.\n\
682
\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
683 684 685 686 687
Only single-character comment start and end sequences are represented thus.\n\
Two-character sequences are represented as described below.\n\
The second character of S is the matching parenthesis,\n\
 used only if the first character is `(' or `)'.\n\
Any additional characters are flags.\n\
688
Defined flags are the characters 1, 2, 3, 4, b, and p.\n\
689 690 691 692
 1 means CHAR is the start of a two-char comment start sequence.\n\
 2 means CHAR is the second character of such a sequence.\n\
 3 means CHAR is the start of a two-char comment end sequence.\n\
 4 means CHAR is the second character of such a sequence.\n\
693
\n\
694
There can be up to two orthogonal comment sequences.  This is to support\n\
695
language modes such as C++.  By default, all comment sequences are of style\n\
696 697
a, but you can set the comment sequence style to b (on the second character\n\
of a comment-start, or the first character of a comment-end sequence) using\n\
698
this flag:\n\
699
 b means CHAR is part of comment sequence b.\n\
700
\n\
701
 p means CHAR is a prefix character for `backward-prefix-chars';\n\
702
   such characters are treated as whitespace when they occur\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
703
   between expressions.")
704
  (char, s, table)
Richard M. Stallman's avatar
Richard M. Stallman committed
705 706 707 708 709 710 711 712 713 714 715
*/

DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3, 
  /* I really don't know why this is interactive
     help-form should at least be made useful whilst reading the second arg
   */
  "cSet syntax for character: \nsSet syntax for %s to: ",
  0 /* See immediately above */)
  (c, newentry, syntax_table)
     Lisp_Object c, newentry, syntax_table;
{
716
  register unsigned char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
717
  register enum syntaxcode code;
718
  int val;
719
  Lisp_Object match;
Richard M. Stallman's avatar
Richard M. Stallman committed
720 721 722

  CHECK_NUMBER (c, 0);
  CHECK_STRING (newentry, 1);
723

Jim Blandy's avatar
Jim Blandy committed
724
  if (NILP (syntax_table))
Richard M. Stallman's avatar
Richard M. Stallman committed
725 726
    syntax_table = current_buffer->syntax_table;
  else
727
    check_syntax_table (syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
728 729 730 731 732 733

  p = XSTRING (newentry)->data;
  code = (enum syntaxcode) syntax_spec_code[*p++];
  if (((int) code & 0377) == 0377)
    error ("invalid syntax description letter: %c", c);

734 735 736 737 738 739 740
  if (code == Sinherit)
    {
      SET_RAW_SYNTAX_ENTRY (syntax_table, c, Qnil);
      return Qnil;
    }

  if (*p)
741
    {
Karl Heuer's avatar
Karl Heuer committed
742 743 744 745
      int len;
      int character = STRING_CHAR_AND_LENGTH (p, XSTRING (newentry)->size - 1,
					      len);
      XSETINT (match, character);
746 747
      if (XFASTINT (match) == ' ')
	match = Qnil;
Karl Heuer's avatar
Karl Heuer committed
748
      p += len;
749 750
    }
  else
751
    match = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
752

753
  val = (int) code;
Richard M. Stallman's avatar
Richard M. Stallman committed
754 755 756 757
  while (*p)
    switch (*p++)
      {
      case '1':
758
	val |= 1 << 16;
Richard M. Stallman's avatar
Richard M. Stallman committed
759 760 761
	break;

      case '2':
762
	val |= 1 << 17;
Richard M. Stallman's avatar
Richard M. Stallman committed
763 764 765
	break;

      case '3':
766
	val |= 1 << 18;
Richard M. Stallman's avatar
Richard M. Stallman committed
767 768 769
	break;

      case '4':
770
	val |= 1 << 19;
Richard M. Stallman's avatar
Richard M. Stallman committed
771 772 773
	break;

      case 'p':
774
	val |= 1 << 20;
Richard M. Stallman's avatar
Richard M. Stallman committed
775
	break;
776 777

      case 'b':
778
	val |= 1 << 21;
779
	break;
Richard M. Stallman's avatar
Richard M. Stallman committed
780 781
      }
	
Karl Heuer's avatar
Karl Heuer committed
782 783 784 785 786 787 788
  if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
    newentry = XVECTOR (Vsyntax_code_object)->contents[val];
  else
    /* Since we can't use a shared object, let's make a new one.  */
    newentry = Fcons (make_number (val), match);
    
  SET_RAW_SYNTAX_ENTRY (syntax_table, c, newentry);
Richard M. Stallman's avatar
Richard M. Stallman committed
789 790 791 792 793 794

  return Qnil;
}

/* Dump syntax table to buffer in human-readable format */

795
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
796 797 798 799
describe_syntax (value)
    Lisp_Object value;
{
  register enum syntaxcode code;
800
  char desc, match, start1, start2, end1, end2, prefix, comstyle;
Richard M. Stallman's avatar
Richard M. Stallman committed
801
  char str[2];
802
  Lisp_Object first, match_lisp;
Richard M. Stallman's avatar
Richard M. Stallman committed
803 804 805

  Findent_to (make_number (16), make_number (1));

806 807
  if (NILP (value))
    {
Karl Heuer's avatar
Karl Heuer committed
808
      insert_string ("default\n");
809 810 811
      return;
    }

812 813 814 815 816 817
  if (CHAR_TABLE_P (value))
    {
      insert_string ("deeper char-table ...\n");
      return;
    }

818 819
  if (!CONSP (value))
    {
Karl Heuer's avatar
Karl Heuer committed
820
      insert_string ("invalid\n");
821 822 823 824 825 826 827
      return;
    }

  first = XCONS (value)->car;
  match_lisp = XCONS (value)->cdr;

  if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
828
    {
Karl Heuer's avatar
Karl Heuer committed
829
      insert_string ("invalid\n");
Richard M. Stallman's avatar
Richard M. Stallman committed
830 831 832
      return;
    }

833 834 835 836 837 838 839
  code = (enum syntaxcode) (first & 0377);
  start1 = (XINT (first) >> 16) & 1;
  start2 = (XINT (first) >> 17) & 1;
  end1 = (XINT (first) >> 18) & 1;
  end2 = (XINT (first) >> 19) & 1;
  prefix = (XINT (first) >> 20) & 1;
  comstyle = (XINT (first) >> 21) & 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
840 841 842 843 844 845 846 847 848 849 850

  if ((int) code < 0 || (int) code >= (int) Smax)
    {
      insert_string ("invalid");
      return;
    }
  desc = syntax_code_spec[(int) code];

  str[0] = desc, str[1] = 0;
  insert (str, 1);

Karl Heuer's avatar
Karl Heuer committed
851 852 853 854
  if (NILP (match_lisp))
    insert (" ", 1);
  else
    insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
855 856 857 858 859 860 861 862 863 864 865 866 867

  if (start1)
    insert ("1", 1);
  if (start2)
    insert ("2", 1);

  if (end1)
    insert ("3", 1);
  if (end2)
    insert ("4", 1);

  if (prefix)
    insert ("p", 1);
868 869
  if (comstyle)
    insert ("b", 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
870 871 872

  insert_string ("\twhich means: ");

873
  switch (SWITCH_ENUM_CAST (code))
Richard M. Stallman's avatar
Richard M. Stallman committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
    {
    case Swhitespace:
      insert_string ("whitespace"); break;
    case Spunct:
      insert_string ("punctuation"); break;
    case Sword:
      insert_string ("word"); break;
    case Ssymbol:
      insert_string ("symbol"); break;
    case Sopen:
      insert_string ("open"); break;
    case Sclose:
      insert_string ("close"); break;
    case Squote:
      insert_string ("quote"); break;
    case Sstring:
      insert_string ("string"); break;
    case Smath:
      insert_string ("math"); break;
    case Sescape:
      insert_string ("escape"); break;
    case Scharquote:
      insert_string ("charquote"); break;
    case Scomment:
      insert_string ("comment"); break;
    case Sendcomment:
      insert_string ("endcomment"); break;
    default:
      insert_string ("invalid");
      return;
    }

906
  if (!NILP (match_lisp))
Richard M. Stallman's avatar
Richard M. Stallman committed
907 908
    {
      insert_string (", matches ");
909
      insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
910 911 912 913 914 915 916 917 918 919 920
    }

  if (start1)
    insert_string (",\n\t  is the first character of a comment-start sequence");
  if (start2)
    insert_string (",\n\t  is the second character of a comment-start sequence");

  if (end1)
    insert_string (",\n\t  is the first character of a comment-end sequence");
  if (end2)
    insert_string (",\n\t  is the second character of a comment-end sequence");
921 922 923
  if (comstyle)
    insert_string (" (comment style b)");

Richard M. Stallman's avatar
Richard M. Stallman committed
924 925 926 927 928 929
  if (prefix)
    insert_string (",\n\t  is a prefix character for `backward-prefix-chars'");

  insert_string ("\n");
}

930
static Lisp_Object
Richard M. Stallman's avatar
Richard M. Stallman committed
931 932 933 934 935
describe_syntax_1 (vector)
     Lisp_Object vector;
{
  struct buffer *old = current_buffer;
  set_buffer_internal (XBUFFER (Vstandard_output));
936
  describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil);
Karl Heuer's avatar
Karl Heuer committed
937 938 939 940 941 942 943
  while (! NILP (XCHAR_TABLE (vector)->parent))
    {
      vector = XCHAR_TABLE (vector)->parent;
      insert_string ("\nThe parent syntax table is:");
      describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil);
    }
	
944
  call0 (intern ("help-mode"));
Richard M. Stallman's avatar
Richard M. Stallman committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
  set_buffer_internal (old);
  return Qnil;
}

DEFUN ("describe-syntax", Fdescribe_syntax, Sdescribe_syntax, 0, 0, "",
  "Describe the syntax specifications in the syntax table.\n\
The descriptions are inserted in a buffer, which is then displayed.")
  ()
{
  internal_with_output_to_temp_buffer
     ("*Help*", describe_syntax_1, current_buffer->syntax_table);

  return Qnil;
}

960 961
int parse_sexp_ignore_comments;

Richard M. Stallman's avatar
Richard M. Stallman committed
962 963 964 965 966 967 968 969 970
/* Return the position across COUNT words from FROM.
   If that many words cannot be found before the end of the buffer, return 0.
   COUNT negative means scan backward and stop at word beginning.  */

scan_words (from, count)
     register int from, count;
{
  register int beg = BEGV;
  register int end = ZV;
Karl Heuer's avatar
Karl Heuer committed
971 972 973
  register enum syntaxcode code;
  int ch0, ch1;
  int temp_pos;
Richard M. Stallman's avatar
Richard M. Stallman committed
974 975 976 977

  immediate_quit = 1;
  QUIT;

978 979
  SETUP_SYNTAX_TABLE (from, count);

Richard M. Stallman's avatar
Richard M. Stallman committed
980 981 982 983 984 985 986 987 988
  while (count > 0)
    {
      while (1)
	{
	  if (from == end)
	    {
	      immediate_quit = 0;
	      return 0;
	    }
989
	  UPDATE_SYNTAX_TABLE_FORWARD (from);
Karl Heuer's avatar
Karl Heuer committed
990 991 992
	  ch0 = FETCH_CHAR (from);
	  code = SYNTAX (ch0);
	  INC_POS (from);
Richard M. Stallman's avatar
Richard M. Stallman committed
993 994 995 996 997 998
	  if (words_include_escapes
	      && (code == Sescape || code == Scharquote))
	    break;
	  if (code == Sword)
	    break;
	}
Karl Heuer's avatar
Karl Heuer committed
999 1000
      /* Now CH0 is a character which begins a word and FROM is the
         position of the next character.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
1001 1002 1003
      while (1)
	{
	  if (from == end) break;
1004
	  UPDATE_SYNTAX_TABLE_FORWARD (from);
Karl Heuer's avatar
Karl Heuer committed
1005 1006
	  ch1 = FETCH_CHAR (from);
	  code = SYNTAX (ch1);
Richard M. Stallman's avatar
Richard M. Stallman committed
1007 1008
	  if (!(words_include_escapes
		&& (code == Sescape || code == Scharquote)))
Karl Heuer's avatar
Karl Heuer committed
1009
	    if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
Richard M. Stallman's avatar
Richard M. Stallman committed
1010
	      break;
Karl Heuer's avatar
Karl Heuer committed
1011 1012
	  INC_POS (from);
	  ch0 = ch1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
	}
      count--;
    }
  while (count < 0)
    {
      while (1)
	{
	  if (from == beg)
	    {
	      immediate_quit = 0;
	      return 0;
	    }
Karl Heuer's avatar
Karl Heuer committed
1025
	  DEC_POS (from);
1026
	  UPDATE_SYNTAX_TABLE_BACKWARD (from);
Karl Heuer's avatar
Karl Heuer committed
1027 1028
	  ch1 = FETCH_CHAR (from);
	  code = SYNTAX (ch1);
Richard M. Stallman's avatar
Richard M. Stallman committed
1029 1030 1031 1032 1033 1034
	  if (words_include_escapes
	      && (code == Sescape || code == Scharquote))
	    break;
	  if (code == Sword)
	    break;
	}
Karl Heuer's avatar
Karl Heuer committed
1035 1036
      /* Now CH1 is a character which ends a word and FROM is the
         position of it.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
1037 1038 1039
      while (1)
	{
	  if (from == beg) break;
Karl Heuer's avatar
Karl Heuer committed
1040 1041
	  temp_pos = from;
	  DEC_POS (temp_pos);
1042
	  UPDATE_SYNTAX_TABLE_BACKWARD (from);
Karl Heuer's avatar
Karl Heuer committed
1043 1044
	  ch0 = FETCH_CHAR (temp_pos);
	  code = SYNTAX (ch0);
Richard M. Stallman's avatar
Richard M. Stallman committed
1045 1046
	  if (!(words_include_escapes
		&& (code == Sescape || code == Scharquote)))
Karl Heuer's avatar
Karl Heuer committed
1047
	    if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
Richard M. Stallman's avatar
Richard M. Stallman committed
1048
	      break;
Karl Heuer's avatar
Karl Heuer committed
1049 1050
	  from = temp_pos;
	  ch1 = ch0;
Richard M. Stallman's avatar
Richard M. Stallman committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
	}
      count++;
    }

  immediate_quit = 0;

  return from;
}

DEFUN ("forward-word", Fforward_word, Sforward_word, 1, 1, "p",
  "Move point forward ARG words (backward if ARG is negative).\n\
Normally returns t.\n\
If an edge of the buffer is reached, point is left there\n\
and nil is returned.")
  (count)
     Lisp_Object count;
{
  int val;
  CHECK_NUMBER (count, 0);

1071
  if (!(val = scan_words (PT, XINT (count))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1072 1073 1074 1075 1076 1077 1078 1079
    {
      SET_PT (XINT (count) > 0 ? ZV : BEGV);
      return Qnil;
    }
  SET_PT (val);
  return Qt;
}

1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
Lisp_Object skip_chars ();

DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
  "Move point forward, stopping before a char not in STRING, or at pos LIM.\n\
STRING is like the inside of a `[...]' in a regular expression\n\
except that `]' is never special and `\\' quotes `^', `-' or `\\'.\n\
Thus, with arg \"a-zA-Z\", this skips letters stopping before first nonletter.\n\
With arg \"^a-zA-Z\", skips nonletters stopping before first letter.\n\
Returns the distance traveled, either zero or positive.")
  (string, lim)
     Lisp_Object string, lim;
{
  return skip_chars (1, 0, string, lim);
}

DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
  "Move point backward, stopping after a char not in STRING, or at pos LIM.\n\
See `skip-chars-forward' for details.\n\
Returns the distance traveled, either zero or negative.")
  (string, lim)
     Lisp_Object string, lim;
{
  return skip_chars (0, 0, string, lim);
}

DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
  "Move point forward across chars in specified syntax classes.\n\
SYNTAX is a string of syntax code characters.\n\
Stop before a char whose syntax is not in SYNTAX, or at position LIM.\n\
If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.\n\
This function returns the distance traveled, either zero or positive.")
  (syntax, lim)
     Lisp_Object syntax, lim;
{
  return skip_chars (1, 1, syntax, lim);
}

DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
  "Move point backward across chars in specified syntax classes.\n\
SYNTAX is a string of syntax code characters.\n\
Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.\n\
If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.\n\
This function returns the distance traveled, either zero or negative.")
  (syntax, lim)
     Lisp_Object syntax, lim;
{
  return skip_chars (0, 1, syntax, lim);
}

Lisp_Object
skip_chars (forwardp, syntaxp, string, lim)
     int forwardp, syntaxp;
     Lisp_Object string, lim;
{
  register unsigned char *p, *pend;
  register unsigned int c;
1136
  register int ch;
1137
  unsigned char fastmap[0400];
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
  /* If SYNTAXP is 0, STRING may contain multi-byte form of characters
     of which codes don't fit in FASTMAP.  In that case, we set the
     first byte of multibyte form (i.e. base leading-code) in FASTMAP
     and set the actual ranges of characters in CHAR_RANGES.  In the
     form "X-Y" of STRING, both X and Y must belong to the same
     character set because a range striding across character sets is
     meaningless.  */
  int *char_ranges
    = (int *) alloca (XSTRING (string)->size * (sizeof (int)) * 2);
  int n_char_ranges = 0;
1148 1149
  int negate = 0;
  register int i;
1150
  int multibyte = !NILP (current_buffer->enable_multibyte_characters);
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182

  CHECK_STRING (string, 0);

  if (NILP (lim))
    XSETINT (lim, forwardp ? ZV : BEGV);
  else
    CHECK_NUMBER_COERCE_MARKER (lim, 1);

  /* In any case, don't allow scan outside bounds of buffer.  */
  /* jla turned this off, for no known reason.
     bfox turned the ZV part on, and rms turned the
     BEGV part back on.  */
  if (XINT (lim) > ZV)
    XSETFASTINT (lim, ZV);
  if (XINT (lim) < BEGV)
    XSETFASTINT (lim, BEGV);

  p = XSTRING (string)->data;
  pend = p + XSTRING (string)->size;
  bzero (fastmap, sizeof fastmap);

  if (p != pend && *p == '^')
    {
      negate = 1; p++;
    }

  /* Find the characters specified and set their elements of fastmap.
     If syntaxp, each character counts as itself.
     Otherwise, handle backslashes and ranges specially.  */

  while (p != pend)
    {
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
      c = *p;
      if (multibyte)
	{
	  ch = STRING_CHAR (p, pend - p);
	  p += BYTES_BY_CHAR_HEAD (*p);
	}
      else
	{
	  ch = c;
	  p++;
	}
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
      if (syntaxp)
	fastmap[syntax_spec_code[c]] = 1;
      else
	{
	  if (c == '\\')
	    {
	      if (p == pend) break;
	      c = *p++;
	    }
	  if (p != pend && *p == '-')
	    {
1205 1206
	      unsigned int ch2;

1207 1208
	      p++;
	      if (p == pend) break;
1209 1210 1211 1212 1213 1214 1215
	      if (SINGLE_BYTE_CHAR_P (ch))
		while (c <= *p)
		  {
		    fastmap[c] = 1;
		    c++;
		  }
	      else
1216
		{
1217 1218 1219 1220 1221
		  fastmap[c] = 1; /* C is the base leading-code.  */
		  ch2 = STRING_CHAR (p, pend - p);
		  if (ch <= ch2)
		    char_ranges[n_char_ranges++] = ch,
		    char_ranges[n_char_ranges++] = ch2;
1222
		}
1223
	      p += multibyte ? BYTES_BY_CHAR_HEAD (*p) : 1;
1224 1225
	    }
	  else
1226 1227 1228 1229 1230 1231 1232 1233
	    {
	      fastmap[c] = 1;
	      if (!SINGLE_BYTE_CHAR_P (ch))
		{
		  char_ranges[n_char_ranges++] = ch;
		  char_ranges[n_char_ranges++] = ch;
		}
	    }
1234 1235 1236
	}
    }

1237 1238 1239 1240
  /* If ^ was the first character, complement the fastmap.  In
     addition, as all multibyte characters have possibility of
     matching, set all entries for base leading codes, which is
     harmless even if SYNTAXP is 1.  */
1241 1242 1243

  if (negate)
    for (i = 0; i < sizeof fastmap; i++)
1244 1245 1246 1247 1248 1249
      {
	if (!multibyte || !BASE_LEADING_CODE_P (i))
	  fastmap[i] ^= 1;
	else
	  fastmap[i] = 1;
      }
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260

  {
    int start_point = PT;
    int pos = PT;

    immediate_quit = 1;
    if (syntaxp)
      {
        SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
	if (forwardp)
	  {
1261
	    if (multibyte)
1262
	      {
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
		while (pos < XINT (lim)
		       && fastmap[(int) SYNTAX (FETCH_CHAR (pos))])
		  {
		    INC_POS (pos);
		    UPDATE_SYNTAX_TABLE_FORWARD (pos);
		  }
	      }
	    else
	      {
		while (pos < XINT (lim)
		       && fastmap[(int) SYNTAX (FETCH_BYTE (pos))])
		  {
		    pos++;
		    UPDATE_SYNTAX_TABLE_FORWARD (pos);
		  }
1278 1279 1280 1281
	      }
	  }
	else
	  {
1282
	    if (multibyte)
1283
	      {
1284 1285 1286 1287
		while (pos > XINT (lim))
		  {
		    int savepos = pos;
		    DEC_POS (pos);
1288
		    UPDATE_SYNTAX_TABLE_BACKWARD (pos);
1289 1290 1291 1292 1293 1294 1295 1296 1297
		    if (!fastmap[(int) SYNTAX (FETCH_CHAR (pos))])
		      {
			pos = savepos;
			break;
		      }
		  }
	      }
	    else
	      {
1298
		while (pos > XINT (lim))
1299 1300
		  {
		    pos--;
1301 1302 1303 1304 1305 1306
		    UPDATE_SYNTAX_TABLE_BACKWARD (pos);
		    if (!fastmap[(int) SYNTAX (FETCH_BYTE (pos))])
		      {
			pos++;
			break;
		      }
1307
		  }
1308 1309 1310 1311 1312 1313 1314
	      }
	  }
      }
    else
      {
	if (forwardp)
	  {
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
	    if (multibyte)
	      while (pos < XINT (lim) && fastmap[(c = FETCH_BYTE (pos))])
		{
		  if (!BASE_LEADING_CODE_P (c))
		    pos++;
		  else if (n_char_ranges)
		    {
		      /* We much check CHAR_RANGES for a multibyte
			 character.  */
		      ch = FETCH_MULTIBYTE_CHAR (pos);
		      for (i = 0; i < n_char_ranges; i += 2)
			if ((ch >= char_ranges[i] && ch <= char_ranges[i + 1]))
			  break;
		      if (!(negate ^ (i < n_char_ranges)))
			break;

		      INC_POS (pos);
		    }
		  else
		    {
		      if (!negate) break;
		      INC_POS (pos);
		    }
		}
	    else
	      while (pos < XINT (lim) && fastmap[FETCH_BYTE (pos)])
		pos++;
1342 1343 1344
	  }
	else
	  {
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
	    if (multibyte)
	      while (pos > XINT (lim))
		{
		  int savepos = pos;
		  DEC_POS (pos);
		  if (fastmap[(c = FETCH_BYTE (pos))])
		    {
		      if (!BASE_LEADING_CODE_P (c))
			;
		      else if (n_char_ranges)
			{
			  /* We much check CHAR_RANGES for a multibyte
			     character.  */
			  ch = FETCH_MULTIBYTE_CHAR (pos);
			  for (i = 0; i < n_char_ranges; i += 2)
			    if (ch >= char_ranges[i] && ch <= char_ranges[i + 1])
			      break;
			  if (!(negate ^ (i < n_char_ranges)))
			    {
			      pos = savepos;
			      break;
			    }
			}
		      else
			if (!negate)
			  {
			    pos = savepos;
			    break;
			  }
		    }
		  else
		    {
		      pos = savepos;
		      break;
		    }
		}
	    else
	      while (pos > XINT (lim) && fastmap[FETCH_BYTE (pos - 1)])
		pos--;
1384 1385
	  }
      }
1386 1387 1388 1389 1390 1391

    if (multibyte
	/* INC_POS or DEC_POS might have moved POS over LIM.  */
	&& (forwardp ? (pos > XINT (lim)) : (pos < XINT (lim))))
      pos = XINT (lim);

1392 1393 1394 1395 1396 1397 1398
    SET_PT (pos);
    immediate_quit = 0;

    return make_number (PT - start_point);
  }
}

1399 1400 1401
DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
  "Move forward across up to N comments.  If N is negative, move backward.\n\
Stop scanning if we find something other than a comment or whitespace.\n\
1402
Set point to where scanning stops.\n\
1403 1404 1405
If N comments are found as expected, with nothing except whitespace\n\
between them, return t; otherwise return nil.")
  (count)
1406
     Lisp_Object count;
1407 1408 1409
{
  register int from;
  register int stop;
1410
  register int c, c1;
1411 1412
  register enum syntaxcode code;
  int comstyle = 0;	    /* style of comment encountered */
1413
  int found;
1414
  int count1;
Karl Heuer's avatar
Karl Heuer committed
1415
  int temp_pos;
1416 1417 1418

  CHECK_NUMBER (count, 0);
  count1 = XINT (count);
1419
  stop = count1 > 0 ? ZV : BEGV;
1420 1421 1422 1423 1424 1425

  immediate_quit = 1;
  QUIT;

  from = PT;

1426
  SETUP_SYNTAX_TABLE (from, count1);
1427
  while (count1 > 0)
1428
    {
1429
      do
1430
	{
1431 1432 1433
	  if (from == stop)
	    {
	      SET_PT (from);
1434
	      immediate_quit = 0;
1435 1436
	      return Qnil;
	    }
1437
	  UPDATE_SYNTAX_TABLE_FORWARD (from);
1438 1439