X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=elopher.el;h=56dc32f25f9c81ace0f18ca260b395214f8ca874;hb=0935ba5c8e9541272bf3acda9bc5b948640c3ac3;hp=fb790a7253c6525b0e046f2f70c5a68ecbecb519;hpb=2b7f57188bd7a6132aad2d3c48cfd95b3a5f5ede;p=elpher.git diff --git a/elopher.el b/elopher.el index fb790a7..56dc32f 100644 --- a/elopher.el +++ b/elopher.el @@ -6,33 +6,92 @@ ;;; 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.") +(defcustom elopher-margin-face '(foreground-color . "orange") + "Face used for record margin legend.") + +;;; Global variables +;; + +(defvar elopher-version "1.0.0" + "Current version of elopher.") + +(defvar elopher-margin-width 6 + "Width of left-hand margin used when rendering indicies.") + +(defvar elopher-history nil + "List of pages in elopher history.") + +(defvar 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 +;; + (defvar elopher-mode-map (let ((map (make-sparse-keymap))) (define-key map (kbd "") 'elopher-next-link) (define-key map (kbd "") '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 "u") 'elopher-history-back + (kbd "g") 'elopher-go)) 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-margin (&optional type-name) (if type-name (insert (propertize (format (concat "%" (number-to-string elopher-margin-width) "s") (concat "[" type-name "] ")) - 'face '(foreground-color . "yellow"))) + 'face elopher-margin-face)) (insert (make-string elopher-margin-width ?\s)))) -(defun elopher-process-record (line) +(defun elopher-render-record (line) (let* ((type (elt line 0)) (fields (split-string (substring line 1) "\t")) (display-string (elt fields 0)) @@ -43,24 +102,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 . "yellow") + '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 @@ -68,27 +127,30 @@ (?.) ; 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-process-complete-records (string) +(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-process-record line))) + (elopher-render-record line))) (setq elopher-incomplete-record (elt lines idx)))))) +;;; Selector retrieval +;; + (defun elopher-get-selector (selector host port filter &optional sentinel) (switch-to-buffer "*elopher*") + (push (buffer-string) elopher-history) (elopher-mode) (let ((inhibit-read-only t)) (erase-buffer)) - (setq elopher-incomplete-record "") (make-network-process :name "elopher-process" :host host @@ -97,34 +159,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-process-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) - (elopher-get-selector selector host port #'elopher-index-filter)) + (setq elopher-incomplete-record "") + (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 "") @@ -137,12 +206,20 @@ (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)) + +;;; Control methods for binding +;; (defun elopher-history-back () (interactive) - (let ((inhibit-read-only t)) - (undo))) + (when elopher-history + (let ((inhibit-read-only t)) + (erase-buffer) + (save-excursion + (insert (pop elopher-history)))))) (defun elopher-next-link () (interactive) @@ -159,12 +236,27 @@ (interactive) (push-button)) -(defun elopher () - "Start gopher client." +(defun elopher-go () + "Go to a particular gopher site." (interactive) (elopher-get-index "" (read-from-minibuffer "Gopher host: ") 70)) +;;; Main start procedure +;; + +(defun elopher () + "Start elopher with default landing page." + (interactive) + (switch-to-buffer "*elopher*") + (elopher-mode) + (setq elopher-history nil) + (let ((inhibit-read-only t)) + (erase-buffer) + (save-excursion + (elopher-render-complete-records elopher-start-page)))) + +;; (elopher) ;; (elopher-get-index "" "gopher.floodgap.com" 70) -(elopher-get-image "/fun/xkcd/comics/2130/2137/text_entry.png" "gopher.floodgap.com" 70) +;; (elopher-get-image "/fun/xkcd/comics/2130/2137/text_entry.png" "gopher.floodgap.com" 70) ;;; elopher.el ends here