syntax.c 49.6 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, 1987, 1993, 1994, 1995 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 27 28
#include <ctype.h>
#include "lisp.h"
#include "commands.h"
#include "buffer.h"
#include "syntax.h"

29
Lisp_Object Qsyntax_table_p, Qsyntax_table;
Richard M. Stallman's avatar
Richard M. Stallman committed
30

31 32 33
static void scan_sexps_forward ();
static int char_quoted ();

Richard M. Stallman's avatar
Richard M. Stallman committed
34 35
int words_include_escapes;

36 37 38 39 40
/* 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;

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/* This is the internal form of the parse state used in parse-partial-sexp.  */

struct lisp_parse_state
  {
    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 */
    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 */
    int location;	/* Char number at which parsing stopped. */
    int mindepth;	/* Minimum depth seen while scanning.  */
    int comstart;	/* Position just after last comment starter.  */
  };

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
/* 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.
   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;
static struct buffer *find_start_buffer;
static int find_start_begv;
static int find_start_modiff;

/* 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
   can return the same value right away.  */

static int
find_defun_start (pos)
     int pos;
{
  int tem;
  int shortage;

  /* 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.  */
93
  tem = scan_buffer ('\n', pos, BEGV, -1, &shortage, 1);
94 95 96 97 98 99 100

  while (tem > BEGV)
    {
      /* Open-paren at start of line means we found our defun-start.  */
      if (SYNTAX (FETCH_CHAR (tem)) == Sopen)
	break;
      /* Move to beg of previous line.  */
101
      tem = scan_buffer ('\n', tem, BEGV, -2, &shortage, 1);
102 103 104 105 106 107 108 109 110 111 112 113
    }

  /* Record what we found, for the next try.  */
  find_start_value = tem;
  find_start_buffer = current_buffer;
  find_start_modiff = MODIFF;
  find_start_begv = BEGV;
  find_start_pos = pos;

  return find_start_value;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
114
DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
115
  "Return t if OBJECT is a syntax table.\n\
116
Currently, any char-table counts as a syntax table.")
117 118
  (object)
     Lisp_Object object;
Richard M. Stallman's avatar
Richard M. Stallman committed
119
{
120 121
  if (CHAR_TABLE_P (object)
      && XCHAR_TABLE (object)->purpose == Qsyntax_table)
Richard M. Stallman's avatar
Richard M. Stallman committed
122 123 124 125
    return Qt;
  return Qnil;
}

126
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128 129
check_syntax_table (obj)
     Lisp_Object obj;
{
130 131 132
  if (!(CHAR_TABLE_P (obj)
	&& XCHAR_TABLE (obj)->purpose == Qsyntax_table))
    wrong_type_argument (Qsyntax_table_p, obj);
Richard M. Stallman's avatar
Richard M. Stallman committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
}   

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;
{
158 159
  Lisp_Object copy;

Jim Blandy's avatar
Jim Blandy committed
160
  if (!NILP (table))
161 162 163 164 165 166 167
    check_syntax_table (table);
  else
    table = Vstandard_syntax_table;

  copy = Fcopy_sequence (table);
  Fset_char_table_parent (copy, Vstandard_syntax_table);
  return copy;
Richard M. Stallman's avatar
Richard M. Stallman committed
168 169 170 171 172 173 174 175
}

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;
{
176
  check_syntax_table (table);
Richard M. Stallman's avatar
Richard M. Stallman committed
177 178
  current_buffer->syntax_table = table;
  /* Indicate that this buffer now has a specified syntax table.  */
179 180
  current_buffer->local_var_flags
    |= XFASTINT (buffer_local_flags.syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
  return table;
}

/* Convert a letter which signifies a syntax code
 into the code it signifies.
 This is used by modify-syntax-entry, and other things. */

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,
    (char) Swhitespace, 0377, (char) Sstring, 0377,
        (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,
200
    (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377,   /* @, A ... */
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202 203 204 205 206 207 208 209 210 211
    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,
    0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377
  };

/* Indexed by syntax code, give the letter that describes it. */

212
char syntax_code_spec[14] =
Richard M. Stallman's avatar
Richard M. Stallman committed
213
  {
214
    ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@'
Richard M. Stallman's avatar
Richard M. Stallman committed
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
/* 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
240
DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
241 242 243
  "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
244 245
The characters that correspond to various syntax codes\n\
are listed in the documentation of `modify-syntax-entry'.")
246 247
  (character)
     Lisp_Object character;
Richard M. Stallman's avatar
Richard M. Stallman committed
248
{
249
  int char_int;
250 251
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
252
  return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
253 254 255
}

DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
256 257 258
  "Return the matching parenthesis of CHARACTER, or nil if none.")
  (character)
     Lisp_Object character;
259
{
260
  int char_int, code;
261 262
  CHECK_NUMBER (character, 0);
  char_int = XINT (character);
263
  code = SYNTAX (char_int);
264
  if (code == Sopen || code == Sclose)
265
    return make_number (SYNTAX_MATCH (char_int));
266
  return Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
267 268 269 270 271 272
}

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

273
DEFUN ("modify-syntax-entry", foo, bar, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275 276 277
  "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
278 279 280 281 282
  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\
283
  <           comment starter.      >   comment ender.\n\
284
  /           character-quote.      @   inherit from `standard-syntax-table'.\n\
285
\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287 288 289 290
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\
291
Defined flags are the characters 1, 2, 3, 4, b, and p.\n\
292 293 294 295
 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\
296 297 298
\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\
299 300
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\
301
this flag:\n\
302
 b means CHAR is part of comment sequence b.\n\
303
\n\
304
 p means CHAR is a prefix character for `backward-prefix-chars';\n\
305
   such characters are treated as whitespace when they occur\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
306
   between expressions.")
307
  (char, s, table)
Richard M. Stallman's avatar
Richard M. Stallman committed
308 309 310 311 312 313 314 315 316 317 318
*/

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;
{
319
  register unsigned char *p;
Richard M. Stallman's avatar
Richard M. Stallman committed
320
  register enum syntaxcode code;
321
  int val;
322
  Lisp_Object match;
Richard M. Stallman's avatar
Richard M. Stallman committed
323 324 325

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

Jim Blandy's avatar
Jim Blandy committed
327
  if (NILP (syntax_table))
Richard M. Stallman's avatar
Richard M. Stallman committed
328 329
    syntax_table = current_buffer->syntax_table;
  else
330
    check_syntax_table (syntax_table);
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332 333 334 335 336

  p = XSTRING (newentry)->data;
  code = (enum syntaxcode) syntax_spec_code[*p++];
  if (((int) code & 0377) == 0377)
    error ("invalid syntax description letter: %c", c);

337 338 339 340 341 342 343
  if (code == Sinherit)
    {
      SET_RAW_SYNTAX_ENTRY (syntax_table, c, Qnil);
      return Qnil;
    }

  if (*p)
344 345 346 347 348 349
    {
      XSETINT (match, *p++);
      if (XFASTINT (match) == ' ')
	match = Qnil;
    }
  else
350
    match = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
351

352
  val = (int) code;
Richard M. Stallman's avatar
Richard M. Stallman committed
353 354 355 356
  while (*p)
    switch (*p++)
      {
      case '1':
357
	val |= 1 << 16;
Richard M. Stallman's avatar
Richard M. Stallman committed
358 359 360
	break;

      case '2':
361
	val |= 1 << 17;
Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364
	break;

      case '3':
365
	val |= 1 << 18;
Richard M. Stallman's avatar
Richard M. Stallman committed
366 367 368
	break;

      case '4':
369
	val |= 1 << 19;
Richard M. Stallman's avatar
Richard M. Stallman committed
370 371 372
	break;

      case 'p':
373
	val |= 1 << 20;
Richard M. Stallman's avatar
Richard M. Stallman committed
374
	break;
375 376

      case 'b':
377
	val |= 1 << 21;
378
	break;
Richard M. Stallman's avatar
Richard M. Stallman committed
379 380
      }
	
381 382
  SET_RAW_SYNTAX_ENTRY (syntax_table, c,
			Fcons (make_number (val), match));
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384 385 386 387 388

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

389
static void
Richard M. Stallman's avatar
Richard M. Stallman committed
390 391 392 393
describe_syntax (value)
    Lisp_Object value;
{
  register enum syntaxcode code;
394
  char desc, match, start1, start2, end1, end2, prefix, comstyle;
Richard M. Stallman's avatar
Richard M. Stallman committed
395
  char str[2];
396
  Lisp_Object first, match_lisp;
Richard M. Stallman's avatar
Richard M. Stallman committed
397 398 399

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

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  if (NILP (value))
    {
      insert_string ("inherit");
      return;
    }

  if (!CONSP (value))
    {
      insert_string ("invalid");
      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
416 417 418 419 420
    {
      insert_string ("invalid");
      return;
    }

421 422 423 424 425 426 427
  code = (enum syntaxcode) (first & 0377);
  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
428 429 430 431 432 433 434 435 436 437 438

  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);

439
  str[0] = !NILP (match_lisp) ? XINT (match_lisp) : ' ';
Richard M. Stallman's avatar
Richard M. Stallman committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453
  insert (str, 1);

  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);
454 455
  if (comstyle)
    insert ("b", 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
456 457 458

  insert_string ("\twhich means: ");

459
  switch (SWITCH_ENUM_CAST (code))
Richard M. Stallman's avatar
Richard M. Stallman committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
    {
    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;
    }

492
  if (!NILP (match_lisp))
Richard M. Stallman's avatar
Richard M. Stallman committed
493 494
    {
      insert_string (", matches ");
495
      insert_char (XINT (match_lisp));
Richard M. Stallman's avatar
Richard M. Stallman committed
496 497 498 499 500 501 502 503 504 505 506
    }

  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");
507 508 509
  if (comstyle)
    insert_string (" (comment style b)");

Richard M. Stallman's avatar
Richard M. Stallman committed
510 511 512 513 514 515
  if (prefix)
    insert_string (",\n\t  is a prefix character for `backward-prefix-chars'");

  insert_string ("\n");
}

516
static Lisp_Object
Richard M. Stallman's avatar
Richard M. Stallman committed
517 518 519 520 521
describe_syntax_1 (vector)
     Lisp_Object vector;
{
  struct buffer *old = current_buffer;
  set_buffer_internal (XBUFFER (Vstandard_output));
522
  describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil);
523
  call0 (intern ("help-mode"));
Richard M. Stallman's avatar
Richard M. Stallman committed
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
  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;
}

/* 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;
  register int code;
549
  int charcode;
Richard M. Stallman's avatar
Richard M. Stallman committed
550 551 552 553 554 555 556 557 558 559 560 561 562

  immediate_quit = 1;
  QUIT;

  while (count > 0)
    {
      while (1)
	{
	  if (from == end)
	    {
	      immediate_quit = 0;
	      return 0;
	    }
563 564
	  charcode = FETCH_CHAR (from);
	  code = SYNTAX (charcode);
Richard M. Stallman's avatar
Richard M. Stallman committed
565 566 567 568 569 570 571 572 573 574
	  if (words_include_escapes
	      && (code == Sescape || code == Scharquote))
	    break;
	  if (code == Sword)
	    break;
	  from++;
	}
      while (1)
	{
	  if (from == end) break;
575 576
	  charcode = FETCH_CHAR (from);
	  code = SYNTAX (charcode);
Richard M. Stallman's avatar
Richard M. Stallman committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
	  if (!(words_include_escapes
		&& (code == Sescape || code == Scharquote)))
	    if (code != Sword)
	      break;
	  from++;
	}
      count--;
    }
  while (count < 0)
    {
      while (1)
	{
	  if (from == beg)
	    {
	      immediate_quit = 0;
	      return 0;
	    }
594 595
	  charcode = FETCH_CHAR (from - 1);
	  code = SYNTAX (charcode);
Richard M. Stallman's avatar
Richard M. Stallman committed
596 597 598 599 600 601 602 603 604 605
	  if (words_include_escapes
	      && (code == Sescape || code == Scharquote))
	    break;
	  if (code == Sword)
	    break;
	  from--;
	}
      while (1)
	{
	  if (from == beg) break;
606 607
	  charcode = FETCH_CHAR (from - 1);
	  code = SYNTAX (charcode);
Richard M. Stallman's avatar
Richard M. Stallman committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
	  if (!(words_include_escapes
		&& (code == Sescape || code == Scharquote)))
	    if (code != Sword)
	      break;
	  from--;
	}
      count++;
    }

  immediate_quit = 0;

  return from;
}

DEFUN ("forward-word", Fforward_word, Sforward_word, 1, 1, "p",
  "Move point forward ARG words (backward if ARG is negative).\n\
Normally returns t.\n\
If an edge of the buffer is reached, point is left there\n\
and nil is returned.")
  (count)
     Lisp_Object count;
{
  int val;
  CHECK_NUMBER (count, 0);

  if (!(val = scan_words (point, XINT (count))))
    {
      SET_PT (XINT (count) > 0 ? ZV : BEGV);
      return Qnil;
    }
  SET_PT (val);
  return Qt;
}

642 643 644
DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
  "Move forward across up to N comments.  If N is negative, move backward.\n\
Stop scanning if we find something other than a comment or whitespace.\n\
645
Set point to where scanning stops.\n\
646 647 648
If N comments are found as expected, with nothing except whitespace\n\
between them, return t; otherwise return nil.")
  (count)
649
     Lisp_Object count;
650 651 652
{
  register int from;
  register int stop;
653
  register int c, c1;
654 655
  register enum syntaxcode code;
  int comstyle = 0;	    /* style of comment encountered */
656
  int found;
657 658 659 660
  int count1;

  CHECK_NUMBER (count, 0);
  count1 = XINT (count);
661 662 663 664 665 666

  immediate_quit = 1;
  QUIT;

  from = PT;

667
  while (count1 > 0)
668 669
    {
      stop = ZV;
670
      do
671
	{
672 673 674
	  if (from == stop)
	    {
	      SET_PT (from);
675
	      immediate_quit = 0;
676 677
	      return Qnil;
	    }
678 679 680 681 682
	  c = FETCH_CHAR (from);
	  code = SYNTAX (c);
	  from++;
	  comstyle = 0;
	  if (from < stop && SYNTAX_COMSTART_FIRST (c)
683 684
	      && (c1 = FETCH_CHAR (from),
		  SYNTAX_COMSTART_SECOND (c1)))
685
	    {
686 687
	      /* We have encountered a comment start sequence and we 
		 are ignoring all text inside comments.  We must record
688 689
		 the comment style this sequence begins so that later,
		 only a comment end of the same style actually ends
690
		 the comment section.  */
691
	      code = Scomment;
692
	      comstyle = SYNTAX_COMMENT_STYLE (c1);
693 694
	      from++;
	    }
695 696 697 698 699 700 701 702 703 704 705 706
	}
      while (code == Swhitespace || code == Sendcomment);
      if (code != Scomment)
	{
	  immediate_quit = 0;
	  SET_PT (from - 1);
	  return Qnil;
	}
      /* We're at the start of a comment.  */
      while (1)
	{
	  if (from == stop)
707 708
	    {
	      immediate_quit = 0;
709
	      SET_PT (from);
710 711
	      return Qnil;
	    }
712
	  c = FETCH_CHAR (from);
713
	  from++;
714 715 716 717 718 719 720
	  if (SYNTAX (c) == Sendcomment
	      && SYNTAX_COMMENT_STYLE (c) == comstyle)
	    /* we have encountered a comment end of the same style
	       as the comment sequence which began this comment
	       section */
	    break;
	  if (from < stop && SYNTAX_COMEND_FIRST (c)
721 722
	      && (c1 = FETCH_CHAR (from),
		  SYNTAX_COMEND_SECOND (c1))
723 724 725 726 727
	      && SYNTAX_COMMENT_STYLE (c) == comstyle)
	    /* we have encountered a comment end of the same style
	       as the comment sequence which began this comment
	       section */
	    { from++; break; }
728
	}
729
      /* We have skipped one comment.  */
730
      count1--;
731 732
    }

733
  while (count1 < 0)
734 735 736 737 738 739 740 741 742 743 744 745 746
    {
      stop = BEGV;
      while (from > stop)
	{
	  int quoted;

	  from--;
	  quoted = char_quoted (from);
	  if (quoted)
	    from--;
	  c = FETCH_CHAR (from);
	  code = SYNTAX (c);
	  comstyle = 0;
747 748
	  if (code == Sendcomment)
	    comstyle = SYNTAX_COMMENT_STYLE (c);
749
	  if (from > stop && SYNTAX_COMEND_SECOND (c)
750 751
	      && (c1 = FETCH_CHAR (from - 1),
		  SYNTAX_COMEND_FIRST (c1))
752 753
	      && !char_quoted (from - 1))
	    {
754
	      /* We must record the comment style encountered so that
755
		 later, we can match only the proper comment begin
756
		 sequence of the same style.  */
757
	      code = Sendcomment;
758
	      comstyle = SYNTAX_COMMENT_STYLE (c1);
759 760 761 762 763
	      from--;
	    }

	  if (code == Sendcomment && !quoted)
	    {
764
#if 0
765 766 767 768 769 770 771
	      if (code != SYNTAX (c))
		/* For a two-char comment ender, we can assume
		   it does end a comment.  So scan back in a simple way.  */
		{
		  if (from != stop) from--;
		  while (1)
		    {
772 773
		      if ((c = FETCH_CHAR (from),
			   SYNTAX (c) == Scomment)
774 775 776 777 778
			  && SYNTAX_COMMENT_STYLE (c) == comstyle)
			break;
		      if (from == stop)
			{
			  immediate_quit = 0;
779
			  SET_PT (from);
780 781 782 783
			  return Qnil;
			}
		      from--;
		      if (SYNTAX_COMSTART_SECOND (c)
784 785
			  && (c1 = FETCH_CHAR (from),
			      SYNTAX_COMSTART_FIRST (c1))
786 787 788 789 790 791
			  && SYNTAX_COMMENT_STYLE (c) == comstyle
			  && !char_quoted (from))
			break;
		    }
		  break;
		}
792
#endif /* 0 */
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809

	      /* 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;
		char my_stringend = 0;
		int string_lossage = 0;
		int comment_end = from;
		int comstart_pos = 0;
		int comstart_parity = 0;
810
		int scanstart = from - 1;
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828

		/* At beginning of range to scan, we're outside of strings;
		   that determines quote parity to the comment-end.  */
		while (from != stop)
		  {
		    /* Move back and examine a character.  */
		    from--;

		    c = FETCH_CHAR (from);
		    code = SYNTAX (c);

		    /* If this char is the second of a 2-char comment sequence,
		       back up and give the pair the appropriate syntax.  */
		    if (from > stop && SYNTAX_COMEND_SECOND (c)
			&& SYNTAX_COMEND_FIRST (FETCH_CHAR (from - 1)))
		      {
			code = Sendcomment;
			from--;
829
		        c = FETCH_CHAR (from);
830 831
		      }
			
832 833 834 835 836 837
		    /* If this char starts a 2-char comment start sequence,
		       treat it like a 1-char comment starter.  */
		    if (from < scanstart && SYNTAX_COMSTART_FIRST (c)
			&& SYNTAX_COMSTART_SECOND (FETCH_CHAR (from + 1))
			&& comstyle == SYNTAX_COMMENT_STYLE (FETCH_CHAR (from + 1)))
		      code = Scomment;
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863

		    /* Ignore escaped characters.  */
		    if (char_quoted (from))
		      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;
		      }

		    /* Record comment-starters according to that
		       quote-parity to the comment-end.  */
		    if (code == Scomment)
		      {
			comstart_parity = parity;
			comstart_pos = from;
		      }

		    /* If we find another earlier comment-ender,
864
		       any comment-starts earlier than that don't count
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
		       (because they go with the earlier comment-ender).  */
		    if (code == Sendcomment
			&& SYNTAX_COMMENT_STYLE (FETCH_CHAR (from)) == comstyle)
		      break;

		    /* Assume a defun-start point is outside of strings.  */
		    if (code == Sopen
			&& (from == stop || FETCH_CHAR (from - 1) == '\n'))
		      break;
		  }

		if (comstart_pos == 0)
		  from = comment_end;
		/* 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;
		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;
		    scan_sexps_forward (&state, find_defun_start (comment_end),
894
					comment_end - 1, -10000, 0, Qnil, 0);
895 896 897 898 899 900 901
		    if (state.incomment)
		      from = state.comstart;
		    else
		      /* We can't grok this as a comment; scan it normally.  */
		      from = comment_end;
		  }
	      }
902 903
	      /* We have skipped one comment.  */
	      break;
904
	    }
905
	  else if ((code != Swhitespace && code != Scomment) || quoted)
906 907
	    {
	      immediate_quit = 0;
908
	      SET_PT (from + 1);
909 910 911 912
	      return Qnil;
	    }
	}

913
      count1++;
914 915 916 917 918 919 920
    }

  SET_PT (from);
  immediate_quit = 0;
  return Qt;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
921 922 923 924 925 926 927 928 929 930
int parse_sexp_ignore_comments;

Lisp_Object
scan_lists (from, count, depth, sexpflag)
     register int from;
     int count, depth, sexpflag;
{
  Lisp_Object val;
  register int stop;
  register int c;
931
  unsigned char stringterm;
Richard M. Stallman's avatar
Richard M. Stallman committed
932 933 934 935
  int quoted;
  int mathexit = 0;
  register enum syntaxcode code;
  int min_depth = depth;    /* Err out if depth gets less than this. */
936
  int comstyle = 0;	    /* style of comment encountered */
Richard M. Stallman's avatar
Richard M. Stallman committed
937 938 939 940 941 942 943 944 945 946 947 948

  if (depth > 0) min_depth = 0;

  immediate_quit = 1;
  QUIT;

  while (count > 0)
    {
      stop = ZV;
      while (from < stop)
	{
	  c = FETCH_CHAR (from);
949
	  code = SYNTAX (c);
Richard M. Stallman's avatar
Richard M. Stallman committed
950 951 952 953
	  from++;
	  if (from < stop && SYNTAX_COMSTART_FIRST (c)
	      && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from))
	      && parse_sexp_ignore_comments)
954 955 956 957 958 959 960 961 962 963 964
	    {
	      /* we have encountered a comment start sequence and we 
		 are ignoring all text inside comments. we must record
		 the comment style this sequence begins so that later,
		 only a comment end of the same style actually ends
		 the comment section */
	      code = Scomment;
	      comstyle = SYNTAX_COMMENT_STYLE (FETCH_CHAR (from));
	      from++;
	    }
	  
Richard M. Stallman's avatar
Richard M. Stallman committed
965 966 967
	  if (SYNTAX_PREFIX (c))
	    continue;

968
	  switch (SWITCH_ENUM_CAST (code))
Richard M. Stallman's avatar
Richard M. Stallman committed
969 970 971 972 973 974 975 976 977 978 979 980
	    {
	    case Sescape:
	    case Scharquote:
	      if (from == stop) goto lose;
	      from++;
	      /* treat following character as a word constituent */
	    case Sword:
	    case Ssymbol:
	      if (depth || !sexpflag) break;
	      /* This word counts as a sexp; return at end of it. */
	      while (from < stop)
		{
981
		  switch (SWITCH_ENUM_CAST (SYNTAX (FETCH_CHAR (from))))
Richard M. Stallman's avatar
Richard M. Stallman committed
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
		    {
		    case Scharquote:
		    case Sescape:
		      from++;
		      if (from == stop) goto lose;
		      break;
		    case Sword:
		    case Ssymbol:
		    case Squote:
		      break;
		    default:
		      goto done;
		    }
		  from++;
		}
	      goto done;

	    case Scomment:
	      if (!parse_sexp_ignore_comments) break;
	      while (1)
		{
1003 1004 1005 1006 1007 1008
		  if (from == stop)
		    {
		      if (depth == 0)
			goto done;
		      goto lose;
		    }
1009 1010 1011 1012 1013 1014
		  c = FETCH_CHAR (from);
		  if (SYNTAX (c) == Sendcomment
		      && SYNTAX_COMMENT_STYLE (c) == comstyle)
		    /* we have encountered a comment end of the same style
		       as the comment sequence which began this comment
		       section */
Richard M. Stallman's avatar
Richard M. Stallman committed
1015 1016 1017
		    break;
		  from++;
		  if (from < stop && SYNTAX_COMEND_FIRST (c)
1018 1019 1020 1021 1022
		      && SYNTAX_COMEND_SECOND (FETCH_CHAR (from))
		      && SYNTAX_COMMENT_STYLE (c) == comstyle)
		    /* we have encountered a comment end of the same style
		       as the comment sequence which began this comment
		       section */
Richard M. Stallman's avatar
Richard M. Stallman committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
		    { from++; break; }
		}
	      break;

	    case Smath:
	      if (!sexpflag)
		break;
	      if (from != stop && c == FETCH_CHAR (from))
		from++;
	      if (mathexit)
		{
		  mathexit = 0;
		  goto close1;
		}
	      mathexit = 1;

	    case Sopen:
	      if (!++depth) goto done;
	      break;

	    case Sclose:
	    close1:
	      if (!--depth) goto done;
	      if (depth < min_depth)
		error ("Containing expression ends prematurely");
	      break;

	    case Sstring:
	      stringterm = FETCH_CHAR (from - 1);
	      while (1)
		{
		  if (from >= stop) goto lose;
		  if (FETCH_CHAR (from) == stringterm) break;
1056
		  switch (SWITCH_ENUM_CAST (SYNTAX (FETCH_CHAR (from))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
		    {
		    case Scharquote:
		    case Sescape:
		      from++;
		    }
		  from++;
		}
	      from++;
	      if (!depth && sexpflag) goto done;
	      break;
	    }
	}

      /* Reached end of buffer.  Error if within object, return nil if between */
      if (depth) goto lose;

      immediate_quit = 0;
      return Qnil;

      /* End of object reached */
    done:
      count--;
    }

  while (count < 0)
    {
      stop = BEGV;
      while (from > stop)
	{
	  from--;
	  if (quoted = char_quoted (from))
	    from--;
	  c = FETCH_CHAR (from);
	  code = SYNTAX (c);
1091 1092 1093
	  comstyle = 0;
	  if (code == Sendcomment)
	    comstyle = SYNTAX_COMMENT_STYLE (c);
Richard M. Stallman's avatar
Richard M. Stallman committed
1094 1095 1096 1097
	  if (from > stop && SYNTAX_COMEND_SECOND (c)
	      && SYNTAX_COMEND_FIRST (FETCH_CHAR (from - 1))
	      && !char_quoted (from - 1)
	      && parse_sexp_ignore_comments)
1098 1099 1100 1101 1102 1103 1104 1105 1106
	    {
	      /* we must record the comment style encountered so that
		 later, we can match only the proper comment begin
		 sequence of the same style */
	      code = Sendcomment;
	      comstyle = SYNTAX_COMMENT_STYLE (FETCH_CHAR (from - 1));
	      from--;
	    }
	  
Richard M. Stallman's avatar
Richard M. Stallman committed
1107 1108 1109
	  if (SYNTAX_PREFIX (c))
	    continue;

1110
	  switch (SWITCH_ENUM_CAST (quoted ? Sword : code))
Richard M. Stallman's avatar
Richard M. Stallman committed
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
	    {
	    case Sword:
	    case Ssymbol:
	      if (depth || !sexpflag) break;
	      /* This word counts as a sexp; count object finished after passing it. */
	      while (from > stop)
		{
		  quoted = char_quoted (from - 1);
		  if (quoted)
		    from--;
1121 1122 1123
		  if (! (quoted || SYNTAX (FETCH_CHAR (from - 1)) == Sword
			 || SYNTAX (FETCH_CHAR (from - 1)) == Ssymbol
			 || SYNTAX (FETCH_CHAR (from - 1)) == Squote))
Richard M. Stallman's avatar
Richard M. Stallman committed
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
            	    goto done2;
		  from--;
		}
	      goto done2;

	    case Smath:
	      if (!sexpflag)
		break;
	      if (from != stop && c == FETCH_CHAR (from - 1))
		from--;
	      if (mathexit)
		{
		  mathexit = 0;
		  goto open2;
		}
	      mathexit = 1;

	    case Sclose:
	      if (!++depth) goto done2;
	      break;

	    case Sopen:
	    open2:
	      if (!--depth) goto done2;
	      if (depth < min_depth)
		error ("Containing expression ends prematurely");
	      break;

	    case Sendcomment:
	      if (!parse_sexp_ignore_comments)
		break;
1155
#if 0
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
	      if (code != SYNTAX (c))
		/* For a two-char comment ender, we can assume
		   it does end a comment.  So scan back in a simple way.  */
		{
		  if (from != stop) from--;
		  while (1)
		    {
		      if (SYNTAX (c = FETCH_CHAR (from)) == Scomment
			  && SYNTAX_COMMENT_STYLE (c) == comstyle)
			break;
1166 1167 1168 1169 1170 1171
		      if (from == stop)
			{
			  if (depth == 0)
			    goto done2;
			  goto lose;
			}
1172 1173 1174 1175 1176 1177 1178 1179 1180
		      from--;
		      if (SYNTAX_COMSTART_SECOND (c)
			  && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from))
			  && SYNTAX_COMMENT_STYLE (c) == comstyle
			  && !char_quoted (from))
			break;
		    }
		  break;
		}
1181
#endif /* 0 */
1182

Richard M. Stallman's avatar
Richard M. Stallman committed
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
	      /* 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;
1194 1195 1196
		char my_stringend = 0;
		int string_lossage = 0;
		int comment_end = from;
1197 1198
		int comstart_pos = 0;
		int comstart_parity = 0;
1199
		int scanstart = from - 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214

		/* At beginning of range to scan, we're outside of strings;
		   that determines quote parity to the comment-end.  */
		while (from != stop)
		  {
		    /* Move back and examine a character.  */
		    from--;

		    c = FETCH_CHAR (from);
		    code = SYNTAX (c);

		    /* If this char is the second of a 2-char comment sequence,
		       back up and give the pair the appropriate syntax.  */
		    if (from > stop && SYNTAX_COMEND_SECOND (c)
			&& SYNTAX_COMEND_FIRST (FETCH_CHAR (from - 1)))
1215 1216 1217
		      {
			code = Sendcomment;
			from--;
1218
		        c = FETCH_CHAR (from);
1219 1220
		      }
			
1221 1222 1223 1224 1225 1226
		    /* If this char starts a 2-char comment start sequence,
		       treat it like a 1-char comment starter.  */
		    if (from < scanstart && SYNTAX_COMSTART_FIRST (c)
			&& SYNTAX_COMSTART_SECOND (FETCH_CHAR (from + 1))
			&& comstyle == SYNTAX_COMMENT_STYLE (FETCH_CHAR (from + 1)))
		      code = Scomment;
Richard M. Stallman's avatar
Richard M. Stallman committed
1227 1228 1229 1230 1231

		    /* Ignore escaped characters.  */
		    if (char_quoted (from))
		      continue;

1232
		    /* Track parity of quotes.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
1233
		    if (code == Sstring)
1234 1235 1236 1237
		      {
			parity ^= 1;
			if (my_stringend == 0)
			  my_stringend = c;
1238
			/* If we have two kinds of string delimiters.
1239 1240 1241 1242
			   There's no way to grok this scanning backwards.  */
			else if (my_stringend != c)
			  string_lossage = 1;
		      }
Richard M. Stallman's avatar
Richard M. Stallman committed
1243 1244 1245 1246

		    /* Record comment-starters according to that
		       quote-parity to the comment-end.  */
		    if (code == Scomment)
1247 1248 1249 1250
		      {
			comstart_parity = parity;
			comstart_pos = from;
		      }
Richard M. Stallman's avatar
Richard M. Stallman committed
1251

1252
		    /* If we find another earlier comment-ender,
1253
		       any comment-starts earlier than that don't count
1254
		       (because they go with the earlier comment-ender).  */
1255 1256
		    if (code == Sendcomment
			&& SYNTAX_COMMENT_STYLE (FETCH_CHAR (from)) == comstyle)
Richard M. Stallman's avatar
Richard M. Stallman committed
1257
		      break;
1258 1259 1260 1261 1262

		    /* Assume a defun-start point is outside of strings.  */
		    if (code == Sopen
			&& (from == stop || FETCH_CHAR (from - 1) == '\n'))
		      break;
Richard M. Stallman's avatar
Richard M. Stallman committed
1263
		  }
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274

		if (comstart_pos == 0)
		  from = comment_end;
		/* 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;
		else
1275 1276 1277 1278 1279 1280 1281
		  {
		    /* 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;
1282
		    scan_sexps_forward (&state, find_defun_start (comment_end),
1283
					comment_end - 1, -10000, 0, Qnil, 0);
1284 1285 1286 1287 1288 1289
		    if (state.incomment)
		      from = state.comstart;
		    else
		      /* We can't grok this as a comment; scan it normally.  */
		      from = comment_end;
		  }
Richard M. Stallman's avatar
Richard M. Stallman committed
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
	      }
	      break;

	    case Sstring:
	      stringterm = FETCH_CHAR (from);
	      while (1)
		{
		  if (from == stop) goto lose;
		  if (!char_quoted (from - 1)
		      && stringterm == FETCH_CHAR (from - 1))
		    break;
		  from--;
		}
	      from--;
	      if (!depth && sexpflag) goto done2;
	      break;
	    }
	}

      /* Reached start of buffer.  Error if within object, return nil if between */
      if (depth) goto lose;

      immediate_quit = 0;
      return Qnil;

    done2:
      count++;
    }


  immediate_quit = 0;
