syntax.c 75.7 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
/* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2
   Copyright (C) 1985, 87, 93, 94, 95, 97, 1998 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 51 52
/* 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;

53 54 55 56
/* This is the internal form of the parse state used in parse-partial-sexp.  */

struct lisp_parse_state
  {
57 58 59 60
    int depth;		/* Depth at end of parsing.  */
    int instring;	/* -1 if not within string, else desired terminator.  */
    int incomment;	/* Nonzero if within a comment at end of parsing.  */
    int comstyle;	/* comment style a=0, or b=1, or ST_COMMENT_STYLE.  */
61 62 63
    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 */
64
    int location;	/* Char number at which parsing stopped.  */
65
    int mindepth;	/* Minimum depth seen while scanning.  */
66
    int comstr_start;	/* Position just after last comment/string starter.  */
67 68
  };

69 70 71
/* 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.
72
   find_start_value_byte is the corresponding byte position.
73 74 75 76 77 78
   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;
79
static int find_start_value_byte;
80 81 82
static struct buffer *find_start_buffer;
static int find_start_begv;
static int find_start_modiff;
83 84 85 86 87 88 89 90 91 92


static int find_defun_start P_ ((int, int));
static int back_comment P_ ((int, int, int, int, int *, int *));
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));
93 94 95 96 97 98 99 100


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

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

106
   `gl_state.*_i' are the intervals, and CHARPOS is further in the search
107 108
   direction than the intervals - or in an interval.  We update the
   current syntax-table basing on the property of this interval, and
109
   update the interval to start further than CHARPOS - or be
110
   NULL_INTERVAL.  We also update lim_property to be the next value of
111
   charpos to call this subroutine again - or be before/after the
112 113 114
   start/end of OBJECT.  */

void
115 116
update_syntax_table (charpos, count, init, object)
     int charpos, count, init;
117 118 119 120 121 122 123 124 125 126
     Lisp_Object object;
{
  Lisp_Object tmp_table;
  int cnt = 0, doing_extra = 0, invalidate = 1;
  INTERVAL i, oldi;

  if (init)
    {
      gl_state.start = gl_state.b_property;
      gl_state.stop = gl_state.e_property;
127
      gl_state.forward_i = interval_of (charpos, object);
128 129 130 131 132
      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;
133 134
      gl_state.b_property = i->position - 1 - gl_state.offset;
      gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
135 136 137 138
      goto update;
    }
  oldi = i = count > 0 ? gl_state.forward_i : gl_state.backward_i;

139 140
  /* We are guarantied to be called with CHARPOS either in i,
     or further off.  */
141 142
  if (NULL_INTERVAL_P (i))
    error ("Error in syntax_table logic for to-the-end intervals");
143
  else if (charpos < i->position)		/* Move left.  */
144 145 146 147
    {
      if (count > 0)
	error ("Error in syntax_table logic for intervals <-.");
      /* Update the interval.  */
148
      i = update_interval (i, charpos);
149 150 151 152 153
      if (oldi->position != INTERVAL_LAST_POS (i))
	{
	  invalidate = 0;
	  gl_state.right_ok = 1;	/* Invalidate the other end.  */
	  gl_state.forward_i = i;
154
	  gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
155 156
	}
    } 
157
  else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right.  */
158 159 160 161
    {
      if (count < 0)
	error ("Error in syntax_table logic for intervals ->.");
      /* Update the interval.  */
162
      i = update_interval (i, charpos);
163 164 165 166 167
      if (i->position != INTERVAL_LAST_POS (oldi))
	{
	  invalidate = 0;
	  gl_state.left_ok = 1;		/* Invalidate the other end.  */
	  gl_state.backward_i = i;
168
	  gl_state.b_property = i->position - 1 - gl_state.offset;
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
	}
    }
  else if (count > 0 ? gl_state.right_ok : gl_state.left_ok)
    {
      /* We do not need to recalculate tmp_table.  */
      tmp_table = gl_state.old_prop;
    }

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

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

200 201
  gl_state.current_syntax_table = tmp_table;
  gl_state.old_prop = tmp_table;
202
  if (EQ (Fsyntax_table_p (tmp_table), Qt))
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
    {
      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) 
	{
249
	  gl_state.e_property = i->position - gl_state.offset;
250 251 252 253
	  gl_state.forward_i = i;
	}
      else 
	{
254
	  gl_state.b_property = i->position + LENGTH (i) - 1 - gl_state.offset;
255 256 257 258 259
	  gl_state.backward_i = i;
	}
    }    
}

