textprop.c 68.3 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Interface code for dealing with text properties.
2
   Copyright (C) 1993-1995, 1997, 1999-2011 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5

This file is part of GNU Emacs.

6
GNU Emacs is free software: you can redistribute it and/or modify
Joseph Arceneaux's avatar
Joseph Arceneaux committed
7
it under the terms of the GNU General Public License as published by
8 9
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
10 11 12 13 14 15 16

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
18

19
#include <config.h>
20
#include <setjmp.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
21 22 23
#include "lisp.h"
#include "intervals.h"
#include "buffer.h"
24
#include "window.h"
25 26 27 28

#ifndef NULL
#define NULL (void *)0
#endif
29 30 31 32 33

/* Test for membership, allowing for t (actually any non-cons) to mean the
   universal set.  */

#define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34 35 36 37 38 39


/* NOTES:  previous- and next- property change will have to skip
  zero-length intervals if they are implemented.  This could be done
  inside next_interval and previous_interval.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
40 41
  set_properties needs to deal with the interval property cache.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
42
  It is assumed that for any interval plist, a property appears
43
  only once on the list.  Although some code i.e., remove_properties,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
44
  handles the more general case, the uniqueness of properties is
45
  necessary for the system to remain consistent.  This requirement
46
  is enforced by the subrs installing properties onto the intervals.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
47 48


49
/* Types of hooks.  */
50 51
static Lisp_Object Qmouse_left;
static Lisp_Object Qmouse_entered;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
52 53
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
54 55
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
56

57
/* Visual properties text (including strings) may have.  */
58 59 60 61 62
static Lisp_Object Qforeground, Qbackground, Qunderline;
Lisp_Object Qfont;
static Lisp_Object Qstipple;
Lisp_Object Qinvisible, Qintangible, Qmouse_face;
static Lisp_Object Qread_only;
63
Lisp_Object Qminibuffer_prompt;
64 65 66

/* Sticky properties */
Lisp_Object Qfront_sticky, Qrear_nonsticky;
67 68 69 70

/* If o1 is a cons whose cdr is a cons, return non-zero and set o2 to
   the o1's cdr.  Otherwise, return zero.  This is handy for
   traversing plists.  */
71
#define PLIST_ELT_P(o1, o2) (CONSP (o1) && ((o2)=XCDR (o1), CONSP (o2)))
72

73 74 75 76
/* verify_interval_modification saves insertion hooks here
   to be run later by report_interval_modification.  */
Lisp_Object interval_insert_behind_hooks;
Lisp_Object interval_insert_in_front_hooks;
77

78
static void text_read_only (Lisp_Object) NO_RETURN;
79
INFUN (Fprevious_property_change, 3);
80

81 82 83 84 85

/* Signal a `text-read-only' error.  This function makes it easier
   to capture that error in GDB by putting a breakpoint on it.  */

static void
86
text_read_only (Lisp_Object propval)
87
{
88 89 90 91
  if (STRINGP (propval))
    xsignal1 (Qtext_read_only, propval);

  xsignal0 (Qtext_read_only);
92 93 94
}


Joseph Arceneaux's avatar
Joseph Arceneaux committed
95

Joseph Arceneaux's avatar
Joseph Arceneaux committed
96 97 98 99 100 101
/* Extract the interval at the position pointed to by BEGIN from
   OBJECT, a string or buffer.  Additionally, check that the positions
   pointed to by BEGIN and END are within the bounds of OBJECT, and
   reverse them if *BEGIN is greater than *END.  The objects pointed
   to by BEGIN and END may be integers or markers; if the latter, they
   are coerced to integers.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
102

103 104 105
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
106 107 108 109 110 111 112 113 114
   Note that buffer points don't correspond to interval indices.
   For example, point-max is 1 greater than the index of the last
   character.  This difference is handled in the caller, which uses
   the validated points to determine a length, and operates on that.
   Exceptions are Ftext_properties_at, Fnext_property_change, and
   Fprevious_property_change which call this function with BEGIN == END.
   Handle this case specially.

   If FORCE is soft (0), it's OK to return NULL_INTERVAL.  Otherwise,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
115 116
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
117
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
118 119 120 121

#define soft 0
#define hard 1

Gerd Moellmann's avatar
Gerd Moellmann committed
122
INTERVAL
123
validate_interval_range (Lisp_Object object, Lisp_Object *begin, Lisp_Object *end, int force)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
124 125
{
  register INTERVAL i;
126
  EMACS_INT searchpos;
127

128 129 130
  CHECK_STRING_OR_BUFFER (object);
  CHECK_NUMBER_COERCE_MARKER (*begin);
  CHECK_NUMBER_COERCE_MARKER (*end);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
131 132

  /* If we are asked for a point, but from a subr which operates
133
     on a range, then return nothing.  */
