syntax.c 91.7 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.
2
   Copyright (C) 1985, 87, 93, 94, 95, 97, 1998, 1999, 2004 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"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "keymap.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
29
#include "regex.h"
30 31 32 33

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

Richard M. Stallman's avatar
Richard M. Stallman committed
34
#include "syntax.h"
35 36 37 38 39 40 41 42
#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
43
#include "category.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
44

45
Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47

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

50 51 52
/* Nonzero means `scan-sexps' treat all multibyte characters as symbol.  */
int multibyte_syntax_as_symbol;

53 54 55 56 57
/* 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;

58 59 60 61 62 63
/* Non-zero means an open parenthesis in column 0 is always considered
   to be the start of a defun.  Zero means an open parenthesis in
   column 0 has no special meaning.  */

int open_paren_in_column_0_is_defun_start;

64 65 66 67
/* This is the internal form of the parse state used in parse-partial-sexp.  */

struct lisp_parse_state
  {
68 69
    int depth;		/* Depth at end of parsing.  */
    int instring;	/* -1 if not within string, else desired terminator.  */
70
    int incomment;	/* -1 if in unnestable comment else comment nesting */
71
    int comstyle;	/* comment style a=0, or b=1, or ST_COMMENT_STYLE.  */
72 73 74
    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 */
75
    int location;	/* Char number at which parsing stopped.  */
76
    int mindepth;	/* Minimum depth seen while scanning.  */
77
    int comstr_start;	/* Position just after last comment/string starter.  */
78 79
    Lisp_Object levelstarts;	/* Char numbers of starts-of-expression
				   of levels (starting from outermost).  */
80 81
  };

82 83 84
/* 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.
85
   find_start_value_byte is the corresponding byte position.
86 87 88 89 90 91
   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;
92
static int find_start_value_byte;
93 94 95
static struct buffer *find_start_buffer;
static int find_start_begv;
static int find_start_modiff;
96 97 98


static int find_defun_start P_ ((int, int));
99
static int back_comment P_ ((int, int, int, int, int, int *, int *));
100
static int char_quoted P_ ((int, int));
Richard M. Stallman's avatar
Richard M. Stallman committed
101
static Lisp_Object skip_chars P_ ((int, int, Lisp_Object, Lisp_Object, int));
102 103 104 105
static Lisp_Object scan_lists P_ ((int, int, int, int));
static void scan_sexps_forward P_ ((struct lisp_parse_state *,
				    int, int, int, int,
				    int, Lisp_Object, int));
Richard M. Stallman's avatar
Richard M. Stallman committed
106
static int in_classes P_ ((int, Lisp_Object));
107 108 109 110 111 112 113 114


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

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

120
   `gl_state.*_i' are the intervals, and CHARPOS is further in the search
121 122
   direction than the intervals - or in an interval.  We update the
   current syntax-table basing on the property of this interval, and
123
   update the interval to start further than CHARPOS - or be
124
   NULL_INTERVAL.  We also update lim_property to be the next value of
125
   charpos to call this subroutine again - or be before/after the
126 127 128
   start/end of OBJECT.  */

void
129 130
update_syntax_table (charpos, count, init, object)
     int charpos, count, init;
131 132 133
     Lisp_Object object;
{
  Lisp_Object tmp_table;
134
  int cnt = 0, invalidate = 1;
135 136 137 138
  INTERVAL i, oldi;

  if (init)
    {
139
      gl_state.old_prop = Qnil;
140 141
      gl_state.start = gl_state.b_property;
      gl_state.stop = gl_state.e_property;
142 143
      i = interval_of (charpos, object);
      gl_state.backward_i = gl_state.forward_i = i;
144 145 146
      invalidate = 0;
      if (NULL_INTERVAL_P (i))
	return;
147
      /* interval_of updates only ->position of the return value, so
148
	 update the parents manually to speed up update_interval.  */
149
      while (!NULL_PARENT (i))
150 151
	{
	  if (AM_RIGHT_CHILD (i))
152
	    INTERVAL_PARENT (i)->position = i->position
153
	      - LEFT_TOTAL_LENGTH (i) + TOTAL_LENGTH (i) /* right end */
154 155
	      - TOTAL_LENGTH (INTERVAL_PARENT (i))
	      + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i));
156
	  else
157
	    INTERVAL_PARENT (i)->position = i->position - LEFT_TOTAL_LENGTH (i)
158
	      + TOTAL_LENGTH (i);
159
	  i = INTERVAL_PARENT (i);
160 161
	}
      i = gl_state.forward_i;