260 261 262
/* 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. */
263 264

static int
265 266
char_quoted (charpos, bytepos)
     register int charpos, bytepos;
267 268 269 270
{
  register enum syntaxcode code;
  register int beg = BEGV;
  register int quoted = 0;
271 272 273
  int orig = charpos;

  DEC_BOTH (charpos, bytepos);
274

275
  while (bytepos >= beg)
276
    {
277 278 279 280 281 282 283
      UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
      code = SYNTAX (FETCH_CHAR (bytepos));
      if (! (code == Scharquote || code == Sescape))
	break;

      DEC_BOTH (charpos, bytepos);
      quoted = !quoted;
284
    }
285 286

  UPDATE_SYNTAX_TABLE (orig);
287 288
  return quoted;
}
289 290 291 292 293 294 295 296

/* 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;
{
297 298 299
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos + 1;

300 301 302 303 304 305 306 307 308 309 310
  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;
{
311 312 313
  if (NILP (current_buffer->enable_multibyte_characters))
    return bytepos - 1;

314 315 316
  DEC_POS (bytepos);
  return bytepos;
}
317

318 319
/* Find a defun-start that is the last one before POS (or nearly the last).
   We record what we find, so that another call in the same area
320 321 322 323 324
   can return the same value right away.  

   There is no promise at which position the global syntax data is
   valid on return from the subroutine, so the caller should explicitly
   update the global data.  */
325 326

static int
327 328
find_defun_start (pos, pos_byte)
     int pos, pos_byte;
329 330 331
{
  int tem;
  int shortage;
332
  int opoint = PT, opoint_byte = PT_BYTE;
333 334 335 336 337 338 339 340 341 342 343 344 345

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

348 349 350 351 352
  /* 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;
353
  while (PT > BEGV)
354 355
    {
      /* Open-paren at start of line means we found our defun-start.  */
356
      if (SYNTAX (FETCH_CHAR (PT_BYTE)) == Sopen)
357
	{
358 359
	  SETUP_SYNTAX_TABLE (PT + 1, -1);	/* Try again... */
	  if (SYNTAX (FETCH_CHAR (PT_BYTE)) == Sopen)
360 361 362 363 364
	    break;
	  /* Now fallback to the default value.  */
	  gl_state.current_syntax_table = current_buffer->syntax_table;
	  gl_state.use_global = 0;
	}
365
      /* Move to beg of previous line.  */
366
      scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
367 368 369
    }

  /* Record what we found, for the next try.  */
370 371
  find_start_value = PT;
  find_start_value_byte = PT_BYTE;
372 373 374 375 376
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

377 378
  TEMP_SET_PT_BOTH (opoint, opoint_byte);

379 380 381
  return find_start_value;
}

382 383 384 385 386 387 388 389 390
/* 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.
391 392 393

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

static int
396 397 398 399
back_comment (from, from_byte, stop, comstyle, charpos_ptr, bytepos_ptr)
     int from, from_byte, stop;
     int comstyle;
     int *charpos_ptr, *bytepos_ptr;
400 401 402 403 404 405 406 407 408 409 410 411 412 413
{
  /* Look back, counting the parity of string-quotes,
     and recording the comment-starters seen.
     When we reach a safe place, assume that's not in a string;
     then step the main scan to the earliest comment-starter seen
     an even number of string quotes away from the safe place.

     OFROM[I] is position of the earliest comment-starter seen
     which is I+2X quotes from the comment-end.
     PARITY is current parity of quotes from the comment end.  */
  int parity = 0;
  int my_stringend = 0;
  int string_lossage = 0;
  int comment_end = from;
