bidi.c 71.2 KB
Newer Older
1
/* Low-level bidirectional buffer/string-scanning functions for GNU Emacs.
2
   Copyright (C) 2000-2001, 2004-2005, 2009-2011
3
   Free Software Foundation, Inc.
Eli Zaretskii's avatar
Eli Zaretskii committed
4 5 6

This file is part of GNU Emacs.

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

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

20 21 22
/* Written by Eli Zaretskii <eliz@gnu.org>.

   A sequential implementation of the Unicode Bidirectional algorithm,
23
   (UBA) as per UAX#9, a part of the Unicode Standard.
Eli Zaretskii's avatar
Eli Zaretskii committed
24 25

   Unlike the reference and most other implementations, this one is
26 27
   designed to be called once for every character in the buffer or
   string.
Eli Zaretskii's avatar
Eli Zaretskii committed
28

29
   The main entry point is bidi_move_to_visually_next.  Each time it
Eli Zaretskii's avatar
Eli Zaretskii committed
30 31 32
   is called, it finds the next character in the visual order, and
   returns its information in a special structure.  The caller is then
   expected to process this character for display or any other
33 34 35
   purposes, and call bidi_move_to_visually_next for the next
   character.  See the comments in bidi_move_to_visually_next for more
   details about its algorithm that finds the next visual-order
Eli Zaretskii's avatar
Eli Zaretskii committed
36 37
   character by resolving their levels on the fly.

38 39 40 41 42
   The two other entry points are bidi_paragraph_init and
   bidi_mirror_char.  The first determines the base direction of a
   paragraph, while the second returns the mirrored version of its
   argument character.

43 44 45 46
   If you want to understand the code, you will have to read it
   together with the relevant portions of UAX#9.  The comments include
   references to UAX#9 rules, for that very reason.

Eli Zaretskii's avatar
Eli Zaretskii committed
47 48 49 50 51 52 53
   A note about references to UAX#9 rules: if the reference says
   something like "X9/Retaining", it means that you need to refer to
   rule X9 and to its modifications decribed in the "Implementation
   Notes" section of UAX#9, under "Retaining Format Codes".  */

#include <config.h>
#include <stdio.h>
54 55
#include <setjmp.h>

Eli Zaretskii's avatar
Eli Zaretskii committed
56 57 58 59 60 61 62
#include "lisp.h"
#include "buffer.h"
#include "character.h"
#include "dispextern.h"

static int bidi_initialized = 0;

63
static Lisp_Object bidi_type_table, bidi_mirror_table;
Eli Zaretskii's avatar
Eli Zaretskii committed
64 65 66 67 68 69 70 71 72 73 74 75 76

#define LRM_CHAR   0x200E
#define RLM_CHAR   0x200F
#define BIDI_EOB   -1

/* Data type for describing the bidirectional character categories.  */
typedef enum {
  UNKNOWN_BC,
  NEUTRAL,
  WEAK,
  STRONG
} bidi_category_t;

77
extern int bidi_ignore_explicit_marks_for_paragraph_level EXTERNALLY_VISIBLE;
Eli Zaretskii's avatar
Eli Zaretskii committed
78 79
int bidi_ignore_explicit_marks_for_paragraph_level = 1;

Eli Zaretskii's avatar
Eli Zaretskii committed
80
static Lisp_Object paragraph_start_re, paragraph_separate_re;
81
static Lisp_Object Qparagraph_start, Qparagraph_separate;
Eli Zaretskii's avatar
Eli Zaretskii committed
82

83 84 85 86

/***********************************************************************
			Utilities
 ***********************************************************************/
Eli Zaretskii's avatar
Eli Zaretskii committed
87

88 89
/* Return the bidi type of a character CH, subject to the current
   directional OVERRIDE.  */
90
static inline bidi_type_t
91
bidi_get_type (int ch, bidi_dir_t override)
Eli Zaretskii's avatar
Eli Zaretskii committed
92
{
93 94
  bidi_type_t default_type;

95 96
  if (ch == BIDI_EOB)
    return NEUTRAL_B;
97 98
  if (ch < 0 || ch > MAX_CHAR)
    abort ();
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

  default_type = (bidi_type_t) XINT (CHAR_TABLE_REF (bidi_type_table, ch));

  if (override == NEUTRAL_DIR)
    return default_type;

  switch (default_type)
    {
      /* Although UAX#9 does not tell, it doesn't make sense to
	 override NEUTRAL_B and LRM/RLM characters.  */
      case NEUTRAL_B:
      case LRE:
      case LRO:
      case RLE:
      case RLO:
      case PDF:
	return default_type;
      default:
	switch (ch)
	  {
	    case LRM_CHAR:
	    case RLM_CHAR:
	      return default_type;
	    default:
	      if (override == L2R) /* X6 */
		return STRONG_L;
	      else if (override == R2L)
		return STRONG_R;
	      else
		abort ();	/* can't happen: handled above */
	  }
    }
Eli Zaretskii's avatar
Eli Zaretskii committed
131 132
}

133
static void
134 135 136 137 138 139
bidi_check_type (bidi_type_t type)
{
  if (type < UNKNOWN_BT || type > NEUTRAL_ON)
    abort ();
}

Eli Zaretskii's avatar
Eli Zaretskii committed
140
/* Given a bidi TYPE of a character, return its category.  */
141
static inline bidi_category_t
Eli Zaretskii's avatar
Eli Zaretskii committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
bidi_get_category (bidi_type_t type)
{
  switch (type)
    {
      case UNKNOWN_BT:
	return UNKNOWN_BC;
      case STRONG_L:
      case STRONG_R:
      case STRONG_AL:
      case LRE:
      case LRO:
      case RLE:
      case RLO:
	return STRONG;
      case PDF:		/* ??? really?? */
      case WEAK_EN:
      case WEAK_ES:
      case WEAK_ET:
      case WEAK_AN:
      case WEAK_CS:
      case WEAK_NSM:
      case WEAK_BN:
	return WEAK;
      case NEUTRAL_B:
      case NEUTRAL_S:
      case NEUTRAL_WS:
      case NEUTRAL_ON:
	return NEUTRAL;
      default:
	abort ();
    }
}

175 176 177 178
/* Return the mirrored character of C, if it has one.  If C has no
   mirrored counterpart, return C.
   Note: The conditions in UAX#9 clause L4 regarding the surrounding
   context must be tested by the caller.  */
