syntax.c 94.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.
Kenichi Handa's avatar
Kenichi Handa committed
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"
27
#include "character.h"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "keymap.h"
29 30 31 32

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

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

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

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

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

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

57 58 59 60 61 62
/* 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;

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

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


static int find_defun_start P_ ((int, int));
98
static int back_comment P_ ((int, int, int, int, int, int *, int *));
99
static int char_quoted P_ ((int, int));
100 101
static Lisp_Object skip_chars P_ ((int, Lisp_Object, Lisp_Object));
static Lisp_Object skip_syntaxes P_ ((int, Lisp_Object, Lisp_Object));
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));
106 107 108 109 110 111 112 113


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

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

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

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

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

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

  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
203

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

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

  while (!NULL_INTERVAL_P (i))
    {
      if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
	{
	  if (count > 0)
244 245 246 247 248 249 250 251 252 253
	    {
	      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;
254
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
255
      else if (cnt == INTERVALS_AT_ONCE)
256 257
	{
	  if (count > 0)
258 259 260 261 262 263 264 265 266 267
	    {
	      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;
268 269 270 271
	}
      cnt++;
      i = count > 0 ? next_interval (i) : previous_interval (i);
    }
272 273 274 275 276
  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;
277 278
}

279 280 281
/* 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. */
282 283

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

  DEC_BOTH (charpos, bytepos);
293

294
  while (bytepos >= beg)
295
    {
296
      UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
297
      code = SYNTAX (FETCH_CHAR_AS_MULTIBYTE (bytepos));
298 299 300 301 302
      if (! (code == Scharquote || code == Sescape))
	break;

      DEC_BOTH (charpos, bytepos);
      quoted = !quoted;
303
    }
304 305

  UPDATE_SYNTAX_TABLE (orig);
306 307
  return quoted;
}
308 309 310 311 312 313 314 315

/* 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;
{
316 317 318
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos + 1;

319 320 321 322 323 324 325 326 327 328 329
  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;
{
330 331 332
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos - 1;

333 334 335
  DEC_POS (bytepos);
  return bytepos;
}
336

Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340
/* 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,
341
   only the beginning of the buffer is treated as a defun-start.
Richard M. Stallman's avatar
Richard M. Stallman committed
342 343 344 345

   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.
346 347 348 349

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

static int
352 353
find_defun_start (pos, pos_byte)
     int pos, pos_byte;
354
{
355
  int opoint = PT, opoint_byte = PT_BYTE;
356

357 358 359 360 361 362
  if (!open_paren_in_column_0_is_defun_start)
    {
      find_start_value_byte = BEGV_BYTE;
      return BEGV;
    }

363 364 365 366 367 368 369 370 371 372 373 374
  /* 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.  */
375
  scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
376

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

  /* Record what we found, for the next try.  */
400 401
  find_start_value = PT;
  find_start_value_byte = PT_BYTE;
402 403 404 405 406
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

407 408
  TEMP_SET_PT_BOTH (opoint, opoint_byte);

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

430 431 432 433 434
/* static int
 * prev_char_comstart_first (pos, pos_byte)
 *      int pos, pos_byte;
 * {
 *   int c, val;
Juanma Barranquero's avatar
Juanma Barranquero committed
435
 *
436 437 438 439 440 441 442
 *   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;
 * } */
443

444 445 446 447 448 449 450 451 452
/* 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.
453 454 455

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

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

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

504
      /* Move back and examine a character.  */
505
      DEC_BOTH (from, from_byte);
506 507
      UPDATE_SYNTAX_TABLE_BACKWARD (from);

508
      prev_syntax = syntax;
509
      c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
510
      syntax = SYNTAX_WITH_FLAGS (c);
511 512
      code = SYNTAX (c);

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
      /* 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))
534
	{
535 536 537
	  int next = from, next_byte = from_byte, next_c, next_syntax;
	  DEC_BOTH (next, next_byte);
	  UPDATE_SYNTAX_TABLE_BACKWARD (next);
538
	  next_c = FETCH_CHAR_AS_MULTIBYTE (next_byte);
539 540 541 542 543 544 545 546 547 548
	  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); */
549
	}
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566

      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))
567
	continue;
568

569 570
      /* Ignore escaped characters, except comment-enders.  */
      if (code != Sendcomment && char_quoted (from, from_byte))
571 572
	continue;

573
      switch (code)
574
	{
575 576 577 578 579 580 581 582 583 584 585 586 587 588
	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.  */
589
	    string_lossage = 1;
590
	  break;
Juanma Barranquero's avatar
Juanma Barranquero committed
591

592 593
	case Scomment:
	  /* We've already checked that it is the relevant comstyle.  */
594
	  if (string_style != -1 || comment_lossage || string_lossage)
595 596 597 598
	    /* There are odd string quotes involved, so let's be careful.
	       Test case in Pascal: " { " a { " } */
	    goto lossage;

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

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

638 639 640 641 642 643 644 645 646 647 648
	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.  */
	    }
