Merge pull request #76 from minad/lazy-loading

Lazy loading and lexical scoping

Author: mtreca

README.org

@@ -103,7 +103,6 @@ When =gnuplot-mode= is on, the following keybindings are available:
 | M-tab or M-ret | complete keyword before point                        |
 | ret            | newline and indent                                   |
 | tab            | indent current line                                  |
-| C-c M-i        | toggle inline plot display in comint buffer          |
 
 
 With the exception of the commands for sending commands to Gnuplot,
@@ -140,16 +139,16 @@ terminal= commands.
 If you install the file =gnuplot-eldoc.el= from a recent Gnuplot
 distribution, gnuplot-mode can show syntax hints in the modeline when
 ~eldoc-mode~ is turned on and context sensitivity is enabled.
-    
+
 ** Inline Images
 
 You can optionally have plots displayed inline in the Gnuplot comint
 process buffer. This is handy for trying things out without having to
 switch between Emacs and the Gnuplot display. Call
-=gnuplot-inline-imge-mode= or type ~C-c M-i~ in a gnuplot-mode buffer
-to try it out. This feature is implemented using temporary =png=
-files, and is also somewhat experimental. It requires Gnuplot to have
-=png= support and a GNU Emacs with image support. Please report bugs.
+=gnuplot-inline-display-mode= in a gnuplot-mode buffer to try it out. This
+feature is implemented using temporary =png= files, and is also somewhat
+experimental. It requires Gnuplot to have =png= support and a GNU Emacs
+with image support. Please report bugs.
 
 
 

gnuplot-context.el

@@ -1,4 +1,4 @@
-;;; gnuplot-context.el -- context-sensitive help and completion for gnuplot
+;;; gnuplot-context.el -- context-sensitive help and completion for gnuplot -*- lexical-binding: t -*-
 
 ;; Copyright (C) 2012-2013 Jon Oddie <[email protected]>
 
@@ -1721,9 +1721,9 @@ name; otherwise continues tokenizing up to the token at point.  FIXME."
 ;; them. For normal use, they compile to no-ops.
 (eval-when-compile
   (when (not (featurep 'gnuplot-debug-context))
-    (defmacro with-gnuplot-trace-buffer (&rest args) "No-op." '(progn nil))
-    (defmacro gnuplot-trace (&rest args) "No-op." '(progn nil))
-    (defmacro gnuplot-debug (&rest args) "No-op." '(progn nil))))
+    (defmacro with-gnuplot-trace-buffer (&rest _) "No-op." '(progn nil))
+    (defmacro gnuplot-trace (&rest _) "No-op." '(progn nil))
+    (defmacro gnuplot-debug (&rest _) "No-op." '(progn nil))))
 
 
 
@@ -1755,6 +1755,12 @@ name specified in the (capture NAME PATTERN) form in the
 list beginning the capture group, and END is the tail of the
 token list just after the end of the capture group.")
 
+(defvar gnuplot-eldoc-hash nil
+  "ElDoc strings for gnuplot-mode.
+
+These have to be compiled from the Gnuplot source tree using
+`doc2texi.el'.")
+
 
 ;;;; The pattern matching machine
 (defun gnuplot-match-pattern (instructions tokens completing-p
@@ -1984,7 +1990,7 @@ there."
 (defun gnuplot-scan-stack (stack tokens)
   "Scan STACK for the most recently pushed eldoc and info strings."
   (gnuplot-trace "\t* scanning stack *\n")
-  (gnuplot-debug (gnuplot-backtrace))
+  (gnuplot-debug (gnuplot-backtrace stack))
   (gnuplot-debug (gnuplot-dump-captures))
 
   (catch 'no-scan
@@ -2180,6 +2186,80 @@ command."
       nil)))
 
 
+;;;###autoload
+(define-minor-mode gnuplot-context-sensitive-mode
+  "Use context-sensitive completion and help in gnuplot-mode.
+
+When context-sensitive mode is enabled, gnuplot-mode tries to
+provide more useful completions and help suggestions for built-in
+keywords and functions by parsing each command as you type.  It
+attempts to take into account Gnuplot's many abbreviated
+keywords.  For example, with point at the end of a line reading
+\"plot 'datafile' w \", typing \\[completion-at-point] will pop
+up a list of plotting styles.
+
+Key bindings:
+
+\\[completion-at-point] will complete the keyword at point based
+on its context in the command. To make keyword completion work on
+pressing TAB, set `tab-always-indent' to `complete', or customize
+`gnuplot-tab-completion' to make this automatic in gnuplot-mode
+buffers.
+
+\\[gnuplot-info-at-point] will try to find the most relevant
+Gnuplot info node for the construction at point, prompting for a
+node name if nothing is found.
+
+\\[gnuplot-help-function] will pop up a brief summary of the
+syntax at point in the minibuffer. To have one-line syntax
+summaries appear in the echo area as you type, toggle
+`eldoc-mode' or customize `gnuplot-eldoc-mode'.
+
+To choose whether to use this mode by default in Gnuplot buffers,
+customize the variable
+`gnuplot-use-context-sensitive-completion'.
+
+Note: help strings for eldoc-mode and \\[gnuplot-help-function]
+need to be provided in an Emacs-readable form by the Gnuplot
+distribution. See gnuplot-context.el for details."
+  :keymap
+  `((,(kbd "C-c C-/") . gnuplot-help-function)
+    (,(kbd "C-c C-d") . gnuplot-info-at-point))
+  (unless (derived-mode-p 'gnuplot-mode 'gnuplot-comint-mode)
+    (message "Gnuplot context-sensitive mode works only in Gnuplot-mode buffers")
+    (setq gnuplot-context-sensitive-mode nil))
+  (if gnuplot-context-sensitive-mode
+      ;; Turn on
+      (progn
+        (setq gnuplot-completion-at-point-function #'gnuplot-context-completion-at-point)
+
+        ;; Setup Eldoc
+        (setq-local eldoc-documentation-function #'gnuplot-eldoc-function)
+        (eldoc-add-command 'completion-at-point)     ; Check for eldoc after completion
+
+        ;; Try to load Eldoc strings
+        (when gnuplot-eldoc-mode
+          (unless gnuplot-eldoc-hash
+            (condition-case nil
+                (load-library "gnuplot-eldoc")
+              (error
+               (message "gnuplot-eldoc.el not found. Install it from the Gnuplot distribution.")
+               (setq gnuplot-eldoc-hash nil
+                     gnuplot-eldoc-mode nil))))
+
+          (if gnuplot-eldoc-hash
+              (eldoc-mode 1)
+            (eldoc-mode 0)))
+
+        ;; Set up tab-to-complete
+        (when gnuplot-tab-completion
+          (setq-local tab-always-indent 'complete)))
+
+    ;; Turn off
+    (setq gnuplot-completion-at-point-function #'gnuplot-completion-at-point-info-look)
+    (setq eldoc-documentation-function nil)
+    (eldoc-mode 0)))
+
 
 ;;; All done!
 (provide 'gnuplot-context)

gnuplot-debug-context.el

@@ -1,6 +1,4 @@
-;;
-;; debugging utilities for the gnuplot-mode context matcher
-;;
+;; debugging utilities for the gnuplot-mode context matcher -*- lexical-binding: t -*-
 
 (require 'gnuplot-test-context) ; for gnuplot-simplify-tokens
 
@@ -56,7 +54,7 @@
 (defmacro gnuplot-trace (&rest args)
   `(with-gnuplot-trace-buffer (insert (format ,@args))))
 
-(defun gnuplot-backtrace ()
+(defun gnuplot-backtrace (stack)
   (if stack
       (with-gnuplot-trace-buffer
        (insert "\n-- * backtrace: * --\n")

gnuplot-gui.el

@@ -1,4 +1,4 @@
-;;;; gnuplot-gui.el -- GUI interface to setting options in gnuplot-mode
+;;;; gnuplot-gui.el -- GUI interface to setting options in gnuplot-mode -*- lexical-binding: t -*-
 
 ;; Copyright (C) 1998-2000 Bruce Ravel
 
@@ -805,6 +805,7 @@ This alist is formed at load time by appending together
                                     gnuplot-gui-test-type))
 
 
+;;;###autoload
 (defun gnuplot-gui-swap-simple-complete ()
   (interactive)
   (setq gnuplot-gui-plot-splot-fit-style
@@ -826,6 +827,7 @@ This alist is formed at load time by appending together
 
 ;;; user interface to the widget-y stuff
 
+;;;###autoload
 (defun gnuplot-gui-mouse-set (event)
   "Use the mouse to begin setting options using a GUI interface.
 EVENT is a mouse event.  Bound to \\[gnuplot-gui-mouse-set]
@@ -842,6 +844,7 @@ currently supported."
 (defun gnuplot-gui-set-frame-param (param value)
   (setcdr (assoc param gnuplot-gui-frame-parameters) value))
 
+;;;###autoload
 (defun gnuplot-gui-set-options-and-insert ()
   "Insert arguments using a GUI interface.
 Determine contents of current line and set up the appropriate GUI
@@ -923,6 +926,7 @@ Note that \"cntrparam\" is not currently supported."
                (message
                 "%S is not a gnuplot command which takes options" w)))) )))
 
+;;;###autoload
 (defun gnuplot-gui-toggle-popup ()
   (interactive)
   (setq gnuplot-gui-popup-flag (not gnuplot-gui-popup-flag))
@@ -931,7 +935,6 @@ Note that \"cntrparam\" is not currently supported."
              "Argument popup will no longer appear after insertions.")))
 
 
-(defun gnuplot-gui-y-n (foo))
 (defalias 'gnuplot-gui-y-n 'y-or-n-p)
 
 (defun gnuplot-gui-correct-command (word set term begin)
@@ -1312,7 +1315,7 @@ SAVE-FRAME is non-nil when the widgets are being reset."
                  :button-face 'gnuplot-gui-button-face
                  :help-echo "Push this button to set options"
                  :notify
-                 (lambda (widget &rest ignore)
+                 (lambda (widget &rest _ignore)
                    (kill-buffer (get-buffer-create "*Gnuplot GUI*"))
                    (delete-frame)
                    (select-frame gnuplot-current-frame)
@@ -1352,7 +1355,7 @@ SAVE-FRAME is non-nil when the widgets are being reset."
                  :button-face 'gnuplot-gui-button-face
                  :doc item
                  :notify
-                 (lambda (widget &rest ignore)
+                 (lambda (widget &rest _ignore)
                    (let ((word (widget-get widget :doc)))
                      (gnuplot-gui-set-alist word gnuplot-gui-current-string)
                      (gnuplot-gui-prompt-for-frame word t))))
@@ -1362,7 +1365,7 @@ SAVE-FRAME is non-nil when the widgets are being reset."
                  :button-face 'gnuplot-gui-button-face
                  :doc item
                  :notify
-                 (lambda (widget &rest ignore)
+                 (lambda (widget &rest _ignore)
                    (let* ((word (widget-get widget :doc))
                           (alist (cdr (assoc word gnuplot-gui-all-types))))
                      (while alist
@@ -1375,7 +1378,7 @@ SAVE-FRAME is non-nil when the widgets are being reset."
   (widget-create 'push-button :value "Cancel"
                  :help-echo "Quit setting options and dismiss frame"
                  :button-face 'gnuplot-gui-button-face
-                 :notify (lambda (widget &rest ignore)
+                 :notify (lambda (_widget &rest _ignore)
                            (kill-buffer (get-buffer-create "*Gnuplot GUI*"))
                            (setq gnuplot-gui-alist nil
                                  gnuplot-gui-current-string nil)
@@ -1425,7 +1428,7 @@ menu.  STARRED is true if this a 'list* widget."
                 :button-prefix "[" :button-suffix "]"
                 :help-echo (format "Mouse-2 to view the %S menu" (downcase item))
                 :notify
-                (lambda (widget &rest ignore)
+                (lambda (widget &rest _ignore)
                   (let ((lab (if (widget-get widget :doc)
                                  (concat (downcase (widget-get widget :tag)) " ")
                                "" )))
@@ -1450,7 +1453,7 @@ the numerical argument."
     (widget-create 'editable-field
                    :size 2 :tag item :value default :doc prefix
                    :help-echo (format "Insert new value of %S here" help-label)
-                   :notify (lambda (widget &rest ignore)
+                   :notify (lambda (widget &rest _ignore)
                              (let ((val (widget-value widget))
                                    (pre (concat (widget-get widget :doc) " ")))
                                (setcdr (assoc (widget-get widget :tag)
@@ -1486,7 +1489,7 @@ prefix for the string.  STARRED is t if quotes are not to be used."
      'editable-field
      :size width :tag item :doc prefix :value default
      :help-echo (format "Insert new value of %S here" help-label)
-     :notify (lambda (widget &rest ignore)
+     :notify (lambda (widget &rest _ignore)
                (let ((val (widget-value widget))
                      (q gnuplot-quote-character)
                      (p (widget-get widget :doc)) )
@@ -1520,7 +1523,7 @@ prefix for the string."
   (widget-create 'editable-field
                  :size (/ (frame-width) 3) :tag item :value default
                  :help-echo (format "Insert new format string here")
-                 :notify (lambda (widget &rest ignore)
+                 :notify (lambda (widget &rest _ignore)
                            (let ((val (widget-value widget)))
                              (setcdr (assoc (widget-get widget :tag)
                                             gnuplot-gui-alist)
@@ -1574,7 +1577,7 @@ the default value for the argument.  TAG is non-nil if ITEM rather than
                :doc item :help-echo "Insert a filename here"
                :complete 'gnuplot-gui-file-completion
                :notify
-               (lambda (widget &rest ignore)
+               (lambda (widget &rest _ignore)
                  (setcdr (assoc (widget-get widget :doc) gnuplot-gui-alist)
                          (format "%s%s%s" gnuplot-quote-character
                                  (widget-value widget)
@@ -1584,7 +1587,7 @@ the default value for the argument.  TAG is non-nil if ITEM rather than
      'push-button :value "Browse"
      :doc item :help-echo "Browse directories for a filename."
      :parent widg
-     :notify (lambda (widget &rest ignore)
+     :notify (lambda (widget &rest _ignore)
                (let ((fname (file-relative-name (read-file-name "File: ")
                                                 default-directory))
                      (q gnuplot-quote-character))
@@ -1610,7 +1613,7 @@ the default value for the argument."
    :format "%{%t%}:\n%v\t  %i\n"
    :entry-format "\t  %i %d %v\n"
    :button-face 'gnuplot-gui-labels-face
-   :notify (lambda (widget &rest ignore)
+   :notify (lambda (widget &rest _ignore)
              (setcdr (assoc (upcase (widget-get widget :tag))
                             gnuplot-gui-alist)
                      (widget-value widget)))))
@@ -1627,7 +1630,7 @@ is non-nil if this is a 'range widget."
                  :size 4 :tag item :value (car default)
                  :help-echo (format "Insert the first value of the %S here"
                                     (downcase item))
-                 :notify (lambda (widget &rest ignore)
+                 :notify (lambda (widget &rest _ignore)
                            (setcar (cdr (assoc (widget-get widget :tag)
                                                gnuplot-gui-alist))
                                    (format "%s" (widget-value widget)))))
@@ -1636,7 +1639,7 @@ is non-nil if this is a 'range widget."
                  :size 4 :tag item :value (cdr default)
                  :help-echo (format "Insert the second value of the %S here"
                                     (downcase item))
-                 :notify (lambda (widget &rest ignore)
+                 :notify (lambda (widget &rest _ignore)
                            (setcdr (cdr (assoc (widget-get widget :tag)
                                                gnuplot-gui-alist))
                                    (format "%s" (widget-value widget)))))

gnuplot-test-context.el

@@ -1,6 +1,4 @@
-;;
-;; automated tests for gnuplot-mode context matching
-;;
+;; automated tests for gnuplot-mode context matching  -*- lexical-binding: t -*-
 
 (require 'gnuplot-context)
 

gnuplot-tests.el

@@ -1,4 +1,4 @@
-;;; Tests for gnuplot-mode.
+;;; Tests for gnuplot-mode. -*- lexical-binding: t -*-
 
 ;;; Currently these attempt to cover the correct identification of
 ;;; string and comment syntax.