414
  int comment_end_byte = from_byte;
415
  int comstart_pos = 0;
416
  int comstart_byte;
417 418 419
  /* Value that PARITY had, when we reached the position
     in COMSTART_POS.  */
  int comstart_parity = 0;
420
  int scanstart = from - 1;
421 422 423 424
  /* 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;
425
  register enum syntaxcode code;
426
  int c;
427 428 429 430 431

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

434
      /* Move back and examine a character.  */
435
      DEC_BOTH (from, from_byte);
436 437
      UPDATE_SYNTAX_TABLE_BACKWARD (from);

438
      c = FETCH_CHAR (from_byte);
439 440
      code = SYNTAX (c);

441
      /* If this char is the second of a 2-char comment end sequence,
442 443
	 back up and give the pair the appropriate syntax.  */
      if (from > stop && SYNTAX_COMEND_SECOND (c)
444 445
	  && (temp_byte = dec_bytepos (from_byte),
	      SYNTAX_COMEND_FIRST (FETCH_CHAR (temp_byte))))
446 447
	{
	  code = Sendcomment;
448
	  DEC_BOTH (from, from_byte);
449 450
	  /* This is apparently the best we can do: */
	  UPDATE_SYNTAX_TABLE_BACKWARD (from);
451
	  c = FETCH_CHAR (from_byte);
452 453 454 455
	}
			
      /* If this char starts a 2-char comment start sequence,
	 treat it like a 1-char comment starter.  */
456
      if (from < scanstart && SYNTAX_COMSTART_FIRST (c)
457 458 459
	  && (temp_byte = inc_bytepos (from_byte),
	      (SYNTAX_COMSTART_SECOND (FETCH_CHAR (temp_byte))
	       && comstyle == SYNTAX_COMMENT_STYLE (FETCH_CHAR (temp_byte)))))
460
	code = Scomment;
461

462 463
      /* Ignore escaped characters, except comment-enders.  */
      if (code != Sendcomment && char_quoted (from, from_byte))
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
	continue;

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

      if (code == Sstring_fence || code == Scomment_fence)
	{
	  parity ^= 1;
	  if (my_stringend == 0)
482 483
	    my_stringend
	      = code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE;
484 485 486 487 488 489 490 491 492 493 494 495 496
	  /* If we have two kinds of string delimiters.
	     There's no way to grok this scanning backwards.  */
	  else if (my_stringend != (code == Sstring_fence 
				    ? ST_STRING_STYLE : ST_COMMENT_STYLE))
	    string_lossage = 1;
	}

      /* Record comment-starters according to that
	 quote-parity to the comment-end.  */
      if (code == Scomment)
	{
	  comstart_parity = parity;
	  comstart_pos = from;
497
	  comstart_byte = from_byte;
498 499 500 501 502 503
	}

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

      /* Assume a defun-start point is outside of strings.  */
      if (code == Sopen
509 510 511
	  && (from == stop
	      || (temp_byte = dec_bytepos (from_byte),
		  FETCH_CHAR (temp_byte) == '\n')))
512 513 514 515 516
	{
	  defun_start = from;
	  defun_start_byte = from_byte;
	  break;
	}
517 518 519 520 521
    }

  if (comstart_pos == 0)
    {
      from = comment_end;
522
      from_byte = comment_end_byte;
523 524 525 526 527 528 529 530 531 532
      UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
    }
  /* If the earliest comment starter
     is followed by uniform paired string quotes or none,
     we know it can't be inside a string
     since if it were then the comment ender would be inside one.
     So it does start a comment.  Skip back to it.  */
  else if (comstart_parity == 0 && !string_lossage) 
    {
      from = comstart_pos;
533
      from_byte = comstart_byte;
534 535 536 537 538 539 540 541 542 543
      /* Globals are correct now.  */
    }
  else
    {
      /* We had two kinds of string delimiters mixed up
	 together.  Decode this going forwards.
	 Scan fwd from the previous comment ender
	 to the one in question; this records where we
	 last passed a comment starter.  */
      struct lisp_parse_state state;
544 545 546 547 548 549
      /* 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;
	}
550
      scan_sexps_forward (&state,
551
			  defun_start, defun_start_byte,
552 553 554 555 556 557 558 559 560 561 562 563
			  comment_end - 1, -10000, 0, Qnil, 0);
      if (state.incomment)
	{
	  /* scan_sexps_forward changed the direction of search in
	     global variables, so we need to update it completely.  */
	  
	  from = state.comstr_start;
	}
      else
	{
	  from = comment_end;	  
	}