162
      gl_state.b_property = i->position - gl_state.offset;
163
      gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
164 165 166 167
      goto update;
    }
  oldi = i = count > 0 ? gl_state.forward_i : gl_state.backward_i;

168
  /* We are guaranteed to be called with CHARPOS either in i,
169
     or further off.  */
170 171
  if (NULL_INTERVAL_P (i))
    error ("Error in syntax_table logic for to-the-end intervals");
172
  else if (charpos < i->position)		/* Move left.  */
173 174
    {
      if (count > 0)
175
	error ("Error in syntax_table logic for intervals <-");
176
      /* Update the interval.  */
177
      i = update_interval (i, charpos);
178
      if (INTERVAL_LAST_POS (i) != gl_state.b_property)
179 180 181
	{
	  invalidate = 0;
	  gl_state.forward_i = i;
182
	  gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
183
	}
184
    }
185
  else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right.  */
186 187
    {
      if (count < 0)
188
	error ("Error in syntax_table logic for intervals ->");
189
      /* Update the interval.  */
190
      i = update_interval (i, charpos);
191
      if (i->position != gl_state.e_property)
192 193 194
	{
	  invalidate = 0;
	  gl_state.backward_i = i;
195
	  gl_state.b_property = i->position - gl_state.offset;
196 197 198 199 200 201 202 203
	}
    }

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

  if (invalidate)
    invalidate = !EQ (tmp_table, gl_state.old_prop); /* Need to invalidate? */
Juanma Barranquero's avatar
Juanma Barranquero committed
204

205 206 207
  if (invalidate)		/* Did not get to adjacent interval.  */
    {				/* with the same table => */
				/* invalidate the old range.  */
208 209 210
      if (count > 0)
	{
	  gl_state.backward_i = i;
211 212 213
	  gl_state.b_property = i->position - gl_state.offset;
	}
      else
214
	{
215
	  gl_state.forward_i = i;
216
	  gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
217 218
	}
    }
219

220
  if (!EQ (tmp_table, gl_state.old_prop))
