syntax.c 93 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 3 4
   Copyright (C) 1985, 1987, 1993, 1994, 1995, 1997, 1998, 1999, 2001,
                 2002, 2003, 2004, 2005, 2006, 2007
                 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 3, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
11 12 13 14 15 16 17 18 19
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
22 23


24
#include <config.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27 28
#include <ctype.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
29
#include "charset.h"
Stefan Monnier's avatar
Stefan Monnier committed
30
#include "keymap.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
31
#include "regex.h"
32 33 34 35

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

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

47
Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
48 49

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

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

55 56 57 58 59
/* 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;

60 61 62 63 64 65
/* 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;

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

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


static int find_defun_start P_ ((int, int));
101 102
static int back_comment P_ ((EMACS_INT, EMACS_INT, EMACS_INT, int, int,
			     EMACS_INT *, EMACS_INT *));
103
static int char_quoted P_ ((int, int));
Richard M. Stallman's avatar
Richard M. Stallman committed
104
static Lisp_Object skip_chars P_ ((int, int, Lisp_Object, Lisp_Object, int));
105
static Lisp_Object scan_lists P_ ((EMACS_INT, EMACS_INT, EMACS_INT, int));
106 107 108
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
109
static int in_classes P_ ((int, Lisp_Object));
110 111 112 113 114 115 116 117


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

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

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

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

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

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

  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
207

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

223
  if (!EQ (tmp_table, gl_state.old_prop))
224
    {
225 226 227 228 229
      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
230
	}
231 232 233 234 235
      else if (CONSP (tmp_table))
	{
	  gl_state.use_global = 1;
	  gl_state.global_code = tmp_table;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
236
      else
237 238 239 240
	{
	  gl_state.use_global = 0;
	  gl_state.current_syntax_table = current_buffer->syntax_table;
	}
241 242 243 244 245 246 247
    }

  while (!NULL_INTERVAL_P (i))
    {
      if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
	{
	  if (count > 0)
248 249 250 251 252 253
	    {
	      gl_state.e_property = i->position - gl_state.offset;
	      gl_state.forward_i = i;
	    }
	  else
	    {
254 255
	      gl_state.b_property
		= i->position + LENGTH (i) - gl_state.offset;
256 257 258
	      gl_state.backward_i = i;
	    }
	  return;
259
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
260
      else if (cnt == INTERVALS_AT_ONCE)
261 262
	{
	  if (count > 0)
263
	    {
264 265 266 267 268 269
	      gl_state.e_property
		= i->position + LENGTH (i) - gl_state.offset
		/* e_property at EOB is not set to ZV but to ZV+1, so that
		   we can do INC(from);UPDATE_SYNTAX_TABLE_FORWARD without
		   having to check eob between the two.  */
		+ (NULL_INTERVAL_P (next_interval (i)) ? 1 : 0);
270 271 272 273 274 275 276 277
	      gl_state.forward_i = i;
	    }
	  else
	    {
	      gl_state.b_property = i->position - gl_state.offset;
	      gl_state.backward_i = i;
	    }
	  return;
278 279 280 281
	}
      cnt++;
      i = count > 0 ? next_interval (i) : previous_interval (i);
    }
282 283 284 285 286
  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;
287 288
}

289 290 291
/* 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. */
292 293

static int
294 295
char_quoted (charpos, bytepos)
     register int charpos, bytepos;
296 297 298 299
{
  register enum syntaxcode code;
  register int beg = BEGV;
  register int quoted = 0;
300 301 302
  int orig = charpos;

  DEC_BOTH (charpos, bytepos);
303

304
  while (charpos >= beg)
305
    {
306 307
      int c;

308
      UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
309 310
      c = FETCH_CHAR (bytepos);
      code = SYNTAX (c);
311 312 313 314 315
      if (! (code == Scharquote || code == Sescape))
	break;

      DEC_BOTH (charpos, bytepos);
      quoted = !quoted;
316
    }
317 318

  UPDATE_SYNTAX_TABLE (orig);
319 320
  return quoted;
}
321 322 323 324 325 326 327 328

/* 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;
{
329 330 331
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos + 1;

332 333 334 335 336 337 338 339 340 341 342
  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;
{
343 344 345
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos - 1;

346 347 348
  DEC_POS (bytepos);
  return bytepos;
}
349

Richard M. Stallman's avatar
Richard M. Stallman committed
350 351 352 353
/* 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,
354
   only the beginning of the buffer is treated as a defun-start.
Richard M. Stallman's avatar
Richard M. Stallman committed
355 356 357 358

   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.
359 360 361 362

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

static int
365 366
find_defun_start (pos, pos_byte)
     int pos, pos_byte;
367
{
368
  int opoint = PT, opoint_byte = PT_BYTE;
369

370 371 372 373 374 375
  if (!open_paren_in_column_0_is_defun_start)
    {
      find_start_value_byte = BEGV_BYTE;
      return BEGV;
    }

376 377 378 379 380 381 382 383 384 385 386 387
  /* 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.  */
388
  scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
389