564
      from_byte = CHAR_TO_BYTE (from);
565 566 567
      UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
    }
    
568 569 570
  *charpos_ptr = from;
  *bytepos_ptr = from_byte;

571 572 573
  return from;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
574
DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
575
  "Return t if OBJECT is a syntax table.\n\
576
Currently, any char-table counts as a syntax table.")
577 578
  (object)
     Lisp_Object object;
Richard M. Stallman's avatar
Richard M. Stallman committed
579
{
580
  if (CHAR_TABLE_P (object)
581
      && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
Richard M. Stallman's avatar
Richard M. Stallman committed
582 583 584 585
    return Qt;
  return Qnil;
}

586
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588 589
check_syntax_table (obj)
     Lisp_Object obj;
{
590
  if (!(CHAR_TABLE_P (obj)
591
	&& EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table)))
592
    wrong_type_argument (Qsyntax_table_p, obj);
Richard M. Stallman's avatar
Richard M. Stallman committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
}   

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;
{
618 619
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
620
  if (!NILP (table))
621 622 623 624 625
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
626 627 628 629 630 631 632 633 634 635

  /* 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);
636
  return copy;
Richard M. Stallman's avatar
Richard M. Stallman committed
637 638 639 640 641 642 643 644
}

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;
{
645
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
646 647
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
648 649
  current_buffer->local_var_flags
    |= XFASTINT (buffer_local_flags.syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
650 651 652 653 654
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
655
 This is used by modify-syntax-entry, and other things.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
656 657 658 659 660 661

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,
662
    (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
Richard M. Stallman's avatar
Richard M. Stallman committed
663 664 665 666 667 668
        (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,
669
    (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377,   /* @, A ... */
Richard M. Stallman's avatar
Richard M. Stallman committed
670 671 672 673 674 675
    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,
676
    0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
Richard M. Stallman's avatar
Richard M. Stallman committed
677 678
  };

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

681
char syntax_code_spec[16] =
Richard M. Stallman's avatar
Richard M. Stallman committed
682
  {
683 684
    ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
    '!', '|'
Richard M. Stallman's avatar
Richard M. Stallman committed
685
  };
Karl Heuer's avatar
Karl Heuer committed
686 687 688 689 690 691 692 693