221
    {
222 223 224 225 226
      gl_state.current_syntax_table = tmp_table;
      gl_state.old_prop = tmp_table;
      if (EQ (Fsyntax_table_p (tmp_table), Qt))
	{
	  gl_state.use_global = 0;
Juanma Barranquero's avatar
Juanma Barranquero committed
227
	}
228 229 230 231 232
      else if (CONSP (tmp_table))
	{
	  gl_state.use_global = 1;
	  gl_state.global_code = tmp_table;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
233
      else
234 235 236 237
	{
	  gl_state.use_global = 0;
	  gl_state.current_syntax_table = current_buffer->syntax_table;
	}
238 239 240 241 242 243 244
    }

  while (!NULL_INTERVAL_P (i))
    {
      if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
	{
	  if (count > 0)
245 246 247 248 249 250 251 252 253 254
	    {
	      gl_state.e_property = i->position - gl_state.offset;
	      gl_state.forward_i = i;
	    }
	  else
	    {
	      gl_state.b_property = i->position + LENGTH (i) - gl_state.offset;
	      gl_state.backward_i = i;
	    }
	  return;
255
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
256
      else if (cnt == INTERVALS_AT_ONCE)
257 258
	{
	  if (count > 0)
259 260 261 262 263 264 265 266 267 268
	    {
	      gl_state.e_property = i->position + LENGTH (i) - gl_state.offset;
	      gl_state.forward_i = i;
	    }
	  else
	    {
	      gl_state.b_property = i->position - gl_state.offset;
	      gl_state.backward_i = i;
	    }
	  return;
269 270 271 272
	}
      cnt++;
      i = count > 0 ? next_interval (i) : previous_interval (i);
    }
273 274 275 276 277
  eassert (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;
278 279
}

280 281 282
/* Returns TRUE if char at CHARPOS is quoted.
   Global syntax-table data should be set up already to be good at CHARPOS
   or after.  On return global syntax data is good for lookup at CHARPOS. */
283 284

static int
285 286
char_quoted (charpos, bytepos)
     register int charpos, bytepos;
287 288 289 290
{
  register enum syntaxcode code;
  register int beg = BEGV;
  register int quoted = 0;
291 292 293
  int orig = charpos;

  DEC_BOTH (charpos, bytepos);
294

295
  while (charpos >= beg)
296
    {
297 298
      int c;

299
      UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
300 301
      c = FETCH_CHAR (bytepos);
      code = SYNTAX (c);
302 303 304 305 306
      if (! (code == Scharquote || code == Sescape))
	break;

      DEC_BOTH (charpos, bytepos);
      quoted = !quoted;
307
    }
308 309

  UPDATE_SYNTAX_TABLE (orig);
310 311
  return quoted;
}
312 313 314 315 316 317 318 319

/* Return the bytepos one character after BYTEPOS.
   We assume that BYTEPOS is not at the end of the buffer.  */

INLINE int
inc_bytepos (bytepos)
     int bytepos;
{
320 321 322
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos + 1;

323 324 325 326 327 328 329 330 331 332 333
  INC_POS (bytepos);
  return bytepos;
}

/* Return the bytepos one character before BYTEPOS.
   We assume that BYTEPOS is not at the start of the buffer.  */

INLINE int
dec_bytepos (bytepos)
     int bytepos;
{
334 335 336
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos - 1;

337 338 339
  DEC_POS (bytepos);
  return bytepos;
}
340

Richard M. Stallman's avatar
Richard M. Stallman committed
341 342 343 344
/* Return a defun-start position before before POS and not too far before.
   It should be the last one before POS, or nearly the last.

   When open_paren_in_column_0_is_defun_start is nonzero,
345
   only the beginning of the buffer is treated as a defun-start.
Richard M. Stallman's avatar
Richard M. Stallman committed
346 347 348 349

   We record the information about where the scan started
   and what its result was, so that another call in the same area
   can return the same value very quickly.
350 351 352 353

   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.  */
354 355

static int
356 357
find_defun_start (pos, pos_byte)
     int pos, pos_byte;
358
{
359
  int opoint = PT, opoint_byte = PT_BYTE;
360

361 362 363 364 365 366
  if (!open_paren_in_column_0_is_defun_start)
    {
      find_start_value_byte = BEGV_BYTE;
      return BEGV;
    }

367 368 369 370 371 372 373 374 375 376 377 378
  /* 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.  */
379
  scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
380

381 382 383 384 385
  /* 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;
386
  while (PT > BEGV)
387
    {
388 389
      int c;

390 391
      /* Open-paren at start of line means we may have found our
	 defun-start.  */
392 393
      c = FETCH_CHAR (PT_BYTE);
      if (SYNTAX (c) == Sopen)
394
	{
395
	  SETUP_SYNTAX_TABLE (PT + 1, -1);	/* Try again... */
396 397
	  c = FETCH_CHAR (PT_BYTE);
	  if (SYNTAX (c) == Sopen)
398 399 400 401
	    break;
	  /* Now fallback to the default value.  */
	  gl_state.current_syntax_table = current_buffer->syntax_table;
	  gl_state.use_global = 0;
402
	}
403 404
      /* Move to beg of previous line.  */
      scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
405 406 407
    }

  /* Record what we found, for the next try.  */
408 409
  find_start_value = PT;
  find_start_value_byte = PT_BYTE;
410 411 412 413 414
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

415 416
  TEMP_SET_PT_BOTH (opoint, opoint_byte);

417 418 419
  return find_start_value;
}

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
/* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE.  */

static int
prev_char_comend_first (pos, pos_byte)
     int pos, pos_byte;
{
  int c, val;

  DEC_BOTH (pos, pos_byte);
  UPDATE_SYNTAX_TABLE_BACKWARD (pos);
  c = FETCH_CHAR (pos_byte);
  val = SYNTAX_COMEND_FIRST (c);
  UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
  return val;
}

/* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE.  */

438 439 440 441 442
/* static int
 * prev_char_comstart_first (pos, pos_byte)
 *      int pos, pos_byte;
 * {
 *   int c, val;
Juanma Barranquero's avatar
Juanma Barranquero committed
443
 *
444 445 446 447 448 449 450
 *   DEC_BOTH (pos, pos_byte);
 *   UPDATE_SYNTAX_TABLE_BACKWARD (pos);
 *   c = FETCH_CHAR (pos_byte);
 *   val = SYNTAX_COMSTART_FIRST (c);
 *   UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
 *   return val;
 * } */
451

452 453 454 455 456 457 458 459 460
/* Checks whether charpos FROM is at the end of a comment.
   FROM_BYTE is the bytepos corresponding to FROM.
   Do not move back before STOP.

   Return a positive value if we find a comment ending at FROM/FROM_BYTE;
   return -1 otherwise.

   If successful, store the charpos of the comment's beginning
   into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
461 462 463

   Global syntax data remains valid for backward search starting at
   the returned value (or at FROM, if the search was not successful).  */
464 465

static int
466
back_comment (from, from_byte, stop, comnested, comstyle, charpos_ptr, bytepos_ptr)
467
     int from, from_byte, stop;
468
     int comnested, comstyle;
469
     int *charpos_ptr, *bytepos_ptr;
470 471 472 473 474 475 476 477 478 479
{
  /* 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.  */
480
  int string_style = -1;	/* Presumed outside of any string. */
481
  int string_lossage = 0;
482
  /* Not a real lossage: indicates that we have passed a matching comment
Juanma Barranquero's avatar
Juanma Barranquero committed
483
     starter plus a non-matching comment-ender, meaning that any matching
484 485 486 487
     comment-starter we might see later could be a false positive (hidden
     inside another comment).
     Test case:  { a (* b } c (* d *) */
  int comment_lossage = 0;
488
  int comment_end = from;
489
  int comment_end_byte = from_byte;
490
  int comstart_pos = 0;
491
  int comstart_byte;
492 493 494 495
  /* Place where the containing defun starts,
     or 0 if we didn't come across it yet.  */
  int defun_start = 0;
  int defun_start_byte = 0;
496
  register enum syntaxcode code;
497
  int nesting = 1;		/* current comment nesting */
498
  int c;
499 500 501 502 503
  int syntax = 0;

  /* FIXME: A }} comment-ender style leads to incorrect behavior
     in the case of {{ c }}} because we ignore the last two chars which are
     assumed to be comment-enders although they aren't.  */
504 505 506 507 508

  /* At beginning of range to scan, we're outside of strings;
     that determines quote parity to the comment-end.  */
  while (from != stop)
    {
509 510
      int temp_byte, prev_syntax;
      int com2start, com2end;
511

512
      /* Move back and examine a character.  */
513
      DEC_BOTH (from, from_byte);
514 515
      UPDATE_SYNTAX_TABLE_BACKWARD (from);

516
      prev_syntax = syntax;
517
      c = FETCH_CHAR (from_byte);
518
      syntax = SYNTAX_WITH_FLAGS (c);
519 520
      code = SYNTAX (c);

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
      /* Check for 2-char comment markers.  */
      com2start = (SYNTAX_FLAGS_COMSTART_FIRST (syntax)
		   && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax)
		   && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax)
		   && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
		       || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested);
      com2end = (SYNTAX_FLAGS_COMEND_FIRST (syntax)
		 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax));

      /* Nasty cases with overlapping 2-char comment markers:
	 - snmp-mode: -- c -- foo -- c --
	              --- c --
		      ------ c --
	 - c-mode:    *||*
		      |* *|* *|
		      |*| |* |*|
		      ///   */

      /* If a 2-char comment sequence partly overlaps with another,
	 we don't try to be clever.  */
      if (from > stop && (com2end || com2start))
