* lisp/emacs-lisp/pcase.el (pcase--expand): Warn for unused pattern.
[emacs.git] / src / region-cache.c
blob2642e824680011451aee8439b14cb9736bec9cc2
1 /* Caching facts about regions of the buffer, for optimization.
3 Copyright (C) 1985-1989, 1993, 1995, 2001-2012
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #include "lisp.h"
27 #include "character.h"
28 #include "buffer.h"
29 #include "region-cache.h"
32 /* Data structures. */
34 /* The region cache.
36 We want something that maps character positions in a buffer onto
37 values. The representation should deal well with long runs of
38 characters with the same value.
40 The tricky part: the representation should be very cheap to
41 maintain in the presence of many insertions and deletions. If the
42 overhead of maintaining the cache is too high, the speedups it
43 offers will be worthless.
46 We represent the region cache as a sorted array of struct
47 boundary's, each of which contains a buffer position and a value;
48 the value applies to all the characters after the buffer position,
49 until the position of the next boundary, or the end of the buffer.
51 The cache always has a boundary whose position is BUF_BEG, so
52 there's always a value associated with every character in the
53 buffer. Since the cache is sorted, this is always the first
54 element of the cache.
56 To facilitate the insertion and deletion of boundaries in the
57 cache, the cache has a gap, just like Emacs's text buffers do.
59 To help boundary positions float along with insertions and
60 deletions, all boundary positions before the cache gap are stored
61 relative to BUF_BEG (buf) (thus they're >= 0), and all boundary
62 positions after the gap are stored relative to BUF_Z (buf) (thus
63 they're <= 0). Look at BOUNDARY_POS to see this in action. See
64 revalidate_region_cache to see how this helps. */
66 struct boundary {
67 ptrdiff_t pos;
68 int value;
71 struct region_cache {
72 /* A sorted array of locations where the known-ness of the buffer
73 changes. */
74 struct boundary *boundaries;
76 /* boundaries[gap_start ... gap_start + gap_len - 1] is the gap. */
77 ptrdiff_t gap_start, gap_len;
79 /* The number of elements allocated to boundaries, not including the
80 gap. */
81 ptrdiff_t cache_len;
83 /* The areas that haven't changed since the last time we cleaned out
84 invalid entries from the cache. These overlap when the buffer is
85 entirely unchanged. */
86 ptrdiff_t beg_unchanged, end_unchanged;
88 /* The first and last positions in the buffer. Because boundaries
89 store their positions relative to the start (BEG) and end (Z) of
90 the buffer, knowing these positions allows us to accurately
91 interpret positions without having to pass the buffer structure
92 or its endpoints around all the time.
94 Yes, buffer_beg is always 1. It's there for symmetry with
95 buffer_end and the BEG and BUF_BEG macros. */
96 ptrdiff_t buffer_beg, buffer_end;
99 /* Return the position of boundary i in cache c. */
100 #define BOUNDARY_POS(c, i) \
101 ((i) < (c)->gap_start \
102 ? (c)->buffer_beg + (c)->boundaries[(i)].pos \
103 : (c)->buffer_end + (c)->boundaries[(c)->gap_len + (i)].pos)
105 /* Return the value for text after boundary i in cache c. */
106 #define BOUNDARY_VALUE(c, i) \
107 ((i) < (c)->gap_start \
108 ? (c)->boundaries[(i)].value \
109 : (c)->boundaries[(c)->gap_len + (i)].value)
111 /* Set the value for text after boundary i in cache c to v. */
112 #define SET_BOUNDARY_VALUE(c, i, v) \
113 ((i) < (c)->gap_start \
114 ? ((c)->boundaries[(i)].value = (v))\
115 : ((c)->boundaries[(c)->gap_len + (i)].value = (v)))
118 /* How many elements to add to the gap when we resize the buffer. */
119 #define NEW_CACHE_GAP (40)
121 /* See invalidate_region_cache; if an invalidation would throw away
122 information about this many characters, call
123 revalidate_region_cache before doing the new invalidation, to
124 preserve that information, instead of throwing it away. */
125 #define PRESERVE_THRESHOLD (500)
127 static void revalidate_region_cache (struct buffer *buf, struct region_cache *c);
130 /* Interface: Allocating, initializing, and disposing of region caches. */
132 struct region_cache *
133 new_region_cache (void)
135 struct region_cache *c
136 = (struct region_cache *) xmalloc (sizeof (struct region_cache));
138 c->gap_start = 0;
139 c->gap_len = NEW_CACHE_GAP;
140 c->cache_len = 0;
141 c->boundaries =
142 (struct boundary *) xmalloc ((c->gap_len + c->cache_len)
143 * sizeof (*c->boundaries));
145 c->beg_unchanged = 0;
146 c->end_unchanged = 0;
147 c->buffer_beg = BEG;
148 c->buffer_end = BEG;
150 /* Insert the boundary for the buffer start. */
151 c->cache_len++;
152 c->gap_len--;
153 c->gap_start++;
154 c->boundaries[0].pos = 0; /* from buffer_beg */
155 c->boundaries[0].value = 0;
157 return c;
160 void
161 free_region_cache (struct region_cache *c)
163 xfree (c->boundaries);
164 xfree (c);
168 /* Finding positions in the cache. */
170 /* Return the index of the last boundary in cache C at or before POS.
171 In other words, return the boundary that specifies the value for
172 the region POS..(POS + 1).
174 This operation should be logarithmic in the number of cache
175 entries. It would be nice if it took advantage of locality of
176 reference, too, by searching entries near the last entry found. */
177 static ptrdiff_t
178 find_cache_boundary (struct region_cache *c, ptrdiff_t pos)
180 ptrdiff_t low = 0, high = c->cache_len;
182 while (low + 1 < high)
184 /* mid is always a valid index, because low < high and ">> 1"
185 rounds down. */
186 ptrdiff_t mid = (low >> 1) + (high >> 1) + (low & high & 1);
187 ptrdiff_t boundary = BOUNDARY_POS (c, mid);
189 if (pos < boundary)
190 high = mid;
191 else
192 low = mid;
195 /* Some testing. */
196 if (BOUNDARY_POS (c, low) > pos
197 || (low + 1 < c->cache_len
198 && BOUNDARY_POS (c, low + 1) <= pos))
199 abort ();
201 return low;
206 /* Moving the cache gap around, inserting, and deleting. */
209 /* Move the gap of cache C to index POS, and make sure it has space
210 for at least MIN_SIZE boundaries. */
211 static void
212 move_cache_gap (struct region_cache *c, ptrdiff_t pos, ptrdiff_t min_size)
214 /* Copy these out of the cache and into registers. */
215 ptrdiff_t gap_start = c->gap_start;
216 ptrdiff_t gap_len = c->gap_len;
217 ptrdiff_t buffer_beg = c->buffer_beg;
218 ptrdiff_t buffer_end = c->buffer_end;
220 if (pos < 0
221 || pos > c->cache_len)
222 abort ();
224 /* We mustn't ever try to put the gap before the dummy start
225 boundary. That must always be start-relative. */
226 if (pos == 0)
227 abort ();
229 /* Need we move the gap right? */
230 while (gap_start < pos)
232 /* Copy one boundary from after to before the gap, and
233 convert its position to start-relative. */
234 c->boundaries[gap_start].pos
235 = (buffer_end
236 + c->boundaries[gap_start + gap_len].pos
237 - buffer_beg);
238 c->boundaries[gap_start].value
239 = c->boundaries[gap_start + gap_len].value;
240 gap_start++;
243 /* To enlarge the gap, we need to re-allocate the boundary array, and
244 then shift the area after the gap to the new end. Since the cost
245 is proportional to the amount of stuff after the gap, we do the
246 enlargement here, after a right shift but before a left shift,
247 when the portion after the gap is smallest. */
248 if (gap_len < min_size)
250 ptrdiff_t i;
252 c->boundaries =
253 xpalloc (c->boundaries, &c->cache_len, min_size, -1,
254 sizeof *c->boundaries);
256 /* Some systems don't provide a version of the copy routine that
257 can be trusted to shift memory upward into an overlapping
258 region. memmove isn't widely available. */
259 min_size -= gap_len;
260 for (i = c->cache_len - 1; i >= gap_start; i--)
262 c->boundaries[i + min_size].pos = c->boundaries[i + gap_len].pos;
263 c->boundaries[i + min_size].value = c->boundaries[i + gap_len].value;
266 gap_len = min_size;
269 /* Need we move the gap left? */
270 while (pos < gap_start)
272 gap_start--;
274 /* Copy one region from before to after the gap, and
275 convert its position to end-relative. */
276 c->boundaries[gap_start + gap_len].pos
277 = c->boundaries[gap_start].pos + buffer_beg - buffer_end;
278 c->boundaries[gap_start + gap_len].value
279 = c->boundaries[gap_start].value;
282 /* Assign these back into the cache. */
283 c->gap_start = gap_start;
284 c->gap_len = gap_len;
288 /* Insert a new boundary in cache C; it will have cache index I,
289 and have the specified POS and VALUE. */
290 static void
291 insert_cache_boundary (struct region_cache *c, ptrdiff_t i, ptrdiff_t pos,
292 int value)
294 /* i must be a valid cache index. */
295 if (i < 0 || i > c->cache_len)
296 abort ();
298 /* We must never want to insert something before the dummy first
299 boundary. */
300 if (i == 0)
301 abort ();
303 /* We must only be inserting things in order. */
304 if (! (BOUNDARY_POS (c, i - 1) < pos
305 && (i == c->cache_len
306 || pos < BOUNDARY_POS (c, i))))
307 abort ();
309 /* The value must be different from the ones around it. However, we
310 temporarily create boundaries that establish the same value as
311 the subsequent boundary, so we're not going to flag that case. */
312 if (BOUNDARY_VALUE (c, i - 1) == value)
313 abort ();
315 move_cache_gap (c, i, 1);
317 c->boundaries[i].pos = pos - c->buffer_beg;
318 c->boundaries[i].value = value;
319 c->gap_start++;
320 c->gap_len--;
321 c->cache_len++;
325 /* Delete the i'th entry from cache C if START <= i < END. */
327 static void
328 delete_cache_boundaries (struct region_cache *c,
329 ptrdiff_t start, ptrdiff_t end)
331 ptrdiff_t len = end - start;
333 /* Gotta be in range. */
334 if (start < 0
335 || end > c->cache_len)
336 abort ();
338 /* Gotta be in order. */
339 if (start > end)
340 abort ();
342 /* Can't delete the dummy entry. */
343 if (start == 0
344 && end >= 1)
345 abort ();
347 /* Minimize gap motion. If we're deleting nothing, do nothing. */
348 if (len == 0)
350 /* If the gap is before the region to delete, delete from the start
351 forward. */
352 else if (c->gap_start <= start)
354 move_cache_gap (c, start, 0);
355 c->gap_len += len;
357 /* If the gap is after the region to delete, delete from the end
358 backward. */
359 else if (end <= c->gap_start)
361 move_cache_gap (c, end, 0);
362 c->gap_start -= len;
363 c->gap_len += len;
365 /* If the gap is in the region to delete, just expand it. */
366 else
368 c->gap_start = start;
369 c->gap_len += len;
372 c->cache_len -= len;
377 /* Set the value for a region. */
379 /* Set the value in cache C for the region START..END to VALUE. */
380 static void
381 set_cache_region (struct region_cache *c,
382 ptrdiff_t start, ptrdiff_t end, int value)
384 if (start > end)
385 abort ();
386 if (start < c->buffer_beg
387 || end > c->buffer_end)
388 abort ();
390 /* Eliminate this case; then we can assume that start and end-1 are
391 both the locations of real characters in the buffer. */
392 if (start == end)
393 return;
396 /* We need to make sure that there are no boundaries in the area
397 between start to end; the whole area will have the same value,
398 so those boundaries will not be necessary.
400 Let start_ix be the cache index of the boundary governing the
401 first character of start..end, and let end_ix be the cache
402 index of the earliest boundary after the last character in
403 start..end. (This tortured terminology is intended to answer
404 all the "< or <=?" sort of questions.) */
405 ptrdiff_t start_ix = find_cache_boundary (c, start);
406 ptrdiff_t end_ix = find_cache_boundary (c, end - 1) + 1;
408 /* We must remember the value established by the last boundary
409 before end; if that boundary's domain stretches beyond end,
410 we'll need to create a new boundary at end, and that boundary
411 must have that remembered value. */
412 int value_at_end = BOUNDARY_VALUE (c, end_ix - 1);
414 /* Delete all boundaries strictly within start..end; this means
415 those whose indices are between start_ix (exclusive) and end_ix
416 (exclusive). */
417 delete_cache_boundaries (c, start_ix + 1, end_ix);
419 /* Make sure we have the right value established going in to
420 start..end from the left, and no unnecessary boundaries. */
421 if (BOUNDARY_POS (c, start_ix) == start)
423 /* Is this boundary necessary? If no, remove it; if yes, set
424 its value. */
425 if (start_ix > 0
426 && BOUNDARY_VALUE (c, start_ix - 1) == value)
428 delete_cache_boundaries (c, start_ix, start_ix + 1);
429 start_ix--;
431 else
432 SET_BOUNDARY_VALUE (c, start_ix, value);
434 else
436 /* Do we need to add a new boundary here? */
437 if (BOUNDARY_VALUE (c, start_ix) != value)
439 insert_cache_boundary (c, start_ix + 1, start, value);
440 start_ix++;
444 /* This is equivalent to letting end_ix float (like a buffer
445 marker does) with the insertions and deletions we may have
446 done. */
447 end_ix = start_ix + 1;
449 /* Make sure we have the correct value established as we leave
450 start..end to the right. */
451 if (end == c->buffer_end)
452 /* There is no text after start..end; nothing to do. */
454 else if (end_ix >= c->cache_len
455 || end < BOUNDARY_POS (c, end_ix))
457 /* There is no boundary at end, but we may need one. */
458 if (value_at_end != value)
459 insert_cache_boundary (c, end_ix, end, value_at_end);
461 else
463 /* There is a boundary at end; should it be there? */
464 if (value == BOUNDARY_VALUE (c, end_ix))
465 delete_cache_boundaries (c, end_ix, end_ix + 1);
472 /* Interface: Invalidating the cache. Private: Re-validating the cache. */
474 /* Indicate that a section of BUF has changed, to invalidate CACHE.
475 HEAD is the number of chars unchanged at the beginning of the buffer.
476 TAIL is the number of chars unchanged at the end of the buffer.
477 NOTE: this is *not* the same as the ending position of modified
478 region.
479 (This way of specifying regions makes more sense than absolute
480 buffer positions in the presence of insertions and deletions; the
481 args to pass are the same before and after such an operation.) */
482 void
483 invalidate_region_cache (struct buffer *buf, struct region_cache *c,
484 ptrdiff_t head, ptrdiff_t tail)
486 /* Let chead = c->beg_unchanged, and
487 ctail = c->end_unchanged.
488 If z-tail < beg+chead by a large amount, or
489 z-ctail < beg+head by a large amount,
491 then cutting back chead and ctail to head and tail would lose a
492 lot of information that we could preserve by revalidating the
493 cache before processing this invalidation. Losing that
494 information may be more costly than revalidating the cache now.
495 So go ahead and call revalidate_region_cache if it seems that it
496 might be worthwhile. */
497 if (((BUF_BEG (buf) + c->beg_unchanged) - (BUF_Z (buf) - tail)
498 > PRESERVE_THRESHOLD)
499 || ((BUF_BEG (buf) + head) - (BUF_Z (buf) - c->end_unchanged)
500 > PRESERVE_THRESHOLD))
501 revalidate_region_cache (buf, c);
504 if (head < c->beg_unchanged)
505 c->beg_unchanged = head;
506 if (tail < c->end_unchanged)
507 c->end_unchanged = tail;
509 /* We now know nothing about the region between the unchanged head
510 and the unchanged tail (call it the "modified region"), not even
511 its length.
513 If the modified region has shrunk in size (deletions do this),
514 then the cache may now contain boundaries originally located in
515 text that doesn't exist any more.
517 If the modified region has increased in size (insertions do
518 this), then there may now be boundaries in the modified region
519 whose positions are wrong.
521 Even calling BOUNDARY_POS on boundaries still in the unchanged
522 head or tail may well give incorrect answers now, since
523 c->buffer_beg and c->buffer_end may well be wrong now. (Well,
524 okay, c->buffer_beg never changes, so boundaries in the unchanged
525 head will still be okay. But it's the principle of the thing.)
527 So things are generally a mess.
529 But we don't clean up this mess here; that would be expensive,
530 and this function gets called every time any buffer modification
531 occurs. Rather, we can clean up everything in one swell foop,
532 accounting for all the modifications at once, by calling
533 revalidate_region_cache before we try to consult the cache the
534 next time. */
538 /* Clean out any cache entries applying to the modified region, and
539 make the positions of the remaining entries accurate again.
541 After calling this function, the mess described in the comment in
542 invalidate_region_cache is cleaned up.
544 This function operates by simply throwing away everything it knows
545 about the modified region. It doesn't care exactly which
546 insertions and deletions took place; it just tosses it all.
548 For example, if you insert a single character at the beginning of
549 the buffer, and a single character at the end of the buffer (for
550 example), without calling this function in between the two
551 insertions, then the entire cache will be freed of useful
552 information. On the other hand, if you do manage to call this
553 function in between the two insertions, then the modified regions
554 will be small in both cases, no information will be tossed, and the
555 cache will know that it doesn't have knowledge of the first and
556 last characters any more.
558 Calling this function may be expensive; it does binary searches in
559 the cache, and causes cache gap motion. */
561 static void
562 revalidate_region_cache (struct buffer *buf, struct region_cache *c)
564 /* The boundaries now in the cache are expressed relative to the
565 buffer_beg and buffer_end values stored in the cache. Now,
566 buffer_beg and buffer_end may not be the same as BUF_BEG (buf)
567 and BUF_Z (buf), so we have two different "bases" to deal with
568 --- the cache's, and the buffer's. */
570 /* If the entire buffer is still valid, don't waste time. Yes, this
571 should be a >, not a >=; think about what beg_unchanged and
572 end_unchanged get set to when the only change has been an
573 insertion. */
574 if (c->buffer_beg + c->beg_unchanged
575 > c->buffer_end - c->end_unchanged)
576 return;
578 /* If all the text we knew about as of the last cache revalidation
579 is still there, then all of the information in the cache is still
580 valid. Because c->buffer_beg and c->buffer_end are out-of-date,
581 the modified region appears from the cache's point of view to be
582 a null region located someplace in the buffer.
584 Now, invalidating that empty string will have no actual affect on
585 the cache; instead, we need to update the cache's basis first
586 (which will give the modified region the same size in the cache
587 as it has in the buffer), and then invalidate the modified
588 region. */
589 if (c->buffer_beg + c->beg_unchanged
590 == c->buffer_end - c->end_unchanged)
592 /* Move the gap so that all the boundaries in the unchanged head
593 are expressed beg-relative, and all the boundaries in the
594 unchanged tail are expressed end-relative. That done, we can
595 plug in the new buffer beg and end, and all the positions
596 will be accurate.
598 The boundary which has jurisdiction over the modified region
599 should be left before the gap. */
600 move_cache_gap (c,
601 (find_cache_boundary (c, (c->buffer_beg
602 + c->beg_unchanged))
603 + 1),
606 c->buffer_beg = BUF_BEG (buf);
607 c->buffer_end = BUF_Z (buf);
609 /* Now that the cache's basis has been changed, the modified
610 region actually takes up some space in the cache, so we can
611 invalidate it. */
612 set_cache_region (c,
613 c->buffer_beg + c->beg_unchanged,
614 c->buffer_end - c->end_unchanged,
618 /* Otherwise, there is a non-empty region in the cache which
619 corresponds to the modified region of the buffer. */
620 else
622 ptrdiff_t modified_ix;
624 /* These positions are correct, relative to both the cache basis
625 and the buffer basis. */
626 set_cache_region (c,
627 c->buffer_beg + c->beg_unchanged,
628 c->buffer_end - c->end_unchanged,
631 /* Now the cache contains only boundaries that are in the
632 unchanged head and tail; we've disposed of any boundaries
633 whose positions we can't be sure of given the information
634 we've saved.
636 If we put the cache gap between the unchanged head and the
637 unchanged tail, we can adjust all the boundary positions at
638 once, simply by setting buffer_beg and buffer_end.
640 The boundary which has jurisdiction over the modified region
641 should be left before the gap. */
642 modified_ix =
643 find_cache_boundary (c, (c->buffer_beg + c->beg_unchanged)) + 1;
644 move_cache_gap (c, modified_ix, 0);
646 c->buffer_beg = BUF_BEG (buf);
647 c->buffer_end = BUF_Z (buf);
649 /* Now, we may have shrunk the buffer when we changed the basis,
650 and brought the boundaries we created for the start and end
651 of the modified region together, giving them the same
652 position. If that's the case, we should collapse them into
653 one boundary. Or we may even delete them both, if the values
654 before and after them are the same. */
655 if (modified_ix < c->cache_len
656 && (BOUNDARY_POS (c, modified_ix - 1)
657 == BOUNDARY_POS (c, modified_ix)))
659 int value_after = BOUNDARY_VALUE (c, modified_ix);
661 /* Should we remove both of the boundaries? Yes, if the
662 latter boundary is now establishing the same value that
663 the former boundary's predecessor does. */
664 if (modified_ix - 1 > 0
665 && value_after == BOUNDARY_VALUE (c, modified_ix - 2))
666 delete_cache_boundaries (c, modified_ix - 1, modified_ix + 1);
667 else
669 /* We do need a boundary here; collapse the two
670 boundaries into one. */
671 SET_BOUNDARY_VALUE (c, modified_ix - 1, value_after);
672 delete_cache_boundaries (c, modified_ix, modified_ix + 1);
677 /* Now the entire cache is valid. */
678 c->beg_unchanged
679 = c->end_unchanged
680 = c->buffer_end - c->buffer_beg;
684 /* Interface: Adding information to the cache. */
686 /* Assert that the region of BUF between START and END (absolute
687 buffer positions) is "known," for the purposes of CACHE (e.g. "has
688 no newlines", in the case of the line cache). */
689 void
690 know_region_cache (struct buffer *buf, struct region_cache *c,
691 ptrdiff_t start, ptrdiff_t end)
693 revalidate_region_cache (buf, c);
695 set_cache_region (c, start, end, 1);
699 /* Interface: using the cache. */
701 /* Return true if the text immediately after POS in BUF is known, for
702 the purposes of CACHE. If NEXT is non-zero, set *NEXT to the nearest
703 position after POS where the knowledge changes. */
705 region_cache_forward (struct buffer *buf, struct region_cache *c,
706 ptrdiff_t pos, ptrdiff_t *next)
708 revalidate_region_cache (buf, c);
711 ptrdiff_t i = find_cache_boundary (c, pos);
712 int i_value = BOUNDARY_VALUE (c, i);
713 ptrdiff_t j;
715 /* Beyond the end of the buffer is unknown, by definition. */
716 if (pos >= BUF_Z (buf))
718 if (next) *next = BUF_Z (buf);
719 i_value = 0;
721 else if (next)
723 /* Scan forward from i to find the next differing position. */
724 for (j = i + 1; j < c->cache_len; j++)
725 if (BOUNDARY_VALUE (c, j) != i_value)
726 break;
728 if (j < c->cache_len)
729 *next = BOUNDARY_POS (c, j);
730 else
731 *next = BUF_Z (buf);
734 return i_value;
738 /* Return true if the text immediately before POS in BUF is known, for
739 the purposes of CACHE. If NEXT is non-zero, set *NEXT to the nearest
740 position before POS where the knowledge changes. */
741 int region_cache_backward (struct buffer *buf, struct region_cache *c,
742 ptrdiff_t pos, ptrdiff_t *next)
744 revalidate_region_cache (buf, c);
746 /* Before the beginning of the buffer is unknown, by
747 definition. */
748 if (pos <= BUF_BEG (buf))
750 if (next) *next = BUF_BEG (buf);
751 return 0;
755 ptrdiff_t i = find_cache_boundary (c, pos - 1);
756 int i_value = BOUNDARY_VALUE (c, i);
757 ptrdiff_t j;
759 if (next)
761 /* Scan backward from i to find the next differing position. */
762 for (j = i - 1; j >= 0; j--)
763 if (BOUNDARY_VALUE (c, j) != i_value)
764 break;
766 if (j >= 0)
767 *next = BOUNDARY_POS (c, j + 1);
768 else
769 *next = BUF_BEG (buf);
772 return i_value;
777 /* Debugging: pretty-print a cache to the standard error output. */
779 void pp_cache (struct region_cache *) EXTERNALLY_VISIBLE;
780 void
781 pp_cache (struct region_cache *c)
783 ptrdiff_t i;
784 ptrdiff_t beg_u = c->buffer_beg + c->beg_unchanged;
785 ptrdiff_t end_u = c->buffer_end - c->end_unchanged;
787 fprintf (stderr,
788 "basis: %"pD"d..%"pD"d modified: %"pD"d..%"pD"d\n",
789 c->buffer_beg, c->buffer_end,
790 beg_u, end_u);
792 for (i = 0; i < c->cache_len; i++)
794 ptrdiff_t pos = BOUNDARY_POS (c, i);
796 putc (((pos < beg_u) ? 'v'
797 : (pos == beg_u) ? '-'
798 : ' '),
799 stderr);
800 putc (((pos > end_u) ? '^'
801 : (pos == end_u) ? '-'
802 : ' '),
803 stderr);
804 fprintf (stderr, "%"pD"d : %d\n", pos, BOUNDARY_VALUE (c, i));