Eli Zaretskii's avatar
Eli Zaretskii committed
179 180 181
int
bidi_mirror_char (int c)
{
182 183 184 185 186 187
  Lisp_Object val;

  if (c == BIDI_EOB)
    return c;
  if (c < 0 || c > MAX_CHAR)
    abort ();
Eli Zaretskii's avatar
Eli Zaretskii committed
188

189 190
  val = CHAR_TABLE_REF (bidi_mirror_table, c);
  if (INTEGERP (val))
Eli Zaretskii's avatar
Eli Zaretskii committed
191
    {
192
      int v = XINT (val);
Eli Zaretskii's avatar
Eli Zaretskii committed
193

194 195 196 197
      if (v < 0 || v > MAX_CHAR)
	abort ();

      return v;
Eli Zaretskii's avatar
Eli Zaretskii committed
198
    }
199

Eli Zaretskii's avatar
Eli Zaretskii committed
200 201 202
  return c;
}

203 204 205 206
/* Determine the start-of-run (sor) directional type given the two
   embedding levels on either side of the run boundary.  Also, update
   the saved info about previously seen characters, since that info is
   generally valid for a single level run.  */
207
static inline void
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
bidi_set_sor_type (struct bidi_it *bidi_it, int level_before, int level_after)
{
  int higher_level = level_before > level_after ? level_before : level_after;

  /* The prev_was_pdf gork is required for when we have several PDFs
     in a row.  In that case, we want to compute the sor type for the
     next level run only once: when we see the first PDF.  That's
     because the sor type depends only on the higher of the two levels
     that we find on the two sides of the level boundary (see UAX#9,
     clause X10), and so we don't need to know the final embedding
     level to which we descend after processing all the PDFs.  */
  if (!bidi_it->prev_was_pdf || level_before < level_after)
    /* FIXME: should the default sor direction be user selectable?  */
    bidi_it->sor = (higher_level & 1) != 0 ? R2L : L2R;
  if (level_before > level_after)
    bidi_it->prev_was_pdf = 1;

  bidi_it->prev.type = UNKNOWN_BT;
  bidi_it->last_strong.type = bidi_it->last_strong.type_after_w1 =
    bidi_it->last_strong.orig_type = UNKNOWN_BT;
  bidi_it->prev_for_neutral.type = bidi_it->sor == R2L ? STRONG_R : STRONG_L;
  bidi_it->prev_for_neutral.charpos = bidi_it->charpos;
  bidi_it->prev_for_neutral.bytepos = bidi_it->bytepos;
  bidi_it->next_for_neutral.type = bidi_it->next_for_neutral.type_after_w1 =
    bidi_it->next_for_neutral.orig_type = UNKNOWN_BT;
  bidi_it->ignore_bn_limit = -1; /* meaning it's unknown */
}

/* Push the current embedding level and override status; reset the
   current level to LEVEL and the current override status to OVERRIDE.  */
238
static inline void
239 240 241 242
bidi_push_embedding_level (struct bidi_it *bidi_it,
			   int level, bidi_dir_t override)
{
  bidi_it->stack_idx++;
243
  xassert (bidi_it->stack_idx < BIDI_MAXLEVEL);
244 245 246 247 248 249
  bidi_it->level_stack[bidi_it->stack_idx].level = level;
  bidi_it->level_stack[bidi_it->stack_idx].override = override;
}

/* Pop the embedding level and directional override status from the
   stack, and return the new level.  */
250
static inline int
251 252 253 254 255 256 257 258 259
bidi_pop_embedding_level (struct bidi_it *bidi_it)
{
  /* UAX#9 says to ignore invalid PDFs.  */
  if (bidi_it->stack_idx > 0)
    bidi_it->stack_idx--;
  return bidi_it->level_stack[bidi_it->stack_idx].level;
}

/* Record in SAVED_INFO the information about the current character.  */
260
static inline void
261 262 263 264 265 266 267 268 269 270 271 272 273
bidi_remember_char (struct bidi_saved_info *saved_info,
		    struct bidi_it *bidi_it)
{
  saved_info->charpos = bidi_it->charpos;
  saved_info->bytepos = bidi_it->bytepos;
  saved_info->type = bidi_it->type;
  bidi_check_type (bidi_it->type);
  saved_info->type_after_w1 = bidi_it->type_after_w1;
  bidi_check_type (bidi_it->type_after_w1);
  saved_info->orig_type = bidi_it->orig_type;
  bidi_check_type (bidi_it->orig_type);
}

Eli Zaretskii's avatar
Eli Zaretskii committed
274 275
/* Copy the bidi iterator from FROM to TO.  To save cycles, this only
   copies the part of the level stack that is actually in use.  */
276
static inline void
Eli Zaretskii's avatar
Eli Zaretskii committed
277 278 279 280
bidi_copy_it (struct bidi_it *to, struct bidi_it *from)
{
  int i;

281
  /* Copy everything except the level stack and beyond.  */
282
  memcpy (to, from, offsetof (struct bidi_it, level_stack[0]));
Eli Zaretskii's avatar
Eli Zaretskii committed
283 284 285 286 287 288 289

  /* Copy the active part of the level stack.  */
  to->level_stack[0] = from->level_stack[0]; /* level zero is always in use */
  for (i = 1; i <= from->stack_idx; i++)
    to->level_stack[i] = from->level_stack[i];
}

290 291 292 293

/***********************************************************************
			Caching the bidi iterator states
 ***********************************************************************/
Eli Zaretskii's avatar
Eli Zaretskii committed
294

295 296 297
#define BIDI_CACHE_CHUNK 200
static struct bidi_it *bidi_cache;
static size_t bidi_cache_size = 0;
298
static size_t elsz = sizeof (struct bidi_it);
299 300 301 302 303 304 305 306 307 308 309
static EMACS_INT bidi_cache_idx;	/* next unused cache slot */
static EMACS_INT bidi_cache_last_idx;	/* slot of last cache hit */
static EMACS_INT bidi_cache_start = 0;	/* start of cache for this
					   "stack" level */

/* Reset the cache state to the empty state.  We only reset the part
   of the cache relevant to iteration of the current object.  Previous
   objects, which are pushed on the display iterator's stack, are left
   intact.  This is called when the cached information is no more
   useful for the current iteration, e.g. when we were reseated to a
   new position on the same object.  */
310
static inline void
Eli Zaretskii's avatar
Eli Zaretskii committed
311 312
bidi_cache_reset (void)
{
313
  bidi_cache_idx = bidi_cache_start;
Eli Zaretskii's avatar
Eli Zaretskii committed
314 315 316
  bidi_cache_last_idx = -1;
}