542
	{
543 544 545 546 547 548 549 550 551 552 553 554 555 556
	  int next = from, next_byte = from_byte, next_c, next_syntax;
	  DEC_BOTH (next, next_byte);
	  UPDATE_SYNTAX_TABLE_BACKWARD (next);
	  next_c = FETCH_CHAR (next_byte);
	  next_syntax = SYNTAX_WITH_FLAGS (next_c);
	  if (((com2start || comnested)
	       && SYNTAX_FLAGS_COMEND_SECOND (syntax)
	       && SYNTAX_FLAGS_COMEND_FIRST (next_syntax))
	      || ((com2end || comnested)
		  && SYNTAX_FLAGS_COMSTART_SECOND (syntax)
		  && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (syntax)
		  && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax)))
	    goto lossage;
	  /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
557
	}
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574

      if (com2start && comstart_pos == 0)
	/* We're looking at a comment starter.  But it might be a comment
	   ender as well (see snmp-mode).  The first time we see one, we
	   need to consider it as a comment starter,
	   and the subsequent times as a comment ender.  */
	com2end = 0;

      /* Turn a 2-char comment sequences into the appropriate syntax.  */
      if (com2end)
	code = Sendcomment;
      else if (com2start)
	code = Scomment;
      /* Ignore comment starters of a different style.  */
      else if (code == Scomment
	       && (comstyle != SYNTAX_FLAGS_COMMENT_STYLE (syntax)
		   || SYNTAX_FLAGS_COMMENT_NESTED (syntax) != comnested))