1321
  XSETFASTINT (val, from);
Richard M. Stallman's avatar
Richard M. Stallman committed
1322 1323 1324 1325 1326 1327 1328
  return val;

 lose:
  error ("Unbalanced parentheses");
  /* NOTREACHED */
}

1329
static int
Richard M. Stallman's avatar
Richard M. Stallman committed
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
char_quoted (pos)
     register int pos;
{
  register enum syntaxcode code;
  register int beg = BEGV;
  register int quoted = 0;

  while (pos > beg
	 && ((code = SYNTAX (FETCH_CHAR (pos - 1))) == Scharquote
	     || code == Sescape))
    pos--, quoted = !quoted;
  return quoted;
}

DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
  "Scan from character number FROM by COUNT lists.\n\
Returns the character number of the position thus found.\n\
\n\
If DEPTH is nonzero, paren depth begins counting from that value,\n\
only places where the depth in parentheses becomes zero\n\
are candidates for stopping; COUNT such places are counted.\n\
Thus, a positive value for DEPTH means go out levels.\n\
\n\
Comments are ignored if `parse-sexp-ignore-comments' is non-nil.\n\
\n\
If the beginning or end of (the accessible part of) the buffer is reached\n\
and the depth is wrong, an error is signaled.\n\
If the depth is right but the count is not used up, nil is returned.")
  (from, count, depth)
     Lisp_Object from, count, depth;
{
  CHECK_NUMBER (from, 0);
  CHECK_NUMBER (count, 1);
  CHECK_NUMBER (depth, 2);

  return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
}

DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
  "Scan from character number FROM by COUNT balanced expressions.\n\
If COUNT is negative, scan backwards.\n\
Returns the character number of the position thus found.\n\
\n\
Comments are ignored if `parse-sexp-ignore-comments' is non-nil.\n\
\n\
If the beginning or end of (the accessible part of) the buffer is reached\n\
in the middle of a parenthetical grouping, an error is signaled.\n\
If the beginning or end is reached between groupings\n\
but before count is used up, nil is returned.")
  (from, count)
     Lisp_Object from, count;
{
  CHECK_NUMBER (from, 0);
  CHECK_NUMBER (count, 1);

  return scan_lists (XINT (from), XINT (count), 0, 1);
}

DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
  0, 0, 0,
  "Move point backward over any number of chars with prefix syntax.\n\
This includes chars with \"quote\" or \"prefix\" syntax (' or p).")
  ()
{
  int beg = BEGV;
  int pos = point;

  while (pos > beg && !char_quoted (pos - 1)
	 && (SYNTAX (FETCH_CHAR (pos - 1)) == Squote
	     || SYNTAX_PREFIX (FETCH_CHAR (pos - 1))))
    pos--;

  SET_PT (pos);

  return Qnil;
}

/* Parse forward from FROM to END,
1408 1409
   assuming that FROM has state OLDSTATE (nil means FROM is start of function),
   and return a description of the state of the parse at END.
1410 1411
   If STOPBEFORE is nonzero, stop at the start of an atom.
   If COMMENTSTOP is nonzero, stop at the start of a comment.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
1412

1413
static void
1414 1415
scan_sexps_forward (stateptr, from, end, targetdepth,
		    stopbefore, oldstate, commentstop)
1416
     struct lisp_parse_state *stateptr;