[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: nero.el
|
From: |
Joe Corneli |
|
Subject: |
Re: nero.el |
|
Date: |
Sun, 03 Apr 2005 16:37:51 -0500 |
Added tabbed browsing and some other features/bugfixes.
I may have introduced minor bugs? Anyway, tabbed browsing will
probably be the last major feature. Please report bugs and
suggestions...
;;; nero.el --- a fast Lynx-based browser for Emacs
;; Copyright (C) 2005 Joe Corneli <address@hidden>
;; Time-stamp: <jac -- Sun Apr 3 16:28:44 CDT 2005>
;; This file is not part of GNU Emacs, but it is distributed under
;; the same terms as GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published
;; by the Free Software Foundation; either version 2, or (at your
;; option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;; Nero is a fast interactive web browser that runs under Emacs. It
;; uses 'lynx -dump' to generate page content. Navigation is
;; typically done via numbered links, a la Conkeror. See
;; `nero-follow-link'. Note that cookies that have been set by Lynx
;; continue to apply to Nero. Nero itself does not set cookies.
;; Better-than-just-browsing interaction with various useful web
;; services is done via elvi, a la Surfraw. The variable `nero-elvi'
;; contains a list of the currently available elvi. See `nero-defelvis'
;; for instructions on how to write your own elvi.
;; Fast access to commonly used pages is available through a
;; programmable hotlist, a la webjump. The variable `nero-jumps'
;; contains a list of the currently available jumps. See
;; `nero-defjump' for instructions on how to write your own jumps.
;; Standard bookmarks are also supported, see the variable
;; `nero-bookmarks' for details.
;; Facilities for "tabbed browsing" a la (insert name of browser) are
;; available. Use `nero-new-tab' to make a new tab and
;; `nero-show-tabs' (and/or `nero-next-tab', `nero-previous-tab') to
;; switch between tabs.
;; Editing source code for remote pages is supported; see
;; `nero-edit-source'. Viewing the GCIDE is partially supported; see
;; `nero-browse-url-force-html' (note: I am planning to introduce
;; improved GCIDE browsing in a subsequent package).
;; Example usage:
;;
;; M-x nero-browse-url RET http://www.roman-emperors.org/nero.htm RET
;; 7 RET
;; b
;; C-s otho C-a RET
;; M-x nero-new-tab RET RET
;; M-x nero-query-wikipedia RET fiddle rome RET
;; 11 M-x nero-download-link RET ~/roman-empire.html
;; C-x C-f ~/roman-empire.html
;; M-x nero-preview-current-buffer RET
;; ,
;; M-x nero-browse-url RET http://www.gnu.org/graphics/gnu-head.jpg RET
;; ...
;; Expected completion date:
;; April 8, 2005
;; Features to add:
;; * When you fetch new content (`nero-reload'), it should update
;; the cells stored in the history!
;; - but as a general principle, it is better to reuse content
;; unless we are specifically asked to do otherwise.
;; * Jumps should not mess with the history (except for the final
;; jumped-to page). Maybe the downloaded URL should be saved
;; in some kind of hidden "jump junk" tab.
;; * completion for `nero-browse-url' applied to local files,
;; maybe more (look for instances of "MURL" in the code, and
;; other hard-coded non-completing features).
;; * make sure that buffer names are actually handled
;; properly as part of the grand scheme of things.
;; * Before opening a page, check to see whether we processed
;; that URL before.
;; * search through all pages in the history/future for terms
;; that we might find interesting! (Similarly across timescapes.)
;; * integration with external/other browsers
;; * fix nasty googlification (see `ungooglify-url').
;; * it might be cool at some point to build a graph of the URL's
;; that have been browsed to... that sounds kinda neat.
;; * abstract all flags and other strings into variables
;; * provide features to automatically switch to a buffer *editing*
;; the source of a page (implement `nero-edit-source')
;; - consider adding code to *save* the results remotely - is
;; this easy to do? Hard to do? Outside of the scope of Nero?
;; (Probably outside of the scope of Nero.)
;; * fix things up so that we use `call-process' instead of
;; `shell-command'.
;; * Setting `nero-links-display' or `nero-links-exist' to nil
;; should produce different default behavior, I guess - but
;; right now they seem to apply on a page by page basis.
;; That could be fine too, but then they should be reset
;; to their default value whenever a new page is loaded.
;; * Maybe we should run `delete-other-windows' in more different
;; places in the code, like whenever a page loads (i.e. conditionally
;; upon `nero-fullscreen' being non-nil).
;;; Code:
(require 'cl)
(defvar nero-homepage "http://www.ma.utexas.edu/~jcorneli/";
"*Variable for user homepage.")
(defvar nero-bookmarks "~/bookmarks/map.html"
"*Variable for user bookmarks.
It points to a a standard HTML file, written in the format used
by Lynx. Add bookmarks using `nero-add-bookmark-url',
`nero-add-bookmark-link'. Access bookmarks using the
function `nero-bookmarks'.")
(defvar nero-default-page nero-bookmarks
"*New tabs open to this page, by default.")
(defvar nero-lynx-program "lynx"
"*The name of the excecutable that supplies your Lynx.
On some systems this is \"lynx.stable\".")
;; thanks Christoph Conrad for the tip
(defvar nero-references-regexp "^References$"
"*The regexp produced by your Lynx to mark the references section.
This may vary depending on your locale, so watch out!")
(defvar nero-Nero-buffer "*Nero*"
"*The name of the buffer in which Nero primarily runs.")
(defvar nero-Nero-Tabs-buffer " *Nero Tabs*"
"*The name of the buffer in which Nero lists tabs.")
(defvar nero-Nero-Refs-buffer " *Nero Refs*"
"*The name of the buffer in which Nero lists references
This buffer is not usually seen by the user.")
(defvar nero-images nil
"*Whether or not nero should display links for images.")
(defvar nero-mode-hook nil
"*Functions to run when `nero-mode' runs.")
(defvar nero-before-browsing-hook nil
"*Functions to run when `nero-browse-url' runs.
This can be used to associate certain actions with opening a
link.")
(defvar nero-generate-content-hook nil
"*Functions to run when `nero-generate-content' runs.
This can be used to filter or otherwise adjust the content you
will see displayed.")
(defvar nero-follow-link-hook nil
"*Functions to run when `nero-follow-link-internal' runs.
This can be used to associate certain actions to following
a link.")
(defvar nero-jump-hook nil
"*Functions to run after making a jump.
This can be used to define your own jump procedures, based on
regexp search or what have you.")
(defvar nero-fullscreen nil
"*Whether or not starting nero should delete other windows.")
(defvar nero-long-thread nil
"*Should `nero-ariadnes-thread' respond to `nero-restore-page'?")
;; the behavior for different image types should perhaps depend on
;; what configuration options we have. But it is easiest to assume
;; that users can tweak the variable on their own.
(defvar nero-extensions-and-instructions '(("jpg" . 'image)
("png" . 'image)
("eps" . 'image)
("gif" . 'download)
("ps" . 'download)
("pdf" . 'download))
"*File extensions and instructions for nero on how to handle
them This is an alist; the car of each element is a string giving
the file extension, and the cdr is one of several special handler
descriptions, or a function to call. For more details, see
`nero-process-nontext-file'.")
(defvar nero-decode-unicode t
"*Whether or not to decode unicode strings (like \"玄\"
or \"繁\").")
(defvar nero-links-display t
"*Whether or not links appear in the buffer.
Set with `nero-toggle-links-display'.")
(defvar nero-links-exist t
"*Whether or not there are links in the buffer.
Set with `nero-toggle-links-exist'.")
(defvar nero-width 75
"*Width of the nero display, in columns.
To change interactively, use `nero-set-width'.")
(defvar nero-default-flags nil
"*Default flags to pass to 'lynx -dump', as a string (or nil).
No need to set the width as a flag here, that is maintained
automatically based on the value of `nero-width'.")
(defvar nero-tab-names-use-defaults t
"*Whether to prompt the user for tab names or just use defaults.")
(defvar nero-home-city "Minneapolis"
"*Default city for use with `nero-query-mapquest'.")
(defvar nero-home-state "MN"
"*Default state for use with `nero-query-mapquest'.")
(defvar nero-mode-map
(let ((map (make-keymap)))
(suppress-keymap map)
(define-key map "a" 'nero-add-bookmark-url)
(define-key map "A" 'nero-add-bookmark-link)
(define-key map "b" 'nero-back)
(define-key map "B" 'nero-back-to-beginning)
(define-key map "d" 'nero-download-link)
(define-key map "D" 'nero-recursively-download)
(define-key map "e" 'nero-edit-source)
(define-key map "f" 'nero-forward)
(define-key map "F" 'nero-forward-to-end)
(define-key map "g" 'nero-browse-url)
(define-key map "G" 'nero-get-modified-url)
(define-key map "h" 'nero-home)
(define-key map "j" 'nero-show-jumps)
(define-key map "l" 'nero-kill-ring-save-current-link)
(define-key map "L" 'nero-inspect-current-link)
(define-key map "m" 'nero-goto-mark)
(define-key map "M" 'nero-mark-page)
(define-key map "n" 'nero-return-to-nero-now)
(define-key map "o" 'nero-new-tab)
(define-key map "q" 'nero-finished)
(define-key map "r" 'nero-reload)
(define-key map "s" 'nero-show-timescape)
(define-key map "S" 'nero-show-ariadnes-thread)
(define-key map "t" 'nero-toggle-links-display)
(define-key map "T" 'nero-toggle-links-exist)
(define-key map "u" 'nero-kill-ring-save-current-url)
(define-key map "U" 'nero-inspect-current-url)
(define-key map "v" 'nero-bookmarks)
(define-key map "w" 'nero-show-tabs)
(define-key map "x" 'nero-external-current-url)
(define-key map "X" 'nero-external-current-link)
(define-key map ";" 'nero-hide)
(define-key map "," 'nero-previous-tab)
(define-key map "." 'nero-next-tab)
(define-key map "'" 'nero-tabula-rosa)
(define-key map "?" 'describe-mode)
(define-key map (kbd "RET") 'nero-follow-link)
(define-key map (kbd "TAB") 'nero-move-to-next-link)
; (define-key map (kbd "M-TAB") 'nero-move-to-previous-link)
(define-key map (kbd "SPC") 'scroll-up)
(define-key map (kbd "DEL") 'scroll-down)
map)
"Keymap for nero major mode.")
(defvar nero-mode-syntax-table
(let ((nero-mode-syntax-table text-mode-syntax-table))
nero-mode-syntax-table)
"Syntax table for nero mode.")
(defvar nero-link-regexp "\\[\\([0-9]+\\)\\]"
"Regular expression that tells nero what links look like.
The first parenthesized subexpression is the unique
string (representing a base 10 number) denoting a link; the page
with the associated number which will be sought among the
references when `nero-follow-link-internal' runs.")
(defvar nero-font-lock-keywords
`((,nero-link-regexp . font-lock-keyword-face))
"Font lock for `nero-mode'.
Currently, only numbered links are fontified.")
(defvar nero-old-layout nil "Browser windows are currently all
fullscreen. This variable saves the window layout that was
active before browsing started. The old layout is restored when
either `nero-hide' or `nero-finished' runs.")
(defvar nero-history nil "Record of pages already visited.
See also `nero-future', `nero-ariadnes-thread'.")
(defvar nero-future nil
"Record of pages visited and then retreated from with `nero-back'.
See also `nero-history', `nero-ariadnes-thread'.")
(defvar nero-moment nil
"A distinguished moment in time.
The user can declare any page to be `nero-moment'. See
`nero-mark-page' and `nero-goto-mark'.")
(defvar nero-moments nil
"A list of distinguished moments.
Every moment set by `nero-mark-page' is added to this
list.")
(defvar nero-tab nil
"The current tab.
See `nero-set-tab' and `nero-get-tab'.")
(defvar nero-tabs nil
"A list of tabs.
Every tab set by `nero-set-tab' is added to this list.")
(defvar nero-multiverse nil
"All the timescapes (tabs) stored in the nero system.
This variable is \"highly non-user visible.\" If you are a user,
you can probably stop reading now.
If you're a programmer extending the nero system, then you should
know that variable is a list of timescapes; the car of each
timescape is its name (like \"Tab 1\", for example), the next
element is the history associated with this timescape, and the
third element is the future associated with this timescape.
To understand how the system works, note that `nero-browse-url'
calls `nero-update-timescape', which will call `nero-set-tab' if
no tabs have currently been defined. In turn, `nero-set-tab'
calls `nero-add-multiverse-element', to finally change this
variable. In other words, every page you browse is associated
with some tab.")
(defvar nero-ariadnes-thread nil "Full record of the pages visited.
Every page loaded by `nero-browse-url' is added to this list.
Even more extensive recording is done if `nero-long-thread' is
non-nil.")
(defvar nero-links-sanctuary nil
"Save links here when deleting with `nero-toggle-links-exist'.")
(defvar nero-elvi nil
"List of elvi known to nero.
Adjusted whenever `nero-defelvis' adds a new elvis.")
(defvar nero-jumps nil
"List of jumps known to nero.
Adjusted whenever `nero-defjump' adds a new jump.")
;; this could be switched by `nero-mode' to be buffer local if we
;; transition to allowing multiple `nero-mode' windows at once. Note
;; that multiple buffers should be easier to do after we have multiple
;; threads for the same buffer.
(defvar nero-buffer-in-nero-mode nil
"Says whether or not the *Nero* buffer is in `nero-mode'.
This variable is investigated every time `nero-browse-url' runs.
If we're not in the right mode, `nero-browse-url' runs `nero-mode'
and sets this variable to t. Whenever the *Nero* buffer is killed,
the variable is set back to nil.")
(defvar nero-width-flag (concat "-width=" (int-to-string nero-width))
"To adjust this variable, please use `nero-set-width'")
(defun nero-mode ()
"Major mode for browsing the web.
Commands:
\\{nero-mode-map}
Entry to this mode calls the value of `nero-mode-hook'
if that value is non-nil."
(interactive)
(kill-all-local-variables)
(set-syntax-table nero-mode-syntax-table)
(use-local-map nero-mode-map)
(setq major-mode 'nero-mode)
(set (make-local-variable 'font-lock-defaults)
'(nero-font-lock-keywords))
(set (make-local-variable 'nero-buffer-in-nero-mode) t)
(setq major-mode 'nero-mode)
(setq mode-name "nero")
(when nero-fullscreen
(delete-other-windows))
(add-hook 'kill-buffer-hook 'nero-wind-down nil t)
;; I don't know if this is needed or not
(font-lock-fontify-buffer)
;; run hook before beginning
(run-hooks 'nero-mode-hook))
(defun nero-carte-blanche ()
"Clear the *Nero* and *Nero Refs* buffers."
(interactive)
(set-buffer (get-buffer-create nero-Nero-buffer))
(erase-buffer)
(set-buffer (get-buffer-create nero-Nero-Refs-buffer))
(erase-buffer))
(defun nero-tabula-rosa ()
"Give nero's history and future a fresh start.
The only thing in the history will be the current page."
(interactive)
(setq nero-history (last nero-history)
nero-future nil))
(defun nero-scorched-earth ()
"Set each of nero's state variables to nil."
(interactive)
(setq nero-history nil
nero-future nil)
(setq nero-old-layout nil
nero-ariadnes-thread nil
nero-tabs nil
nero-moments nil
nero-tab nil
nero-moment nil
nero-multiverse nil))
;; Couldn't get this to work the way I wanted it to.
; (defadvice shell-command-sentinel (around be-quiet activate)
; "Make the dang thing shut up.")
; (ad-enable-advice 'shell-command-sentinel 'around 'be-quiet)
; (ad-activate 'shell-command-sentinel)
;;
;; Should probably do this with `call-process'. Indeed,
;; calling shell commands tends to screw up one's life in
;; general ways (creating too much garbage in various buffers,
;; etc.).
(defun nero-download-url (URL &optional saveas)
"URL is a web address or path to a file.
Running this command downloads the URL and saves it to a file.
If you want to check on the progress of the download, have a
look at the *Async Shell Command* buffer."
(interactive
(list (read-string "URL: ")
(read-string "Save as: "
(let* ((filename
(concat
(replace-regexp-in-string
".*/" "" URL))))
(expand-file-name
(if (equal filename "")
"index.html"
filename)
default-directory))
nil
"~/nero-download")))
(let ((winconf (current-window-configuration))
(path (or
saveas
(read-string "Save as: "
(let* ((filename
(concat
(replace-regexp-in-string
".*/" "" URL))))
(expand-file-name
(if (equal filename "")
"index.html"
filename)
default-directory))
nil
"~/nero-download"))))
(shell-command (concat "wget -O " path
" \"" URL "\"&") nil nil)
(set-window-configuration winconf)))
;; to we could easily write a version of this function that takes in
;; the number of levels as an argument.
(defun nero-recursively-download (URL)
"Recursively download the contents of URL.
Calls 'wget -r -l 1' to do the work."
(interactive (read-string (concat "URL: "
"(default "
(nero-current-url)
"): ")
nil
nil
(nero-current-url)))
(shell-command "wget -r -l 1 \"" URL "\"&"))
(defun nero-external-current-url ()
"Use `browse-url' to view the current url."
(interactive)
(browse-url (nero-current-url)))
(defun nero-external-current-link ()
"Use `browse-url' to view the current link."
(interactive)
(browse-url (nero-current-link)))
(defun nero-browse-url-force-html (URL)
"Like `nero-browse-url', but sends the '-force-html' flag to Lynx."
(interactive "MURL: ")
(nero-browse-url URL "-force-html"))
;; Providing optional arguments to an interactive function seems
;; a little weird. I'm not totally sure what the standard way
;; to proceed is.
(defun nero-edit-source (&optional mode)
"Edit the source code for the current page.
Optional argument MODE is the mode to edit in; it defaults
to `html-mode'."
(interactive)
(nero-edit-source-at-url (nero-current-url)))
(defun nero-edit-source-at-url (url &optional mode)
"Edit the source code found at the location URL.
Optional argument MODE is the mode to edit in; it defaults
to `html-mode'."
(interactive "MURL: ")
(let ((nero-lynx-program (concat nero-lynx-program " -source"))
(nero-images nil)
(nero-default-flags nil)
(nero-Nero-buffer (nero-buffername-from-url url)))
(nero-browse-url url nil nil (or mode 'html-mode))))
(defun nero-buffername-from-url (url)
"Generate an acceptable name for a buffer based on URL."
(let ((start-with-this (replace-regexp-in-string ".*/" "" url)))
(if (equal start-with-this "")
"index.html"
start-with-this)))
(defun nero-preview-region (&optional flags)
"Preview the current region in nero.
If given, FLAGS is a string giving any additional flags to be
passed to the 'lynx -dump' rendering engine."
(interactive)
(nero-preview-string (buffer-substring-no-properties
(region-beginning)
(region-end))
flags))
(defun nero-preview-string (str &optional flags)
"Preview string STR in nero.
If given, FLAGS is a string giving any additional flags to be
passed to the 'lynx -dump' rendering engine."
(interactive)
(with-temp-buffer
(insert str)
(nero-preview-current-buffer flags)))
(defun nero-preview-buffer (&optional buffer flags)
"Preview BUFFER (by default, the current buffer) in nero.
If given, FLAGS is a string giving any additional flags to be
passed to the rendering engine. See also `nero-preview-string',
`nero-preview-region', and `nero-preview-current-buffer'."
(interactive (list (read-string (concat "Buffer "
"(default "
(buffer-name (current-buffer))
"): ")
nil
nil
(buffer-name (current-buffer)))))
(set-buffer (get-buffer-create buffer))
(nero-browse-url (buffer-name) flags (cons 'buffer (buffer-name))))
(defun nero-preview-current-buffer (&optional flags)
"Like `nero-preview-buffer' but automatically uses the current buffer."
(interactive)
(nero-browse-url (buffer-name) flags (cons 'buffer (buffer-name))))
(defun nero-get-modified-url (URL)
"Get a new url based on the current URL.
The current url appears in the minibuffer for editing. Note, you
are not editing the contents of this url!"
(interactive (list (read-string "URL: " (nero-current-url)
nil nil (nero-current-url))))
(nero-browse-url URL))
;; should -probably- definitely set things up so that several nero
;; windows can be used at once... but might as well wait and
;; do that port all at once at some point when the other
;; features stabilize...
;;
;; Note that while there are no references in a buffer with no links,
;; which means that *Nero Refs" won't be created if the first
;; page we browse has no links. We set up helper functions so
;; that they don't assume that this buffer has been created.
(defun nero-browse-url (URL &optional flags handler mode action)
"URL is a web address or path to a file.
Running this command displays a rendered version of the URL in
the *Nero* buffer. If given, FLAGS is a string giving any
additional flags to be passed to the 'lynx -dump' rendering
engine, HANDLER tells `nero-generate-content' how to behave, and
MODE says what mode to put the resulting buffer in. If mode is
nil, the resulting buffer is put into `nero-mode', and a list of
references is produced which make the page suitable for
interactive browsing. Optional argument ACTION can be used to
give nero special instructions on how to deal with the file; if
non-nil, is one of the flags 'image, 'download, or a function to
call that takes the URL as its sole argument."
(interactive "MURL: ")
(run-hooks 'nero-before-browsing-hook)
;; set up environment
(unless nero-old-layout
(setq nero-old-layout (current-window-configuration)))
(switch-to-buffer (get-buffer-create nero-Nero-buffer))
(unless nero-buffer-in-nero-mode
(if mode
(funcall mode)
(nero-mode)))
;; we should save the current location of the point to the history
;; for this page -- but it is important to get straight which of
;; the pages histories should be affected...
(let ((curpoint (point)))
(unless (nero-process-nontext-file URL action)
;; generate the content according to the specified handler.
(nero-generate-content URL flags handler)
(unless mode
(nero-generate-references)))
(unless mode
(nero-update-timescape URL curpoint)))
;; I must be missing at least one `save-excursion', otherwise I
;; wouldn't have to run `set-buffer' here.
;;
;; it would be nice to fix this up, as it would be a major step
;; towards getting `nero-browse-url' to return a non-nil value only
;; when the page actually loads.
(set-buffer nero-Nero-buffer)
(goto-char (point-min)))
(defun nero-process-nontext-file (URL &optional action)
"Called by `nero-browse-url' to handle some non-text files specially."
(let* ((filename (replace-regexp-in-string ".*/" "" URL))
(extension (replace-regexp-in-string ".*\\." "" filename))
(act (or action
(cdr (assoc extension
nero-extensions-and-instructions)))))
(cond
((eq act 'image)
(set-buffer (get-buffer-create nero-Nero-buffer))
(erase-buffer)
(insert-image
(create-image
(with-temp-buffer
;; thanks for the suggestion Miles Bader
(set-buffer-multibyte nil)
(if (file-regular-p URL)
(insert-file-contents URL)
(url-insert-file-contents URL))
(buffer-string))
nil t)))
((eq act 'download)
(nero-download-url URL))
((functionp act)
(funcall act URL))
;; everything else we process as a text file.
(t nil))))
;; Not called, because we assume Emacs can figure this stuff out on
;; its own. If it was called, we'd use: `,(nero-type-from-extension
;; extension)
; (defun nero-type-from-extension (extension)
; "Return the image type identifier associated with a file extension."
; (cdr (assoc extension '(("jpeg" . jpeg)
; ("jpg" . jpeg)
; ("xpm" . xpm)
; ("xbm" . xbm)
; ("gif" . gif)
; ("eps" . postscript)
; ("pbm" . pbm)
; ("png" . png)
; ("tiff" . tiff)))))
;; and thanks once again Miles Bader!
(defun nero-translate-unicode-codepoints-to-utf-16 ()
"Do replacements to decode and render unicode codepoint strings."
(goto-char (point-min))
(while (re-search-forward "&#\\(x\\)?\\([0-9a-f]+\\);" nil t)
(let* ((ucs (string-to-number (match-string 2)
(if (match-beginning 1) 16 10)))
(decoded (decode-char 'ucs ucs)))
(when decoded
(delete-region (match-beginning 0) (match-end 0))
(insert-char decoded 1)))))
;; Note: we don't make BUFFER default to the current buffer because it
;; is better to be consistent with style of `shell-command-on-region'.
(defun shell-command-on-buffer
(buffer command &optional output-buffer replace error-buffer
display-error-buffer)
"COMMAND is the shell command to run on the contents of BUFFER.
See `shell-command-on-region' for further details."
(set-buffer (get-buffer-create buffer))
(shell-command-on-region (point-min) (point-max) command
output-buffer replace error-buffer))
;; Could use this instead of `shell-command-on-buffer' and save having
;; to start the tcsh (thanks David Hunter):
; (call-process-region (point-min) (point-max) "lynx -dump -stdin" nil
; (get-buffer-create "*foo*"))
;; Indeed it seems to me that it might be better to use something
;; sorta like this everywhere we use lynx - i.e., skip the tcsh every
;; time.
(defun nero-generate-content (URL flags handler)
"Puts initial text in the *Nero* buffer.
This includes the normal (rendered) text of URL, as well as any
references found in the page. The references will later be moved
to the *Nero Refs* buffer. FLAGS are strings to feed to the
inferior lynx process; HANDLER explains how to deal with the
\"URL\", specifically, if it is equal to 'buffer, we do something
different from usual."
(erase-buffer)
(cond
((eq (car handler) 'buffer)
(shell-command-on-buffer
(cdr handler)
(concat nero-lynx-program " -dump -stdin "
(if nero-images "" "-image_links ")
(if nero-default-flags (concat " " nero-default-flags) "")
(if flags (concat " " flags) ""))
nero-Nero-buffer))
(t
(insert (shell-command-to-string
(concat nero-lynx-program " -dump "
;; just an case someone erases the width flag.
(concat (or nero-width-flag "-width=75") " ")
(if nero-images "" "-image_links ")
(if nero-default-flags
(concat nero-default-flags " ")
"")
(if flags
flags
"")
" \"" URL "\"")))))
(when nero-decode-unicode
(nero-translate-unicode-codepoints-to-utf-16))
;; useful for filtering out content that you don't want to see.
(run-hooks 'nero-generate-content-hook))
(defun nero-generate-references ()
"Called by `nero-browse-url' to set up the *Nero Refs* buffer."
(save-excursion
(set-buffer nero-Nero-buffer)
(goto-char (point-max))
(if (search-backward-regexp nero-references-regexp nil t)
(let ((nero-references (buffer-substring-no-properties
(match-beginning 0) (point-max))))
(delete-region (match-beginning 0) (point-max))
(save-excursion
(set-buffer (get-buffer-create nero-Nero-Refs-buffer))
(delete-region (point-min) (point-max))
(insert nero-references)))
(set-buffer (get-buffer-create nero-Nero-Refs-buffer))
(delete-region (point-min) (point-max)))))
;; if we are browsing a fixed timescape... something may have
;; to change to make things work properly.
(defun nero-update-timescape (URL curpoint)
"Called by `nero-browse-url' to set history and future, etc.
This function will also initiate the creation of a new tab, if no
tabs have been created so far."
;; add to history
(unless (equal (nero-current-url) URL)
(nero-add-history-element URL))
;; save location of point in previous timeframe
(when (> (length nero-history) 1)
(setcar (nthcdr 3 (nero-previous-page)) curpoint))
;; update future as needed. If we've moved forward in time one
;; unit, we don't need the last cell in the future anymore.
(if (equal (caar (last nero-future)) URL)
(setq nero-future (nbutlast nero-future))
;; we maintain this "weird" nil-headed structure for `nero-future'
;; so we can consistenly use tail pointers.
(setq nero-future (if (not nero-future)
(list nil)
(nbutlast nero-future
(1- (length nero-future))))))
;; update our ariadne's thread
(setq nero-ariadnes-thread
(cons (nero-current-url) nero-ariadnes-thread))
;; set up a a default tab if there are no tabs yet
(unless nero-tabs
(nero-set-tab "Tab 1")))
(defun nero-add-history-element (URL)
"Called by `nero-update-timescape' to add a history element."
(setq nero-history
(nconc nero-history
(list
(list
URL
(save-excursion
(set-buffer (get-buffer-create nero-Nero-buffer))
(buffer-substring-no-properties (point-min)
(point-max)))
(save-excursion
(set-buffer (get-buffer-create nero-Nero-Refs-buffer))
(buffer-substring-no-properties (point-min)
(point-max)))
1)))))
;; the analogy noted in the docstring here should be exploited.
(defun nero-mark-page ()
"Use this function to set `nero-moment'.
Use `nero-goto-mark' to retrieve to this \"moment\" (see
its docstring for details). Note that `set-mark', a familiar
editing command, is in some ways analogous to this command."
(interactive)
(message (concat (nero-current-url) " marked."))
(setq nero-moment (list
(nero-current-url)
(save-excursion (set-buffer nero-Nero-buffer)
(buffer-string))
(save-excursion (set-buffer nero-Nero-Refs-buffer)
(buffer-string))
(save-excursion (set-buffer nero-Nero-buffer)
(point)))
nero-moments (add-to-list 'nero-moments nero-moment)))
;; Probably this should rocket you to whatever tab/timescape the
;; moment is located in.
(defun nero-goto-mark ()
"Use this function to retreive `nero-moment'.
If `nero-moment' has not been set, this function behaves like
`nero-return-to-nero-now'. Warning: Either the past or the future
may be different from how they were when you ran
`nero-mark-page' (and in fact they probably will be)."
(interactive)
(nero-mark-page)
(nero-restore-page (or nero-moment
(nero-current-page))))
(defun nero-goto-mark-no-mark ()
"Like `nero-goto-mark' but does not mark the current page."
(interactive)
(nero-restore-page (or nero-moment
(nero-current-page))))
(defun nero-return-to-nero-now ()
"Use this function to return to the \"present\".
This is useful to return from the displays produced by
`nero-show-tabs' and `nero-show-ariadnes-thread', both of which
are considered to be \"outside of time\"."
(interactive)
(nero-restore-page (nero-current-page)))
;; this and the next two things are a fairly roundabout way of doing
;; what we're trying to do - they were written at a time when
;; `nero-preview-buffer' wasn't working. Probably this is not the
;; best way to do things - but oh well, it works.
(defun nero-show-timescape ()
"Show browsing history and future, indicating current page.
The page is navigable, or you can use `nero-return-to-nero-now'
to return to browsing the current page."
(interactive)
(set-buffer nero-Nero-Refs-buffer)
(erase-buffer)
(let ((number 1)
(hist (reverse nero-history))
(fut nero-future))
(while fut
(when (caar fut)
(insert (concat " " (int-to-string number) ". "
(caar fut) "\n"))
(setq number (1+ number)))
(setq fut (cdr fut)))
;; mark the page that's current
(insert (concat " " (int-to-string number) ". " (caar hist) " ***\n"))
(setq hist (cdr hist))
(setq number (1+ number))
(while hist
(insert (concat " " (int-to-string number) ". " (caar hist) "\n"))
(setq hist (cdr hist))
(setq number (1+ number))))
(nero-mark-up-references-for-browsing))
(defun nero-show-ariadnes-thread ()
"Show a page displaying a full record of the pages that have loaded.
See `nero-ariadnes-thread'."
(interactive)
(set-buffer nero-Nero-Refs-buffer)
(erase-buffer)
(let ((number 1)
(thread nero-ariadnes-thread))
(while thread
(insert (concat
" "
(int-to-string number)
". "
(car thread) "\n"))
(setq thread (cdr thread))
(setq number (1+ number))))
(nero-mark-up-references-for-browsing))
;; We should mark the "current" tab with **, like we do
;; with history (and like we also should do with ariadne's thread).
;;
;; For ariadne's thread, it would be cool to show the tab that
;; the link was in as well as the link itself.
(defun nero-show-tabs ()
"Switch to the *Nero Tabs* buffer, a marked-up list of tabs.
Following a link in this buffer makes the linked tab
current. (This is accomplished by adding `nero-restore-tab'
attached to the local value of `nero-follow-link-hook' in the
*Nero Tabs* buffer.)"
(interactive)
(cond
(nero-tabs
(set-buffer (get-buffer-create nero-Nero-Refs-buffer))
(erase-buffer)
(let ((number 1)
(tabs nero-tabs))
(while tabs
(insert
(concat " " (int-to-string number)
". " (nero-tab-currently-browsing (car tabs))
" " (car tabs) "\n"))
(setq tabs (cdr tabs))
(setq number (1+ number))))
(nero-mark-up-references-for-browsing nero-Nero-Tabs-buffer)
(set-buffer nero-Nero-Tabs-buffer)
(save-excursion (when (search-forward-regexp nero-tab nil t)
(goto-char (line-beginning-position))
(insert "**")
(delete-char 2)))
(bury-buffer nero-Nero-Tabs-buffer))
(t (nero-set-tab "Tab 1")
(nero-show-tabs))))
(defun nero-tab-currently-browsing (name)
"Return the url that the tab named NAME is currently browsing.
But if there is none, return the empty string."
(or (caar (last (cadr (assoc name nero-multiverse))))
""))
(defun nero-mark-up-references-for-browsing (&optional buffer)
"Turns a numbered list of references into something browsable.
Called by various functions, including `nero-show-tabs' and
`nero-show-timescape'."
(let ((content (buffer-string)))
(switch-to-buffer (get-buffer-create (or buffer
nero-Nero-buffer)))
;; if we create a new buffer, we have to switch it to *Nero Mode*
;; -- actually, we might want to use some other derived modes
;; for doing dired-like actions on various lists of things,
;; but that can wait a bit
(unless nero-buffer-in-nero-mode
(nero-mode))
(erase-buffer)
(insert "\n")
(insert content)
(goto-char (point-min)))
(while (re-search-forward
"^ \\([0-9]+\\)\. \\([^ \n]*\\)\\(.*\\)" nil t)
(let* ((num (match-string 1))
(link (match-string 2))
(trailing (match-string 3))
(beg (match-beginning 0))
(end (match-end 0))
(replacement
(cond
((equal trailing " ***")
(concat "** [" num "] " link ))
((not (equal trailing ""))
(concat " [" num "] \""
;; it is annoying to have to do this, but I
;; couldn't figure out how to accomplish it all
;; with the one `re-search-forward'.
(replace-regexp-in-string
"^ +" "" trailing)
"\" viewing " link ""))
(t
(concat " [" num "] " link)))))
(delete-region beg end)
(insert replacement)))
(font-lock-fontify-buffer)
(goto-char (point-min)))
;; need to complement this with a `nero-delete-tab'.
(defun nero-new-tab (name where)
"Open a new tab, named NAME.
WHERE controls the url to display and defaults to
`nero-default-page'. See `nero-set-tab' for further
information."
(interactive (list (if nero-tab-names-use-defaults
(nero-default-new-tab-name)
(read-string
(concat "Name (default: "
(nero-default-new-tab-name)
"): ")
nil
nil
(nero-default-new-tab-name)))
(read-string
(concat "URL (default: "
nero-default-page
"): ")
nil
nil
nero-default-page)))
(nero-set-tab name where))
;; This whole business with the url and setting up new tabs is a
;; little confusing - I think that `nero-add-multiverse-element'
;; is probably being relied upon to do too much.
(defun nero-set-tab (name &optional url)
"Set up a new tab named NAME.
If optional argument URL is t, the tab will open to the
`nero-default-page'. If nil, to the current page.
Otherwise, the new tab will open to URL.
Note: only built-in functions should call this with a nil URL."
(nero-add-multiverse-element name url)
(setq nero-tabs (add-to-list 'nero-tabs name t))
;; identify the tab we just created as active
(setq nero-tab name))
(defun nero-add-multiverse-element (name &optional url)
"Called by `nero-set-tab' to add a multiverse element.
The new element is named NAME. If URL is given, it will open to
a new tab browsing URL. Otherwise, it will preserve the current
url, and just set it up so that it is inside a tab."
(when url
(setq nero-history nil
nero-future nil)
(nero-browse-url (if (eq url t)
nero-default-page
url)))
(setq nero-multiverse
(add-to-list 'nero-multiverse
(let ((newtab (list 'foo)))
(setcar newtab name)
(setcdr newtab (list nero-history))
(setcdr (cdr newtab) (list nero-future))
newtab)
t)))
(defun nero-default-new-tab-name ()
"Generate the default name of a new tab."
(concat "Tab "
(int-to-string
(1+ (length nero-tabs)))))
(defun nero-get-tab (name)
"Retrieve and activate the tab NAME."
(interactive (list (completing-read "Tab: "
(mapcar #'car nero-tabs))))
(unless (equal name "")
(setq nero-history nil
nero-future nil)
(let ((newtab (assoc name nero-multiverse)))
(when newtab
(setq nero-tab name
nero-history (nconc nero-history (second newtab))
nero-future (nconc nero-future (third newtab)))
(nero-restore-page (nero-current-page))))))
(defun nero-previous-tab ()
"Cycles through `nero-multiverse' to make the previous tab current. "
(interactive)
(if (eq (length nero-multiverse) 1)
(message "No next tab.")
(let ((current-tab (member-if
(lambda (elt) (equal (car elt) nero-tab))
nero-multiverse)))
(if (eq (length current-tab) (length nero-multiverse))
(nero-get-tab (caar (last nero-multiverse)))
(nero-get-tab (caar (last (butlast nero-multiverse
(length current-tab)))))))))
(defun nero-next-tab ()
"Cycles through `nero-multiverse' to make the next tab current. "
(interactive)
(if (eq (length nero-multiverse) 1)
(message "No next tab.")
(let ((current-tab (member-if
(lambda (elt) (equal (car elt) nero-tab))
nero-multiverse)))
(if (eq (length current-tab) 1)
(nero-get-tab (caar nero-multiverse))
(nero-get-tab (caadr current-tab))))))
;; maybe this should take an optional argument that says more about
;; what to do with the new/old info. For example, when called by
;; `nero-set-width-temporarily', maybe we don't want the history data
;; to bo changed, but when called by `nero-set-width', we probably
;; do.
(defun nero-reload ()
"Reload the current url.
This is useful if you suspect its contents might have changed."
(interactive)
(when (nero-browse-url (nero-current-url))
(message "Page reloaded.")))
(defun nero-restore-page (page)
"Utility to display a page that has been saved in nero's history.
This command does not itself change `nero-history'/`nero-future'."
(switch-to-buffer (get-buffer-create nero-Nero-Refs-buffer))
(delete-region (point-min) (point-max))
(insert (third page))
(switch-to-buffer (get-buffer-create nero-Nero-buffer))
(delete-region (point-min) (point-max))
(insert (second page))
(goto-char (fourth page))
(when nero-long-thread
(setq nero-ariadnes-thread
(cons (first page) nero-ariadnes-thread))))
(defun nero-back ()
"Display the previous page you visited."
(interactive)
(if (eq (length nero-history) 1)
(message "Already at beginning of history.")
(setq nero-future (nconc nero-future (last nero-history))
nero-history (nbutlast nero-history))
(nero-restore-page (nero-current-page))))
(defun nero-back-to-beginning ()
"Display the first page you visited.
Runs `nero-mark-page' first."
(interactive)
(nero-mark-page)
(while (> (length nero-history) 1)
(nero-back)))
(defun nero-forward ()
"Display the next page you visited."
(interactive)
(if (not (cdr nero-future))
(message "Already at end of future.")
(setq nero-history (nconc nero-history (last nero-future))
nero-future (nbutlast nero-future))
(nero-restore-page (nero-current-page))))
(defun nero-forward-to-end ()
"Display the final page you visited.
Runs `nero-mark-page' first."
(interactive)
(nero-mark-page)
(while nero-future
(nero-forward)))
(defun nero-down (&optional handler)
"Use the next link spotted in this buffer.
How we actually make use of this link depends on HANDLER.
See `nero-follow-link-internal'."
(while (and (looking-at "[0-9]*\\]")
(not (bobp)))
(backward-char 1))
;; does not currently work with escaped brackets
(when (search-forward-regexp nero-link-regexp nil t)
(nero-follow-link-internal (match-string-no-properties 1) handler)))
(defun nero-follow-link-internal (number &optional handler)
"Read in the NUMBER of a link and display the page it leads to.
If HANDLER is equal to 'wget, download; if it is equal to
'copy-link, copy the url accessed by link to the kill ring.
Otherwise, browse the page that link links to."
(let ((buf (buffer-name (current-buffer))))
(set-buffer (get-buffer-create nero-Nero-Refs-buffer))
(save-excursion
(goto-char (point-min))
(when (search-forward-regexp
(concat " +" number "\\. \\([^ \n]*\\)") nil t)
(let ((url (match-string-no-properties 1))
(beg (match-beginning 1))
(end (match-end 1)))
(when (equal buf nero-Nero-Tabs-buffer)
(nero-restore-tab))
(case handler
('wget
(nero-download-url url))
('copy-link
(kill-ring-save beg end))
('return-link
(buffer-substring-no-properties beg end))
(t
(nero-browse-url url))))))))
(defun nero-restore-tab ()
"This function runs when we're following a link in the *Nero Tabs* buffer."
(let ((tab (buffer-substring (1+ (point)) (line-end-position))))
(nero-get-tab tab)))
(defun nero-download-link (&optional number)
"Like `nero-follow-link' except that the page is saved, not displayed."
(interactive "P")
(if number
(nero-follow-link-internal
(int-to-string (prefix-numeric-value number))
'wget)
(nero-down 'wget)))
(defun nero-kill-ring-save-current-url ()
"Copy the current url to the kill ring.
If `x-select-enable-clipboard' is non-nil and you are running
Emacs under X, this makes it easy to paste the url into other programs."
(interactive)
(with-temp-buffer
(insert (nero-current-url))
(kill-ring-save (point-min) (point-max)))
(message "Current URL copied to kill-ring."))
(defun nero-kill-ring-save-current-link ()
"Copy the current link to the kill ring.
If `x-select-enable-clipboard' is non-nil and you are running
Emacs under X, this makes it easy to paste the url into other programs."
(interactive)
(save-excursion (nero-down 'copy-link))
(message "URL of current link copied to kill-ring."))
(defun nero-toggle-images ()
"Toggle display of images in nero."
(interactive)
(setq nero-images (not nero-images)))
(defun nero-toggle-decoding ()
"Toggle parsing of unicode characters."
(interactive)
(setq nero-decode-unicode (not nero-decode-unicode)))
(defun nero-toggle-links-display ()
"Toggle whether or not links are visible in the current page.
Even if the links are not visible, you can still follow them
using `nero-follow-link', and they will still be copied to
another buffer if you select and copy text that contains them.
See `nero-toggle-links-exist' for a \"firmer\" function that
accomplishes something similar."
(interactive)
(save-excursion
(goto-char (point-min))
(setq nero-links-display (not nero-links-display))
;; what to do now?
(if nero-links-display
;; show links
(remove-text-properties (point-min) (point-max)
'(invisible t
intangible t))
;; hide links
(while (re-search-forward nero-link-regexp nil t)
(set-text-properties (match-beginning 0)
(match-end 0)
'(invisible t
intangible t))))))
(defun nero-toggle-links-exist ()
"Toggle whether or not links exist in the current page.
If there are links (as is typically the case), they will be
deleted. But if there are no links (as will be the case after
running `nero-toggle-links-exist' an odd number of times) running
the function again will cause the links to be automagicially
restored. See `nero-toggle-links-display' for a \"softer\"
function that accomplishes something similar."
(interactive)
(save-excursion
(goto-char (point-min))
(setq nero-links-exist (not nero-links-exist))
;; what to do now?
(if nero-links-exist
;; replace the links we saved
(let ((offset 0))
(while nero-links-sanctuary
(goto-char (+ (first (car nero-links-sanctuary)) offset))
(let ((str (second (car nero-links-sanctuary))))
(insert str)
(setq offset (+ offset (length str))))
(setq nero-links-sanctuary (cdr nero-links-sanctuary))))
;; delete the links
(while (re-search-forward nero-link-regexp nil t)
(let ((match (match-string 0)))
(replace-match "")
(setq nero-links-sanctuary
(append nero-links-sanctuary
(list (list (point) match)))
nero-links-exist nil))))))
(defun nero-set-width (width)
"Make the width of text in nero equal to WIDTH.
Interactively, WIDTH is a numerical prefix argument."
(interactive "nNew width: ")
(setq nero-width width)
(setq nero-width-flag (replace-regexp-in-string "[0-9]+"
(int-to-string width)
nero-width-flag))
(nero-reload))
(defun nero-set-width-temporarily (width)
"Reload the current page being with width equal to WIDTH.
Interactively, WIDTH is a numerical prefix argument."
(interactive "nNew width: ")
(let ((nero-width-flag
(replace-regexp-in-string "[0-9]+"
(int-to-string width)
nero-width-flag)))
(nero-reload)))
(defun nero-follow-link (&optional number)
"By default, opens the page linked to by the next link in the buffer.
See `nero-move-to-next-link' for the definition of \"next link\".
If a numerical argument is specified, open the page linked
to by the link bearing that NUMBER."
(interactive "P")
(if number
(nero-follow-link-internal
(int-to-string (prefix-numeric-value number)))
(nero-down)))
(defun nero-move-to-next-link ()
"Position the cursor on the next link that appears in the buffer.
The \"next link\" is any link such that the cursor is not past
the the right brace that denotes the link's end, and such that no
right brace of any other link intervenes."
(interactive)
(unless nero-links-display
(goto-char (next-property-change (point))))
(if (search-forward-regexp nero-link-regexp nil t)
(backward-char 1)
(message "No more links in buffer.")))
(defun nero-move-to-previous-link ()
"Position the cursor on the previous link that appears in the buffer.
The \"previous link\" is any link such that the cursor is not before
the the right brace that denotes the link's end, and such that no
right brace of any other link intervenes."
(interactive)
(unless nero-links-display
(goto-char (previous-property-change (point))))
(search-backward-regexp nero-link-regexp nil t)
(forward-char 1)
(while (looking-at "[0-9]")
(forward-char 1)))
(defun nero-home ()
"Open `nero-homepage' with `nero-browse-url'."
(interactive)
(nero-browse-url nero-homepage))
(defun nero-bookmarks ()
"Open the `nero-bookmarks' file with `nero-browse-url'."
(interactive)
(nero-browse-url nero-bookmarks))
(defun nero-add-bookmark-url (name)
"Add a bookmark for the current page to the `nero-bookmarks' file.
NAME is a user-specified string that says what to call the bookmark."
(interactive "MBookmark name: ")
(with-temp-buffer
(insert "<LI><a href=\"" (nero-current-url) "\">" name "</a>\n")
(write-region (point-min) (point-max) nero-bookmarks t)))
(defun nero-add-bookmark-link (name)
"Add a bookmark for the current link to the `nero-bookmarks' file.
NAME is a user-specified string that says what to call the bookmark."
(interactive "MBookmark name: ")
(save-excursion
(with-temp-buffer
(insert "<LI><a href=\"" (nero-current-link) "\">" name "</a>\n")
(write-region (point-min) (point-max) nero-bookmarks t))))
(defun nero-add-bookmark-arbitrary-url (name URL)
"Add a bookmark for the current page to the `nero-bookmarks' file.
NAME is a user-specified string that says what to call the bookmark."
(interactive "MBookmark name: \nMURL: ")
(with-temp-buffer
(insert "<LI><a href=\"" URL "\">" name "</a>\n")
(write-region (point-min) (point-max) nero-bookmarks t)))
(defun nero-inspect-current-url ()
"Show the current url in the echo area."
(interactive)
(message (concat "Currently viewing: " (nero-current-url))))
(defun nero-inspect-current-link ()
"Show the current link in the echo area."
(interactive)
(save-excursion
(message (concat "Current link: " (nero-down 'return-link)))))
;; everywhere *else* we should just call `nero-current-url' -
;; makes the code easier to read.
(defun nero-current-url ()
"Return the current url (if any)."
(caar (last nero-history)))
(defun nero-current-link ()
"Return the current link (if any)."
(nero-down 'return-link))
(defun nero-current-page ()
"Return the current page (if any)."
(car (last nero-history)))
(defun nero-previous-page ()
"Return the previous page (if any)."
(car (last nero-history 2)))
;; figure out exactly when to apply this. Can't necessarily do it
;; "always" or we would mess up bookmarking of google pages. Ah-ha!
;; How about if we do it in the *Nero References buffer?
;; That would certainly seem to be the way to go, if we can't
;; figure out how to make google be nicer and not mark things up.
;; Presumably normal browsers use redirection? Maybe we could set
;; it so that this ungooglifies whenever a link is followed from
;; a page containing google results (saving lots of replacements
;; that don't need to be done). This is sorta like doing the
;; redirection, except it is presumably somewhat faster ;).
(defun ungooglify-url (url)
"Google may doctor up a URL before handing it to you.
This function corrects for this unseemly behavior."
(replace-regexp-in-string "&[^+]*?$" ""
(replace-regexp-in-string "\\(^.*?q=\\)" "" url)))
(defun nero-hide ()
"Restore the window configuration that was active before nero ran."
(interactive)
(set-window-configuration nero-old-layout))
(defun nero-finished ()
"Quit this nero session."
(interactive)
(kill-buffer nero-Nero-buffer))
(defun nero-wind-down ()
"Kill nero's associated buffers, restoring all windows and variables."
(when (equal (buffer-name) nero-Nero-buffer)
(when (buffer-live-p (get-buffer nero-Nero-Refs-buffer))
(kill-buffer nero-Nero-Refs-buffer))
(when (buffer-live-p (get-buffer nero-Nero-Tabs-buffer))
(set-buffer nero-Nero-Tabs-buffer)
(fundamental-mode)
(kill-buffer nero-Nero-Tabs-buffer))
(setq nero-buffer-in-nero-mode nil)
(nero-scorched-earth)))
(defmacro nero-defelvis (name baseurl separator &optional trailing)
"Create an elvis to use with nero.
Elvi were made popular by the Shell Users' Revolutionary Front
Rage Against The Web. They are functions for interacting with
useful web services through a simple non-web interface. This
macro implements the same basic strategy, this time for
Emacs/Nero users.
NAME is how you might refer to the elvis in prose. BASEURL is the
beginning part of the URL for the service. SEPARATOR is the
symbol to substitute for spaces in the final url we build from
the arguments given to the function defined by `nero-defelvis'.
that implements the elvis. TRAILING, if present, plays a role
similar to that of BASEURL, but at the end of the built-up
string. The names of elvi defined using this function are
automatically added to the list `nero-elvi'."
(declare (indent defun))
`(add-to-list 'nero-elvi
(defun ,(intern
(concat "nero-query-"
(downcase
(replace-regexp-in-string
" " "-" name))))
(search-string)
,(concat "The " name " elvis for nero.
SEARCH-STRING will be submitted to the service and you will be
shown the results, just as if you were using a \"normal\" web
browser.")
(interactive "MSearch string: ")
(nero-browse-url
(concat ,baseurl
(replace-regexp-in-string
" " "+" search-string)
(if ,trailing
,trailing
""))))))
(nero-defelvis "Google"
"http://www.google.com/search?hl=en&ie=ISO-8859-1&q=";
"+"
"&btnG=Google+Search")
(nero-defelvis "Free Software Directory"
"http://directory.fsf.org/search/fsd-search.py?q=";
"+")
(nero-defelvis "Help GNU Emacs"
"http://lists.gnu.org/archive/cgi-bin/namazu.cgi?query=";
"+"
"&submit=Search%21&idxname=help-gnu-emacs&max=20&result=normal&sort=score")
(nero-defelvis "GNU Emacs Sources"
"http://lists.gnu.org/archive/cgi-bin/namazu.cgi?query=";
"+"
"&submit=Search%21&idxname=gnu-emacs-sources&max=20&result=normal&sort=score")
(nero-defelvis "Emacs Devel"
"http://lists.gnu.org/archive/cgi-bin/namazu.cgi?query=";
"+"
"&submit=Search%21&idxname=emacs-devel&max=20&result=normal&sort=score")
(nero-defelvis "EmacsWiki"
"http://www.emacswiki.org/cgi-bin/wiki?search=";
"+"
"&lang=&dosearch=Go%21")
(nero-defelvis "AsteroidMeta"
"http://oddwiki.taoriver.net/wiki.pl/AsteroidMeta?search=";
"+"
"&dosearch=Go%21")
(nero-defelvis "PlanetMath"
"http://planetmath.org/?op=search&term=";
"+")
;; wikipedia search is actually a google search, or was last time
;; I checked
(nero-defelvis "Wikipedia"
"http://www.google.com/search?domains=en.wikipedia.org&num=50&ie=iso-8859-1&oe=iso-8859-1&q=";
"+"
"&btnG=Google+Search&sitesearch=en.wikipedia.org")
;; Note: this should be rewritten to use processes instead
;; of shell commands, like everything else...
;;
;; Also note that the reason I'm using xv is that my emacs isn'
;; built with gif support. Anyway, this command isn't strictly
;; "necessary" - its fun to look at maps and all, but it is
;; mainly here to illustrate how to write more complicated elvi-type
;; things. (Maybe the elvi mechanism should be addjusted to support
;; things like this, so as to make use of a unified treatment
;; of all elvi.)
(defun nero-query-mapquest (&optional address city state zipcode)
"Download and view a map to ADDRESS from mapquest.com.
CITY and STATE default to `nero-home-city' and `nero-home-state'.
ZIPCODE is usually not necessary. To call this function
without all the prompting, use `nero-query-mapquest-defaults'."
(interactive (list (read-string "Address: " nil nil "")
(read-string (concat "City (default: "
nero-home-city "): ")
nil
nil
nero-home-city)
(read-string (concat "State (default: "
nero-home-state "): ")
nil
nil
nero-home-state)
(read-string (concat "Zip code: ") nil nil "")))
(let ((nero-images t))
(nero-browse-url
(concat "http://www.mapquest.com/maps/map.adp?searchtype";
"=address&country=US&addtohistory=&searchtab=home&address="
(replace-regexp-in-string
" " "+" address)
"&city="
(replace-regexp-in-string
" " "+" city)
"&state="
state
"&zipcode="
zipcode))
(when (search-forward-regexp "Get map of " nil t)
(nero-move-to-previous-link)
(nero-follow-link))
(when (search-forward "mqmapgend" nil t)
(nero-move-to-previous-link)
(nero-browse-url (nero-down 'return-link)
nil
nil
nil
(lambda (url)
(when (shell-command
(concat "wget -O ~/.map.gif "
"\"" url "\"")))
(shell-command "xv ~/.map.gif"))))))
(defun nero-query-mapquest-defaults (&optional address)
"View a map to ADDRESS in `nero-home-city'/`nero-home-state'.
See `nero-query-mapquest'."
(interactive "MAddress: ")
(nero-query-mapquest address nero-home-city nero-home-state))
(defun nero-show-jumps ()
"See `nero-defjump'."
(interactive)
(message "Not implemented yet."))
;; the other approach, automatically changing bookmarks, should be
;; considered as well.
;;
;; It would probably be nice (and easy also) to add autocompletion
;; features a la webjump at some point. Indeed, autocompletion for
;; `nero-defelvis' would also be pretty easy to add.
;;
;; It might be useful to have pages that were jumpted past not
;; appear in the history, or anyway, to make it optional. This would
;; take the addition of a new flag for `nero-browse-url' etc.
;; (Note that in addition to not appearing in the history, the
;; pages don't really need to be rendered; their content
;; should really be wholly ignored.)
;;
;; It might be good to also include the ability to jump to sub
;; pages from some domain (e.g. like with `browse-asteroid',
;; jump right away to a page from AsteroidMeta).
(defmacro nero-defjump (name baseurl &rest numbers)
"Create a jump to be used with nero.
Nero jumps are like bookmarks or \"webjumps\", but they can
do a bit more. The most basic nero jump is essentially just
a bookmark.
The reason you might want more is that sometimes urls change, you
know a consistent way to find them, starting from some
\"landmark\". You don't want to redefine your bookmark every
time the url changes, but you don't want to physically go through
the process of browsing to the final url either. What to do?
This macro takes the approach of having nero do the browsing for
you.
NAME is how you might refer to this jump in prose. BASEURL
is the URL to start from. NUMBERS, if present, indicate the
numbered links to follow, in order.
A function called \"nero-jump-to-\" NAME (suitably marked up)
will be created when this macro runs.
The last thing these functions do when they run is to run
`nero-jump-hook'. This allows you to create your own jumping
procedures, based on regexps rather than link numbers, for
example."
(declare (indent defun))
`(add-to-list 'nero-jumps
(defun ,(intern
(concat "nero-jump-to-"
(downcase
(replace-regexp-in-string
" " "-" name))))
(&optional insert)
,(concat "Get known landmark for " name
" and then follow numbered links.
Applies `nero-browse-url' and then calls `nero-follow-link' as
to follow this sequence of numbered links: "
(format "%S" numbers)
"\n\With prefix arg INSERT, just insert the
URL of " name ".
After the final page has loaded, run `nero-jump-hook'.")
(interactive "P")
(if insert
(insert ,baseurl)
(nero-browse-url ,baseurl)
(when ,(car numbers)
(apply (lambda (number)
(nero-follow-link number))
(list ,@numbers)))
(run-hooks 'nero-jump-hook)))))
(nero-defjump "GNU Emacs Sources"
"http://mail.gnu.org/archive/html/gnu-emacs-sources/";
3)
(nero-defjump "Help GNU Emacs"
"http://mail.gnu.org/archive/html/help-gnu-emacs/";
3)
(nero-defjump "Emacs Devel"
"http://mail.gnu.org/archive/html/emacs-devel/";
3)
(nero-defjump "Emacs Lisp List"
"http://www.anc.ed.ac.uk/~stephen/emacs/ell.html";)
;; I use this wiki a lot, but of course you don't have to...
(nero-defjump "AsteroidMeta"
"http://oddwiki.taoriver.net/wiki.pl/AsteroidMeta/HomePage";)
(nero-defjump "AsteroidMeta recent changes"
"http://oddwiki.taoriver.net/wiki.pl/AsteroidMeta?action=rc;days=1;all=0;showedit=0";)
(nero-defjump "Joe's homepage"
"http://www.ma.utexas.edu/~jcorneli/";)
(nero-defjump "PlanetMath"
"http://planetmath.org/";)
;; not useful for people who don't use `simple-wiki-edit-mode', but
;; quite useful for those who do. You will need to load the following
;; configuration to make this function useful:
; (add-to-list 'swd-wiki-defs-list
; `("AsteroidMeta"
; "http://oddwiki.taoriver.net/wiki.pl/AsteroidMeta/";
; "?action=browse&raw=2&id="
; "?action=index&raw=1"
; "?action=rc&raw=1"
; 1.1
; swd-usemod-wiki-save
; utf-8))
(defun nero-swe-asteroid-page ()
"Example showing how to integrate nero with `simple-wiki-edit-mode'."
(interactive)
(if (functionp 'swc-browse)
(swc-browse "AsteroidMeta"
;; to do this really right, need lots of translations, I'm
sure
(replace-regexp-in-string "%2c" ","
(replace-regexp-in-string ".*/" ""
(nero-current-url))))
(message
"You need simple-wiki-edit (and some extra configs) to use this.")))
(provide 'nero)
;;; nero.el ends here
- Re: nero.el,
Joe Corneli <=