syntax.c 89.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.
2
   Copyright (C) 1985, 87, 93, 94, 95, 97, 1998, 1999 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

int words_include_escapes;
46
int parse_sexp_lookup_properties;
Richard M. Stallman's avatar
Richard M. Stallman committed
47

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

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

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

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


static int find_defun_start P_ ((int, int));
97
static int back_comment P_ ((int, int, int, int, int, int *, int *));
98 99 100 101 102 103
static int char_quoted P_ ((int, int));
static Lisp_Object skip_chars P_ ((int, int, Lisp_Object, Lisp_Object));
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));
104 105 106 107 108 109 110 111


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

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

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

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

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

165
  /* We are guaranteed to be called with CHARPOS either in i,
166
     or further off.  */
167 168
  if (NULL_INTERVAL_P (i))
    error ("Error in syntax_table logic for to-the-end intervals");
169
  else if (charpos < i->position)		/* Move left.  */
170 171
    {
      if (count > 0)
172
	error ("Error in syntax_table logic for intervals <-");
173
      /* Update the interval.  */
174
      i = update_interval (i, charpos);
175
      if (!gl_state.left_ok || oldi->position != INTERVAL_LAST_POS (i))
176 177 178 179
	{
	  invalidate = 0;
	  gl_state.right_ok = 1;	/* Invalidate the other end.  */
	  gl_state.forward_i = i;
180
	  gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
181
	}
182
    }
183
  else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right.  */
184 185
    {
      if (count < 0)
186
	error ("Error in syntax_table logic for intervals ->");
187
      /* Update the interval.  */
188
      i = update_interval (i, charpos);
189
      if (!gl_state.right_ok || i->position != INTERVAL_LAST_POS (oldi))
190 191 192 193
	{
	  invalidate = 0;
	  gl_state.left_ok = 1;		/* Invalidate the other end.  */
	  gl_state.backward_i = i;
194
	  gl_state.b_property = i->position - 1 - gl_state.offset;
195 196 197 198 199 200 201 202 203 204 205 206 207 208
	}
    }
  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? */
      
209 210 211
  if (invalidate)		/* Did not get to adjacent interval.  */
    {				/* with the same table => */
				/* invalidate the old range.  */
212 213 214 215
      if (count > 0)
	{
	  gl_state.backward_i = i;
	  gl_state.left_ok = 1;		/* Invalidate the other end.  */
216
	  gl_state.b_property = i->position - 1 - gl_state.offset;
217 218 219 220 221
	} 
      else 
	{
	  gl_state.forward_i = i;	
	  gl_state.right_ok = 1;	/* Invalidate the other end.  */
222
	  gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
223 224
	}
    }
225

226 227
  gl_state.current_syntax_table = tmp_table;
  gl_state.old_prop = tmp_table;
228
  if (EQ (Fsyntax_table_p (tmp_table), Qt))
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
    {
      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) 
	{
275
	  gl_state.e_property = i->position - gl_state.offset;
276 277 278 279
	  gl_state.forward_i = i;
	}
      else 
	{
280
	  gl_state.b_property = i->position + LENGTH (i) - 1 - gl_state.offset;
281 282 283 284 285
	  gl_state.backward_i = i;
	}
    }    
}

286 287 288
/* 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. */
289 290

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

  DEC_BOTH (charpos, bytepos);
300

301
  while (bytepos >= beg)
302
    {
303 304 305 306 307 308 309
      UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
      code = SYNTAX (FETCH_CHAR (bytepos));
      if (! (code == Scharquote || code == Sescape))
	break;

      DEC_BOTH (charpos, bytepos);
      quoted = !quoted;
310
    }
311 312

  UPDATE_SYNTAX_TABLE (orig);
313 314
  return quoted;
}
315 316 317 318 319 320 321 322

