Commit | Line | Data |
---|---|---|
cbb09f04 | 1 | /* Low-level bidirectional buffer/string-scanning functions for GNU Emacs. |
ab422c4d PE |
2 | Copyright (C) 2000-2001, 2004-2005, 2009-2013 Free Software |
3 | Foundation, Inc. | |
b7b65b15 EZ |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
a8d11bd3 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
b7b65b15 | 8 | it under the terms of the GNU General Public License as published by |
a8d11bd3 EZ |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
b7b65b15 EZ |
11 | |
12 | GNU Emacs is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
b7b65b15 | 17 | You should have received a copy of the GNU General Public License |
a8d11bd3 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
b7b65b15 | 19 | |
2d6e4628 EZ |
20 | /* Written by Eli Zaretskii <eliz@gnu.org>. |
21 | ||
22 | A sequential implementation of the Unicode Bidirectional algorithm, | |
cbb09f04 | 23 | (UBA) as per UAX#9, a part of the Unicode Standard. |
b7b65b15 EZ |
24 | |
25 | Unlike the reference and most other implementations, this one is | |
940afb59 EZ |
26 | designed to be called once for every character in the buffer or |
27 | string. | |
b7b65b15 | 28 | |
4b292a22 | 29 | The main entry point is bidi_move_to_visually_next. Each time it |
b7b65b15 EZ |
30 | is called, it finds the next character in the visual order, and |
31 | returns its information in a special structure. The caller is then | |
32 | expected to process this character for display or any other | |
4b292a22 EZ |
33 | purposes, and call bidi_move_to_visually_next for the next |
34 | character. See the comments in bidi_move_to_visually_next for more | |
35 | details about its algorithm that finds the next visual-order | |
b7b65b15 EZ |
36 | character by resolving their levels on the fly. |
37 | ||
95e1afc6 | 38 | Two other entry points are bidi_paragraph_init and |
940afb59 EZ |
39 | bidi_mirror_char. The first determines the base direction of a |
40 | paragraph, while the second returns the mirrored version of its | |
41 | argument character. | |
42 | ||
95e1afc6 EZ |
43 | A few auxiliary entry points are used to initialize the bidi |
44 | iterator for iterating an object (buffer or string), push and pop | |
45 | the bidi iterator state, and save and restore the state of the bidi | |
46 | cache. | |
47 | ||
89d3374a EZ |
48 | If you want to understand the code, you will have to read it |
49 | together with the relevant portions of UAX#9. The comments include | |
50 | references to UAX#9 rules, for that very reason. | |
51 | ||
b7b65b15 EZ |
52 | A note about references to UAX#9 rules: if the reference says |
53 | something like "X9/Retaining", it means that you need to refer to | |
cd1181db | 54 | rule X9 and to its modifications described in the "Implementation |
b7b65b15 EZ |
55 | Notes" section of UAX#9, under "Retaining Format Codes". */ |
56 | ||
b7b65b15 | 57 | #include <config.h> |
b7b65b15 | 58 | #include <stdio.h> |
29e3d8d1 | 59 | |
b7b65b15 | 60 | #include "lisp.h" |
b7b65b15 | 61 | #include "character.h" |
e5560ff7 | 62 | #include "buffer.h" |
b7b65b15 EZ |
63 | #include "dispextern.h" |
64 | ||
2cc21167 | 65 | static bool bidi_initialized = 0; |
b7b65b15 | 66 | |
cbc4fd20 | 67 | static Lisp_Object bidi_type_table, bidi_mirror_table; |
b7b65b15 EZ |
68 | |
69 | #define LRM_CHAR 0x200E | |
70 | #define RLM_CHAR 0x200F | |
b7b65b15 | 71 | #define BIDI_EOB -1 |
b7b65b15 | 72 | |
b7b65b15 EZ |
73 | /* Data type for describing the bidirectional character categories. */ |
74 | typedef enum { | |
75 | UNKNOWN_BC, | |
76 | NEUTRAL, | |
77 | WEAK, | |
78 | STRONG | |
79 | } bidi_category_t; | |
80 | ||
32413314 EZ |
81 | /* UAX#9 says to search only for L, AL, or R types of characters, and |
82 | ignore RLE, RLO, LRE, and LRO, when determining the base paragraph | |
83 | level. Yudit indeed ignores them. This variable is therefore set | |
2cc21167 PE |
84 | by default to ignore them, but clearing it will take them into |
85 | account. */ | |
86 | extern bool bidi_ignore_explicit_marks_for_paragraph_level EXTERNALLY_VISIBLE; | |
87 | bool bidi_ignore_explicit_marks_for_paragraph_level = 1; | |
b7b65b15 | 88 | |
372b7a95 | 89 | static Lisp_Object paragraph_start_re, paragraph_separate_re; |
6bff6497 | 90 | static Lisp_Object Qparagraph_start, Qparagraph_separate; |
b7b65b15 | 91 | |
cbb09f04 EZ |
92 | \f |
93 | /*********************************************************************** | |
94 | Utilities | |
95 | ***********************************************************************/ | |
b7b65b15 | 96 | |
6bff6497 EZ |
97 | /* Return the bidi type of a character CH, subject to the current |
98 | directional OVERRIDE. */ | |
0a99eee1 | 99 | static bidi_type_t |
6bff6497 | 100 | bidi_get_type (int ch, bidi_dir_t override) |
b7b65b15 | 101 | { |
6bff6497 EZ |
102 | bidi_type_t default_type; |
103 | ||
e7402cb2 EZ |
104 | if (ch == BIDI_EOB) |
105 | return NEUTRAL_B; | |
e342a24d | 106 | if (ch < 0 || ch > MAX_CHAR) |
1088b922 | 107 | emacs_abort (); |
6bff6497 EZ |
108 | |
109 | default_type = (bidi_type_t) XINT (CHAR_TABLE_REF (bidi_type_table, ch)); | |
bca633fb EZ |
110 | /* Every valid character code, even those that are unassigned by the |
111 | UCD, have some bidi-class property, according to | |
112 | DerivedBidiClass.txt file. Therefore, if we ever get UNKNOWN_BT | |
113 | (= zero) code from CHAR_TABLE_REF, that's a bug. */ | |
114 | if (default_type == UNKNOWN_BT) | |
1088b922 | 115 | emacs_abort (); |
6bff6497 EZ |
116 | |
117 | if (override == NEUTRAL_DIR) | |
118 | return default_type; | |
119 | ||
120 | switch (default_type) | |
121 | { | |
122 | /* Although UAX#9 does not tell, it doesn't make sense to | |
123 | override NEUTRAL_B and LRM/RLM characters. */ | |
124 | case NEUTRAL_B: | |
125 | case LRE: | |
126 | case LRO: | |
127 | case RLE: | |
128 | case RLO: | |
129 | case PDF: | |
130 | return default_type; | |
131 | default: | |
132 | switch (ch) | |
133 | { | |
134 | case LRM_CHAR: | |
135 | case RLM_CHAR: | |
136 | return default_type; | |
137 | default: | |
138 | if (override == L2R) /* X6 */ | |
139 | return STRONG_L; | |
140 | else if (override == R2L) | |
141 | return STRONG_R; | |
142 | else | |
1088b922 | 143 | emacs_abort (); /* can't happen: handled above */ |
6bff6497 EZ |
144 | } |
145 | } | |
b7b65b15 EZ |
146 | } |
147 | ||
0a99eee1 | 148 | static void |
2d6e4628 EZ |
149 | bidi_check_type (bidi_type_t type) |
150 | { | |
a54e2c05 | 151 | eassert (UNKNOWN_BT <= type && type <= NEUTRAL_ON); |
2d6e4628 EZ |
152 | } |
153 | ||
b7b65b15 | 154 | /* Given a bidi TYPE of a character, return its category. */ |
0a99eee1 | 155 | static bidi_category_t |
b7b65b15 EZ |
156 | bidi_get_category (bidi_type_t type) |
157 | { | |
158 | switch (type) | |
159 | { | |
160 | case UNKNOWN_BT: | |
161 | return UNKNOWN_BC; | |
162 | case STRONG_L: | |
163 | case STRONG_R: | |
164 | case STRONG_AL: | |
165 | case LRE: | |
166 | case LRO: | |
167 | case RLE: | |
168 | case RLO: | |
169 | return STRONG; | |
170 | case PDF: /* ??? really?? */ | |
171 | case WEAK_EN: | |
172 | case WEAK_ES: | |
173 | case WEAK_ET: | |
174 | case WEAK_AN: | |
175 | case WEAK_CS: | |
176 | case WEAK_NSM: | |
177 | case WEAK_BN: | |
178 | return WEAK; | |
179 | case NEUTRAL_B: | |
180 | case NEUTRAL_S: | |
181 | case NEUTRAL_WS: | |
182 | case NEUTRAL_ON: | |
183 | return NEUTRAL; | |
184 | default: | |
1088b922 | 185 | emacs_abort (); |
b7b65b15 EZ |
186 | } |
187 | } | |
188 | ||
a6e8d97c EZ |
189 | /* Return the mirrored character of C, if it has one. If C has no |
190 | mirrored counterpart, return C. | |
191 | Note: The conditions in UAX#9 clause L4 regarding the surrounding | |
192 | context must be tested by the caller. */ | |
b7b65b15 EZ |
193 | int |
194 | bidi_mirror_char (int c) | |
195 | { | |
cbc4fd20 EZ |
196 | Lisp_Object val; |
197 | ||
198 | if (c == BIDI_EOB) | |
199 | return c; | |
200 | if (c < 0 || c > MAX_CHAR) | |
1088b922 | 201 | emacs_abort (); |
b7b65b15 | 202 | |
cbc4fd20 EZ |
203 | val = CHAR_TABLE_REF (bidi_mirror_table, c); |
204 | if (INTEGERP (val)) | |
b7b65b15 | 205 | { |
da92a98c | 206 | int v; |
9e1a06fc | 207 | |
da92a98c PE |
208 | /* When debugging, check before assigning to V, so that the check |
209 | isn't broken by undefined behavior due to int overflow. */ | |
81899c91 | 210 | eassert (CHAR_VALID_P (XINT (val))); |
9e1a06fc | 211 | |
da92a98c PE |
212 | v = XINT (val); |
213 | ||
9e1a06fc EZ |
214 | /* Minimal test we must do in optimized builds, to prevent weird |
215 | crashes further down the road. */ | |
216 | if (v < 0 || v > MAX_CHAR) | |
1088b922 | 217 | emacs_abort (); |
9e1a06fc EZ |
218 | |
219 | return v; | |
b7b65b15 | 220 | } |
cbc4fd20 | 221 | |
b7b65b15 EZ |
222 | return c; |
223 | } | |
224 | ||
cbb09f04 EZ |
225 | /* Determine the start-of-run (sor) directional type given the two |
226 | embedding levels on either side of the run boundary. Also, update | |
227 | the saved info about previously seen characters, since that info is | |
228 | generally valid for a single level run. */ | |
0a99eee1 | 229 | static void |
cbb09f04 EZ |
230 | bidi_set_sor_type (struct bidi_it *bidi_it, int level_before, int level_after) |
231 | { | |
512a289d | 232 | int higher_level = (level_before > level_after ? level_before : level_after); |
cbb09f04 EZ |
233 | |
234 | /* The prev_was_pdf gork is required for when we have several PDFs | |
235 | in a row. In that case, we want to compute the sor type for the | |
236 | next level run only once: when we see the first PDF. That's | |
237 | because the sor type depends only on the higher of the two levels | |
238 | that we find on the two sides of the level boundary (see UAX#9, | |
239 | clause X10), and so we don't need to know the final embedding | |
240 | level to which we descend after processing all the PDFs. */ | |
241 | if (!bidi_it->prev_was_pdf || level_before < level_after) | |
242 | /* FIXME: should the default sor direction be user selectable? */ | |
512a289d | 243 | bidi_it->sor = ((higher_level & 1) != 0 ? R2L : L2R); |
cbb09f04 EZ |
244 | if (level_before > level_after) |
245 | bidi_it->prev_was_pdf = 1; | |
246 | ||
247 | bidi_it->prev.type = UNKNOWN_BT; | |
512a289d RS |
248 | bidi_it->last_strong.type = bidi_it->last_strong.type_after_w1 |
249 | = bidi_it->last_strong.orig_type = UNKNOWN_BT; | |
250 | bidi_it->prev_for_neutral.type = (bidi_it->sor == R2L ? STRONG_R : STRONG_L); | |
cbb09f04 EZ |
251 | bidi_it->prev_for_neutral.charpos = bidi_it->charpos; |
252 | bidi_it->prev_for_neutral.bytepos = bidi_it->bytepos; | |
512a289d RS |
253 | bidi_it->next_for_neutral.type = bidi_it->next_for_neutral.type_after_w1 |
254 | = bidi_it->next_for_neutral.orig_type = UNKNOWN_BT; | |
cbb09f04 EZ |
255 | bidi_it->ignore_bn_limit = -1; /* meaning it's unknown */ |
256 | } | |
257 | ||
258 | /* Push the current embedding level and override status; reset the | |
259 | current level to LEVEL and the current override status to OVERRIDE. */ | |
0a99eee1 | 260 | static void |
cbb09f04 EZ |
261 | bidi_push_embedding_level (struct bidi_it *bidi_it, |
262 | int level, bidi_dir_t override) | |
263 | { | |
264 | bidi_it->stack_idx++; | |
a54e2c05 | 265 | eassert (bidi_it->stack_idx < BIDI_MAXLEVEL); |
cbb09f04 EZ |
266 | bidi_it->level_stack[bidi_it->stack_idx].level = level; |
267 | bidi_it->level_stack[bidi_it->stack_idx].override = override; | |
268 | } | |
269 | ||
270 | /* Pop the embedding level and directional override status from the | |
271 | stack, and return the new level. */ | |
0a99eee1 | 272 | static int |
cbb09f04 EZ |
273 | bidi_pop_embedding_level (struct bidi_it *bidi_it) |
274 | { | |
275 | /* UAX#9 says to ignore invalid PDFs. */ | |
276 | if (bidi_it->stack_idx > 0) | |
277 | bidi_it->stack_idx--; | |
278 | return bidi_it->level_stack[bidi_it->stack_idx].level; | |
279 | } | |
280 | ||
281 | /* Record in SAVED_INFO the information about the current character. */ | |
0a99eee1 | 282 | static void |
cbb09f04 EZ |
283 | bidi_remember_char (struct bidi_saved_info *saved_info, |
284 | struct bidi_it *bidi_it) | |
285 | { | |
286 | saved_info->charpos = bidi_it->charpos; | |
287 | saved_info->bytepos = bidi_it->bytepos; | |
288 | saved_info->type = bidi_it->type; | |
289 | bidi_check_type (bidi_it->type); | |
290 | saved_info->type_after_w1 = bidi_it->type_after_w1; | |
291 | bidi_check_type (bidi_it->type_after_w1); | |
292 | saved_info->orig_type = bidi_it->orig_type; | |
293 | bidi_check_type (bidi_it->orig_type); | |
294 | } | |
295 | ||
b7b65b15 EZ |
296 | /* Copy the bidi iterator from FROM to TO. To save cycles, this only |
297 | copies the part of the level stack that is actually in use. */ | |
0a99eee1 | 298 | static void |
b7b65b15 EZ |
299 | bidi_copy_it (struct bidi_it *to, struct bidi_it *from) |
300 | { | |
05584c31 PE |
301 | /* Copy everything from the start through the active part of |
302 | the level stack. */ | |
303 | memcpy (to, from, | |
304 | (offsetof (struct bidi_it, level_stack[1]) | |
305 | + from->stack_idx * sizeof from->level_stack[0])); | |
b7b65b15 EZ |
306 | } |
307 | ||
cbb09f04 EZ |
308 | \f |
309 | /*********************************************************************** | |
310 | Caching the bidi iterator states | |
311 | ***********************************************************************/ | |
b7b65b15 | 312 | |
2fe72643 EZ |
313 | #define BIDI_CACHE_CHUNK 200 |
314 | static struct bidi_it *bidi_cache; | |
39e378da | 315 | static ptrdiff_t bidi_cache_size = 0; |
ad6042bb | 316 | enum { elsz = sizeof (struct bidi_it) }; |
39e378da PE |
317 | static ptrdiff_t bidi_cache_idx; /* next unused cache slot */ |
318 | static ptrdiff_t bidi_cache_last_idx; /* slot of last cache hit */ | |
319 | static ptrdiff_t bidi_cache_start = 0; /* start of cache for this | |
87e67904 EZ |
320 | "stack" level */ |
321 | ||
bc18e09d PE |
322 | /* 5-slot stack for saving the start of the previous level of the |
323 | cache. xdisp.c maintains a 5-slot stack for its iterator state, | |
324 | and we need the same size of our stack. */ | |
325 | static ptrdiff_t bidi_cache_start_stack[IT_STACK_SIZE]; | |
326 | static int bidi_cache_sp; | |
327 | ||
328 | /* Size of header used by bidi_shelve_cache. */ | |
329 | enum | |
330 | { | |
512a289d RS |
331 | bidi_shelve_header_size |
332 | = (sizeof (bidi_cache_idx) + sizeof (bidi_cache_start_stack) | |
333 | + sizeof (bidi_cache_sp) + sizeof (bidi_cache_start) | |
334 | + sizeof (bidi_cache_last_idx)) | |
bc18e09d PE |
335 | }; |
336 | ||
87e67904 EZ |
337 | /* Reset the cache state to the empty state. We only reset the part |
338 | of the cache relevant to iteration of the current object. Previous | |
339 | objects, which are pushed on the display iterator's stack, are left | |
340 | intact. This is called when the cached information is no more | |
341 | useful for the current iteration, e.g. when we were reseated to a | |
342 | new position on the same object. */ | |
0a99eee1 | 343 | static void |
b7b65b15 EZ |
344 | bidi_cache_reset (void) |
345 | { | |
87e67904 | 346 | bidi_cache_idx = bidi_cache_start; |
b7b65b15 EZ |
347 | bidi_cache_last_idx = -1; |
348 | } | |
349 | ||
87e67904 EZ |
350 | /* Shrink the cache to its minimal size. Called when we init the bidi |
351 | iterator for reordering a buffer or a string that does not come | |
352 | from display properties, because that means all the previously | |
353 | cached info is of no further use. */ | |
0a99eee1 | 354 | static void |
2fe72643 EZ |
355 | bidi_cache_shrink (void) |
356 | { | |
357 | if (bidi_cache_size > BIDI_CACHE_CHUNK) | |
358 | { | |
38182d90 | 359 | bidi_cache = xrealloc (bidi_cache, BIDI_CACHE_CHUNK * elsz); |
51f30bc5 | 360 | bidi_cache_size = BIDI_CACHE_CHUNK; |
2fe72643 EZ |
361 | } |
362 | bidi_cache_reset (); | |
363 | } | |
364 | ||
0a99eee1 | 365 | static void |
39e378da | 366 | bidi_cache_fetch_state (ptrdiff_t idx, struct bidi_it *bidi_it) |
b7b65b15 EZ |
367 | { |
368 | int current_scan_dir = bidi_it->scan_dir; | |
369 | ||
87e67904 | 370 | if (idx < bidi_cache_start || idx >= bidi_cache_idx) |
1088b922 | 371 | emacs_abort (); |
b7b65b15 EZ |
372 | |
373 | bidi_copy_it (bidi_it, &bidi_cache[idx]); | |
374 | bidi_it->scan_dir = current_scan_dir; | |
375 | bidi_cache_last_idx = idx; | |
376 | } | |
377 | ||
378 | /* Find a cached state with a given CHARPOS and resolved embedding | |
379 | level less or equal to LEVEL. if LEVEL is -1, disregard the | |
380 | resolved levels in cached states. DIR, if non-zero, means search | |
381 | in that direction from the last cache hit. */ | |
0a99eee1 | 382 | static ptrdiff_t |
d311d28c | 383 | bidi_cache_search (ptrdiff_t charpos, int level, int dir) |
b7b65b15 | 384 | { |
39e378da | 385 | ptrdiff_t i, i_start; |
b7b65b15 | 386 | |
6eec7596 | 387 | if (bidi_cache_idx > bidi_cache_start) |
b7b65b15 | 388 | { |
6eec7596 EZ |
389 | if (bidi_cache_last_idx == -1) |
390 | bidi_cache_last_idx = bidi_cache_idx - 1; | |
b7b65b15 | 391 | if (charpos < bidi_cache[bidi_cache_last_idx].charpos) |
182ce2d2 EZ |
392 | { |
393 | dir = -1; | |
394 | i_start = bidi_cache_last_idx - 1; | |
395 | } | |
396 | else if (charpos > (bidi_cache[bidi_cache_last_idx].charpos | |
397 | + bidi_cache[bidi_cache_last_idx].nchars - 1)) | |
398 | { | |
399 | dir = 1; | |
400 | i_start = bidi_cache_last_idx + 1; | |
401 | } | |
402 | else if (dir) | |
b7b65b15 EZ |
403 | i_start = bidi_cache_last_idx; |
404 | else | |
405 | { | |
406 | dir = -1; | |
407 | i_start = bidi_cache_idx - 1; | |
408 | } | |
409 | ||
410 | if (dir < 0) | |
411 | { | |
412 | /* Linear search for now; FIXME! */ | |
87e67904 | 413 | for (i = i_start; i >= bidi_cache_start; i--) |
182ce2d2 EZ |
414 | if (bidi_cache[i].charpos <= charpos |
415 | && charpos < bidi_cache[i].charpos + bidi_cache[i].nchars | |
b7b65b15 EZ |
416 | && (level == -1 || bidi_cache[i].resolved_level <= level)) |
417 | return i; | |
418 | } | |
419 | else | |
420 | { | |
421 | for (i = i_start; i < bidi_cache_idx; i++) | |
182ce2d2 EZ |
422 | if (bidi_cache[i].charpos <= charpos |
423 | && charpos < bidi_cache[i].charpos + bidi_cache[i].nchars | |
b7b65b15 EZ |
424 | && (level == -1 || bidi_cache[i].resolved_level <= level)) |
425 | return i; | |
426 | } | |
427 | } | |
428 | ||
429 | return -1; | |
430 | } | |
431 | ||
432 | /* Find a cached state where the resolved level changes to a value | |
433 | that is lower than LEVEL, and return its cache slot index. DIR is | |
434 | the direction to search, starting with the last used cache slot. | |
87e67904 | 435 | If DIR is zero, we search backwards from the last occupied cache |
2cc21167 | 436 | slot. BEFORE means return the index of the slot that |
87e67904 | 437 | is ``before'' the level change in the search direction. That is, |
b7b65b15 EZ |
438 | given the cached levels like this: |
439 | ||
440 | 1122333442211 | |
441 | AB C | |
442 | ||
443 | and assuming we are at the position cached at the slot marked with | |
444 | C, searching backwards (DIR = -1) for LEVEL = 2 will return the | |
445 | index of slot B or A, depending whether BEFORE is, respectively, | |
2cc21167 | 446 | true or false. */ |
39e378da | 447 | static ptrdiff_t |
2cc21167 | 448 | bidi_cache_find_level_change (int level, int dir, bool before) |
b7b65b15 EZ |
449 | { |
450 | if (bidi_cache_idx) | |
451 | { | |
39e378da | 452 | ptrdiff_t i = dir ? bidi_cache_last_idx : bidi_cache_idx - 1; |
b7b65b15 EZ |
453 | int incr = before ? 1 : 0; |
454 | ||
a54e2c05 | 455 | eassert (!dir || bidi_cache_last_idx >= 0); |
6eec7596 | 456 | |
b7b65b15 EZ |
457 | if (!dir) |
458 | dir = -1; | |
459 | else if (!incr) | |
460 | i += dir; | |
461 | ||
462 | if (dir < 0) | |
463 | { | |
87e67904 | 464 | while (i >= bidi_cache_start + incr) |
b7b65b15 EZ |
465 | { |
466 | if (bidi_cache[i - incr].resolved_level >= 0 | |
467 | && bidi_cache[i - incr].resolved_level < level) | |
468 | return i; | |
469 | i--; | |
470 | } | |
471 | } | |
472 | else | |
473 | { | |
474 | while (i < bidi_cache_idx - incr) | |
475 | { | |
476 | if (bidi_cache[i + incr].resolved_level >= 0 | |
477 | && bidi_cache[i + incr].resolved_level < level) | |
478 | return i; | |
479 | i++; | |
480 | } | |
481 | } | |
482 | } | |
483 | ||
484 | return -1; | |
485 | } | |
486 | ||
0a99eee1 | 487 | static void |
39e378da | 488 | bidi_cache_ensure_space (ptrdiff_t idx) |
58b9f433 EZ |
489 | { |
490 | /* Enlarge the cache as needed. */ | |
491 | if (idx >= bidi_cache_size) | |
492 | { | |
f0eb61e9 PE |
493 | /* The bidi cache cannot be larger than the largest Lisp string |
494 | or buffer. */ | |
512a289d RS |
495 | ptrdiff_t string_or_buffer_bound |
496 | = max (BUF_BYTES_MAX, STRING_BYTES_BOUND); | |
f0eb61e9 PE |
497 | |
498 | /* Also, it cannot be larger than what C can represent. */ | |
512a289d RS |
499 | ptrdiff_t c_bound |
500 | = (min (PTRDIFF_MAX, SIZE_MAX) - bidi_shelve_header_size) / elsz; | |
f0eb61e9 | 501 | |
512a289d RS |
502 | bidi_cache |
503 | = xpalloc (bidi_cache, &bidi_cache_size, | |
504 | max (BIDI_CACHE_CHUNK, idx - bidi_cache_size + 1), | |
505 | min (string_or_buffer_bound, c_bound), elsz); | |
58b9f433 EZ |
506 | } |
507 | } | |
508 | ||
0a99eee1 | 509 | static void |
2cc21167 | 510 | bidi_cache_iterator_state (struct bidi_it *bidi_it, bool resolved) |
b7b65b15 | 511 | { |
39e378da | 512 | ptrdiff_t idx; |
b7b65b15 EZ |
513 | |
514 | /* We should never cache on backward scans. */ | |
515 | if (bidi_it->scan_dir == -1) | |
1088b922 | 516 | emacs_abort (); |
b7b65b15 EZ |
517 | idx = bidi_cache_search (bidi_it->charpos, -1, 1); |
518 | ||
519 | if (idx < 0) | |
520 | { | |
521 | idx = bidi_cache_idx; | |
58b9f433 | 522 | bidi_cache_ensure_space (idx); |
bd924a5d EZ |
523 | /* Character positions should correspond to cache positions 1:1. |
524 | If we are outside the range of cached positions, the cache is | |
525 | useless and must be reset. */ | |
87e67904 | 526 | if (idx > bidi_cache_start && |
182ce2d2 EZ |
527 | (bidi_it->charpos > (bidi_cache[idx - 1].charpos |
528 | + bidi_cache[idx - 1].nchars) | |
a1344e7d | 529 | || bidi_it->charpos < bidi_cache[bidi_cache_start].charpos)) |
bd924a5d EZ |
530 | { |
531 | bidi_cache_reset (); | |
87e67904 | 532 | idx = bidi_cache_start; |
bd924a5d | 533 | } |
102ebb00 | 534 | if (bidi_it->nchars <= 0) |
1088b922 | 535 | emacs_abort (); |
b7b65b15 EZ |
536 | bidi_copy_it (&bidi_cache[idx], bidi_it); |
537 | if (!resolved) | |
538 | bidi_cache[idx].resolved_level = -1; | |
539 | } | |
540 | else | |
541 | { | |
542 | /* Copy only the members which could have changed, to avoid | |
543 | costly copying of the entire struct. */ | |
544 | bidi_cache[idx].type = bidi_it->type; | |
2d6e4628 | 545 | bidi_check_type (bidi_it->type); |
89d3374a EZ |
546 | bidi_cache[idx].type_after_w1 = bidi_it->type_after_w1; |
547 | bidi_check_type (bidi_it->type_after_w1); | |
b7b65b15 EZ |
548 | if (resolved) |
549 | bidi_cache[idx].resolved_level = bidi_it->resolved_level; | |
550 | else | |
551 | bidi_cache[idx].resolved_level = -1; | |
552 | bidi_cache[idx].invalid_levels = bidi_it->invalid_levels; | |
553 | bidi_cache[idx].invalid_rl_levels = bidi_it->invalid_rl_levels; | |
554 | bidi_cache[idx].next_for_neutral = bidi_it->next_for_neutral; | |
555 | bidi_cache[idx].next_for_ws = bidi_it->next_for_ws; | |
556 | bidi_cache[idx].ignore_bn_limit = bidi_it->ignore_bn_limit; | |
f67cdd7f | 557 | bidi_cache[idx].disp_pos = bidi_it->disp_pos; |
0c95fcf7 | 558 | bidi_cache[idx].disp_prop = bidi_it->disp_prop; |
b7b65b15 EZ |
559 | } |
560 | ||
561 | bidi_cache_last_idx = idx; | |
562 | if (idx >= bidi_cache_idx) | |
563 | bidi_cache_idx = idx + 1; | |
564 | } | |
565 | ||
0a99eee1 | 566 | static bidi_type_t |
d311d28c | 567 | bidi_cache_find (ptrdiff_t charpos, int level, struct bidi_it *bidi_it) |
b7b65b15 | 568 | { |
39e378da | 569 | ptrdiff_t i = bidi_cache_search (charpos, level, bidi_it->scan_dir); |
b7b65b15 | 570 | |
87e67904 | 571 | if (i >= bidi_cache_start) |
b7b65b15 EZ |
572 | { |
573 | bidi_dir_t current_scan_dir = bidi_it->scan_dir; | |
574 | ||
5009f85e | 575 | bidi_copy_it (bidi_it, &bidi_cache[i]); |
b7b65b15 | 576 | bidi_cache_last_idx = i; |
5a5fa834 | 577 | /* Don't let scan direction from the cached state override |
b7b65b15 EZ |
578 | the current scan direction. */ |
579 | bidi_it->scan_dir = current_scan_dir; | |
580 | return bidi_it->type; | |
581 | } | |
582 | ||
583 | return UNKNOWN_BT; | |
584 | } | |
585 | ||
0a99eee1 | 586 | static int |
b7b65b15 EZ |
587 | bidi_peek_at_next_level (struct bidi_it *bidi_it) |
588 | { | |
87e67904 | 589 | if (bidi_cache_idx == bidi_cache_start || bidi_cache_last_idx == -1) |
1088b922 | 590 | emacs_abort (); |
b7b65b15 EZ |
591 | return bidi_cache[bidi_cache_last_idx + bidi_it->scan_dir].resolved_level; |
592 | } | |
593 | ||
cbb09f04 | 594 | \f |
58b9f433 EZ |
595 | /*********************************************************************** |
596 | Pushing and popping the bidi iterator state | |
597 | ***********************************************************************/ | |
58b9f433 EZ |
598 | |
599 | /* Push the bidi iterator state in preparation for reordering a | |
600 | different object, e.g. display string found at certain buffer | |
7e2ad32c EZ |
601 | position. Pushing the bidi iterator boils down to saving its |
602 | entire state on the cache and starting a new cache "stacked" on top | |
603 | of the current cache. */ | |
58b9f433 EZ |
604 | void |
605 | bidi_push_it (struct bidi_it *bidi_it) | |
b7b65b15 | 606 | { |
58b9f433 EZ |
607 | /* Save the current iterator state in its entirety after the last |
608 | used cache slot. */ | |
609 | bidi_cache_ensure_space (bidi_cache_idx); | |
ae1d87e2 | 610 | bidi_cache[bidi_cache_idx++] = *bidi_it; |
be39f003 | 611 | |
58b9f433 | 612 | /* Push the current cache start onto the stack. */ |
a54e2c05 | 613 | eassert (bidi_cache_sp < IT_STACK_SIZE); |
58b9f433 | 614 | bidi_cache_start_stack[bidi_cache_sp++] = bidi_cache_start; |
be39f003 | 615 | |
58b9f433 EZ |
616 | /* Start a new level of cache, and make it empty. */ |
617 | bidi_cache_start = bidi_cache_idx; | |
618 | bidi_cache_last_idx = -1; | |
619 | } | |
620 | ||
621 | /* Restore the iterator state saved by bidi_push_it and return the | |
622 | cache to the corresponding state. */ | |
623 | void | |
624 | bidi_pop_it (struct bidi_it *bidi_it) | |
625 | { | |
626 | if (bidi_cache_start <= 0) | |
1088b922 | 627 | emacs_abort (); |
58b9f433 EZ |
628 | |
629 | /* Reset the next free cache slot index to what it was before the | |
630 | call to bidi_push_it. */ | |
631 | bidi_cache_idx = bidi_cache_start - 1; | |
632 | ||
633 | /* Restore the bidi iterator state saved in the cache. */ | |
ae1d87e2 | 634 | *bidi_it = bidi_cache[bidi_cache_idx]; |
58b9f433 EZ |
635 | |
636 | /* Pop the previous cache start from the stack. */ | |
637 | if (bidi_cache_sp <= 0) | |
1088b922 | 638 | emacs_abort (); |
58b9f433 EZ |
639 | bidi_cache_start = bidi_cache_start_stack[--bidi_cache_sp]; |
640 | ||
641 | /* Invalidate the last-used cache slot data. */ | |
642 | bidi_cache_last_idx = -1; | |
643 | } | |
644 | ||
ec7cc85b | 645 | static ptrdiff_t bidi_cache_total_alloc; |
35928349 | 646 | |
ed94e6d7 EZ |
647 | /* Stash away a copy of the cache and its control variables. */ |
648 | void * | |
649 | bidi_shelve_cache (void) | |
650 | { | |
651 | unsigned char *databuf; | |
458bfed3 | 652 | ptrdiff_t alloc; |
ed94e6d7 | 653 | |
35928349 | 654 | /* Empty cache. */ |
ed94e6d7 EZ |
655 | if (bidi_cache_idx == 0) |
656 | return NULL; | |
657 | ||
458bfed3 PE |
658 | alloc = (bidi_shelve_header_size |
659 | + bidi_cache_idx * sizeof (struct bidi_it)); | |
660 | databuf = xmalloc (alloc); | |
661 | bidi_cache_total_alloc += alloc; | |
35928349 | 662 | |
ed94e6d7 EZ |
663 | memcpy (databuf, &bidi_cache_idx, sizeof (bidi_cache_idx)); |
664 | memcpy (databuf + sizeof (bidi_cache_idx), | |
665 | bidi_cache, bidi_cache_idx * sizeof (struct bidi_it)); | |
666 | memcpy (databuf + sizeof (bidi_cache_idx) | |
667 | + bidi_cache_idx * sizeof (struct bidi_it), | |
668 | bidi_cache_start_stack, sizeof (bidi_cache_start_stack)); | |
669 | memcpy (databuf + sizeof (bidi_cache_idx) | |
670 | + bidi_cache_idx * sizeof (struct bidi_it) | |
671 | + sizeof (bidi_cache_start_stack), | |
672 | &bidi_cache_sp, sizeof (bidi_cache_sp)); | |
673 | memcpy (databuf + sizeof (bidi_cache_idx) | |
674 | + bidi_cache_idx * sizeof (struct bidi_it) | |
675 | + sizeof (bidi_cache_start_stack) + sizeof (bidi_cache_sp), | |
676 | &bidi_cache_start, sizeof (bidi_cache_start)); | |
677 | memcpy (databuf + sizeof (bidi_cache_idx) | |
678 | + bidi_cache_idx * sizeof (struct bidi_it) | |
679 | + sizeof (bidi_cache_start_stack) + sizeof (bidi_cache_sp) | |
680 | + sizeof (bidi_cache_start), | |
681 | &bidi_cache_last_idx, sizeof (bidi_cache_last_idx)); | |
682 | ||
683 | return databuf; | |
684 | } | |
685 | ||
d1410150 EZ |
686 | /* Restore the cache state from a copy stashed away by |
687 | bidi_shelve_cache, and free the buffer used to stash that copy. | |
2cc21167 | 688 | JUST_FREE means free the buffer, but don't restore the |
d1410150 EZ |
689 | cache; used when the corresponding iterator is discarded instead of |
690 | being restored. */ | |
ed94e6d7 | 691 | void |
2cc21167 | 692 | bidi_unshelve_cache (void *databuf, bool just_free) |
ed94e6d7 EZ |
693 | { |
694 | unsigned char *p = databuf; | |
695 | ||
696 | if (!p) | |
be39f003 | 697 | { |
d1410150 EZ |
698 | if (!just_free) |
699 | { | |
700 | /* A NULL pointer means an empty cache. */ | |
701 | bidi_cache_start = 0; | |
702 | bidi_cache_sp = 0; | |
703 | bidi_cache_reset (); | |
704 | } | |
be39f003 | 705 | } |
ed94e6d7 EZ |
706 | else |
707 | { | |
35928349 EZ |
708 | if (just_free) |
709 | { | |
710 | ptrdiff_t idx; | |
711 | ||
712 | memcpy (&idx, p, sizeof (bidi_cache_idx)); | |
512a289d RS |
713 | bidi_cache_total_alloc |
714 | -= bidi_shelve_header_size + idx * sizeof (struct bidi_it); | |
35928349 EZ |
715 | } |
716 | else | |
717 | { | |
718 | memcpy (&bidi_cache_idx, p, sizeof (bidi_cache_idx)); | |
719 | bidi_cache_ensure_space (bidi_cache_idx); | |
720 | memcpy (bidi_cache, p + sizeof (bidi_cache_idx), | |
721 | bidi_cache_idx * sizeof (struct bidi_it)); | |
722 | memcpy (bidi_cache_start_stack, | |
723 | p + sizeof (bidi_cache_idx) | |
724 | + bidi_cache_idx * sizeof (struct bidi_it), | |
725 | sizeof (bidi_cache_start_stack)); | |
726 | memcpy (&bidi_cache_sp, | |
727 | p + sizeof (bidi_cache_idx) | |
728 | + bidi_cache_idx * sizeof (struct bidi_it) | |
729 | + sizeof (bidi_cache_start_stack), | |
730 | sizeof (bidi_cache_sp)); | |
731 | memcpy (&bidi_cache_start, | |
732 | p + sizeof (bidi_cache_idx) | |
733 | + bidi_cache_idx * sizeof (struct bidi_it) | |
734 | + sizeof (bidi_cache_start_stack) + sizeof (bidi_cache_sp), | |
735 | sizeof (bidi_cache_start)); | |
736 | memcpy (&bidi_cache_last_idx, | |
737 | p + sizeof (bidi_cache_idx) | |
738 | + bidi_cache_idx * sizeof (struct bidi_it) | |
739 | + sizeof (bidi_cache_start_stack) + sizeof (bidi_cache_sp) | |
740 | + sizeof (bidi_cache_start), | |
741 | sizeof (bidi_cache_last_idx)); | |
512a289d RS |
742 | bidi_cache_total_alloc |
743 | -= (bidi_shelve_header_size | |
744 | + bidi_cache_idx * sizeof (struct bidi_it)); | |
35928349 | 745 | } |
ed94e6d7 EZ |
746 | |
747 | xfree (p); | |
748 | } | |
749 | } | |
b7b65b15 | 750 | |
58b9f433 | 751 | \f |
cbb09f04 EZ |
752 | /*********************************************************************** |
753 | Initialization | |
754 | ***********************************************************************/ | |
755 | static void | |
756 | bidi_initialize (void) | |
b7b65b15 | 757 | { |
474a8465 EZ |
758 | bidi_type_table = uniprop_table (intern ("bidi-class")); |
759 | if (NILP (bidi_type_table)) | |
1088b922 | 760 | emacs_abort (); |
cbb09f04 EZ |
761 | staticpro (&bidi_type_table); |
762 | ||
474a8465 EZ |
763 | bidi_mirror_table = uniprop_table (intern ("mirroring")); |
764 | if (NILP (bidi_mirror_table)) | |
1088b922 | 765 | emacs_abort (); |
cbb09f04 EZ |
766 | staticpro (&bidi_mirror_table); |
767 | ||
cbb09f04 EZ |
768 | Qparagraph_start = intern ("paragraph-start"); |
769 | staticpro (&Qparagraph_start); | |
770 | paragraph_start_re = Fsymbol_value (Qparagraph_start); | |
771 | if (!STRINGP (paragraph_start_re)) | |
772 | paragraph_start_re = build_string ("\f\\|[ \t]*$"); | |
773 | staticpro (¶graph_start_re); | |
774 | Qparagraph_separate = intern ("paragraph-separate"); | |
775 | staticpro (&Qparagraph_separate); | |
776 | paragraph_separate_re = Fsymbol_value (Qparagraph_separate); | |
777 | if (!STRINGP (paragraph_separate_re)) | |
778 | paragraph_separate_re = build_string ("[ \t\f]*$"); | |
779 | staticpro (¶graph_separate_re); | |
58b9f433 EZ |
780 | |
781 | bidi_cache_sp = 0; | |
ec7cc85b | 782 | bidi_cache_total_alloc = 0; |
58b9f433 | 783 | |
cbb09f04 | 784 | bidi_initialized = 1; |
b7b65b15 EZ |
785 | } |
786 | ||
cbb09f04 EZ |
787 | /* Do whatever UAX#9 clause X8 says should be done at paragraph's |
788 | end. */ | |
0a99eee1 | 789 | static void |
cbb09f04 | 790 | bidi_set_paragraph_end (struct bidi_it *bidi_it) |
b7b65b15 | 791 | { |
cbb09f04 EZ |
792 | bidi_it->invalid_levels = 0; |
793 | bidi_it->invalid_rl_levels = -1; | |
794 | bidi_it->stack_idx = 0; | |
795 | bidi_it->resolved_level = bidi_it->level_stack[0].level; | |
796 | } | |
b7b65b15 | 797 | |
cbb09f04 EZ |
798 | /* Initialize the bidi iterator from buffer/string position CHARPOS. */ |
799 | void | |
2cc21167 | 800 | bidi_init_it (ptrdiff_t charpos, ptrdiff_t bytepos, bool frame_window_p, |
cbb09f04 EZ |
801 | struct bidi_it *bidi_it) |
802 | { | |
803 | if (! bidi_initialized) | |
804 | bidi_initialize (); | |
805 | if (charpos >= 0) | |
806 | bidi_it->charpos = charpos; | |
807 | if (bytepos >= 0) | |
808 | bidi_it->bytepos = bytepos; | |
809 | bidi_it->frame_window_p = frame_window_p; | |
810 | bidi_it->nchars = -1; /* to be computed in bidi_resolve_explicit_1 */ | |
811 | bidi_it->first_elt = 1; | |
812 | bidi_set_paragraph_end (bidi_it); | |
813 | bidi_it->new_paragraph = 1; | |
814 | bidi_it->separator_limit = -1; | |
815 | bidi_it->type = NEUTRAL_B; | |
816 | bidi_it->type_after_w1 = NEUTRAL_B; | |
817 | bidi_it->orig_type = NEUTRAL_B; | |
818 | bidi_it->prev_was_pdf = 0; | |
512a289d RS |
819 | bidi_it->prev.type = bidi_it->prev.type_after_w1 |
820 | = bidi_it->prev.orig_type = UNKNOWN_BT; | |
821 | bidi_it->last_strong.type = bidi_it->last_strong.type_after_w1 | |
822 | = bidi_it->last_strong.orig_type = UNKNOWN_BT; | |
cbb09f04 | 823 | bidi_it->next_for_neutral.charpos = -1; |
512a289d RS |
824 | bidi_it->next_for_neutral.type |
825 | = bidi_it->next_for_neutral.type_after_w1 | |
826 | = bidi_it->next_for_neutral.orig_type = UNKNOWN_BT; | |
cbb09f04 | 827 | bidi_it->prev_for_neutral.charpos = -1; |
512a289d RS |
828 | bidi_it->prev_for_neutral.type |
829 | = bidi_it->prev_for_neutral.type_after_w1 | |
830 | = bidi_it->prev_for_neutral.orig_type = UNKNOWN_BT; | |
cbb09f04 EZ |
831 | bidi_it->sor = L2R; /* FIXME: should it be user-selectable? */ |
832 | bidi_it->disp_pos = -1; /* invalid/unknown */ | |
0c95fcf7 | 833 | bidi_it->disp_prop = 0; |
cbb09f04 EZ |
834 | /* We can only shrink the cache if we are at the bottom level of its |
835 | "stack". */ | |
836 | if (bidi_cache_start == 0) | |
837 | bidi_cache_shrink (); | |
58b9f433 EZ |
838 | else |
839 | bidi_cache_reset (); | |
b7b65b15 EZ |
840 | } |
841 | ||
182ce2d2 | 842 | /* Perform initializations for reordering a new line of bidi text. */ |
6bff6497 | 843 | static void |
be39f003 EZ |
844 | bidi_line_init (struct bidi_it *bidi_it) |
845 | { | |
846 | bidi_it->scan_dir = 1; /* FIXME: do we need to have control on this? */ | |
847 | bidi_it->resolved_level = bidi_it->level_stack[0].level; | |
848 | bidi_it->level_stack[0].override = NEUTRAL_DIR; /* X1 */ | |
849 | bidi_it->invalid_levels = 0; | |
850 | bidi_it->invalid_rl_levels = -1; | |
4787455f EZ |
851 | /* Setting this to zero will force its recomputation the first time |
852 | we need it for W5. */ | |
853 | bidi_it->next_en_pos = 0; | |
7b5d6677 | 854 | bidi_it->next_en_type = UNKNOWN_BT; |
be39f003 | 855 | bidi_it->next_for_ws.type = UNKNOWN_BT; |
b44d9321 | 856 | bidi_set_sor_type (bidi_it, |
512a289d | 857 | (bidi_it->paragraph_dir == R2L ? 1 : 0), |
be39f003 EZ |
858 | bidi_it->level_stack[0].level); /* X10 */ |
859 | ||
860 | bidi_cache_reset (); | |
861 | } | |
862 | ||
cbb09f04 EZ |
863 | \f |
864 | /*********************************************************************** | |
865 | Fetching characters | |
866 | ***********************************************************************/ | |
867 | ||
f3014ef5 EZ |
868 | /* Count bytes in string S between BEG/BEGBYTE and END. BEG and END |
869 | are zero-based character positions in S, BEGBYTE is byte position | |
2cc21167 | 870 | corresponding to BEG. UNIBYTE means S is a unibyte string. */ |
0a99eee1 | 871 | static ptrdiff_t |
d311d28c | 872 | bidi_count_bytes (const unsigned char *s, const ptrdiff_t beg, |
2cc21167 | 873 | const ptrdiff_t begbyte, const ptrdiff_t end, bool unibyte) |
87e67904 | 874 | { |
d311d28c | 875 | ptrdiff_t pos = beg; |
87e67904 EZ |
876 | const unsigned char *p = s + begbyte, *start = p; |
877 | ||
f3014ef5 EZ |
878 | if (unibyte) |
879 | p = s + end; | |
880 | else | |
87e67904 | 881 | { |
f3014ef5 | 882 | if (!CHAR_HEAD_P (*p)) |
1088b922 | 883 | emacs_abort (); |
f3014ef5 EZ |
884 | |
885 | while (pos < end) | |
886 | { | |
887 | p += BYTES_BY_CHAR_HEAD (*p); | |
888 | pos++; | |
889 | } | |
87e67904 EZ |
890 | } |
891 | ||
892 | return p - start; | |
893 | } | |
894 | ||
05584c31 | 895 | /* Fetch and return the character at byte position BYTEPOS. If S is |
87e67904 | 896 | non-NULL, fetch the character from string S; otherwise fetch the |
2cc21167 | 897 | character from the current buffer. UNIBYTE means S is a |
f3014ef5 | 898 | unibyte string. */ |
0a99eee1 | 899 | static int |
2cc21167 | 900 | bidi_char_at_pos (ptrdiff_t bytepos, const unsigned char *s, bool unibyte) |
87e67904 EZ |
901 | { |
902 | if (s) | |
f3014ef5 | 903 | { |
05584c31 | 904 | s += bytepos; |
f3014ef5 | 905 | if (unibyte) |
05584c31 | 906 | return *s; |
f3014ef5 | 907 | } |
87e67904 | 908 | else |
05584c31 PE |
909 | s = BYTE_POS_ADDR (bytepos); |
910 | return STRING_CHAR (s); | |
87e67904 EZ |
911 | } |
912 | ||
36075a19 | 913 | /* Fetch and return the character at CHARPOS/BYTEPOS. If that |
102ebb00 | 914 | character is covered by a display string, treat the entire run of |
0c95fcf7 EZ |
915 | covered characters as a single character, either u+2029 or u+FFFC, |
916 | and return their combined length in CH_LEN and NCHARS. DISP_POS | |
917 | specifies the character position of the next display string, or -1 | |
b75258b3 EZ |
918 | if not yet computed. When the next character is at or beyond that |
919 | position, the function updates DISP_POS with the position of the | |
2cc21167 | 920 | next display string. *DISP_PROP non-zero means that there's really |
0c95fcf7 | 921 | a display string at DISP_POS, as opposed to when we searched till |
2cc21167 | 922 | DISP_POS without finding one. If *DISP_PROP is 2, it means the |
0c95fcf7 | 923 | display spec is of the form `(space ...)', which is replaced with |
b75258b3 EZ |
924 | u+2029 to handle it as a paragraph separator. STRING->s is the C |
925 | string to iterate, or NULL if iterating over a buffer or a Lisp | |
926 | string; in the latter case, STRING->lstring is the Lisp string. */ | |
0a99eee1 | 927 | static int |
36075a19 | 928 | bidi_fetch_char (ptrdiff_t charpos, ptrdiff_t bytepos, ptrdiff_t *disp_pos, |
0c95fcf7 | 929 | int *disp_prop, struct bidi_string_data *string, |
2cc21167 | 930 | bool frame_window_p, ptrdiff_t *ch_len, ptrdiff_t *nchars) |
182ce2d2 EZ |
931 | { |
932 | int ch; | |
5895d7b9 | 933 | ptrdiff_t endpos |
512a289d | 934 | = (string->s || STRINGP (string->lstring)) ? string->schars : ZV; |
6db161be | 935 | struct text_pos pos; |
e99a9b8b | 936 | int len; |
182ce2d2 | 937 | |
182ce2d2 | 938 | /* If we got past the last known position of display string, compute |
87e67904 EZ |
939 | the position of the next one. That position could be at CHARPOS. */ |
940 | if (charpos < endpos && charpos > *disp_pos) | |
6db161be EZ |
941 | { |
942 | SET_TEXT_POS (pos, charpos, bytepos); | |
55439c61 | 943 | *disp_pos = compute_display_string_pos (&pos, string, frame_window_p, |
0c95fcf7 | 944 | disp_prop); |
6db161be | 945 | } |
102ebb00 EZ |
946 | |
947 | /* Fetch the character at BYTEPOS. */ | |
87e67904 | 948 | if (charpos >= endpos) |
182ce2d2 EZ |
949 | { |
950 | ch = BIDI_EOB; | |
951 | *ch_len = 1; | |
952 | *nchars = 1; | |
87e67904 | 953 | *disp_pos = endpos; |
0c95fcf7 | 954 | *disp_prop = 0; |
182ce2d2 | 955 | } |
0c95fcf7 | 956 | else if (charpos >= *disp_pos && *disp_prop) |
182ce2d2 | 957 | { |
d311d28c | 958 | ptrdiff_t disp_end_pos; |
7b600102 EZ |
959 | |
960 | /* We don't expect to find ourselves in the middle of a display | |
961 | property. Hopefully, it will never be needed. */ | |
962 | if (charpos > *disp_pos) | |
1088b922 | 963 | emacs_abort (); |
0c95fcf7 EZ |
964 | /* Text covered by `display' properties and overlays with |
965 | display properties or display strings is handled as a single | |
966 | character that represents the entire run of characters | |
967 | covered by the display property. */ | |
968 | if (*disp_prop == 2) | |
969 | { | |
970 | /* `(space ...)' display specs are handled as paragraph | |
971 | separators for the purposes of the reordering; see UAX#9 | |
972 | section 3 and clause HL1 in section 4.3 there. */ | |
973 | ch = 0x2029; | |
974 | } | |
975 | else | |
976 | { | |
977 | /* All other display specs are handled as the Unicode Object | |
978 | Replacement Character. */ | |
979 | ch = 0xFFFC; | |
980 | } | |
87e67904 | 981 | disp_end_pos = compute_display_string_end (*disp_pos, string); |
fbcaa2f3 EZ |
982 | if (disp_end_pos < 0) |
983 | { | |
984 | /* Somebody removed the display string from the buffer | |
985 | behind our back. Recover by processing this buffer | |
986 | position as if no display property were present there to | |
987 | begin with. */ | |
988 | *disp_prop = 0; | |
989 | goto normal_char; | |
990 | } | |
7b600102 | 991 | *nchars = disp_end_pos - *disp_pos; |
f3014ef5 | 992 | if (*nchars <= 0) |
1088b922 | 993 | emacs_abort (); |
87e67904 EZ |
994 | if (string->s) |
995 | *ch_len = bidi_count_bytes (string->s, *disp_pos, bytepos, | |
f3014ef5 | 996 | disp_end_pos, string->unibyte); |
9f257352 EZ |
997 | else if (STRINGP (string->lstring)) |
998 | *ch_len = bidi_count_bytes (SDATA (string->lstring), *disp_pos, | |
f3014ef5 | 999 | bytepos, disp_end_pos, string->unibyte); |
87e67904 EZ |
1000 | else |
1001 | *ch_len = CHAR_TO_BYTE (disp_end_pos) - bytepos; | |
182ce2d2 | 1002 | } |
182ce2d2 EZ |
1003 | else |
1004 | { | |
fbcaa2f3 | 1005 | normal_char: |
87e67904 EZ |
1006 | if (string->s) |
1007 | { | |
87e67904 | 1008 | |
f3014ef5 EZ |
1009 | if (!string->unibyte) |
1010 | { | |
1011 | ch = STRING_CHAR_AND_LENGTH (string->s + bytepos, len); | |
1012 | *ch_len = len; | |
1013 | } | |
1014 | else | |
1015 | { | |
1016 | ch = UNIBYTE_TO_CHAR (string->s[bytepos]); | |
1017 | *ch_len = 1; | |
1018 | } | |
87e67904 | 1019 | } |
9f257352 EZ |
1020 | else if (STRINGP (string->lstring)) |
1021 | { | |
f3014ef5 EZ |
1022 | if (!string->unibyte) |
1023 | { | |
1024 | ch = STRING_CHAR_AND_LENGTH (SDATA (string->lstring) + bytepos, | |
1025 | len); | |
1026 | *ch_len = len; | |
1027 | } | |
1028 | else | |
1029 | { | |
1030 | ch = UNIBYTE_TO_CHAR (SREF (string->lstring, bytepos)); | |
1031 | *ch_len = 1; | |
1032 | } | |
9f257352 | 1033 | } |
87e67904 EZ |
1034 | else |
1035 | { | |
e99a9b8b EZ |
1036 | ch = STRING_CHAR_AND_LENGTH (BYTE_POS_ADDR (bytepos), len); |
1037 | *ch_len = len; | |
87e67904 | 1038 | } |
182ce2d2 EZ |
1039 | *nchars = 1; |
1040 | } | |
1041 | ||
1042 | /* If we just entered a run of characters covered by a display | |
1043 | string, compute the position of the next display string. */ | |
55439c61 | 1044 | if (charpos + *nchars <= endpos && charpos + *nchars > *disp_pos |
0c95fcf7 | 1045 | && *disp_prop) |
6db161be EZ |
1046 | { |
1047 | SET_TEXT_POS (pos, charpos + *nchars, bytepos + *ch_len); | |
55439c61 | 1048 | *disp_pos = compute_display_string_pos (&pos, string, frame_window_p, |
0c95fcf7 | 1049 | disp_prop); |
6db161be | 1050 | } |
182ce2d2 EZ |
1051 | |
1052 | return ch; | |
1053 | } | |
1054 | ||
cbb09f04 EZ |
1055 | \f |
1056 | /*********************************************************************** | |
1057 | Determining paragraph direction | |
1058 | ***********************************************************************/ | |
1059 | ||
1060 | /* Check if buffer position CHARPOS/BYTEPOS is the end of a paragraph. | |
1061 | Value is the non-negative length of the paragraph separator | |
1062 | following the buffer position, -1 if position is at the beginning | |
1063 | of a new paragraph, or -2 if position is neither at beginning nor | |
1064 | at end of a paragraph. */ | |
d311d28c PE |
1065 | static ptrdiff_t |
1066 | bidi_at_paragraph_end (ptrdiff_t charpos, ptrdiff_t bytepos) | |
cbb09f04 EZ |
1067 | { |
1068 | Lisp_Object sep_re; | |
1069 | Lisp_Object start_re; | |
d311d28c | 1070 | ptrdiff_t val; |
cbb09f04 EZ |
1071 | |
1072 | sep_re = paragraph_separate_re; | |
1073 | start_re = paragraph_start_re; | |
1074 | ||
1075 | val = fast_looking_at (sep_re, charpos, bytepos, ZV, ZV_BYTE, Qnil); | |
1076 | if (val < 0) | |
1077 | { | |
1078 | if (fast_looking_at (start_re, charpos, bytepos, ZV, ZV_BYTE, Qnil) >= 0) | |
1079 | val = -1; | |
1080 | else | |
1081 | val = -2; | |
1082 | } | |
1083 | ||
1084 | return val; | |
1085 | } | |
1086 | ||
1137e8b8 EZ |
1087 | /* On my 2005-vintage machine, searching back for paragraph start |
1088 | takes ~1 ms per line. And bidi_paragraph_init is called 4 times | |
1089 | when user types C-p. The number below limits each call to | |
1090 | bidi_paragraph_init to about 10 ms. */ | |
1091 | #define MAX_PARAGRAPH_SEARCH 7500 | |
1092 | ||
be39f003 | 1093 | /* Find the beginning of this paragraph by looking back in the buffer. |
1137e8b8 EZ |
1094 | Value is the byte position of the paragraph's beginning, or |
1095 | BEGV_BYTE if paragraph_start_re is still not found after looking | |
1096 | back MAX_PARAGRAPH_SEARCH lines in the buffer. */ | |
d311d28c PE |
1097 | static ptrdiff_t |
1098 | bidi_find_paragraph_start (ptrdiff_t pos, ptrdiff_t pos_byte) | |
6bff6497 | 1099 | { |
372b7a95 | 1100 | Lisp_Object re = paragraph_start_re; |
d311d28c | 1101 | ptrdiff_t limit = ZV, limit_byte = ZV_BYTE; |
4c0078d4 | 1102 | ptrdiff_t n = 0; |
6bff6497 | 1103 | |
6bff6497 | 1104 | while (pos_byte > BEGV_BYTE |
1137e8b8 | 1105 | && n++ < MAX_PARAGRAPH_SEARCH |
6bff6497 | 1106 | && fast_looking_at (re, pos, pos_byte, limit, limit_byte, Qnil) < 0) |
b5426561 DA |
1107 | { |
1108 | /* FIXME: What if the paragraph beginning is covered by a | |
1109 | display string? And what if a display string covering some | |
1110 | of the text over which we scan back includes | |
1111 | paragraph_start_re? */ | |
1112 | DEC_BOTH (pos, pos_byte); | |
1113 | pos = find_newline_no_quit (pos, pos_byte, -1, &pos_byte); | |
1114 | } | |
1137e8b8 EZ |
1115 | if (n >= MAX_PARAGRAPH_SEARCH) |
1116 | pos_byte = BEGV_BYTE; | |
be39f003 | 1117 | return pos_byte; |
6bff6497 EZ |
1118 | } |
1119 | ||
ce811ad9 EZ |
1120 | /* On a 3.4 GHz machine, searching forward for a strong directional |
1121 | character in a long paragraph full of weaks or neutrals takes about | |
1122 | 1 ms for each 20K characters. The number below limits each call to | |
1123 | bidi_paragraph_init to less than 10 ms even on slow machines. */ | |
1124 | #define MAX_STRONG_CHAR_SEARCH 100000 | |
1125 | ||
bea4f10c | 1126 | /* Determine the base direction, a.k.a. base embedding level, of the |
b44d9321 EZ |
1127 | paragraph we are about to iterate through. If DIR is either L2R or |
1128 | R2L, just use that. Otherwise, determine the paragraph direction | |
bea4f10c EZ |
1129 | from the first strong directional character of the paragraph. |
1130 | ||
2cc21167 | 1131 | NO_DEFAULT_P means don't default to L2R if the paragraph |
bea4f10c EZ |
1132 | has no strong directional characters and both DIR and |
1133 | bidi_it->paragraph_dir are NEUTRAL_DIR. In that case, search back | |
1134 | in the buffer until a paragraph is found with a strong character, | |
1135 | or until hitting BEGV. In the latter case, fall back to L2R. This | |
1136 | flag is used in current-bidi-paragraph-direction. | |
1137 | ||
1138 | Note that this function gives the paragraph separator the same | |
1139 | direction as the preceding paragraph, even though Emacs generally | |
9858f6c3 | 1140 | views the separator as not belonging to any paragraph. */ |
b7b65b15 | 1141 | void |
2cc21167 | 1142 | bidi_paragraph_init (bidi_dir_t dir, struct bidi_it *bidi_it, bool no_default_p) |
b7b65b15 | 1143 | { |
d311d28c | 1144 | ptrdiff_t bytepos = bidi_it->bytepos; |
2cc21167 | 1145 | bool string_p = bidi_it->string.s || STRINGP (bidi_it->string.lstring); |
d311d28c | 1146 | ptrdiff_t pstartbyte; |
87e67904 EZ |
1147 | /* Note that begbyte is a byte position, while end is a character |
1148 | position. Yes, this is ugly, but we are trying to avoid costly | |
1149 | calls to BYTE_TO_CHAR and its ilk. */ | |
d311d28c PE |
1150 | ptrdiff_t begbyte = string_p ? 0 : BEGV_BYTE; |
1151 | ptrdiff_t end = string_p ? bidi_it->string.schars : ZV; | |
e7402cb2 | 1152 | |
5e65aec0 | 1153 | /* Special case for an empty buffer. */ |
87e67904 | 1154 | if (bytepos == begbyte && bidi_it->charpos == end) |
5e65aec0 | 1155 | dir = L2R; |
9c82e145 | 1156 | /* We should never be called at EOB or before BEGV. */ |
87e67904 | 1157 | else if (bidi_it->charpos >= end || bytepos < begbyte) |
1088b922 | 1158 | emacs_abort (); |
9c82e145 | 1159 | |
be39f003 EZ |
1160 | if (dir == L2R) |
1161 | { | |
1162 | bidi_it->paragraph_dir = L2R; | |
1163 | bidi_it->new_paragraph = 0; | |
1164 | } | |
1165 | else if (dir == R2L) | |
1166 | { | |
1167 | bidi_it->paragraph_dir = R2L; | |
1168 | bidi_it->new_paragraph = 0; | |
1169 | } | |
b7b65b15 EZ |
1170 | else if (dir == NEUTRAL_DIR) /* P2 */ |
1171 | { | |
182ce2d2 | 1172 | int ch; |
d311d28c PE |
1173 | ptrdiff_t ch_len, nchars; |
1174 | ptrdiff_t pos, disp_pos = -1; | |
0c95fcf7 | 1175 | int disp_prop = 0; |
6bff6497 | 1176 | bidi_type_t type; |
9f257352 | 1177 | const unsigned char *s; |
be39f003 | 1178 | |
d20e1419 EZ |
1179 | if (!bidi_initialized) |
1180 | bidi_initialize (); | |
1181 | ||
be39f003 EZ |
1182 | /* If we are inside a paragraph separator, we are just waiting |
1183 | for the separator to be exhausted; use the previous paragraph | |
e5a2fec7 EZ |
1184 | direction. But don't do that if we have been just reseated, |
1185 | because we need to reinitialize below in that case. */ | |
1186 | if (!bidi_it->first_elt | |
1187 | && bidi_it->charpos < bidi_it->separator_limit) | |
be39f003 EZ |
1188 | return; |
1189 | ||
b44d9321 | 1190 | /* If we are on a newline, get past it to where the next |
5e65aec0 EZ |
1191 | paragraph might start. But don't do that at BEGV since then |
1192 | we are potentially in a new paragraph that doesn't yet | |
1193 | exist. */ | |
c143c213 | 1194 | pos = bidi_it->charpos; |
512a289d RS |
1195 | s = (STRINGP (bidi_it->string.lstring) |
1196 | ? SDATA (bidi_it->string.lstring) | |
1197 | : bidi_it->string.s); | |
f3014ef5 EZ |
1198 | if (bytepos > begbyte |
1199 | && bidi_char_at_pos (bytepos, s, bidi_it->string.unibyte) == '\n') | |
be39f003 | 1200 | { |
b44d9321 | 1201 | bytepos++; |
c143c213 | 1202 | pos++; |
be39f003 | 1203 | } |
b44d9321 EZ |
1204 | |
1205 | /* We are either at the beginning of a paragraph or in the | |
1206 | middle of it. Find where this paragraph starts. */ | |
87e67904 EZ |
1207 | if (string_p) |
1208 | { | |
1209 | /* We don't support changes of paragraph direction inside a | |
1210 | string. It is treated as a single paragraph. */ | |
1211 | pstartbyte = 0; | |
1212 | } | |
1213 | else | |
1214 | pstartbyte = bidi_find_paragraph_start (pos, bytepos); | |
be39f003 EZ |
1215 | bidi_it->separator_limit = -1; |
1216 | bidi_it->new_paragraph = 0; | |
bea4f10c | 1217 | |
2cc21167 PE |
1218 | /* The following loop is run more than once only if NO_DEFAULT_P, |
1219 | and only if we are iterating on a buffer. */ | |
bea4f10c | 1220 | do { |
ce811ad9 EZ |
1221 | ptrdiff_t pos1; |
1222 | ||
bea4f10c | 1223 | bytepos = pstartbyte; |
87e67904 EZ |
1224 | if (!string_p) |
1225 | pos = BYTE_TO_CHAR (bytepos); | |
36075a19 | 1226 | ch = bidi_fetch_char (pos, bytepos, &disp_pos, &disp_prop, |
55439c61 | 1227 | &bidi_it->string, |
87e67904 | 1228 | bidi_it->frame_window_p, &ch_len, &nchars); |
bea4f10c EZ |
1229 | type = bidi_get_type (ch, NEUTRAL_DIR); |
1230 | ||
ce811ad9 | 1231 | pos1 = pos; |
182ce2d2 | 1232 | for (pos += nchars, bytepos += ch_len; |
ce811ad9 EZ |
1233 | ((bidi_get_category (type) != STRONG) |
1234 | || (bidi_ignore_explicit_marks_for_paragraph_level | |
1235 | && (type == RLE || type == RLO | |
1236 | || type == LRE || type == LRO))) | |
1237 | /* Stop when searched too far into an abnormally large | |
1238 | paragraph full of weak or neutral characters. */ | |
1239 | && pos - pos1 < MAX_STRONG_CHAR_SEARCH; | |
bea4f10c EZ |
1240 | type = bidi_get_type (ch, NEUTRAL_DIR)) |
1241 | { | |
87e67904 | 1242 | if (pos >= end) |
bea4f10c EZ |
1243 | { |
1244 | /* Pretend there's a paragraph separator at end of | |
87e67904 | 1245 | buffer/string. */ |
bea4f10c EZ |
1246 | type = NEUTRAL_B; |
1247 | break; | |
1248 | } | |
0bb23927 EZ |
1249 | if (!string_p |
1250 | && type == NEUTRAL_B | |
1251 | && bidi_at_paragraph_end (pos, bytepos) >= -1) | |
cf99dcf8 | 1252 | break; |
102ebb00 | 1253 | /* Fetch next character and advance to get past it. */ |
36075a19 | 1254 | ch = bidi_fetch_char (pos, bytepos, &disp_pos, |
0c95fcf7 | 1255 | &disp_prop, &bidi_it->string, |
fc6f18ce | 1256 | bidi_it->frame_window_p, &ch_len, &nchars); |
182ce2d2 EZ |
1257 | pos += nchars; |
1258 | bytepos += ch_len; | |
bea4f10c | 1259 | } |
32413314 EZ |
1260 | if ((type == STRONG_R || type == STRONG_AL) /* P3 */ |
1261 | || (!bidi_ignore_explicit_marks_for_paragraph_level | |
1262 | && (type == RLO || type == RLE))) | |
bea4f10c | 1263 | bidi_it->paragraph_dir = R2L; |
32413314 EZ |
1264 | else if (type == STRONG_L |
1265 | || (!bidi_ignore_explicit_marks_for_paragraph_level | |
1266 | && (type == LRO || type == LRE))) | |
bea4f10c | 1267 | bidi_it->paragraph_dir = L2R; |
87e67904 EZ |
1268 | if (!string_p |
1269 | && no_default_p && bidi_it->paragraph_dir == NEUTRAL_DIR) | |
bea4f10c EZ |
1270 | { |
1271 | /* If this paragraph is at BEGV, default to L2R. */ | |
1272 | if (pstartbyte == BEGV_BYTE) | |
1273 | bidi_it->paragraph_dir = L2R; /* P3 and HL1 */ | |
1274 | else | |
1275 | { | |
d311d28c PE |
1276 | ptrdiff_t prevpbyte = pstartbyte; |
1277 | ptrdiff_t p = BYTE_TO_CHAR (pstartbyte), pbyte = pstartbyte; | |
bea4f10c EZ |
1278 | |
1279 | /* Find the beginning of the previous paragraph, if any. */ | |
1280 | while (pbyte > BEGV_BYTE && prevpbyte >= pstartbyte) | |
1281 | { | |
182ce2d2 EZ |
1282 | /* FXIME: What if p is covered by a display |
1283 | string? See also a FIXME inside | |
1284 | bidi_find_paragraph_start. */ | |
36075a19 | 1285 | DEC_BOTH (p, pbyte); |
bea4f10c EZ |
1286 | prevpbyte = bidi_find_paragraph_start (p, pbyte); |
1287 | } | |
1288 | pstartbyte = prevpbyte; | |
1289 | } | |
1290 | } | |
87e67904 EZ |
1291 | } while (!string_p |
1292 | && no_default_p && bidi_it->paragraph_dir == NEUTRAL_DIR); | |
b7b65b15 | 1293 | } |
be39f003 | 1294 | else |
1088b922 | 1295 | emacs_abort (); |
b7b65b15 | 1296 | |
b44d9321 EZ |
1297 | /* Contrary to UAX#9 clause P3, we only default the paragraph |
1298 | direction to L2R if we have no previous usable paragraph | |
bea4f10c | 1299 | direction. This is allowed by the HL1 clause. */ |
d20e1419 | 1300 | if (bidi_it->paragraph_dir != L2R && bidi_it->paragraph_dir != R2L) |
bea4f10c | 1301 | bidi_it->paragraph_dir = L2R; /* P3 and HL1 ``higher-level protocols'' */ |
be39f003 | 1302 | if (bidi_it->paragraph_dir == R2L) |
b44d9321 | 1303 | bidi_it->level_stack[0].level = 1; |
be39f003 | 1304 | else |
b44d9321 | 1305 | bidi_it->level_stack[0].level = 0; |
be39f003 EZ |
1306 | |
1307 | bidi_line_init (bidi_it); | |
b7b65b15 EZ |
1308 | } |
1309 | ||
cbb09f04 EZ |
1310 | \f |
1311 | /*********************************************************************** | |
1312 | Resolving explicit and implicit levels. | |
58b9f433 | 1313 | The rest of this file constitutes the core of the UBA implementation. |
cbb09f04 | 1314 | ***********************************************************************/ |
b7b65b15 | 1315 | |
0a99eee1 | 1316 | static bool |
182ce2d2 | 1317 | bidi_explicit_dir_char (int ch) |
b7b65b15 | 1318 | { |
182ce2d2 EZ |
1319 | bidi_type_t ch_type; |
1320 | ||
1321 | if (!bidi_initialized) | |
1088b922 | 1322 | emacs_abort (); |
182ce2d2 EZ |
1323 | ch_type = (bidi_type_t) XINT (CHAR_TABLE_REF (bidi_type_table, ch)); |
1324 | return (ch_type == LRE || ch_type == LRO | |
1325 | || ch_type == RLE || ch_type == RLO | |
1326 | || ch_type == PDF); | |
b7b65b15 EZ |
1327 | } |
1328 | ||
1329 | /* A helper function for bidi_resolve_explicit. It advances to the | |
1330 | next character in logical order and determines the new embedding | |
1331 | level and directional override, but does not take into account | |
1332 | empty embeddings. */ | |
1333 | static int | |
1334 | bidi_resolve_explicit_1 (struct bidi_it *bidi_it) | |
1335 | { | |
1336 | int curchar; | |
1337 | bidi_type_t type; | |
1338 | int current_level; | |
1339 | int new_level; | |
1340 | bidi_dir_t override; | |
2cc21167 | 1341 | bool string_p = bidi_it->string.s || STRINGP (bidi_it->string.lstring); |
b7b65b15 | 1342 | |
182ce2d2 EZ |
1343 | /* If reseat()'ed, don't advance, so as to start iteration from the |
1344 | position where we were reseated. bidi_it->bytepos can be less | |
1345 | than BEGV_BYTE after reseat to BEGV. */ | |
87e67904 | 1346 | if (bidi_it->bytepos < (string_p ? 0 : BEGV_BYTE) |
9c82e145 | 1347 | || bidi_it->first_elt) |
e7402cb2 | 1348 | { |
9c82e145 | 1349 | bidi_it->first_elt = 0; |
87e67904 EZ |
1350 | if (string_p) |
1351 | { | |
512a289d RS |
1352 | const unsigned char *p |
1353 | = (STRINGP (bidi_it->string.lstring) | |
1354 | ? SDATA (bidi_it->string.lstring) | |
1355 | : bidi_it->string.s); | |
9f257352 | 1356 | |
87e67904 | 1357 | if (bidi_it->charpos < 0) |
05e193f1 EZ |
1358 | bidi_it->charpos = bidi_it->bytepos = 0; |
1359 | eassert (bidi_it->bytepos == bidi_count_bytes (p, 0, 0, | |
1360 | bidi_it->charpos, | |
1361 | bidi_it->string.unibyte)); | |
87e67904 EZ |
1362 | } |
1363 | else | |
1364 | { | |
1365 | if (bidi_it->charpos < BEGV) | |
05e193f1 EZ |
1366 | { |
1367 | bidi_it->charpos = BEGV; | |
1368 | bidi_it->bytepos = BEGV_BYTE; | |
1369 | } | |
1370 | eassert (bidi_it->bytepos == CHAR_TO_BYTE (bidi_it->charpos)); | |
87e67904 | 1371 | } |
e7402cb2 | 1372 | } |
87e67904 EZ |
1373 | /* Don't move at end of buffer/string. */ |
1374 | else if (bidi_it->charpos < (string_p ? bidi_it->string.schars : ZV)) | |
b7b65b15 | 1375 | { |
182ce2d2 EZ |
1376 | /* Advance to the next character, skipping characters covered by |
1377 | display strings (nchars > 1). */ | |
102ebb00 | 1378 | if (bidi_it->nchars <= 0) |
1088b922 | 1379 | emacs_abort (); |
182ce2d2 | 1380 | bidi_it->charpos += bidi_it->nchars; |
e7402cb2 | 1381 | if (bidi_it->ch_len == 0) |
1088b922 | 1382 | emacs_abort (); |
b7b65b15 EZ |
1383 | bidi_it->bytepos += bidi_it->ch_len; |
1384 | } | |
1385 | ||
1386 | current_level = bidi_it->level_stack[bidi_it->stack_idx].level; /* X1 */ | |
1387 | override = bidi_it->level_stack[bidi_it->stack_idx].override; | |
1388 | new_level = current_level; | |
1389 | ||
87e67904 | 1390 | if (bidi_it->charpos >= (string_p ? bidi_it->string.schars : ZV)) |
e7402cb2 EZ |
1391 | { |
1392 | curchar = BIDI_EOB; | |
1393 | bidi_it->ch_len = 1; | |
182ce2d2 | 1394 | bidi_it->nchars = 1; |
87e67904 | 1395 | bidi_it->disp_pos = (string_p ? bidi_it->string.schars : ZV); |
0c95fcf7 | 1396 | bidi_it->disp_prop = 0; |
e7402cb2 EZ |
1397 | } |
1398 | else | |
1399 | { | |
182ce2d2 EZ |
1400 | /* Fetch the character at BYTEPOS. If it is covered by a |
1401 | display string, treat the entire run of covered characters as | |
1402 | a single character u+FFFC. */ | |
36075a19 | 1403 | curchar = bidi_fetch_char (bidi_it->charpos, bidi_it->bytepos, |
0c95fcf7 | 1404 | &bidi_it->disp_pos, &bidi_it->disp_prop, |
55439c61 | 1405 | &bidi_it->string, bidi_it->frame_window_p, |
102ebb00 | 1406 | &bidi_it->ch_len, &bidi_it->nchars); |
e7402cb2 | 1407 | } |
b7b65b15 | 1408 | bidi_it->ch = curchar; |
b7b65b15 | 1409 | |
6bff6497 EZ |
1410 | /* Don't apply directional override here, as all the types we handle |
1411 | below will not be affected by the override anyway, and we need | |
1412 | the original type unaltered. The override will be applied in | |
1413 | bidi_resolve_weak. */ | |
1414 | type = bidi_get_type (curchar, NEUTRAL_DIR); | |
89d3374a EZ |
1415 | bidi_it->orig_type = type; |
1416 | bidi_check_type (bidi_it->orig_type); | |
b7b65b15 EZ |
1417 | |
1418 | if (type != PDF) | |
1419 | bidi_it->prev_was_pdf = 0; | |
1420 | ||
89d3374a | 1421 | bidi_it->type_after_w1 = UNKNOWN_BT; |
b7b65b15 EZ |
1422 | |
1423 | switch (type) | |
1424 | { | |
1425 | case RLE: /* X2 */ | |
1426 | case RLO: /* X4 */ | |
89d3374a EZ |
1427 | bidi_it->type_after_w1 = type; |
1428 | bidi_check_type (bidi_it->type_after_w1); | |
b7b65b15 | 1429 | type = WEAK_BN; /* X9/Retaining */ |
87e67904 | 1430 | if (bidi_it->ignore_bn_limit <= -1) |
b7b65b15 EZ |
1431 | { |
1432 | if (current_level <= BIDI_MAXLEVEL - 4) | |
1433 | { | |
1434 | /* Compute the least odd embedding level greater than | |
1435 | the current level. */ | |
1436 | new_level = ((current_level + 1) & ~1) + 1; | |
89d3374a | 1437 | if (bidi_it->type_after_w1 == RLE) |
b7b65b15 EZ |
1438 | override = NEUTRAL_DIR; |
1439 | else | |
1440 | override = R2L; | |
1441 | if (current_level == BIDI_MAXLEVEL - 4) | |
1442 | bidi_it->invalid_rl_levels = 0; | |
1443 | bidi_push_embedding_level (bidi_it, new_level, override); | |
1444 | } | |
1445 | else | |
1446 | { | |
1447 | bidi_it->invalid_levels++; | |
1448 | /* See the commentary about invalid_rl_levels below. */ | |
1449 | if (bidi_it->invalid_rl_levels < 0) | |
1450 | bidi_it->invalid_rl_levels = 0; | |
1451 | bidi_it->invalid_rl_levels++; | |
1452 | } | |
1453 | } | |
89d3374a | 1454 | else if (bidi_it->prev.type_after_w1 == WEAK_EN /* W5/Retaining */ |
7b5d6677 EZ |
1455 | || (bidi_it->next_en_pos > bidi_it->charpos |
1456 | && bidi_it->next_en_type == WEAK_EN)) | |
b7b65b15 EZ |
1457 | type = WEAK_EN; |
1458 | break; | |
1459 | case LRE: /* X3 */ | |
1460 | case LRO: /* X5 */ | |
89d3374a EZ |
1461 | bidi_it->type_after_w1 = type; |
1462 | bidi_check_type (bidi_it->type_after_w1); | |
b7b65b15 | 1463 | type = WEAK_BN; /* X9/Retaining */ |
87e67904 | 1464 | if (bidi_it->ignore_bn_limit <= -1) |
b7b65b15 EZ |
1465 | { |
1466 | if (current_level <= BIDI_MAXLEVEL - 5) | |
1467 | { | |
1468 | /* Compute the least even embedding level greater than | |
1469 | the current level. */ | |
1470 | new_level = ((current_level + 2) & ~1); | |
89d3374a | 1471 | if (bidi_it->type_after_w1 == LRE) |
b7b65b15 EZ |
1472 | override = NEUTRAL_DIR; |
1473 | else | |
1474 | override = L2R; | |
1475 | bidi_push_embedding_level (bidi_it, new_level, override); | |
1476 | } | |
1477 | else | |
1478 | { | |
1479 | bidi_it->invalid_levels++; | |
1480 | /* invalid_rl_levels counts invalid levels encountered | |
1481 | while the embedding level was already too high for | |
1482 | LRE/LRO, but not for RLE/RLO. That is because | |
1483 | there may be exactly one PDF which we should not | |
1484 | ignore even though invalid_levels is non-zero. | |
1485 | invalid_rl_levels helps to know what PDF is | |
1486 | that. */ | |
1487 | if (bidi_it->invalid_rl_levels >= 0) | |
1488 | bidi_it->invalid_rl_levels++; | |
1489 | } | |
1490 | } | |
89d3374a | 1491 | else if (bidi_it->prev.type_after_w1 == WEAK_EN /* W5/Retaining */ |
7b5d6677 EZ |
1492 | || (bidi_it->next_en_pos > bidi_it->charpos |
1493 | && bidi_it->next_en_type == WEAK_EN)) | |
b7b65b15 EZ |
1494 | type = WEAK_EN; |
1495 | break; | |
1496 | case PDF: /* X7 */ | |
89d3374a EZ |
1497 | bidi_it->type_after_w1 = type; |
1498 | bidi_check_type (bidi_it->type_after_w1); | |
b7b65b15 | 1499 | type = WEAK_BN; /* X9/Retaining */ |
87e67904 | 1500 | if (bidi_it->ignore_bn_limit <= -1) |
b7b65b15 EZ |
1501 | { |
1502 | if (!bidi_it->invalid_rl_levels) | |
1503 | { | |
1504 | new_level = bidi_pop_embedding_level (bidi_it); | |
1505 | bidi_it->invalid_rl_levels = -1; | |
1506 | if (bidi_it->invalid_levels) | |
1507 | bidi_it->invalid_levels--; | |
1508 | /* else nothing: UAX#9 says to ignore invalid PDFs */ | |
1509 | } | |
1510 | if (!bidi_it->invalid_levels) | |
1511 | new_level = bidi_pop_embedding_level (bidi_it); | |
1512 | else | |
1513 | { | |
1514 | bidi_it->invalid_levels--; | |
1515 | bidi_it->invalid_rl_levels--; | |
1516 | } | |
1517 | } | |
89d3374a | 1518 | else if (bidi_it->prev.type_after_w1 == WEAK_EN /* W5/Retaining */ |
7b5d6677 EZ |
1519 | || (bidi_it->next_en_pos > bidi_it->charpos |
1520 | && bidi_it->next_en_type == WEAK_EN)) | |
b7b65b15 EZ |
1521 | type = WEAK_EN; |
1522 | break; | |
1523 | default: | |
1524 | /* Nothing. */ | |
1525 | break; | |
1526 | } | |
1527 | ||
1528 | bidi_it->type = type; | |
2d6e4628 | 1529 | bidi_check_type (bidi_it->type); |
b7b65b15 EZ |
1530 | |
1531 | return new_level; | |
1532 | } | |
1533 | ||
1534 | /* Given an iterator state in BIDI_IT, advance one character position | |
182ce2d2 EZ |
1535 | in the buffer/string to the next character (in the logical order), |
1536 | resolve any explicit embeddings and directional overrides, and | |
1537 | return the embedding level of the character after resolving | |
1538 | explicit directives and ignoring empty embeddings. */ | |
b7b65b15 EZ |
1539 | static int |
1540 | bidi_resolve_explicit (struct bidi_it *bidi_it) | |
1541 | { | |
1542 | int prev_level = bidi_it->level_stack[bidi_it->stack_idx].level; | |
1543 | int new_level = bidi_resolve_explicit_1 (bidi_it); | |
d311d28c | 1544 | ptrdiff_t eob = bidi_it->string.s ? bidi_it->string.schars : ZV; |
512a289d RS |
1545 | const unsigned char *s |
1546 | = (STRINGP (bidi_it->string.lstring) | |
1547 | ? SDATA (bidi_it->string.lstring) | |
1548 | : bidi_it->string.s); | |
b7b65b15 EZ |
1549 | |
1550 | if (prev_level < new_level | |
1551 | && bidi_it->type == WEAK_BN | |
87e67904 EZ |
1552 | && bidi_it->ignore_bn_limit == -1 /* only if not already known */ |
1553 | && bidi_it->charpos < eob /* not already at EOB */ | |
1554 | && bidi_explicit_dir_char (bidi_char_at_pos (bidi_it->bytepos | |
f3014ef5 EZ |
1555 | + bidi_it->ch_len, s, |
1556 | bidi_it->string.unibyte))) | |
b7b65b15 EZ |
1557 | { |
1558 | /* Avoid pushing and popping embedding levels if the level run | |
1559 | is empty, as this breaks level runs where it shouldn't. | |
1560 | UAX#9 removes all the explicit embedding and override codes, | |
1561 | so empty embeddings disappear without a trace. We need to | |
1562 | behave as if we did the same. */ | |
1563 | struct bidi_it saved_it; | |
1564 | int level = prev_level; | |
1565 | ||
1566 | bidi_copy_it (&saved_it, bidi_it); | |
1567 | ||
87e67904 | 1568 | while (bidi_explicit_dir_char (bidi_char_at_pos (bidi_it->bytepos |
f3014ef5 EZ |
1569 | + bidi_it->ch_len, s, |
1570 | bidi_it->string.unibyte))) | |
b7b65b15 | 1571 | { |
182ce2d2 EZ |
1572 | /* This advances to the next character, skipping any |
1573 | characters covered by display strings. */ | |
b7b65b15 | 1574 | level = bidi_resolve_explicit_1 (bidi_it); |
9f257352 EZ |
1575 | /* If string.lstring was relocated inside bidi_resolve_explicit_1, |
1576 | a pointer to its data is no longer valid. */ | |
1577 | if (STRINGP (bidi_it->string.lstring)) | |
1578 | s = SDATA (bidi_it->string.lstring); | |
b7b65b15 EZ |
1579 | } |
1580 | ||
102ebb00 | 1581 | if (bidi_it->nchars <= 0) |
1088b922 | 1582 | emacs_abort (); |
b7b65b15 | 1583 | if (level == prev_level) /* empty embedding */ |
182ce2d2 | 1584 | saved_it.ignore_bn_limit = bidi_it->charpos + bidi_it->nchars; |
b7b65b15 | 1585 | else /* this embedding is non-empty */ |
87e67904 | 1586 | saved_it.ignore_bn_limit = -2; |
b7b65b15 EZ |
1587 | |
1588 | bidi_copy_it (bidi_it, &saved_it); | |
87e67904 | 1589 | if (bidi_it->ignore_bn_limit > -1) |
b7b65b15 EZ |
1590 | { |
1591 | /* We pushed a level, but we shouldn't have. Undo that. */ | |
1592 | if (!bidi_it->invalid_rl_levels) | |
1593 | { | |
1594 | new_level = bidi_pop_embedding_level (bidi_it); | |
1595 | bidi_it->invalid_rl_levels = -1; | |
1596 | if (bidi_it->invalid_levels) | |
1597 | bidi_it->invalid_levels--; | |
1598 | } | |
1599 | if (!bidi_it->invalid_levels) | |
1600 | new_level = bidi_pop_embedding_level (bidi_it); | |
1601 | else | |
1602 | { | |
1603 | bidi_it->invalid_levels--; | |
1604 | bidi_it->invalid_rl_levels--; | |
1605 | } | |
1606 | } | |
1607 | } | |
1608 | ||
b7b65b15 EZ |
1609 | if (bidi_it->type == NEUTRAL_B) /* X8 */ |
1610 | { | |
21fce5ab | 1611 | bidi_set_paragraph_end (bidi_it); |
6bff6497 EZ |
1612 | /* This is needed by bidi_resolve_weak below, and in L1. */ |
1613 | bidi_it->type_after_w1 = bidi_it->type; | |
89d3374a | 1614 | bidi_check_type (bidi_it->type_after_w1); |
b7b65b15 EZ |
1615 | } |
1616 | ||
1617 | return new_level; | |
1618 | } | |
1619 | ||
182ce2d2 EZ |
1620 | /* Advance in the buffer/string, resolve weak types and return the |
1621 | type of the next character after weak type resolution. */ | |
fd3998ff | 1622 | static bidi_type_t |
b7b65b15 EZ |
1623 | bidi_resolve_weak (struct bidi_it *bidi_it) |
1624 | { | |
1625 | bidi_type_t type; | |
1626 | bidi_dir_t override; | |
1627 | int prev_level = bidi_it->level_stack[bidi_it->stack_idx].level; | |
1628 | int new_level = bidi_resolve_explicit (bidi_it); | |
1629 | int next_char; | |
1630 | bidi_type_t type_of_next; | |
1631 | struct bidi_it saved_it; | |
5895d7b9 | 1632 | ptrdiff_t eob |
512a289d RS |
1633 | = ((STRINGP (bidi_it->string.lstring) || bidi_it->string.s) |
1634 | ? bidi_it->string.schars : ZV); | |
b7b65b15 EZ |
1635 | |
1636 | type = bidi_it->type; | |
1637 | override = bidi_it->level_stack[bidi_it->stack_idx].override; | |
1638 | ||
1639 | if (type == UNKNOWN_BT | |
1640 | || type == LRE | |
1641 | || type == LRO | |
1642 | || type == RLE | |
1643 | || type == RLO | |
1644 | || type == PDF) | |
1088b922 | 1645 | emacs_abort (); |
b7b65b15 EZ |
1646 | |
1647 | if (new_level != prev_level | |
1648 | || bidi_it->type == NEUTRAL_B) | |
1649 | { | |
1650 | /* We've got a new embedding level run, compute the directional | |
1651 | type of sor and initialize per-run variables (UAX#9, clause | |
1652 | X10). */ | |
1653 | bidi_set_sor_type (bidi_it, prev_level, new_level); | |
1654 | } | |
1655 | else if (type == NEUTRAL_S || type == NEUTRAL_WS | |
1656 | || type == WEAK_BN || type == STRONG_AL) | |
89d3374a EZ |
1657 | bidi_it->type_after_w1 = type; /* needed in L1 */ |
1658 | bidi_check_type (bidi_it->type_after_w1); | |
b7b65b15 EZ |
1659 | |
1660 | /* Level and directional override status are already recorded in | |
1661 | bidi_it, and do not need any change; see X6. */ | |
1662 | if (override == R2L) /* X6 */ | |
1663 | type = STRONG_R; | |
1664 | else if (override == L2R) | |
1665 | type = STRONG_L; | |
bc5a45f3 | 1666 | else |
b7b65b15 | 1667 | { |
bc5a45f3 | 1668 | if (type == WEAK_NSM) /* W1 */ |
b7b65b15 | 1669 | { |
bc5a45f3 | 1670 | /* Note that we don't need to consider the case where the |
5930fe97 EZ |
1671 | prev character has its type overridden by an RLO or LRO, |
1672 | because then either the type of this NSM would have been | |
1673 | also overridden, or the previous character is outside the | |
1674 | current level run, and thus not relevant to this NSM. | |
1675 | This is why NSM gets the type_after_w1 of the previous | |
1676 | character. */ | |
ebb5722e EZ |
1677 | if (bidi_it->prev.type_after_w1 != UNKNOWN_BT |
1678 | /* if type_after_w1 is NEUTRAL_B, this NSM is at sor */ | |
1679 | && bidi_it->prev.type_after_w1 != NEUTRAL_B) | |
5930fe97 | 1680 | type = bidi_it->prev.type_after_w1; |
bc5a45f3 EZ |
1681 | else if (bidi_it->sor == R2L) |
1682 | type = STRONG_R; | |
1683 | else if (bidi_it->sor == L2R) | |
1684 | type = STRONG_L; | |
1685 | else /* shouldn't happen! */ | |
1088b922 | 1686 | emacs_abort (); |
b7b65b15 | 1687 | } |
bc5a45f3 EZ |
1688 | if (type == WEAK_EN /* W2 */ |
1689 | && bidi_it->last_strong.type_after_w1 == STRONG_AL) | |
1690 | type = WEAK_AN; | |
1691 | else if (type == STRONG_AL) /* W3 */ | |
1692 | type = STRONG_R; | |
1693 | else if ((type == WEAK_ES /* W4 */ | |
1694 | && bidi_it->prev.type_after_w1 == WEAK_EN | |
1695 | && bidi_it->prev.orig_type == WEAK_EN) | |
1696 | || (type == WEAK_CS | |
1697 | && ((bidi_it->prev.type_after_w1 == WEAK_EN | |
1698 | && bidi_it->prev.orig_type == WEAK_EN) | |
1699 | || bidi_it->prev.type_after_w1 == WEAK_AN))) | |
b7b65b15 | 1700 | { |
512a289d RS |
1701 | const unsigned char *s |
1702 | = (STRINGP (bidi_it->string.lstring) | |
1703 | ? SDATA (bidi_it->string.lstring) | |
1704 | : bidi_it->string.s); | |
1705 | ||
1706 | next_char = (bidi_it->charpos + bidi_it->nchars >= eob | |
1707 | ? BIDI_EOB | |
1708 | : bidi_char_at_pos (bidi_it->bytepos + bidi_it->ch_len, | |
1709 | s, bidi_it->string.unibyte)); | |
6bff6497 | 1710 | type_of_next = bidi_get_type (next_char, override); |
b7b65b15 | 1711 | |
bc5a45f3 | 1712 | if (type_of_next == WEAK_BN |
b7b65b15 EZ |
1713 | || bidi_explicit_dir_char (next_char)) |
1714 | { | |
1715 | bidi_copy_it (&saved_it, bidi_it); | |
1716 | while (bidi_resolve_explicit (bidi_it) == new_level | |
bc5a45f3 | 1717 | && bidi_it->type == WEAK_BN) |
b7b65b15 EZ |
1718 | ; |
1719 | type_of_next = bidi_it->type; | |
b7b65b15 EZ |
1720 | bidi_copy_it (bidi_it, &saved_it); |
1721 | } | |
bc5a45f3 EZ |
1722 | |
1723 | /* If the next character is EN, but the last strong-type | |
1724 | character is AL, that next EN will be changed to AN when | |
1725 | we process it in W2 above. So in that case, this ES | |
1726 | should not be changed into EN. */ | |
1727 | if (type == WEAK_ES | |
1728 | && type_of_next == WEAK_EN | |
1729 | && bidi_it->last_strong.type_after_w1 != STRONG_AL) | |
1730 | type = WEAK_EN; | |
1731 | else if (type == WEAK_CS) | |
b7b65b15 | 1732 | { |
bc5a45f3 EZ |
1733 | if (bidi_it->prev.type_after_w1 == WEAK_AN |
1734 | && (type_of_next == WEAK_AN | |
1735 | /* If the next character is EN, but the last | |
1736 | strong-type character is AL, EN will be later | |
1737 | changed to AN when we process it in W2 above. | |
1738 | So in that case, this ES should not be | |
1739 | changed into EN. */ | |
1740 | || (type_of_next == WEAK_EN | |
1741 | && bidi_it->last_strong.type_after_w1 == STRONG_AL))) | |
1742 | type = WEAK_AN; | |
1743 | else if (bidi_it->prev.type_after_w1 == WEAK_EN | |
1744 | && type_of_next == WEAK_EN | |
1745 | && bidi_it->last_strong.type_after_w1 != STRONG_AL) | |
1746 | type = WEAK_EN; | |
1747 | } | |
1748 | } | |
1749 | else if (type == WEAK_ET /* W5: ET with EN before or after it */ | |
1750 | || type == WEAK_BN) /* W5/Retaining */ | |
1751 | { | |
7b5d6677 | 1752 | if (bidi_it->prev.type_after_w1 == WEAK_EN) /* ET/BN w/EN before it */ |
bc5a45f3 | 1753 | type = WEAK_EN; |
7b5d6677 EZ |
1754 | else if (bidi_it->next_en_pos > bidi_it->charpos |
1755 | && bidi_it->next_en_type != WEAK_BN) | |
1756 | { | |
1757 | if (bidi_it->next_en_type == WEAK_EN) /* ET/BN with EN after it */ | |
1758 | type = WEAK_EN; | |
1759 | } | |
1760 | else if (bidi_it->next_en_pos >=0) | |
bc5a45f3 | 1761 | { |
d311d28c | 1762 | ptrdiff_t en_pos = bidi_it->charpos + bidi_it->nchars; |
512a289d RS |
1763 | const unsigned char *s = (STRINGP (bidi_it->string.lstring) |
1764 | ? SDATA (bidi_it->string.lstring) | |
1765 | : bidi_it->string.s); | |
bc5a45f3 | 1766 | |
102ebb00 | 1767 | if (bidi_it->nchars <= 0) |
1088b922 | 1768 | emacs_abort (); |
512a289d RS |
1769 | next_char |
1770 | = (bidi_it->charpos + bidi_it->nchars >= eob | |
1771 | ? BIDI_EOB | |
1772 | : bidi_char_at_pos (bidi_it->bytepos + bidi_it->ch_len, s, | |
1773 | bidi_it->string.unibyte)); | |
bc5a45f3 EZ |
1774 | type_of_next = bidi_get_type (next_char, override); |
1775 | ||
1776 | if (type_of_next == WEAK_ET | |
1777 | || type_of_next == WEAK_BN | |
1778 | || bidi_explicit_dir_char (next_char)) | |
1779 | { | |
1780 | bidi_copy_it (&saved_it, bidi_it); | |
1781 | while (bidi_resolve_explicit (bidi_it) == new_level | |
1782 | && (bidi_it->type == WEAK_BN | |
1783 | || bidi_it->type == WEAK_ET)) | |
1784 | ; | |
1785 | type_of_next = bidi_it->type; | |
1786 | en_pos = bidi_it->charpos; | |
1787 | bidi_copy_it (bidi_it, &saved_it); | |
1788 | } | |
7b5d6677 EZ |
1789 | /* Remember this position, to speed up processing of the |
1790 | next ETs. */ | |
1791 | bidi_it->next_en_pos = en_pos; | |
bc5a45f3 | 1792 | if (type_of_next == WEAK_EN) |
b7b65b15 | 1793 | { |
bc5a45f3 EZ |
1794 | /* If the last strong character is AL, the EN we've |
1795 | found will become AN when we get to it (W2). */ | |
7b5d6677 EZ |
1796 | if (bidi_it->last_strong.type_after_w1 == STRONG_AL) |
1797 | type_of_next = WEAK_AN; | |
bc5a45f3 EZ |
1798 | else if (type == WEAK_BN) |
1799 | type = NEUTRAL_ON; /* W6/Retaining */ | |
7b5d6677 EZ |
1800 | else |
1801 | type = WEAK_EN; | |
b7b65b15 | 1802 | } |
4787455f EZ |
1803 | else if (type_of_next == NEUTRAL_B) |
1804 | /* Record the fact that there are no more ENs from | |
1805 | here to the end of paragraph, to avoid entering the | |
1806 | loop above ever again in this paragraph. */ | |
1807 | bidi_it->next_en_pos = -1; | |
7b5d6677 EZ |
1808 | /* Record the type of the character where we ended our search. */ |
1809 | bidi_it->next_en_type = type_of_next; | |
b7b65b15 EZ |
1810 | } |
1811 | } | |
1812 | } | |
1813 | ||
1814 | if (type == WEAK_ES || type == WEAK_ET || type == WEAK_CS /* W6 */ | |
89d3374a EZ |
1815 | || (type == WEAK_BN |
1816 | && (bidi_it->prev.type_after_w1 == WEAK_CS /* W6/Retaining */ | |
1817 | || bidi_it->prev.type_after_w1 == WEAK_ES | |
1818 | || bidi_it->prev.type_after_w1 == WEAK_ET))) | |
b7b65b15 EZ |
1819 | type = NEUTRAL_ON; |
1820 | ||
1821 | /* Store the type we've got so far, before we clobber it with strong | |
1822 | types in W7 and while resolving neutral types. But leave alone | |
1823 | the original types that were recorded above, because we will need | |
1824 | them for the L1 clause. */ | |
89d3374a EZ |
1825 | if (bidi_it->type_after_w1 == UNKNOWN_BT) |
1826 | bidi_it->type_after_w1 = type; | |
1827 | bidi_check_type (bidi_it->type_after_w1); | |
b7b65b15 EZ |
1828 | |
1829 | if (type == WEAK_EN) /* W7 */ | |
1830 | { | |
89d3374a | 1831 | if ((bidi_it->last_strong.type_after_w1 == STRONG_L) |
b7b65b15 EZ |
1832 | || (bidi_it->last_strong.type == UNKNOWN_BT && bidi_it->sor == L2R)) |
1833 | type = STRONG_L; | |
1834 | } | |
1835 | ||
1836 | bidi_it->type = type; | |
2d6e4628 | 1837 | bidi_check_type (bidi_it->type); |
b7b65b15 EZ |
1838 | return type; |
1839 | } | |
1840 | ||
cbb09f04 EZ |
1841 | /* Resolve the type of a neutral character according to the type of |
1842 | surrounding strong text and the current embedding level. */ | |
0a99eee1 | 1843 | static bidi_type_t |
cbb09f04 EZ |
1844 | bidi_resolve_neutral_1 (bidi_type_t prev_type, bidi_type_t next_type, int lev) |
1845 | { | |
1846 | /* N1: European and Arabic numbers are treated as though they were R. */ | |
1847 | if (next_type == WEAK_EN || next_type == WEAK_AN) | |
1848 | next_type = STRONG_R; | |
1849 | if (prev_type == WEAK_EN || prev_type == WEAK_AN) | |
1850 | prev_type = STRONG_R; | |
1851 | ||
1852 | if (next_type == prev_type) /* N1 */ | |
1853 | return next_type; | |
1854 | else if ((lev & 1) == 0) /* N2 */ | |
1855 | return STRONG_L; | |
1856 | else | |
1857 | return STRONG_R; | |
1858 | } | |
1859 | ||
fd3998ff | 1860 | static bidi_type_t |
b7b65b15 EZ |
1861 | bidi_resolve_neutral (struct bidi_it *bidi_it) |
1862 | { | |
1863 | int prev_level = bidi_it->level_stack[bidi_it->stack_idx].level; | |
1864 | bidi_type_t type = bidi_resolve_weak (bidi_it); | |
1865 | int current_level = bidi_it->level_stack[bidi_it->stack_idx].level; | |
1866 | ||
1867 | if (!(type == STRONG_R | |
1868 | || type == STRONG_L | |
1869 | || type == WEAK_BN | |
1870 | || type == WEAK_EN | |
1871 | || type == WEAK_AN | |
1872 | || type == NEUTRAL_B | |
1873 | || type == NEUTRAL_S | |
1874 | || type == NEUTRAL_WS | |
1875 | || type == NEUTRAL_ON)) | |
1088b922 | 1876 | emacs_abort (); |
b7b65b15 | 1877 | |
4787455f EZ |
1878 | if ((type != NEUTRAL_B /* Don't risk entering the long loop below if |
1879 | we are already at paragraph end. */ | |
1880 | && bidi_get_category (type) == NEUTRAL) | |
b7b65b15 EZ |
1881 | || (type == WEAK_BN && prev_level == current_level)) |
1882 | { | |
1883 | if (bidi_it->next_for_neutral.type != UNKNOWN_BT) | |
1884 | type = bidi_resolve_neutral_1 (bidi_it->prev_for_neutral.type, | |
1885 | bidi_it->next_for_neutral.type, | |
1886 | current_level); | |
4787455f EZ |
1887 | /* The next two "else if" clauses are shortcuts for the |
1888 | important special case when we have a long sequence of | |
1889 | neutral or WEAK_BN characters, such as whitespace or nulls or | |
1890 | other control characters, on the base embedding level of the | |
1891 | paragraph, and that sequence goes all the way to the end of | |
1892 | the paragraph and follows a character whose resolved | |
1893 | directionality is identical to the base embedding level. | |
1894 | (This is what happens in a buffer with plain L2R text that | |
1895 | happens to include long sequences of control characters.) By | |
1896 | virtue of N1, the result of examining this long sequence will | |
1897 | always be either STRONG_L or STRONG_R, depending on the base | |
1898 | embedding level. So we use this fact directly instead of | |
1899 | entering the expensive loop in the "else" clause. */ | |
1900 | else if (current_level == 0 | |
1901 | && bidi_it->prev_for_neutral.type == STRONG_L | |
1902 | && !bidi_explicit_dir_char (bidi_it->ch)) | |
1903 | type = bidi_resolve_neutral_1 (bidi_it->prev_for_neutral.type, | |
1904 | STRONG_L, current_level); | |
1905 | else if (/* current level is 1 */ | |
1906 | current_level == 1 | |
1907 | /* base embedding level is also 1 */ | |
1908 | && bidi_it->level_stack[0].level == 1 | |
1909 | /* previous character is one of those considered R for | |
1910 | the purposes of W5 */ | |
1911 | && (bidi_it->prev_for_neutral.type == STRONG_R | |
1912 | || bidi_it->prev_for_neutral.type == WEAK_EN | |
1913 | || bidi_it->prev_for_neutral.type == WEAK_AN) | |
1914 | && !bidi_explicit_dir_char (bidi_it->ch)) | |
1915 | type = bidi_resolve_neutral_1 (bidi_it->prev_for_neutral.type, | |
1916 | STRONG_R, current_level); | |
b7b65b15 EZ |
1917 | else |
1918 | { | |
1919 | /* Arrrgh!! The UAX#9 algorithm is too deeply entrenched in | |
1920 | the assumption of batch-style processing; see clauses W4, | |
1921 | W5, and especially N1, which require to look far forward | |
182ce2d2 EZ |
1922 | (as well as back) in the buffer/string. May the fleas of |
1923 | a thousand camels infest the armpits of those who design | |
b7b65b15 EZ |
1924 | supposedly general-purpose algorithms by looking at their |
1925 | own implementations, and fail to consider other possible | |
1926 | implementations! */ | |
1927 | struct bidi_it saved_it; | |
1928 | bidi_type_t next_type; | |
1929 | ||
1930 | if (bidi_it->scan_dir == -1) | |
1088b922 | 1931 | emacs_abort (); |
b7b65b15 EZ |
1932 | |
1933 | bidi_copy_it (&saved_it, bidi_it); | |
1934 | /* Scan the text forward until we find the first non-neutral | |
1935 | character, and then use that to resolve the neutral we | |
1936 | are dealing with now. We also cache the scanned iterator | |
1937 | states, to salvage some of the effort later. */ | |
1938 | bidi_cache_iterator_state (bidi_it, 0); | |
1939 | do { | |
1940 | /* Record the info about the previous character, so that | |
1941 | it will be cached below with this state. */ | |
89d3374a | 1942 | if (bidi_it->type_after_w1 != WEAK_BN /* W1/Retaining */ |
b7b65b15 EZ |
1943 | && bidi_it->type != WEAK_BN) |
1944 | bidi_remember_char (&bidi_it->prev, bidi_it); | |
1945 | type = bidi_resolve_weak (bidi_it); | |
1946 | /* Paragraph separators have their levels fully resolved | |
1947 | at this point, so cache them as resolved. */ | |
1948 | bidi_cache_iterator_state (bidi_it, type == NEUTRAL_B); | |
1949 | /* FIXME: implement L1 here, by testing for a newline and | |
1950 | resetting the level for any sequence of whitespace | |
1951 | characters adjacent to it. */ | |
1952 | } while (!(type == NEUTRAL_B | |
1953 | || (type != WEAK_BN | |
1954 | && bidi_get_category (type) != NEUTRAL) | |
1955 | /* This is all per level run, so stop when we | |
1956 | reach the end of this level run. */ | |
512a289d RS |
1957 | || (bidi_it->level_stack[bidi_it->stack_idx].level |
1958 | != current_level))); | |
b7b65b15 EZ |
1959 | |
1960 | bidi_remember_char (&saved_it.next_for_neutral, bidi_it); | |
1961 | ||
1962 | switch (type) | |
1963 | { | |
1964 | case STRONG_L: | |
1965 | case STRONG_R: | |
1966 | case STRONG_AL: | |
4787455f EZ |
1967 | /* Actually, STRONG_AL cannot happen here, because |
1968 | bidi_resolve_weak converts it to STRONG_R, per W3. */ | |
a54e2c05 | 1969 | eassert (type != STRONG_AL); |
b7b65b15 EZ |
1970 | next_type = type; |
1971 | break; | |
1972 | case WEAK_EN: | |
1973 | case WEAK_AN: | |
1974 | /* N1: ``European and Arabic numbers are treated as | |
1975 | though they were R.'' */ | |
1976 | next_type = STRONG_R; | |
b7b65b15 EZ |
1977 | break; |
1978 | case WEAK_BN: | |
713bfeaa | 1979 | case NEUTRAL_ON: /* W6/Retaining */ |
b7b65b15 | 1980 | if (!bidi_explicit_dir_char (bidi_it->ch)) |
1088b922 | 1981 | emacs_abort (); /* can't happen: BNs are skipped */ |
b7b65b15 EZ |
1982 | /* FALLTHROUGH */ |
1983 | case NEUTRAL_B: | |
1984 | /* Marched all the way to the end of this level run. | |
1985 | We need to use the eor type, whose information is | |
1986 | stored by bidi_set_sor_type in the prev_for_neutral | |
1987 | member. */ | |
1988 | if (saved_it.type != WEAK_BN | |
89d3374a | 1989 | || bidi_get_category (bidi_it->prev.type_after_w1) == NEUTRAL) |
4787455f | 1990 | next_type = bidi_it->prev_for_neutral.type; |
b7b65b15 EZ |
1991 | else |
1992 | { | |
1993 | /* This is a BN which does not adjoin neutrals. | |
1994 | Leave its type alone. */ | |
1995 | bidi_copy_it (bidi_it, &saved_it); | |
1996 | return bidi_it->type; | |
1997 | } | |
1998 | break; | |
1999 | default: | |
1088b922 | 2000 | emacs_abort (); |
b7b65b15 EZ |
2001 | } |
2002 | type = bidi_resolve_neutral_1 (saved_it.prev_for_neutral.type, | |
2003 | next_type, current_level); | |
4787455f | 2004 | saved_it.next_for_neutral.type = next_type; |
b7b65b15 | 2005 | saved_it.type = type; |
4787455f | 2006 | bidi_check_type (next_type); |
2d6e4628 | 2007 | bidi_check_type (type); |
b7b65b15 EZ |
2008 | bidi_copy_it (bidi_it, &saved_it); |
2009 | } | |
2010 | } | |
2011 | return type; | |
2012 | } | |
2013 | ||
2014 | /* Given an iterator state in BIDI_IT, advance one character position | |
182ce2d2 EZ |
2015 | in the buffer/string to the next character (in the logical order), |
2016 | resolve the bidi type of that next character, and return that | |
2017 | type. */ | |
fd3998ff | 2018 | static bidi_type_t |
b7b65b15 EZ |
2019 | bidi_type_of_next_char (struct bidi_it *bidi_it) |
2020 | { | |
2021 | bidi_type_t type; | |
2022 | ||
2023 | /* This should always be called during a forward scan. */ | |
2024 | if (bidi_it->scan_dir != 1) | |
1088b922 | 2025 | emacs_abort (); |
b7b65b15 EZ |
2026 | |
2027 | /* Reset the limit until which to ignore BNs if we step out of the | |
2028 | area where we found only empty levels. */ | |
87e67904 | 2029 | if ((bidi_it->ignore_bn_limit > -1 |
b7b65b15 | 2030 | && bidi_it->ignore_bn_limit <= bidi_it->charpos) |
87e67904 | 2031 | || (bidi_it->ignore_bn_limit == -2 |
b7b65b15 | 2032 | && !bidi_explicit_dir_char (bidi_it->ch))) |
87e67904 | 2033 | bidi_it->ignore_bn_limit = -1; |
b7b65b15 EZ |
2034 | |
2035 | type = bidi_resolve_neutral (bidi_it); | |
2036 | ||
2037 | return type; | |
2038 | } | |
2039 | ||
2040 | /* Given an iterator state BIDI_IT, advance one character position in | |
182ce2d2 EZ |
2041 | the buffer/string to the next character (in the current scan |
2042 | direction), resolve the embedding and implicit levels of that next | |
2043 | character, and return the resulting level. */ | |
fd3998ff | 2044 | static int |
b7b65b15 EZ |
2045 | bidi_level_of_next_char (struct bidi_it *bidi_it) |
2046 | { | |
2047 | bidi_type_t type; | |
2048 | int level, prev_level = -1; | |
2049 | struct bidi_saved_info next_for_neutral; | |
d311d28c | 2050 | ptrdiff_t next_char_pos = -2; |
b7b65b15 EZ |
2051 | |
2052 | if (bidi_it->scan_dir == 1) | |
2053 | { | |
5895d7b9 | 2054 | ptrdiff_t eob |
512a289d RS |
2055 | = ((bidi_it->string.s || STRINGP (bidi_it->string.lstring)) |
2056 | ? bidi_it->string.schars : ZV); | |
9f257352 | 2057 | |
b7b65b15 | 2058 | /* There's no sense in trying to advance if we hit end of text. */ |
9f257352 | 2059 | if (bidi_it->charpos >= eob) |
b7b65b15 EZ |
2060 | return bidi_it->resolved_level; |
2061 | ||
2062 | /* Record the info about the previous character. */ | |
89d3374a | 2063 | if (bidi_it->type_after_w1 != WEAK_BN /* W1/Retaining */ |
b7b65b15 EZ |
2064 | && bidi_it->type != WEAK_BN) |
2065 | bidi_remember_char (&bidi_it->prev, bidi_it); | |
89d3374a EZ |
2066 | if (bidi_it->type_after_w1 == STRONG_R |
2067 | || bidi_it->type_after_w1 == STRONG_L | |
2068 | || bidi_it->type_after_w1 == STRONG_AL) | |
b7b65b15 EZ |
2069 | bidi_remember_char (&bidi_it->last_strong, bidi_it); |
2070 | /* FIXME: it sounds like we don't need both prev and | |
2071 | prev_for_neutral members, but I'm leaving them both for now. */ | |
2072 | if (bidi_it->type == STRONG_R || bidi_it->type == STRONG_L | |
2073 | || bidi_it->type == WEAK_EN || bidi_it->type == WEAK_AN) | |
2074 | bidi_remember_char (&bidi_it->prev_for_neutral, bidi_it); | |
2075 | ||
2076 | /* If we overstepped the characters used for resolving neutrals | |
2077 | and whitespace, invalidate their info in the iterator. */ | |
2078 | if (bidi_it->charpos >= bidi_it->next_for_neutral.charpos) | |
2079 | bidi_it->next_for_neutral.type = UNKNOWN_BT; | |
2080 | if (bidi_it->next_en_pos >= 0 | |
2081 | && bidi_it->charpos >= bidi_it->next_en_pos) | |
7b5d6677 EZ |
2082 | { |
2083 | bidi_it->next_en_pos = 0; | |
2084 | bidi_it->next_en_type = UNKNOWN_BT; | |
2085 | } | |
b7b65b15 EZ |
2086 | if (bidi_it->next_for_ws.type != UNKNOWN_BT |
2087 | && bidi_it->charpos >= bidi_it->next_for_ws.charpos) | |
2088 | bidi_it->next_for_ws.type = UNKNOWN_BT; | |
2089 | ||
2090 | /* This must be taken before we fill the iterator with the info | |
2091 | about the next char. If we scan backwards, the iterator | |
2092 | state must be already cached, so there's no need to know the | |
2093 | embedding level of the previous character, since we will be | |
2094 | returning to our caller shortly. */ | |
2095 | prev_level = bidi_it->level_stack[bidi_it->stack_idx].level; | |
2096 | } | |
2097 | next_for_neutral = bidi_it->next_for_neutral; | |
2098 | ||
182ce2d2 EZ |
2099 | /* Perhaps the character we want is already cached. If it is, the |
2100 | call to bidi_cache_find below will return a type other than | |
2101 | UNKNOWN_BT. */ | |
87e67904 | 2102 | if (bidi_cache_idx > bidi_cache_start && !bidi_it->first_elt) |
102ebb00 | 2103 | { |
512a289d RS |
2104 | int bob = ((bidi_it->string.s || STRINGP (bidi_it->string.lstring)) |
2105 | ? 0 : 1); | |
102ebb00 EZ |
2106 | if (bidi_it->scan_dir > 0) |
2107 | { | |
2108 | if (bidi_it->nchars <= 0) | |
1088b922 | 2109 | emacs_abort (); |
102ebb00 EZ |
2110 | next_char_pos = bidi_it->charpos + bidi_it->nchars; |
2111 | } | |
9f257352 | 2112 | else if (bidi_it->charpos >= bob) |
bb269206 EZ |
2113 | /* Implementation note: we allow next_char_pos to be as low as |
2114 | 0 for buffers or -1 for strings, and that is okay because | |
2115 | that's the "position" of the sentinel iterator state we | |
2116 | cached at the beginning of the iteration. */ | |
102ebb00 | 2117 | next_char_pos = bidi_it->charpos - 1; |
578b494e | 2118 | if (next_char_pos >= bob - 1) |
87e67904 EZ |
2119 | type = bidi_cache_find (next_char_pos, -1, bidi_it); |
2120 | else | |
2121 | type = UNKNOWN_BT; | |
102ebb00 | 2122 | } |
182ce2d2 | 2123 | else |
102ebb00 | 2124 | type = UNKNOWN_BT; |
b7b65b15 EZ |
2125 | if (type != UNKNOWN_BT) |
2126 | { | |
2127 | /* Don't lose the information for resolving neutrals! The | |
2128 | cached states could have been cached before their | |
2129 | next_for_neutral member was computed. If we are on our way | |
2130 | forward, we can simply take the info from the previous | |
2131 | state. */ | |
2132 | if (bidi_it->scan_dir == 1 | |
2133 | && bidi_it->next_for_neutral.type == UNKNOWN_BT) | |
2134 | bidi_it->next_for_neutral = next_for_neutral; | |
2135 | ||
2136 | /* If resolved_level is -1, it means this state was cached | |
2137 | before it was completely resolved, so we cannot return | |
2138 | it. */ | |
2139 | if (bidi_it->resolved_level != -1) | |
2140 | return bidi_it->resolved_level; | |
2141 | } | |
2142 | if (bidi_it->scan_dir == -1) | |
2143 | /* If we are going backwards, the iterator state is already cached | |
2144 | from previous scans, and should be fully resolved. */ | |
1088b922 | 2145 | emacs_abort (); |
b7b65b15 EZ |
2146 | |
2147 | if (type == UNKNOWN_BT) | |
2148 | type = bidi_type_of_next_char (bidi_it); | |
2149 | ||
2150 | if (type == NEUTRAL_B) | |
2151 | return bidi_it->resolved_level; | |
2152 | ||
2153 | level = bidi_it->level_stack[bidi_it->stack_idx].level; | |
2154 | if ((bidi_get_category (type) == NEUTRAL /* && type != NEUTRAL_B */) | |
2155 | || (type == WEAK_BN && prev_level == level)) | |
2156 | { | |
2157 | if (bidi_it->next_for_neutral.type == UNKNOWN_BT) | |
1088b922 | 2158 | emacs_abort (); |
b7b65b15 EZ |
2159 | |
2160 | /* If the cached state shows a neutral character, it was not | |
2161 | resolved by bidi_resolve_neutral, so do it now. */ | |
2162 | type = bidi_resolve_neutral_1 (bidi_it->prev_for_neutral.type, | |
2163 | bidi_it->next_for_neutral.type, | |
2164 | level); | |
2165 | } | |
2166 | ||
2167 | if (!(type == STRONG_R | |
2168 | || type == STRONG_L | |
2169 | || type == WEAK_BN | |
2170 | || type == WEAK_EN | |
2171 | || type == WEAK_AN)) | |
1088b922 | 2172 | emacs_abort (); |
b7b65b15 | 2173 | bidi_it->type = type; |
2d6e4628 | 2174 | bidi_check_type (bidi_it->type); |
b7b65b15 EZ |
2175 | |
2176 | /* For L1 below, we need to know, for each WS character, whether | |
0d327994 | 2177 | it belongs to a sequence of WS characters preceding a newline |
b7b65b15 | 2178 | or a TAB or a paragraph separator. */ |
89d3374a | 2179 | if (bidi_it->orig_type == NEUTRAL_WS |
b7b65b15 EZ |
2180 | && bidi_it->next_for_ws.type == UNKNOWN_BT) |
2181 | { | |
2182 | int ch; | |
d311d28c PE |
2183 | ptrdiff_t clen = bidi_it->ch_len; |
2184 | ptrdiff_t bpos = bidi_it->bytepos; | |
2185 | ptrdiff_t cpos = bidi_it->charpos; | |
2186 | ptrdiff_t disp_pos = bidi_it->disp_pos; | |
2187 | ptrdiff_t nc = bidi_it->nchars; | |
87e67904 | 2188 | struct bidi_string_data bs = bidi_it->string; |
b7b65b15 | 2189 | bidi_type_t chtype; |
2cc21167 | 2190 | bool fwp = bidi_it->frame_window_p; |
0c95fcf7 | 2191 | int dpp = bidi_it->disp_prop; |
b7b65b15 | 2192 | |
102ebb00 | 2193 | if (bidi_it->nchars <= 0) |
1088b922 | 2194 | emacs_abort (); |
b7b65b15 | 2195 | do { |
36075a19 | 2196 | ch = bidi_fetch_char (cpos += nc, bpos += clen, &disp_pos, &dpp, &bs, |
55439c61 | 2197 | fwp, &clen, &nc); |
79beb178 | 2198 | if (ch == '\n' || ch == BIDI_EOB) |
b7b65b15 EZ |
2199 | chtype = NEUTRAL_B; |
2200 | else | |
6bff6497 | 2201 | chtype = bidi_get_type (ch, NEUTRAL_DIR); |
b7b65b15 EZ |
2202 | } while (chtype == NEUTRAL_WS || chtype == WEAK_BN |
2203 | || bidi_explicit_dir_char (ch)); /* L1/Retaining */ | |
2204 | bidi_it->next_for_ws.type = chtype; | |
2d6e4628 | 2205 | bidi_check_type (bidi_it->next_for_ws.type); |
b7b65b15 EZ |
2206 | bidi_it->next_for_ws.charpos = cpos; |
2207 | bidi_it->next_for_ws.bytepos = bpos; | |
2208 | } | |
2209 | ||
2210 | /* Resolve implicit levels, with a twist: PDFs get the embedding | |
55622b93 | 2211 | level of the embedding they terminate. See below for the |
b7b65b15 | 2212 | reason. */ |
89d3374a | 2213 | if (bidi_it->orig_type == PDF |
b7b65b15 EZ |
2214 | /* Don't do this if this formatting code didn't change the |
2215 | embedding level due to invalid or empty embeddings. */ | |
2216 | && prev_level != level) | |
2217 | { | |
2218 | /* Don't look in UAX#9 for the reason for this: it's our own | |
2219 | private quirk. The reason is that we want the formatting | |
2220 | codes to be delivered so that they bracket the text of their | |
2221 | embedding. For example, given the text | |
2222 | ||
2223 | {RLO}teST{PDF} | |
2224 | ||
2225 | we want it to be displayed as | |
2226 | ||
0d68907d | 2227 | {PDF}STet{RLO} |
b7b65b15 EZ |
2228 | |
2229 | not as | |
2230 | ||
2231 | STet{RLO}{PDF} | |
2232 | ||
2233 | which will result because we bump up the embedding level as | |
2234 | soon as we see the RLO and pop it as soon as we see the PDF, | |
2235 | so RLO itself has the same embedding level as "teST", and | |
2236 | thus would be normally delivered last, just before the PDF. | |
2237 | The switch below fiddles with the level of PDF so that this | |
2238 | ugly side effect does not happen. | |
2239 | ||
2240 | (This is, of course, only important if the formatting codes | |
e7402cb2 EZ |
2241 | are actually displayed, but Emacs does need to display them |
2242 | if the user wants to.) */ | |
b7b65b15 EZ |
2243 | level = prev_level; |
2244 | } | |
89d3374a EZ |
2245 | else if (bidi_it->orig_type == NEUTRAL_B /* L1 */ |
2246 | || bidi_it->orig_type == NEUTRAL_S | |
e7402cb2 | 2247 | || bidi_it->ch == '\n' || bidi_it->ch == BIDI_EOB |
89d3374a | 2248 | || (bidi_it->orig_type == NEUTRAL_WS |
b7b65b15 EZ |
2249 | && (bidi_it->next_for_ws.type == NEUTRAL_B |
2250 | || bidi_it->next_for_ws.type == NEUTRAL_S))) | |
2251 | level = bidi_it->level_stack[0].level; | |
2252 | else if ((level & 1) == 0) /* I1 */ | |
2253 | { | |
2254 | if (type == STRONG_R) | |
2255 | level++; | |
2256 | else if (type == WEAK_EN || type == WEAK_AN) | |
2257 | level += 2; | |
2258 | } | |
2259 | else /* I2 */ | |
2260 | { | |
2261 | if (type == STRONG_L || type == WEAK_EN || type == WEAK_AN) | |
2262 | level++; | |
2263 | } | |
2264 | ||
2265 | bidi_it->resolved_level = level; | |
2266 | return level; | |
2267 | } | |
2268 | ||
2cc21167 PE |
2269 | /* Move to the other edge of a level given by LEVEL. If END_FLAG, |
2270 | we are at the end of a level, and we need to prepare to | |
b7b65b15 EZ |
2271 | resume the scan of the lower level. |
2272 | ||
2273 | If this level's other edge is cached, we simply jump to it, filling | |
2274 | the iterator structure with the iterator state on the other edge. | |
182ce2d2 EZ |
2275 | Otherwise, we walk the buffer or string until we come back to the |
2276 | same level as LEVEL. | |
b7b65b15 EZ |
2277 | |
2278 | Note: we are not talking here about a ``level run'' in the UAX#9 | |
2279 | sense of the term, but rather about a ``level'' which includes | |
2280 | all the levels higher than it. In other words, given the levels | |
2281 | like this: | |
2282 | ||
2283 | 11111112222222333333334443343222222111111112223322111 | |
2284 | A B C | |
2285 | ||
2286 | and assuming we are at point A scanning left to right, this | |
2287 | function moves to point C, whereas the UAX#9 ``level 2 run'' ends | |
2288 | at point B. */ | |
2289 | static void | |
2cc21167 | 2290 | bidi_find_other_level_edge (struct bidi_it *bidi_it, int level, bool end_flag) |
b7b65b15 EZ |
2291 | { |
2292 | int dir = end_flag ? -bidi_it->scan_dir : bidi_it->scan_dir; | |
39e378da | 2293 | ptrdiff_t idx; |
b7b65b15 EZ |
2294 | |
2295 | /* Try the cache first. */ | |
87e67904 EZ |
2296 | if ((idx = bidi_cache_find_level_change (level, dir, end_flag)) |
2297 | >= bidi_cache_start) | |
b7b65b15 EZ |
2298 | bidi_cache_fetch_state (idx, bidi_it); |
2299 | else | |
2300 | { | |
2301 | int new_level; | |
2302 | ||
1088b922 | 2303 | /* If we are at end of level, its edges must be cached. */ |
b7b65b15 | 2304 | if (end_flag) |
1088b922 | 2305 | emacs_abort (); |
b7b65b15 EZ |
2306 | |
2307 | bidi_cache_iterator_state (bidi_it, 1); | |
2308 | do { | |
2309 | new_level = bidi_level_of_next_char (bidi_it); | |
2310 | bidi_cache_iterator_state (bidi_it, 1); | |
2311 | } while (new_level >= level); | |
2312 | } | |
2313 | } | |
2314 | ||
2315 | void | |
4b292a22 | 2316 | bidi_move_to_visually_next (struct bidi_it *bidi_it) |
b7b65b15 EZ |
2317 | { |
2318 | int old_level, new_level, next_level; | |
9c82e145 | 2319 | struct bidi_it sentinel; |
acb28818 | 2320 | struct gcpro gcpro1; |
b7b65b15 | 2321 | |
87e67904 | 2322 | if (bidi_it->charpos < 0 || bidi_it->bytepos < 0) |
1088b922 | 2323 | emacs_abort (); |
b7b65b15 EZ |
2324 | |
2325 | if (bidi_it->scan_dir == 0) | |
2326 | { | |
2327 | bidi_it->scan_dir = 1; /* default to logical order */ | |
2328 | } | |
2329 | ||
acb28818 | 2330 | /* The code below can call eval, and thus cause GC. If we are |
7e2ad32c | 2331 | iterating a Lisp string, make sure it won't be GCed. */ |
acb28818 EZ |
2332 | if (STRINGP (bidi_it->string.lstring)) |
2333 | GCPRO1 (bidi_it->string.lstring); | |
2334 | ||
be39f003 | 2335 | /* If we just passed a newline, initialize for the next line. */ |
1137e8b8 EZ |
2336 | if (!bidi_it->first_elt |
2337 | && (bidi_it->ch == '\n' || bidi_it->ch == BIDI_EOB)) | |
be39f003 EZ |
2338 | bidi_line_init (bidi_it); |
2339 | ||
6dcfd253 EZ |
2340 | /* Prepare the sentinel iterator state, and cache it. When we bump |
2341 | into it, scanning backwards, we'll know that the last non-base | |
2342 | level is exhausted. */ | |
87e67904 | 2343 | if (bidi_cache_idx == bidi_cache_start) |
9c82e145 EZ |
2344 | { |
2345 | bidi_copy_it (&sentinel, bidi_it); | |
2346 | if (bidi_it->first_elt) | |
2347 | { | |
2348 | sentinel.charpos--; /* cached charpos needs to be monotonic */ | |
2349 | sentinel.bytepos--; | |
2350 | sentinel.ch = '\n'; /* doesn't matter, but why not? */ | |
2351 | sentinel.ch_len = 1; | |
182ce2d2 | 2352 | sentinel.nchars = 1; |
9c82e145 | 2353 | } |
6dcfd253 | 2354 | bidi_cache_iterator_state (&sentinel, 1); |
9c82e145 | 2355 | } |
b7b65b15 EZ |
2356 | |
2357 | old_level = bidi_it->resolved_level; | |
2358 | new_level = bidi_level_of_next_char (bidi_it); | |
b7b65b15 EZ |
2359 | |
2360 | /* Reordering of resolved levels (clause L2) is implemented by | |
2361 | jumping to the other edge of the level and flipping direction of | |
c0546589 | 2362 | scanning the text whenever we find a level change. */ |
b7b65b15 EZ |
2363 | if (new_level != old_level) |
2364 | { | |
2cc21167 | 2365 | bool ascending = new_level > old_level; |
b7b65b15 EZ |
2366 | int level_to_search = ascending ? old_level + 1 : old_level; |
2367 | int incr = ascending ? 1 : -1; | |
2368 | int expected_next_level = old_level + incr; | |
2369 | ||
b7b65b15 EZ |
2370 | /* Jump (or walk) to the other edge of this level. */ |
2371 | bidi_find_other_level_edge (bidi_it, level_to_search, !ascending); | |
2372 | /* Switch scan direction and peek at the next character in the | |
2373 | new direction. */ | |
2374 | bidi_it->scan_dir = -bidi_it->scan_dir; | |
2375 | ||
2376 | /* The following loop handles the case where the resolved level | |
2377 | jumps by more than one. This is typical for numbers inside a | |
2378 | run of text with left-to-right embedding direction, but can | |
2379 | also happen in other situations. In those cases the decision | |
2380 | where to continue after a level change, and in what direction, | |
2381 | is tricky. For example, given a text like below: | |
2382 | ||
2383 | abcdefgh | |
2384 | 11336622 | |
2385 | ||
2386 | (where the numbers below the text show the resolved levels), | |
2387 | the result of reordering according to UAX#9 should be this: | |
2388 | ||
2389 | efdcghba | |
2390 | ||
2391 | This is implemented by the loop below which flips direction | |
2392 | and jumps to the other edge of the level each time it finds | |
2393 | the new level not to be the expected one. The expected level | |
2394 | is always one more or one less than the previous one. */ | |
2395 | next_level = bidi_peek_at_next_level (bidi_it); | |
2396 | while (next_level != expected_next_level) | |
2397 | { | |
713bfeaa EZ |
2398 | /* If next_level is -1, it means we have an unresolved level |
2399 | in the cache, which at this point should not happen. If | |
2400 | it does, we will infloop. */ | |
2401 | eassert (next_level >= 0); | |
b7b65b15 EZ |
2402 | expected_next_level += incr; |
2403 | level_to_search += incr; | |
2404 | bidi_find_other_level_edge (bidi_it, level_to_search, !ascending); | |
2405 | bidi_it->scan_dir = -bidi_it->scan_dir; | |
2406 | next_level = bidi_peek_at_next_level (bidi_it); | |
2407 | } | |
2408 | ||
2409 | /* Finally, deliver the next character in the new direction. */ | |
2410 | next_level = bidi_level_of_next_char (bidi_it); | |
2411 | } | |
2412 | ||
b44d9321 EZ |
2413 | /* Take note when we have just processed the newline that precedes |
2414 | the end of the paragraph. The next time we are about to be | |
2415 | called, set_iterator_to_next will automatically reinit the | |
2416 | paragraph direction, if needed. We do this at the newline before | |
2417 | the paragraph separator, because the next character might not be | |
2418 | the first character of the next paragraph, due to the bidi | |
c0546589 EZ |
2419 | reordering, whereas we _must_ know the paragraph base direction |
2420 | _before_ we process the paragraph's text, since the base | |
2421 | direction affects the reordering. */ | |
1137e8b8 EZ |
2422 | if (bidi_it->scan_dir == 1 |
2423 | && (bidi_it->ch == '\n' || bidi_it->ch == BIDI_EOB)) | |
be39f003 | 2424 | { |
87e67904 EZ |
2425 | /* The paragraph direction of the entire string, once |
2426 | determined, is in effect for the entire string. Setting the | |
2427 | separator limit to the end of the string prevents | |
2428 | bidi_paragraph_init from being called automatically on this | |
2429 | string. */ | |
9f257352 | 2430 | if (bidi_it->string.s || STRINGP (bidi_it->string.lstring)) |
87e67904 EZ |
2431 | bidi_it->separator_limit = bidi_it->string.schars; |
2432 | else if (bidi_it->bytepos < ZV_BYTE) | |
be39f003 | 2433 | { |
5895d7b9 | 2434 | ptrdiff_t sep_len |
512a289d RS |
2435 | = bidi_at_paragraph_end (bidi_it->charpos + bidi_it->nchars, |
2436 | bidi_it->bytepos + bidi_it->ch_len); | |
87e67904 | 2437 | if (bidi_it->nchars <= 0) |
1088b922 | 2438 | emacs_abort (); |
87e67904 EZ |
2439 | if (sep_len >= 0) |
2440 | { | |
2441 | bidi_it->new_paragraph = 1; | |
2442 | /* Record the buffer position of the last character of the | |
2443 | paragraph separator. */ | |
512a289d RS |
2444 | bidi_it->separator_limit |
2445 | = bidi_it->charpos + bidi_it->nchars + sep_len; | |
87e67904 | 2446 | } |
be39f003 EZ |
2447 | } |
2448 | } | |
6bff6497 | 2449 | |
87e67904 | 2450 | if (bidi_it->scan_dir == 1 && bidi_cache_idx > bidi_cache_start) |
b7b65b15 EZ |
2451 | { |
2452 | /* If we are at paragraph's base embedding level and beyond the | |
2453 | last cached position, the cache's job is done and we can | |
2454 | discard it. */ | |
2455 | if (bidi_it->resolved_level == bidi_it->level_stack[0].level | |
182ce2d2 EZ |
2456 | && bidi_it->charpos > (bidi_cache[bidi_cache_idx - 1].charpos |
2457 | + bidi_cache[bidi_cache_idx - 1].nchars - 1)) | |
b7b65b15 EZ |
2458 | bidi_cache_reset (); |
2459 | /* But as long as we are caching during forward scan, we must | |
2460 | cache each state, or else the cache integrity will be | |
2461 | compromised: it assumes cached states correspond to buffer | |
2462 | positions 1:1. */ | |
2463 | else | |
2464 | bidi_cache_iterator_state (bidi_it, 1); | |
2465 | } | |
acb28818 EZ |
2466 | |
2467 | if (STRINGP (bidi_it->string.lstring)) | |
2468 | UNGCPRO; | |
b7b65b15 EZ |
2469 | } |
2470 | ||
2471 | /* This is meant to be called from within the debugger, whenever you | |
2472 | wish to examine the cache contents. */ | |
e78aecca | 2473 | void bidi_dump_cached_states (void) EXTERNALLY_VISIBLE; |
b7b65b15 EZ |
2474 | void |
2475 | bidi_dump_cached_states (void) | |
2476 | { | |
39e378da | 2477 | ptrdiff_t i; |
b7b65b15 EZ |
2478 | int ndigits = 1; |
2479 | ||
2480 | if (bidi_cache_idx == 0) | |
2481 | { | |
2482 | fprintf (stderr, "The cache is empty.\n"); | |
2483 | return; | |
2484 | } | |
df9733bf | 2485 | fprintf (stderr, "Total of %"pD"d state%s in cache:\n", |
b7b65b15 EZ |
2486 | bidi_cache_idx, bidi_cache_idx == 1 ? "" : "s"); |
2487 | ||
2488 | for (i = bidi_cache[bidi_cache_idx - 1].charpos; i > 0; i /= 10) | |
2489 | ndigits++; | |
2490 | fputs ("ch ", stderr); | |
2491 | for (i = 0; i < bidi_cache_idx; i++) | |
2492 | fprintf (stderr, "%*c", ndigits, bidi_cache[i].ch); | |
2493 | fputs ("\n", stderr); | |
2494 | fputs ("lvl ", stderr); | |
2495 | for (i = 0; i < bidi_cache_idx; i++) | |
2496 | fprintf (stderr, "%*d", ndigits, bidi_cache[i].resolved_level); | |
2497 | fputs ("\n", stderr); | |
2498 | fputs ("pos ", stderr); | |
2499 | for (i = 0; i < bidi_cache_idx; i++) | |
7c85f529 | 2500 | fprintf (stderr, "%*"pD"d", ndigits, bidi_cache[i].charpos); |
b7b65b15 EZ |
2501 | fputs ("\n", stderr); |
2502 | } |