317 318 319 320
/* Shrink the cache to its minimal size.  Called when we init the bidi
   iterator for reordering a buffer or a string that does not come
   from display properties, because that means all the previously
   cached info is of no further use.  */
321
static inline void
322 323 324 325
bidi_cache_shrink (void)
{
  if (bidi_cache_size > BIDI_CACHE_CHUNK)
    {
326 327 328
      bidi_cache_size = BIDI_CACHE_CHUNK;
      bidi_cache =
	(struct bidi_it *) xrealloc (bidi_cache, bidi_cache_size * elsz);
329 330 331 332
    }
  bidi_cache_reset ();
}

333
static inline void
Eli Zaretskii's avatar
Eli Zaretskii committed
334 335 336 337
bidi_cache_fetch_state (int idx, struct bidi_it *bidi_it)
{
  int current_scan_dir = bidi_it->scan_dir;

338
  if (idx < bidi_cache_start || idx >= bidi_cache_idx)
Eli Zaretskii's avatar
Eli Zaretskii committed
339 340 341 342 343 344 345 346 347 348 349
    abort ();

  bidi_copy_it (bidi_it, &bidi_cache[idx]);
  bidi_it->scan_dir = current_scan_dir;
  bidi_cache_last_idx = idx;
}

/* Find a cached state with a given CHARPOS and resolved embedding
   level less or equal to LEVEL.  if LEVEL is -1, disregard the
   resolved levels in cached states.  DIR, if non-zero, means search
   in that direction from the last cache hit.  */
350
static inline int
351
bidi_cache_search (EMACS_INT charpos, int level, int dir)
Eli Zaretskii's avatar
Eli Zaretskii committed
352 353 354 355 356 357
{
  int i, i_start;

  if (bidi_cache_idx)
    {
      if (charpos < bidi_cache[bidi_cache_last_idx].charpos)
358 359 360 361 362 363 364 365 366 367 368
	{
	  dir = -1;
	  i_start = bidi_cache_last_idx - 1;
	}
      else if (charpos > (bidi_cache[bidi_cache_last_idx].charpos
			  + bidi_cache[bidi_cache_last_idx].nchars - 1))
	{
	  dir = 1;
	  i_start = bidi_cache_last_idx + 1;
	}
      else if (dir)
Eli Zaretskii's avatar
Eli Zaretskii committed
369 370 371 372 373 374 375 376 377 378
	i_start = bidi_cache_last_idx;
      else
	{
	  dir = -1;
	  i_start = bidi_cache_idx - 1;
	}

      if (dir < 0)
	{
	  /* Linear search for now; FIXME!  */
379
	  for (i = i_start; i >= bidi_cache_start; i--)
380 381
	    if (bidi_cache[i].charpos <= charpos
		&& charpos < bidi_cache[i].charpos + bidi_cache[i].nchars
Eli Zaretskii's avatar
Eli Zaretskii committed
382 383 384 385 386 387
		&& (level == -1 || bidi_cache[i].resolved_level <= level))
	      return i;
	}
      else
	{
	  for (i = i_start; i < bidi_cache_idx; i++)
388 389
	    if (bidi_cache[i].charpos <= charpos
		&& charpos < bidi_cache[i].charpos + bidi_cache[i].nchars
Eli Zaretskii's avatar
Eli Zaretskii committed
390 391 392 393 394 395 396 397 398 399 400
		&& (level == -1 || bidi_cache[i].resolved_level <= level))
	      return i;
	}
    }

  return -1;
}

/* Find a cached state where the resolved level changes to a value
   that is lower than LEVEL, and return its cache slot index.  DIR is
   the direction to search, starting with the last used cache slot.
401 402 403
   If DIR is zero, we search backwards from the last occupied cache
   slot.  BEFORE, if non-zero, means return the index of the slot that
   is ``before'' the level change in the search direction.  That is,
Eli Zaretskii's avatar
Eli Zaretskii committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
   given the cached levels like this:

	 1122333442211
	  AB        C

   and assuming we are at the position cached at the slot marked with
   C, searching backwards (DIR = -1) for LEVEL = 2 will return the
   index of slot B or A, depending whether BEFORE is, respectively,
   non-zero or zero.  */
static int
bidi_cache_find_level_change (int level, int dir, int before)
{
  if (bidi_cache_idx)
    {
      int i = dir ? bidi_cache_last_idx : bidi_cache_idx - 1;
      int incr = before ? 1 : 0;

      if (!dir)
	dir = -1;
      else if (!incr)
	i += dir;

      if (dir < 0)
	{
428
	  while (i >= bidi_cache_start + incr)
Eli Zaretskii's avatar
Eli Zaretskii committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
	    {
	      if (bidi_cache[i - incr].resolved_level >= 0
		  && bidi_cache[i - incr].resolved_level < level)
		return i;
	      i--;
	    }
	}
      else
	{
	  while (i < bidi_cache_idx - incr)
	    {
	      if (bidi_cache[i + incr].resolved_level >= 0
		  && bidi_cache[i + incr].resolved_level < level)
		return i;
	      i++;
	    }
	}
    }

  return -1;
}

451 452 453 454 455 456 457 458 459 460 461 462 463
static inline void
bidi_cache_ensure_space (int idx)
{
  /* Enlarge the cache as needed.  */
  if (idx >= bidi_cache_size)
    {
      bidi_cache_size += BIDI_CACHE_CHUNK;
      bidi_cache =
	(struct bidi_it *) xrealloc (bidi_cache, bidi_cache_size * elsz);
    }
}