390 391 392 393 394
  /* 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;
395
  while (PT > BEGV)
396
    {
397 398
      int c;

399 400
      /* Open-paren at start of line means we may have found our
	 defun-start.  */
401 402
      c = FETCH_CHAR (PT_BYTE);
      if (SYNTAX (c) == Sopen)
403
	{
404
	  SETUP_SYNTAX_TABLE (PT + 1, -1);	/* Try again... */
405 406
	  c = FETCH_CHAR (PT_BYTE);
	  if (SYNTAX (c) == Sopen)
407 408 409 410
	    break;
	  /* Now fallback to the default value.  */
	  gl_state.current_syntax_table = current_buffer->syntax_table;
	  gl_state.use_global = 0;
411
	}
412 413
      /* Move to beg of previous line.  */
      scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
414 415 416
    }

  /* Record what we found, for the next try.  */
417 418
  find_start_value = PT;
  find_start_value_byte = PT_BYTE;
419 420 421 422 423
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

424 425
  TEMP_SET_PT_BOTH (opoint, opoint_byte);

426 427 428
  return find_start_value;
}

429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
/* 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.  */

447 448 449 450 451
/* static int
 * prev_char_comstart_first (pos, pos_byte)
 *      int pos, pos_byte;
 * {
 *   int c, val;
Juanma Barranquero's avatar
Juanma Barranquero committed
452
 *
453 454 455 456 457 458 459
 *   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;
 * } */
460

461 462 463 464 465 466 467 468 469
/* 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.
470 471 472

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

static int
475
back_comment (from, from_byte, stop, comnested, comstyle, charpos_ptr, bytepos_ptr)
476
     EMACS_INT from, from_byte, stop;
477
     int comnested, comstyle;
478
     EMACS_INT *charpos_ptr, *bytepos_ptr;
479 480 481 482 483 484 485 486 487 488
{
  /* 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.  */
489
  int string_style = -1;	/* Presumed outside of any string. */
490
  int string_lossage = 0;
491
  /* Not a real lossage: indicates that we have passed a matching comment
Juanma Barranquero's avatar
Juanma Barranquero committed
492
     starter plus a non-matching comment-ender, meaning that any matching
493 494 495 496
     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;
497
  int comment_end = from;
498
  int comment_end_byte = from_byte;
499
  int comstart_pos = 0;
500
  int comstart_byte;
501 502 503 504
  /* 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;
505
  register enum syntaxcode code;
506
  int nesting = 1;		/* current comment nesting */
507
  int c;
508 509 510 511 512
  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.  */
513 514 515 516 517

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

521
      /* Move back and examine a character.  */
522
      DEC_BOTH (from, from_byte);
523 524
      UPDATE_SYNTAX_TABLE_BACKWARD (from);

525
      prev_syntax = syntax;
526
      c = FETCH_CHAR (from_byte);
527
      syntax = SYNTAX_WITH_FLAGS (c);
528 529
      code = SYNTAX (c);

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
      /* 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))
551
	{
552 553 554 555 556 557 558 559 560 561 562 563 564 565
	  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); */
566
	}
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583

      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))
584
	continue;
585

586 587
      /* Ignore escaped characters, except comment-enders.  */
      if (code != Sendcomment && char_quoted (from, from_byte))
588 589
	continue;

590
      switch (code)
591
	{
592 593 594 595 596 597 598 599 600 601 602 603 604 605
	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.  */
606
	    string_lossage = 1;
607
	  break;
Juanma Barranquero's avatar
Juanma Barranquero committed
608

609 610
	case Scomment:
	  /* We've already checked that it is the relevant comstyle.  */
611
	  if (string_style != -1 || comment_lossage || string_lossage)
612 613 614 615
	    /* There are odd string quotes involved, so let's be careful.
	       Test case in Pascal: " { " a { " } */
	    goto lossage;

616 617 618 619 620 621 622
	  if (!comnested)
	    {
	      /* Record best comment-starter so far.  */
	      comstart_pos = from;
	      comstart_byte = from_byte;
	    }
	  else if (--nesting <= 0)
623 624 625 626 627 628
	    /* 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;
629 630
	  break;

631
	case Sendcomment:
632
	  if (SYNTAX_FLAGS_COMMENT_STYLE (syntax) == comstyle
633
	      && ((com2end && SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax))
634
		  || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
635 636 637 638 639 640 641 642 643
	    /* 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.  */
	    }
644 645 646 647 648 649 650 651 652
	  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;
653
	  break;
654

655 656 657 658 659 660 661 662 663 664 665
	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.  */
	    }
666
	  break;
667 668

	default:
669
	  break;
670
	}
671 672 673 674 675
    }

  if (comstart_pos == 0)
    {
      from = comment_end;
676
      from_byte = comment_end_byte;
677 678
      UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
    }
679 680 681
  /* 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 */