575
	continue;
576

577 578
      /* Ignore escaped characters, except comment-enders.  */
      if (code != Sendcomment && char_quoted (from, from_byte))
579 580
	continue;

581
      switch (code)
582
	{
583 584 585 586 587 588 589 590 591 592 593 594 595 596
	case Sstring_fence:
	case Scomment_fence:
	  c = (code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE);
	case Sstring:
	  /* Track parity of quotes.  */
	  if (string_style == -1)
	    /* Entering a string.  */
	    string_style = c;
	  else if (string_style == c)
	    /* Leaving the string.  */
	    string_style = -1;
	  else
	    /* If we have two kinds of string delimiters.
	       There's no way to grok this scanning backwards.  */
597
	    string_lossage = 1;
598
	  break;
Juanma Barranquero's avatar
Juanma Barranquero committed
599

600 601
	case Scomment:
	  /* We've already checked that it is the relevant comstyle.  */
602
	  if (string_style != -1 || comment_lossage || string_lossage)
603 604 605 606
	    /* There are odd string quotes involved, so let's be careful.
	       Test case in Pascal: " { " a { " } */
	    goto lossage;

607 608 609 610 611 612 613
	  if (!comnested)
	    {
	      /* Record best comment-starter so far.  */
	      comstart_pos = from;
	      comstart_byte = from_byte;
	    }
	  else if (--nesting <= 0)
614 615 616 617 618 619
	    /* nested comments have to be balanced, so we don't need to
	       keep looking for earlier ones.  We use here the same (slightly
	       incorrect) reasoning as below:  since it is followed by uniform
	       paired string quotes, this comment-start has to be outside of
	       strings, else the comment-end itself would be inside a string. */
	    goto done;
620 621
	  break;

622
	case Sendcomment:
623
	  if (SYNTAX_FLAGS_COMMENT_STYLE (syntax) == comstyle
624
	      && ((com2end && SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax))
625
		  || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
626 627 628 629 630 631 632 633 634
	    /* This is the same style of comment ender as ours. */
	    {
	      if (comnested)
		nesting++;
	      else
		/* Anything before that can't count because it would match
		   this comment-ender rather than ours.  */
		from = stop;	/* Break out of the loop.  */
	    }
635 636 637 638 639 640 641 642 643
	  else if (comstart_pos != 0 || c != '\n')
	    /* We're mixing comment styles here, so we'd better be careful.
	       The (comstart_pos != 0 || c != '\n') check is not quite correct
	       (we should just always set comment_lossage), but removing it
	       would imply that any multiline comment in C would go through
	       lossage, which seems overkill.
	       The failure should only happen in the rare cases such as
	         { (* } *)   */
	    comment_lossage = 1;
644
	  break;
645

646 647 648 649 650 651 652 653 654 655 656
	case Sopen:
	  /* Assume a defun-start point is outside of strings.  */
	  if (open_paren_in_column_0_is_defun_start
	      && (from == stop
		  || (temp_byte = dec_bytepos (from_byte),
		      FETCH_CHAR (temp_byte) == '\n')))
	    {
	      defun_start = from;
	      defun_start_byte = from_byte;
	      from = stop;	/* Break out of the loop.  */
	    }
657
	  break;
658 659

	default:
660
	  break;
661
	}
662 663 664 665 666
    }

  if (comstart_pos == 0)
    {
      from = comment_end;
667
      from_byte = comment_end_byte;
668 669
      UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
    }