static inline void
Eli Zaretskii's avatar
Eli Zaretskii committed
464 465 466 467 468 469 470 471 472 473 474 475
bidi_cache_iterator_state (struct bidi_it *bidi_it, int resolved)
{
  int idx;

  /* We should never cache on backward scans.  */
  if (bidi_it->scan_dir == -1)
    abort ();
  idx = bidi_cache_search (bidi_it->charpos, -1, 1);

  if (idx < 0)
    {
      idx = bidi_cache_idx;
476
      bidi_cache_ensure_space (idx);
477 478 479
      /* Character positions should correspond to cache positions 1:1.
	 If we are outside the range of cached positions, the cache is
	 useless and must be reset.  */
480
      if (idx > bidi_cache_start &&
481 482
	  (bidi_it->charpos > (bidi_cache[idx - 1].charpos
			       + bidi_cache[idx - 1].nchars)
483
	   || bidi_it->charpos < bidi_cache[bidi_cache_start].charpos))
484 485
	{
	  bidi_cache_reset ();
486
	  idx = bidi_cache_start;
487
	}
488 489
      if (bidi_it->nchars <= 0)
	abort ();
Eli Zaretskii's avatar
Eli Zaretskii committed
490 491 492 493 494 495 496 497 498
      bidi_copy_it (&bidi_cache[idx], bidi_it);
      if (!resolved)
	bidi_cache[idx].resolved_level = -1;
    }
  else
    {
      /* Copy only the members which could have changed, to avoid
	 costly copying of the entire struct.  */
      bidi_cache[idx].type = bidi_it->type;
499
      bidi_check_type (bidi_it->type);
500 501
      bidi_cache[idx].type_after_w1 = bidi_it->type_after_w1;
      bidi_check_type (bidi_it->type_after_w1);
Eli Zaretskii's avatar
Eli Zaretskii committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
      if (resolved)
	bidi_cache[idx].resolved_level = bidi_it->resolved_level;
      else
	bidi_cache[idx].resolved_level = -1;
      bidi_cache[idx].invalid_levels = bidi_it->invalid_levels;
      bidi_cache[idx].invalid_rl_levels = bidi_it->invalid_rl_levels;
      bidi_cache[idx].next_for_neutral = bidi_it->next_for_neutral;
      bidi_cache[idx].next_for_ws = bidi_it->next_for_ws;
      bidi_cache[idx].ignore_bn_limit = bidi_it->ignore_bn_limit;
    }

  bidi_cache_last_idx = idx;
  if (idx >= bidi_cache_idx)
    bidi_cache_idx = idx + 1;
}

518
static inline bidi_type_t
519
bidi_cache_find (EMACS_INT charpos, int level, struct bidi_it *bidi_it)
Eli Zaretskii's avatar
Eli Zaretskii committed
520 521 522
{
  int i = bidi_cache_search (charpos, level, bidi_it->scan_dir);

523
  if (i >= bidi_cache_start)
Eli Zaretskii's avatar
Eli Zaretskii committed
524 525 526
    {
      bidi_dir_t current_scan_dir = bidi_it->scan_dir;

527
      bidi_copy_it (bidi_it, &bidi_cache[i]);
Eli Zaretskii's avatar
Eli Zaretskii committed
528 529 530 531 532 533 534 535 536 537
      bidi_cache_last_idx = i;
      /* Don't let scan direction from from the cached state override
	 the current scan direction.  */
      bidi_it->scan_dir = current_scan_dir;
      return bidi_it->type;
    }

  return UNKNOWN_BT;
}

538
static inline int
Eli Zaretskii's avatar
Eli Zaretskii committed
539 540
bidi_peek_at_next_level (struct bidi_it *bidi_it)
{
541
  if (bidi_cache_idx == bidi_cache_start || bidi_cache_last_idx == -1)
Eli Zaretskii's avatar
Eli Zaretskii committed
542 543 544 545
    abort ();
  return bidi_cache[bidi_cache_last_idx + bidi_it->scan_dir].resolved_level;
}

546 547 548 549

/***********************************************************************
	     Pushing and popping the bidi iterator state
 ***********************************************************************/
550 551 552 553
/* 5-slot stack for saving the start of the previous level of the
   cache.  xdisp.c maintains a 5-slot stack for its iterator state,
   and we need the same size of our stack.  */
static int bidi_cache_start_stack[IT_STACK_SIZE];
554 555 556 557
static int bidi_cache_sp;

/* Push the bidi iterator state in preparation for reordering a
   different object, e.g. display string found at certain buffer
558 559 560
   position.  Pushing the bidi iterator boils down to saving its
   entire state on the cache and starting a new cache "stacked" on top
   of the current cache.  */
561 562 563 564 565 566 567 568 569
void
bidi_push_it (struct bidi_it *bidi_it)
{
  /* Save the current iterator state in its entirety after the last
     used cache slot.  */
  bidi_cache_ensure_space (bidi_cache_idx);
  memcpy (&bidi_cache[bidi_cache_idx++], bidi_it, sizeof (struct bidi_it));

  /* Push the current cache start onto the stack.  */
570
  xassert (bidi_cache_sp < IT_STACK_SIZE);
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
  bidi_cache_start_stack[bidi_cache_sp++] = bidi_cache_start;

  /* Start a new level of cache, and make it empty.  */
  bidi_cache_start = bidi_cache_idx;
  bidi_cache_last_idx = -1;
}

/* Restore the iterator state saved by bidi_push_it and return the
   cache to the corresponding state.  */
void
bidi_pop_it (struct bidi_it *bidi_it)
{
  if (bidi_cache_start <= 0)
    abort ();

  /* Reset the next free cache slot index to what it was before the
     call to bidi_push_it.  */
  bidi_cache_idx = bidi_cache_start - 1;

  /* Restore the bidi iterator state saved in the cache.  */
  memcpy (bidi_it, &bidi_cache[bidi_cache_idx], sizeof (struct bidi_it));

  /* Pop the previous cache start from the stack.  */
  if (bidi_cache_sp <= 0)
    abort ();
  bidi_cache_start = bidi_cache_start_stack[--bidi_cache_sp];

  /* Invalidate the last-used cache slot data.  */
  bidi_cache_last_idx = -1;
}

602 603 604 605 606 607

/***********************************************************************
			Initialization
 ***********************************************************************/
static void
bidi_initialize (void)
Eli Zaretskii's avatar
Eli Zaretskii committed
608
{
609

610 611
#include "biditype.h"
#include "bidimirror.h"
612

613
  int i;
Eli Zaretskii's avatar
Eli Zaretskii committed
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
  bidi_type_table = Fmake_char_table (Qnil, make_number (STRONG_L));
  staticpro (&bidi_type_table);

  for (i = 0; i < sizeof bidi_type / sizeof bidi_type[0]; i++)
    char_table_set_range (bidi_type_table, bidi_type[i].from, bidi_type[i].to,
			  make_number (bidi_type[i].type));

  bidi_mirror_table = Fmake_char_table (Qnil, Qnil);
  staticpro (&bidi_mirror_table);

  for (i = 0; i < sizeof bidi_mirror / sizeof bidi_mirror[0]; i++)
    char_table_set (bidi_mirror_table, bidi_mirror[i].from,
		    make_number (bidi_mirror[i].to));

  Qparagraph_start = intern ("paragraph-start");
  staticpro (&Qparagraph_start);
  paragraph_start_re = Fsymbol_value (Qparagraph_start);
  if (!STRINGP (paragraph_start_re))
    paragraph_start_re = build_string ("\f\\|[ \t]*$");
  staticpro (&paragraph_start_re);
  Qparagraph_separate = intern ("paragraph-separate");
  staticpro (&Qparagraph_separate);
  paragraph_separate_re = Fsymbol_value (Qparagraph_separate);
  if (!STRINGP (paragraph_separate_re))
    paragraph_separate_re = build_string ("[ \t\f]*$");
  staticpro (&paragraph_separate_re);
641 642 643

  bidi_cache_sp = 0;

644
  bidi_initialized = 1;
Eli Zaretskii's avatar
Eli Zaretskii committed
645 646
}

