Mercurial > hg > xemacs-beta
annotate src/rangetab.c @ 4742:4cf435fcebbc
Make #'letf not error if handed a #'values form.
lisp/ChangeLog addition:
2009-11-14 Aidan Kehoe <kehoea@parhasard.net>
* cl-macs.el (letf):
Check whether arguments to #'values are bound, and make them
unbound after evaluating BODY; document the limitations of this
macro.
tests/ChangeLog addition:
2009-11-14 Aidan Kehoe <kehoea@parhasard.net>
* automated/lisp-tests.el:
Don't call Known-Bug-Expect-Failure now that the particular letf
bug it tickled is fixed.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sat, 14 Nov 2009 11:43:09 +0000 |
| parents | 312503644bc3 |
| children | 2e15c29cc2b3 e0db3c197671 |
| rev | line source |
|---|---|
| 428 | 1 /* XEmacs routines to deal with range tables. |
| 2 Copyright (C) 1995 Sun Microsystems, Inc. | |
| 2952 | 3 Copyright (C) 1995, 2002, 2004, 2005 Ben Wing. |
| 428 | 4 |
| 5 This file is part of XEmacs. | |
| 6 | |
| 7 XEmacs is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 9 Free Software Foundation; either version 2, or (at your option) any | |
| 10 later version. | |
| 11 | |
| 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 18 along with XEmacs; see the file COPYING. If not, write to | |
| 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 20 Boston, MA 02111-1307, USA. */ | |
| 21 | |
| 22 /* Synched up with: Not in FSF. */ | |
| 23 | |
| 24 /* Written by Ben Wing, August 1995. */ | |
| 25 | |
| 26 #include <config.h> | |
| 27 #include "lisp.h" | |
| 28 #include "rangetab.h" | |
| 29 | |
| 30 Lisp_Object Qrange_tablep; | |
| 31 Lisp_Object Qrange_table; | |
| 32 | |
| 2421 | 33 Lisp_Object Qstart_closed_end_open; |
| 34 Lisp_Object Qstart_open_end_open; | |
| 35 Lisp_Object Qstart_closed_end_closed; | |
| 36 Lisp_Object Qstart_open_end_closed; | |
| 37 | |
| 428 | 38 |
| 39 /************************************************************************/ | |
| 40 /* Range table object */ | |
| 41 /************************************************************************/ | |
| 42 | |
| 2421 | 43 static enum range_table_type |
| 44 range_table_symbol_to_type (Lisp_Object symbol) | |
| 45 { | |
| 46 if (NILP (symbol)) | |
| 47 return RANGE_START_CLOSED_END_OPEN; | |
| 48 | |
| 49 CHECK_SYMBOL (symbol); | |
| 50 if (EQ (symbol, Qstart_closed_end_open)) | |
| 51 return RANGE_START_CLOSED_END_OPEN; | |
| 52 if (EQ (symbol, Qstart_closed_end_closed)) | |
| 53 return RANGE_START_CLOSED_END_CLOSED; | |
| 54 if (EQ (symbol, Qstart_open_end_open)) | |
| 55 return RANGE_START_OPEN_END_OPEN; | |
| 56 if (EQ (symbol, Qstart_open_end_closed)) | |
| 57 return RANGE_START_OPEN_END_CLOSED; | |
| 58 | |
| 59 invalid_constant ("Unknown range table type", symbol); | |
| 60 RETURN_NOT_REACHED (RANGE_START_CLOSED_END_OPEN); | |
| 61 } | |
| 62 | |
| 63 static Lisp_Object | |
| 64 range_table_type_to_symbol (enum range_table_type type) | |
| 65 { | |
| 66 switch (type) | |
| 67 { | |
| 68 case RANGE_START_CLOSED_END_OPEN: | |
| 69 return Qstart_closed_end_open; | |
| 70 case RANGE_START_CLOSED_END_CLOSED: | |
| 71 return Qstart_closed_end_closed; | |
| 72 case RANGE_START_OPEN_END_OPEN: | |
| 73 return Qstart_open_end_open; | |
| 74 case RANGE_START_OPEN_END_CLOSED: | |
| 75 return Qstart_open_end_closed; | |
| 76 } | |
| 77 | |
| 2500 | 78 ABORT (); |
| 2421 | 79 return Qnil; |
| 80 } | |
| 81 | |
| 428 | 82 /* We use a sorted array of ranges. |
| 83 | |
| 84 #### We should be using the gap array stuff from extents.c. This | |
| 85 is not hard but just requires moving that stuff out of that file. */ | |
| 86 | |
| 87 static Lisp_Object | |
| 88 mark_range_table (Lisp_Object obj) | |
| 89 { | |
| 440 | 90 Lisp_Range_Table *rt = XRANGE_TABLE (obj); |
| 428 | 91 int i; |
| 92 | |
| 93 for (i = 0; i < Dynarr_length (rt->entries); i++) | |
| 94 mark_object (Dynarr_at (rt->entries, i).val); | |
|
4690
257b468bf2ca
Move the #'query-coding-region implementation to C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4391
diff
changeset
|
95 |
| 428 | 96 return Qnil; |
| 97 } | |
| 98 | |
| 99 static void | |
| 2286 | 100 print_range_table (Lisp_Object obj, Lisp_Object printcharfun, |
| 101 int UNUSED (escapeflag)) | |
| 428 | 102 { |
| 440 | 103 Lisp_Range_Table *rt = XRANGE_TABLE (obj); |
| 428 | 104 int i; |
| 105 | |
| 2421 | 106 if (print_readably) |
| 107 write_fmt_string_lisp (printcharfun, "#s(range-table type %s data (", | |
| 108 1, range_table_type_to_symbol (rt->type)); | |
| 109 else | |
| 110 write_c_string (printcharfun, "#<range-table "); | |
| 428 | 111 for (i = 0; i < Dynarr_length (rt->entries); i++) |
| 112 { | |
| 113 struct range_table_entry *rte = Dynarr_atp (rt->entries, i); | |
| 2421 | 114 int so, ec; |
| 428 | 115 if (i > 0) |
| 826 | 116 write_c_string (printcharfun, " "); |
| 2421 | 117 switch (rt->type) |
| 118 { | |
| 119 case RANGE_START_CLOSED_END_OPEN: so = 0, ec = 0; break; | |
| 120 case RANGE_START_CLOSED_END_CLOSED: so = 0, ec = 1; break; | |
| 121 case RANGE_START_OPEN_END_OPEN: so = 1, ec = 0; break; | |
| 122 case RANGE_START_OPEN_END_CLOSED: so = 1; ec = 1; break; | |
| 2500 | 123 default: ABORT (); so = 0, ec = 0; break; |
| 2421 | 124 } |
| 125 write_fmt_string (printcharfun, "%c%ld %ld%c ", | |
| 126 print_readably ? '(' : so ? '(' : '[', | |
| 127 (long) (rte->first - so), | |
| 128 (long) (rte->last - ec), | |
| 129 print_readably ? ')' : ec ? ']' : ')' | |
| 130 ); | |
| 428 | 131 print_internal (rte->val, printcharfun, 1); |
| 132 } | |
| 2421 | 133 if (print_readably) |
| 134 write_c_string (printcharfun, "))"); | |
| 135 else | |
| 136 write_fmt_string (printcharfun, " 0x%x>", rt->header.uid); | |
| 428 | 137 } |
| 138 | |
| 139 static int | |
| 140 range_table_equal (Lisp_Object obj1, Lisp_Object obj2, int depth) | |
| 141 { | |
| 440 | 142 Lisp_Range_Table *rt1 = XRANGE_TABLE (obj1); |
| 143 Lisp_Range_Table *rt2 = XRANGE_TABLE (obj2); | |
| 428 | 144 int i; |
| 145 | |
| 146 if (Dynarr_length (rt1->entries) != Dynarr_length (rt2->entries)) | |
| 147 return 0; | |
| 148 | |
| 149 for (i = 0; i < Dynarr_length (rt1->entries); i++) | |
| 150 { | |
| 151 struct range_table_entry *rte1 = Dynarr_atp (rt1->entries, i); | |
| 152 struct range_table_entry *rte2 = Dynarr_atp (rt2->entries, i); | |
| 153 | |
| 154 if (rte1->first != rte2->first | |
| 155 || rte1->last != rte2->last | |
| 156 || !internal_equal (rte1->val, rte2->val, depth + 1)) | |
| 157 return 0; | |
| 158 } | |
| 159 | |
| 160 return 1; | |
| 161 } | |
| 162 | |
| 2515 | 163 static Hashcode |
| 428 | 164 range_table_entry_hash (struct range_table_entry *rte, int depth) |
| 165 { | |
| 166 return HASH3 (rte->first, rte->last, internal_hash (rte->val, depth + 1)); | |
| 167 } | |
| 168 | |
| 2515 | 169 static Hashcode |
| 428 | 170 range_table_hash (Lisp_Object obj, int depth) |
| 171 { | |
| 440 | 172 Lisp_Range_Table *rt = XRANGE_TABLE (obj); |
| 428 | 173 int i; |
| 174 int size = Dynarr_length (rt->entries); | |
| 2515 | 175 Hashcode hash = size; |
| 428 | 176 |
| 177 /* approach based on internal_array_hash(). */ | |
| 178 if (size <= 5) | |
| 179 { | |
| 180 for (i = 0; i < size; i++) | |
| 181 hash = HASH2 (hash, | |
| 182 range_table_entry_hash (Dynarr_atp (rt->entries, i), | |
| 183 depth)); | |
| 184 return hash; | |
| 185 } | |
| 186 | |
| 187 /* just pick five elements scattered throughout the array. | |
| 188 A slightly better approach would be to offset by some | |
| 189 noise factor from the points chosen below. */ | |
| 190 for (i = 0; i < 5; i++) | |
| 191 hash = HASH2 (hash, range_table_entry_hash (Dynarr_atp (rt->entries, | |
| 192 i*size/5), | |
| 193 depth)); | |
| 194 return hash; | |
| 195 } | |
| 196 | |
| 1204 | 197 static const struct memory_description rte_description_1[] = { |
| 440 | 198 { XD_LISP_OBJECT, offsetof (range_table_entry, val) }, |
| 428 | 199 { XD_END } |
| 200 }; | |
| 201 | |
| 1204 | 202 static const struct sized_memory_description rte_description = { |
| 440 | 203 sizeof (range_table_entry), |
| 428 | 204 rte_description_1 |
| 205 }; | |
| 206 | |
| 1204 | 207 static const struct memory_description rted_description_1[] = { |
| 440 | 208 XD_DYNARR_DESC (range_table_entry_dynarr, &rte_description), |
| 428 | 209 { XD_END } |
| 210 }; | |
| 211 | |
| 1204 | 212 static const struct sized_memory_description rted_description = { |
| 440 | 213 sizeof (range_table_entry_dynarr), |
| 428 | 214 rted_description_1 |
| 215 }; | |
| 216 | |
| 1204 | 217 static const struct memory_description range_table_description[] = { |
| 2551 | 218 { XD_BLOCK_PTR, offsetof (Lisp_Range_Table, entries), 1, |
| 219 { &rted_description } }, | |
| 428 | 220 { XD_END } |
| 221 }; | |
| 222 | |
| 934 | 223 DEFINE_LRECORD_IMPLEMENTATION ("range-table", range_table, |
| 224 1, /*dumpable-flag*/ | |
| 225 mark_range_table, print_range_table, 0, | |
| 226 range_table_equal, range_table_hash, | |
| 227 range_table_description, | |
| 228 Lisp_Range_Table); | |
| 428 | 229 |
| 230 /************************************************************************/ | |
| 231 /* Range table operations */ | |
| 232 /************************************************************************/ | |
| 233 | |
| 800 | 234 #ifdef ERROR_CHECK_STRUCTURES |
| 428 | 235 |
| 236 static void | |
| 440 | 237 verify_range_table (Lisp_Range_Table *rt) |
| 428 | 238 { |
| 239 int i; | |
| 240 | |
| 241 for (i = 0; i < Dynarr_length (rt->entries); i++) | |
| 242 { | |
| 243 struct range_table_entry *rte = Dynarr_atp (rt->entries, i); | |
| 244 assert (rte->last >= rte->first); | |
| 245 if (i > 0) | |
| 2421 | 246 assert (Dynarr_at (rt->entries, i - 1).last <= rte->first); |
| 428 | 247 } |
| 248 } | |
| 249 | |
| 250 #else | |
| 251 | |
| 252 #define verify_range_table(rt) | |
| 253 | |
| 254 #endif | |
| 255 | |
| 256 /* Look up in a range table without the Dynarr wrapper. | |
| 257 Used also by the unified range table format. */ | |
| 258 | |
| 259 static Lisp_Object | |
| 260 get_range_table (EMACS_INT pos, int nentries, struct range_table_entry *tab, | |
| 261 Lisp_Object default_) | |
| 262 { | |
| 263 int left = 0, right = nentries; | |
| 264 | |
| 265 /* binary search for the entry. Based on similar code in | |
| 266 extent_list_locate(). */ | |
| 267 while (left != right) | |
| 268 { | |
| 269 /* RIGHT might not point to a valid entry (i.e. it's at the end | |
| 270 of the list), so NEWPOS must round down. */ | |
| 647 | 271 int newpos = (left + right) >> 1; |
| 428 | 272 struct range_table_entry *entry = tab + newpos; |
| 2421 | 273 if (pos >= entry->last) |
| 274 left = newpos + 1; | |
| 428 | 275 else if (pos < entry->first) |
| 276 right = newpos; | |
| 277 else | |
| 278 return entry->val; | |
| 279 } | |
| 280 | |
| 281 return default_; | |
| 282 } | |
| 283 | |
| 284 DEFUN ("range-table-p", Frange_table_p, 1, 1, 0, /* | |
| 285 Return non-nil if OBJECT is a range table. | |
| 286 */ | |
| 287 (object)) | |
| 288 { | |
| 289 return RANGE_TABLEP (object) ? Qt : Qnil; | |
| 290 } | |
| 291 | |
| 2421 | 292 DEFUN ("range-table-type", Frange_table_type, 1, 1, 0, /* |
|
4713
312503644bc3
Correct the docstring for #'range-table-type.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4690
diff
changeset
|
293 Return the type of RANGE-TABLE. |
|
312503644bc3
Correct the docstring for #'range-table-type.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4690
diff
changeset
|
294 |
|
312503644bc3
Correct the docstring for #'range-table-type.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4690
diff
changeset
|
295 This will be a symbol describing how ranges in RANGE-TABLE function at their |
|
312503644bc3
Correct the docstring for #'range-table-type.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4690
diff
changeset
|
296 ends; see `make-range-table'. |
| 2421 | 297 */ |
| 298 (range_table)) | |
| 299 { | |
| 300 CHECK_RANGE_TABLE (range_table); | |
| 301 return range_table_type_to_symbol (XRANGE_TABLE (range_table)->type); | |
| 302 } | |
| 303 | |
| 304 DEFUN ("make-range-table", Fmake_range_table, 0, 1, 0, /* | |
| 428 | 305 Return a new, empty range table. |
| 306 You can manipulate it using `put-range-table', `get-range-table', | |
| 307 `remove-range-table', and `clear-range-table'. | |
| 2421 | 308 Range tables allow you to efficiently set values for ranges of integers. |
| 309 | |
| 310 TYPE is a symbol indicating how ranges are assumed to function at their | |
| 311 ends. It can be one of | |
| 312 | |
| 313 SYMBOL RANGE-START RANGE-END | |
| 314 ------ ----------- --------- | |
| 315 `start-closed-end-open' (the default) closed open | |
| 316 `start-closed-end-closed' closed closed | |
| 317 `start-open-end-open' open open | |
| 318 `start-open-end-closed' open closed | |
| 319 | |
| 320 A `closed' endpoint of a range means that the number at that end is included | |
| 321 in the range. For an `open' endpoint, the number would not be included. | |
| 322 | |
| 323 For example, a closed-open range from 5 to 20 would be indicated as [5, | |
| 324 20) where a bracket indicates a closed end and a parenthesis an open end, | |
| 325 and would mean `all the numbers between 5 and 20', including 5 but not 20. | |
| 326 This seems a little strange at first but is in fact extremely common in | |
| 327 the outside world as well as in computers and makes things work sensibly. | |
| 328 For example, if I say "there are seven days between today and next week | |
| 329 today", I'm including today but not next week today; if I included both, | |
| 330 there would be eight days. Similarly, there are 15 (= 20 - 5) elements in | |
| 331 the range [5, 20), but 16 in the range [5, 20]. | |
| 428 | 332 */ |
| 2421 | 333 (type)) |
| 428 | 334 { |
| 3017 | 335 Lisp_Range_Table *rt = ALLOC_LCRECORD_TYPE (Lisp_Range_Table, |
| 440 | 336 &lrecord_range_table); |
| 428 | 337 rt->entries = Dynarr_new (range_table_entry); |
| 2421 | 338 rt->type = range_table_symbol_to_type (type); |
| 793 | 339 return wrap_range_table (rt); |
| 428 | 340 } |
| 341 | |
| 342 DEFUN ("copy-range-table", Fcopy_range_table, 1, 1, 0, /* | |
| 444 | 343 Return a new range table which is a copy of RANGE-TABLE. |
| 344 It will contain the same values for the same ranges as RANGE-TABLE. | |
| 345 The values will not themselves be copied. | |
| 428 | 346 */ |
| 444 | 347 (range_table)) |
| 428 | 348 { |
| 440 | 349 Lisp_Range_Table *rt, *rtnew; |
| 428 | 350 |
| 444 | 351 CHECK_RANGE_TABLE (range_table); |
| 352 rt = XRANGE_TABLE (range_table); | |
| 428 | 353 |
| 3017 | 354 rtnew = ALLOC_LCRECORD_TYPE (Lisp_Range_Table, &lrecord_range_table); |
| 428 | 355 rtnew->entries = Dynarr_new (range_table_entry); |
| 2421 | 356 rtnew->type = rt->type; |
| 428 | 357 |
| 358 Dynarr_add_many (rtnew->entries, Dynarr_atp (rt->entries, 0), | |
| 359 Dynarr_length (rt->entries)); | |
| 793 | 360 return wrap_range_table (rtnew); |
| 428 | 361 } |
| 362 | |
| 363 DEFUN ("get-range-table", Fget_range_table, 2, 3, 0, /* | |
| 444 | 364 Find value for position POS in RANGE-TABLE. |
| 428 | 365 If there is no corresponding value, return DEFAULT (defaults to nil). |
| 366 */ | |
| 444 | 367 (pos, range_table, default_)) |
| 428 | 368 { |
| 440 | 369 Lisp_Range_Table *rt; |
| 428 | 370 |
| 444 | 371 CHECK_RANGE_TABLE (range_table); |
| 372 rt = XRANGE_TABLE (range_table); | |
| 428 | 373 |
| 374 CHECK_INT_COERCE_CHAR (pos); | |
| 375 | |
| 376 return get_range_table (XINT (pos), Dynarr_length (rt->entries), | |
| 377 Dynarr_atp (rt->entries, 0), default_); | |
| 378 } | |
| 379 | |
| 380 void | |
| 381 put_range_table (Lisp_Object table, EMACS_INT first, | |
| 382 EMACS_INT last, Lisp_Object val) | |
| 383 { | |
| 384 int i; | |
| 385 int insert_me_here = -1; | |
| 440 | 386 Lisp_Range_Table *rt = XRANGE_TABLE (table); |
| 428 | 387 |
| 2421 | 388 /* Fix up the numbers in accordance with the open/closedness to make |
| 389 them behave like default open/closed. */ | |
| 390 | |
| 391 switch (rt->type) | |
| 392 { | |
| 393 case RANGE_START_CLOSED_END_OPEN: break; | |
| 394 case RANGE_START_CLOSED_END_CLOSED: last++; break; | |
| 395 case RANGE_START_OPEN_END_OPEN: first++; break; | |
| 396 case RANGE_START_OPEN_END_CLOSED: first++, last++; break; | |
| 397 } | |
| 398 | |
| 399 if (first == last) | |
| 400 return; | |
| 401 if (first > last) | |
| 402 /* This will happen if originally first == last and both ends are | |
| 403 open. #### Should we signal an error? */ | |
| 404 return; | |
| 405 | |
| 428 | 406 /* Now insert in the proper place. This gets tricky because |
| 407 we may be overlapping one or more existing ranges and need | |
| 408 to fix them up. */ | |
| 409 | |
| 410 /* First delete all sections of any existing ranges that overlap | |
| 411 the new range. */ | |
| 412 for (i = 0; i < Dynarr_length (rt->entries); i++) | |
| 413 { | |
| 414 struct range_table_entry *entry = Dynarr_atp (rt->entries, i); | |
| 415 /* We insert before the first range that begins at or after the | |
| 416 new range. */ | |
| 417 if (entry->first >= first && insert_me_here < 0) | |
| 418 insert_me_here = i; | |
| 419 if (entry->last < first) | |
| 420 /* completely before the new range. */ | |
| 421 continue; | |
| 422 if (entry->first > last) | |
| 423 /* completely after the new range. No more possibilities of | |
| 424 finding overlapping ranges. */ | |
| 425 break; | |
| 2421 | 426 /* At this point the existing ENTRY overlaps or touches the new one. */ |
| 428 | 427 if (entry->first < first && entry->last <= last) |
| 428 { | |
| 429 /* looks like: | |
| 430 | |
| 2421 | 431 [ NEW ) |
| 432 [ EXISTING ) | |
| 433 | |
| 434 or | |
| 435 | |
| 436 [ NEW ) | |
| 437 [ EXISTING ) | |
| 428 | 438 |
| 439 */ | |
| 440 /* truncate the end off of it. */ | |
| 2421 | 441 entry->last = first; |
| 428 | 442 } |
| 443 else if (entry->first < first && entry->last > last) | |
| 444 /* looks like: | |
| 445 | |
| 2421 | 446 [ NEW ) |
| 447 [ EXISTING ) | |
| 428 | 448 |
| 449 */ | |
| 450 /* need to split this one in two. */ | |
| 451 { | |
| 452 struct range_table_entry insert_me_too; | |
| 453 | |
| 2421 | 454 insert_me_too.first = last; |
| 428 | 455 insert_me_too.last = entry->last; |
| 456 insert_me_too.val = entry->val; | |
| 2421 | 457 entry->last = first; |
| 428 | 458 Dynarr_insert_many (rt->entries, &insert_me_too, 1, i + 1); |
| 459 } | |
| 2421 | 460 else if (entry->last >= last) |
| 428 | 461 { |
| 462 /* looks like: | |
| 463 | |
| 2421 | 464 [ NEW ) |
| 465 [ EXISTING ) | |
| 466 | |
| 467 or | |
| 468 | |
| 469 [ NEW ) | |
| 470 [ EXISTING ) | |
| 428 | 471 |
| 472 */ | |
| 473 /* truncate the start off of it. */ | |
| 2421 | 474 entry->first = last; |
| 428 | 475 } |
| 476 else | |
| 477 { | |
| 478 /* existing is entirely within new. */ | |
| 479 Dynarr_delete_many (rt->entries, i, 1); | |
| 480 i--; /* back up since everything shifted one to the left. */ | |
| 481 } | |
| 482 } | |
| 483 | |
| 484 /* Someone asked us to delete the range, not insert it. */ | |
| 485 if (UNBOUNDP (val)) | |
| 486 return; | |
| 487 | |
| 488 /* Now insert the new entry, maybe at the end. */ | |
| 489 | |
| 490 if (insert_me_here < 0) | |
| 491 insert_me_here = i; | |
| 492 | |
| 493 { | |
| 494 struct range_table_entry insert_me; | |
| 495 | |
| 496 insert_me.first = first; | |
| 497 insert_me.last = last; | |
| 498 insert_me.val = val; | |
| 499 | |
| 500 Dynarr_insert_many (rt->entries, &insert_me, 1, insert_me_here); | |
| 501 } | |
| 502 | |
| 503 /* Now see if we can combine this entry with adjacent ones just | |
| 504 before or after. */ | |
| 505 | |
| 506 if (insert_me_here > 0) | |
| 507 { | |
| 508 struct range_table_entry *entry = Dynarr_atp (rt->entries, | |
| 509 insert_me_here - 1); | |
| 2421 | 510 if (EQ (val, entry->val) && entry->last == first) |
| 428 | 511 { |
| 512 entry->last = last; | |
| 513 Dynarr_delete_many (rt->entries, insert_me_here, 1); | |
| 514 insert_me_here--; | |
| 515 /* We have morphed into a larger range. Update our records | |
| 516 in case we also combine with the one after. */ | |
| 517 first = entry->first; | |
| 518 } | |
| 519 } | |
| 520 | |
| 521 if (insert_me_here < Dynarr_length (rt->entries) - 1) | |
| 522 { | |
| 523 struct range_table_entry *entry = Dynarr_atp (rt->entries, | |
| 524 insert_me_here + 1); | |
| 2421 | 525 if (EQ (val, entry->val) && entry->first == last) |
| 428 | 526 { |
| 527 entry->first = first; | |
| 528 Dynarr_delete_many (rt->entries, insert_me_here, 1); | |
| 529 } | |
| 530 } | |
| 531 } | |
| 532 | |
| 533 DEFUN ("put-range-table", Fput_range_table, 4, 4, 0, /* | |
| 2421 | 534 Set the value for range START .. END to be VALUE in RANGE-TABLE. |
| 428 | 535 */ |
| 444 | 536 (start, end, value, range_table)) |
| 428 | 537 { |
| 538 EMACS_INT first, last; | |
| 539 | |
| 444 | 540 CHECK_RANGE_TABLE (range_table); |
| 428 | 541 CHECK_INT_COERCE_CHAR (start); |
| 542 first = XINT (start); | |
| 543 CHECK_INT_COERCE_CHAR (end); | |
| 544 last = XINT (end); | |
| 545 if (first > last) | |
| 563 | 546 invalid_argument_2 ("start must be <= end", start, end); |
| 428 | 547 |
| 444 | 548 put_range_table (range_table, first, last, value); |
| 549 verify_range_table (XRANGE_TABLE (range_table)); | |
| 428 | 550 return Qnil; |
| 551 } | |
| 552 | |
| 553 DEFUN ("remove-range-table", Fremove_range_table, 3, 3, 0, /* | |
| 2421 | 554 Remove the value for range START .. END in RANGE-TABLE. |
| 428 | 555 */ |
| 444 | 556 (start, end, range_table)) |
| 428 | 557 { |
| 444 | 558 return Fput_range_table (start, end, Qunbound, range_table); |
| 428 | 559 } |
| 560 | |
| 561 DEFUN ("clear-range-table", Fclear_range_table, 1, 1, 0, /* | |
| 444 | 562 Flush RANGE-TABLE. |
| 428 | 563 */ |
| 444 | 564 (range_table)) |
| 428 | 565 { |
| 444 | 566 CHECK_RANGE_TABLE (range_table); |
| 567 Dynarr_reset (XRANGE_TABLE (range_table)->entries); | |
| 428 | 568 return Qnil; |
| 569 } | |
| 570 | |
| 571 DEFUN ("map-range-table", Fmap_range_table, 2, 2, 0, /* | |
| 444 | 572 Map FUNCTION over entries in RANGE-TABLE, calling it with three args, |
| 428 | 573 the beginning and end of the range and the corresponding value. |
| 442 | 574 |
| 575 Results are guaranteed to be correct (i.e. each entry processed | |
| 576 exactly once) if FUNCTION modifies or deletes the current entry | |
| 444 | 577 \(i.e. passes the current range to `put-range-table' or |
|
4391
cbf129b005df
Clarify #'map-range-table docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3017
diff
changeset
|
578 `remove-range-table'). If FUNCTION modifies or deletes any other entry, |
|
cbf129b005df
Clarify #'map-range-table docstring.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3017
diff
changeset
|
579 this guarantee doesn't hold. |
| 428 | 580 */ |
| 444 | 581 (function, range_table)) |
| 428 | 582 { |
| 442 | 583 Lisp_Range_Table *rt; |
| 584 int i; | |
| 585 | |
| 444 | 586 CHECK_RANGE_TABLE (range_table); |
| 442 | 587 CHECK_FUNCTION (function); |
| 588 | |
| 444 | 589 rt = XRANGE_TABLE (range_table); |
| 442 | 590 |
| 591 /* Do not "optimize" by pulling out the length computation below! | |
| 592 FUNCTION may have changed the table. */ | |
| 593 for (i = 0; i < Dynarr_length (rt->entries); i++) | |
| 594 { | |
| 595 struct range_table_entry *entry = Dynarr_atp (rt->entries, i); | |
| 596 EMACS_INT first, last; | |
| 597 Lisp_Object args[4]; | |
| 598 int oldlen; | |
| 599 | |
| 600 again: | |
| 601 first = entry->first; | |
| 602 last = entry->last; | |
| 603 oldlen = Dynarr_length (rt->entries); | |
| 604 args[0] = function; | |
| 2952 | 605 /* Fix up the numbers in accordance with the open/closedness of the |
| 606 table. */ | |
| 607 { | |
| 608 EMACS_INT premier = first, dernier = last; | |
| 609 switch (rt->type) | |
| 610 { | |
| 611 case RANGE_START_CLOSED_END_OPEN: break; | |
| 612 case RANGE_START_CLOSED_END_CLOSED: dernier--; break; | |
| 613 case RANGE_START_OPEN_END_OPEN: premier--; break; | |
| 614 case RANGE_START_OPEN_END_CLOSED: premier--, dernier--; break; | |
| 615 } | |
| 616 args[1] = make_int (premier); | |
| 617 args[2] = make_int (dernier); | |
| 618 } | |
| 442 | 619 args[3] = entry->val; |
| 620 Ffuncall (countof (args), args); | |
| 621 /* Has FUNCTION removed the entry? */ | |
| 622 if (oldlen > Dynarr_length (rt->entries) | |
| 623 && i < Dynarr_length (rt->entries) | |
| 624 && (first != entry->first || last != entry->last)) | |
| 625 goto again; | |
| 626 } | |
| 627 | |
| 428 | 628 return Qnil; |
| 629 } | |
| 630 | |
| 631 | |
| 632 /************************************************************************/ | |
| 633 /* Range table read syntax */ | |
| 634 /************************************************************************/ | |
| 635 | |
| 636 static int | |
| 2421 | 637 rangetab_type_validate (Lisp_Object UNUSED (keyword), Lisp_Object value, |
| 638 Error_Behavior UNUSED (errb)) | |
| 639 { | |
| 640 /* #### should deal with ERRB */ | |
| 641 range_table_symbol_to_type (value); | |
| 642 return 1; | |
| 643 } | |
| 644 | |
| 645 static int | |
| 2286 | 646 rangetab_data_validate (Lisp_Object UNUSED (keyword), Lisp_Object value, |
| 647 Error_Behavior UNUSED (errb)) | |
| 428 | 648 { |
| 2367 | 649 /* #### should deal with ERRB */ |
| 650 EXTERNAL_PROPERTY_LIST_LOOP_3 (range, data, value) | |
| 428 | 651 { |
| 652 if (!INTP (range) && !CHARP (range) | |
| 653 && !(CONSP (range) && CONSP (XCDR (range)) | |
| 654 && NILP (XCDR (XCDR (range))) | |
| 655 && (INTP (XCAR (range)) || CHARP (XCAR (range))) | |
| 656 && (INTP (XCAR (XCDR (range))) || CHARP (XCAR (XCDR (range)))))) | |
| 563 | 657 sferror ("Invalid range format", range); |
| 428 | 658 } |
| 659 | |
| 660 return 1; | |
| 661 } | |
| 662 | |
| 663 static Lisp_Object | |
| 2421 | 664 rangetab_instantiate (Lisp_Object plist) |
| 428 | 665 { |
| 2425 | 666 Lisp_Object data = Qnil, type = Qnil, rangetab; |
| 428 | 667 |
| 2421 | 668 PROPERTY_LIST_LOOP_3 (key, value, plist) |
| 428 | 669 { |
| 2421 | 670 if (EQ (key, Qtype)) type = value; |
| 671 else if (EQ (key, Qdata)) data = value; | |
| 672 else | |
| 2500 | 673 ABORT (); |
| 2421 | 674 } |
| 675 | |
| 2425 | 676 rangetab = Fmake_range_table (type); |
| 428 | 677 |
| 2421 | 678 { |
| 679 PROPERTY_LIST_LOOP_3 (range, val, data) | |
| 680 { | |
| 681 if (CONSP (range)) | |
| 682 Fput_range_table (Fcar (range), Fcar (Fcdr (range)), val, | |
| 683 rangetab); | |
| 684 else | |
| 685 Fput_range_table (range, range, val, rangetab); | |
| 686 } | |
| 687 } | |
| 428 | 688 |
| 689 return rangetab; | |
| 690 } | |
| 691 | |
| 692 | |
| 693 /************************************************************************/ | |
| 694 /* Unified range tables */ | |
| 695 /************************************************************************/ | |
| 696 | |
| 697 /* A "unified range table" is a format for storing range tables | |
| 698 as contiguous blocks of memory. This is used by the regexp | |
| 699 code, which needs to use range tables to properly handle [] | |
| 700 constructs in the presence of extended characters but wants to | |
| 701 store an entire compiled pattern as a contiguous block of memory. | |
| 702 | |
| 703 Unified range tables are designed so that they can be placed | |
| 704 at an arbitrary (possibly mis-aligned) place in memory. | |
| 705 (Dealing with alignment is a pain in the ass.) | |
| 706 | |
| 707 WARNING: No provisions for garbage collection are currently made. | |
| 708 This means that there must not be any Lisp objects in a unified | |
| 709 range table that need to be marked for garbage collection. | |
| 710 Good candidates for objects that can go into a range table are | |
| 711 | |
| 712 -- numbers and characters (do not need to be marked) | |
| 713 -- nil, t (marked elsewhere) | |
| 714 -- charsets and coding systems (automatically marked because | |
| 715 they are in a marked list, | |
| 716 and can't be removed) | |
| 717 | |
| 718 Good but slightly less so: | |
| 719 | |
| 720 -- symbols (could be uninterned, but that is not likely) | |
| 721 | |
| 722 Somewhat less good: | |
| 723 | |
| 724 -- buffers, frames, devices (could get deleted) | |
| 725 | |
| 726 | |
| 727 It is expected that you work with range tables in the normal | |
| 728 format and then convert to unified format when you are done | |
| 729 making modifications. As such, no functions are provided | |
| 730 for modifying a unified range table. The only operations | |
| 731 you can do to unified range tables are | |
| 732 | |
| 733 -- look up a value | |
| 734 -- retrieve all the ranges in an iterative fashion | |
| 735 | |
| 736 */ | |
| 737 | |
| 738 /* The format of a unified range table is as follows: | |
| 739 | |
| 740 -- The first byte contains the number of bytes to skip to find the | |
| 741 actual start of the table. This deals with alignment constraints, | |
| 742 since the table might want to go at any arbitrary place in memory. | |
| 743 -- The next three bytes contain the number of bytes to skip (from the | |
| 744 *first* byte) to find the stuff after the table. It's stored in | |
| 745 little-endian format because that's how God intended things. We don't | |
| 746 necessarily start the stuff at the very end of the table because | |
| 747 we want to have at least ALIGNOF (EMACS_INT) extra space in case | |
| 748 we have to move the range table around. (It appears that some | |
| 749 architectures don't maintain alignment when reallocing.) | |
| 750 -- At the prescribed offset is a struct unified_range_table, containing | |
| 751 some number of `struct range_table_entry' entries. */ | |
| 752 | |
| 753 struct unified_range_table | |
| 754 { | |
| 755 int nentries; | |
| 756 struct range_table_entry first; | |
| 757 }; | |
| 758 | |
| 759 /* Return size in bytes needed to store the data in a range table. */ | |
| 760 | |
| 761 int | |
| 762 unified_range_table_bytes_needed (Lisp_Object rangetab) | |
| 763 { | |
| 764 return (sizeof (struct range_table_entry) * | |
| 765 (Dynarr_length (XRANGE_TABLE (rangetab)->entries) - 1) + | |
| 766 sizeof (struct unified_range_table) + | |
| 767 /* ALIGNOF a struct may be too big. */ | |
| 768 /* We have four bytes for the size numbers, and an extra | |
| 769 four or eight bytes for making sure we get the alignment | |
| 770 OK. */ | |
| 771 ALIGNOF (EMACS_INT) + 4); | |
| 772 } | |
| 773 | |
| 774 /* Convert a range table into unified format and store in DEST, | |
| 775 which must be able to hold the number of bytes returned by | |
| 776 range_table_bytes_needed(). */ | |
| 777 | |
| 778 void | |
| 779 unified_range_table_copy_data (Lisp_Object rangetab, void *dest) | |
| 780 { | |
| 781 /* We cast to the above structure rather than just casting to | |
| 782 char * and adding sizeof(int), because that will lead to | |
| 783 mis-aligned data on the Alpha machines. */ | |
| 784 struct unified_range_table *un; | |
| 785 range_table_entry_dynarr *rted = XRANGE_TABLE (rangetab)->entries; | |
| 786 int total_needed = unified_range_table_bytes_needed (rangetab); | |
| 826 | 787 void *new_dest = ALIGN_PTR ((char *) dest + 4, EMACS_INT); |
| 428 | 788 |
| 789 * (char *) dest = (char) ((char *) new_dest - (char *) dest); | |
| 790 * ((unsigned char *) dest + 1) = total_needed & 0xFF; | |
| 791 total_needed >>= 8; | |
| 792 * ((unsigned char *) dest + 2) = total_needed & 0xFF; | |
| 793 total_needed >>= 8; | |
| 794 * ((unsigned char *) dest + 3) = total_needed & 0xFF; | |
| 795 un = (struct unified_range_table *) new_dest; | |
| 796 un->nentries = Dynarr_length (rted); | |
| 797 memcpy (&un->first, Dynarr_atp (rted, 0), | |
| 798 sizeof (struct range_table_entry) * Dynarr_length (rted)); | |
| 799 } | |
| 800 | |
| 801 /* Return number of bytes actually used by a unified range table. */ | |
| 802 | |
| 803 int | |
| 804 unified_range_table_bytes_used (void *unrangetab) | |
| 805 { | |
| 806 return ((* ((unsigned char *) unrangetab + 1)) | |
| 807 + ((* ((unsigned char *) unrangetab + 2)) << 8) | |
| 808 + ((* ((unsigned char *) unrangetab + 3)) << 16)); | |
| 809 } | |
| 810 | |
| 811 /* Make sure the table is aligned, and move it around if it's not. */ | |
| 812 static void | |
| 813 align_the_damn_table (void *unrangetab) | |
| 814 { | |
| 815 void *cur_dest = (char *) unrangetab + * (char *) unrangetab; | |
| 826 | 816 if (cur_dest != ALIGN_PTR (cur_dest, EMACS_INT)) |
| 428 | 817 { |
| 818 int count = (unified_range_table_bytes_used (unrangetab) - 4 | |
| 819 - ALIGNOF (EMACS_INT)); | |
| 820 /* Find the proper location, just like above. */ | |
| 826 | 821 void *new_dest = ALIGN_PTR ((char *) unrangetab + 4, EMACS_INT); |
| 428 | 822 /* memmove() works in the presence of overlapping data. */ |
| 823 memmove (new_dest, cur_dest, count); | |
| 824 * (char *) unrangetab = (char) ((char *) new_dest - (char *) unrangetab); | |
| 825 } | |
| 826 } | |
| 827 | |
| 828 /* Look up a value in a unified range table. */ | |
| 829 | |
| 830 Lisp_Object | |
| 831 unified_range_table_lookup (void *unrangetab, EMACS_INT pos, | |
| 832 Lisp_Object default_) | |
| 833 { | |
| 834 void *new_dest; | |
| 835 struct unified_range_table *un; | |
| 836 | |
| 837 align_the_damn_table (unrangetab); | |
| 838 new_dest = (char *) unrangetab + * (char *) unrangetab; | |
| 839 un = (struct unified_range_table *) new_dest; | |
| 840 | |
| 841 return get_range_table (pos, un->nentries, &un->first, default_); | |
| 842 } | |
| 843 | |
| 844 /* Return number of entries in a unified range table. */ | |
| 845 | |
| 846 int | |
| 847 unified_range_table_nentries (void *unrangetab) | |
| 848 { | |
| 849 void *new_dest; | |
| 850 struct unified_range_table *un; | |
| 851 | |
| 852 align_the_damn_table (unrangetab); | |
| 853 new_dest = (char *) unrangetab + * (char *) unrangetab; | |
| 854 un = (struct unified_range_table *) new_dest; | |
| 855 return un->nentries; | |
| 856 } | |
| 857 | |
| 858 /* Return the OFFSETth range (counting from 0) in UNRANGETAB. */ | |
| 859 void | |
| 860 unified_range_table_get_range (void *unrangetab, int offset, | |
| 861 EMACS_INT *min, EMACS_INT *max, | |
| 862 Lisp_Object *val) | |
| 863 { | |
| 864 void *new_dest; | |
| 865 struct unified_range_table *un; | |
| 866 struct range_table_entry *tab; | |
| 867 | |
| 868 align_the_damn_table (unrangetab); | |
| 869 new_dest = (char *) unrangetab + * (char *) unrangetab; | |
| 870 un = (struct unified_range_table *) new_dest; | |
| 871 | |
| 872 assert (offset >= 0 && offset < un->nentries); | |
| 873 tab = (&un->first) + offset; | |
| 874 *min = tab->first; | |
| 875 *max = tab->last; | |
| 876 *val = tab->val; | |
| 877 } | |
| 878 | |
| 879 | |
| 880 /************************************************************************/ | |
| 881 /* Initialization */ | |
| 882 /************************************************************************/ | |
| 883 | |
| 884 void | |
| 885 syms_of_rangetab (void) | |
| 886 { | |
| 442 | 887 INIT_LRECORD_IMPLEMENTATION (range_table); |
| 888 | |
| 563 | 889 DEFSYMBOL_MULTIWORD_PREDICATE (Qrange_tablep); |
| 890 DEFSYMBOL (Qrange_table); | |
| 428 | 891 |
| 2421 | 892 DEFSYMBOL (Qstart_closed_end_open); |
| 893 DEFSYMBOL (Qstart_open_end_open); | |
| 894 DEFSYMBOL (Qstart_closed_end_closed); | |
| 895 DEFSYMBOL (Qstart_open_end_closed); | |
| 896 | |
| 428 | 897 DEFSUBR (Frange_table_p); |
| 2421 | 898 DEFSUBR (Frange_table_type); |
| 428 | 899 DEFSUBR (Fmake_range_table); |
| 900 DEFSUBR (Fcopy_range_table); | |
| 901 DEFSUBR (Fget_range_table); | |
| 902 DEFSUBR (Fput_range_table); | |
| 903 DEFSUBR (Fremove_range_table); | |
| 904 DEFSUBR (Fclear_range_table); | |
| 905 DEFSUBR (Fmap_range_table); | |
| 906 } | |
| 907 | |
| 908 void | |
| 909 structure_type_create_rangetab (void) | |
| 910 { | |
| 911 struct structure_type *st; | |
| 912 | |
| 913 st = define_structure_type (Qrange_table, 0, rangetab_instantiate); | |
| 914 | |
| 915 define_structure_type_keyword (st, Qdata, rangetab_data_validate); | |
| 2421 | 916 define_structure_type_keyword (st, Qtype, rangetab_type_validate); |
| 428 | 917 } |