670 671 672
  /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
     or `done'), then we've found the beginning of the non-nested comment.  */
  else if (1)	/* !comnested */
673 674
    {
      from = comstart_pos;
675
      from_byte = comstart_byte;
676
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
677 678 679
    }
  else
    {
680 681
      struct lisp_parse_state state;
    lossage:
682 683
      /* We had two kinds of string delimiters mixed up
	 together.  Decode this going forwards.
684
	 Scan fwd from a known safe place (beginning-of-defun)
685 686
	 to the one in question; this records where we
	 last passed a comment starter.  */
687 688 689 690 691 692
      /* If we did not already find the defun start, find it now.  */
      if (defun_start == 0)
	{
	  defun_start = find_defun_start (comment_end, comment_end_byte);
	  defun_start_byte = find_start_value_byte;
	}
693
      do
694
	{
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
	  scan_sexps_forward (&state,
			      defun_start, defun_start_byte,
			      comment_end, -10000, 0, Qnil, 0);
	  defun_start = comment_end;
	  if (state.incomment == (comnested ? 1 : -1)
	      && state.comstyle == comstyle)
	    from = state.comstr_start;
	  else
	    {
	      from = comment_end;
	      if (state.incomment)
		/* If comment_end is inside some other comment, maybe ours
		   is nested, so we need to try again from within the
		   surrounding comment.  Example: { a (* " *)  */
		{
		  /* FIXME: We should advance by one or two chars. */
		  defun_start = state.comstr_start + 2;
		  defun_start_byte = CHAR_TO_BYTE (defun_start);
		}
	    }
	} while (defun_start < comment_end);

717
      from_byte = CHAR_TO_BYTE (from);
718 719
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
720

721
 done:
722 723 724
  *charpos_ptr = from;
  *bytepos_ptr = from_byte;

725
  return (from == comment_end) ? -1 : from;
726 727
}

Richard M. Stallman's avatar
Richard M. Stallman committed
728
DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
729 730 731
       doc: /* Return t if OBJECT is a syntax table.
Currently, any char-table counts as a syntax table.  */)
     (object)
732
     Lisp_Object object;
Richard M. Stallman's avatar
Richard M. Stallman committed
733
{
734
  if (CHAR_TABLE_P (object)
735
      && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
Richard M. Stallman's avatar
Richard M. Stallman committed
736 737 738 739
    return Qt;
  return Qnil;
}

740
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
741 742 743
check_syntax_table (obj)
     Lisp_Object obj;
{
744
  if (!(CHAR_TABLE_P (obj)
745
	&& EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table)))
746
    wrong_type_argument (Qsyntax_table_p, obj);
Juanma Barranquero's avatar
Juanma Barranquero committed
747
}
Richard M. Stallman's avatar
Richard M. Stallman committed
748 749

DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
750 751 752
       doc: /* Return the current syntax table.
This is the one specified by the current buffer.  */)
     ()
Richard M. Stallman's avatar
Richard M. Stallman committed
753 754 755 756 757 758
{
  return current_buffer->syntax_table;
}

DEFUN ("standard-syntax-table", Fstandard_syntax_table,
   Sstandard_syntax_table, 0, 0, 0,
759 760 761
       doc: /* Return the standard syntax table.
This is the one used for new buffers.  */)
     ()
Richard M. Stallman's avatar
Richard M. Stallman committed
762 763 764 765 766
{
  return Vstandard_syntax_table;
}

DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
767 768 769
       doc: /* Construct a new syntax table and return it.
It is a copy of the TABLE, which defaults to the standard syntax table.  */)
     (table)
Richard M. Stallman's avatar
Richard M. Stallman committed
770 771
     Lisp_Object table;
{
772 773
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
774
  if (!NILP (table))
775 776 777 778 779
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
780 781 782 783 784 785 786 787 788 789

  /* 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);
790
  return copy;
Richard M. Stallman's avatar
Richard M. Stallman committed
791 792 793
}

DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
794 795 796
       doc: /* Select a new syntax table for the current buffer.
One argument, a syntax table.  */)
     (table)
Richard M. Stallman's avatar
Richard M. Stallman committed
797 798
     Lisp_Object table;
{
799
  int idx;
800
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
801 802
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
803 804
  idx = PER_BUFFER_VAR_IDX (syntax_table);
  SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
805 806 807 808 809
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
810
 This is used by modify-syntax-entry, and other things.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
811 812 813 814 815 816

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,
817
    (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
Richard M. Stallman's avatar
Richard M. Stallman committed
818 819 820 821 822 823
        (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,
824
    (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377,   /* @, A ... */
Richard M. Stallman's avatar
Richard M. Stallman committed
825 826 827 828 829 830
    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,
831
    0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
Richard M. Stallman's avatar
Richard M. Stallman committed
832 833
  };

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

836
char syntax_code_spec[16] =
Richard M. Stallman's avatar
Richard M. Stallman committed
837
  {
838 839
    ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
    '!', '|'
Richard M. Stallman's avatar
Richard M. Stallman committed
840
  };
Karl Heuer's avatar
Karl Heuer committed
841 842 843 844 845 846 847 848

/* 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
849

850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/* 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
873
DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
874 875 876 877 878 879
       doc: /* Return the syntax code of CHARACTER, described by a character.
For example, if CHARACTER is a word constituent,
the character `w' is returned.
The characters that correspond to various syntax codes
are listed in the documentation of `modify-syntax-entry'.  */)
     (character)
880
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
881
{
882
  int char_int;
883 884 885
  gl_state.current_syntax_table = current_buffer->syntax_table;

  gl_state.use_global = 0;
886
  CHECK_NUMBER (character);
887
  char_int = XINT (character);
888
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
889 890 891
}

DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
892 893
       doc: /* Return the matching parenthesis of CHARACTER, or nil if none.  */)
     (character)
894
     Lisp_Object character;
895
{
896
  int char_int, code;
897 898
  gl_state.current_syntax_table = current_buffer->syntax_table;
  gl_state.use_global = 0;
899
  CHECK_NUMBER (character);
900
  char_int = XINT (character);
901
  code = SYNTAX (char_int);
902
  if (code == Sopen || code == Sclose)
903
    return SYNTAX_MATCH (char_int);
904
  return Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
905 906
}

907
DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
908 909 910 911 912 913
       doc: /* Convert a syntax specification STRING into syntax cell form.
STRING should be a string as it is allowed as argument of
`modify-syntax-entry'.  Value is the equivalent cons cell
(CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
text property.  */)
     (string)
