;;; forms.el --- Forms mode: edit a file as a form to fill in
-;; Copyright (C) 1991, 1994-1997, 2001-2011 Free Software Foundation, Inc.
+;; Copyright (C) 1991, 1994-1997, 2001-2013 Free Software Foundation,
+;; Inc.
;; Author: Johan Vromans <jvromans@squirrel.nl>
;;; Commentary:
-;; Visit a file using a form. See forms-d2.el for examples.
+;; Visit a file using a form. See etc/forms for examples.
;;
;; === Naming conventions
;;
(error (concat "Forms control file error: "
"`forms-modified-record-filter' is not a function")))
- ;; The filters acces the contents of the forms using `forms-fields'.
+ ;; The filters access the contents of the forms using `forms-fields'.
(make-local-variable 'forms-fields)
;; Dynamic text support.
;;(message "forms: proceeding setup...")
- ;; Since we aren't really implementing a minor mode, we hack the modeline
+ ;; Since we aren't really implementing a minor mode, we hack the mode line
;; directly to get the text " View " into forms-read-only form buffers. For
;; that reason, this variable must be buffer only.
(make-local-variable 'minor-mode-alist)
(forms-first-record))
)
- ;; user customising
+ ;; user customizing
;;(message "forms: proceeding setup (user hooks)...")
(run-mode-hooks 'forms-mode-hook 'forms-mode-hooks)
;;(message "forms: setting up... done.")
(defvar forms--iif-properties nil
"Original properties of the character being overridden.")
-(defun forms--iif-hook (begin end)
+(defun forms--iif-hook (_begin _end)
"`insert-in-front-hooks' function for read-only segments."
;; Note start location. By making it a marker that points one
(setq forms--field nil)))
))
\f
+(defvar read-file-filter) ; bound in forms--intuit-from-file
+
(defun forms--intuit-from-file ()
"Get number of fields and a default form using the data file."
)
(defun forms--mode-menu-ro (map)
-;;; Menu initialisation
+;;; Menu initialization
; (define-key map [menu-bar] (make-sparse-keymap))
(define-key map [menu-bar forms]
(cons "Forms" (make-sparse-keymap "Forms")))
(put 'forms-delete-record 'menu-enable '(not forms-read-only))
)
(defun forms--mode-menu-edit (map)
-;;; Menu initialisation
+;;; Menu initialization
; (define-key map [menu-bar] (make-sparse-keymap))
(define-key map [menu-bar forms]
(cons "Forms" (make-sparse-keymap "Forms")))
(forms-jump-record cur))
t)
-(defun forms--revert-buffer (&optional arg noconfirm)
+(defun forms--revert-buffer (&optional _arg noconfirm)
"Reverts current form to un-modified."
(interactive "P")
(if (or noconfirm
\f
;;; Debugging
-(defvar forms--debug nil
- "*Enables forms-mode debugging if not nil.")
+(defcustom forms--debug nil
+ "If non-nil, enable Forms mode debugging."
+ :type 'boolean
+ :group 'forms)
(defun forms--debug (&rest args)
"Internal debugging routine."