647 648
/* Do whatever UAX#9 clause X8 says should be done at paragraph's
   end.  */
649
static inline void
650
bidi_set_paragraph_end (struct bidi_it *bidi_it)
Eli Zaretskii's avatar
Eli Zaretskii committed
651
{
652 653 654 655 656
  bidi_it->invalid_levels = 0;
  bidi_it->invalid_rl_levels = -1;
  bidi_it->stack_idx = 0;
  bidi_it->resolved_level = bidi_it->level_stack[0].level;
}
Eli Zaretskii's avatar
Eli Zaretskii committed
657

658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
/* Initialize the bidi iterator from buffer/string position CHARPOS.  */
void
bidi_init_it (EMACS_INT charpos, EMACS_INT bytepos, int frame_window_p,
	      struct bidi_it *bidi_it)
{
  if (! bidi_initialized)
    bidi_initialize ();
  if (charpos >= 0)
    bidi_it->charpos = charpos;
  if (bytepos >= 0)
    bidi_it->bytepos = bytepos;
  bidi_it->frame_window_p = frame_window_p;
  bidi_it->nchars = -1;	/* to be computed in bidi_resolve_explicit_1 */
  bidi_it->first_elt = 1;
  bidi_set_paragraph_end (bidi_it);
  bidi_it->new_paragraph = 1;
  bidi_it->separator_limit = -1;
  bidi_it->type = NEUTRAL_B;
  bidi_it->type_after_w1 = NEUTRAL_B;
  bidi_it->orig_type = NEUTRAL_B;
  bidi_it->prev_was_pdf = 0;
  bidi_it->prev.type = bidi_it->prev.type_after_w1 =
    bidi_it->prev.orig_type = UNKNOWN_BT;
681 682
  bidi_it->last_strong.type = bidi_it->last_strong.type_after_w1 =
    bidi_it->last_strong.orig_type = UNKNOWN_BT;
683 684 685
  bidi_it->next_for_neutral.charpos = -1;
  bidi_it->next_for_neutral.type =
    bidi_it->next_for_neutral.type_after_w1 =
686
    bidi_it->next_for_neutral.orig_type = UNKNOWN_BT;
687 688 689 690 691 692 693 694 695 696
  bidi_it->prev_for_neutral.charpos = -1;
  bidi_it->prev_for_neutral.type =
    bidi_it->prev_for_neutral.type_after_w1 =
    bidi_it->prev_for_neutral.orig_type = UNKNOWN_BT;
  bidi_it->sor = L2R;	 /* FIXME: should it be user-selectable? */
  bidi_it->disp_pos = -1;	/* invalid/unknown */
  /* We can only shrink the cache if we are at the bottom level of its
     "stack".  */
  if (bidi_cache_start == 0)
    bidi_cache_shrink ();
697 698
  else
    bidi_cache_reset ();
Eli Zaretskii's avatar
Eli Zaretskii committed
699 700
}

701
/* Perform initializations for reordering a new line of bidi text.  */
702
static void
703 704 705 706 707 708 709 710 711
bidi_line_init (struct bidi_it *bidi_it)
{
  bidi_it->scan_dir = 1; /* FIXME: do we need to have control on this? */
  bidi_it->resolved_level = bidi_it->level_stack[0].level;
  bidi_it->level_stack[0].override = NEUTRAL_DIR; /* X1 */
  bidi_it->invalid_levels = 0;
  bidi_it->invalid_rl_levels = -1;
  bidi_it->next_en_pos = -1;
  bidi_it->next_for_ws.type = UNKNOWN_BT;
712 713
  bidi_set_sor_type (bidi_it,
		     bidi_it->paragraph_dir == R2L ? 1 : 0,
714 715 716 717 718
		     bidi_it->level_stack[0].level); /* X10 */

  bidi_cache_reset ();
}

719 720 721 722 723

/***********************************************************************
			Fetching characters
 ***********************************************************************/

724 725 726 727
/* Count bytes in string S between BEG/BEGBYTE and END.  BEG and END
   are zero-based character positions in S, BEGBYTE is byte position
   corresponding to BEG.  UNIBYTE, if non-zero, means S is a unibyte
   string.  */
728 729
static inline EMACS_INT
bidi_count_bytes (const unsigned char *s, const EMACS_INT beg,
730
		  const EMACS_INT begbyte, const EMACS_INT end, int unibyte)
731 732 733 734
{
  EMACS_INT pos = beg;
  const unsigned char *p = s + begbyte, *start = p;

735 736 737
  if (unibyte)
    p = s + end;
  else
738
    {
739 740 741 742 743 744 745 746
      if (!CHAR_HEAD_P (*p))
	abort ();

      while (pos < end)
	{
	  p += BYTES_BY_CHAR_HEAD (*p);
	  pos++;
	}
747 748 749 750 751 752 753
    }

  return p - start;
}

/* Fetch and returns the character at byte position BYTEPOS.  If S is
   non-NULL, fetch the character from string S; otherwise fetch the
754 755
   character from the current buffer.  UNIBYTE non-zero means S is a
   unibyte string.  */
756
static inline int
757
bidi_char_at_pos (EMACS_INT bytepos, const unsigned char *s, int unibyte)
758 759
{
  if (s)
760 761 762 763 764 765
    {
      if (unibyte)
	return s[bytepos];
      else
	return STRING_CHAR (s + bytepos);
    }
766 767 768 769
  else
    return FETCH_MULTIBYTE_CHAR (bytepos);
}

770 771 772 773 774 775 776
/* Fetch and return the character at BYTEPOS/CHARPOS.  If that
   character is covered by a display string, treat the entire run of
   covered characters as a single character u+FFFC, and return their
   combined length in CH_LEN and NCHARS.  DISP_POS specifies the
   character position of the next display string, or -1 if not yet
   computed.  When the next character is at or beyond that position,
   the function updates DISP_POS with the position of the next display
777 778 779
   string.  STRING->s is the C string to iterate, or NULL if iterating
   over a buffer or a Lisp string; in the latter case, STRING->lstring
   is the Lisp string.  */