914
     Lisp_Object string;
Richard M. Stallman's avatar
Richard M. Stallman committed
915
{
916
  register const unsigned char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
917
  register enum syntaxcode code;
918
  int val;
919
  Lisp_Object match;
Richard M. Stallman's avatar
Richard M. Stallman committed
920

921
  CHECK_STRING (string);
Richard M. Stallman's avatar
Richard M. Stallman committed
922

923
  p = SDATA (string);
Richard M. Stallman's avatar
Richard M. Stallman committed
924 925
  code = (enum syntaxcode) syntax_spec_code[*p++];
  if (((int) code & 0377) == 0377)
926
    error ("Invalid syntax description letter: %c", p[-1]);
Richard M. Stallman's avatar
Richard M. Stallman committed
927

928
  if (code == Sinherit)
929
    return Qnil;
930 931

  if (*p)
932
    {
Karl Heuer's avatar
Karl Heuer committed
933
      int len;
934
      int character = (STRING_CHAR_AND_LENGTH
935
		       (p, SBYTES (string) - 1, len));
Karl Heuer's avatar
Karl Heuer committed
936
      XSETINT (match, character);
937 938
      if (XFASTINT (match) == ' ')
	match = Qnil;
Karl Heuer's avatar
Karl Heuer committed
939
      p += len;
940 941
    }
  else
942
    match = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
943

944
  val = (int) code;
Richard M. Stallman's avatar
Richard M. Stallman committed
945 946 947 948
  while (*p)
    switch (*p++)
      {
      case '1':
949
	val |= 1 << 16;
Richard M. Stallman's avatar
Richard M. Stallman committed
950 951 952
	break;

      case '2':
953
	val |= 1 << 17;
Richard M. Stallman's avatar
Richard M. Stallman committed
954 955 956
	break;

      case '3':
957
	val |= 1 << 18;
Richard M. Stallman's avatar
Richard M. Stallman committed
958 959 960
	break;

      case '4':
961
	val |= 1 << 19;
Richard M. Stallman's avatar
Richard M. Stallman committed
962 963 964
	break;

      case 'p':
965
	val |= 1 << 20;
Richard M. Stallman's avatar
Richard M. Stallman committed
966
	break;
967 968

      case 'b':
969
	val |= 1 << 21;
970
	break;
971 972 973 974

      case 'n':
	val |= 1 << 22;
	break;
Richard M. Stallman's avatar
Richard M. Stallman committed
975
      }
Juanma Barranquero's avatar
Juanma Barranquero committed
976

Karl Heuer's avatar
Karl Heuer committed
977
  if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
978
    return XVECTOR (Vsyntax_code_object)->contents[val];
Karl Heuer's avatar
Karl Heuer committed
979 980
  else
    /* Since we can't use a shared object, let's make a new one.  */
981 982 983
    return Fcons (make_number (val), match);
}