/* 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
694

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
/* 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
718
DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
719 720 721
  "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
722 723
The characters that correspond to various syntax codes\n\
are listed in the documentation of `modify-syntax-entry'.")
724 725
  (character)
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
726
{
727
  int char_int;
728 729 730
  gl_state.current_syntax_table = current_buffer->syntax_table;

  gl_state.use_global = 0;
731 732
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
733
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
734 735 736
}

DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
737 738 739
  "Return the matching parenthesis of CHARACTER, or nil if none.")
  (character)
     Lisp_Object character;
740
{
741
  int char_int, code;
742 743
  gl_state.current_syntax_table = current_buffer->syntax_table;
  gl_state.use_global = 0;
744 745
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
746
  code = SYNTAX (char_int);
747
  if (code == Sopen || code == Sclose)
748
    return SYNTAX_MATCH (char_int);
749
  return Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752 753 754 755
}

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

756
DEFUN ("modify-syntax-entry", foo, bar, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
757 758 759 760
  "Set syntax for character CHAR according to string S.\n\
The syntax is changed only for table TABLE, which defaults to\n\
 the current buffer's syntax table.\n\
The first character of S should be one of the following:\n\
Jim Blandy's avatar
Jim Blandy committed
761 762 763 764 765
  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\
766
  <           comment starter.      >   comment ender.\n\
767
  /           character-quote.      @   inherit from `standard-syntax-table'.\n\
768
\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
769 770 771 772 773
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\
774
Defined flags are the characters 1, 2, 3, 4, b, and p.\n\
775 776 777 778
 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\
779
\n\
780
There can be up to two orthogonal comment sequences.  This is to support\n\
781
language modes such as C++.  By default, all comment sequences are of style\n\
782 783
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\
784
this flag:\n\
785
 b means CHAR is part of comment sequence b.\n\
786
\n\
787
 p means CHAR is a prefix character for `backward-prefix-chars';\n\
788
   such characters are treated as whitespace when they occur\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
789
   between expressions.")
790
  (char, s, table)
Richard M. Stallman's avatar
Richard M. Stallman committed
791 792 793 794 795 796 797 798 799 800 801
*/

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;
{
802
  register unsigned char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
803
  register enum syntaxcode code;
804
  int val;
805
  Lisp_Object match;
Richard M. Stallman's avatar
Richard M. Stallman committed
806 807 808

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

Jim Blandy's avatar
Jim Blandy committed
810
  if (NILP (syntax_table))
Richard M. Stallman's avatar
Richard M. Stallman committed
811 812
    syntax_table = current_buffer->syntax_table;
  else
813
    check_syntax_table (syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
814 815 816 817

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

820 821
  if (code == Sinherit)
    {
822
      SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), Qnil);
823 824 825 826
      return Qnil;
    }

  if (*p)
827
    {
Karl Heuer's avatar
Karl Heuer committed
828 829 830 831
      int len;
      int character = STRING_CHAR_AND_LENGTH (p, XSTRING (newentry)->size - 1,
					      len);
      XSETINT (match, character);
832 833
      if (XFASTINT (match) == ' ')
	match = Qnil;
Karl Heuer's avatar
Karl Heuer committed
834
      p += len;
835 836
    }
  else
837
    match = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
838

839
  val = (int) code;
Richard M. Stallman's avatar
Richard M. Stallman committed
840 841 842 843
  while (*p)
    switch (*p++)
      {
      case '1':
844
	val |= 1 << 16;
Richard M. Stallman's avatar
Richard M. Stallman committed
845 846 847
	break;

      case '2':
848
	val |= 1 << 17;
Richard M. Stallman's avatar
Richard M. Stallman committed
849 850 851
	break;

      case '3':
852
	val |= 1 << 18;
Richard M. Stallman's avatar
Richard M. Stallman committed
853 854 855
	break;

      case '4':
856
	val |= 1 << 19;
Richard M. Stallman's avatar
Richard M. Stallman committed
857 858 859
	break;

      case 'p':
860
	val |= 1 << 20;
Richard M. Stallman's avatar
Richard M. Stallman committed
861
	break;
862 863

      case 'b':
864
	val |= 1 << 21;
865
	break;
Richard M. Stallman's avatar
Richard M. Stallman committed
866 867
      }
	
Karl Heuer's avatar
Karl Heuer committed
868 869 870 871 872 873
  if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
    newentry = XVECTOR (Vsyntax_code_object)->contents[val];
  else
    /* Since we can't use a shared object, let's make a new one.  */
    newentry = Fcons (make_number (val), match);
    
874
  SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), newentry);
Richard M. Stallman's avatar
Richard M. Stallman committed
875 876 877 878 879 880

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

