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

diff --git a/elopher.el b/elopher.el
index 2be607a..96cd641 100644
--- a/elopher.el
+++ b/elopher.el
@@ -6,35 +6,114 @@
 
 ;;; Code:
 
+;;; 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
+;;
+
+(defun elopher-make-node (parent address &optional content)
+  (list parent address cache))
+
+(defun elopher-node-parent (node)
+  (car node))
+
+(defun elopher-node-address (node)
+  (cadr node))
+
+(defun elopher-node-content (node)
+  (caddr node))
+
+(defun elopher-reload-node (node after)
+  ())
+
+;;; Global constants
+;;
+
+(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
+  (concat "i\tfake\tfake\t1\r\n"
+          "i--------------------------------------------\tfake\tfake\t1\r\n"
+          "i          Elopher Gopher Client             \tfake\tfake\t1\r\n"
+          (format "i              version %s\tfake\tfake\t1\r\n" elopher-version)
+          "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\tsdf.org\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"))
+
+;;; Mode and keymap
+;;
+
 (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 "u") 'elopher-pop-history)
     (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-history-back
-        (kbd "u") 'elopher-history-back
-        (kbd "g") 'elopher-go))
+        (kbd "C-t") 'elopher-pop-history
+        (kbd "u") 'elopher-pop-history
+        (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.")
 
-(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"))
+    (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")))
+      (insert (format (concat "%" (number-to-string elopher-margin-width) "s"
+                              (concat
+                               (propertize "[" 'face '(foreground-color . "blue"))
+                               (propertize type-name 'face '(foreground-color . "white"))
+                               (propertize "]" 'face '(foreground-color . "blue"))))))
     (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))
@@ -45,24 +124,24 @@
     (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")
+                              'face elopher-text-face
                               'link-getter #'elopher-get-text
                               'link-address address
                               'action #'elopher-click-link
                               'follow-link t))
       (?1 (elopher-insert-margin "/")
           (insert-text-button display-string
-                              'face '(foreground-color . "cyan")
+                              'face elopher-index-face
                               'link-getter #'elopher-get-index
                               'link-address address
                               'action #'elopher-click-link
                               'follow-link t))
       (?p (elopher-insert-margin "img")
           (insert-text-button display-string
-                             'face '(foreground-color . "cyan")
+                             'face elopher-image-face
                              'link-getter #'elopher-get-image
                              'link-address address
                              'action #'elopher-click-link
@@ -70,24 +149,57 @@
       (?.) ; 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 "")
+;;; History management
+;;
+
+(defvar elopher-history nil
+  "List of pages in elopher history.")
+
+(defvar elopher-place-history nil
+  "List of objects describing how to access pages in history.")
+
+(defvar elopher-current-place nil
+  "How to access current page.")
+
+(defun elopher-push-history ()
+  "Add current contents of buffer, including point, to history."
+  (unless (string-empty-p (buffer-string))
+    (push
+     (list (buffer-string)
+           (point))
+     elopher-history)
+    (push
+     elopher-current-place
+     elopher-place-history)))
+
+(defun elopher-pop-history ()
+  "Restore most recent page from history."
+  (interactive)
+  (if (get-buffer "*elopher*")
+      (if elopher-history
+          (let* ((inhibit-read-only t)
+                 (prev-page (pop elopher-history))
+                 (page-string (car prev-page))
+                 (page-point (cadr prev-page)))
+            (switch-to-buffer "*elopher*")
+            (erase-buffer)
+            (insert page-string)
+            (goto-char page-point)
+            (setq elopher-current-place (pop elopher-place-history)))
+        (message "Already at start of history."))
+    (message "No elopher buffer found.")))
+
 
-(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)
+  (elopher-push-history)
   (let ((inhibit-read-only t))
     (erase-buffer))
   (make-network-process
@@ -98,35 +210,41 @@
    :sentinel sentinel)
   (process-send-string "elopher-process" (concat selector "\n")))
 
+;; Index retrieval
+
 (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))))))
-    
+  (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))
+  (elopher-get-selector selector host port
+                        #'elopher-index-filter))
+
+;; Text retrieval
 
 (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))))))
+  (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))
+  (elopher-get-selector selector host port
+                        #'elopher-text-filter))
+
+;; Image retrieval
 
 (defvar elopher-image-buffer "")
 
@@ -139,12 +257,21 @@
 
 (defun elopher-get-image (selector host port)
   (setq elopher-image-buffer "")
-  (elopher-get-selector selector host port #'elopher-image-filter #'elopher-image-sentinel))
+  (elopher-get-selector selector host port
+                        #'elopher-image-filter
+                        #'elopher-image-sentinel))
 
-(defun elopher-history-back ()
-  (interactive)
+;; Start page retrieval
+
+(defun elopher-get-start-page (&optional selector host port)
+  "Display start page.  SELECTOR, HOST and PORT are unused."
   (let ((inhibit-read-only t))
-    (undo)))
+    (erase-buffer)
+    (save-excursion
+      (elopher-render-complete-records elopher-start-page))))
+
+;;; Navigation methods
+;;
 
 (defun elopher-next-link ()
   (interactive)
@@ -155,7 +282,8 @@
   (backward-button 1))
 
 (defun elopher-click-link (button)
-  (apply (button-get button 'link-getter) (button-get button 'link-address)))
+  (apply (button-get button 'link-getter) (button-get button 'link-address))
+  (setq elopher-current-place (list link-getter link-address)))
 
 (defun elopher-follow-closest-link ()
   (interactive)
@@ -164,38 +292,34 @@
 (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-get-index "" (read-from-minibuffer "Gopher host: ") 70)i
+    (setq elopher-current-place (list #'elopher-get-index address))))
+
+(defun  elopher-reload ()
+  "Reload current page."
+  (interactive)
+  (if elopher-current-place
+      (let ((link-getter (car elopher-current-place))
+            (address (cadr elopher-current-place)))
+        (apply link-getter address))
+    (elopher-get-start-page)))
+
+;;; 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)
+  (setq elopher-history nil)
+  (setq elopher-place-history nil)
+  (setq elopher-current-place nil)
+  (elopher-get-start-page))
+
 
 ;;; elopher.el ends here