aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorLars Brinkhoff2013-01-06 14:27:44 +0100
committerLars Brinkhoff2017-04-04 08:23:46 +0200
commita2c33430292c79ac520100b1d0e8e7c04dfe426a (patch)
treec14abd179a8646449c1430f24762db3e2359886a /src
parent19b92cdfb04a025037d7388954b64468d6f54462 (diff)
downloademacs-a2c33430292c79ac520100b1d0e8e7c04dfe426a.tar.gz
emacs-a2c33430292c79ac520100b1d0e8e7c04dfe426a.zip
Add record objects with user-defined types.
* src/alloc.c (allocate_record): New function. (Fmake_record, Frecord, Fcopy_record): New functions. (syms_of_alloc): defsubr them. (purecopy): Work with records. * src/data.c (Ftype_of): Return slot 0 for record objects, or type name if record's type holds class. (Frecordp): New function. (syms_of_data): defsubr it. Define `Qrecordp'. (Faref, Faset): Work with records. * src/fns.c (Flength): Work with records. * src/lisp.h (prec_type): Add PVEC_RECORD. (RECORDP, CHECK_RECORD, CHECK_RECORD_TYPE): New functions. * src/lread.c (read1): Add syntax for records. * src/print.c (PRINT_CIRCLE_CANDIDATE_P): Add RECORDP. (print_object): Add syntax for records. * test/lisp/emacs-lisp/cl-print-tests.el (cl-print-tests-2): New test. * test/src/alloc-tests.el (record-1, record-2, record-3): New tests. * doc/lispref/elisp.texi, doc/lispref/objects.texi, doc/lispref/records.texi: Add documentation for records.
Diffstat (limited to 'src')
-rw-r--r--src/alloc.c93
-rw-r--r--src/data.c35
-rw-r--r--src/fns.c2
-rw-r--r--src/lisp.h14
-rw-r--r--src/lread.c14
-rw-r--r--src/print.c27
6 files changed, 177 insertions, 8 deletions
diff --git a/src/alloc.c b/src/alloc.c
index ae3e1519c04..fe631f2e4d8 100644
--- a/src/alloc.c
+++ b/src/alloc.c
@@ -3392,6 +3392,94 @@ allocate_buffer (void)
3392 return b; 3392 return b;
3393} 3393}
3394 3394
3395
3396/* Allocate a new record with COUNT slots. Return NULL if COUNT is
3397 too large. */
3398
3399static struct Lisp_Vector *
3400allocate_record (int count)
3401{
3402 if (count >= (1 << PSEUDOVECTOR_SIZE_BITS))
3403 return NULL;
3404
3405 struct Lisp_Vector *p = allocate_vector (count);
3406 XSETPVECTYPE (p, PVEC_RECORD);
3407 return p;
3408}
3409
3410
3411DEFUN ("make-record", Fmake_record, Smake_record, 3, 3, 0,
3412 doc: /* Create a new record.
3413TYPE is its type as returned by `type-of'. SLOTS is the number of
3414slots, each initialized to INIT. The number of slots, including the
3415type slot, must fit in PSEUDOVECTOR_SIZE_BITS. */)
3416 (Lisp_Object type, Lisp_Object slots, Lisp_Object init)
3417{
3418 Lisp_Object record;
3419 ptrdiff_t size, i;
3420 struct Lisp_Vector *p;
3421
3422 CHECK_NATNUM (slots);
3423
3424 size = XFASTINT (slots) + 1;
3425 p = allocate_record (size);
3426 if (p == NULL)
3427 error ("Attempt to allocate a record of %ld slots; max is %d",
3428 size, (1 << PSEUDOVECTOR_SIZE_BITS) - 1);
3429
3430 p->contents[0] = type;
3431 for (i = 1; i < size; i++)
3432 p->contents[i] = init;
3433
3434 XSETVECTOR (record, p);
3435 return record;
3436}
3437
3438
3439DEFUN ("record", Frecord, Srecord, 1, MANY, 0,
3440 doc: /* Create a new record.
3441TYPE is its type as returned by `type-of'. SLOTS is used to
3442initialize the record slots with shallow copies of the arguments. The
3443number of slots, including the type slot, must fit in
3444PSEUDOVECTOR_SIZE_BITS.
3445usage: (record TYPE &rest SLOTS) */)
3446 (ptrdiff_t nargs, Lisp_Object *args)
3447{
3448 struct Lisp_Vector *p = allocate_record (nargs);
3449 if (p == NULL)
3450 error ("Attempt to allocate a record of %ld slots; max is %d",
3451 nargs, (1 << PSEUDOVECTOR_SIZE_BITS) - 1);
3452
3453 Lisp_Object type = args[0];
3454 Lisp_Object record;
3455
3456 p->contents[0] = type;
3457 memcpy (p->contents + 1, args + 1, (nargs - 1) * sizeof *args);
3458
3459 XSETVECTOR (record, p);
3460 return record;
3461}
3462
3463
3464DEFUN ("copy-record", Fcopy_record, Scopy_record, 1, 1, 0,
3465 doc: /* Return a new record that is a shallow copy of the argument RECORD. */)
3466 (Lisp_Object record)
3467{
3468 CHECK_RECORD (record);
3469 struct Lisp_Vector *src = XVECTOR (record);
3470 ptrdiff_t size = ASIZE (record) & PSEUDOVECTOR_SIZE_MASK;
3471 struct Lisp_Vector *new = allocate_record (size);
3472 if (new == NULL)
3473 error ("Attempt to allocate a record of %ld slots; max is %d",
3474 size, (1 << PSEUDOVECTOR_SIZE_BITS) - 1);
3475
3476 memcpy (&(new->contents[0]), &(src->contents[0]),
3477 size * sizeof (Lisp_Object));
3478 XSETVECTOR (record, new);
3479 return record;
3480}
3481
3482
3395DEFUN ("make-vector", Fmake_vector, Smake_vector, 2, 2, 0, 3483DEFUN ("make-vector", Fmake_vector, Smake_vector, 2, 2, 0,
3396 doc: /* Return a newly created vector of length LENGTH, with each element being INIT. 3484 doc: /* Return a newly created vector of length LENGTH, with each element being INIT.
3397See also the function `vector'. */) 3485See also the function `vector'. */)
@@ -5532,7 +5620,7 @@ purecopy (Lisp_Object obj)
5532 struct Lisp_Hash_Table *h = purecopy_hash_table (table); 5620 struct Lisp_Hash_Table *h = purecopy_hash_table (table);
5533 XSET_HASH_TABLE (obj, h); 5621 XSET_HASH_TABLE (obj, h);
5534 } 5622 }
5535 else if (COMPILEDP (obj) || VECTORP (obj)) 5623 else if (COMPILEDP (obj) || VECTORP (obj) || RECORDP (obj))
5536 { 5624 {
5537 struct Lisp_Vector *objp = XVECTOR (obj); 5625 struct Lisp_Vector *objp = XVECTOR (obj);
5538 ptrdiff_t nbytes = vector_nbytes (objp); 5626 ptrdiff_t nbytes = vector_nbytes (objp);
@@ -7461,10 +7549,13 @@ The time is in seconds as a floating point value. */);
7461 defsubr (&Scons); 7549 defsubr (&Scons);
7462 defsubr (&Slist); 7550 defsubr (&Slist);
7463 defsubr (&Svector); 7551 defsubr (&Svector);
7552 defsubr (&Srecord);
7553 defsubr (&Scopy_record);
7464 defsubr (&Sbool_vector); 7554 defsubr (&Sbool_vector);
7465 defsubr (&Smake_byte_code); 7555 defsubr (&Smake_byte_code);
7466 defsubr (&Smake_list); 7556 defsubr (&Smake_list);
7467 defsubr (&Smake_vector); 7557 defsubr (&Smake_vector);
7558 defsubr (&Smake_record);
7468 defsubr (&Smake_string); 7559 defsubr (&Smake_string);
7469 defsubr (&Smake_bool_vector); 7560 defsubr (&Smake_bool_vector);
7470 defsubr (&Smake_symbol); 7561 defsubr (&Smake_symbol);
diff --git a/src/data.c b/src/data.c
index ae8dd9721c2..5fdbec2000e 100644
--- a/src/data.c
+++ b/src/data.c
@@ -267,6 +267,15 @@ for example, (type-of 1) returns `integer'. */)
267 case PVEC_MUTEX: return Qmutex; 267 case PVEC_MUTEX: return Qmutex;
268 case PVEC_CONDVAR: return Qcondition_variable; 268 case PVEC_CONDVAR: return Qcondition_variable;
269 case PVEC_TERMINAL: return Qterminal; 269 case PVEC_TERMINAL: return Qterminal;
270 case PVEC_RECORD:
271 {
272 Lisp_Object t = AREF (object, 0);
273 if (RECORDP (t) && 1 < (ASIZE (t) & PSEUDOVECTOR_SIZE_MASK))
274 /* Return the type name field of the class! */
275 return AREF (t, 1);
276 else
277 return t;
278 }
270 /* "Impossible" cases. */ 279 /* "Impossible" cases. */
271 case PVEC_XWIDGET: 280 case PVEC_XWIDGET:
272 case PVEC_OTHER: 281 case PVEC_OTHER:
@@ -359,6 +368,15 @@ DEFUN ("vectorp", Fvectorp, Svectorp, 1, 1, 0,
359 return Qnil; 368 return Qnil;
360} 369}
361 370
371DEFUN ("recordp", Frecordp_p, Srecordp, 1, 1, 0,
372 doc: /* Return t if OBJECT is a record. */)
373 (Lisp_Object object)
374{
375 if (RECORDP (object))
376 return Qt;
377 return Qnil;
378}
379
362DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0, 380DEFUN ("stringp", Fstringp, Sstringp, 1, 1, 0,
363 doc: /* Return t if OBJECT is a string. */ 381 doc: /* Return t if OBJECT is a string. */
364 attributes: const) 382 attributes: const)
@@ -2287,7 +2305,7 @@ or a byte-code object. IDX starts at 0. */)
2287 ptrdiff_t size = 0; 2305 ptrdiff_t size = 0;
2288 if (VECTORP (array)) 2306 if (VECTORP (array))
2289 size = ASIZE (array); 2307 size = ASIZE (array);
2290 else if (COMPILEDP (array)) 2308 else if (COMPILEDP (array) || RECORDP (array))
2291 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK; 2309 size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2292 else 2310 else
2293 wrong_type_argument (Qarrayp, array); 2311 wrong_type_argument (Qarrayp, array);
@@ -2308,7 +2326,8 @@ bool-vector. IDX starts at 0. */)
2308 2326
2309 CHECK_NUMBER (idx); 2327 CHECK_NUMBER (idx);
2310 idxval = XINT (idx); 2328 idxval = XINT (idx);
2311 CHECK_ARRAY (array, Qarrayp); 2329 if (! RECORDP (array))
2330 CHECK_ARRAY (array, Qarrayp);
2312 2331
2313 if (VECTORP (array)) 2332 if (VECTORP (array))
2314 { 2333 {
@@ -2328,7 +2347,14 @@ bool-vector. IDX starts at 0. */)
2328 CHECK_CHARACTER (idx); 2347 CHECK_CHARACTER (idx);
2329 CHAR_TABLE_SET (array, idxval, newelt); 2348 CHAR_TABLE_SET (array, idxval, newelt);
2330 } 2349 }
2331 else 2350 else if (RECORDP (array))
2351 {
2352 ptrdiff_t size = ASIZE (array) & PSEUDOVECTOR_SIZE_MASK;
2353 if (idxval < 0 || idxval >= size)
2354 args_out_of_range (array, idx);
2355 ASET (array, idxval, newelt);
2356 }
2357 else /* STRINGP */
2332 { 2358 {
2333 int c; 2359 int c;
2334 2360
@@ -3604,6 +3630,7 @@ syms_of_data (void)
3604 DEFSYM (Qsequencep, "sequencep"); 3630 DEFSYM (Qsequencep, "sequencep");
3605 DEFSYM (Qbufferp, "bufferp"); 3631 DEFSYM (Qbufferp, "bufferp");
3606 DEFSYM (Qvectorp, "vectorp"); 3632 DEFSYM (Qvectorp, "vectorp");
3633 DEFSYM (Qrecordp, "recordp");
3607 DEFSYM (Qbool_vector_p, "bool-vector-p"); 3634 DEFSYM (Qbool_vector_p, "bool-vector-p");
3608 DEFSYM (Qchar_or_string_p, "char-or-string-p"); 3635 DEFSYM (Qchar_or_string_p, "char-or-string-p");
3609 DEFSYM (Qmarkerp, "markerp"); 3636 DEFSYM (Qmarkerp, "markerp");
@@ -3714,6 +3741,7 @@ syms_of_data (void)
3714 DEFSYM (Qbuffer, "buffer"); 3741 DEFSYM (Qbuffer, "buffer");
3715 DEFSYM (Qframe, "frame"); 3742 DEFSYM (Qframe, "frame");
3716 DEFSYM (Qvector, "vector"); 3743 DEFSYM (Qvector, "vector");
3744 DEFSYM (Qrecord, "record");
3717 DEFSYM (Qchar_table, "char-table"); 3745 DEFSYM (Qchar_table, "char-table");
3718 DEFSYM (Qbool_vector, "bool-vector"); 3746 DEFSYM (Qbool_vector, "bool-vector");
3719 DEFSYM (Qhash_table, "hash-table"); 3747 DEFSYM (Qhash_table, "hash-table");
@@ -3750,6 +3778,7 @@ syms_of_data (void)
3750 defsubr (&Sstringp); 3778 defsubr (&Sstringp);
3751 defsubr (&Smultibyte_string_p); 3779 defsubr (&Smultibyte_string_p);
3752 defsubr (&Svectorp); 3780 defsubr (&Svectorp);
3781 defsubr (&Srecordp);
3753 defsubr (&Schar_table_p); 3782 defsubr (&Schar_table_p);
3754 defsubr (&Svector_or_char_table_p); 3783 defsubr (&Svector_or_char_table_p);
3755 defsubr (&Sbool_vector_p); 3784 defsubr (&Sbool_vector_p);
diff --git a/src/fns.c b/src/fns.c
index de7fc1b47fc..47da5f8b4bc 100644
--- a/src/fns.c
+++ b/src/fns.c
@@ -106,7 +106,7 @@ To get the number of bytes, use `string-bytes'. */)
106 XSETFASTINT (val, MAX_CHAR); 106 XSETFASTINT (val, MAX_CHAR);
107 else if (BOOL_VECTOR_P (sequence)) 107 else if (BOOL_VECTOR_P (sequence))
108 XSETFASTINT (val, bool_vector_size (sequence)); 108 XSETFASTINT (val, bool_vector_size (sequence));
109 else if (COMPILEDP (sequence)) 109 else if (COMPILEDP (sequence) || RECORDP (sequence))
110 XSETFASTINT (val, ASIZE (sequence) & PSEUDOVECTOR_SIZE_MASK); 110 XSETFASTINT (val, ASIZE (sequence) & PSEUDOVECTOR_SIZE_MASK);
111 else if (CONSP (sequence)) 111 else if (CONSP (sequence))
112 { 112 {
diff --git a/src/lisp.h b/src/lisp.h
index 3125bd2a5dd..5e7d41bc5d5 100644
--- a/src/lisp.h
+++ b/src/lisp.h
@@ -889,6 +889,7 @@ enum pvec_type
889 PVEC_COMPILED, 889 PVEC_COMPILED,
890 PVEC_CHAR_TABLE, 890 PVEC_CHAR_TABLE,
891 PVEC_SUB_CHAR_TABLE, 891 PVEC_SUB_CHAR_TABLE,
892 PVEC_RECORD,
892 PVEC_FONT /* Should be last because it's used for range checking. */ 893 PVEC_FONT /* Should be last because it's used for range checking. */
893}; 894};
894 895
@@ -1412,6 +1413,7 @@ CHECK_VECTOR (Lisp_Object x)
1412 CHECK_TYPE (VECTORP (x), Qvectorp, x); 1413 CHECK_TYPE (VECTORP (x), Qvectorp, x);
1413} 1414}
1414 1415
1416
1415/* A pseudovector is like a vector, but has other non-Lisp components. */ 1417/* A pseudovector is like a vector, but has other non-Lisp components. */
1416 1418
1417INLINE enum pvec_type 1419INLINE enum pvec_type
@@ -2732,6 +2734,18 @@ FRAMEP (Lisp_Object a)
2732 return PSEUDOVECTORP (a, PVEC_FRAME); 2734 return PSEUDOVECTORP (a, PVEC_FRAME);
2733} 2735}
2734 2736
2737INLINE bool
2738RECORDP (Lisp_Object a)
2739{
2740 return PSEUDOVECTORP (a, PVEC_RECORD);
2741}
2742
2743INLINE void
2744CHECK_RECORD (Lisp_Object x)
2745{
2746 CHECK_TYPE (RECORDP (x), Qrecordp, x);
2747}
2748
2735/* Test for image (image . spec) */ 2749/* Test for image (image . spec) */
2736INLINE bool 2750INLINE bool
2737IMAGEP (Lisp_Object x) 2751IMAGEP (Lisp_Object x)
diff --git a/src/lread.c b/src/lread.c
index 5c6a7f97f52..6de9fe6e08e 100644
--- a/src/lread.c
+++ b/src/lread.c
@@ -2603,8 +2603,18 @@ read1 (Lisp_Object readcharfun, int *pch, bool first_in_list)
2603 int param_count = 0; 2603 int param_count = 0;
2604 2604
2605 if (!EQ (head, Qhash_table)) 2605 if (!EQ (head, Qhash_table))
2606 error ("Invalid extended read marker at head of #s list " 2606 {
2607 "(only hash-table allowed)"); 2607 ptrdiff_t size = XINT (Flength (tmp));
2608 Lisp_Object record = Fmake_record (CAR_SAFE (tmp),
2609 make_number (size - 1),
2610 Qnil);
2611 for (int i = 1; i < size; i++)
2612 {
2613 tmp = Fcdr (tmp);
2614 ASET (record, i, Fcar (tmp));
2615 }
2616 return record;
2617 }
2608 2618
2609 tmp = CDR_SAFE (tmp); 2619 tmp = CDR_SAFE (tmp);
2610 2620
diff --git a/src/print.c b/src/print.c
index e857761bd46..76f263994e6 100644
--- a/src/print.c
+++ b/src/print.c
@@ -1135,7 +1135,8 @@ print (Lisp_Object obj, Lisp_Object printcharfun, bool escapeflag)
1135 || (VECTORLIKEP (obj) \ 1135 || (VECTORLIKEP (obj) \
1136 && (VECTORP (obj) || COMPILEDP (obj) \ 1136 && (VECTORP (obj) || COMPILEDP (obj) \
1137 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \ 1137 || CHAR_TABLE_P (obj) || SUB_CHAR_TABLE_P (obj) \
1138 || HASH_TABLE_P (obj) || FONTP (obj))) \ 1138 || HASH_TABLE_P (obj) || FONTP (obj) \
1139 || RECORDP (obj))) \
1139 || (! NILP (Vprint_gensym) \ 1140 || (! NILP (Vprint_gensym) \
1140 && SYMBOLP (obj) \ 1141 && SYMBOLP (obj) \
1141 && !SYMBOL_INTERNED_P (obj))) 1142 && !SYMBOL_INTERNED_P (obj)))
@@ -1963,6 +1964,30 @@ print_object (Lisp_Object obj, Lisp_Object printcharfun, bool escapeflag)
1963 } 1964 }
1964 break; 1965 break;
1965 1966
1967 case PVEC_RECORD:
1968 {
1969 ptrdiff_t n, size = ASIZE (obj) & PSEUDOVECTOR_SIZE_MASK;
1970 int i;
1971
1972 /* Don't print more elements than the specified maximum. */
1973 if (NATNUMP (Vprint_length)
1974 && XFASTINT (Vprint_length) < size)
1975 n = XFASTINT (Vprint_length);
1976 else
1977 n = size;
1978
1979 print_c_string ("#s(", printcharfun);
1980 for (i = 0; i < n; i ++)
1981 {
1982 if (i) printchar (' ', printcharfun);
1983 print_object (AREF (obj, i), printcharfun, escapeflag);
1984 }
1985 if (n < size)
1986 print_c_string (" ...", printcharfun);
1987 printchar (')', printcharfun);
1988 }
1989 break;
1990
1966 case PVEC_SUB_CHAR_TABLE: 1991 case PVEC_SUB_CHAR_TABLE:
1967 case PVEC_COMPILED: 1992 case PVEC_COMPILED:
1968 case PVEC_CHAR_TABLE: 1993 case PVEC_CHAR_TABLE: