Skip to content


Subversion checkout URL

You can clone with
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

3555 lines (3217 sloc) 124.038 kB
;;; gimp-mode.el --- Interaction/editing mode for the GIMP
;; Copyright (C) 2008-2012 Niels Giesen
;; Author: Niels Giesen <>
;; Keywords: processes, languages, multimedia, tools
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Commentary:
;; Interaction/editing mode for the GIMP
;; see README.markdown for full description and usage.
;; TOC:
;;;; Requirements
;;;; Structure
;;;; Faces
;;;; Globals
;;;; Customization
;;;; General purpose functions and macros
;;;; Keybindings
;;;; Set up the modes
;;;; Versioning
;;;; Evaluation
;;;; Help
;;;; Stuff pertaining to running 'n' quitting
;;;; Utility functions
;;;; Caches: saving, deleting, restoring
;;;; Tracing
;;;; Modes
;;;; Internal information retrieval
;;;; Completion
;;;; Shortcuts
;;;; Doc echoing
;;;; Source look-up
;;;; Snippets
;;;; Misc interactive commands
;; Client mode global vars
;;; Code:
(provide 'gimp-mode)
;;;; Requirements
(require 'cmuscheme)
(require 'outline)
(require 'cl)
(require 'eldoc)
(require 'thingatpt)
(eval-when-compile (load "gimp-init.el"))
(eval-when (compile load)
(require 'ring)
(require 'snippet)
(require 'scheme-complete)
;; (require 'fud)
;;;; Structure
(defgroup gimp nil "Customization group for GIMP (script-fu) programming."
:group 'shell
:group 'scheme
:group 'multimedia
:group 'languages)
(defgroup gimp-faces
"Customization group for GIMP Mode faces"
:group 'gimp)
;;;; Faces
;; text properties
(defun gimp-highlight (str)
(propertize str 'mouse-face 'highlight))
(defmacro gimp-set-face (str face)
`(propertize ,str
(read (format "gimp-%S-face" ',face))))
(defmacro gimp-button (text field hint face)
"Make a button showing TEXT, with field FIELD.
HINT is the help-echo, and face the gimp-FACE-face."
'mouse-face 'highlight
'field ',field
'font-lock-face (read (format "gimp-%S-face" ',face))))
(defface gimp-shy-face
'((((class color)(background dark))
:foreground "saddlebrown")
(((class color)(background light))
:foreground "#ecf"))
"Face for uninteresting stuff."
:group 'gimp-faces)
(defface gimp-less-shy-face
'((((class color)(background dark))
:foreground "darkkhaki")
(((class color)(background light))
:foreground "darkslateblue"))
"Face for uninteresting stuff."
:group 'gimp-faces)
(defface gimp-menu-face
'((t (:foreground "#7f8c29"
:box '(:line-width 2 :color grey15)
:height 1.2
:bold t
"Face for menu items."
:group 'gimp-faces)
(defface gimp-red-face
'((t (:foreground "#f00"
:bold t
"Face for menu items."
:group 'gimp-faces)
(defface gimp-terminal-menu-face
(:inherit gimp-menu-face))
(((class color)(background dark))
:foreground "#cc0")
(((class color)(background light))
:foreground "#200"))
"Face for terminal menu item."
:group 'gimp-faces)
(defface gimp-link-face
(:underline t
:foreground "#d37511")))
"Face for links."
:group 'gimp-faces)
(defface gimp-visited-procedure-face
(:foreground "#8c7829")))
"Face for procedures that have been visited with GIMP Help"
:group 'gimp-faces)
(defface gimp-level1-face
:family "helv"
:height 1.2
:weight bold)
(((class color)(background dark))
:foreground "gold3")
(((class color)(background light))
:foreground "gold"))
"Face for level2 items (== arguments)"
:group 'gimp-faces)
(defface gimp-level2-face
:weight bold)
(((class color)(background dark))
:foreground "gold")
(((class color)(background light))
:foreground "#200"))
"Face for level2 items (== arguments)"
:group 'gimp-faces)
(defface gimp-function-name-face
'((((class color) (min-colors 88) (background light))
(:foreground "Blue1"))
(((class color) (min-colors 88) (background dark))
(:foreground "LightSkyBlue"))
(((class color) (min-colors 16) (background light))
(:foreground "Blue"))
(((class color) (min-colors 16) (background dark))
(:foreground "LightSkyBlue"))
(((class color) (min-colors 8))
(:foreground "blue" :weight bold))
(t (:inverse-video t :weight bold)))
"Gimp Mode face used to highlight function names."
:group 'gimp-faces)
(defface gimp-variable-name-face
'((((class grayscale) (background light))
(:foreground "Gray90" :weight bold :slant italic))
(((class grayscale) (background dark))
(:foreground "DimGray" :weight bold :slant italic))
(((class color) (min-colors 88) (background light))
(:foreground "DarkGoldenrod"))
(((class color) (min-colors 88) (background dark))
(:foreground "LightGoldenrod"))
(((class color) (min-colors 16) (background light))
(:foreground "DarkGoldenrod"))
(((class color) (min-colors 16) (background dark))
(:foreground "LightGoldenrod"))
(((class color) (min-colors 8))
(:foreground "yellow" :weight light))
(t (:weight bold :slant italic)))
"Gimp Mode face used to highlight variable names."
:group 'gimp-faces)
'(("[A-Z-]\\{3,\\}" . font-lock-constant-face)) )
;;;; Globals
(defconst gimp-email-regexp
(defconst gimp-url-regexp
(defconst gimp-interactive t
"Provide interaction with inferior gimp process?
Leave this a non-nil-val; this might turn into a defcustom one time or
another. Now best left at the non-nil value.")
(defvar gimp-current-procedure nil
"Value of queried procedure in GIMP Help buffer")
(make-variable-buffer-local 'comint-input-filter-functions)
(make-variable-buffer-local 'gimp-current-procedure)
(defvar gimp-mode-line-format
(reduce (lambda (memo this)
(or (and (and memo this)(concat memo "," this)) this memo))
(if gimp-complete-p
(if gimp-complete-fuzzy-p
(when (get 'gimp-trace 'trace-wanted) "tracing")
(and gimp-cl-host (concat gimp-cl-host ":"
(number-to-string gimp-cl-port))))))
"State of various Gimp Mode options.")
(defvar gimp-cl-proc nil
"Gimp Client Process Object")
(defvar gimp-cl-buffer-name "*Gimp-Client*"
"Name of Gimp client buffer.")
(defvar gimp-output ""
"Contains output from inferior gimp process.")
;; (Bases of following caches) generated on GIMP startup (by
;; emacs-interaction.scm)
(defvar gimp-dump nil
"Dump of GIMPs pdb as a hash table.
Access this only through `gimp-get-dump-hash', since it requires
that GIMP run and generate the symbol information for completion
and documentation first.")
(defvar gimp-pdb-cache nil
"Cache containing all symbols in GIMPs Procedural Database.
Access this only through `gimp-get-pdb-cache', for the same
reasons as given by the documentation for `gimp-dump'.")
(defvar gimp-registrations nil)
(defvar gimp-fonts-cache nil
"Cache of available fonts")
(defvar gimp-brushes-cache nil
"Cache of available brushes")
(defvar gimp-patterns-cache nil
"Cache of available patterns")
(defvar gimp-gradients-cache nil
"Cache of available gradients")
(defvar gimp-palettes-cache nil
"Cache of available palettes")
(defvar gimp-oblist-cache nil
"Cache containing ALL symbols in TinyScheme, whether bound or not.
The last might be subject to change.")
(defvar gimp-menu nil)
(defvar gimp-shortcuts nil
"Commands that can be completed from inferior GIMP buffer.
Define such command with `gimp-defcommand' to be automatically included.")
(defvar gimp-help-ring ())
(setf (get 'gimp-help-ring 'gimp-help-positions)
(make-vector 100 1))
(put 'gimp-help-ring 'index 0)
;;;; Customization
(defgroup gimp-directories nil
"Directories where the GIMP finds its sources"
:group 'gimp)
(defcustom gimp-src-dir (expand-file-name "~/Src/gimp-2.6/")
"Source directory for the GIMP.
On Debian(-derivatives), get the source for your distribution with apt-get
source gimp. You will most probably have to change this value."
:group 'gimp-directories
:type 'string)
(defcustom gimp-data-dir "/usr/share/gimp/2.0/"
"Fall-back data dir of the GIMP.
Setting this variable is only necessary for non-interactive use.
Value returned by evaluating the variable `gimp-data-dir' in the GIMP
script-fu console."
:group 'gimp-directories
:type 'string)
(defun gimp-src-dir ()
(if (or
(null gimp-src-dir)
(not (file-exists-p gimp-src-dir)))
(error "%s does not exist. Check variable `gimp-src-dir'"
(or gimp-src-dir "gimp-src-dir"))
(defcustom gimp-docs-alist
'(("script-fu introduction" .
("script-fu tutorial" .
("yahoo script-fu group" . "")
("mailing lists" . "")
("" . "")
("" . "")
("local help" . "file:///usr/share/gimp/2.0/help/en/index.html")
("gimp talk (needs graphical browser)" . "")
("gimp-mode page" . "")
("grokking the gimp" .
("sicp (Structure and Interpretation of Computer Programs)" .
"Alist of gimp documentation URLs."
:group 'gimp
:type '(alist :key-type string :value-type string))
(defcustom gimp-program (if (eq window-system 'w32)
"gimp-2.6.exe" ;Probably... does not
;really matter anyway
"Name of Gimp executable.
If Gimp produces error messages, you may want to define and a
shell script redirecting stderr, something like:
GIMP=`which gimp-2.7`
$GIMP $@ 2>/tmp/gimp-err.log
should do.
This is because Emacs cannot distinguish between stderr and
stdout for subprocesses.
See Info node `(elisp)Output from Processes'."
:group 'gimp
:type '(string))
(defcustom gimp-command-line-args
"-c --batch-interpreter=plug-in-script-fu-eval -b -"
"Arguments to give to the GIMP.
The list below is taken from GIMP version 2.6:
GNU Image Manipulation Program
Application Options:
-v, --version Show version information and exit
--license Show license information and exit
--verbose Be more verbose
-n, --new-instance Start a new GIMP instance
-a, --as-new Open images as new
-i, --no-interface Run without a user interface
-d, --no-data Do not load brushes, gradients, patterns, ...
-f, --no-fonts Do not load any fonts
-s, --no-splash Do not show a startup window
--no-shm Do not use shared memory between GIMP and plugins
--no-cpu-accel Do not use special CPU acceleration functions
--session=<name> Use an alternate sessionrc file
-g, --gimprc=<filename> Use an alternate user gimprc file
--system-gimprc=<filename> Use an alternate system gimprc file
-b, --batch=<command> Batch command to run (can be used multiple times)
--batch-interpreter=<proc> The procedure to process batch commands with
-c, --console-messages Send messages to console instead of using a dialog
--pdb-compat-mode=<mode> PDB compatibility mode (off|on|warn)
--stack-trace-mode=<mode> Debug in case of a crash (never|query|always)
--debug-handlers Enable non-fatal debugging signal handlers
--g-fatal-warnings Make all warnings fatal
--dump-gimprc Output a gimprc file with default settings
--display=DISPLAY X display to use"
:group 'gimp
:type 'string)
(defcustom gimp-inhibit-start-up-message nil
"Inhibit start-up message in Inferior Gimp Mode."
:group 'gimp
:type 'boolean)
(defcustom gimp-just-one-space nil
"When issuing `gimp-space', act as `just-one-space'?"
:group 'gimp
:type 'boolean)
(defcustom gimp-try-and-get-closure-code-p t
"When this variable has a non-nil value, try to get closure
code for echoing. Otherwise, don't. When running in client mode,
this can really make a difference in responsiveness."
:group 'gimp
:type 'boolean)
(defcustom gimp-insert-quotes-for-strings-p t
"Insert quotes when the current argument is a string?
With its value set to nil, gimp-mode will still offer contextual
completion (when possible) when point is in a string."
:group 'gimp
:type 'boolean)
(defcustom gimp-prompt ">"
"Prompt TinyScheme uses.
The prompt used to be >, but Gimp git commit
9541fe03872d15d049c95809fa50b97ce5791129, of Fri Aug 7 2009
changed this to ts>. Presumably to comply with changes in
TinyScheme cvs. What this roughly means is that Gimp 2.7 and
beyond need ts>, not >.
Run-gimp will automagically change this session-wide to ts> if it
deems required, but not back again.
And this is *not* done when connecting to a Gimp server via
:group 'gimp
:type 'string)
;;;; General purpose functions and macros
(defmacro gimp-defcommand (name arglist docstring &rest body)
"Define NAME as a function.
Put its name without the gimp-prefix in variable `gimp-shortcuts'.
The definition is (lambda ARGLIST DOCSTRING BODY...).
If no `interactive' form is used in BODY, an error is signalled."
(declare (indent defun)
(debug defun))
(when (not (stringp docstring))
(error "Error defining %S: docstring seems to be missing" name))
(eval-when (load eval) (add-to-list 'gimp-shortcuts
"^gimp-" "" (symbol-name name))))
(defun ,name (,@arglist)
(when (not (commandp ',name))
(error "Error: function %S defined, but not interactive" ',name))))
(defmacro gimp-hash-to-list (hash-table)
(let ((nl (gensym)))
`(let (,nl)
(maphash (lambda (k v)
(push (list k v) ,nl)) ,hash-table)
(defmacro gimp-list-to-hash (list)
(let ((ht (gensym)))
`(let ((,ht (make-hash-table)))
(mapc (lambda (item)
(puthash (car item) (cadr item) ,ht)) ,list)
(defmacro gimp-without-string (&rest body)
(if (gimp-in-string-p)
(defmacro gimp-without-string-or-comment (&rest body)
(if (gimp-in-string-p)
(if (gimp-in-comment-p)
(defun gimp-string-match (re str &optional num)
(when (string-match re str)
(if num (match-string num str)
(let (result)
(dotimes (v (/ (length (match-data)) 2) (reverse result))
(push (match-string v str) result))))))
(defun gimp-test-recursively (fun list max)
"Test FUN on subsequent items in LIST, for MAX recursions."
((< (decf max) 0))
((endp (cdr list)) t)
((apply fun
(car list)
(list (cadr list)))
(gimp-test-recursively fun (cdr list) max))
(t nil)))
;; Emacs 22 compatibility for rings
(eval-when (compile load)
(when (not (fboundp 'ring-member))
(defun ring-member (ring item)
"Return index of ITEM if on RING, else nil.
Comparison is done via `equal'. The index is 0-based."
(catch 'found
(dotimes (ind (ring-length ring) nil)
(when (equal item (ring-ref ring ind))
(throw 'found ind)))))))
(eval-when (compile load)
(when (not (fboundp 'ring-next))
(defun ring-next (ring item)
"Return the next item in the RING, after ITEM.
Raise error if ITEM is not in the RING."
(let ((curr-index (ring-member ring item)))
(unless curr-index (error "Item is not in the ring: `%s'" item))
(ring-ref ring (ring-plus1 curr-index (ring-length ring)))))))
;; Adapted from elmo-util.el
(defun gimp-uniq-list! (lst)
"Destructively uniquify elements of LST. Quite fast."
(let ((tmp lst))
(while tmp
(setq tmp
(setcdr tmp
(and (cdr tmp)
(car tmp)
(cdr tmp)))))))
(defun gimp-regular-files-in-dir (dir)
"List all regular files in DIR, "
(loop for f in (directory-files dir t)
when (file-regular-p f)
collect f))
(defun gimp-de-underscore (list-or-item)
"Return LIST-OR-ITEM with all underscores recursively eradicated."
(cond ((listp list-or-item)
(loop for i in list-or-item
when (not (eq '_ i))
collect (gimp-de-underscore i)))
(t list-or-item)))
(defun gimp-buffer-window (buffer)
(lambda (w)
(eq (window-buffer w)
(get-buffer buffer)))))
;;;; Keybindings
;; menu "mixin"
(defvar gimp-menu-map
(let ((m (make-sparse-keymap)))
(define-key m [menu-bar gimp]
(cons "Gimp" (make-sparse-keymap "gimp-mode")))
(define-key m [menu-bar gimp gimp-documentation]
(cons "Related documentation" 'gimp-documentation))
(define-key m [menu-bar gimp gimp-report-bug]
(cons "Report a bug in gimp-mode" 'gimp-report-bug))
(define-key m [menu-bar gimp gimp-open-image]
(cons "Open image" 'gimp-open-image))
(define-key m [menu-bar gimp gimp-list-snippets]
(cons "List snippets" 'gimp-list-snippets))
(define-key m [menu-bar gimp gimp-toggle-completion]
(cons "Toggle completion" 'gimp-toggle-completion))
(define-key m [menu-bar gimp gimp-toggle-fuzzy-completion]
(cons "Toggle fuzzy completion" 'gimp-toggle-fuzzy-completion))
(define-key m [menu-bar gimp gimp-code-search]
(cons "Search for source code" 'gimp-code-search))
(define-key m [menu-bar gimp gimp-apropos]
(cons "Apropos GIMP procedure" 'gimp-apropos))
(define-key m [menu-bar gimp gimp-menu]
(cons "Find procedure through GIMP menu structure" 'gimp-menu))
(define-key m [menu-bar gimp gimp-describe-procedure]
(cons "Describe procedure" 'gimp-describe-procedure))
(define-key m [menu-bar gimp gimp-help]
(cons "Gimp Help" 'gimp-help))
(define-key m [menu-bar gimp gimp-run]
(cons "Run the GIMP" 'run-gimp))
(defvar inferior-gimp-mode-map
(let ((m (copy-keymap inferior-scheme-mode-map)))
(define-key m "\t" 'gimp-indent-and-complete)
(define-key m " " 'gimp-space)
(define-key m "\C-c," 'gimp-describe-this-arg)
(define-key m "\C-c." 'gimp-echo)
(define-key m "\C-cf" 'gimp-describe-procedure)
(define-key m "\C-ca" 'gimp-apropos)
(define-key m "\C-ch" 'gimp-help)
(define-key m "\C-cd" 'gimp-documentation)
(define-key m "\C-cs" 'gimp-code-search)
(define-key m "\C-cm" 'gimp-menu)
(define-key m "\C-m" 'gimp-send-input)
(define-key m "\M-\\" 'comint-dynamic-complete-filename)
(define-key m "\C-cr" 'gimp-toggle-fuzzy-completion)
(define-key m "\C-cc" 'gimp-toggle-completion)
(define-key m [mouse-1] 'gimp-insert-input)
(define-key m [mouse-2] 'gimp-insert-input)
(if (featurep 'fud)
(define-key m [(down-mouse-3)]
(defvar gimp-mode-map
(let ((m (copy-keymap scheme-mode-map)))
(define-key m "\t" 'gimp-indent-and-complete)
(define-key m " " 'gimp-space)
(define-key m "\C-x\C-e" 'gimp-send-last-sexp)
(define-key m "\C-c," 'gimp-describe-this-arg)
(define-key m "\C-c." 'gimp-echo)
(define-key m "\C-ch" 'gimp-help)
(define-key m "\C-cf" 'gimp-describe-procedure)
(define-key m "\C-ca" 'gimp-apropos)
(define-key m "\C-cd" 'gimp-documentation)
(define-key m "\C-cs" 'gimp-code-search)
(define-key m "\C-cm" 'gimp-menu)
(define-key m "\C-ci" 'run-gimp)
(define-key m "\C-cr" 'gimp-toggle-fuzzy-completion)
(define-key m "\C-cc" 'gimp-toggle-completion)
(define-key m "\M-\\" 'comint-dynamic-complete-filename)
(if (featurep 'fud)
(define-key m [(down-mouse-3)]
(defvar gimp-help-mode-map
(let ((m (copy-keymap outline-mode-map)))
(define-key m "\C-m" 'gimp-help-enter)
(define-key m "\t" 'gimp-next-field)
(define-key m [(backtab)]
(lambda (n)
"Hop fields backwards."
(interactive "p")
(gimp-next-field (- n))))
(define-key m " " 'gimp-space)
(define-key m "," 'gimp-echo-at-point)
(define-key m "f" 'gimp-help-forward)
(define-key m "b" 'gimp-help-back)
(define-key m "F" 'gimp-describe-procedure)
(define-key m "a" 'gimp-apropos)
(define-key m "q" 'bury-buffer)
(define-key m "p" 'previous-line)
(define-key m "n" 'next-line)
(define-key m "i" 'run-gimp)
(define-key m "d" 'gimp-documentation)
(define-key m "s" 'gimp-code-search)
(define-key m "m" 'gimp-menu)
(define-key m "i" 'gimp-insert-sexp-at-repl)
(define-key m "t" 'outline-toggle-children)
(define-key m "S" 'gimp-selector)
(define-key m "\C-cf" 'gimp-describe-procedure)
(define-key m "\C-ca" 'gimp-apropos)
(define-key m "\C-ch" 'gimp-help)
(define-key m "\C-cd" 'gimp-documentation)
(define-key m "\C-cs" 'gimp-code-search)
(define-key m "\C-cm" 'gimp-menu)
(setq inferior-gimp-mode-map
(append gimp-menu-map (cdr inferior-gimp-mode-map)))
(setq gimp-mode-map
(append gimp-menu-map (cdr gimp-mode-map)))
(setq gimp-help-mode-map
(append gimp-menu-map (cdr gimp-help-mode-map)))
(define-key gimp-help-mode-map
(lambda ()
"Put point where mouse is, and do what ENTER does at that spot."
(let ((event (read-event)))
(mouse-set-point event)
(defun gimp-help-enter (&optional event)
"Dispatch enter key or mouse click in GIMP Help buffer.
Optional argument EVENT is a mouse event."
(cond ((or (eq (field-at-pos (point)) 'submenu)
(eq (field-at-pos (1+ (point))) 'submenu))
(gimp-submenu-at-point (point))))
((or (eq (field-at-pos (point)) 'procedure)
(eq (field-at-pos (1+ (point))) 'procedure))
(let ((char (read-char "Insert at REPL or search source code [is]: ")))
(case char
(?i (gimp-insert-sexp-at-repl))
(?s (gimp-code-search (symbol-name (gimp-procedure-at-point)))))))
(gimp-describe-procedure (gimp-procedure-at-point t)))
((or (eq (field-at-pos (point)) 'email)
(eq (field-at-pos (1+ (point))) 'email))
(mail nil (field-string-no-properties (1+ (point)))
(symbol-name gimp-current-procedure)))
((or (eq (field-at-pos (point)) 'url)
(eq (field-at-pos (1+ (point))) 'url))
(browse-url (field-string-no-properties (1+ (point)))))
((or (eq (field-at-pos (point)) 'function)
(eq (field-at-pos (1+ (point))) 'function))
(let ((str (field-string-no-properties (1+ (point)))))
(gimp-describe-procedure (substring str 1 (1- (length str))))))
((or (eq (field-at-pos (point)) 'forward)
(eq (field-at-pos (1+ (point))) 'forward))
((or (eq (field-at-pos (point)) 'back)
(eq (field-at-pos (1+ (point))) 'back))
(t (error "Nothing to do at point"))))
(defun gimp-space (n)
"Dispatch space to DWIM actions:
- in help (apropos) mode: echo documentation and move to next line
- in other modes:
- when in a string: insert N spaces
- otherwise: echo documentation
Note that - though this is not handled by this command - if space
is entered after a snippet abbreviation (see
`gimp-list-snippets'), a snippet is inserted in a gimp-mode
(interactive "p")
(cond ((eq major-mode 'gimp-help-mode)
(if (gimp-describe-procedure-at-point)
(unless (= (point-at-eol) (point-max))
(call-interactively 'next-line))
(scroll-up n)))
(if gimp-just-one-space
(just-one-space n)
(self-insert-command n))
;; Notify delete-selection-mode that gimp-space should act like what a space
;; event would do, that is, if/when delete-selection-mode is activated by the
;; user:
(put 'gimp-space 'delete-selection t)
;;;; Set up the modes
(define-derived-mode gimp-mode scheme-mode "GIMP mode"
"Mode for editing script-fu and interacting with an inferior gimp process."
(use-local-map gimp-mode-map)
(abbrev-mode 1)
(add-to-list 'mode-line-process gimp-mode-line-format t)
(setq indent-line-function 'lisp-indent-line)
(if (null gimp-oblist-cache)
(setf ;turn off CASE-FOLD in
;font-lock search
(caddr font-lock-defaults) nil))
(define-derived-mode inferior-gimp-mode inferior-scheme-mode
"Inferior GIMP"
"Mode for interaction with inferior gimp process."
(use-local-map inferior-gimp-mode-map)
(setq comint-input-filter-functions
(add-to-list 'mode-line-process gimp-mode-line-format t))
;;;; Versioning
(defvar gimp-version "1.54"
"Gimp Mode version")
(gimp-defcommand gimp-gimp-mode-version ()
"Version of this mode."
(if (interactive-p)
(prog1 nil
(message "GIMP mode version: %s" gimp-version))
(defalias 'gimp-mode-version 'gimp-gimp-mode-version)
(gimp-defcommand gimp-gimp-version ()
"Version of the GIMP."
(destructuring-bind (version major minor rev)
(gimp-eval "(car (gimp-version))"))
(when (interactive-p)
(message "GIMP version: %s" version))
(list version major minor rev)))
(defun gimp-check-version-compatibility ()
(let ((m (string-match "\\([0-9]\.[0-9]\\)\\(\.exe\\)?$" gimp-program)))
(when (and m
(string-match (concat (match-string 1 gimp-program) "$")
(message "Version of `gimp-program' and `gimp-dir' \
do not match, this is probably an error, please correct"))))
;;;; Evaluation
(defmacro in-gimp (body)
"Evaluate fu sexps without having to quote them. Syntactic sugar.
Argument BODY is a SCHEME sexp. Caveats:
1. Inclusion of literal Scheme vectors is impossible. This is due to read
syntax of Emacs lisp and the use of [] in scheme as if they were
parentheses. Be sure to use portable (vector elem1 elem2...) if you want to
make a vector in SCHEME with `in-gimp'.
2. As body must be a single sexp, use (begin ...) in your scheme code.
3. Possibly others. Use it lightly."
(format "%S" (backquote ,body))))
;; Core inferior interaction functions
(defun gimp-proc ()
(or (scheme-get-process)
(defun gimp-filter (proc string)
"Filter for inferior gimp-process."
(setq gimp-output
(replace-regexp-in-string "Eval" "" (concat gimp-output string))))
(defun gimp-set-comint-filter ()
(defun gimp-comint-filter (proc string)
(gimp-filter proc string)
(when (featurep 'fud)
(fud-find-reference string)
(fud-echo-value string)
(setq string (fud-prettify-code string))))
(let ((string
(concat "\n" gimp-prompt " \nEval: (tracing 0)\nEval: tracing\nEval: 0\nApply to: (0)1")
"" string)))
(condition-case err
(setq string
(replace-regexp-in-string "^\\(?:Apply to\\|Eval\\|Gives\\): .*\n"
(lambda (m)
(aref m 0)
(?E shy)
(?A less-shy)
(?G visited-procedure))))
(error nil))
(replace-regexp-in-string "[]()[]"
(lambda (m)
(gimp-set-face m red)) string))))
(defun scheme-send-string (string &optional newline)
"Send STRING to the scheme process.
When optional argument NEWLINE is non-nil, append a newline char."
(gimp-add-define-to-oblist string)
(concat string (if newline "\n" ""))))
(defun gimp-send-last-sexp (&optional insert)
"Send the previous sexp to the inferior Scheme process."
(interactive "P")
(if (featurep 'fud)
(with-no-warnings (fud-update-breakpoints)))
(let ((result
(save-excursion (backward-sexp) (point)) (point)))))
(message "%s" result)
(when (and insert (not (string-equal result "")))
(insert (substring result 0 -1)))))
(defun gimp-eval (string)
"Eval STRING, and return it read, somewhat, though not fully, elispified.
Best is to craft STRING so that script-fu returns something universal to the
Lisp world."
(let ((output (gimp-eval-to-string string)))
(if (string-match "^#" output) ;unreadable by the lisp reader
(if (string= (concat "#f\n" gimp-prompt " ") gimp-output) ;gimp returned #f
(read (substring output 1))) ;so strip
(read output))))
(defun gimp-eval-to-string (string &optional discard timeout)
"Eval STRING in the GIMP.
With optional argument DISCARD, do not wait van return value.
Throw an error if TIMEOUT seconds have passed. This can be used
to avoid infinite looping. "
;; Apparently `with-local-quit' did not cut it, therefore the timeout
;; option'. Without TIMEOUT, just keep on trying until `gimp-output'
;; matches \"^> $\""; actually, replace > with value of `gimp-prompt'
(setq gimp-output "")
(set-process-filter (gimp-proc) 'gimp-filter)
(scheme-send-string string t)
(unless discard
(let ((time (current-time)))
(not (string-match (concat "^" gimp-prompt " $") gimp-output)) ;prompt has not
;yet returned
(when (and timeout (> (cadr (time-since time)) timeout))
(error "%S Timed out" this-command))
(sit-for .01)) ;keep polling
(substring gimp-output 0 -2)))))
;; Bail early with an error message if the user needs to start the GIMP process:
((not (gimp-proc))
((eq (process-status gimp-cl-proc)
(gimp-cl-eval-to-string string discard))
(t "nil"))) ;strip prompt
(defun gimp-insert-input (event)
"Insert input field at point after prompt.
Argument EVENT is a mouse-event."
(interactive "e")
(mouse-set-point event)
(let ((pos (posn-point (event-end event)))
(with-selected-window (posn-window (event-end event))
(when (eq (field-at-pos pos) 'input)
(setq input (field-string-no-properties pos))))
(comint-insert-input event)
(when (member input gimp-shortcuts)
(insert ?,)))))
(defun gimp-add-define-to-oblist (str)
"Put vars, functions and macros defined by STR in the oblist."
(set-text-properties 0 (length str) nil str)
str 2)))
(if (and var-or-fun (not (member var-or-fun (gimp-get-oblist-cache))))
(push var-or-fun gimp-oblist-cache))))
(defun dotted-to-list (dl)
"'Undot' DL.
Turn DL (of the form (\"a\" \"b\" . \"c\")) into a list of the form (\"a\"
\"b\" \". c\"))."
(cond ((atom (cdr dl))
(cons (car dl)
(if (endp (cdr dl))
(list (format ". %s" (cdr dl))))))
(t (cons (car dl)
(dotted-to-list (cdr dl))))))
(defun gimp-insert-and-send-string (string)
"In *GIMP* buffer, set the current string to STRING."
(switch-to-buffer (process-buffer (gimp-proc)))
(unless (null comint-accum-marker)
(goto-char (point-max))
;; First delete any old unsent string at the end
(or (marker-position comint-accum-marker)
(process-mark (get-buffer-process (current-buffer))))
;; Insert the string
(insert string)
;; Send it
;;;; Help
(defvar gimp-help-visited-pages nil
"List of visited pages.")
(defmacro gimp-help-wrapper (form &rest body)
(when (and
(not (member ,form gimp-help-ring))) ;new branche
(setq gimp-help-ring
(member (nth (get 'gimp-help-ring 'index) gimp-help-ring)
gimp-help-ring)) ;set help ring to history until now
(push ,form gimp-help-ring)
(put 'gimp-help-ring 'index 0)
(aref (get 'gimp-help-ring 'gimp-help-positions)
(1- (length gimp-help-ring)))
(let ((window (gimp-buffer-window "*GIMP Help*")))
(if window
(select-window window)
(when (= (length (window-list)) 1)
(split-window-vertically (round (* .60 (window-height)))))
(other-window 1)
"*GIMP Help*")))
(let (buffer-read-only)
(goto-char (point-max))
(insert "\n\n" (if (< (get 'gimp-help-ring 'index)
(1- (length gimp-help-ring)))
(gimp-button "[back]" back "Back in Help History" link)
(gimp-set-face "[back]" shy))
" "
(if (> (get 'gimp-help-ring 'index) 0)
(gimp-button "[forward]" forward "Forward in Help History" link)
(gimp-set-face "[forward]" shy))
" ")))))
(gimp-defcommand gimp-help ()
"Generic help for Gimp Mode."
(let ((window (get-window-with-predicate
(lambda (w)
(eq (window-buffer w)
(get-buffer "*GIMP Help*"))))))
(if window
(select-window window)
(when (= (length (window-list)) 1)
(split-window-vertically (round (* .6 (window-height)))))
(other-window 1)
"*GIMP Help*")
(if (= (buffer-size) 0)
(let (buffer-read-only)
(gimp-set-face "GIMP Help\n" level1)
(gimp-set-face (concat (make-string (window-width) ?=) "\n") shy)
(gimp-set-face "Keys:\n\n" level2)
"a : gimp-apropos,
F : function query
m : select a procedure via the menu
s : search code
S : gimp-selector\n\n")
(goto-char (point-min)))))))
(defun gimp-next-field (num)
"Hop clickable fields in GIMP Help buffer."
(interactive "p")
(dotimes (n (abs num))
(let ((next-field
(if (< num 0)
(let ((fb (field-beginning (point) t)))
(if (<= fb (point-min))
(field-beginning (1- fb) t)))
(1+ (field-end (point) t)))))
(if (or (>= next-field (point-max))
(>= (field-end next-field) (point-max))
(<= next-field (point-min)))
(error "No next field")
(goto-char next-field))
(when (member (field-at-pos (point))
'(email url procedure))
(backward-char 1))
(when (null (field-at-pos (1+ (point))))
(gimp-next-field 1)))))
(gimp-defcommand gimp-menu (&optional submenu)
"Navigate through GIMP menu structure.
Optional argument SUBMENU defines the default content of the minibuffer."
(let* ((entry (completing-read "Select by menu entry: "
(mapcar 'cadr gimp-menu)
nil t (or submenu "<")))
(plug-in (car (rassoc* entry gimp-menu :key 'car :test 'string=))))
(gimp-describe-procedure plug-in)))
(defun gimp-insert-menu-path ()
(insert (completing-read "Insert menu entry: "
(mapcar 'cadr gimp-menu)
nil nil "<")))
(defun gimp-submenu-at-point (pos)
"Return submenu at POS."
(goto-char pos)
(do ((string (field-string-no-properties (1+ (point)))
(concat (field-string-no-properties) "/" string)))
((progn (goto-char (1- (field-beginning)))
(not (eq (field-at-pos (point)) 'submenu)))
(concat (replace-regexp-in-string "/*$" "" string) "/")))))
(defun gimp-insert-sexp-at-repl ()
"Insert sexp at point at the GIMP REPL.
Deletes any previous stuff at that REPL"
(let ((sexp (thing-at-point 'sexp)))
(when sexp
(switch-to-buffer-other-window (gimp-buffer))
(goto-char (point-max))
;; First delete any old unsent input at the end
(or (marker-position comint-accum-marker)
(process-mark (get-buffer-process (current-buffer))))
(set-text-properties 0 (length sexp) () sexp)
;; Insert the input at point
(insert sexp))))
(defun gimp-help-refresh ()
(eval (nth 0 gimp-help-ring)))
;;;; Stuff pertaining to running 'n' quitting
(defun run-gimp (override-p)
"Start the GIMP and its REPL.
With prefix argument OVERRIDE-P, prompt for executable and
(interactive "P")
(setq gimp-output "")
(let ((gimp-program
(if override-p
(read-file-name "Gimp executable: " "/" nil t gimp-program)
(if override-p
(read-from-minibuffer "Run with arguments: " gimp-command-line-args)
(if override-p
(let ((configuration-dir
"Gimp configuration directory\
(shall be set for this Emacs session): " "~/" nil t gimp-dir)))
(customize-set-variable 'gimp-dir (expand-file-name configuration-dir))
(if (not (file-exists-p (expand-file-name
(concat gimp-dir
(if (y-or-n-p "Gimp-mode was not installed in that directory,\
install it there? ")
(gimp-install gimp-dir)
(error "Backing out")))))
(if (buffer-live-p (gimp-buffer))
(if (gimp-buffer-window (gimp-buffer))
(select-window (gimp-buffer-window (gimp-buffer)))
(switch-to-buffer-other-window (gimp-buffer)))
(if (eq window-system 'w32)
(message "Probably no interaction possible here,\
see `gimp-cl-connect' to connect as a client to the GIMP script-fu server"))
(run-scheme (concat gimp-program " " gimp-command-line-args))
(lambda (p s)
(if (string-match "finished" s)
(error "Probably the GIMP is already running.
Either close that instance, add the -e switch to `gimp-command-line-args',
or run command `gimp-cl-connect'.")
(message s))))
(switch-to-buffer (gimp-buffer))
(setq buffer-read-only t))
(defun gimp-first-run-action (proc string)
;; Seed the gimp-output with what has been seen so far in the process
;; buffer, so that the call to gimp-progress below can detect if the prompt
;; has happened quickly (to prevent a hang otherwise):
(setq gimp-output
(gimp-set-comint-filter) ;set comint filter for subsequent input
(lambda (p s)
(when (string-match "finished" s)
(kill-buffer (gimp-buffer))
(message "GIMP process ended."))))
(with-current-buffer (gimp-buffer)
(let (buffer-read-only) ;make the buffer capable
;of receiving user input etc.
(insert string)
(unless (string= (buffer-name)
(rename-buffer "*GIMP*"))
(setq scheme-buffer (current-buffer))
(gimp-progress (concat (current-message)
"...waiting to finish (C-g to quit) ...")
(lambda ()
(when (and
(not (string-match "ts>" gimp-prompt))
(string-match "^ts> " gimp-output))
(setq gimp-prompt "ts>"))
(not (string-match (concat "^" gimp-prompt " ") gimp-output)))
(unless gimp-inhibit-start-up-message
(gimp-shortcuts t))
(process-put (gimp-proc) 'listening t)
(message "%s The GIMP is loaded. Have FU." (or (current-message) ""))))
(setq buffer-read-only nil)))
(defun gimp-progress (message test &optional end-text)
"Show MESSAGE with rotating thing at end while TEST yields a non-nil value.
Optional argument END-TEXT is the text appended to the message when TEST fails."
(let ((r (make-ring 4)))
(mapc (lambda (i)
(ring-insert r i))
'(45 47 124 92))
(message "%s" (concat message "/"))
(while (funcall test)
(let* ((mess (or (current-message) (concat message "/")))
(last-char (string-to-char
(substring mess (1- (length mess))
(length mess)))))
(if (not (ring-member r last-char))
(setq last-char 45))
(message "%s%c" (substring mess 0 (1- (length mess)))
(ring-next r last-char))
;; Discard any terminal input if sit-for returned immediately, thus forcing
;; the gimp-filter function to get called with any new pending process
;; input. What effect this has on the C-g quiting aspect is not known
;; at this point:
(if (not (sit-for .15))
(if end-text (message "%s%s" (current-message) end-text))))
(defalias 'gimp-start 'run-gimp
"Alias so people gimp-TABbing can find `run-gimp'")
(gimp-defcommand gimp-quit ()
"Quit gimp session."
(if (gimp-buffer)
(gimp-eval-to-string "(gimp-quit 0)" t)
(kill-buffer (gimp-buffer))
(message "GIMP process ended.")
(setq gimp-output ""))
(message "GIMP process was not started.")))
;;;; Utility functions
(defun gimp-buffer ()
(let ((proc (gimp-proc)))
(if proc
(process-buffer (gimp-proc))
(get-buffer "*GIMP*"))))
(defun gimp-latest-source-buffer ()
"Return latest visited source buffer.
Return nil if none or only one, being the current
buffer, is found."
(let* ((this-buffer (current-buffer))
(buffer (car
(lambda (b)
(with-current-buffer b
(and (eq major-mode 'gimp-mode)
(not (eq b this-buffer)))))
(defun gimp-dir ()
(if (not (gimp-interactive-p))
(gimp-eval "gimp-dir")))
(defun gimp-data-dir ()
(if (gimp-interactive-p)
(in-gimp gimp-data-dir)
(defun gimp-all-scm-files ()
"Produce a list of all script-fu files."
(loop for f in
(lambda (memo dir)
(append memo (gimp-regular-files-in-dir dir)))
(list (format "%s/scripts" (gimp-data-dir))
(format "%s/scripts" (gimp-dir)))
:initial-value nil)
when (string-match "\.scm\\'" f)
collect f))
(defun gimp-up-string ()
"Move point to a place presumable not in a string."
(when (re-search-backward "[^\\]\"" nil t)
(forward-char 1)))
(defun gimp-up-comment ()
"Move point to a place presumable not in a comment."
(while (gimp-in-comment-p)
(backward-char 1)))
(defun gimp-beginning-of-sexp ()
(let ((parse-sexp-ignore-comments t))
(condition-case err
(while (progn
(forward-sexp -1)
(or (= (char-before) ?\")
(not (bobp)))))
(error nil))))
(defun gimp-interactive-p ()
"Is gimp being run as a subprocess?"
(get-buffer scheme-buffer)
(comint-check-proc scheme-buffer)))
(defvar gimp-error-must-run-gimp-error-message
"You must execute `run-gimp' one time at least,\
in order to populate symbol completion tables from within GIMP."
"Error message to emit when the user must run GIMP first\
to populate symbol completion tables.")
(defun gimp-error-must-run-gimp ()
(error gimp-error-must-run-gimp-error-message))
(defun gimp-get-dump-hash ()
(if gimp-dump
(defun gimp-get-pdb-cache ()
(if gimp-pdb-cache
(defun gimp-get-oblist-cache ()
(unless gimp-oblist-cache
(defun gimp-procedure-at-point (&optional as-string)
(let ((sym (when (gethash (symbol-at-point) (gimp-get-dump-hash))
(when sym
(if as-string
(list sym)))))
(defun gimp-current-symbol ()
(let ((c (char-after (point))))
(and c
(memq (char-syntax c) '(?w ?_))
(read (current-word)))))
(defun gimp-fnsym-in-current-sexp ()
(let ((p (point)))
(when (not (looking-back ",[[:alnum:]- ]+"))
(with-syntax-table scheme-mode-syntax-table
(not (bobp))
(let ((m (when (gimp-proc)
(process-mark (gimp-proc)))))
(or (not m)
(eq (marker-buffer m)
(not (= (point)
(marker-position m)))
t))) ;no rules for other types of buffers.
(when (eq (char-syntax (char-before)) ?\")
(backward-sexp 1)
(memq (char-syntax (char-before)) '(?w ?_ 32 ?- ?\" ?> ?'))
(when (memq (char-syntax (char-before)) '(?\)))
(backward-sexp 1)
(forward-char -1)))
;; Return nil if current word is actually:
(= (or (char-after (1- (point))) 0) ?\") ;at a string
(bobp) ;or at beginning of buffer
(number-at-point)) ;or beginning with a number -
;hence no symbol.
(goto-char p))))))
(defun gimp-position ()
"Return position of point in current lambda form."
(if (bolp) ;correct, but does not intercept all possible
;0-positions, of course
(let ((count 0))
(if (not (looking-at "[ \n\t)(\"']+"))
(forward-sexp 1))
(if (looking-back "[ \n\t)(]+")
(incf count))
(while (not (or (looking-back (rx "(" (* (or "\n" white))))
(looking-back comint-prompt-regexp)))
(backward-sexp 1)
(incf count))
(decf count)))))
;; adapted from scheme-in-string-p in scheme-complete.el
(defun gimp-in-string-p ()
"Is (point) in a string?"
(let ((orig (point)))
(let ((parses (parse-partial-sexp (point) orig)))
(nth 3 parses)))))
(defun gimp-in-comment-p ()
"Is (point) in a string?"
(let ((orig (point)))
(let ((parses (parse-partial-sexp (point) orig)))
(nth 4 parses)))))
(defun gimp-save-scm-files ()
"Ask user to save modified scheme files."
(save-some-buffers nil
(lambda ()
(let ((buffer-name (buffer-file-name)))
(and buffer-name
(string-match "\.scm\\'" buffer-name)
;;;; Caches: saving, deleting, restoring
(defun gimp-save-cache (cache)
(with-temp-file (format "%s/emacs-%s" (gimp-dir) cache)
(let ((cache (symbol-value cache)))
(insert (format "%S" (if (hash-table-p cache)
(gimp-hash-to-list cache)
(defun gimp-restore-cache (cache &optional to-hash prefix)
"Restore cache from disk.
Argument CACHE is the cache to restore.
Optional argument TO-HASH means convert the list to a hash.
Optional argument PREFIX specifies a prefix for the filename."
(let* ((prefix (or prefix "/emacs/emacs-"))
(file (format "%s/%s%s" (gimp-dir) prefix cache)))
(when (file-exists-p file)
(find-file-literally file)
; (goto-char (point-min))
(set cache (prog1 (read (buffer-substring (point-min) (point-max)))
(kill-buffer nil)))
(when to-hash (set cache (gimp-list-to-hash (symbol-value cache))))))
(symbol-value cache)))
(defun gimp-restore-caches ()
"Restore caches from disk.
Normally this function needn't be run interactively, lest a cache has been
screwed up. It is wise then to preceed it with a call to
(when (or (not (file-exists-p (concat (gimp-dir) "/emacs/")))
(not (file-directory-p (concat (gimp-dir) "/emacs/"))))
(make-directory (concat (gimp-dir) "/emacs/"))
(message "Reading in caches...(C-g to quit) ")
(mapc 'gimp-restore-cache
(setq gimp-oblist-cache
(mapcar 'symbol-name
(condition-case err
(error (gimp-report-bug err)))
(message "%s%s" (current-message) "Done!"))
(defun gimp-dump-file ()
(expand-file-name "dump.db" (gimp-dir)))
(defun gimp-read-dump ()
(let ((gimp-dump-file (gimp-dump-file))
(ht (make-hash-table :test 'eql)))
;; If gimp-dump-file does not exist, then GIMP has not been executed yet,
;; which is required in order for the file to be generated by the
;; emacs-interaction.scm file inside GIMP. But at Emacs startup, we may be
;; asked to read the dump file, but we will silently ignore that request
;; here if the dump.db file does not already exist. Later on, when the user
;; executes one of Gimp Modes commands that requires symbol
;; completion, then we will throw an error that reminds them that they have
;; to run the GIMP one time at least in order to dump this file out. Note
;; that the accessing of gimp-dump or gimp-pdb-cache should be guarded with
;; the proper check by calling gimp-get-dump-hash and gimp-get-pdb-cache,
;; respectively, instead directly accessing the variables, except of course
;; here where we update their values:
(when (file-exists-p gimp-dump-file)
(insert-file-contents gimp-dump-file)
(mapc (lambda (i)
(puthash (intern (cadr i))
(cddr i)
(read (concat
(point-min) (point-max))
(setq gimp-dump ht)
(setq gimp-pdb-cache (let (list)
(maphash (lambda (k v)
(push (symbol-name k) list))
;; Input ring
(defun gimp-save-input-ring ()
"Save the input ring for subsequent sessions."
(when (gimp-buffer)
(let ((r
(with-current-buffer (gimp-buffer) comint-input-ring)))
(with-temp-file (format "%s/emacs/emacs-%s" (gimp-dir) "comint-input-ring")
(insert (format "%S" r))))))
(defun gimp-restore-input-ring ()
(with-current-buffer (gimp-buffer)
(gimp-restore-cache 'comint-input-ring)
(if (null comint-input-ring)
(set 'comint-input-ring (make-ring 65)))))
(defun gimp-scrape-fu-registrations ()
(let (result)
(lambda (f)
(insert-file-contents-literally f)
nil t)
(with-syntax-table scheme-mode-syntax-table
(up-list -1)
(push (gimp-de-underscore
(cdr (sexp-at-point))) result)
(forward-sexp 1)))))
(defun gimp-registrations ()
(defun gimp-arg-from-scraped-registration (pos procstr)
(let* ((defaults (loop for specs in
(assoc procstr
collect specs))
(options (nth (1- (* 3 (1+ pos))) defaults))
(type (nth (* 3 pos) defaults)))
((listp options)
(case type
(mapcar* 'list
'(init lower upper step_inc page_inc digits type)
(cadr options)))
(cadr options))
(t (cadr options))))
(t (list options)))))
(defun gimp-dump-for-emacs ()
"Dump stuff for emacs."
(let ((command
"(car (script-fu-dump-for-emacs TRUE TRUE TRUE TRUE TRUE TRUE TRUE))"))
(if (eq this-command 'gimp-send-input)
(message "Dumping stuff...")
(gimp-eval command))))
(defun gimp-refresh-all ()
"Update both the GIMP's and GIMP Mode's knowledge on all scripts and symbols."
(get-buffer "*GIMP Help*")
;;;; Tracing
(gimp-defcommand gimp-trace ()
"Start tracing FU.
Only for REPL input."
(when (gimp-cl-p)
(error "Tracing in client mode unimplemented"))
(message "Tracing turned on")
(put 'gimp-trace 'trace-wanted t))
(gimp-defcommand gimp-untrace ()
"Stop tracing FU.
Only for REPL input."
(when (gimp-cl-p)
(error "Tracing in client mode unimplemented"))
(gimp-eval "(tracing 0)\n")
(message "Tracing turned off")
(put 'gimp-trace 'trace-wanted nil))
;;;; Modes
(define-derived-mode gimp-help-mode outline-mode "GIMP Help"
"Help mode for the GIMP."
(use-local-map gimp-help-mode-map)
(setq buffer-read-only t)
(setq buffer-undo-list t)
(if (null gimp-oblist-cache)
(gimp-defcommand gimp-documentation ()
"Shortcut to (online) documentation.
See variable `gimp-docs-alist'"
(let ((doc (completing-read "Documentation: " gimp-docs-alist nil t)))
(browse-url (cdr (assoc doc gimp-docs-alist)))))
;; (defun gimp-apropos-list (input)
;; (loop for i in (sort (mapcar (lambda (l)
;; (symbol-name (car l)))
;; (gimp-hash-to-list (gimp-get-dump-hash))) 'string<)
;; when (string-match input i)
;; collect i))
;; (defun gimp-apropos-list-by-key (key value)
;; (let* ((lookup '(short long author copyright date type))
;; (pos (- 6 (length (member key lookup))))
;; result)
;; (maphash (lambda (k v)
;; (if (string-match value (nth pos v))
;; (push (symbol-name k) result)))
;; (gimp-get-dump-hash))
;; (sort result 'string<)))
(defun gimp-real-apropos (value)
(let (result)
(lambda (k v)
(if (or
(lambda (thing)
(and (stringp thing)
(string-match (concat "\\<" value "\\>") thing))) v)
(string-match value (symbol-name k)))
(push (symbol-name k) result)))
(sort result 'string<)))
(gimp-defcommand gimp-apropos (&optional query)
"Search pdb for submatch of QUERY.
It will find any procedure whose name matches QUERY in any way.
It will also find any procedure in the description of which QUERY
matches a whole word.
If QUERY matches only a part of a word of that description, it
will therefore not match."
(let* ((query (or query (read-from-minibuffer "Apropos query: " )))
(lambda (proc)
(if (not (string= query ""))
"^ ") ;do not bother when matching anything
(lambda (m)
(gimp-set-face m less-shy))
(propertize proc
(if (member (read proc)
(gimp-real-apropos query) "\n")))
(if (> (length new-contents) 0)
`(gimp-apropos ,query)
(gimp-set-face (format "GIMP procedures apropos %S\n"
(if (string= "" query)
(gimp-set-face (make-string (window-width) ?=) shy)
(goto-char (point-min))
(forward-line 2))
(message "No match"))))
(defun gimp-help-back ()
"Select last shown GIMP Help page.
Go back one page in GIMP Help, and set current page to be the last one
(setf (aref (get 'gimp-help-ring 'gimp-help-positions)
(- (length gimp-help-ring)
(get 'gimp-help-ring 'index)))
(put 'gimp-help-ring
(1- (length gimp-help-ring))
(1+ (get 'gimp-help-ring 'index))))
(aref (get 'gimp-help-ring 'gimp-help-positions)
(- (length gimp-help-ring)
(get 'gimp-help-ring 'index)))))
(defun gimp-help-forward ()
"Select last shown GIMP Help page.
Go back one page in GIMP Help, and set current page to be the last one
(setf (aref (get 'gimp-help-ring 'gimp-help-positions)
(- (length gimp-help-ring)
(get 'gimp-help-ring 'index)))
(put 'gimp-help-ring
(1- (get 'gimp-help-ring 'index))))
(aref (get 'gimp-help-ring 'gimp-help-positions)
(- (length gimp-help-ring)
(get 'gimp-help-ring 'index)))))
(defun gimp-describe-procedure-at-point ()
(let ((proc (gimp-procedure-at-point)))
(when proc
(gimp-echo-procedure-description proc))))
(gimp-defcommand gimp-describe-procedure (&optional proc)
"Describe function in current sexp, or the one at point.
This is a full description, similar to the one in the GIMP pdb browser.
The description is shown in the *GIMP Help* buffer.
If the procedure is menu-registered, the submenus shown can be followed (by
clicking or pressing ENTER), to have a shortcut into the command `gimp-menu'
for like procedures.
You can also follow email addresses and urls.
One can TAB through these followable fields.
Use `outline-mode' commands to navigate and fold stuff.
Optional argument PROC is a string identifying a procedure."
(let* ((pdb-cache (gimp-get-pdb-cache))
(gimp-procedure-at-point t)
(car (member (symbol-name
(gimp-fnsym-in-current-sexp)) pdb-cache))
(completing-read "Procedure: " pdb-cache nil t
(if (gethash (symbol-at-point) (gimp-get-dump-hash))
(symbol-name (symbol-at-point))))))))
(add-to-list 'gimp-help-visited-pages sym)
`(gimp-describe-procedure ,(symbol-name sym))
(gimp-headline sym)
(gimp-menu-bar sym)
(gimp-summary sym)
(gimp-argument-listing sym)))
(setq gimp-current-procedure sym)))
(goto-char (point-min)))
(defun gimp-headline (procedure)
"Return headline for PROCEDURE."
(format "%s%s %s\n%s\n"
(gimp-set-face "* " shy)
(gimp-set-face "GIMP proc: " level1)
(gimp-button (symbol-name procedure)
"i : insert symbol at REPL
s : search source code for symbol"
(gimp-set-face (make-string (window-width) ?=) shy)))
(defun gimp-summary (procedure)
"Return a summary for PROCEDURE."
(let ((case-fold-search t))
(lambda (match)
(if (member (match-string 1 match) (gimp-get-pdb-cache))
(gimp-button match
"Follow link"
(read (match-string 1 match))
(lambda (match)
(gimp-button match url "Follow link" link))
(lambda (match)
(gimp-button match email "Mail author" link))
(gimp-procedure-description procedure))))))
(defun gimp-menu-bar (procedure)
"Return a menu bar for PROCEDURE."
(let ((menu (cadr (assoc (symbol-name procedure) gimp-menu))))
(if (null menu)
(setq menu (nreverse (split-string menu "/")))
(reverse (mapcar
(lambda (submenu) ;
"Find more plugins under this submenu"
(cdr menu)))
(gimp-set-face "/" shy))
(gimp-set-face "/" shy)
(gimp-set-face (car menu) terminal-menu)))))
(defun gimp-argument-listing (procedure)
"Make a list of argument descriptions for PROCEDURE."
(let ((count 0))
(let ((desc2 (car (cddr argument))))
(when (string-match "@{.*@}" desc2)
(setq desc2
(replace-regexp-in-string " @{ " ":\n\n" desc2))
(setq desc2
(replace-regexp-in-string "@}" "" desc2))
(setq desc2
(lambda (item)
"\\(.+\\) \\(([0-9]+)\\)" item)
(format " %-21s%2s"
(match-string 1 item)
(match-string 2 item))
(split-string desc2 "\\(, \\|\n\\)") "\n")))
(format "%s %s\n%s\n%s"
(gimp-set-face "**" shy)
(format "%-2d %-20s %50s"
(incf count)
"GIMP_PDB_" "" (cadr argument))
(car argument))
(let ((scraped
(1- count)
(symbol-name procedure))))
(if scraped
(concat "\nDefaults:\n"
(lambda (m)
(gimp-set-face m shy))
(format "%S" scraped)
(gimp-get-proc-args procedure)
;;;; Internal information retrieval
(defun gimp-get-proc-arg (proc arg)
(nth arg (gimp-get-proc-args proc)))
(defun gimp-get-proc-description (proc)
(gethash proc (gimp-get-dump-hash)))
(defun gimp-get-proc-args (proc)
(let ((all-args (nth 6 (gimp-get-proc-description proc))))
(if (and (eq (gimp-get-proc-type proc)
(string= (caar all-args)
(cdr all-args)
(defun gimp-get-proc-arg-descriptive-name (sym pos)
(let ((desc (caddr (gimp-get-proc-arg sym pos))))
(lambda (m)
(concat ":" (match-string 1 m)))
(defun gimp-get-proc-type (sym)
(let ((type (nth 5 (gimp-get-proc-description sym))))
((string= type "Temporary Procedure") 'fu)
((string= type "Internal GIMP procedure") 'internal)
((string= type "GIMP Plug-In") 'plug-in)
((string= type "GIMP Extension") 'extension)
(t 'other))))
(defun gimp-get-closure-code (sym)
(when (gimp-proc)
(apply 'format
"(let* ((bound? (symbol-bound? '%s))\
(code (if bound? (get-closure-code %s) #f)))\
(if code (cons '%s (cadr code)) 'nil))"
(make-list 4 sym)) nil 1))))
(defun gimp-procedure-description (sym)
(let ((info (gimp-get-proc-description sym)))
(concat (car info)
(insert (cadr info))
(fill-paragraph t)
(buffer-substring (point-min)
"\n\nAuthor(s): "
(nth 2 info))
"\nCopyright: "
(nth 3 info))
", "
(nth 4 info))))
;;;; Completion
(defcustom gimp-complete-fuzzy-p t
"Perform fuzzy completion?
This is a special implementation of fuzziness to aid in
completion of hyphen-separated symbols that are frequent in lisp.
It lets you type in the first letter(s) of the combining parts of
such symbol. Of course, the basic case of consecutive characters
found anywhere in a target string will match.
Examples of the implementation of fuzziness:
s-f-c-s => script-fu-coffee-stain
stain => script-fu-coffee-stain
scr-f- => script-fu-
s-f--logo => suggestions for script-fu-neon-logo,
script-fu-comic-logo, script-fu-chalk-logo ...
Note on comparison with other fuzzy algorithms:
It does *not* match like symbols, as do other implementations.
Neither does e.g. \"sif\" match \"script-fu\".
You can toggle this variable at any time with the command
Its state is indicated in the mode-line."
:group 'gimp
:type 'boolean)
(defcustom gimp-complete-p t
"Perform completion?
This defines whether or not completion is offered when pressing
You can toggle this variable at any time with the command
:group 'gimp
:type 'boolean)
(defcustom gimp-completion-rules
'(((lambda (desc name type)
(string-match "FLOAT" type))
. nil)
((lambda (desc name &rest type)
(string-match "filename" name))
. (lambda (&rest ignore)
(when (not (gimp-in-string-p))
(insert (format "%S" (expand-file-name "~/")))
(backward-char 1))
((lambda (desc name type)
(and (not (gimp-in-string-p))
(string-match "STRING" type)))
. (lambda (&rest ignore)
(when gimp-insert-quotes-for-strings-p
(insert "\"\"")
(forward-char -1))
(gimp-make-completion (list desc name type))))
((lambda (desc name type)
(string-match "{.*}" desc))
. (lambda (desc &rest ignore)
(split-string desc "\\(.*{ *\\|, \\|([0-9]+)\\|}.*\\|@\\)" t)))
((lambda (desc name type)
(and (string-match "gradient" desc)
(string= type "GIMP_PDB_STRING")))
. (lambda (&rest ignore)
(in-gimp (cadr (gimp-gradients-get-list "")))))
((lambda (desc name type)
(string-match "paint method" desc))
. (lambda (&rest ignore)
(in-gimp (cadr (gimp-context-list-paint-methods)))))
((lambda (desc name type)
(or (string-match "font" name)
(string= "The name of the font" desc)))
. (lambda (&rest ignore)
((lambda (desc name type)
(string-match "pattern" name))
. (lambda (&rest ignore)
((lambda (desc name type)
(string= "procedure-name" name))
. (lambda (&rest ignore)
((lambda (desc name type)
(string= "run-mode" name))
((lambda (desc name type)
(or (string= name "toggle")
(string-match "\\((TRUE or FALSE)\\|toggle\\)"
. ("TRUE" "FALSE"))
((lambda (desc name type)
(string-match "The brush name" desc))
. (lambda (&rest ignore)
((lambda (desc name type)
(or (string-match "palette" desc)
(string= type "GIMP_PDB_PALETTE")))
. (lambda (&rest ignore)
((lambda (desc name type)
(message "%S %S %S" desc name type)
(string= type "GIMP_PDB_IMAGE"))
. (lambda (&rest ignore)
(mapcar number->string
(vector->list (cadr (gimp-image-list)))))))
((lambda (desc name type)
(string-match "color" name))
. (lambda (&rest ignore)
(when (and (not (gimp-buffer-window
(y-or-n-p "List colors? "))
((lambda (desc name type)
(string= "operation" name))
((lambda (desc name type)
(string-match "STRING" type))
. (lambda (&rest ignore)))
((lambda (desc name type)
(string= name "icon-type"))
((lambda (desc name type)
(string= name "decompose-type"))
. ("RGB" "Red" "Green" "Blue" "RGBA" "HSV" "Hue"
"Saturation" "Value" "HSL" "Hue (HSL)" "Saturation (HSL)"
"Lightness" "CMY" "Cyan" "Magenta" "Yellow" "CMYK"
"Cyan_K" "Magenta_K" "Yellow_K" "Alpha" "LAB"
"YCbCr_ITU_R470" "YCbCr_ITU_R709" "YCbCr ITU R470 256"
"YCbCr ITU R709 256"))
((lambda (desc name type)
(string= "GIMP_PDB_DRAWABLE" type))
((lambda (desc name type)
. (lambda (&rest ignore)
"Ruleset for deciding the completion to perform by `gimp-make-completion'.
A rule is list of the form (MATCH-FUNCTION . ACTION-OR-LIST)
These rules are checked in order until a match is found.
If ACTION-OR-LIST is a function, it must provide a list of completion
If ACTION-OR-LIST is a list of the form (\"ELT1\" \"ELT2\" ...) this list will
serve as the candidate pool.
Both the MATCH-FUNCTION and the ACTION-OR-LIST (if an action) take three
arguments pertaining to the argument, in order:
\(description name type)"
:group 'gimp
:type '(alist :key-type function :value-type
(choice (function :tag "Action")
(sexp :tag "List"))))
(defun gimp-indent-and-complete ()
"Indent and complete function or argument at point."
(let ((bolp (bolp)))
(when (not bolp) (gimp-complete))
(defun gimp-current-arg ()
"Return positional information on the current argument.
The output is a list of (BEG END PATTERN), where BEG and END are
its buffer positions and PATTERN is the argument itself."
(with-syntax-table scheme-mode-syntax-table
(let* ((end
(cond ((eobp)
(and (not (eobp))
(memq (char-syntax (following-char)) '(?w ?_ ?\ ))
(forward-char 1)))
((memq (char-syntax (char-after (point))) '(?) ?\" ?( ? ))
(t (while
(and (not (eobp))
(memq (char-syntax (following-char)) '(?w ?_)))
(forward-char 1))
(cond ((gimp-in-string-p)
(re-search-backward "[^\\]\"" nil t)
(forward-char 2)
((memq (char-syntax (char-before (point))) '(?\( ?\ ? ))
(t (while
(memq (char-syntax (char-before)) '(?w ?_))
(forward-char -1))
(pattern (buffer-substring-no-properties beg end)))
(list beg end pattern))))
(defun gimp-complete-savvy (&optional lst)
"Perform completion on script-fu symbol preceding point.
Compare that symbol against the known script-fu symbols.
If no characters can be completed, display a list of possible completions.
Repeating the command at that point scrolls the list.
Optional argument LST specifies a list of completion candidates."
(let ((window (get-buffer-window "*Completions*" 0)))
(if (and (eq last-command this-command)
window (window-live-p window) (window-buffer window)
(buffer-name (window-buffer window)))
;; If this command was repeated, and
;; there's a fresh completion window with a live buffer,
;; and this command is repeated, scroll that window.
(with-current-buffer (window-buffer window)
(if (pos-visible-in-window-p (point-max) window)
(set-window-start window (point-min))
(select-window window)
;; Do completion.
(multiple-value-bind (beg end pattern) (gimp-current-arg)
(and (not (string-equal pattern ""))
(let* ((lst (mapcar (lambda (i)
(if (listp i)
(car i)
;;let the list be possibly of form
;;((matchable . metadata))
(or lst (gimp-get-oblist-cache))))
(if (not gimp-complete-fuzzy-p)
(try-completion pattern lst nil)
(or (gimp-try-fuzzy-completion pattern lst) pattern))))
(cond ((eq completion t))
((null completion)
((not (string= pattern completion))
(delete-region beg end)
(insert completion)
;; Don't leave around a completions buffer that's out of date.
(let ((win (get-buffer-window "*Completions*" 0)))
(if win (with-selected-window win (bury-buffer)))))
(let ((minibuf-is-in-use
(eq (minibuffer-window) (selected-window))))
(unless minibuf-is-in-use
(message "Making completion list..."))
(let ((lst2
(if gimp-complete-fuzzy-p
(all-completions pattern lst nil))))
(if (not gimp-complete-fuzzy-p)
(setq lst2 (sort lst2 'string<)))
(if (> (length lst2) 1)
;; (with-output-to-temp-buffer "*Completions*"
;; (display-completion-list nil))
;set up a good buffer (with
;all them hooks (orig code:)
(with-output-to-temp-buffer "*Completions*"
(display-completion-list lst2))
(gimp-highlight-matches completion
;; Don't leave around a completions buffer that's
;; out of date.
(if (not gimp-complete-fuzzy-p)
(let ((win (get-buffer-window "*Completions*" 0)))
(if win (with-selected-window win (bury-buffer))))
(when (= 1 (length lst))
(delete-region beg end)
(insert (car lst2))))))
(unless minibuf-is-in-use
(message "Making completion list...%s" "done")))))))))))
(defun gimp-complete-oblist (&optional discard)
"Function that always just uses the oblist to complete the symbol at point.
Pushed into `hippie-expand-try-functions-list'."
(case major-mode
((gimp-mode inferior-gimp-mode)
(push 'gimp-complete-oblist hippie-expand-try-functions-list)
(defun gimp-highlight-matches (pattern buffer)
"Propertize PATTERN in the BUFFER."
(unless (string= pattern "")
(switch-to-buffer-other-window buffer)
(let (buffer-read-only)
(while (re-search-forward (gimp-make-fuzzy-match-re pattern) nil t)
(gimp-set-face (match-string 0) level2)))
(goto-char (point-min))
(forward-line 2)
"Press C-cr to toggle fuzzy completion\n")))))
(defun gimp-completable-at-p ()
"Check whether thing at p is completable."
(let ((fun (gimp-fnsym-in-current-sexp)))
(and fun (gethash fun (gimp-get-dump-hash)))))
(defun gimp-complete ()
"Main completion function."
(unless (and (not (interactive-p))
(not gimp-complete-p))
(let* ((fun (gimp-fnsym-in-current-sexp))
(pos (gimp-position))
(if gimp-complete-fuzzy-p
(symbol-name fun)
(mapcar (lambda (i)
(symbol-name (car i)))
(cadr (gimp-string-match "^,\\([[:alpha:]-]*\\)"
(num-args (gimp-get-proc-args fun))
(function-already-complete (not (null num-args))))
(gimp-complete-savvy gimp-shortcuts))
;; If the function is already complete, but there are no arguments, then
;; there is nothing to complete:
((and function-already-complete (= 0 (length num-args)))
((and fun (> pos (length num-args)))
(= pos 0)
(cdr all-completions))
;; not really an error, but I want to back out:
(error "[Complete, but not unique: %S]" fun))
(= pos 0)
(not (looking-back (rx (+ (or "\n" white))))))
(insert 32))
((and (gimp-completable-at-p)
;; Prompt for completion of the argument if there is info for that
;; argument, but not otherwise:
(gimp-get-proc-arg fun (1- pos)))
(let* ((desc (gimp-get-proc-arg fun (1- pos)))
(list (gimp-make-completion desc))
(scraped-arg (gimp-arg-from-scraped-registration
(1- pos)
(symbol-name fun)))
(question (format "%s %s: "
(caddr desc)
(or scraped-arg ""))))
(if (string= (car desc)
(setq list
(or scraped-arg list)))
((eq list 'discard)
((functionp list)
(funcall list))
;; If there are no completions and we are at the end of the word that
;; was completed, then don't try to prompt for the argument since there
;; needs to be at least one whitespace character between point and the
;; end of the previous word. In that case we will do the default savvy
;; completion (which may not actually complete anything, which is
;; sometimes expected):
((and (null list)
(not (looking-back (rx (+ (or "\n" white))))))
(gimp-complete-savvy (gimp-get-oblist-cache)))
(gimp-complete-savvy list))
(t (let ((answer (read-from-minibuffer
(if scraped-arg
(read (cadr desc))
(number-to-string (cadar scraped-arg)))
(GIMP_PDB_COLOR (if (numberp (car scraped-arg))
(format "'%S" scraped-arg)
(car scraped-arg)))
(t (format "%S" (car scraped-arg))))
(replace-regexp-in-string "\\(^\"\\|\"$\\)" "" answer)))))))
(gimp-complete-savvy (gimp-get-oblist-cache)))))))
(defun gimp-local-completion ()
(let* ((desc (gimp-get-proc-arg
(1- (gimp-position))))
(list (gimp-make-completion desc)))))
(defun gimp-make-completion (desc)
(destructuring-bind (name type desc) desc
(let ((action
(cdr (assoc-if
(lambda (rule)
(if (functionp rule)
(apply rule (list desc name type))
(if (functionp action)
(apply action (list desc name type))
(gimp-defcommand gimp-toggle-completion ()
"Toggle fuzzy completion.
See variable `gimp-complete-p' for a bit more detailed information."
(setq gimp-complete-p
(not gimp-complete-p)))
(gimp-defcommand gimp-toggle-fuzzy-completion ()
"Toggle fuzzy completion.
See variable `gimp-complete-fuzzy-p' for a bit more detailed information."
(setq gimp-complete-fuzzy-p
(not gimp-complete-fuzzy-p))
(if (eq last-command 'gimp-indent-and-complete)
(call-interactively 'gimp-indent-and-complete)))
(defun gimp-make-fuzzy-match-re (pattern)
(let ((re (replace-regexp-in-string "-" "[^-]*-" pattern)))
(if (string= pattern re)
(defun gimp-all-fuzzy-completions (pattern list)
(mapcar 'car
(gimp-all-fuzzy-completion-data pattern list)))
(defun gimp-all-fuzzy-completion-data (pattern list)
(let* ((re (gimp-make-fuzzy-match-re pattern)))
(loop for s in list
for match = (or (string-match re s)
(string-match pattern s))
when match
collect (list s match
(length (match-string 0 s))
(length s)
(match-string 0 s)))
:key 'cadddr)))
(defun gimp-try-fuzzy-completion (pattern list)
(let* ((max-lisp-eval-depth 30000)
(completions (gimp-all-fuzzy-completion-data pattern list)))
(if (null completions)
(error "[Can't find completion for %S]" pattern)
(if (fboundp 'icicle-expanded-common-match)
(gimp-make-fuzzy-match-re pattern)
(mapcar 'car completions))
(if (gimp-test-recursively
(lambda (one two)
(string= (nth 4 one)
(nth 4 two)))
(if (= (length completions) 1)
(caar completions)
(if (nth 4 (car completions))
(try-completion (nth 4 (car completions))
(mapcar 'car completions))))
;;;; Shortcuts
(gimp-defcommand gimp-shortcuts (&optional terse)
"Show interactive commands in the REPL.
Optional argument TERSE means only show that I am there to help you."
(if (eq major-mode 'inferior-gimp-mode)
(if terse (insert "Type ," (gimp-make-input-field "shortcuts")
" for list of commands")
(insert "Available commands:\n "
"\n ,"
(mapconcat 'gimp-make-input-field gimp-shortcuts "\n ,")
"\n "))
(insert (propertize (concat "\n" gimp-prompt " ")
'font-lock-face 'comint-highlight-prompt
'field 'output
'inhibit-line-move-field-capture t
'rear-nonsticky t))
(let ((pmark (process-mark (gimp-proc))))
(setq comint-save-input-ring-index comint-input-ring-index)
(setq comint-input-ring-index nil)
;; Update the markers to discard this 'input'.
(set-marker comint-last-input-start pmark)
(set-marker comint-last-input-end (point))
(set-marker (process-mark (gimp-proc))
(error "Not in *GIMP* buffer")))
(gimp-defcommand gimp-clear ()
"Clear REPL"
(comint-send-string (gimp-proc) "(begin (display \"Display \") 'cleared)\n"))
(defun gimp-make-input-field (arg)
(gimp-button arg input
(format "gimp-%s" arg))) 1)
;;;; Doc echoing
(defcustom gimp-echo-p t
"Perform doc echoing?
When set to a non-nil value, information on function and
arguments will be echoed in the minibuffer."
:group 'gimp
:type 'boolean)
(defun gimp-docstring (sym)
(if (and
(eq (gimp-get-proc-type sym)
(eq this-command last-command))
;; set this-command to its name, so that calls to eq will
;; fail, but we still can know what command has been
;; effectively called.
(setq this-command (symbol-name this-command))
(if gimp-try-and-get-closure-code-p
(gimp-get-closure-code sym)))
(cons sym
(mapcar (lambda (arg)
(list (read (car arg))
(read (replace-regexp-in-string
"" (cadr arg)))))
(gimp-get-proc-args sym)))))
(defun gimp-echo (&optional sym)
"Echo function and argument information for SYM.
The echo takes the form of (function (name-1 TYPE)...(name-n TYPE)), where the
argument at point is highlighted."
(unless (or (gimp-in-string-p)
(and (not (interactive-p))
(not gimp-echo-p)))
(let ((result))
(let* ((sym (or sym (gimp-fnsym-in-current-sexp)))
(str (symbol-name sym))
(pos (gimp-position)))
(when sym
(cond ((gethash sym (gimp-get-dump-hash))
;; Get it
(setq response (gimp-docstring (read str))))
((unless nil ;(string-match "define\\(?:-macro\\)?\\|let" str)
;"fails" in these cases.
(if (and info (listp (read info))) ;the actual condition
;for cond clause
(setq response (read info))
(setq result (gimp-string-match "(.*)\\(.*\\)" info 1))
t) ;break
;; Get it (unless we have it already)
(unless (and response (not (consp response)))
;;; (setq response
;;; (if (and gimp-try-and-get-closure-code-p
;;; (not (eq this-command 'gimp-indent-and-complete)))
;;; (gimp-get-closure-code sym)))
; (when (not (consp response))
(setq response nil))))
(when (and response
(not (eq 'gimp-error (car response)))) ;this may be
;an error
;in gimp-cl
(setq response
(mapcar (lambda (item) (format "%s" item))
(dotted-to-list response)))
(setf (car response)
(propertize str 'face 'font-lock-keyword-face))
;; Show it
(let ((this-arg (nth pos response)))
(when this-arg
(when (> pos 0)
(let ((arg (nth pos response)))
(setf (nth pos response)
(if (string-match "^\. " arg)
(concat ". "
(propertize (substring arg 2)
'face 'highlight))
(propertize arg 'face 'highlight)))))
(message "(%s)%s" (mapconcat 'identity response " ")
(or result ""))
(when (> pos 0)
(set-text-properties 0 (length this-arg)
nil (nth pos response)))))))))))
(defun gimp-echo-procedure-description (sym)
"Echo short description for SYM."
(message "%s" (gimp-procedure-description sym)))
(defun gimp-describe-this-arg ()
"Echo description for argument or procedure at point."
(let* ((sym (gimp-without-string (gimp-fnsym-in-current-sexp))))
(if (member (symbol-name sym) (gimp-get-pdb-cache))
(if (eql sym (symbol-at-point))
(gimp-echo-procedure-description sym)
(message "%s %s"
(gimp-get-proc-arg-descriptive-name sym (1- (gimp-position)))
(if (eq (gimp-get-proc-type sym) 'fu)
(gimp-arg-from-scraped-registration (1- (gimp-position))
(symbol-name sym))
(message "%S: No information available" sym))))
;;;; Source look-up
(defun gimp-code-search-fu (proc)
"Search for definition of script-fu procedure PROC."
(grep (format
"grep -rnH \"( *define\\( (\\| +\\)%s\\([^a-z0-9!?<>-]\\|$\\)\" %s %s"
(shell-quote-argument (format "%s/scripts/" (gimp-data-dir)))
(shell-quote-argument (format "%s/scripts/" (gimp-dir))))))
(defun gimp-code-search-plug-in-file (proc)
"Search for a plug-in file containing plug-in PROC.
Needs the variable `gimp-src-dir' to be set."
(format "grep -nHri \"\\\"%s\\\"\" %s*"
(concat (gimp-src-dir) "/plug-ins/")))))
(defun gimp-code-search-core-function (proc)
"Search for the definition of core procedure PROC.
Needs the variable `gimp-src-dir' to be set."
(let ((proc
"-" "_" proc)))
(grep (format "grep -rnH \"^%s[^a-z0-9_]\" %s*"
(concat (gimp-src-dir) "/libgimp*/"))))))
(gimp-defcommand gimp-code-search (&optional proc)
"Scavenge source for a procedure.
This admittedly is a poor implementation, and you should delve
into etags and find-tag."
(let ((proc
(or proc
"Search code for procedure: "
(gimp-get-pdb-cache) nil t
(let ((p (or (gimp-procedure-at-point)
(gethash (gimp-fnsym-in-current-sexp) (gimp-get-dump-hash))
(if p (symbol-name p) nil))))))
(case (gimp-get-proc-type (read proc))
(internal (gimp-code-search-core-function proc))
(extension (gimp-code-search-plug-in-file proc))
(plug-in (gimp-code-search-plug-in-file proc))
(fu (gimp-code-search-fu proc))
(t (error "Look up-for %s unimplemented" proc)))))
;;;; Snippets
(defvar gimp-registration-snippet
"(define (script-fu-$${name})\n$>$.)
\(script-fu-register \"script-fu-$${name}\"
_\"$${menu entry (use _ before shortcut letter!) }\"
\"$${%s} ($${%s})\"
\(script-fu-menu-register \"script-fu-$${name}\"
(format-time-string "%Y-%m-%d")))
("reg" . (eval gimp-registration-snippet)) ;ACH! evil...
("sft" . "SF-TOGGLE\t_\"$${On or Off?}\"\t$${TRUE}$>")
("sfv" . "SF-VALUE\t_\"$${text}\"\t\"$${STRING}\"$>")
("sfs" . "SF-STRING\t_\"$${text}\"\t\"$${STRING}\"$>")
("sfa" .
"SF-ADJUSTMENT\t_\"$${Adjust: }\"\t'($${initval} $${lower} $${upper}\
$${step_inc} $${page_inc} $${digits} $${type (0: slider, 1: spinner) })$>")
("sfc" . "SF-COLOR\t_\"$${Color: }\"\t\"$${#000}\"$>")
("sff" . "SF-FILENAME\t_\"$${Filename: }\"\t\"$${~/Pictures}\"$>")
("sfd" . "SF-DIRNAME\t_\"$${Dirname: }\"\t\"$${~/Pictures/}\"$>")
("sfo" .
"SF-OPTION\t_\"$${Choose: (combo)}\"\t'(\"$${opt1}\" \"$${opt2...}\")$>")
("sfe" .
"SF-ENUM\t_\"$${Choose}\"\t'(\"$${enum name}\" \"$${initval}\")$>")
("sfb" .
"SF-BRUSH\t_\"$${Brush:}\"\t'(\"$${brush}\" $${opacity} $${spacing}\
$${NORMAL})$>" )
("sfp" . "SF-PATTERN\t_\"$${Pattern:}\"\t\"$${Pine}\"$>")
("sfg" . "SF-GRADIENT\t_\"$${Gradient:}\"\t\"$${FG to BG (RGB)}\"$>")
("sfpl" . "SF-PALETTE\t_\"$${Palette:}\"\t\"$${Web}\"$>")
("sffont" . "SF-FONT\t_\"$${Font:}\"\t\"$${Helvetica}\"$>")
("sfi" . "SF-IMAGE\t\"Image\"\t1$>")
("sfdr" . "SF-DRAWABLE\t\"Drawable\"\t1$>")
("sfl" . "SF-LAYER\t\"Layer\"\t1$>")
("sfvec" . "SF-VECTORS\t\"Vector\"\t'($${syntax undocced})$>"))
(defconst gimp-snippets
'(("reg" . "Definition and registration set-up")
("sft" . "SF-TOGGLE...")
("sfv" . "SF-VALUE...")
("sfs" . "SF-STRING...")
("sfa" . "SF-ADJUSTMENT...")
("sfc" . "SF-COLOR...")
("sff" . "SF-FILENAME...")
("sfd" . "SF-DIRNAME...")
("sfo" . "SF-OPTION...")
("sfe" . "SF-ENUM...")
("sfb" . "SF-BRUSH...")
("sfp" . "SF-PATTERN...")
("sfg" . "SF-GRADIENT...")
("sfpl" . "SF-PALETTE...")
("sffont" . "SF-FONT...")
("sfi" . "SF-IMAGE...")
("sfdr" . "SF-DRAWABLE...")
("sfl" . "SF-LAYER...")
("sfvec" . "SF-VECTORS..."))
"Reference list snippets ")
(gimp-defcommand gimp-list-snippets ()
"List predefined snippets for GIMPMode."
(gimp-set-face "List of predefined GIMP Mode snippets" level1)
Type the abbreviations on the left in a GIMP Mode buffer, and hit ENTER
(gimp-set-face (make-string (window-width) ?=) shy)
(lambda (i)
(format "%-17s%s"
(car i)
(cdr i)))
gimp-snippets "\n"))
(goto-char (point-min))))
;;;; Misc interactive commands
(gimp-defcommand gimp-selector (char)
"GIMP buffer switcher similar to `slime-selector.
Argument CHAR is used to choose between actions.'."
(interactive "cSwitch to gimp buffer [rldhc?]: ")
(case char
(?l (call-interactively 'gimp-switch-to-latest-source-buffer))
(?h (gimp-help))
(?r (call-interactively 'run-gimp))
(?c (if (eq (process-status gimp-cl-proc) 'open)
(switch-to-buffer gimp-cl-buffer-name)
(?d (call-interactively 'gimp-documentation))
(27 nil)
(?? (message
"i = inferior gimp buffer; l: last lisp buffer;\
d: online documentation; h: help; c: connect as client; ESC: cancel.")
(sit-for 3)
(call-interactively 'gimp-selector))
(t (call-interactively 'gimp-selector))))
(defun gimp-switch-to-latest-source-buffer ()
"Switch to the latest source buffer in gimp-mode.
If none is found, display a message stating so."
(let ((buffer (gimp-latest-source-buffer)))
(if buffer
(switch-to-buffer buffer)
(message "No (other) living gimp-mode buffers to switch to."))))
(gimp-defcommand gimp-load-script (&optional script)
"Load a SCRIPT into the scheme image."
(let* ((script (or script (read-file-name "Load script: "
(format "%s/scripts/" (gimp-dir)))))
(command (format "(load %S)" (expand-file-name script))))
(if (eq this-command 'gimp-send-input)
(message "%s" command))))
(gimp-defcommand gimp-report-bug (subject)
"Send a bug report on GIMP Mode."
(interactive "sGIMP Mode Bug Subject: ")
(let ((from-buffer (current-buffer)))
(mail nil (rot13 "avryf.tvrfra@tznvy.pbz")
(insert (format
This is a bug report for GIMP mode (NOT for the GIMP itself!) .
This bug report will be sent to the GIMP mode maintainer,
not to your local site managers!
Please describe exactly what actions triggered the bug
and the precise symptoms of the bug (it may also be
helpful to include an *EXAMPLE FILE*!):
GIMP-mode version: %s
In %s\n\n\n"
(insert (format "\n\nMajor mode: %s\n"
(buffer-local-value 'mode-name from-buffer)
nil nil from-buffer)))
(insert "\n")
(insert "Minor modes in effect:\n")
(dolist (mode minor-mode-list)
(and (boundp mode) (buffer-local-value mode from-buffer)
(insert (format " %s: %s\n" mode
(buffer-local-value mode from-buffer)))))
(insert "\n"))))
(gimp-defcommand gimp-refresh-scripts ()
"Refresh script-fu scripts."
(let* ((command "(car (script-fu-refresh RUN-INTERACTIVE))"))
(if (eq this-command 'gimp-send-input)
(message "Refreshing scripts... (C-g to quit)")
(if (gimp-eval command)
(message "Completed!")
(message "Failed!")))))
(gimp-defcommand gimp-open-image ()
"Open image(s) by the inferior GIMP process, and display it.
Return the GIMP image number.
Does what you mean(TM) in `dired-mode', `image-dired-thumbnail-mode'
and `image-dired-display-image-mode'.
If GIMP is not running as an inferior process, open image(s) with gimp-remote."
(let ((img
(case major-mode
((image-dired-thumbnail-mode image-dired-display-image-mode)
(with-no-warnings (dired-get-marked-files)))
; silence compiler, as
; `dired-get-marked-files' is
; always present when
; dired-mode is on
(t (read-file-name "File: ")))))
(if (null img) (error "No image at point"))
(flet ((open (image)
((or (gimp-interactive-p)
"(let \
\((image (car (gimp-file-load RUN-INTERACTIVE\n\t%S\n\t%S))))
\t(car (gimp-display-new image)))\n"
(gimp-insert-and-send-string command)
(if (eq window-system 'w32)
(call-process "gimp-win-remote" nil 0 nil
(call-process gimp-program nil 0 nil image))))))
(when (and (listp img) (not (cdr img)))
(setq img (car img)))
(if (listp img)
(mapc 'open (mapcar 'expand-file-name img))
(message "Asked GIMP to open %d images " (length img)))
(message "Asked GIMP to open %s " img)
(open (expand-file-name img))))))
;; Client Mode
;; Client mode global vars
(defun gimp-make-gimp-file (file)
(expand-file-name (concat gimp-dir "/emacs/" file)))
(defvar *gimp-output-file* (gimp-make-gimp-file "emacs-output.scm"))
(defvar *gimp-input-file* (gimp-make-gimp-file "emacs-input.scm"))
(defvar gimp-cl-output "")
(defvar gimp-cl-port nil)
(make-variable-buffer-local 'gimp-cl-port)
(defvar gimp-cl-host nil)
(make-variable-buffer-local 'gimp-cl-host)
(defmacro gimp-with-open-file (filename direction &rest body)
(declare (indent defun))
(case ,direction
(insert-file-contents-literally ,filename)
(write-file ,filename nil))
(insert-file-contents-literally ,filename)
(progn ,@body)
(write-file ,filename nil))))))
(defun gimp-cl-connect ()
"Connect to the Script-Fu server.
The Script-Fu server is started in the GIMP via Xtns > Script FU
> Start Server."
(let ((host (read-from-minibuffer "Host: " ""))
(port (read-number "Port: " 10008)))
(setq gimp-cl-proc
(open-network-stream "gimp-client"
(switch-to-buffer gimp-cl-buffer-name)
(setq gimp-cl-port port
gimp-cl-host host)
(insert "Client mode for the GIMP script-fu server\n"
(make-string 42 61)
(set-marker (process-mark gimp-cl-proc) (point))))
(eval-when (compile load)
(defun gimp-cl-process-filter (p s)
(setq gimp-cl-output
(gimp-with-open-file *gimp-output-file* :input
"+Error: .*$" ;ignore some nonsensical errors (until I
;found out their raison d'être)
(buffer-substring-no-properties (point-min)
(defun gimp-cl-send-string (string &optional discard)
(when (eq (process-status gimp-cl-proc)
(with-no-warnings (gimp-cl-new-output-p))
;flush any previous output
(let* ((string (if discard
(format "(emacs-cl-output %s)" string)))
(pre "G")
(len (length string))
(high (/ len 256))
(low (mod len 256)))
(if (> len 65535)
(error "GIMP send-string: String to long: %d" len))
(if (> low 0)
;; arghh Problems with multibyte and send string. Assert low
;; length of 0
(setq string (concat string (make-string (- 256 low) ? ))
low 0
high (1+ high)))
(setq pre (concat pre
(char-to-string high)
(char-to-string low)))
(if (fboundp 'string-as-unibyte)
(setq pre (string-as-unibyte pre)))
(process-send-string gimp-cl-proc pre)
(process-send-string gimp-cl-proc string))))
(defun gimp-cl-eval-to-string (string &optional discard)
(gimp-cl-send-string string discard)
(while (not (with-no-warnings (gimp-cl-new-output-p)))
(sit-for .1))
(unless discard
(if (string-match "^(gimp-error " gimp-cl-output)
(prog1 (gimp-cl-error gimp-cl-output)
(gimp-cl-send-string "" nil)) ;flush
(defmacro gimp-cl-error (err)
(defun gimp-cl-eval (string)
"Eval STRING, and return it read, somewhat, though not fully, elispified.
Best is to craft STRING so that script-fu returns something universal to the
Lisp world."
(let ((output (gimp-cl-eval-to-string string)))
(if (string-match "^#" output) ;unreadable by the lisp reader
(if (string= (concat "#f\n" gimp-prompt " ") gimp-output) ;gimp returned #f
(read (substring output 1))) ;so strip
(read output))))
(define-derived-mode inferior-cl-gimp-mode inferior-scheme-mode
"Inferior GIMP"
"Mode for interaction with inferior gimp process."
(use-local-map inferior-gimp-mode-map)
(setq comint-input-filter-functions
(add-to-list 'mode-line-process gimp-mode-line-format t))
(defun gimp-send-input ()
"Send current input to the GIMP."
(let ((gimp-command
(cadr (gimp-string-match "^\,\\([[:alpha:]-]+\\)"
(if gimp-command
(set 'gimp-command (intern-soft (concat "gimp-" gimp-command))))
(cond ((and gimp-command
(commandp gimp-command))
(let ((input (call-interactively gimp-command)))
(when (and (eq major-mode 'inferior-gimp-mode)
(stringp input))
(insert input)
(if (gimp-cl-p)
(process-mark gimp-cl-proc)
(set-marker (process-mark gimp-cl-proc) (point)))
(gimp-command (message "No such command: %s" gimp-command))
(if (fboundp 'fud-update-breakpoints)
(let ((undo-list (if (listp buffer-undo-list)
(setq buffer-undo-list t) ;Do not record the very
;verbose tracing in the undo list.
(when (get 'gimp-trace 'trace-wanted)
(if (gimp-cl-p)
nil ;tracing does not work in gimp-cl
(scheme-send-string "(tracing 1)" t))
(sit-for 0.1)
(setq gimp-output ""))
(goto-char (point-max))
(if (gimp-cl-p)
(let ((cl-input (buffer-substring-no-properties
(process-mark gimp-cl-proc)
(mapc (lambda (pv)
(apply 'put-text-property
(process-mark gimp-cl-proc)
'((field input)
(font-lock-face comint-highlight-input)
(front-sticky t)
"mouse-2: insert after prompt as new input")
(mouse-face highlight)))
(set-marker (process-mark gimp-cl-proc) (point))
(ring-insert comint-input-ring cl-input))
(when (get 'gimp-trace 'trace-wanted)
(if (gimp-cl-p) nil ;tracing does not work in gimp-cl
(scheme-send-string "(tracing 0)" t))
(sit-for 0.1)
(setq gimp-output ""))
(setq buffer-undo-list undo-list)))))))
(defun gimp-cl-mkprompt ()
(propertize (concat "\n" gimp-prompt " ")
'font-lock-face 'comint-highlight-prompt
'field 'output
'inhibit-line-move-field-capture t
'rear-nonsticky t))
(defun gimp-cl-get-output-time ()
(nth 5 (file-attributes *gimp-output-file*)))
(defun gimp-cl-new-output-p ()))
(eval-when (load run)
(lexical-let ((old-time (gimp-cl-get-output-time)))
(defun gimp-cl-new-output-p ()
(let ((new-time (gimp-cl-get-output-time)))
(if (not (equal old-time
(setq old-time new-time)
(defun gimp-cl-p ()
"Are we hooked into the GIMP as a client?"
(string= (buffer-name)
(defun gimp-unit-test-execute (test-name function-to-test &rest cl-keys)
"Test FUNCTION-TO-TEST using TEST-NAME to name the output.
This function is part of the unit test function suite for
TEST-NAME is a string for pass/fail messages.
FUNCTION-TO-TEST specifies a lambda function to execute.
Optional keywords:
:expression is a Scheme expression to test FUNCTION-TO-TEST
against. It should include a \"<point>\" string where the test
should position point before proceeding with the test (the
\"<point>\" part of the expression is deleted before proceeding).
When :use-nil-dump-file is set to a non-nil value, the
`gimp-dump' is temporarily set to nil to simulate the condition
whereby the user has installed gimp-mode the first time, but has
yet to actually run GIMP, such that the symbol completion should
fail in a user-friendly way.
When :use-nil-dump-file is left to be nil, then `gimp-dump'
variable is left set as it is (and in this case, `gimp-dump' must
be non-nil, which is verified during the test run).
When :dont-trap is non-nil, do not trap for any error, which is
used for interactive debugging by avoiding obscuring the
traceback (useful when you also have debug-on-error enabled with
:preconditioner is a lambda form to funcall before running the test.
:error-checker is a lambda form to funcall when an error
occurs. When it is defined, and returns non-nil, then the error
that occurred is deemed to be expected. If it returns nil, then
the error is not expected and an error is thrown.
\nKeywords supported: :use-nil-dump-file :dont-trap :validator \
:preconditioner :error-checker
(:expression :use-nil-dump-file :dont-trap :validator :preconditioner :error-checker) ()
(let ((tmp-scm-file (make-temp-file "gimp-mode-test" nil ".scm"))
;; Set gimp-dump to nil temporarily to simulate that the GIMP dump file
;; did not exist upon startup, but only if cl-use-nil-dump-file is t
(gimp-dump (if cl-use-nil-dump-file
(or gimp-dump
(error "You must have run `run-gimp' at least once\
first time in order for the unit-test to validate all functionality."))))
(read-from-minibuffer-result-string "result-string")
(flet ((test-error (&rest format-args)
(error (format "gimp-unit-test-execute: %s: %s"
test-name (apply 'format format-args))))
;; override read-from-minibuffer to just record the prompts into
;; read-from-minibuffer-list so that the cl-validator can scan over it
;; for various tests:
(prompt &optional initial-contents keymap read hist default-value
(push (list prompt initial-contents keymap read hist default-value
inherit-input-method) read-from-minibuffer-list)
;; Return a result, just as read-from-minibuffer would:
(with-temp-file tmp-scm-file
(when cl-expression
(insert cl-expression)
(goto-char (point-min))
(let ((point-expression "<point>"))
(if (search-forward point-expression nil t)
(delete-region (match-beginning 0) (match-end 0))
(test-error (format "EXPRESSION does not include a \"%s\" string\
to locate the point." point-expression)))))
;; Execute the preconditioner if specified:
(when cl-preconditioner
(funcall cl-preconditioner))
;; Use dont-trap when you want to see the error backtrace show up with
;; toggle-debug-on-error is active (otherwise, the backtracing mechanism
;; in Emacs rewrites the trace to the point of not being useable):
(if cl-dont-trap
(funcall function-to-test)
(condition-case err
(funcall function-to-test)
;; When cl-error-checker is defined, then call it. If it returns
;; non-nil, then everything checks out fine, otherwise, we throw
;; an unexpected error condition:
(if (and cl-error-checker (not (funcall cl-error-checker err)))
(error "FAILED \"%s\": Unexpected error: %S" test-name err)))))
;; Call the cl-validator and expect a string result if it fails, and that
;; string result is the reason for the failure. But if cl-validator is not
;; specified, then just indicate the test passed:
(let (validator-result)
(if cl-validator
(setq validator-result (funcall cl-validator read-from-minibuffer-list)))
(if (and cl-validator (stringp validator-result))
(error "FAILED \"%s\": Validation failed: %s" test-name validator-result)
(message (format "PASSED: \"%s\"" test-name)))))
;; Remove the temporary file file if it is written (we expect
;; it to be always written out by make-temp-file called
;; above):
(and (file-exists-p tmp-scm-file) (delete-file tmp-scm-file))))))
(defun gimp-unit-test-completions (dont-trap)
"Unit test function for testing completion."
(flet ((current-word-validator
`(lambda (&rest ignored)
(let ((word (current-word)))
(or (string-equal ,word word)
"Expected current word to be completed as %S but instead got %S"
,word word)))))
(lambda (&rest read-from-minibuffer-list)
(and (car read-from-minibuffer-list)
"Expected no prompting but instead got one or more prompts: %S"
(kill-completions-buffer ()
(mapc (lambda (buffer)
(and (string-match (rx "*Completions*") (buffer-name buffer))
(kill-buffer buffer)))
(let ((function-to-test (lambda ()
(call-interactively 'gimp-indent-and-complete))))
;; First, we run a set of tests that work when `run-gimp' has yet to be
;; executed, following by another set where we do expect `run-gimp' to
;; have been executed. So, before we execute the first set, we insure
;; that gimp is not running.
(when (gimp-proc)
(error "Please terminate the existing Gimp session before running the gimp-mode unit-test."))
;; Insure that we have a proper error message when the `gimp-dump' variable
;; does not exist, which means that the user has yet to run `run-gimp' the
;; very first time after having installed gimp-mode (the installation of which
;; includes inserting a .scm file into the users GIMP startup directory to
;; dump out a representation of the GIMP PDB for Emacs to read into the
;; `gimp-dump' hash):
"T001: Error checking for missing dump hash"
:expression "(gimp-displays-flush<point>)"
:use-nil-dump-file t
:dont-trap dont-trap)
;; Do the same test as above, but this time test that no Emacs Lisp error
;; occurs during completion of a GIMP Scheme function known to have zero
;; arguments:
"T002: Check for zero-args function name completion"
:expression "(gimp-displays-flush<point>)"
:dont-trap dont-trap
(current-word-validator "gimp-displays-flush"))
;; Test for completions on a function:
"T009: Check for function name completion with preceding space\
but with first arg of integer type"
:expression "(gimp-image-<point>)"
;; kill all completion buffers initially, so as to test for at
;; least one showing up during completion:
:preconditioner 'kill-completions-buffer
:dont-trap dont-trap
(lambda (&rest read-from-minibuffer-list)
(unless (remove-if-not
(lambda (buffer)
(string-match (rx "*Completions*") (buffer-name buffer)))
"No completions buffer showed up when completing on \"gimp-image-<point>\"")))
"T003: Check for one-arg function name completion with arg already specified"
:expression "(gimp-display-ne<point> image)"
:dont-trap dont-trap
;; kill all completion buffers initially, because otherwise the
;; completion mechanism would otherwise just scroll that window. That
;; may be a bug, but we can't tell yet exactly:
:preconditioner 'kill-completions-buffer
:validator (current-word-validator "gimp-display-new"))
;; Test for two-arg function completion. No prompting for
;; arguments should be done:
"T004: Check for two-arg function name completion with arg already specified"
:expression "(gimp-image-new<point> image)"
:dont-trap dont-trap
:validator (expect-no-prompting-validator))
;; Test for one-arg function completion. This has in the past
;; resulted in failures whereby the user has not yet run
;; `run-gimp', which means that the inferior process with the
;; GIMP has not yet been established; the solution to this of
;; course is to require the user to execute `run-gimp'. Here,
;; gimp-display-new has an argument that is matched by the
;; gimp-completion-rules, but returns nil often times
;; (gimp-image-list can return nil if there are no active
;; images), and in that case we do not want to prompt for the
;; argument since the point does not have a space in front (If
;; we were to go ahead and prompt for the argument and insert it
;; in without the preceding whitespace, then it will be a part
;; of the previous word, which is not syntactically correct, and
;; certainly not what the user desires):
"T005: Check for function name completion without preceding space\
but with first arg of image type"
:expression "(gimp-display-new<point> image)"
:dont-trap dont-trap
:validator (expect-no-prompting-validator))
;; Do the same test as above, but gimp-image-new whose first arg
;; is an integer type, and for that case we do not prompt. In
;; this case and the preceding case, there is no preceding space
;; which is key here:
"T006: Check for function name completion without preceding space\
but with first arg of integer type"
:expression "(gimp-image-new<point>)"
:dont-trap dont-trap
:validator (expect-no-prompting-validator))
;; Expect to prompt for the first arg of a function that takes
;; an image type as the first argument. Note that there _is_
;; preceding whitespace in front of point here:
"T007: Check for function name completion with preceding space\
but with first arg of image type"
:expression "(gimp-display-new <point> image)"
:dont-trap dont-trap
:error-checker (lambda (err)
;; In this special case, since we have yet to execute
;; `run-gimp', and the user is asking to complete on an
;; image, there is no way for us to identify the image
;; object ids without contacting the GIMP process. So we
;; expect to see an
;; gimp-error-must-run-gimp-error-message error being thrown:
(string-equal (cadr err) gimp-error-must-run-gimp-error-message))
:validator (lambda (&rest read-from-minibuffer-list)
(let ((first-arg (car read-from-minibuffer-list)))
(cond ((null first-arg)
;; Got no prompt, as expected. Return t:
"Unexpected first argument prompt for gimp-display-new: %S"
(caar first-arg)))))))
;; Expect no prompting on a integer argument type when
;; completing after some whitespace:
"T008: Check for function name completion with preceding space\
but with first arg of integer type"
:expression "(gimp-image-new <point>)"
:dont-trap dont-trap
:validator (expect-no-prompting-validator))
"T011: Check for function name completion with preceding space\
but with first arg of integer type"
:expression "(script-fu-neon<point>)"
:dont-trap dont-trap
:validator (expect-no-prompting-validator))
;; For the subsequent tests, we need to execute `run-gimp', but first
;; assert that we are still without the GIMP process:
(when (gimp-proc)
(error (concat "Assertion failed: The GIMP process should "
"not have been started by prior unit tests.")))
;; Once every 10 runs or so, the execution of `run-gimp' below hangs with
;; an infinite "hit Ctrl-g" prompt. Until we can determine a fix, disable
;; the rest of the tests that require `run-gimp' to have run to completion
;; (using a (when nil ... ) block):
(message "Unit test is running the GIMP now via `run-gimp' ...")
(run-gimp nil)
(while (and (gimp-proc)
(not (process-get (gimp-proc)
(sit-for 0.1))
(unless (gimp-proc)
(error "Assertion failed: The GIMP process was not started as expected."))
"T010: Check for function name completion with preceding space\
but with first arg of image type with Gimp running"
:expression "(gimp-display-new <point> image)"
:dont-trap dont-trap
;; No :error-checker defined here, as we do not expect any errors. The
;; Gimp should be contacted to find the image IDs and a suitable prompt
;; provided.
:validator (lambda (&rest read-from-minibuffer-list)
(let ((first-arg (car read-from-minibuffer-list)))
(cond ((null first-arg)
(format "Expected a prompt but got none"))
;; Pass the test if the prompt
;; contains the word "image"
;; in upper or lower case:
((let ((case-fold-search t))
(string-match "image" (caar first-arg)))
"Unexpected first argument prompt for gimp-display-new: %S"
(caar first-arg)))))))
(message "PASSED: All gimp-mode unit-tests pass."))))
(defun gimp-unit-test (&optional dont-trap)
"The top-level driver function for all unit-tests.
Call subsidiary functions to perform various unit-tests on
temporary GIMP Scheme files to validate the Emacs-->GIMP
integration provided by `gimp-mode'.
Optional prefix argument DONT-TRAP will be passed on to the
testing functions. See documentation on keyword arg :dont-trap in
(interactive "P")
(unless (and (gimp-dir) (file-directory-p (gimp-dir)))
(error "Expected (gimp-dir) to return an existing directory.\
Did Gimp Mode get downloaded and installed correctly?"))
;; Insure we have read the dump file:
(gimp-unit-test-completions dont-trap)
;; ... add more unit test function calls here ...
(message "PASSED: All gimp-mode unit-tests pass."))
(provide 'gimp-mode)
;; gimp-mode.el ends here
Jump to Line
Something went wrong with that request. Please try again.