984
/* I really don't know why this is interactive
Stefan Monnier's avatar
Stefan Monnier committed
985
   help-form should at least be made useful whilst reading the second arg.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
986
DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3,
987
  "cSet syntax for character: \nsSet syntax for %s to: ",
988
       doc: /* Set syntax for character CHAR according to string NEWENTRY.
989
The syntax is changed only for table SYNTAX-TABLE, which defaults to
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
 the current buffer's syntax table.
The first character of NEWENTRY should be one of the following:
  Space or -  whitespace syntax.    w   word constituent.
  _           symbol constituent.   .   punctuation.
  (           open-parenthesis.     )   close-parenthesis.
  "           string quote.         \\   escape.
  $           paired delimiter.     '   expression quote or prefix operator.
  <           comment starter.      >   comment ender.
  /           character-quote.      @   inherit from `standard-syntax-table'.
  |           generic string fence. !   generic comment fence.

Only single-character comment start and end sequences are represented thus.
Two-character sequences are represented as described below.
The second character of NEWENTRY is the matching parenthesis,
 used only if the first character is `(' or `)'.
Any additional characters are flags.
Defined flags are the characters 1, 2, 3, 4, b, p, and n.
1007 1008 1009 1010
 1 means CHAR is the start of a two-char comment start sequence.
 2 means CHAR is the second character of such a sequence.
 3 means CHAR is the start of a two-char comment end sequence.
 4 means CHAR is the second character of such a sequence.
1011 1012 1013 1014 1015 1016

There can be up to two orthogonal comment sequences.  This is to support
language modes such as C++.  By default, all comment sequences are of style
a, but you can set the comment sequence style to b (on the second character
of a comment-start, or the first character of a comment-end sequence) using
this flag:
1017 1018
 b means CHAR is part of comment sequence b.
 n means CHAR is part of a nestable comment sequence.
1019

1020
 p means CHAR is a prefix character for `backward-prefix-chars';
1021
   such characters are treated as whitespace when they occur
1022