649
	  break;
650 651

	default:
652
	  break;
653
	}
654 655 656 657 658
    }

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

709
      from_byte = CHAR_TO_BYTE (from);
710 711
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
712

713
 done:
714 715 716
  *charpos_ptr = from;
  *bytepos_ptr = from_byte;

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

732
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
733 734 735
check_syntax_table (obj)
     Lisp_Object obj;
{
736
  if (!(CHAR_TABLE_P (obj)
737
	&& EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table)))
738
    wrong_type_argument (Qsyntax_table_p, obj);
Juanma Barranquero's avatar
Juanma Barranquero committed
739
}
Richard M. Stallman's avatar
Richard M. Stallman committed
740 741

DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
742 743 744
       doc: /* Return the current syntax table.
This is the one specified by the current buffer.  */)
     ()
Richard M. Stallman's avatar
Richard M. Stallman committed
745 746 747 748 749 750
{
  return current_buffer->syntax_table;
}

DEFUN ("standard-syntax-table", Fstandard_syntax_table,
   Sstandard_syntax_table, 0, 0, 0,
751 752 753
       doc: /* Return the standard syntax table.
This is the one used for new buffers.  */)
     ()
Richard M. Stallman's avatar
Richard M. Stallman committed
754 755 756 757 758
{
  return Vstandard_syntax_table;
}

DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
759 760 761
       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
762 763
     Lisp_Object table;
{
764 765
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
766
  if (!NILP (table))
767 768 769 770 771
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
772 773 774 775 776 777 778 779 780 781

  /* 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);
782
  return copy;
Richard M. Stallman's avatar
Richard M. Stallman committed
783 784 785
}

DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
786 787 788
       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
789 790
     Lisp_Object table;
{
791
  int idx;
792
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
793 794
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
795 796
  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
797 798 799 800 801
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
802
 This is used by modify-syntax-entry, and other things.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
803 804 805 806 807 808

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

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

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

/* 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
841 842

DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
843 844 845 846 847 848
       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)
849
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
850
{
851
  int char_int;
852 853 854
  gl_state.current_syntax_table = current_buffer->syntax_table;

  gl_state.use_global = 0;
855
  CHECK_NUMBER (character);
856
  char_int = XINT (character);
857
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
858 859 860
}

DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
861 862
       doc: /* Return the matching parenthesis of CHARACTER, or nil if none.  */)
     (character)
863
     Lisp_Object character;
864
{
865
  int char_int, code;
866 867
  gl_state.current_syntax_table = current_buffer->syntax_table;
  gl_state.use_global = 0;
868
  CHECK_NUMBER (character);
869
  char_int = XINT (character);
870
  code = SYNTAX (char_int);
871
  if (code == Sopen || code == Sclose)
872
    return SYNTAX_MATCH (char_int);
873
  return Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
874 875
}

876
DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
877 878 879 880 881 882
       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)
883
     Lisp_Object string;