134
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
135 136 137 138
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
139 140
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
141
      *begin = *end;
142
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
143 144
    }

145
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
146 147 148 149 150 151
    {
      register struct buffer *b = XBUFFER (object);

      if (!(BUF_BEGV (b) <= XINT (*begin) && XINT (*begin) <= XINT (*end)
	    && XINT (*end) <= BUF_ZV (b)))
	args_out_of_range (*begin, *end);
152
      i = BUF_INTERVALS (b);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
153

154
      /* If there's no text, there are no properties.  */
155 156 157 158
      if (BUF_BEGV (b) == BUF_ZV (b))
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
159 160 161
    }
  else
    {
162
      EMACS_INT len = SCHARS (object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
163

164
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
165
	     && XINT (*end) <= len))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
166
	args_out_of_range (*begin, *end);
167
      XSETFASTINT (*begin, XFASTINT (*begin));
168
      if (begin != end)
169
	XSETFASTINT (*end, XFASTINT (*end));
170
      i = STRING_INTERVALS (object);
171

172
      if (len == 0)
173 174 175
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
176 177 178 179
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
180

181
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
182 183 184 185
}

/* Validate LIST as a property list.  If LIST is not a list, then
   make one consisting of (LIST nil).  Otherwise, verify that LIST
186
   is even numbered and thus suitable as a plist.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
187 188

static Lisp_Object
189
validate_plist (Lisp_Object list)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
190 191 192 193 194 195 196 197
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
198
      for (i = 0, tail = list; CONSP (tail); i++)
199
	{
200
	  tail = XCDR (tail);
201 202
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
203 204 205 206 207 208 209 210 211
      if (i & 1)
	error ("Odd length text property list");
      return list;
    }

  return Fcons (list, Fcons (Qnil, Qnil));
}

/* Return nonzero if interval I has all the properties,
212
   with the same values, of list PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
213 214

static int
215
interval_has_all_properties (Lisp_Object plist, INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
216
{
217
  register Lisp_Object tail1, tail2, sym1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
218 219
  register int found;

220
  /* Go through each element of PLIST.  */
