maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(wpcarro/emacs): Package al, list, set, struct

Browse source 
Originally I set-out to package `al.el`, but as I started traversing the
dependencies, I needed to package increasingly more packages. I refactored some
of these to prune their dependencies to slay this hydra before it turned into a
never-ending project. I have mixed feelings about this.

I also introduced `ert` and unit tests into my Elisp packaging, so it'll be nice
to have build-time tests that run when Emacs updates land in depot.

Change-Id: I2756dc60888b80255a495e08ae61bd547e6b3db2
Reviewed-on: https://cl.tvl.fyi/c/depot/+/5998
Reviewed-by: wpcarro <wpcarro@gmail.com>
Autosubmit: wpcarro <wpcarro@gmail.com>
Tested-by: BuildkiteCI
This commit is contained in:
William Carroll 2022-07-28 20:29:07 -07:00 • committed by clbot
parent caf068253a
commit 15c9ff4902
13 changed files with 323 additions and 165 deletions
Download patch file Download diff file Expand all files Collapse all files

85
users/wpcarro/emacs/.emacs.d/wpc/struct.el
View file

@ -1,85 +0,0 @@
;;; struct.el --- Helpers for working with structs -*- lexical-binding: t -*-
;; Author: William Carroll <wpcarro@gmail.com>
;; Version: 0.0.1
;; Package-Requires: ((emacs "24.3"))
;;; Commentary:
;; Provides new macros for working with structs. Also provides adapter
;; interfaces to existing struct macros, that should have more intuitive
;; interfaces.
;;
;; Sometimes `setf' just isn't enough.
;;; Code:
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Dependencies
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(require 'string)
(require 'dash)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Library
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar struct--enable-tests? t
"When t, run the test suite defined herein.")
(defmacro struct-update (type field f xs)
"Apply F to FIELD in XS, which is a struct of TYPE.
This is immutable."
(let ((copier (->> type
symbol-name
(string-prepend "copy-")
intern))
(accessor (->> field
symbol-name
(string-prepend (string-concat (symbol-name type) "-"))
intern)))
`(let ((copy (,copier ,xs)))
(setf (,accessor copy) (funcall ,f (,accessor copy)))
copy)))
(defmacro struct-set (type field x xs)
"Immutably set FIELD in XS (struct TYPE) to X."
(let ((copier (->> type
symbol-name
(string-prepend "copy-")
intern))
(accessor (->> field
symbol-name
(string-prepend (string-concat (symbol-name type) "-"))
intern)))
`(let ((copy (,copier ,xs)))
(setf (,accessor copy) ,x)
copy)))
(defmacro struct-set! (type field x xs)
"Set FIELD in XS (struct TYPE) to X mutably.
This is an adapter interface to `setf'."
(let ((accessor (->> field
symbol-name
(string-prepend (string-concat (symbol-name type) "-"))
intern)))
`(progn
(setf (,accessor ,xs) ,x)
,xs)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Tests
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(when struct--enable-tests?
(cl-defstruct dummy name age)
(defvar struct--test-dummy (make-dummy :name "Roofus" :age 19))
(struct-set! dummy name "Doofus" struct--test-dummy)
(prelude-assert (string= "Doofus" (dummy-name struct--test-dummy)))
(let ((result (struct-set dummy name "Shoofus" struct--test-dummy)))
;; Test the immutability of `struct-set'
(prelude-assert (string= "Doofus" (dummy-name struct--test-dummy)))
(prelude-assert (string= "Shoofus" (dummy-name result)))))
(provide 'struct)
;;; struct.el ends here