Richard M. Stallman's avatar
Richard M. Stallman committed
884
{
885
  register const unsigned char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
886
  register enum syntaxcode code;
887
  int val;
888
  Lisp_Object match;
Richard M. Stallman's avatar
Richard M. Stallman committed
889

890
  CHECK_STRING (string);
Richard M. Stallman's avatar
Richard M. Stallman committed
891

892
  p = SDATA (string);
Richard M. Stallman's avatar
Richard M. Stallman committed
893 894
  code = (enum syntaxcode) syntax_spec_code[*p++];
  if (((int) code & 0377) == 0377)
895
    error ("invalid syntax description letter: %c", p[-1]);
Richard M. Stallman's avatar
Richard M. Stallman committed
896

897
  if (code == Sinherit)
898
    return Qnil;
899 900

  if (*p)
901
    {
Karl Heuer's avatar
Karl Heuer committed
902
      int len;
903
      int character = (STRING_CHAR_AND_LENGTH
904
		       (p, SBYTES (string) - 1, len));
Karl Heuer's avatar
Karl Heuer committed
905
      XSETINT (match, character);
906 907
      if (XFASTINT (match) == ' ')
	match = Qnil;
Karl Heuer's avatar
Karl Heuer committed
908
      p += len;
909 910
    }
  else
911
    match = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
912

913
  val = (int) code;
Richard M. Stallman's avatar
Richard M. Stallman committed
914 915 916 917
  while (*p)
    switch (*p++)
      {
      case '1':
918
	val |= 1 << 16;
Richard M. Stallman's avatar
Richard M. Stallman committed
919 920 921
	break;

      case '2':
922
	val |= 1 << 17;
Richard M. Stallman's avatar
Richard M. Stallman committed
923 924 925
	break;

      case '3':
926
	val |= 1 << 18;
Richard M. Stallman's avatar
Richard M. Stallman committed
927 928 929
	break;

      case '4':
930
	val |= 1 << 19;
Richard M. Stallman's avatar
Richard M. Stallman committed
931 932 933
	break;

      case 'p':
934
	val |= 1 << 20;
Richard M. Stallman's avatar
Richard M. Stallman committed
935
	break;
936 937

      case 'b':
938
	val |= 1 << 21;
939
	break;
940 941 942 943

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

Karl Heuer's avatar
Karl Heuer committed
946
  if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
947
    return XVECTOR (Vsyntax_code_object)->contents[val];
Karl Heuer's avatar
Karl Heuer committed
948 949
  else
    /* Since we can't use a shared object, let's make a new one.  */
950 951 952
    return Fcons (make_number (val), match);
}

953
/* I really don't know why this is interactive
Stefan Monnier's avatar
Stefan Monnier committed
954
   help-form should at least be made useful whilst reading the second arg.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
955
DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3,
956
  "cSet syntax for character: \nsSet syntax for %s to: ",
957
       doc: /* Set syntax for character CHAR according to string NEWENTRY.
958 959
The syntax is changed only for table SYNTAX_TABLE, which defaults to
 the current buffer's syntax table.
960 961
CHAR may be a cons (MIN . MAX), in which case, syntaxes of all characters
in the range MIN and MAX are changed.
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
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.
978 979 980 981
 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.
982 983 984 985 986 987

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:
988 989
 b means CHAR is part of comment sequence b.
 n means CHAR is part of a nestable comment sequence.
990

991
 p means CHAR is a prefix character for `backward-prefix-chars';
992
   such characters are treated as whitespace when they occur
993 994
   between expressions.
usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
995
     (c, newentry, syntax_table)
996 997
     Lisp_Object c, newentry, syntax_table;
{
998 999
  if (CONSP (c))
    {
Kenichi Handa's avatar
Kenichi Handa committed
1000 1001
      CHECK_CHARACTER_CAR (c);
      CHECK_CHARACTER_CDR (c);
1002 1003 1004
    }
  else
    CHECK_CHARACTER (c);
1005 1006 1007 1008 1009

  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
1010

1011 1012 1013 1014 1015
  newentry = Fstring_to_syntax (newentry);
  if (CONSP (c))
    SET_RAW_SYNTAX_ENTRY_RANGE (syntax_table, c, newentry);
  else
    SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), newentry);
Richard M. Stallman's avatar
Richard M. Stallman committed
1016 1017 1018 1019 1020
  return Qnil;
}

/* Dump syntax table to buffer in human-readable format */

1021 1022 1023 1024 1025
DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value,
       Sinternal_describe_syntax_value, 1, 1, 0,
       doc: /* Insert a description of the internal syntax description SYNTAX at point.  */)
     (syntax)
     Lisp_Object syntax;
Richard M. Stallman's avatar
Richard M. Stallman committed
1026 1027
{
  register enum syntaxcode code;
1028
  char desc, start1, start2, end1, end2, prefix, comstyle, comnested;
Richard M. Stallman's avatar
Richard M. Stallman committed
1029
  char str[2];
1030
  Lisp_Object first, match_lisp, value = syntax;
Richard M. Stallman's avatar
Richard M. Stallman committed
1031

1032 1033
  if (NILP (value))
    {
1034 1035
      insert_string ("default");
      return syntax;
1036 1037
    }

1038 1039
  if (CHAR_TABLE_P (value))
    {
1040 1041
      insert_string ("deeper char-table ...");
      return syntax;
1042 1043
    }

1044 1045
  if (!CONSP (value))
    {
1046 1047
      insert_string ("invalid");
      return syntax;
1048 1049
    }

1050 1051
  first = XCAR (value);
  match_lisp = XCDR (value);
1052 1053

  if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1054
    {
1055 1056
      insert_string ("invalid");
      return syntax;
Richard M. Stallman's avatar
Richard M. Stallman committed
1057 1058
    }

1059
  code = (enum syntaxcode) (XINT (first) & 0377);
1060 1061 1062 1063 1064 1065
  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;
1066
  comnested = (XINT (first) >> 22) & 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1067 1068 1069 1070

  if ((int) code < 0 || (int) code >= (int) Smax)
    {
      insert_string ("invalid");
1071
      return syntax;
Richard M. Stallman's avatar
Richard M. Stallman committed
1072 1073 1074 1075 1076 1077
    }
  desc = syntax_code_spec[(int) code];

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

Karl Heuer's avatar
Karl Heuer committed
1078 1079 1080 1081
  if (NILP (match_lisp))
    insert (" ", 1);
  else
    insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

  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);
1095 1096
  if (comstyle)
    insert ("b", 1);
1097 1098
  if (comnested)
    insert ("n", 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
1099 1100 1101

  insert_string ("\twhich means: ");

1102
  switch (SWITCH_ENUM_CAST (code))
Richard M. Stallman's avatar
Richard M. Stallman committed
1103 1104 1105 1106 1107 1108 1109 1110