780
static inline int
781
bidi_fetch_char (EMACS_INT bytepos, EMACS_INT charpos, EMACS_INT *disp_pos,
782
		 struct bidi_string_data *string,
783
		 int frame_window_p, EMACS_INT *ch_len, EMACS_INT *nchars)
784 785
{
  int ch;
786 787
  EMACS_INT endpos =
    (string->s || STRINGP (string->lstring)) ? string->schars : ZV;
788
  struct text_pos pos;
789 790

  /* If we got past the last known position of display string, compute
791 792
     the position of the next one.  That position could be at CHARPOS.  */
  if (charpos < endpos && charpos > *disp_pos)
793 794 795 796
    {
      SET_TEXT_POS (pos, charpos, bytepos);
      *disp_pos = compute_display_string_pos (&pos, string, frame_window_p);
    }
797 798

  /* Fetch the character at BYTEPOS.  */
799
  if (charpos >= endpos)
800 801 802 803
    {
      ch = BIDI_EOB;
      *ch_len = 1;
      *nchars = 1;
804
      *disp_pos = endpos;
805
    }
806
  else if (charpos >= *disp_pos)
807
    {
808 809 810 811 812 813 814
      EMACS_INT disp_end_pos;

      /* We don't expect to find ourselves in the middle of a display
	 property.  Hopefully, it will never be needed.  */
      if (charpos > *disp_pos)
	abort ();
      /* Return the Unicode Object Replacement Character to represent
815
	 the entire run of characters covered by the display string.  */
816
      ch = 0xFFFC;
817
      disp_end_pos = compute_display_string_end (*disp_pos, string);
818
      *nchars = disp_end_pos - *disp_pos;
819 820
      if (*nchars <= 0)
	abort ();
821 822
      if (string->s)
	*ch_len = bidi_count_bytes (string->s, *disp_pos, bytepos,
823
				    disp_end_pos, string->unibyte);
824 825
      else if (STRINGP (string->lstring))
	*ch_len = bidi_count_bytes (SDATA (string->lstring), *disp_pos,
826
				    bytepos, disp_end_pos, string->unibyte);
827 828
      else
	*ch_len = CHAR_TO_BYTE (disp_end_pos) - bytepos;
829 830 831
    }
  else
    {
832 833 834 835
      if (string->s)
	{
	  EMACS_INT len;

836 837 838 839 840 841 842 843 844 845
	  if (!string->unibyte)
	    {
	      ch = STRING_CHAR_AND_LENGTH (string->s + bytepos, len);
	      *ch_len = len;
	    }
	  else
	    {
	      ch = UNIBYTE_TO_CHAR (string->s[bytepos]);
	      *ch_len = 1;
	    }
846
	}
847 848 849 850
      else if (STRINGP (string->lstring))
	{
	  EMACS_INT len;

851 852 853 854 855 856 857 858 859 860 861
	  if (!string->unibyte)
	    {
	      ch = STRING_CHAR_AND_LENGTH (SDATA (string->lstring) + bytepos,
					   len);
	      *ch_len = len;
	    }
	  else
	    {
	      ch = UNIBYTE_TO_CHAR (SREF (string->lstring, bytepos));
	      *ch_len = 1;
	    }
862
	}
863 864 865 866 867
      else
	{
	  ch = FETCH_MULTIBYTE_CHAR (bytepos);
	  *ch_len = CHAR_BYTES (ch);
	}
868 869 870 871 872
      *nchars = 1;
    }

  /* If we just entered a run of characters covered by a display
     string, compute the position of the next display string.  */
873
  if (charpos + *nchars <= endpos && charpos + *nchars > *disp_pos)
874 875 876 877
    {
      SET_TEXT_POS (pos, charpos + *nchars, bytepos + *ch_len);
      *disp_pos = compute_display_string_pos (&pos, string, frame_window_p);
    }
878 879 880 881

  return ch;
}

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913

/***********************************************************************
			Determining paragraph direction
 ***********************************************************************/

/* Check if buffer position CHARPOS/BYTEPOS is the end of a paragraph.
   Value is the non-negative length of the paragraph separator
   following the buffer position, -1 if position is at the beginning
   of a new paragraph, or -2 if position is neither at beginning nor
   at end of a paragraph.  */
static EMACS_INT
bidi_at_paragraph_end (EMACS_INT charpos, EMACS_INT bytepos)
{
  Lisp_Object sep_re;
  Lisp_Object start_re;
  EMACS_INT val;

  sep_re = paragraph_separate_re;
  start_re = paragraph_start_re;

  val = fast_looking_at (sep_re, charpos, bytepos, ZV, ZV_BYTE, Qnil);
  if (val < 0)
    {
      if (fast_looking_at (start_re, charpos, bytepos, ZV, ZV_BYTE, Qnil) >= 0)
	val = -1;
      else
	val = -2;
    }

  return val;
}

914 915 916
/* Find the beginning of this paragraph by looking back in the buffer.
   Value is the byte position of the paragraph's beginning.  */
static EMACS_INT
917
bidi_find_paragraph_start (EMACS_INT pos, EMACS_INT pos_byte)
918
{
Eli Zaretskii's avatar
Eli Zaretskii committed
919
  Lisp_Object re = paragraph_start_re;
920 921 922 923 924
  EMACS_INT limit = ZV, limit_byte = ZV_BYTE;

  while (pos_byte > BEGV_BYTE
	 && fast_looking_at (re, pos, pos_byte, limit, limit_byte, Qnil) < 0)
    {
925 926 927 928
      /* FIXME: What if the paragraph beginning is covered by a
	 display string?  And what if a display string covering some
	 of the text over which we scan back includes
	 paragraph_start_re?  */
929 930
      pos = find_next_newline_no_quit (pos - 1, -1);
      pos_byte = CHAR_TO_BYTE (pos);
931
    }
932
  return pos_byte;
933 934
}

