"i - RET/mouse-1: open directory entry under cursor\tfake\tfake\t1"
"i - u: return to parent directory entry\tfake\tfake\t1"
"i - g: go to a particular page\tfake\tfake\t1"
- "i - r: reload current page\tfake\tfake\t1"
+ "i - r: redraw current page (using cached contents if available)\tfake\tfake\t1"
+ "i - R: reload current page (regenerates cache)\tfake\tfake\t1"
"i - d: download directory entry under cursor\tfake\tfake\t1"
"i - w: display the raw server response for the current page\tfake\tfake\t1"
"i\tfake\tfake\t1"
"Face used for index records.")
(defface elopher-text
- '((default :weight bold)
- (((background dark)) :foreground "white"))
+ '((((background dark)) :foreground "white")
+ (((background light)) :weight bold))
"Face used for text records.")
(defface elopher-info '()
;; Address
(defun elopher-make-address (selector host port)
+ "Create an address of a gopher object with SELECTOR, HOST and PORT."
(list selector host port))
(defun elopher-address-selector (address)
+ "Retrieve selector from ADDRESS."
(car address))
(defun elopher-address-host (address)
+ "Retrieve host from ADDRESS."
(cadr address))
(defun elopher-address-port (address)
+ "Retrieve port from ADDRESS."
(caddr address))
;; Node
(defun elopher-make-node (parent address getter &optional content pos)
+ "Create a node in the gopher page hierarchy.
+
+PARENT specifies the parent of the node, ADDRESS specifies the address of
+the gopher page, GETTER provides the getter function used to obtain this
+page.
+
+The optional arguments CONTENT and POS can be used to fill the cached
+content and cursor position fields of the node."
(list parent address getter content pos))
(defun elopher-node-parent (node)
+ "Retrieve the parent node of NODE."
(elt node 0))
(defun elopher-node-address (node)
+ "Retrieve the address of NODE."
(elt node 1))
(defun elopher-node-getter (node)
+ "Retrieve the preferred getter function of NODE."
(elt node 2))
(defun elopher-node-content (node)
+ "Retrieve the cached content of NODE, or nil if none exists."
(elt node 3))
(defun elopher-node-pos (node)
+ "Retrieve the cached cursor position for NODE, or nil if none exists."
(elt node 4))
(defun elopher-set-node-content (node content)
+ "Set the content cache of NODE to CONTENT."
(setcar (nthcdr 3 node) content))
(defun elopher-set-node-pos (node pos)
+ "Set the cursor position cache of NODE to POS."
(setcar (nthcdr 4 node) pos))
(defun elopher-save-pos ()
+ "Save the current position of point to the current node."
(when elopher-current-node
(elopher-set-node-pos elopher-current-node (point))))
(defun elopher-restore-pos ()
+ "Restore the position of point to that cached in the current node."
(let ((pos (elopher-node-pos elopher-current-node)))
(if pos
(goto-char pos)
(defvar elopher-current-node)
(defun elopher-visit-node (node &optional getter)
+ "Visit NODE using its own getter or GETTER, if non-nil."
(elopher-save-pos)
(elopher-process-cleanup)
(setq elopher-current-node node)
(funcall (elopher-node-getter node))))
(defun elopher-visit-parent-node ()
+ "Visit the parent of the current node."
(let ((parent-node (elopher-node-parent elopher-current-node)))
(when parent-node
(elopher-visit-node parent-node))))
(defun elopher-reload-current-node ()
+ "Reload the current node, discarding any existing cached content."
(elopher-set-node-content elopher-current-node nil)
(elopher-visit-node elopher-current-node))
'help-echo (format "mouse-1, RET: open %s on %s port %s"
selector host port)))
(pcase type
- (?i (elopher-insert-margin) ; Information
+ (?i (elopher-insert-margin) ; Information
(insert (propertize display-string
'face 'elopher-info)))
(?h (elopher-insert-margin "W") ; Web link
(?.) ; Occurs at end of index, can safely ignore.
(tp (elopher-insert-margin (concat (char-to-string tp) "?"))
(insert (propertize display-string
- 'face elopher-unknown-face)))))
+ 'face 'elopher-unknown-face)))))
(insert "\n")))
;; Index retrieval
(defun elopher-get-index-node ()
+ "Getter which retrieves the current node contents as an index."
(let ((content (elopher-node-content elopher-current-node))
(address (elopher-node-address elopher-current-node)))
(if content
;; Text retrieval
-(defconst elopher-url-regex "\\(https?\\|gopher\\)://\\([a-zA-Z0-9.\-]+\\)\\(?3::[0-9]+\\)?\\(?4:/[^ \r\n\t(),]*\\)?"
+(defconst elopher-url-regex
+ "\\(https?\\|gopher\\)://\\([a-zA-Z0-9.\-]+\\)\\(?3::[0-9]+\\)?\\(?4:/[^ \r\n\t(),]*\\)?"
"Regexp used to locate and buttinofy URLs in text files loaded by elopher.")
(defun elopher-buttonify-urls (string)
(buffer-string)))
(defun elopher-process-text (string)
+ "Remove CRs and trailing period from the gopher text document STRING."
(let* ((chopped-str (replace-regexp-in-string "\r\n\.\r\n$" "\r\n" string))
(cleaned-str (replace-regexp-in-string "\r" "" chopped-str)))
(elopher-buttonify-urls cleaned-str)))
(defun elopher-get-text-node ()
+ "Getter which retrieves the current node contents as a text document."
(let ((content (elopher-node-content elopher-current-node))
(address (elopher-node-address elopher-current-node)))
(if content
;; Image retrieval
(defun elopher-get-image-node ()
+ "Getter which retrieves the current node contents as an image to view."
(let ((content (elopher-node-content elopher-current-node))
(address (elopher-node-address elopher-current-node)))
(if content
(lambda (proc event)
(unless (string-prefix-p "deleted" event)
(let ((image (create-image
- (string-as-unibyte elopher-selector-string)
+ (encode-coding-string elopher-selector-string
+ 'no-conversion)
nil t)))
(elopher-with-clean-buffer
(insert-image image))
;; Search retrieval
(defun elopher-get-search-node ()
+ "Getter which submits a search query to the address of the current node."
(let ((content (elopher-node-content elopher-current-node))
(address (elopher-node-address elopher-current-node))
(aborted t))
;; Raw server response retrieval
(defun elopher-get-node-raw ()
+ "Getter which retrieves the raw server response for the current node."
(let* ((content (elopher-node-content elopher-current-node))
(address (elopher-node-address elopher-current-node)))
(elopher-with-clean-buffer
(elopher-with-clean-buffer
(insert elopher-start-index))
(goto-char (point-min)))))
- (message "Displaying raw server response. Reload to return to standard view."))
+ (message "Displaying raw server response. Reload or redraw to return to standard view."))
;; File export retrieval
(defvar elopher-download-filename)
(defun elopher-get-node-download ()
+ "Getter which retrieves the current node and writes the result to a file."
(let* ((address (elopher-node-address elopher-current-node))
(selector (elopher-address-selector address)))
(elopher-visit-parent-node) ; Do first in case of non-local exits.
;;
(defun elopher-next-link ()
+ "Move point to the next link on the current page."
(interactive)
(forward-button 1))
(defun elopher-prev-link ()
+ "Move point to the previous link on the current page."
(interactive)
(backward-button 1))
(defun elopher-click-link (button)
+ "Function called when the gopher link BUTTON is activated (via mouse or keypress)."
(let ((node (button-get button 'elopher-node)))
(elopher-visit-node node)))
(defun elopher-click-url (button)
+ "Function called when the url link BUTTON is activated (via mouse or keypress)."
(let ((url (button-get button 'elopher-url)))
(if elopher-open-urls-with-eww
(browse-web url)
(browse-url url))))
-(defun elopher-follow-closest-link ()
+(defun elopher-follow-current-link ()
+ "Open the link or url at point."
(interactive)
(push-button))
address
#'elopher-get-index-node))))
+(defun elopher-redraw ()
+ "Redraw current page."
+ (interactive)
+ (elopher-visit-node elopher-current-node))
+
(defun elopher-reload ()
"Reload current page."
(interactive)
(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 "TAB") 'elopher-next-link)
+ (define-key map (kbd "<backtab>") 'elopher-prev-link)
(define-key map (kbd "u") 'elopher-back)
(define-key map (kbd "g") 'elopher-go)
- (define-key map (kbd "r") 'elopher-reload)
+ (define-key map (kbd "r") 'elopher-redraw)
+ (define-key map (kbd "R") 'elopher-reload)
(define-key map (kbd "w") 'elopher-view-raw)
(define-key map (kbd "d") 'elopher-download)
(when (fboundp 'evil-define-key)
(evil-define-key 'normal map
- (kbd "C-]") 'elopher-follow-closest-link
+ (kbd "TAB") 'elopher-next-link
+ (kbd "C-]") 'elopher-follow-current-link
(kbd "C-t") 'elopher-back
(kbd "u") 'elopher-back
(kbd "g") 'elopher-go
- (kbd "r") 'elopher-reload
+ (kbd "r") 'elopher-redraw
+ (kbd "R") 'elopher-reload
(kbd "w") 'elopher-view-raw
(kbd "d") 'elopher-download))
map)