221
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
222
    {
223
      sym1 = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
224 225 226
      found = 0;

      /* Go through I's plist, looking for sym1 */
227 228
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym1, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
229 230
	  {
	    /* Found the same property on both lists.  If the
231
	       values are unequal, return zero.  */
232
	    if (! EQ (Fcar (XCDR (tail1)), Fcar (XCDR (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
233 234
	      return 0;

235
	    /* Property has same value on both lists;  go to next one.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
236 237 238 239 240 241 242 243 244 245 246 247
	    found = 1;
	    break;
	  }

      if (! found)
	return 0;
    }

  return 1;
}

/* Return nonzero if the plist of interval I has any of the
248
   properties of PLIST, regardless of their values.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
249 250

static INLINE int
251
interval_has_some_properties (Lisp_Object plist, INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
252 253 254
{
  register Lisp_Object tail1, tail2, sym;

255
  /* Go through each element of PLIST.  */
256
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
257
    {
258
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
259 260

      /* Go through i's plist, looking for tail1 */
261 262
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
263 264 265 266 267
	  return 1;
    }

  return 0;
}
268 269 270 271 272

/* Return nonzero if the plist of interval I has any of the
   property names in LIST, regardless of their values.  */

static INLINE int
273
interval_has_some_properties_list (Lisp_Object list, INTERVAL i)
274 275 276 277
{
  register Lisp_Object tail1, tail2, sym;

  /* Go through each element of LIST.  */
278
  for (tail1 = list; CONSP (tail1); tail1 = XCDR (tail1))
279 280 281 282
    {
      sym = Fcar (tail1);

      /* Go through i's plist, looking for tail1 */
283
      for (tail2 = i->plist; CONSP (tail2); tail2 = XCDR (XCDR (tail2)))
284 285 286 287 288 289
	if (EQ (sym, XCAR (tail2)))
	  return 1;
    }

  return 0;
}
290

291 292 293 294
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
295
static Lisp_Object
296
property_value (Lisp_Object plist, Lisp_Object prop)
297 298 299 300
{
  Lisp_Object value;

  while (PLIST_ELT_P (plist, value))
301 302
    if (EQ (XCAR (plist), prop))
      return XCAR (value);
303
    else
304
      plist = XCDR (value);
305 306 307 308

  return Qunbound;
}

309 310 311 312 313
/* Set the properties of INTERVAL to PROPERTIES,
   and record undo info for the previous values.
   OBJECT is the string or buffer that INTERVAL belongs to.  */

static void
314
set_properties (Lisp_Object properties, INTERVAL interval, Lisp_Object object)
315
{
316
  Lisp_Object sym, value;
317

318
  if (BUFFERP (object))
319
    {
320 321 322 323
      /* For each property in the old plist which is missing from PROPERTIES,
	 or has a different value in PROPERTIES, make an undo record.  */
      for (sym = interval->plist;
	   PLIST_ELT_P (sym, value);
324 325 326
	   sym = XCDR (value))
	if (! EQ (property_value (properties, XCAR (sym)),
		  XCAR (value)))
327 328
	  {
	    record_property_change (interval->position, LENGTH (interval),
329
				    XCAR (sym), XCAR (value),
330 331
				    object);
	  }
332 333 334 335 336

      /* For each new property that has no value at all in the old plist,
	 make an undo record binding it to nil, so it will be removed.  */
      for (sym = properties;
	   PLIST_ELT_P (sym, value);
337 338
	   sym = XCDR (value))
	if (EQ (property_value (interval->plist, XCAR (sym)), Qunbound))
339 340
	  {
	    record_property_change (interval->position, LENGTH (interval),
341
				    XCAR (sym), Qnil,
342 343
				    object);
	  }
344 345 346 347 348
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
349 350 351 352 353

/* Add the properties of PLIST to the interval I, or set
   the value of I's property to the value of the property on PLIST
   if they are different.

354 355
   OBJECT should be the string or buffer the interval is in.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
356 357 358
   Return nonzero if this changes I (i.e., if any members of PLIST
   are actually added to I's plist) */

359
static int
360
add_properties (Lisp_Object plist, INTERVAL i, Lisp_Object object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
361
{
362
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
363 364
  register int changed = 0;
  register int found;
365 366 367 368 369 370 371 372 373
  struct gcpro gcpro1, gcpro2, gcpro3;

  tail1 = plist;
  sym1 = Qnil;
  val1 = Qnil;
  /* No need to protect OBJECT, because we can GC only in the case
     where it is a buffer, and live buffers are always protected.
     I and its plist are also protected, via OBJECT.  */
  GCPRO3 (tail1, sym1, val1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
374

375
  /* Go through each element of PLIST.  */
376
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
377
    {
378 379
      sym1 = XCAR (tail1);
      val1 = Fcar (XCDR (tail1));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
380 381 382
      found = 0;

      /* Go through I's plist, looking for sym1 */
383 384
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym1, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
385
	  {
386 387
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
388
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
389

390
	    this_cdr = XCDR (tail2);
391
	    /* Found the property.  Now check its value.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
392 393 394
	    found = 1;

	    /* The properties have the same value on both lists.
395
	       Continue to the next property.  */
396
	    if (EQ (val1, Fcar (this_cdr)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
397 398
	      break;

399
	    /* Record this change in the buffer, for undo purposes.  */
400
	    if (BUFFERP (object))
401
	      {
402 403
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
404 405
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
406 407 408 409 410 411 412 413
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
414
	  /* Record this change in the buffer, for undo purposes.  */
415
	  if (BUFFERP (object))
416
	    {
417 418
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
419
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
420 421 422 423 424
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

425 426
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
427 428 429
  return changed;
}

430 431 432
/* For any members of PLIST, or LIST,
   which are properties of I, remove them from I's plist.
   (If PLIST is non-nil, use that, otherwise use LIST.)
433
   OBJECT is the string or buffer containing I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
434

435
static int
436
remove_properties (Lisp_Object plist, Lisp_Object list, INTERVAL i, Lisp_Object object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
437
{
438
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
439 440
  register int changed = 0;

441 442
  /* Nonzero means tail1 is a plist, otherwise it is a list.  */
  int use_plist;
443

444
  current_plist = i->plist;
445 446

  if (! NILP (plist))
447
    tail1 = plist, use_plist = 1;
448
  else
449
    tail1 = list, use_plist = 0;
450 451

  /* Go through each element of LIST or PLIST.  */
452
  while (CONSP (tail1))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
453
    {
454
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
455

456
      /* First, remove the symbol if it's at the head of the list */
457
      while (CONSP (current_plist) && EQ (sym, XCAR (current_plist)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
458
	{
459
	  if (BUFFERP (object))
460 461 462
	    record_property_change (i->position, LENGTH (i),
				    sym, XCAR (XCDR (current_plist)),
				    object);
463

464
	  current_plist = XCDR (XCDR (current_plist));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
465 466 467
	  changed++;
	}

468
      /* Go through I's plist, looking for SYM.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
469 470 471
      tail2 = current_plist;
      while (! NILP (tail2))
	{
472
	  register Lisp_Object this;
473
	  this = XCDR (XCDR (tail2));
474
	  if (CONSP (this) && EQ (sym, XCAR (this)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
475
	    {
476
	      if (BUFFERP (object))
477 478
		record_property_change (i->position, LENGTH (i),
					sym, XCAR (XCDR (this)), object);
479

480
	      Fsetcdr (XCDR (tail2), XCDR (XCDR (this)));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
481 482 483 484
	      changed++;
	    }
	  tail2 = this;
	}
485 486

      /* Advance thru TAIL1 one way or the other.  */
487 488
      tail1 = XCDR (tail1);
      if (use_plist && CONSP (tail1))
489
	tail1 = XCDR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
490 491 492 493 494 495 496
    }

  if (changed)
    i->plist = current_plist;
  return changed;
}

497
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
498
/* Remove all properties from interval I.  Return non-zero
499
   if this changes the interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
500 501

static INLINE int
Andreas Schwab's avatar
Andreas Schwab committed
502
erase_properties (INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
503 504 505 506 507 508 509
{
  if (NILP (i->plist))
    return 0;

  i->plist = Qnil;
  return 1;
}
510
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
511

512
/* Returns the interval of POSITION in OBJECT.
513 514 515
   POSITION is BEG-based.  */

INTERVAL
516
interval_of (int position, Lisp_Object object)
517 518
{
  register INTERVAL i;
519
  EMACS_INT beg, end;
520 521 522

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
Karl Heuer's avatar
Karl Heuer committed
523 524
  else if (EQ (object, Qt))
    return NULL_INTERVAL;
525

526
  CHECK_STRING_OR_BUFFER (object);
527 528 529 530 531 532 533 534 535 536 537

  if (BUFFERP (object))
    {
      register struct buffer *b = XBUFFER (object);

      beg = BUF_BEGV (b);
      end = BUF_ZV (b);
      i = BUF_INTERVALS (b);
    }
  else
    {
538
      beg = 0;
539 540
      end = SCHARS (object);
      i = STRING_INTERVALS (object);
541 542 543
    }

  if (!(beg <= position && position <= end))
544
    args_out_of_range (make_number (position), make_number (position));
545 546
  if (beg == end || NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
547

548 549 550
  return find_interval (i, position);
}

551
DEFUE ("text-properties-at", Ftext_properties_at,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
552
       Stext_properties_at, 1, 2, 0,
553
       doc: /* Return the list of properties of the character at POSITION in OBJECT.
554 555 556
If the optional second argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.
557
If POSITION is at the end of OBJECT, the value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
558
  (Lisp_Object position, Lisp_Object object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
559 560 561 562
{
  register INTERVAL i;

  if (NILP (object))
563
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
564

565
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
566 567
  if (NULL_INTERVAL_P (i))
    return Qnil;
568
  /* If POSITION is at the end of the interval,
569 570 571
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
572
  if (XINT (position) == LENGTH (i) + i->position)
573
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
574 575 576 577

  return i->plist;
}

578
DEFUE ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
579 580 581
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
OBJECT is optional and defaults to the current buffer.
If POSITION is at the end of OBJECT, the value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
582
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object)
583
{
584
  return textget (Ftext_properties_at (position, object), prop);
585 586
}

587
/* Return the value of char's property PROP, in OBJECT at POSITION.
588 589 590 591 592 593 594 595 596 597 598
   OBJECT is optional and defaults to the current buffer.
   If OVERLAY is non-0, then in the case that the returned property is from
   an overlay, the overlay found is returned in *OVERLAY, otherwise nil is
   returned in *OVERLAY.
   If POSITION is at the end of OBJECT, the value is nil.
   If OBJECT is a buffer, then overlay properties are considered as well as
   text properties.
   If OBJECT is a window, then that window's buffer is used, but
   window-specific overlays are considered only if they are associated
   with OBJECT. */
Lisp_Object
599
get_char_property_and_overlay (Lisp_Object position, register Lisp_Object prop, Lisp_Object object, Lisp_Object *overlay)
600 601 602
{
  struct window *w = 0;

603
  CHECK_NUMBER_COERCE_MARKER (position);
604 605

  if (NILP (object))
606
    XSETBUFFER (object, current_buffer);
607 608 609 610

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
611
      object = w->buffer;
612 613 614 615
    }
  if (BUFFERP (object))
    {
      int noverlays;
616
      Lisp_Object *overlay_vec;
617 618
      struct buffer *obuf = current_buffer;

619 620 621 622
      if (XINT (position) < BUF_BEGV (XBUFFER (object))
	  || XINT (position) > BUF_ZV (XBUFFER (object)))
	xsignal1 (Qargs_out_of_range, position);

623
      set_buffer_temp (XBUFFER (object));
624

625
      GET_OVERLAYS_AT (XINT (position), overlay_vec, noverlays, NULL, 0);
626 627
      noverlays = sort_overlays (overlay_vec, noverlays, w);

628 629
      set_buffer_temp (obuf);

630 631 632
      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
633
	  Lisp_Object tem = Foverlay_get (overlay_vec[noverlays], prop);
634
	  if (!NILP (tem))
635 636 637 638 639 640
	    {
	      if (overlay)
		/* Return the overlay we got the property from.  */
		*overlay = overlay_vec[noverlays];
	      return tem;
	    }
641 642
	}
    }
643 644 645 646 647

  if (overlay)
    /* Indicate that the return value is not from an overlay.  */
    *overlay = Qnil;

648 649
  /* Not a buffer, or no appropriate overlay, so fall through to the
     simpler case.  */
650 651 652
  return Fget_text_property (position, prop, object);
}

653
DEFUE ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
654
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
655
Both overlay properties and text properties are checked.
656 657 658 659 660 661
OBJECT is optional and defaults to the current buffer.
If POSITION is at the end of OBJECT, the value is nil.
If OBJECT is a buffer, then overlay properties are considered as well as
text properties.
If OBJECT is a window, then that window's buffer is used, but window-specific
overlays are considered only if they are associated with OBJECT.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
662
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object)
663 664
{
  return get_char_property_and_overlay (position, prop, object, 0);
665
}
666 667 668 669

DEFUN ("get-char-property-and-overlay", Fget_char_property_and_overlay,
       Sget_char_property_and_overlay, 2, 3, 0,
       doc: /* Like `get-char-property', but with extra overlay information.
670 671 672
The value is a cons cell.  Its car is the return value of `get-char-property'
with the same arguments--that is, the value of POSITION's property
PROP in OBJECT.  Its cdr is the overlay in which the property was
673
found, or nil, if it was found as a text property or not found at all.
674

675 676 677 678 679 680
OBJECT is optional and defaults to the current buffer.  OBJECT may be
a string, a buffer or a window.  For strings, the cdr of the return
value is always nil, since strings do not have overlays.  If OBJECT is
a window, then that window's buffer is used, but window-specific
overlays are considered only if they are associated with OBJECT.  If
POSITION is at the end of OBJECT, both car and cdr are nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
681
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object)
682 683 684 685
{
  Lisp_Object overlay;
  Lisp_Object val
    = get_char_property_and_overlay (position, prop, object, &overlay);
Richard M. Stallman's avatar
Richard M. Stallman committed
686
  return Fcons (val, overlay);
687 688
}

689

690
DEFUE ("next-char-property-change", Fnext_char_property_change,
691
       Snext_char_property_change, 1, 2, 0,
692
       doc: /* Return the position of next text property or overlay change.
693 694 695
This scans characters forward in the current buffer from POSITION till
it finds a change in some text property, or the beginning or end of an
overlay, and returns the position of that.
696
If none is found up to (point-max), the function returns (point-max).
697

698
If the optional second argument LIMIT is non-nil, don't search
699 700
past position LIMIT; return LIMIT if nothing is found before LIMIT.
LIMIT is a no-op if it is greater than (point-max).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
701
  (Lisp_Object position, Lisp_Object limit)
702 703 704 705 706 707
{
  Lisp_Object temp;

  temp = Fnext_overlay_change (position);
  if (! NILP (limit))
    {
David Kastrup's avatar
David Kastrup committed
708
      CHECK_NUMBER_COERCE_MARKER (limit);
709 710 711 712 713 714
      if (XINT (limit) < XINT (temp))
	temp = limit;
    }
  return Fnext_property_change (position, Qnil, temp);
}

715
DEFUE ("previous-char-property-change", Fprevious_char_property_change,
716
       Sprevious_char_property_change, 1, 2, 0,
717
       doc: /* Return the position of previous text property or overlay change.
718 719 720
Scans characters backward in the current buffer from POSITION till it
finds a change in some text property, or the beginning or end of an
overlay, and returns the position of that.
721
If none is found since (point-min), the function returns (point-min).
722

723
If the optional second argument LIMIT is non-nil, don't search
724 725
past position LIMIT; return LIMIT if nothing is found before LIMIT.
LIMIT is a no-op if it is less than (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
726
  (Lisp_Object position, Lisp_Object limit)
727 728
{
  Lisp_Object temp;
729

730 731 732
  temp = Fprevious_overlay_change (position);
  if (! NILP (limit))
    {
David Kastrup's avatar
David Kastrup committed
733
      CHECK_NUMBER_COERCE_MARKER (limit);
734 735 736 737 738
      if (XINT (limit) > XINT (temp))
	temp = limit;
    }
  return Fprevious_property_change (position, Qnil, temp);
}
739 740


741
DEFUE ("next-single-char-property-change", Fnext_single_char_property_change,
742
       Snext_single_char_property_change, 2, 4, 0,
743 744 745
       doc: /* Return the position of next text property or overlay change for a specific property.
Scans characters forward from POSITION till it finds
a change in the PROP property, then returns the position of the change.
746 747 748 749
If the optional third argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.

750 751 752
In a string, scan runs to the end of the string.
In a buffer, it runs to (point-max), and the value cannot exceed that.

753 754 755 756 757
The property values are compared with `eq'.
If the property is constant all the way to the end of OBJECT, return the
last valid position in OBJECT.
If the optional fourth argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
758
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object, Lisp_Object limit)
759 760 761
{
  if (STRINGP (object))
    {
762 763
      position = Fnext_single_property_change (position, prop, object, limit);
      if (NILP (position))
764 765
	{
	  if (NILP (limit))
766
	    position = make_number (SCHARS (object));
767
	  else
David Kastrup's avatar
David Kastrup committed
768 769 770 771
	    {
	      CHECK_NUMBER (limit);
	      position = limit;
	    }
772 773 774 775 776
	}
    }
  else
    {
      Lisp_Object initial_value, value;
Juanma Barranquero's avatar
Juanma Barranquero committed
777
      int count = SPECPDL_INDEX ();
778

779
      if (! NILP (object))
780
	CHECK_BUFFER (object);
781

782 783 784 785 786 787
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}

David Kastrup's avatar
David Kastrup committed
788 789
      CHECK_NUMBER_COERCE_MARKER (position);

790
      initial_value = Fget_char_property (position, prop, object);
791

792
      if (NILP (limit))
793
	XSETFASTINT (limit, ZV);
794
      else
795
	CHECK_NUMBER_COERCE_MARKER (limit);
796

797
      if (XFASTINT (position) >= XFASTINT (limit))
798
	{
799 800 801
	  position = limit;
	  if (XFASTINT (position) > ZV)
	    XSETFASTINT (position, ZV);
802
	}
803 804 805 806 807 808 809 810 811 812 813 814 815 816
      else
	while (1)
	  {
	    position = Fnext_char_property_change (position, limit);
	    if (XFASTINT (position) >= XFASTINT (limit))
	      {
		position = limit;
		break;
	      }

	    value = Fget_char_property (position, prop, object);
	    if (!EQ (value, initial_value))
	      break;
	  }
817 818 819 820

      unbind_to (count, Qnil);
    }

821
  return position;
822 823
}

824
DEFUE ("previous-single-char-property-change",
825 826
       Fprevious_single_char_property_change,
       Sprevious_single_char_property_change, 2, 4, 0,
827 828 829
       doc: /* Return the position of previous text property or overlay change for a specific property.
Scans characters backward from POSITION till it finds
a change in the PROP property, then returns the position of the change.
830 831 832 833
If the optional third argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.

834 835 836
In a string, scan runs to the start of the string.
In a buffer, it runs to (point-min), and the value cannot be less than that.

837 838 839 840 841
The property values are compared with `eq'.
If the property is constant all the way to the start of OBJECT, return the
first valid position in OBJECT.
If the optional fourth argument LIMIT is non-nil, don't search
back past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
842
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object, Lisp_Object limit)
843 844 845 846 847 848 849
{
  if (STRINGP (object))
    {
      position = Fprevious_single_property_change (position, prop, object, limit);
      if (NILP (position))
	{
	  if (NILP (limit))
850
	    position = make_number (0);
851
	  else
David Kastrup's avatar
David Kastrup committed
852 853 854 855
	    {
	      CHECK_NUMBER (limit);
	      position = limit;
	    }
856 857 858 859
	}
    }
  else
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
860
      int count = SPECPDL_INDEX ();
861 862

      if (! NILP (object))
863
	CHECK_BUFFER (object);
864

865 866 867 868 869
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}
870

David Kastrup's avatar
David Kastrup committed
871 872
      CHECK_NUMBER_COERCE_MARKER (position);

873
      if (NILP (limit))
874
	XSETFASTINT (limit, BEGV);
875
      else
876
	CHECK_NUMBER_COERCE_MARKER (limit);
877

878
      if (XFASTINT (position) <= XFASTINT (limit))
879 880 881 882 883
	{
	  position = limit;
	  if (XFASTINT (position) < BEGV)
	    XSETFASTINT (position, BEGV);
	}
884
      else
885
	{
886 887 888
	  Lisp_Object initial_value
	    = Fget_char_property (make_number (XFASTINT (position) - 1),
				  prop, object);
889

890
	  while (1)
891 892
	    {
	      position = Fprevious_char_property_change (position, limit);
893

894 895 896 897 898 899 900
	      if (XFASTINT (position) <= XFASTINT (limit))
		{
		  position = limit;
		  break;
		}
	      else
		{
901 902 903
		  Lisp_Object value
		    = Fget_char_property (make_number (XFASTINT (position) - 1),
					  prop, object);
904 905 906 907 908

		  if (!EQ (value, initial_value))
		    break;
		}
	    }
909 910 911 912 913 914 915
	}

      unbind_to (count, Qnil);
    }

  return position;
}
916

917
DEFUE ("next-property-change", Fnext_property_change,
918
       Snext_property_change, 1, 3, 0,
919 920 921
       doc: /* Return the position of next property change.
Scans characters forward from POSITION in OBJECT till it finds
a change in some text property, then returns the position of the change.
922 923 924
If the optional second argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.
925 926 927 928 929
Return nil if the property is constant all the way to the end of OBJECT.
If the value is non-nil, it is a position greater than POSITION, never equal.

If the optional third argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
930
  (Lisp_Object position, Lisp_Object object, Lisp_Object limit)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
931