935
/* Determine the base direction, a.k.a. base embedding level, of the
936 937
   paragraph we are about to iterate through.  If DIR is either L2R or
   R2L, just use that.  Otherwise, determine the paragraph direction
938 939
   from the first strong directional character of the paragraph.

940
   NO_DEFAULT_P non-zero means don't default to L2R if the paragraph
941 942 943 944 945 946 947 948 949
   has no strong directional characters and both DIR and
   bidi_it->paragraph_dir are NEUTRAL_DIR.  In that case, search back
   in the buffer until a paragraph is found with a strong character,
   or until hitting BEGV.  In the latter case, fall back to L2R.  This
   flag is used in current-bidi-paragraph-direction.

   Note that this function gives the paragraph separator the same
   direction as the preceding paragraph, even though Emacs generally
   views the separartor as not belonging to any paragraph.  */
Eli Zaretskii's avatar
Eli Zaretskii committed
950
void
951
bidi_paragraph_init (bidi_dir_t dir, struct bidi_it *bidi_it, int no_default_p)
Eli Zaretskii's avatar
Eli Zaretskii committed
952
{
953
  EMACS_INT bytepos = bidi_it->bytepos;
954
  int string_p = bidi_it->string.s != NULL || STRINGP (bidi_it->string.lstring);
955
  EMACS_INT pstartbyte;
956 957 958 959 960
  /* Note that begbyte is a byte position, while end is a character
     position.  Yes, this is ugly, but we are trying to avoid costly
     calls to BYTE_TO_CHAR and its ilk.  */
  EMACS_INT begbyte = string_p ? 0 : BEGV_BYTE;
  EMACS_INT end = string_p ? bidi_it->string.schars : ZV;
961

962
  /* Special case for an empty buffer. */
963
  if (bytepos == begbyte && bidi_it->charpos == end)
964
    dir = L2R;
965
  /* We should never be called at EOB or before BEGV.  */
966
  else if (bidi_it->charpos >= end || bytepos < begbyte)
967 968
    abort ();

969 970 971 972 973 974 975 976 977 978
  if (dir == L2R)
    {
      bidi_it->paragraph_dir = L2R;
      bidi_it->new_paragraph = 0;
    }
  else if (dir == R2L)
    {
      bidi_it->paragraph_dir = R2L;
      bidi_it->new_paragraph = 0;
    }
Eli Zaretskii's avatar
Eli Zaretskii committed
979 980
  else if (dir == NEUTRAL_DIR)	/* P2 */
    {
981 982 983
      int ch;
      EMACS_INT ch_len, nchars;
      EMACS_INT pos, disp_pos = -1;
984
      bidi_type_t type;
985
      const unsigned char *s;
986

987 988 989
      if (!bidi_initialized)
	bidi_initialize ();

990 991
      /* If we are inside a paragraph separator, we are just waiting
	 for the separator to be exhausted; use the previous paragraph
992 993 994 995
	 direction.  But don't do that if we have been just reseated,
	 because we need to reinitialize below in that case.  */
      if (!bidi_it->first_elt
	  && bidi_it->charpos < bidi_it->separator_limit)
996 997
	return;

998
      /* If we are on a newline, get past it to where the next
999 1000 1001
	 paragraph might start.  But don't do that at BEGV since then
	 we are potentially in a new paragraph that doesn't yet
	 exist.  */
1002
      pos = bidi_it->charpos;
1003 1004
      s = STRINGP (bidi_it->string.lstring) ?
	SDATA (bidi_it->string.lstring) : bidi_it->string.s;
1005 1006
      if (bytepos > begbyte
	  && bidi_char_at_pos (bytepos, s, bidi_it->string.unibyte) == '\n')
1007
	{
1008
	  bytepos++;
1009
	  pos++;
1010
	}
1011 1012 1013

      /* We are either at the beginning of a paragraph or in the
	 middle of it.  Find where this paragraph starts.  */
1014 1015 1016 1017 1018 1019 1020 1021
      if (string_p)
	{
	  /* We don't support changes of paragraph direction inside a
	     string.  It is treated as a single paragraph.  */
	  pstartbyte = 0;
	}
      else
	pstartbyte = bidi_find_paragraph_start (pos, bytepos);
1022 1023
      bidi_it->separator_limit = -1;
      bidi_it->new_paragraph = 0;
1024 1025

      /* The following loop is run more than once only if NO_DEFAULT_P
1026
	 is non-zero, and only if we are iterating on a buffer.  */
1027 1028
      do {
	bytepos = pstartbyte;
1029 1030 1031 1032
	if (!string_p)
	  pos = BYTE_TO_CHAR (bytepos);
	ch = bidi_fetch_char (bytepos, pos, &disp_pos, &bidi_it->string,
			      bidi_it->frame_window_p, &ch_len, &nchars);
1033 1034
	type = bidi_get_type (ch, NEUTRAL_DIR);

1035
	for (pos += nchars, bytepos += ch_len;
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
	     /* NOTE: UAX#9 says to search only for L, AL, or R types
		of characters, and ignore RLE, RLO, LRE, and LRO.
		However, I'm not sure it makes sense to omit those 4;
		should try with and without that to see the effect.  */
	     (bidi_get_category (type) != STRONG)
	       || (bidi_ignore_explicit_marks_for_paragraph_level
		   && (type == RLE || type == RLO
		       || type == LRE || type == LRO));
	     type = bidi_get_type (ch, NEUTRAL_DIR))
	  {
1046 1047 1048
	    if (!string_p
		&& type == NEUTRAL_B
		&& bidi_at_paragraph_end (pos, bytepos) >= -1)
1049
	      break;
1050
	    if (pos >= end)
1051 1052
	      {
		/* Pretend there's a paragraph separator at end of
1053
		   buffer/string.  */
1054 1055 1056
		type = NEUTRAL_B;
		break;
	      }
1057
	    /* Fetch next character and advance to get past it.  */
1058
	    ch = bidi_fetch_char (bytepos, pos, &disp_pos, &bidi_it->string,
1059
				  bidi_it->frame_window_p, &ch_len, &nchars);
1060 1061
	    pos += nchars;
	    bytepos += ch_len;
1062 1063 1064 1065 1066
	  }
	if (type == STRONG_R || type == STRONG_AL) /* P3 */
	  bidi_it->paragraph_dir = R2L;
	else if (type == STRONG_L)
	  bidi_it->paragraph_dir = L2R;
1067 1068
	if (!string_p
	    && no_default_p && bidi_it->paragraph_dir == NEUTRAL_DIR)
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
	  {
	    /* If this paragraph is at BEGV, default to L2R.  */
	    if (pstartbyte == BEGV_BYTE)
	      bidi_it->paragraph_dir = L2R; /* P3 and HL1 */
	    else
	      {
		EMACS_INT prevpbyte = pstartbyte;
		EMACS_INT p = BYTE_TO_CHAR (pstartbyte), pbyte = pstartbyte;

		/* Find the beginning of the previous paragraph, if any.  */
		while (pbyte > BEGV_BYTE && prevpbyte >= pstartbyte)
		  {
1081 1082 1083
		    /* FXIME: What if p is covered by a display
		       string?  See also a FIXME inside
		       bidi_find_paragraph_start.  */
1084 1085 1086 1087 1088 1089 1090
		    p--;
		    pbyte = CHAR_TO_BYTE (p);
		    prevpbyte = bidi_find_paragraph_start (p, pbyte);
		  }
		pstartbyte = prevpbyte;
	      }
	  }
1091 1092
      } while (!string_p
	       && no_default_p && bidi_it->paragraph_dir == NEUTRAL_DIR);
Eli Zaretskii's avatar
Eli Zaretskii committed
1093
    }
1094 1095
  else
    abort ();
Eli Zaretskii's avatar
Eli Zaretskii committed
1096

1097 1098
  /* Contrary to UAX#9 clause P3, we only default the paragraph
     direction to L2R if we have no previous usable paragraph
1099
     direction.  This is allowed by the HL1 clause.  */
1100
  if (bidi_it->paragraph_dir != L2R && bidi_it->paragraph_dir != R2L)
1101
    bidi_it->paragraph_dir = L2R; /* P3 and HL1 ``higher-level protocols'' */
1102
  if (bidi_it->paragraph_dir == R2L)
1103
    bidi_it->level_stack[0].level = 1;
1104
  else
1105
    bidi_it->level_stack[0].level = 0;
1106 1107

  bidi_line_init (bidi_it);
Eli Zaretskii's avatar
Eli Zaretskii committed
1108 1109
}

