X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=elopher.el;h=812ebb487507704f985a133f3279c203f037fec0;hb=7f807b93bfabc32fcf5e17d81511d6bfdbba3acd;hp=2be607ad673f2b811bc97e6ec157d8bab310a4c7;hpb=1f1bf8f3603af22926a34a4cca05f90dad95d223;p=elpher.git

diff --git a/elopher.el b/elopher.el
index 2be607a..812ebb4 100644
--- a/elopher.el
+++ b/elopher.el
@@ -6,145 +6,249 @@
 
 ;;; Code:
 
-(setq elopher-mode-map
-  (let ((map (make-sparse-keymap)))
-    (define-key map (kbd "<tab>") 'elopher-next-link)
-    (define-key map (kbd "<S-tab>") 'elopher-prev-link)
-    (define-key map (kbd "u") 'elopher-history-back)
-    (define-key map (kbd "g") 'elopher-go)
-    (when (require 'evil nil t)
-      (evil-define-key 'normal map
-        (kbd "C-]") 'elopher-follow-closest-link
-        (kbd "C-t") 'elopher-history-back
-        (kbd "u") 'elopher-history-back
-        (kbd "g") 'elopher-go))
-    map))
-  ;; "Keymap for gopher client.")
+;;; Global constants
+;;
 
-(define-derived-mode elopher-mode special-mode "elopher"
-  "Major mode for elopher, an elisp gopher client.")
+(defconst elopher-version "1.0.0"
+  "Current version of elopher.")
+
+(defconst elopher-margin-width 6
+  "Width of left-hand margin used when rendering indicies.")
+
+(defconst elopher-start-page
+  (string-join
+   (list "i\tfake\tfake\t1"
+         "i--------------------------------------------\tfake\tfake\t1"
+         "i          Elopher Gopher Client             \tfake\tfake\t1"
+         (format "i              version %s\tfake\tfake\t1" elopher-version)
+         "i--------------------------------------------\tfake\tfake\t1"
+         "i\tfake\tfake\t1"
+         "iBasic usage:\tfake\tfake\t1"
+         "i - tab/shift-tab: next/prev directory entry\tfake\tfake\t1"
+         "i - RET/mouse-1: open directory entry\tfake\tfake\t1"
+         "i - u: return to parent directory entry\tfake\tfake\t1"
+         "i - g: go to a particular site\tfake\tfake\t1"
+         "i - r: reload current page\tfake\tfake\t1"
+         "i\tfake\tfake\t1"
+         "iPlaces to start exploring Gopherspace:\tfake\tfake\t1"
+         "1Floodgap Systems Gopher Server\t\tgopher.floodgap.com\t70"
+         "1Super-Dimensional Fortress\t\tsdf.org\t70"
+         "i\tfake\tfake\t1"
+         "iTest entries:\tfake\tfake\t1"
+         "pXKCD comic image\t/fun/xkcd/comics/2130/2137/text_entry.png\tgopher.floodgap.com\t70"
+         "1Test server\t\tlocalhost\t70"
+         ".")
+   "\r\n"))
+
+
+;;; Customization group
+;;
+
+(defgroup elopher nil
+  "A simple gopher client."
+  :group 'applications)
+
+(defcustom elopher-index-face '(foreground-color . "cyan")
+  "Face used for index records.")
+(defcustom elopher-text-face '(foreground-color . "white")
+  "Face used for text records.")
+(defcustom elopher-info-face '(foreground-color . "gray")
+  "Face used for info records.")
+(defcustom elopher-image-face '(foreground-color . "green")
+  "Face used for image records.")
+(defcustom elopher-unknown-face '(foreground-color . "red")
+  "Face used for unknown record types.")
+
+;;; Model
+;;
+
+;; Address
+
+(defun elopher-make-address (selector host port)
+  (list selector host port))
+
+(defun elopher-address-selector (address)
+  (car address))
+
+(defun elopher-address-host (address)
+  (cadr address))
+
+(defun elopher-address-port (address)
+  (caddr address))
+
+;; Node
+
+(defun elopher-make-node (parent address getter &optional content)
+  (list parent address getter content))
+
+(defun elopher-node-parent (node)
+  (car node))
+
+(defun elopher-node-address (node)
+  (cadr node))
+
+(defun elopher-node-getter (node)
+  (caddr node))
+
+(defun elopher-node-content (node)
+  (cadddr node))
+
+(defun elopher-set-node-content (node content)
+  (setcar (cdddr node) content))
+
+;; Node graph traversal
+
+(defvar elopher-start-node (elopher-make-node nil nil #'elopher-get-index-node))
+(defvar elopher-current-node)
+
+(defun elopher-visit-node (node)
+  (elopher-prepare-buffer)
+  (setq elopher-current-node node)
+  (funcall (elopher-node-getter node)))
+
+(defun elopher-visit-parent-node ()
+  (let ((parent-node (elopher-node-parent elopher-current-node)))
+    (when parent-node
+      (setq elopher-current-node parent-node)
+      (elopher-visit-node elopher-current-node))))
+      
+(defun elopher-reload-current-node ()
+  (elopher-set-node-content elopher-current-node nil)
+  (elopher-visit-node elopher-current-node))
+
+
+;;; Buffer preparation
+;;
+
+(defun elopher-prepare-buffer ()
+  (switch-to-buffer "*elopher*")
+  (elopher-mode)
+  (let ((inhibit-read-only t))
+    (erase-buffer)))
 
-(defvar elopher-margin-width 5)
+
+;;; Index rendering
+;;
+
+(defun elopher-insert-index (string)
+  "Inserts the index corresponding to STRING into the current buffer."
+  (dolist (line (split-string string "\r\n"))
+    (unless (string-empty-p line)
+      (elopher-insert-index-record line))))
 
 (defun elopher-insert-margin (&optional type-name)
   (if type-name
-      (insert (propertize
-               (format (concat "%" (number-to-string elopher-margin-width) "s")
-                       (concat "[" type-name "] "))
-               'face '(foreground-color . "orange")))
+      (progn
+        (insert (format (concat "%" (number-to-string (- elopher-margin-width 1)) "s")
+                        (concat
+                         (propertize "[" 'face '(foreground-color . "blue"))
+                         (propertize type-name 'face '(foreground-color . "white"))
+                         (propertize "]" 'face '(foreground-color . "blue")))))
+        (insert " "))
     (insert (make-string elopher-margin-width ?\s))))
 
-(defun elopher-render-record (line)
+(defun elopher-insert-index-record (line)
+  "Inserts the index record corresponding to LINE into the current buffer."
   (let* ((type (elt line 0))
          (fields (split-string (substring line 1) "\t"))
          (display-string (elt fields 0))
-         (selector (elt fields 1))
-         (hostname (elt fields 2))
-         (port (elt fields 3))
-         (address (list selector hostname port)))
+         (address (elopher-make-address (elt fields 1) (elt fields 2) (elt fields 3))))
     (pcase type
       (?i (elopher-insert-margin)
           (insert (propertize display-string
-                              'face '(foreground-color . "gray"))))
+                              'face elopher-info-face)))
       (?0 (elopher-insert-margin "T")
           (insert-text-button display-string
-                              'face '(foreground-color . "white")
-                              'link-getter #'elopher-get-text
-                              'link-address address
+                              'face elopher-text-face
+                              'elopher-node (elopher-make-node elopher-current-node
+                                                               address
+                                                               #'elopher-get-text-node)
                               'action #'elopher-click-link
                               'follow-link t))
       (?1 (elopher-insert-margin "/")
           (insert-text-button display-string
-                              'face '(foreground-color . "cyan")
-                              'link-getter #'elopher-get-index
-                              'link-address address
+                              'face elopher-index-face
+                              'elopher-node (elopher-make-node elopher-current-node
+                                                               address
+                                                               #'elopher-get-index-node)
                               'action #'elopher-click-link
                               'follow-link t))
-      (?p (elopher-insert-margin "img")
-          (insert-text-button display-string
-                             'face '(foreground-color . "cyan")
-                             'link-getter #'elopher-get-image
-                             'link-address address
-                             'action #'elopher-click-link
-                             'follow-link t))
       (?.) ; Occurs at end of index, can safely ignore.
       (tp (elopher-insert-margin (concat (char-to-string tp) "?"))
           (insert (propertize display-string
-                              'face '(foreground-color . "red")))))
+                              'face elopher-unknown-face))))
     (insert "\n")))
 
-(defvar elopher-incomplete-record "")
 
-(defun elopher-render-complete-records (string)
-  (let* ((til-now (string-join (list elopher-incomplete-record string)))
-         (lines (split-string til-now "\r\n")))
-    (dotimes (idx (length lines))
-      (if (< idx (- (length lines) 1))
-          (let ((line (elt lines idx)))
-            (unless (string-empty-p line)
-              (elopher-render-record line)))
-        (setq elopher-incomplete-record (elt lines idx))))))
+;;; Selector retrieval (all kinds)
+;;
 
-(defun elopher-get-selector (selector host port filter &optional sentinel)
-  (switch-to-buffer "*elopher*")
-  (elopher-mode)
-  (let ((inhibit-read-only t))
-    (erase-buffer))
+(defvar elopher-selector-string)
+
+(defun elopher-get-selector (address after)
+  (setq elopher-selector-string "")
+  (let ((p (get-process "elopher-process")))
+    (if p (delete-process p)))
   (make-network-process
    :name "elopher-process"
-   :host host
-   :service (if port port 70)
-   :filter filter
-   :sentinel sentinel)
-  (process-send-string "elopher-process" (concat selector "\n")))
-
-(defun elopher-index-filter (proc string)
-  (with-current-buffer (get-buffer "*elopher*")
-    (let ((marker (process-mark proc))
-          (inhibit-read-only t))
-      (if (not (marker-position marker))
-          (set-marker marker 0 (current-buffer)))
-      (save-excursion
-        (goto-char marker)
-        (elopher-render-complete-records string)
-        (set-marker marker (point))))))
-    
-(defun elopher-get-index (selector host port)
-  (setq elopher-incomplete-record "")
-  (elopher-get-selector selector host port #'elopher-index-filter))
-
-(defun elopher-text-filter (proc string)
-  (with-current-buffer (get-buffer "*elopher*")
-    (let ((marker (process-mark proc))
-          (inhibit-read-only t))
-      (if (not (marker-position marker))
-          (set-marker marker 0 (current-buffer)))
-      (save-excursion
-        (goto-char marker)
-        (dolist (line (split-string string "\r"))
-          (insert line))
-        (set-marker marker (point))))))
-
-(defun elopher-get-text (selector host port)
-  (elopher-get-selector selector host port #'elopher-text-filter))
-
-(defvar elopher-image-buffer "")
-
-(defun elopher-image-filter (proc string)
-  (setq elopher-image-buffer (concat elopher-image-buffer string)))
-
-(defun elopher-image-sentinel (proc event)
-  (let ((inhibit-read-only t))
-    (insert-image (create-image elopher-image-buffer))))
+   :host (elopher-address-host address)
+   :service (elopher-address-port address)
+   :filter (lambda (proc string)
+             (setq elopher-selector-string (concat elopher-selector-string string)))
+   :sentinel after)
+  (process-send-string "elopher-process"
+                       (concat (elopher-address-selector address) "\n")))
 
-(defun elopher-get-image (selector host port)
-  (setq elopher-image-buffer "")
-  (elopher-get-selector selector host port #'elopher-image-filter #'elopher-image-sentinel))
+;; Index retrieval
 
-(defun elopher-history-back ()
-  (interactive)
-  (let ((inhibit-read-only t))
-    (undo)))
+(defun elopher-get-index-node ()
+  (let ((content (elopher-node-content elopher-current-node))
+        (address (elopher-node-address elopher-current-node)))
+    (if content
+        (let ((inhibit-read-only t))
+          (save-excursion
+            (insert content)))
+      (if address
+          (elopher-get-selector address
+                                (lambda (proc event)
+                                  (let ((inhibit-read-only t))
+                                    (erase-buffer)
+                                    (save-excursion
+                                      (elopher-insert-index elopher-selector-string)))
+                                  (elopher-set-node-content elopher-current-node
+                                                            (buffer-string))))
+        (progn
+          (let ((inhibit-read-only t))
+            (erase-buffer)
+            (save-excursion
+              (elopher-insert-index elopher-start-page)))
+          (elopher-set-node-content elopher-current-node
+                                    (buffer-string)))))))
+
+;; Text retrieval
+
+(defun elopher-strip-CRs (string)
+  (replace-regexp-in-string "\r" "" string))
+
+(defun elopher-get-text-node ()
+  (let ((content (elopher-node-content elopher-current-node))
+        (address (elopher-node-address elopher-current-node)))
+    (if content
+        (let ((inhibit-read-only t))
+          (save-excursion
+            (insert content)))
+      (elopher-get-selector address
+                            (lambda (proc event)
+                              (let ((inhibit-read-only t))
+                                (erase-buffer)
+                                (save-excursion
+                                  (insert
+                                   (elopher-strip-CRs elopher-selector-string))))
+                              (elopher-set-node-content elopher-current-node
+                                                        (buffer-string)))))))
+
+;;; Navigation methods
+;;
 
 (defun elopher-next-link ()
   (interactive)
@@ -155,7 +259,8 @@
   (backward-button 1))
 
 (defun elopher-click-link (button)
-  (apply (button-get button 'link-getter) (button-get button 'link-address)))
+  (let ((node (button-get button 'elopher-node)))
+    (elopher-visit-node node)))
 
 (defun elopher-follow-closest-link ()
   (interactive)
@@ -164,38 +269,55 @@
 (defun elopher-go ()
   "Go to a particular gopher site."
   (interactive)
-  (elopher-get-index "" (read-from-minibuffer "Gopher host: ") 70))
+  (let* ((selector "")
+         (hostname (read-from-minibuffer "Gopher host: "))
+         (port 70)
+         (address (list selector hostname port)))
+    (elopher-visit-node
+     (elopher-make-node elopher-current-node
+                        address
+                        #'elopher-get-index-node))))
+
+(defun  elopher-reload ()
+  "Reload current site."
+  (interactive)
+  (elopher-reload-current-node))
 
+(defun elopher-back ()
+  "Go to previous site."
+  (interactive)
+  (elopher-visit-parent-node))
+
+;;; Main start procedure
+;;
 (defun elopher ()
   "Start elopher with default landing page."
   (interactive)
-  (switch-to-buffer "*elopher*")
-  (elopher-mode)
-  (let ((inhibit-read-only t))
-    (erase-buffer)
-    (save-excursion
-      (elopher-render-complete-records
-       (concat "i\tfake\tfake\t1\r\n"
-               "i--------------------------------------------\tfake\tfake\t1\r\n"
-               "i          Elopher Gopher Client             \tfake\tfake\t1\r\n"
-               "i              version 1.0                   \tfake\tfake\t1\r\n"
-               "i--------------------------------------------\tfake\tfake\t1\r\n"
-               "i\tfake\tfake\t1\r\n"
-               "iBasic usage:\tfake\tfake\t1\r\n"
-               "i - tab/shift-tab: next/prev directory entry\tfake\tfake\t1\r\n"
-               "i - RET/mouse-1: open directory entry\tfake\tfake\t1\r\n"
-               "i - u: return to parent directory entry\tfake\tfake\t1\r\n"
-               "i - g: go to a particular site\tfake\tfake\t1\r\n"
-               "i\tfake\tfake\t1\r\n"
-               "iPlaces to start exploring Gopherspace:\tfake\tfake\t1\r\n"
-               "1Floodgap Systems Gopher Server\t\tgopher.floodgap.com\t70\r\n"
-               "1Super-Dimensional Fortress\t\tgopher.floodgap.com\t70\r\n"
-               "i\tfake\tfake\t1\r\n"
-               "iTest entries:\tfake\tfake\t1\r\n"
-               "pXKCD comic image\t/fun/xkcd/comics/2130/2137/text_entry.png\tgopher.floodgap.com\t70\r\n")))))
-
-(elopher)
-;; (elopher-get-index "" "gopher.floodgap.com" 70)
-;; (elopher-get-image "/fun/xkcd/comics/2130/2137/text_entry.png" "gopher.floodgap.com" 70)
+  (elopher-visit-node elopher-start-node))
+
+
+;;; Mode and keymap
+;;
+
+(defvar elopher-mode-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map (kbd "<tab>") 'elopher-next-link)
+    (define-key map (kbd "<S-tab>") 'elopher-prev-link)
+    (define-key map (kbd "u") 'elopher-back)
+    (define-key map (kbd "g") 'elopher-go)
+    (define-key map (kbd "r") 'elopher-reload)
+    (when (require 'evil nil t)
+      (evil-define-key 'normal map
+        (kbd "C-]") 'elopher-follow-closest-link
+        (kbd "C-t") 'elopher-back
+        (kbd "u") 'elopher-back
+        (kbd "g") 'elopher-go
+        (kbd "r") 'elopher-reload))
+    map)
+  "Keymap for gopher client.")
+
+(define-derived-mode elopher-mode special-mode "elopher"
+  "Major mode for elopher, an elisp gopher client.")
+
 
 ;;; elopher.el ends here