1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-07 04:30:18 +02:00
guile/module/ice-9/object-properties.scm
Andy Wingo be6a5c6c75 Deprecate object-properties in the main environment
They should be deprecated entirely except that they are used for object
documentation.  Some other day.

* libguile/objprop.c:
* libguile/objprop.h: Remove.
* libguile/deprecated.h:
* libguile/deprecated.c (scm_object_properties):
(scm_set_object_properties_x):
(scm_object_property):
(scm_set_object_property_x): Add deprecation shims.
* module/ice-9/deprecated.scm (object-properties*):
(set-object-properties!*):
(object-property*):
(set-object-property!*): Add deprecation shims.
* libguile/init.c:
* libguile.h: Remove objprops.
* module/ice-9/object-properties.scm: Add pure Scheme implementation
here.
* module/ice-9/documentation.scm:
* module/scripts/api-diff.scm:
* module/scripts/read-text-outline.scm:
* module/scripts/scan-api.scm:
* module/scripts/summarize-guile-TODO.scm:
* module/srfi/srfi-64.scm: Include object-properties module.
2025-05-12 13:45:21 +02:00

64 lines
2.4 KiB
Scheme
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; Copyright (C) 2025 Free Software Foundation, Inc.
;;;
;;; This library is free software: you can redistribute it and/or modify
;;; it under the terms of the GNU Lesser General Public License as
;;; published by the Free Software Foundation, either version 3 of the
;;; License, or (at your option) any later version.
;;;
;;; This library is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;;; Lesser General Public License for more details.
;;;
;;; You should have received a copy of the GNU Lesser General Public
;;; License along with this program. If not, see
;;; <http://www.gnu.org/licenses/>.
;;; Commentary:
;;;
;;; Properties are a lispy way to associate random info with random
;;; objects. Traditionally properties are implemented as an alist or a
;;; plist actually pertaining to the object in question.
;;;
;;; These "object properties" have the advantage that they can be
;;; associated with any object, even if the object has no plist. Object
;;; properties are good when you are extending pre-existing objects in
;;; unexpected ways. They also present a pleasing, uniform
;;; procedure-with-setter interface. But if you have a data type that
;;; always has properties, it's often still best to store those
;;; properties within the object itself.
;;;
;;; Code:
(define-module (ice-9 object-properties)
#:use-module (ice-9 weak-tables)
;; FIXME: Change to #:export when deprecated bindings removed.
#:replace (make-object-property
object-properties
set-object-properties!
object-property
set-object-property!))
(define (make-object-property)
;; Weak tables are thread-safe.
(let ((prop (make-weak-key-hash-table)))
(make-procedure-with-setter
(lambda (obj) (hashq-ref prop obj))
(lambda (obj val) (hashq-set! prop obj val)))))
;; FIXME: Deprecate these global properties.
(define global-properties (make-weak-key-hash-table))
(define (object-properties obj)
(hashq-ref global-properties obj '()))
(define (set-object-properties! obj props)
(hashq-set! global-properties obj props))
(define (object-property obj key)
(assq-ref (object-properties obj) key))
(define (set-object-property! obj key value)
(set-object-properties! obj (assq-set! (object-properties obj) key value)))