/* 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;
{
323 324 325
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos + 1;

326 327 328 329 330 331 332 333 334 335 336
  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;
{
337 338 339
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos - 1;

340 341 342
  DEC_POS (bytepos);
  return bytepos;
}
343

Richard M. Stallman's avatar
Richard M. Stallman committed
344 345 346 347 348 349 350 351 352
/* 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,
   the beginning of every line is treated as a defun-start.

   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.
353 354 355 356

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

static int
359 360
find_defun_start (pos, pos_byte)
     int pos, pos_byte;
361
{
362
  int opoint = PT, opoint_byte = PT_BYTE;
363 364 365 366 367 368 369 370 371 372 373 374 375

  /* 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.  */
376
  scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
377

378 379 380 381 382
  /* 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;
383
  if (open_paren_in_column_0_is_defun_start)
384
    {
385
      while (PT > BEGV)
386
	{
387 388 389 390 391 392 393 394 395 396 397 398 399
	  /* Open-paren at start of line means we may have found our
	     defun-start.  */
	  if (SYNTAX (FETCH_CHAR (PT_BYTE)) == Sopen)
	    {
	      SETUP_SYNTAX_TABLE (PT + 1, -1);	/* Try again... */
	      if (SYNTAX (FETCH_CHAR (PT_BYTE)) == Sopen)
		break;
	      /* Now fallback to the default value.  */
	      gl_state.current_syntax_table = current_buffer->syntax_table;
	      gl_state.use_global = 0;
	    }
	  /* Move to beg of previous line.  */
	  scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
400
	}
401 402 403
    }

  /* Record what we found, for the next try.  */
404 405
  find_start_value = PT;
  find_start_value_byte = PT_BYTE;
406 407 408 409 410
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

411 412
  TEMP_SET_PT_BOTH (opoint, opoint_byte);

413 414 415
  return find_start_value;
}

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
/* 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.  */

434 435 436 437 438 439 440 441 442 443 444 445 446
/* static int
 * prev_char_comstart_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_COMSTART_FIRST (c);
 *   UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
 *   return val;
 * } */
447

448 449 450 451 452 453 454 455 456
/* 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.
457 458 459

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

static int
462
back_comment (from, from_byte, stop, comnested, comstyle, charpos_ptr, bytepos_ptr)
463
     int from, from_byte, stop;
464
     int comnested, comstyle;
465
     int *charpos_ptr, *bytepos_ptr;
466 467 468 469 470 471 472 473 474 475
{
  /* 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.  */
476
  int string_style = -1;	/* Presumed outside of any string. */
477
  int string_lossage = 0;
478 479 480 481 482 483
  /* Not a real lossage: indicates that we have passed a matching comment
     starter plus an non-matching comment-ender, meaning that any matching
     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;
484
  int comment_end = from;
485
  int comment_end_byte = from_byte;
486
  int comstart_pos = 0;
487
  int comstart_byte;
488 489 490 491
  /* 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;
492
  register enum syntaxcode code;
493
  int nesting = 1;		/* current comment nesting */
494
  int c;
495 496 497 498 499
  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.  */
500 501 502 503 504

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

508
      /* Move back and examine a character.  */
509
      DEC_BOTH (from, from_byte);
510 511
      UPDATE_SYNTAX_TABLE_BACKWARD (from);

512
      prev_syntax = syntax;
513
      c = FETCH_CHAR (from_byte);
514
      syntax = SYNTAX_WITH_FLAGS (c);
515 516
      code = SYNTAX (c);

517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
      /* 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))
538
	{
539 540 541 542 543 544 545 546 547 548 549 550 551 552
	  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); */
553
	}
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570

      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))
571
	continue;
572

573 574
      /* Ignore escaped characters, except comment-enders.  */
      if (code != Sendcomment && char_quoted (from, from_byte))
575 576
	continue;

577
      switch (code)
578
	{
579 580 581 582 583 584 585 586 587 588 589 590 591 592
	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.  */
593
	    string_lossage = 1;
594 595 596 597
	  break;
	  
	case Scomment:
	  /* We've already checked that it is the relevant comstyle.  */
598
	  if (string_style != -1 || comment_lossage || string_lossage)
599 600 601 602
	    /* There are odd string quotes involved, so let's be careful.
	       Test case in Pascal: " { " a { " } */
	    goto lossage;

603 604 605 606 607 608 609
	  if (!comnested)
	    {
	      /* Record best comment-starter so far.  */
	      comstart_pos = from;
	      comstart_byte = from_byte;
	    }
	  else if (--nesting <= 0)
610 611 612 613 614 615
	    /* 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;
616 617
	  break;

618
	case Sendcomment:
619 620 621
	  if (SYNTAX_FLAGS_COMMENT_STYLE (syntax) == comstyle
	      && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
		  || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
622 623 624 625 626 627 628 629 630
	    /* 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.  */
	    }
631 632 633 634 635 636 637 638 639
	  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;
640
	  break;
641

642 643 644 645 646 647 648 649 650 651 652
	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.  */
	    }
653
	  break;
654 655

	default:
656
	  break;
657
	}
658 659 660 661 662
    }

  if (comstart_pos == 0)
    {
      from = comment_end;
663
      from_byte = comment_end_byte;
664 665
      UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
    }
666 667 668
  /* 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 */
669 670
    {
      from = comstart_pos;
671
      from_byte = comstart_byte;
672 673 674 675
      /* Globals are correct now.  */
    }
  else
    {
676 677
      struct lisp_parse_state state;
    lossage:
678 679
      /* We had two kinds of string delimiters mixed up
	 together.  Decode this going forwards.
680
	 Scan fwd from a known safe place (beginning-of-defun)
681 682
	 to the one in question; this records where we
	 last passed a comment starter.  */
683 684 685 686 687 688
      /* 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;
	}
689
      do
690
	{
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
	  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);

713
      from_byte = CHAR_TO_BYTE (from);
714 715 716
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
    }
    
717
 done:
718 719 720
  *charpos_ptr = from;
  *bytepos_ptr = from_byte;

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

736
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
737 738 739
check_syntax_table (obj)
     Lisp_Object obj;
{
740
  if (!(CHAR_TABLE_P (obj)
741
	&& EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table)))
742
    wrong_type_argument (Qsyntax_table_p, obj);
Richard M. Stallman's avatar
Richard M. Stallman committed
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
}   

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;
{
768 769
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
770
  if (!NILP (table))
771 772 773 774 775
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
776 777 778 779 780 781 782 783 784 785

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

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;
{
795
  int idx;
796
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
797 798
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
799 800
  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
801 802 803 804 805
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
806
 This is used by modify-syntax-entry, and other things.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
807 808 809 810 811 812

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

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

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

/* 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
845

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
/* 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
869
DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
870 871 872
  "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
873 874
The characters that correspond to various syntax codes\n\
are listed in the documentation of `modify-syntax-entry'.")
875 876
  (character)
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
877
{
878
  int char_int;
879 880 881
  gl_state.current_syntax_table = current_buffer->syntax_table;

  gl_state.use_global = 0;
882 883
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
884
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
885 886 887
}

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

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

917
  CHECK_STRING (string, 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
918

919
  p = XSTRING (string)->data;
Richard M. Stallman's avatar
Richard M. Stallman committed
920 921
  code = (enum syntaxcode) syntax_spec_code[*p++];
  if (((int) code & 0377) == 0377)
922
    error ("invalid syntax description letter: %c", p[-1]);
Richard M. Stallman's avatar
Richard M. Stallman committed
923

924
  if (code == Sinherit)
925
    return Qnil;
926 927

  if (*p)
928
    {
Karl Heuer's avatar
Karl Heuer committed
929
      int len;
930
      int character = (STRING_CHAR_AND_LENGTH
931
		       (p, STRING_BYTES (XSTRING (string)) - 1, len));
Karl Heuer's avatar
Karl Heuer committed
932
      XSETINT (match, character);
933 934
      if (XFASTINT (match) == ' ')
	match = Qnil;
Karl Heuer's avatar
Karl Heuer committed
935
      p += len;
936 937
    }
  else
938
    match = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
939

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

      case '2':
949
	val |= 1 << 17;
Richard M. Stallman's avatar
Richard M. Stallman committed
950 951 952
	break;

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

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

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

      case 'b':
965
	val |= 1 << 21;
966
	break;
967 968 969 970

      case 'n':
	val |= 1 << 22;
	break;
Richard M. Stallman's avatar
Richard M. Stallman committed
971 972
      }
	
Karl Heuer's avatar
Karl Heuer committed
973
  if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
974
    return XVECTOR (Vsyntax_code_object)->contents[val];
Karl Heuer's avatar
Karl Heuer committed
975 976
  else
    /* Since we can't use a shared object, let's make a new one.  */
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
    return Fcons (make_number (val), match);
}

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

