e55a1128bb
Bind standalone fixture renders to the compact playground viewport, paint reference spacers across the canvas, and give every tinted content box explicit high-contrast ink. Add regression coverage for width, painted separators, and fixture color contracts.
197 lines
6.8 KiB
EmacsLisp
197 lines
6.8 KiB
EmacsLisp
;;; ebox-playground.el --- Public Ebox layout examples -*- lexical-binding: t; -*-
|
|
|
|
;; SPDX-License-Identifier: GPL-3.0-or-later
|
|
;; Author: Ebox contributors
|
|
;; Version: 0.1.0
|
|
;; Package-Requires: ((emacs "29.1") (ebox "1.0.1"))
|
|
;; URL: https://github.com/ginqi7/ebox-playground
|
|
|
|
;;; Commentary:
|
|
|
|
;; This package is intentionally small and public-only. It demonstrates the
|
|
;; Ebox contract without reaching into internal implementation details. ETAF's
|
|
;; application examples live in the sibling `etaf-playground' package.
|
|
|
|
;;; Code:
|
|
|
|
(require 'ebox)
|
|
(require 'elisp-mode)
|
|
(require 'subr-x)
|
|
(defvar read-eval)
|
|
|
|
(defconst ebox-playground-buffer-name "*Ebox Playground*"
|
|
"Default buffer name used by `ebox-playground-open'.")
|
|
|
|
(defvar ebox-dsl-mode-map
|
|
(let ((map (make-sparse-keymap)))
|
|
(set-keymap-parent map emacs-lisp-mode-map)
|
|
(define-key map (kbd "C-c C-c") #'ebox-dsl-render)
|
|
map)
|
|
"Keymap used by `ebox-dsl-mode'.")
|
|
|
|
(defconst ebox-playground--dsl-header-line
|
|
"Ebox DSL | C-c C-c Render preview"
|
|
"Header line shown by `ebox-dsl-mode'.")
|
|
|
|
(defun ebox-playground--source-form ()
|
|
"Read the single Ebox DSL form from the current buffer."
|
|
(ebox-playground--evaluate-form
|
|
(ebox-playground--read-form
|
|
(buffer-substring-no-properties (point-min) (point-max)))))
|
|
|
|
;;;###autoload
|
|
(define-derived-mode ebox-dsl-mode emacs-lisp-mode "EboxDSL"
|
|
"Major mode for Ebox DSL source files."
|
|
(setq-local header-line-format ebox-playground--dsl-header-line)
|
|
(setq-local truncate-lines nil)
|
|
(setq-local bidi-display-reordering nil)
|
|
(setq-local bidi-paragraph-direction 'left-to-right))
|
|
|
|
;;;###autoload
|
|
(defun ebox-dsl-render ()
|
|
"Render the current Ebox DSL buffer into a preview buffer."
|
|
(interactive)
|
|
(let ((ebox-viewport-width
|
|
(ebox-playground--effective-viewport-width)))
|
|
(let* ((source (ebox-playground--source-form))
|
|
(name (format "*Ebox Preview: %s*"
|
|
(or (buffer-file-name) (buffer-name))))
|
|
(node (ebox-build source)))
|
|
(ebox-display-buffer name node)
|
|
(message "Rendered Ebox DSL into %s" name)
|
|
(get-buffer name))))
|
|
|
|
;;;###autoload
|
|
(add-to-list 'auto-mode-alist '("\\.ebox\\'" . ebox-dsl-mode))
|
|
|
|
(defgroup ebox-playground nil
|
|
"Run Ebox DSL examples from source files."
|
|
:group 'ebox)
|
|
|
|
(defconst ebox-playground-directory
|
|
(file-name-directory (or load-file-name buffer-file-name))
|
|
"Directory containing the Ebox Playground package.")
|
|
|
|
(defcustom ebox-playground-default-file
|
|
(expand-file-name "examples/public-layout-gallery.ebox"
|
|
ebox-playground-directory)
|
|
"Ebox DSL file rendered by `ebox-playground-open'."
|
|
:type 'file
|
|
:group 'ebox-playground)
|
|
|
|
(defcustom ebox-playground-default-viewport-width 720
|
|
"Viewport width used when a caller does not provide one explicitly."
|
|
:type 'positive-integer
|
|
:group 'ebox-playground)
|
|
|
|
(defun ebox-playground--effective-viewport-width ()
|
|
"Return the caller's viewport width or the compact playground default."
|
|
(if (and (numberp ebox-viewport-width)
|
|
(> ebox-viewport-width 0))
|
|
(floor ebox-viewport-width)
|
|
ebox-playground-default-viewport-width))
|
|
|
|
(defun ebox-playground--render-node-to-buffer (buffer node)
|
|
"Render NODE into BUFFER using the effective playground viewport width."
|
|
(let ((ebox-viewport-width
|
|
(ebox-playground--effective-viewport-width)))
|
|
(ebox-render-to-buffer buffer node)))
|
|
|
|
(defun ebox-playground--static-value-p (value)
|
|
"Return non-nil when VALUE is a literal or explicitly quoted form."
|
|
(or (null value) (numberp value) (stringp value) (characterp value)
|
|
(keywordp value) (eq value t)
|
|
(and (consp value) (memq (car value) '(quote function)))))
|
|
|
|
(defun ebox-playground--evaluate-value (value)
|
|
"Evaluate executable DSL VALUE while preserving literal data values."
|
|
(if (ebox-playground--static-value-p value)
|
|
(if (and (consp value) (memq (car value) '(quote function)))
|
|
(eval value nil)
|
|
value)
|
|
(eval value nil)))
|
|
|
|
(defun ebox-playground--evaluate-items (items)
|
|
"Evaluate property values and recurse into child forms in ITEMS."
|
|
(let (result)
|
|
(while items
|
|
(let ((item (pop items)))
|
|
(if (keywordp item)
|
|
(progn
|
|
(unless items
|
|
(error "Ebox playground: missing value for %S" item))
|
|
(push item result)
|
|
(push (ebox-playground--evaluate-value (pop items)) result))
|
|
(push (ebox-playground--evaluate-form item) result))))
|
|
(nreverse result)))
|
|
|
|
(defun ebox-playground--evaluate-form (form)
|
|
"Evaluate property expressions in one structural DSL FORM."
|
|
(if (and (consp form) (symbolp (car form)))
|
|
(cons (car form) (ebox-playground--evaluate-items (cdr form)))
|
|
form))
|
|
|
|
(defun ebox-playground--read-form (source)
|
|
"Read one Ebox DSL form from SOURCE."
|
|
(when (string-empty-p (string-trim source))
|
|
(user-error "The Ebox DSL source is empty"))
|
|
(with-temp-buffer
|
|
(insert source)
|
|
(goto-char (point-min))
|
|
(let ((read-eval nil)
|
|
(form (read (current-buffer))))
|
|
(condition-case nil
|
|
(progn
|
|
(read (current-buffer))
|
|
(user-error "The Ebox DSL source must contain one form"))
|
|
(end-of-file form)))))
|
|
|
|
(defun ebox-playground--read-file (file)
|
|
"Read one Ebox DSL form from FILE."
|
|
(unless (file-readable-p file)
|
|
(user-error "Ebox DSL file is not readable: %s" file))
|
|
(with-temp-buffer
|
|
(insert-file-contents file)
|
|
(ebox-playground--read-form
|
|
(buffer-substring-no-properties (point-min) (point-max)))))
|
|
|
|
;;;###autoload
|
|
(defun ebox-playground-view (&optional file)
|
|
"Build the Ebox DSL form in FILE without buffer side effects."
|
|
(let ((ebox-viewport-width
|
|
(ebox-playground--effective-viewport-width)))
|
|
(ebox-build
|
|
(ebox-playground--evaluate-form
|
|
(ebox-playground--read-file
|
|
(expand-file-name (or file ebox-playground-default-file)))))))
|
|
|
|
;;;###autoload
|
|
(defun ebox-playground-open (&optional buffer-name)
|
|
"Render the default Ebox DSL example into BUFFER-NAME and return its buffer."
|
|
(interactive)
|
|
(ebox-playground--render-node-to-buffer
|
|
(or buffer-name ebox-playground-buffer-name)
|
|
(ebox-playground-view)))
|
|
|
|
;;;###autoload
|
|
(defun ebox-playground-open-file (file &optional buffer-name)
|
|
"Render Ebox DSL FILE into BUFFER-NAME and return its buffer."
|
|
(interactive "fEbox DSL file: ")
|
|
(ebox-playground--render-node-to-buffer
|
|
(or buffer-name
|
|
(format "*Ebox Preview: %s*" (file-name-nondirectory file)))
|
|
(ebox-playground-view file)))
|
|
|
|
;;;###autoload
|
|
(defun ebox-playground-close (&optional buffer-name)
|
|
"Kill the playground BUFFER-NAME and return its former buffer."
|
|
(interactive)
|
|
(let ((buffer (get-buffer (or buffer-name ebox-playground-buffer-name))))
|
|
(when buffer
|
|
(kill-buffer buffer))
|
|
buffer))
|
|
|
|
(provide 'ebox-playground)
|
|
|
|
;;; ebox-playground.el ends here
|