1110 1111 1112

/***********************************************************************
		 Resolving explicit and implicit levels.
1113
  The rest of this file constitutes the core of the UBA implementation.
1114
 ***********************************************************************/
Eli Zaretskii's avatar
Eli Zaretskii committed
1115

1116
static inline int
1117
bidi_explicit_dir_char (int ch)
Eli Zaretskii's avatar
Eli Zaretskii committed
1118
{
1119 1120 1121 1122 1123 1124 1125 1126
  bidi_type_t ch_type;

  if (!bidi_initialized)
    abort ();
  ch_type = (bidi_type_t) XINT (CHAR_TABLE_REF (bidi_type_table, ch));
  return (ch_type == LRE || ch_type == LRO
	  || ch_type == RLE || ch_type == RLO
	  || ch_type == PDF);
Eli Zaretskii's avatar
Eli Zaretskii committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
}

/* A helper function for bidi_resolve_explicit.  It advances to the
   next character in logical order and determines the new embedding
   level and directional override, but does not take into account
   empty embeddings.  */
static int
bidi_resolve_explicit_1 (struct bidi_it *bidi_it)
{
  int curchar;
  bidi_type_t type;
  int current_level;
  int new_level;
  bidi_dir_t override;
1141
  int string_p = bidi_it->string.s != NULL || STRINGP (bidi_it->string.lstring);
Eli Zaretskii's avatar
Eli Zaretskii committed
1142

1143 1144 1145
  /* If reseat()'ed, don't advance, so as to start iteration from the
     position where we were reseated.  bidi_it->bytepos can be less
     than BEGV_BYTE after reseat to BEGV.  */
1146
  if (bidi_it->bytepos < (string_p ? 0 : BEGV_BYTE)
1147
      || bidi_it->first_elt)
1148
    {
1149
      bidi_it->first_elt = 0;
1150 1151
      if (string_p)
	{
1152 1153 1154 1155
	  const unsigned char *p =
	    STRINGP (bidi_it->string.lstring)
	    ? SDATA (bidi_it->string.lstring) : bidi_it->string.s;

1156 1157
	  if (bidi_it->charpos < 0)
	    bidi_it->charpos = 0;
1158 1159
	  bidi_it->bytepos = bidi_count_bytes (p, 0, 0, bidi_it->charpos,
					       bidi_it->string.unibyte);
1160 1161 1162 1163 1164 1165 1166
	}
      else
	{
	  if (bidi_it->charpos < BEGV)
	    bidi_it->charpos = BEGV;
	  bidi_it->bytepos = CHAR_TO_BYTE (bidi_it->charpos);
	}
1167
    }
1168 1169
  /* Don't move at end of buffer/string.  */
  else if (bidi_it->charpos < (string_p ? bidi_it->string.schars : ZV))
Eli Zaretskii's avatar
Eli Zaretskii committed
1170
    {
1171 1172
      /* Advance to the next character, skipping characters covered by
	 display strings (nchars > 1).  */
1173 1174
      if (bidi_it->nchars <= 0)
	abort ();
1175
      bidi_it->charpos += bidi_it->nchars;
1176 1177
      if (bidi_it->ch_len == 0)
	abort ();
Eli Zaretskii's avatar
Eli Zaretskii committed
1178 1179 1180 1181 1182 1183 1184
      bidi_it->bytepos += bidi_it->ch_len;
    }

  current_level = bidi_it->level_stack[bidi_it->stack_idx].level; /* X1 */
  override = bidi_it->level_stack[bidi_it->stack_idx].override;
  new_level = current_level;

1185
  if (bidi_it->charpos >= (string_p ? bidi_it->string.schars : ZV))
1186 1187 1188
    {
      curchar = BIDI_EOB;
      bidi_it->ch_len = 1;
1189
      bidi_it->nchars = 1;
1190
      bidi_it->disp_pos = (string_p ? bidi_it->string.schars : ZV);
1191 1192 1193
    }
  else
    {
1194 1195 1196
      /* Fetch the character at BYTEPOS.  If it is covered by a
	 display string, treat the entire run of covered characters as
	 a single character u+FFFC.  */
1197
      curchar = bidi_fetch_char (bidi_it->bytepos, bidi_it->charpos,
1198 1199
				 &bidi_it->disp_pos, &bidi_it->string,
				 bidi_it->frame_window_p,
1200
				 &bidi_it->ch_len, &bidi_it->nchars);
1201
    }
Eli Zaretskii's avatar
Eli Zaretskii committed
1202 1203
  bidi_it->ch = curchar;

1204 1205 1206 1207 1208
  /* Don't apply directional override here, as all the types we handle
     below will not be affected by the override anyway, and we need
     the original type unaltered.  The override will be applied in
     bidi_resolve_weak.  */