881
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
882 883 884 885
describe_syntax (value)
    Lisp_Object value;
{
  register enum syntaxcode code;
886
  char desc, match, start1, start2, end1, end2, prefix, comstyle;
Richard M. Stallman's avatar
Richard M. Stallman committed
887
  char str[2];
888
  Lisp_Object first, match_lisp;
Richard M. Stallman's avatar
Richard M. Stallman committed
889 890 891

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

892 893
  if (NILP (value))
    {
Karl Heuer's avatar
Karl Heuer committed
894
      insert_string ("default\n");
895 896 897
      return;
    }

898 899 900 901 902 903
  if (CHAR_TABLE_P (value))
    {
      insert_string ("deeper char-table ...\n");
      return;
    }

904 905
  if (!CONSP (value))
    {
Karl Heuer's avatar
Karl Heuer committed
906
      insert_string ("invalid\n");
907 908 909 910 911 912 913
      return;
    }

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

  if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
914
    {
Karl Heuer's avatar
Karl Heuer committed
915
      insert_string ("invalid\n");
Richard M. Stallman's avatar
Richard M. Stallman committed
916 917 918
      return;
    }

919
  code = (enum syntaxcode) (XINT (first) & 0377);
920 921 922 923 924 925
  start1 = (XINT (first) >> 16) & 1;
  start2 = (XINT (first) >> 17) & 1;
  end1 = (XINT (first) >> 18) & 1;
  end2 = (XINT (first) >> 19) & 1;
  prefix = (XINT (first) >> 20) & 1;
  comstyle = (XINT (first) >> 21) & 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
926 927 928 929 930 931 932 933 934 935 936

  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
937 938 939 940
  if (NILP (match_lisp))
    insert (" ", 1);
  else
    insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
941 942 943 944 945 946 947 948 949 950 951 952 953

  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);
954 955
  if (comstyle)
    insert ("b", 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
956 957 958

  insert_string ("\twhich means: ");

959
  switch (SWITCH_ENUM_CAST (code))
Richard M. Stallman's avatar
Richard M. Stallman committed
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
    {
    case Swhitespace:
      insert_string ("whitespace"); break;
    case Spunct:
      insert_string ("punctuation"); break;
    case Sword:
      insert_string ("word"); break;
    case Ssymbol:
      insert_string ("symbol"); break;
    case Sopen:
      insert_string ("open"); break;
    case Sclose:
      insert_string ("close"); break;
    case Squote:
      insert_string ("quote"); break;
    case Sstring:
      insert_string ("string"); break;
    case Smath:
      insert_string ("math"); break;
    case Sescape:
      insert_string ("escape"); break;
    case Scharquote:
      insert_string ("charquote"); break;
    case Scomment:
      insert_string ("comment"); break;
    case Sendcomment:
      insert_string ("endcomment"); break;
    default:
      insert_string ("invalid");
      return;
    }

992
  if (!NILP (match_lisp))
Richard M. Stallman's avatar
Richard M. Stallman committed
993 994
    {
      insert_string (", matches ");
995
      insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
996 997 998 999 1000 1001 1002 1003 1004 1005 1006
    }

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
1010 1011 1012 1013 1014 1015
  if (prefix)
    insert_string (",\n\t  is a prefix character for `backward-prefix-chars'");

  insert_string ("\n");
}

1016
static Lisp_Object
Richard M. Stallman's avatar
Richard M. Stallman committed
1017 1018 1019 1020 1021
describe_syntax_1 (vector)
     Lisp_Object vector;
{
  struct buffer *old = current_buffer;
  set_buffer_internal (XBUFFER (Vstandard_output));
1022
  describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil, (int *) 0, 0);
Karl Heuer's avatar
Karl Heuer committed
1023 1024 1025 1026
  while (! NILP (XCHAR_TABLE (vector)->parent))
    {
      vector = XCHAR_TABLE (vector)->parent;
      insert_string ("\nThe parent syntax table is:");
1027 1028
      describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil,
		       (int *) 0, 0);
Karl Heuer's avatar
Karl Heuer committed
1029 1030
    }
	
1031
  call0 (intern ("help-mode"));
Richard M. Stallman's avatar
Richard M. Stallman committed
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
  set_buffer_internal (old);
  return Qnil;
}

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

  return Qnil;
}

1047 1048
int parse_sexp_ignore_comments;

Richard M. Stallman's avatar
Richard M. Stallman committed
1049 1050 1051 1052 1053 1054 1055 1056 1057
/* Return the position across COUNT words from FROM.
   If that many words cannot be found before the end of the buffer, return 0.
   COUNT negative means scan backward and stop at word beginning.  */