682 683
    {
      from = comstart_pos;
684
      from_byte = comstart_byte;
685
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
686 687 688
    }
  else
    {
689 690
      struct lisp_parse_state state;
    lossage:
691 692
      /* We had two kinds of string delimiters mixed up
	 together.  Decode this going forwards.
693
	 Scan fwd from a known safe place (beginning-of-defun)
694 695
	 to the one in question; this records where we
	 last passed a comment starter.  */
696 697 698 699 700 701
      /* 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;
	}
702
      do
703
	{
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
	  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);

726
      from_byte = CHAR_TO_BYTE (from);
727 728
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
729

730
 done:
731 732 733
  *charpos_ptr = from;
  *bytepos_ptr = from_byte;

734
  return (from == comment_end) ? -1 : from;
735 736
}

Richard M. Stallman's avatar
Richard M. Stallman committed
737
DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
738 739 740
       doc: /* Return t if OBJECT is a syntax table.
Currently, any char-table counts as a syntax table.  */)
     (object)
741
     Lisp_Object object;
Richard M. Stallman's avatar
Richard M. Stallman committed
742
{
743
  if (CHAR_TABLE_P (object)
744
      && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
Richard M. Stallman's avatar
Richard M. Stallman committed
745 746 747 748
    return Qt;
  return Qnil;
}

749
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752
check_syntax_table (obj)
     Lisp_Object obj;
{
753 754
  CHECK_TYPE (CHAR_TABLE_P (obj) && EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table),
	      Qsyntax_table_p, obj);
Juanma Barranquero's avatar
Juanma Barranquero committed
755
}
Richard M. Stallman's avatar
Richard M. Stallman committed
756 757

DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
758 759 760
       doc: /* Return the current syntax table.
This is the one specified by the current buffer.  */)
     ()
Richard M. Stallman's avatar
Richard M. Stallman committed
761 762 763 764 765 766
{
  return current_buffer->syntax_table;
}

DEFUN ("standard-syntax-table", Fstandard_syntax_table,
   Sstandard_syntax_table, 0, 0, 0,
767 768 769
       doc: /* Return the standard syntax table.
This is the one used for new buffers.  */)
     ()
Richard M. Stallman's avatar
Richard M. Stallman committed
770 771 772 773 774
{
  return Vstandard_syntax_table;
}

DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
775 776 777
       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
778 779
     Lisp_Object table;
{
780 781
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
782
  if (!NILP (table))
783 784 785 786 787
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
788 789 790 791 792 793 794 795 796 797

  /* 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);
798
  return copy;
Richard M. Stallman's avatar
Richard M. Stallman committed
799 800 801
}

DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
802 803 804
       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
805 806
     Lisp_Object table;
{
807
  int idx;
808
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
809 810
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
811 812
  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
813 814 815 816 817
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
818
 This is used by modify-syntax-entry, and other things.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
819 820 821 822 823 824

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,
825
    (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
Richard M. Stallman's avatar
Richard M. Stallman committed
826 827 828 829 830 831
        (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,
832
    (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377,   /* @, A ... */
Richard M. Stallman's avatar
Richard M. Stallman committed
833 834 835 836 837 838
    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,
839
    0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
Richard M. Stallman's avatar
Richard M. Stallman committed
840 841
  };

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

844
char syntax_code_spec[16] =
Richard M. Stallman's avatar
Richard M. Stallman committed
845
  {
846 847
    ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
    '!', '|'
Richard M. Stallman's avatar
Richard M. Stallman committed
848
  };
Karl Heuer's avatar
Karl Heuer committed
849 850 851 852 853 854 855 856

/* 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
857

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
/* 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
881
DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
882 883 884 885 886 887
       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)
888
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
889
{
890
  int char_int;
891 892 893
  gl_state.current_syntax_table = current_buffer->syntax_table;

  gl_state.use_global = 0;
894
  CHECK_NUMBER (character);
895
  char_int = XINT (character);
896
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
897 898 899
}

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

915
DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
916 917 918
       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
919
\(CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
920 921
text property.  */)
     (string)
922
     Lisp_Object string;
Richard M. Stallman's avatar
Richard M. Stallman committed
923
{
924
  register const unsigned char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
925
  register enum syntaxcode code;
926
  int val;
927
  Lisp_Object match;
Richard M. Stallman's avatar
Richard M. Stallman committed
928

929
  CHECK_STRING (string);
Richard M. Stallman's avatar
Richard M. Stallman committed
930

931
  p = SDATA (string);
Richard M. Stallman's avatar
Richard M. Stallman committed
932 933
  code = (enum syntaxcode) syntax_spec_code[*p++];
  if (((int) code & 0377) == 0377)
934
    error ("Invalid syntax description letter: %c", p[-1]);
Richard M. Stallman's avatar
Richard M. Stallman committed
935

936
  if (code == Sinherit)
937
    return Qnil;
938 939

  if (*p)
940
    {
Karl Heuer's avatar
Karl Heuer committed
941
      int len;
942
      int character = (STRING_CHAR_AND_LENGTH
943
		       (p, SBYTES (string) - 1, len));
Karl Heuer's avatar
Karl Heuer committed
944
      XSETINT (match, character);
945 946
      if (XFASTINT (match) == ' ')
	match = Qnil;
Karl Heuer's avatar
Karl Heuer committed
947
      p += len;
948