DEFUN ("modify-syntax-entry", foo, bar, 2, 3, 0,
  "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\
  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\
  <           comment starter.      >   comment ender.\n\
  /           character-quote.      @   inherit from `standard-syntax-table'.\n\
  |           generic string fence. !   generic comment fence.\n\
\n\
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\
Defined flags are the characters 1, 2, 3, 4, b, p, and n.\n\
 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\
\n\
There can be up to two orthogonal comment sequences.  This is to support\n\
language modes such as C++.  By default, all comment sequences are of style\n\
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\
this flag:\n\
 b means CHAR is part of comment sequence b.\n\
 n means CHAR is part of a nestable comment sequence.\n\
\n\
 p means CHAR is a prefix character for `backward-prefix-chars';\n\
   such characters are treated as whitespace when they occur\n\
   between expressions.")
  (char, s, table)
*/

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;
{
  CHECK_NUMBER (c, 0);

  if (NILP (syntax_table))
    syntax_table = current_buffer->syntax_table;
  else
    check_syntax_table (syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
1038

1039
  SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), Fstring_to_syntax (newentry));
Richard M. Stallman's avatar
Richard M. Stallman committed
1040 1041 1042 1043 1044
  return Qnil;
}

/* Dump syntax table to buffer in human-readable format */

1045
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
1046 1047 1048 1049
describe_syntax (value)
    Lisp_Object value;
{
  register enum syntaxcode code;
1050
  char desc, start1, start2, end1, end2, prefix, comstyle, comnested;
Richard M. Stallman's avatar
Richard M. Stallman committed
1051
  char str[2];
1052
  Lisp_Object first, match_lisp;
Richard M. Stallman's avatar
Richard M. Stallman committed
1053 1054 1055

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

1056 1057
  if (NILP (value))
    {
Karl Heuer's avatar
Karl Heuer committed
1058
      insert_string ("default\n");
1059 1060 1061
      return;
    }

1062 1063 1064 1065 1066 1067
  if (CHAR_TABLE_P (value))
    {
      insert_string ("deeper char-table ...\n");
      return;
    }

1068 1069
  if (!CONSP (value))
    {
Karl Heuer's avatar
Karl Heuer committed
1070
      insert_string ("invalid\n");
1071 1072 1073
      return;
    }

1074 1075
  first = XCAR (value);
  match_lisp = XCDR (value);
1076 1077

  if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1078
    {
Karl Heuer's avatar
Karl Heuer committed
1079
      insert_string ("invalid\n");
Richard M. Stallman's avatar
Richard M. Stallman committed
1080 1081 1082
      return;
    }

1083
  code = (enum syntaxcode) (XINT (first) & 0377);
1084 1085 1086 1087 1088 1089
  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;
1090
  comnested = (XINT (first) >> 22) & 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101

  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
1102 1103 1104 1105
  if (NILP (match_lisp))
    insert (" ", 1);
  else
    insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

  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);
1119 1120
  if (comstyle)
    insert ("b", 1);
1121 1122
  if (comnested)
    insert ("n", 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
1123 1124 1125

  insert_string ("\twhich means: ");

1126
  switch (SWITCH_ENUM_CAST (code))
Richard M. Stallman's avatar
Richard M. Stallman committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    {
    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:
1141
      insert_string ("prefix"); break;
Richard M. Stallman's avatar
Richard M. Stallman committed
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
    case