scan_words (from, count)
     register int from, count;
{
  register int beg = BEGV;
  register int end = ZV;
1058
  register int from_byte = CHAR_TO_BYTE (from);
Karl Heuer's avatar
Karl Heuer committed
1059 1060
  register enum syntaxcode code;
  int ch0, ch1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1061 1062 1063 1064

  immediate_quit = 1;
  QUIT;

1065 1066
  SETUP_SYNTAX_TABLE (from, count);

Richard M. Stallman's avatar
Richard M. Stallman committed
1067 1068 1069 1070 1071 1072 1073 1074 1075
  while (count > 0)
    {
      while (1)
	{
	  if (from == end)
	    {
	      immediate_quit = 0;
	      return 0;
	    }
1076
	  UPDATE_SYNTAX_TABLE_FORWARD (from);
1077
	  ch0 = FETCH_CHAR (from_byte);
Karl Heuer's avatar
Karl Heuer committed
1078
	  code = SYNTAX (ch0);
1079
	  INC_BOTH (from, from_byte);
Richard M. Stallman's avatar
Richard M. Stallman committed
1080 1081 1082 1083 1084 1085
	  if (words_include_escapes
	      && (code == Sescape || code == Scharquote))
	    break;
	  if (code == Sword)
	    break;
	}
Karl Heuer's avatar
Karl Heuer committed
1086 1087
      /* Now CH0 is a character which begins a word and FROM is the
         position of the next character.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
1088 1089 1090
      while (1)
	{
	  if (from == end) break;
1091
	  UPDATE_SYNTAX_TABLE_FORWARD (from);
1092
	  ch1 = FETCH_CHAR (from_byte);
Karl Heuer's avatar
Karl Heuer committed
1093
	  code = SYNTAX (ch1);
Richard M. Stallman's avatar
Richard M. Stallman committed
1094 1095
	  if (!(words_include_escapes
		&& (code == Sescape || code == Scharquote)))
Karl Heuer's avatar
Karl Heuer committed
1096
	    if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
Richard M. Stallman's avatar
Richard M. Stallman committed
1097
	      break;
1098
	  INC_BOTH (from, from_byte);
Karl Heuer's avatar
Karl Heuer committed
1099
	  ch0 = ch1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
	}
      count--;
    }
  while (count < 0)
    {
      while (1)
	{
	  if (from == beg)
	    {
	      immediate_quit = 0;
	      return 0;
	    }
1112
	  DEC_BOTH (from, from_byte);
1113
	  UPDATE_SYNTAX_TABLE_BACKWARD (from);
1114
	  ch1 = FETCH_CHAR (from_byte);
Karl Heuer's avatar
Karl Heuer committed
1115
	  code = SYNTAX (ch1);
Richard M. Stallman's avatar
Richard M. Stallman committed
1116 1117 1118 1119 1120 1121
	  if (words_include_escapes
	      && (code == Sescape || code == Scharquote))
	    break;
	  if (code == Sword)
	    break;
	}
Karl Heuer's avatar
Karl Heuer committed
1122 1123
      /* Now CH1 is a character which ends a word and FROM is the
         position of it.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
1124 1125
      while (1)
	{
1126 1127 1128 1129 1130
	  int temp_byte;

	  if (from == beg)
	    break;
	  temp_byte = dec_bytepos (from_byte);
1131
	  UPDATE_SYNTAX_TABLE_BACKWARD (from);
1132
	  ch0 = FETCH_CHAR (temp_byte);
Karl Heuer's avatar
Karl Heuer committed
1133
	  code = SYNTAX (ch0);
Richard M. Stallman's avatar
Richard M. Stallman committed
1134 1135
	  if (!(words_include_escapes
		&& (code == Sescape || code == Scharquote)))
Karl Heuer's avatar
Karl Heuer committed
1136
	    if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
Richard M. Stallman's avatar
Richard M. Stallman committed
1137
	      break;
1138
	  DEC_BOTH (from, from_byte);
Karl Heuer's avatar
Karl Heuer committed
1139
	  ch1 = ch0;
Richard M. Stallman's avatar
Richard M. Stallman committed
1140 1141 1142 1143