remove unneeded plugins
This commit is contained in:
parent
2822280595
commit
40687da612
|
|
@ -1,34 +0,0 @@
|
||||||
;;; nov-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(add-to-list 'load-path (directory-file-name
|
|
||||||
(or (file-name-directory #$) (car load-path))))
|
|
||||||
|
|
||||||
|
|
||||||
;;;### (autoloads nil "nov" "nov.el" (0 0 0 0))
|
|
||||||
;;; Generated autoloads from nov.el
|
|
||||||
|
|
||||||
(autoload 'nov-mode "nov" "\
|
|
||||||
Major mode for reading EPUB documents
|
|
||||||
|
|
||||||
\(fn)" t nil)
|
|
||||||
|
|
||||||
(autoload 'nov-bookmark-jump-handler "nov" "\
|
|
||||||
The bookmark handler-function interface for bookmark BMK.
|
|
||||||
|
|
||||||
See also `nov-bookmark-make-record'.
|
|
||||||
|
|
||||||
\(fn BMK)" nil nil)
|
|
||||||
|
|
||||||
(register-definition-prefixes "nov" '("nov-"))
|
|
||||||
|
|
||||||
;;;***
|
|
||||||
|
|
||||||
;; Local Variables:
|
|
||||||
;; version-control: never
|
|
||||||
;; no-byte-compile: t
|
|
||||||
;; no-update-autoloads: t
|
|
||||||
;; coding: utf-8
|
|
||||||
;; End:
|
|
||||||
;;; nov-autoloads.el ends here
|
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
;;; Generated package description from nov.el -*- no-byte-compile: t -*-
|
|
||||||
(define-package "nov" "20220805.2031" "Featureful EPUB reader mode" '((esxml "0.3.6") (emacs "25.1")) :commit "cb5f45cbcfbcf263cdeb2d263eb15edefc8b07cb" :authors '(("Vasilij Schneidermann" . "mail@vasilij.de")) :maintainer '("Vasilij Schneidermann" . "mail@vasilij.de") :keywords '("hypermedia" "multimedia" "epub") :url "https://depp.brause.cc/nov.el")
|
|
||||||
|
|
@ -1,987 +0,0 @@
|
||||||
;;; nov.el --- Featureful EPUB reader mode
|
|
||||||
|
|
||||||
;; Copyright (C) 2017 Vasilij Schneidermann <mail@vasilij.de>
|
|
||||||
|
|
||||||
;; Author: Vasilij Schneidermann <mail@vasilij.de>
|
|
||||||
;; URL: https://depp.brause.cc/nov.el
|
|
||||||
;; Package-Version: 20220805.2031
|
|
||||||
;; Package-Commit: cb5f45cbcfbcf263cdeb2d263eb15edefc8b07cb
|
|
||||||
;; Version: 0.4.0
|
|
||||||
;; Package-Requires: ((esxml "0.3.6") (emacs "25.1"))
|
|
||||||
;; Keywords: hypermedia, multimedia, epub
|
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
|
||||||
|
|
||||||
;; This program 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 3 of the License, or
|
|
||||||
;; (at your option) any later version.
|
|
||||||
|
|
||||||
;; This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
|
|
||||||
;; nov.el provides a major mode for reading EPUB documents.
|
|
||||||
;;
|
|
||||||
;; Features:
|
|
||||||
;;
|
|
||||||
;; - Basic navigation (jump to TOC, previous/next chapter)
|
|
||||||
;; - Remembering and restoring the last read position
|
|
||||||
;; - Jump to next chapter when scrolling beyond end
|
|
||||||
;; - Storing and following Org links to EPUB files
|
|
||||||
;; - Renders EPUB2 (.ncx) and EPUB3 (<nav>) TOCs
|
|
||||||
;; - Hyperlinks to internal and external targets
|
|
||||||
;; - Supports textual and image documents
|
|
||||||
;; - Info-style history navigation
|
|
||||||
;; - View source of document files
|
|
||||||
;; - Metadata display
|
|
||||||
;; - Image rescaling
|
|
||||||
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(require 'cl-lib)
|
|
||||||
(require 'dom)
|
|
||||||
(require 'esxml-query)
|
|
||||||
(require 'image)
|
|
||||||
(require 'seq)
|
|
||||||
(require 'shr)
|
|
||||||
(require 'url-parse)
|
|
||||||
(require 'xml)
|
|
||||||
|
|
||||||
(require 'bookmark)
|
|
||||||
(require 'easymenu)
|
|
||||||
(require 'imenu)
|
|
||||||
(require 'org)
|
|
||||||
(require 'recentf)
|
|
||||||
|
|
||||||
(when (not (fboundp 'libxml-parse-xml-region))
|
|
||||||
(message "Your Emacs wasn't compiled with libxml support"))
|
|
||||||
|
|
||||||
|
|
||||||
;;; EPUB preparation
|
|
||||||
|
|
||||||
(defgroup nov nil
|
|
||||||
"EPUB reader mode"
|
|
||||||
:group 'multimedia)
|
|
||||||
|
|
||||||
(defcustom nov-unzip-program (executable-find "unzip")
|
|
||||||
"Path to decompression executable."
|
|
||||||
:type '(file :must-match t)
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-unzip-args '("-od" directory filename)
|
|
||||||
"Arguments to decompression executable.
|
|
||||||
This variable expects a list of strings, except for `directory'
|
|
||||||
and `filename' symbols, which will be replaced accordingly when
|
|
||||||
opening an EPUB file."
|
|
||||||
:type 'list
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-variable-pitch t
|
|
||||||
"Non-nil if a variable pitch face should be used.
|
|
||||||
Otherwise the default face is used."
|
|
||||||
:type 'boolean
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-text-width nil
|
|
||||||
"Width filled text shall occupy.
|
|
||||||
An integer is interpreted as the number of columns. If nil, use
|
|
||||||
the full window's width. If t, disable filling completely. Note
|
|
||||||
that this variable only has an effect in Emacs 25.1 or greater."
|
|
||||||
:type '(choice (integer :tag "Fixed width in characters")
|
|
||||||
(const :tag "Use the width of the window" nil)
|
|
||||||
(const :tag "Disable filling" t))
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-render-html-function 'nov-render-html
|
|
||||||
"Function used to render HTML.
|
|
||||||
It's called without arguments with a buffer containing HTML and
|
|
||||||
should change it to contain the rendered version of it."
|
|
||||||
:type 'function
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-pre-html-render-hook nil
|
|
||||||
"Hook run before `nov-render-html'."
|
|
||||||
:type 'hook
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-post-html-render-hook nil
|
|
||||||
"Hook run after `nov-render-html'."
|
|
||||||
:type 'hook
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-save-place-file (locate-user-emacs-file "nov-places")
|
|
||||||
"File name where last reading places are saved to and restored from.
|
|
||||||
If set to `nil', no saving and restoring is performed."
|
|
||||||
:type '(choice (file :tag "File name")
|
|
||||||
(const :tag "Don't save last reading places" nil))
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defcustom nov-header-line-format "%t: %c"
|
|
||||||
"Header line format.
|
|
||||||
- %t is replaced by the title.
|
|
||||||
- %c is replaced by the chapter title."
|
|
||||||
:type 'string
|
|
||||||
:group 'nov)
|
|
||||||
|
|
||||||
(defvar-local nov-file-name nil
|
|
||||||
"Path to the EPUB file backing this buffer.")
|
|
||||||
|
|
||||||
(defvar-local nov-temp-dir nil
|
|
||||||
"Temporary directory containing the buffer's EPUB files.")
|
|
||||||
|
|
||||||
(defvar-local nov-content-file nil
|
|
||||||
"Path to the EPUB buffer's .opf file.")
|
|
||||||
|
|
||||||
(defvar-local nov-epub-version nil
|
|
||||||
"Version string of the EPUB buffer.")
|
|
||||||
|
|
||||||
(defvar-local nov-metadata nil
|
|
||||||
"Metadata of the EPUB buffer.")
|
|
||||||
|
|
||||||
(defvar-local nov-documents nil
|
|
||||||
"Alist for the EPUB buffer's documents.
|
|
||||||
Each alist item consists of the identifier and full path.")
|
|
||||||
|
|
||||||
(defvar-local nov-documents-index 0
|
|
||||||
"Index of the currently rendered document in the EPUB buffer.")
|
|
||||||
|
|
||||||
(defvar-local nov-toc-id nil
|
|
||||||
"TOC identifier of the EPUB buffer.")
|
|
||||||
|
|
||||||
(defvar-local nov-history nil
|
|
||||||
"Stack of documents user has visited.
|
|
||||||
Each element of the stack is a list (NODEINDEX BUFFERPOS).")
|
|
||||||
|
|
||||||
(defvar-local nov-history-forward nil
|
|
||||||
"Stack of documents user has visited with `nov-history-back' command.
|
|
||||||
Each element of the stack is a list (NODEINDEX BUFFERPOS).")
|
|
||||||
|
|
||||||
(defun nov-make-path (directory file)
|
|
||||||
"Create a path from DIRECTORY and FILE."
|
|
||||||
(concat (file-name-as-directory directory) file))
|
|
||||||
|
|
||||||
(defun nov-directory-files (directory)
|
|
||||||
"Returns a list of files in DIRECTORY except for . and .."
|
|
||||||
(seq-remove (lambda (file) (string-match-p "/\\.\\(?:\\.\\)?\\'" file))
|
|
||||||
(directory-files directory t)))
|
|
||||||
|
|
||||||
(defun nov-contains-nested-directory-p (directory)
|
|
||||||
"Non-nil if DIRECTORY contains exactly one directory."
|
|
||||||
(let* ((files (nov-directory-files directory))
|
|
||||||
(file (car files)))
|
|
||||||
(and (= (length files) 1)
|
|
||||||
(file-directory-p file)
|
|
||||||
file)))
|
|
||||||
|
|
||||||
(defun nov-unnest-directory (directory child)
|
|
||||||
"Move contents of CHILD into DIRECTORY, then delete CHILD."
|
|
||||||
;; FIXME: this will most certainly fail for con/con
|
|
||||||
(dolist (item (nov-directory-files child))
|
|
||||||
(rename-file item directory))
|
|
||||||
(delete-directory child))
|
|
||||||
|
|
||||||
(defun nov--fix-permissions (file-or-directory mode)
|
|
||||||
(let* ((modes (file-modes file-or-directory))
|
|
||||||
(fixed-mode (file-modes-symbolic-to-number mode modes)))
|
|
||||||
(set-file-modes file-or-directory fixed-mode)))
|
|
||||||
|
|
||||||
(defun nov-fix-permissions (directory)
|
|
||||||
"Iterate recursively through DIRECTORY to fix its files."
|
|
||||||
(nov--fix-permissions directory "+rx")
|
|
||||||
(dolist (file (nov-directory-files directory))
|
|
||||||
(if (file-directory-p file)
|
|
||||||
(nov-fix-permissions file)
|
|
||||||
(nov--fix-permissions file "+r"))))
|
|
||||||
|
|
||||||
(defun nov-unzip-epub (directory filename)
|
|
||||||
"Extract FILENAME into DIRECTORY.
|
|
||||||
Unnecessary nesting is removed with `nov-unnest-directory'."
|
|
||||||
(let* ((status (apply #'call-process nov-unzip-program nil "*nov unzip*" t
|
|
||||||
(mapcar (lambda (arg)
|
|
||||||
(cond
|
|
||||||
((eq arg 'directory) directory)
|
|
||||||
((eq arg 'filename) filename)
|
|
||||||
(t arg)))
|
|
||||||
nov-unzip-args)))
|
|
||||||
child)
|
|
||||||
(while (setq child (nov-contains-nested-directory-p directory))
|
|
||||||
(nov-unnest-directory directory child))
|
|
||||||
;; HACK: unzip preserves file permissions, no matter how silly they
|
|
||||||
;; are, so ensure files and directories are readable
|
|
||||||
(nov-fix-permissions directory)
|
|
||||||
status))
|
|
||||||
|
|
||||||
(defmacro nov-ignore-file-errors (&rest body)
|
|
||||||
"Like `ignore-errors', but for file errors."
|
|
||||||
`(condition-case nil (progn ,@body) (file-error nil)))
|
|
||||||
|
|
||||||
(defun nov-slurp (filename &optional parse-xml-p)
|
|
||||||
"Return the contents of FILENAME.
|
|
||||||
If PARSE-XML-P is t, return the contents as parsed by libxml."
|
|
||||||
(with-temp-buffer
|
|
||||||
(insert-file-contents filename)
|
|
||||||
(if parse-xml-p
|
|
||||||
(libxml-parse-xml-region (point-min) (point-max))
|
|
||||||
(buffer-string))))
|
|
||||||
|
|
||||||
(defun nov-mimetype-valid-p (directory)
|
|
||||||
"Return t if DIRECTORY contains a valid EPUB mimetype file."
|
|
||||||
(nov-ignore-file-errors
|
|
||||||
(let ((filename (nov-make-path directory "mimetype")))
|
|
||||||
(equal (nov-slurp filename) "application/epub+zip"))))
|
|
||||||
|
|
||||||
(defun nov-container-filename (directory)
|
|
||||||
"Return the container filename for DIRECTORY."
|
|
||||||
(let ((filename (nov-make-path directory "META-INF")))
|
|
||||||
(nov-make-path filename "container.xml")))
|
|
||||||
|
|
||||||
(defun nov-container-content-filename (content)
|
|
||||||
"Return the content filename for CONTENT."
|
|
||||||
(let* ((query "container>rootfiles>rootfile[media-type='application/oebps-package+xml']")
|
|
||||||
(node (esxml-query query content)))
|
|
||||||
(dom-attr node 'full-path)))
|
|
||||||
|
|
||||||
(defun nov-container-valid-p (directory)
|
|
||||||
"Return t if DIRECTORY holds a valid EPUB container."
|
|
||||||
(let ((filename (nov-container-filename directory)))
|
|
||||||
(when (and filename (file-exists-p filename))
|
|
||||||
(let* ((content (nov-slurp filename t))
|
|
||||||
(content-file (nov-container-content-filename content)))
|
|
||||||
(when (and content content-file)
|
|
||||||
(file-exists-p (nov-make-path directory content-file)))))))
|
|
||||||
|
|
||||||
(defun nov-epub-valid-p (directory)
|
|
||||||
"Return t if DIRECTORY makes up a valid EPUB document."
|
|
||||||
(when (not (nov-mimetype-valid-p directory))
|
|
||||||
(message "Invalid mimetype"))
|
|
||||||
(nov-container-valid-p directory))
|
|
||||||
|
|
||||||
(defun nov-urldecode (string)
|
|
||||||
"Return urldecoded version of STRING or nil."
|
|
||||||
(when string
|
|
||||||
(url-unhex-string string)))
|
|
||||||
|
|
||||||
(defun nov-content-version (content)
|
|
||||||
"Return the EPUB version for CONTENT."
|
|
||||||
(let* ((node (esxml-query "package" content))
|
|
||||||
(version (dom-attr node 'version)))
|
|
||||||
(when (not version)
|
|
||||||
(error "Version not specified"))
|
|
||||||
version))
|
|
||||||
|
|
||||||
(defun nov-content-unique-identifier-name (content)
|
|
||||||
"Return the unique identifier name referenced in CONTENT.
|
|
||||||
This is used in `nov-content-unique-identifier' to retrieve the
|
|
||||||
the specific type of unique identifier."
|
|
||||||
(let* ((node (esxml-query "package[unique-identifier]" content))
|
|
||||||
(name (dom-attr node 'unique-identifier)))
|
|
||||||
(when (not name)
|
|
||||||
(error "Unique identifier name not specified"))
|
|
||||||
name))
|
|
||||||
|
|
||||||
(defun nov-content-unique-identifier (content)
|
|
||||||
"Return the the unique identifier for CONTENT."
|
|
||||||
(let* ((name (nov-content-unique-identifier-name content))
|
|
||||||
(selector (format "package>metadata>identifier[id='%s']"
|
|
||||||
(esxml-query-css-escape name)))
|
|
||||||
(id (car (dom-children (esxml-query selector content)))))
|
|
||||||
(when (not id)
|
|
||||||
(error "Unique identifier not found by its name: %s" name))
|
|
||||||
(intern id)))
|
|
||||||
|
|
||||||
;; NOTE: unique identifier is queried separately as identifiers can
|
|
||||||
;; appear more than once and only one of them can be the unique one
|
|
||||||
(defvar nov-required-metadata-tags '(title language)
|
|
||||||
"Required metadata tags used for `nov-content-metadata'.")
|
|
||||||
|
|
||||||
(defvar nov-optional-metadata-tags
|
|
||||||
'(contributor coverage creator date description format
|
|
||||||
publisher relation rights source subject type)
|
|
||||||
"Optional metadata tags used for 'nov-content-metadata'.")
|
|
||||||
|
|
||||||
(defun nov-content-metadata (content)
|
|
||||||
"Return a metadata alist for CONTENT.
|
|
||||||
Required keys are 'identifier and everything in
|
|
||||||
`nov-required-metadata-tags', optional keys are in
|
|
||||||
`nov-optional-metadata-tags'."
|
|
||||||
(let* ((identifier (nov-content-unique-identifier content))
|
|
||||||
(candidates (mapcar (lambda (node)
|
|
||||||
(cons (dom-tag node) (car (dom-children node))))
|
|
||||||
(esxml-query-all "package>metadata>*" content)))
|
|
||||||
(required (mapcar (lambda (tag)
|
|
||||||
(let ((candidate (cdr (assq tag candidates))))
|
|
||||||
(when (not candidate)
|
|
||||||
;; NOTE: this should ideally be a
|
|
||||||
;; warning, but `warn' is too obtrusive
|
|
||||||
(message "Required metadatum %s not found" tag))
|
|
||||||
(cons tag candidate)))
|
|
||||||
nov-required-metadata-tags))
|
|
||||||
(optional (mapcar (lambda (tag) (cons tag (cdr (assq tag candidates))))
|
|
||||||
nov-optional-metadata-tags)))
|
|
||||||
(append `((identifier . ,identifier)) required optional)))
|
|
||||||
|
|
||||||
(defun nov-content-manifest (directory content)
|
|
||||||
"Extract an alist of manifest files for CONTENT in DIRECTORY.
|
|
||||||
Each alist item consists of the identifier and full path."
|
|
||||||
(mapcar (lambda (node)
|
|
||||||
(let ((id (dom-attr node 'id))
|
|
||||||
(href (dom-attr node 'href)))
|
|
||||||
(cons (intern id)
|
|
||||||
(nov-make-path directory (nov-urldecode href)))))
|
|
||||||
(esxml-query-all "package>manifest>item" content)))
|
|
||||||
|
|
||||||
(defun nov-content-spine (content)
|
|
||||||
"Extract a list of spine identifiers for CONTENT."
|
|
||||||
(mapcar (lambda (node) (intern (dom-attr node 'idref)))
|
|
||||||
(esxml-query-all "package>spine>itemref" content)))
|
|
||||||
|
|
||||||
(defun nov--content-epub2-files (content manifest files)
|
|
||||||
(let* ((node (esxml-query "package>spine[toc]" content))
|
|
||||||
(id (dom-attr node 'toc)))
|
|
||||||
(when (not id)
|
|
||||||
(error "EPUB 2 NCX ID not found"))
|
|
||||||
(setq nov-toc-id (intern id))
|
|
||||||
(let ((toc-file (assq nov-toc-id manifest)))
|
|
||||||
(when (not toc-file)
|
|
||||||
(error "EPUB 2 NCX file not found"))
|
|
||||||
(cons toc-file files))))
|
|
||||||
|
|
||||||
(defun nov--content-epub3-files (content manifest files)
|
|
||||||
(let* ((node (esxml-query "package>manifest>item[properties~=nav]" content))
|
|
||||||
(id (dom-attr node 'id)))
|
|
||||||
(when (not id)
|
|
||||||
(error "EPUB 3 <nav> ID not found"))
|
|
||||||
(setq nov-toc-id (intern id))
|
|
||||||
(let ((toc-file (assq nov-toc-id manifest)))
|
|
||||||
(when (not toc-file)
|
|
||||||
(error "EPUB 3 <nav> file not found"))
|
|
||||||
(setq files (seq-remove (lambda (item) (eq (car item) nov-toc-id)) files))
|
|
||||||
(cons toc-file files))))
|
|
||||||
|
|
||||||
(defun nov-content-files (directory content)
|
|
||||||
"Create correctly ordered file alist for CONTENT in DIRECTORY.
|
|
||||||
Each alist item consists of the identifier and full path."
|
|
||||||
(let* ((manifest (nov-content-manifest directory content))
|
|
||||||
(spine (nov-content-spine content))
|
|
||||||
(files (mapcar (lambda (item) (assq item manifest)) spine)))
|
|
||||||
(if (version< nov-epub-version "3.0")
|
|
||||||
(nov--content-epub2-files content manifest files)
|
|
||||||
(nov--content-epub3-files content manifest files))))
|
|
||||||
|
|
||||||
(defun nov--walk-ncx-node (node)
|
|
||||||
(let ((tag (dom-tag node))
|
|
||||||
(children (seq-filter (lambda (child) (eq (dom-tag child) 'navPoint))
|
|
||||||
(dom-children node))))
|
|
||||||
(cond
|
|
||||||
((eq tag 'navMap)
|
|
||||||
(insert "<ol>\n")
|
|
||||||
(mapc (lambda (node) (nov--walk-ncx-node node)) children)
|
|
||||||
(insert "</ol>\n"))
|
|
||||||
((eq tag 'navPoint)
|
|
||||||
(let* ((label-node (esxml-query "navLabel>text" node))
|
|
||||||
(content-node (esxml-query "content" node))
|
|
||||||
(href (nov-urldecode (dom-attr content-node 'src)))
|
|
||||||
(label (car (dom-children label-node))))
|
|
||||||
(when (not href)
|
|
||||||
(error "Navigation point is missing href attribute"))
|
|
||||||
(let ((link (format "<a href=\"%s\">%s</a>"
|
|
||||||
(xml-escape-string href)
|
|
||||||
(xml-escape-string (or label href)))))
|
|
||||||
(if children
|
|
||||||
(progn
|
|
||||||
(insert (format "<li>\n%s\n<ol>\n" link))
|
|
||||||
(mapc (lambda (node) (nov--walk-ncx-node node))
|
|
||||||
children)
|
|
||||||
(insert (format "</ol>\n</li>\n")))
|
|
||||||
(insert (format "<li>\n%s\n</li>\n" link)))))))))
|
|
||||||
|
|
||||||
(defun nov-ncx-to-html (path)
|
|
||||||
"Convert NCX document at PATH to HTML."
|
|
||||||
(let ((root (esxml-query "navMap" (nov-slurp path t))))
|
|
||||||
(with-temp-buffer
|
|
||||||
(nov--walk-ncx-node root)
|
|
||||||
(buffer-string))))
|
|
||||||
|
|
||||||
|
|
||||||
;;; UI
|
|
||||||
|
|
||||||
(defvar nov-mode-map
|
|
||||||
(let ((map (make-sparse-keymap)))
|
|
||||||
(define-key map (kbd "g") 'nov-render-document)
|
|
||||||
(define-key map (kbd "v") 'nov-view-source)
|
|
||||||
(define-key map (kbd "V") 'nov-view-content-source)
|
|
||||||
(define-key map (kbd "a") 'nov-reopen-as-archive)
|
|
||||||
(define-key map (kbd "m") 'nov-display-metadata)
|
|
||||||
(define-key map (kbd "n") 'nov-next-document)
|
|
||||||
(define-key map (kbd "]") 'nov-next-document)
|
|
||||||
(define-key map (kbd "p") 'nov-previous-document)
|
|
||||||
(define-key map (kbd "[") 'nov-previous-document)
|
|
||||||
(define-key map (kbd "t") 'nov-goto-toc)
|
|
||||||
(define-key map (kbd "l") 'nov-history-back)
|
|
||||||
(define-key map (kbd "r") 'nov-history-forward)
|
|
||||||
(define-key map (kbd "TAB") 'shr-next-link)
|
|
||||||
(define-key map (kbd "M-TAB") 'shr-previous-link)
|
|
||||||
(define-key map (kbd "<backtab>") 'shr-previous-link)
|
|
||||||
(define-key map (kbd "SPC") 'nov-scroll-up)
|
|
||||||
(define-key map (kbd "S-SPC") 'nov-scroll-down)
|
|
||||||
(define-key map (kbd "DEL") 'nov-scroll-down)
|
|
||||||
(define-key map (kbd "<home>") 'beginning-of-buffer)
|
|
||||||
(define-key map (kbd "<end>") 'end-of-buffer)
|
|
||||||
map))
|
|
||||||
|
|
||||||
(defvar nov-button-map
|
|
||||||
(let ((map (copy-keymap nov-mode-map)))
|
|
||||||
(set-keymap-parent map shr-map)
|
|
||||||
(define-key map (kbd "RET") 'nov-browse-url)
|
|
||||||
(define-key map (kbd "<mouse-2>") 'nov-browse-url)
|
|
||||||
(define-key map (kbd "c") 'nov-copy-url)
|
|
||||||
map))
|
|
||||||
|
|
||||||
(easy-menu-define nov-mode-menu nov-mode-map "Menu for nov-mode"
|
|
||||||
'("EPUB"
|
|
||||||
["Next" nov-next-document
|
|
||||||
:help "Go to the next document"]
|
|
||||||
["Previous" nov-previous-document
|
|
||||||
:help "Go to the previous document"]
|
|
||||||
["Backward" nov-history-back
|
|
||||||
:help "Go back in the history to the last visited document"]
|
|
||||||
["Forward" nov-history-forward
|
|
||||||
:help "Go forward in the history of visited documents"]
|
|
||||||
["Next Link" shr-next-link
|
|
||||||
:help "Go to the next link"]
|
|
||||||
["Previous Link" shr-previous-link
|
|
||||||
:keys "M-TAB"
|
|
||||||
:help "Go to the previous link"]
|
|
||||||
["Table of Contents" nov-goto-toc
|
|
||||||
:help "Display the table of contents"]
|
|
||||||
["Redisplay" nov-render-document
|
|
||||||
:help "Redisplay the document"]
|
|
||||||
"---"
|
|
||||||
["View Metadata" nov-display-metadata
|
|
||||||
:help "View the metadata of the EPUB document"]
|
|
||||||
["View HTML Source" nov-view-source
|
|
||||||
:help "View the HTML source of the current document in a new buffer"]
|
|
||||||
["View OPF Source" nov-view-content-source
|
|
||||||
:help "View the OPF source of the EPUB document in a new buffer"]
|
|
||||||
["View as Archive" nov-reopen-as-archive
|
|
||||||
:help "Reopen the EPUB document as an archive"]))
|
|
||||||
|
|
||||||
(defun nov-clean-up ()
|
|
||||||
"Delete temporary files of the current EPUB buffer."
|
|
||||||
(when nov-temp-dir
|
|
||||||
(let ((identifier (cdr (assq 'identifier nov-metadata)))
|
|
||||||
(index (if (integerp nov-documents-index)
|
|
||||||
nov-documents-index
|
|
||||||
0)))
|
|
||||||
(nov-save-place identifier index (point)))
|
|
||||||
(nov-ignore-file-errors
|
|
||||||
(delete-directory nov-temp-dir t))))
|
|
||||||
|
|
||||||
(defun nov-clean-up-all ()
|
|
||||||
"Delete temporary files of all opened EPUB buffers."
|
|
||||||
(dolist (buffer (buffer-list))
|
|
||||||
(with-current-buffer buffer
|
|
||||||
(when (eq major-mode 'nov-mode)
|
|
||||||
(nov-clean-up)))))
|
|
||||||
|
|
||||||
(defun nov-external-url-p (url)
|
|
||||||
"Return t if URL refers to an external document."
|
|
||||||
(and (url-type (url-generic-parse-url url)) t))
|
|
||||||
|
|
||||||
(defun nov-url-filename-and-target (url)
|
|
||||||
"Return a list of URL's filename and target."
|
|
||||||
(setq url (url-generic-parse-url url))
|
|
||||||
(mapcar 'nov-urldecode (list (url-filename url) (url-target url))))
|
|
||||||
|
|
||||||
;; adapted from `shr-rescale-image'
|
|
||||||
(defun nov-insert-image (path alt)
|
|
||||||
"Insert an image for PATH at point, falling back to ALT.
|
|
||||||
This function honors `shr-max-image-proportion' if possible."
|
|
||||||
(let ((type (if (or (and (fboundp 'image-transforms-p) (image-transforms-p))
|
|
||||||
(not (fboundp 'imagemagick-types)))
|
|
||||||
nil
|
|
||||||
'imagemagick)))
|
|
||||||
(if (not (display-graphic-p))
|
|
||||||
(insert alt)
|
|
||||||
(seq-let (x1 y1 x2 y2) (window-inside-pixel-edges
|
|
||||||
(get-buffer-window (current-buffer)))
|
|
||||||
(let ((image
|
|
||||||
;; `create-image' errors out for unsupported image types
|
|
||||||
(ignore-errors
|
|
||||||
(create-image path type nil
|
|
||||||
:ascent 100
|
|
||||||
:max-width (truncate (* shr-max-image-proportion
|
|
||||||
(- x2 x1)))
|
|
||||||
:max-height (truncate (* shr-max-image-proportion
|
|
||||||
(- y2 y1)))))))
|
|
||||||
(if image
|
|
||||||
(insert-image image)
|
|
||||||
(insert alt)))))))
|
|
||||||
|
|
||||||
(defvar nov-original-shr-tag-img-function
|
|
||||||
(symbol-function 'shr-tag-img))
|
|
||||||
|
|
||||||
(defun nov-render-img (dom &optional url)
|
|
||||||
"Custom <img> rendering function for DOM.
|
|
||||||
Uses `shr-tag-img' for external paths and `nov-insert-image' for
|
|
||||||
internal ones."
|
|
||||||
(let ((url (or url (cdr (assq 'src (cadr dom)))))
|
|
||||||
(alt (or (cdr (assq 'alt (cadr dom))) "")))
|
|
||||||
(if (nov-external-url-p url)
|
|
||||||
;; HACK: avoid hanging in an infinite loop when using
|
|
||||||
;; `cl-letf' to override `shr-tag-img' with a function that
|
|
||||||
;; might call `shr-tag-img' again
|
|
||||||
(funcall nov-original-shr-tag-img-function dom url)
|
|
||||||
(setq url (expand-file-name (nov-urldecode url)))
|
|
||||||
(nov-insert-image url alt))))
|
|
||||||
|
|
||||||
(defun nov-render-title (dom)
|
|
||||||
"Custom <title> rendering function for DOM.
|
|
||||||
Sets `header-line-format' according to `nov-header-line-format'."
|
|
||||||
(setq header-line-format
|
|
||||||
(and nov-header-line-format
|
|
||||||
(let ((title (cdr (assq 'title nov-metadata)))
|
|
||||||
(chapter-title (car (dom-children dom))))
|
|
||||||
(when (not chapter-title)
|
|
||||||
(setq chapter-title (propertize "No title" 'face 'italic)))
|
|
||||||
;; this shouldn't happen for properly authored EPUBs
|
|
||||||
(when (not title)
|
|
||||||
(setq title (propertize "No title" 'face 'italic)))
|
|
||||||
(string-replace
|
|
||||||
"%" "%%"
|
|
||||||
(format-spec
|
|
||||||
nov-header-line-format
|
|
||||||
`((?c . ,chapter-title)
|
|
||||||
(?t . ,title))))))))
|
|
||||||
|
|
||||||
(defvar nov-shr-rendering-functions
|
|
||||||
'(;; default function uses url-retrieve and fails on local images
|
|
||||||
(img . nov-render-img)
|
|
||||||
;; titles are rendered *inside* the document by default
|
|
||||||
(title . nov-render-title))
|
|
||||||
"Alist of rendering functions used with `shr-render-region'.")
|
|
||||||
|
|
||||||
(defun nov-render-html ()
|
|
||||||
"Render HTML in current buffer with shr."
|
|
||||||
(run-hooks 'nov-pre-html-render-hook)
|
|
||||||
(let (;; HACK: make buttons use our own commands
|
|
||||||
(shr-map nov-button-map)
|
|
||||||
(shr-external-rendering-functions nov-shr-rendering-functions)
|
|
||||||
(shr-use-fonts nov-variable-pitch))
|
|
||||||
;; HACK: `shr-external-rendering-functions' doesn't cover
|
|
||||||
;; every usage of `shr-tag-img'
|
|
||||||
(cl-letf (((symbol-function 'shr-tag-img) 'nov-render-img))
|
|
||||||
(if (eq nov-text-width t)
|
|
||||||
(cl-letf (((symbol-function 'shr-fill-line) 'ignore))
|
|
||||||
(shr-render-region (point-min) (point-max)))
|
|
||||||
(let ((shr-width nov-text-width))
|
|
||||||
(shr-render-region (point-min) (point-max))))))
|
|
||||||
(run-hooks 'nov-post-html-render-hook))
|
|
||||||
|
|
||||||
(defun nov-render-document ()
|
|
||||||
"Render the document referenced by `nov-documents-index'.
|
|
||||||
If the document path refers to an image (as determined by
|
|
||||||
`image-type-file-name-regexps'), an image is inserted, otherwise
|
|
||||||
the HTML is rendered with `nov-render-html-function'."
|
|
||||||
(interactive)
|
|
||||||
(seq-let (id &rest path) (aref nov-documents nov-documents-index)
|
|
||||||
(let (;; HACK: this should be looked up in the manifest
|
|
||||||
(imagep (seq-find (lambda (item) (string-match-p (car item) path))
|
|
||||||
image-type-file-name-regexps))
|
|
||||||
;; NOTE: allows resolving image references correctly
|
|
||||||
(default-directory (file-name-directory path))
|
|
||||||
buffer-read-only)
|
|
||||||
(erase-buffer)
|
|
||||||
|
|
||||||
(cond
|
|
||||||
(imagep
|
|
||||||
(nov-insert-image path ""))
|
|
||||||
((and (version< nov-epub-version "3.0")
|
|
||||||
(eq id nov-toc-id))
|
|
||||||
(insert (nov-ncx-to-html path)))
|
|
||||||
(t
|
|
||||||
(insert (nov-slurp path))))
|
|
||||||
|
|
||||||
(when (not imagep)
|
|
||||||
(funcall nov-render-html-function))
|
|
||||||
(goto-char (point-min)))))
|
|
||||||
|
|
||||||
(defun nov-find-document (predicate)
|
|
||||||
"Return first item in `nov-documents' PREDICATE is true for."
|
|
||||||
(let ((i 0)
|
|
||||||
done)
|
|
||||||
(while (and (not done)
|
|
||||||
(< i (length nov-documents)))
|
|
||||||
(when (funcall predicate (aref nov-documents i))
|
|
||||||
(setq done t))
|
|
||||||
(setq i (1+ i)))
|
|
||||||
(when done
|
|
||||||
(1- i))))
|
|
||||||
|
|
||||||
(defun nov-goto-document (index)
|
|
||||||
"Go to the document denoted by INDEX."
|
|
||||||
(let ((history (cons (list nov-documents-index (point))
|
|
||||||
nov-history)))
|
|
||||||
(setq nov-documents-index index)
|
|
||||||
(nov-render-document)
|
|
||||||
(setq nov-history history)))
|
|
||||||
|
|
||||||
(defun nov-goto-toc ()
|
|
||||||
"Go to the TOC index and render the TOC document."
|
|
||||||
(interactive)
|
|
||||||
(let ((index (nov-find-document (lambda (doc) (eq (car doc) nov-toc-id)))))
|
|
||||||
(when (not index)
|
|
||||||
(error "Couldn't locate TOC"))
|
|
||||||
(nov-goto-document index)))
|
|
||||||
|
|
||||||
(defun nov-view-source ()
|
|
||||||
"View the source of the current document in a new buffer."
|
|
||||||
(interactive)
|
|
||||||
(find-file (cdr (aref nov-documents nov-documents-index))))
|
|
||||||
|
|
||||||
(defun nov-view-content-source ()
|
|
||||||
"View the source of the content file in a new buffer."
|
|
||||||
(interactive)
|
|
||||||
(find-file nov-content-file))
|
|
||||||
|
|
||||||
(defun nov-reopen-as-archive ()
|
|
||||||
"Reopen the EPUB document using `archive-mode'."
|
|
||||||
(interactive)
|
|
||||||
(with-current-buffer (find-file-literally nov-file-name)
|
|
||||||
(archive-mode)))
|
|
||||||
|
|
||||||
(defun nov-display-metadata ()
|
|
||||||
"View the metadata of the EPUB document in a new buffer."
|
|
||||||
(interactive)
|
|
||||||
(let ((buffer "*EPUB metadata*")
|
|
||||||
(metadata nov-metadata)
|
|
||||||
(version nov-epub-version))
|
|
||||||
(with-current-buffer (get-buffer-create buffer)
|
|
||||||
(special-mode)
|
|
||||||
(let (buffer-read-only)
|
|
||||||
(erase-buffer)
|
|
||||||
(insert (format "EPUB Version: %s\n" version))
|
|
||||||
(dolist (item metadata)
|
|
||||||
(seq-let (key &rest value) item
|
|
||||||
(insert (format "%s: " (capitalize (symbol-name key))))
|
|
||||||
(if value
|
|
||||||
(if (eq key 'description)
|
|
||||||
(let ((beg (point)))
|
|
||||||
(insert value)
|
|
||||||
(shr-render-region beg (point)))
|
|
||||||
(insert (format "%s" value)))
|
|
||||||
(insert (propertize "None" 'face 'italic)))
|
|
||||||
(insert "\n")))
|
|
||||||
(goto-char (point-min))))
|
|
||||||
(pop-to-buffer buffer)))
|
|
||||||
|
|
||||||
(defun nov-next-document ()
|
|
||||||
"Go to the next document and render it."
|
|
||||||
(interactive)
|
|
||||||
(when (< nov-documents-index (1- (length nov-documents)))
|
|
||||||
(nov-goto-document (1+ nov-documents-index))))
|
|
||||||
|
|
||||||
(defun nov-previous-document ()
|
|
||||||
"Go to the previous document and render it."
|
|
||||||
(interactive)
|
|
||||||
(when (> nov-documents-index 0)
|
|
||||||
(nov-goto-document (1- nov-documents-index))))
|
|
||||||
|
|
||||||
(defun nov-scroll-up (arg)
|
|
||||||
"Scroll with `scroll-up' or visit next chapter if at bottom."
|
|
||||||
(interactive "P")
|
|
||||||
(if (>= (window-end) (point-max))
|
|
||||||
(nov-next-document)
|
|
||||||
(scroll-up arg)))
|
|
||||||
|
|
||||||
(defun nov-scroll-down (arg)
|
|
||||||
"Scroll with `scroll-down' or visit previous chapter if at top."
|
|
||||||
(interactive "P")
|
|
||||||
(if (and (<= (window-start) (point-min))
|
|
||||||
(> nov-documents-index 0))
|
|
||||||
(progn
|
|
||||||
(nov-previous-document)
|
|
||||||
(goto-char (point-max)))
|
|
||||||
(scroll-down arg)))
|
|
||||||
|
|
||||||
(defun nov-visit-relative-file (filename target)
|
|
||||||
"Visit the document as specified by FILENAME and TARGET."
|
|
||||||
(let (index)
|
|
||||||
(when (not (zerop (length filename)))
|
|
||||||
(let* ((current-path (cdr (aref nov-documents nov-documents-index)))
|
|
||||||
(directory (file-name-directory current-path))
|
|
||||||
(path (file-truename (nov-make-path directory filename)))
|
|
||||||
(match (nov-find-document
|
|
||||||
(lambda (doc) (equal path (file-truename (cdr doc)))))))
|
|
||||||
(when (not match)
|
|
||||||
(error "Couldn't locate document"))
|
|
||||||
(setq index match)))
|
|
||||||
;; HACK: this binding is only need for Emacs 27.1 and older, as of
|
|
||||||
;; Emacs 28.1, shr.el always adds the shr-target-id property
|
|
||||||
(let ((shr-target-id target))
|
|
||||||
(nov-goto-document (or index nov-documents-index))))
|
|
||||||
(when target
|
|
||||||
(let ((pos (point-min))
|
|
||||||
done)
|
|
||||||
(while (and (not done)
|
|
||||||
(setq pos (next-single-property-change pos 'shr-target-id)))
|
|
||||||
(let ((property (get-text-property pos 'shr-target-id)))
|
|
||||||
(when (or (equal property target)
|
|
||||||
;; NOTE: as of Emacs 28.1 this may be a list of targets
|
|
||||||
(and (consp property) (member target property)))
|
|
||||||
(goto-char pos)
|
|
||||||
(recenter (1- (max 1 scroll-margin)))
|
|
||||||
(setq done t))))
|
|
||||||
(when (not done)
|
|
||||||
(error "Couldn't locate target")))))
|
|
||||||
|
|
||||||
;; adapted from `shr-browse-url'
|
|
||||||
(defun nov-browse-url (&optional mouse-event)
|
|
||||||
"Follow an external url with `browse-url'.
|
|
||||||
Internal URLs are visited with `nov-visit-relative-file'."
|
|
||||||
(interactive (list last-nonmenu-event))
|
|
||||||
(mouse-set-point mouse-event)
|
|
||||||
(let ((url (get-text-property (point) 'shr-url)))
|
|
||||||
(when (not url)
|
|
||||||
(user-error "No link under point"))
|
|
||||||
(if (nov-external-url-p url)
|
|
||||||
(browse-url url)
|
|
||||||
(apply 'nov-visit-relative-file (nov-url-filename-and-target url)))))
|
|
||||||
|
|
||||||
(defun nov-copy-url (&optional mouse-event)
|
|
||||||
(interactive (list last-nonmenu-event))
|
|
||||||
(mouse-set-point mouse-event)
|
|
||||||
(let ((url (get-text-property (point) 'shr-url)))
|
|
||||||
(when (not url)
|
|
||||||
(user-error "No link under point"))
|
|
||||||
(kill-new url)
|
|
||||||
(message "%s" url)))
|
|
||||||
|
|
||||||
(defun nov-saved-places ()
|
|
||||||
"Retrieve saved places in `nov-save-place-file'."
|
|
||||||
(when (and nov-save-place-file (file-exists-p nov-save-place-file))
|
|
||||||
(with-temp-buffer
|
|
||||||
(insert-file-contents-literally nov-save-place-file)
|
|
||||||
(goto-char (point-min))
|
|
||||||
(read (current-buffer)))))
|
|
||||||
|
|
||||||
(defun nov-saved-place (identifier)
|
|
||||||
"Retrieve saved place for IDENTIFIER in `nov-saved-place-file'."
|
|
||||||
(cdr (assq identifier (nov-saved-places))))
|
|
||||||
|
|
||||||
(defun nov-save-place (identifier index point)
|
|
||||||
"Save place as identified by IDENTIFIER, INDEX and POINT.
|
|
||||||
Saving is only done if `nov-save-place-file' is set."
|
|
||||||
(when nov-save-place-file
|
|
||||||
(let* ((place `(,identifier (index . ,index)
|
|
||||||
(point . ,point)))
|
|
||||||
(places (cons place (assq-delete-all identifier (nov-saved-places))))
|
|
||||||
print-level
|
|
||||||
print-length)
|
|
||||||
(with-temp-file nov-save-place-file
|
|
||||||
(insert (prin1-to-string places))))))
|
|
||||||
|
|
||||||
(defun nov--index-valid-p (documents index)
|
|
||||||
(and (integerp index)
|
|
||||||
(>= index 0)
|
|
||||||
(< index (length documents))))
|
|
||||||
|
|
||||||
(defun nov-history-back ()
|
|
||||||
"Go back in the history to the last visited document."
|
|
||||||
(interactive)
|
|
||||||
(or nov-history
|
|
||||||
(user-error "This is the first document you looked at"))
|
|
||||||
(let ((history-forward (cons (list nov-documents-index (point))
|
|
||||||
nov-history-forward)))
|
|
||||||
(seq-let (index opoint) (car nov-history)
|
|
||||||
(setq nov-history (cdr nov-history))
|
|
||||||
(nov-goto-document index)
|
|
||||||
(setq nov-history (cdr nov-history))
|
|
||||||
(setq nov-history-forward history-forward)
|
|
||||||
(goto-char opoint)
|
|
||||||
(recenter (1- (max 1 scroll-margin))))))
|
|
||||||
|
|
||||||
(defun nov-history-forward ()
|
|
||||||
"Go forward in the history of visited documents."
|
|
||||||
(interactive)
|
|
||||||
(or nov-history-forward
|
|
||||||
(user-error "This is the last document you looked at"))
|
|
||||||
(let ((history-forward (cdr nov-history-forward)))
|
|
||||||
(seq-let (index opoint) (car nov-history-forward)
|
|
||||||
(nov-goto-document index)
|
|
||||||
(setq nov-history-forward history-forward)
|
|
||||||
(goto-char opoint)
|
|
||||||
(recenter (1- (max 1 scroll-margin))))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(define-derived-mode nov-mode special-mode "EPUB"
|
|
||||||
"Major mode for reading EPUB documents"
|
|
||||||
(add-hook 'kill-buffer-hook 'nov-clean-up nil t)
|
|
||||||
(add-hook 'kill-emacs-hook 'nov-clean-up-all)
|
|
||||||
(add-hook 'change-major-mode-hook 'nov-clean-up nil t)
|
|
||||||
(when (not buffer-file-name)
|
|
||||||
(error "EPUB must be associated with file"))
|
|
||||||
(when (not nov-unzip-program)
|
|
||||||
(error "unzip executable not found, customize `nov-unzip-program'"))
|
|
||||||
(setq nov-temp-dir (make-temp-file "nov-" t ".epub"))
|
|
||||||
(let ((exit-code (nov-unzip-epub nov-temp-dir buffer-file-name)))
|
|
||||||
(when (not (integerp exit-code))
|
|
||||||
(nov-clean-up)
|
|
||||||
(error "EPUB extraction aborted by signal %s" exit-code))
|
|
||||||
(when (> exit-code 1) ; exit code 1 is most likely a warning
|
|
||||||
(nov-clean-up)
|
|
||||||
(error "EPUB extraction failed with exit code %d (see *nov unzip* buffer)"
|
|
||||||
exit-code)))
|
|
||||||
(when (not (nov-epub-valid-p nov-temp-dir))
|
|
||||||
(nov-clean-up)
|
|
||||||
(error "Invalid EPUB file"))
|
|
||||||
(let* ((content (nov-slurp (nov-container-filename nov-temp-dir) t))
|
|
||||||
(content-file-name (nov-container-content-filename content))
|
|
||||||
(content-file (nov-make-path nov-temp-dir content-file-name))
|
|
||||||
(work-dir (file-name-directory content-file))
|
|
||||||
(content (nov-slurp content-file t)))
|
|
||||||
(setq nov-content-file content-file)
|
|
||||||
(setq nov-epub-version (nov-content-version content))
|
|
||||||
(setq nov-metadata (nov-content-metadata content))
|
|
||||||
(setq nov-documents (apply 'vector (nov-content-files work-dir content)))
|
|
||||||
(setq nov-documents-index 0))
|
|
||||||
(setq buffer-undo-list t)
|
|
||||||
(setq nov-file-name (buffer-file-name))
|
|
||||||
(setq-local bookmark-make-record-function
|
|
||||||
'nov-bookmark-make-record)
|
|
||||||
(set-visited-file-name nil t) ; disable autosaves and save questions
|
|
||||||
(let ((place (nov-saved-place (cdr (assq 'identifier nov-metadata)))))
|
|
||||||
(if place
|
|
||||||
(let ((index (cdr (assq 'index place)))
|
|
||||||
(point (cdr (assq 'point place))))
|
|
||||||
(if (nov--index-valid-p nov-documents index)
|
|
||||||
(progn
|
|
||||||
(setq nov-documents-index index)
|
|
||||||
(nov-render-document)
|
|
||||||
(goto-char point))
|
|
||||||
(warn "Couldn't restore last position")
|
|
||||||
(nov-render-document)))
|
|
||||||
(nov-render-document))))
|
|
||||||
|
|
||||||
|
|
||||||
;;; recentf interop
|
|
||||||
|
|
||||||
(defun nov-add-to-recentf ()
|
|
||||||
"Add real path to recentf list if possible."
|
|
||||||
(when nov-file-name
|
|
||||||
(recentf-add-file nov-file-name)))
|
|
||||||
|
|
||||||
(add-hook 'nov-mode-hook 'nov-add-to-recentf)
|
|
||||||
(add-hook 'nov-mode-hook 'hack-dir-local-variables-non-file-buffer)
|
|
||||||
|
|
||||||
|
|
||||||
(defun nov--find-file (file index point)
|
|
||||||
"Open FILE in nov-mode and go to the specified INDEX and POSITION.
|
|
||||||
If FILE is nil, the current buffer is used."
|
|
||||||
(when file
|
|
||||||
(find-file file))
|
|
||||||
(unless (eq major-mode 'nov-mode)
|
|
||||||
(nov-mode))
|
|
||||||
(when (not (nov--index-valid-p nov-documents index))
|
|
||||||
(error "Invalid documents index"))
|
|
||||||
(setq nov-documents-index index)
|
|
||||||
(nov-render-document)
|
|
||||||
(goto-char point))
|
|
||||||
|
|
||||||
;; Bookmark interop
|
|
||||||
(defun nov-bookmark-make-record ()
|
|
||||||
"Create a bookmark epub record."
|
|
||||||
(cons (buffer-name)
|
|
||||||
`((filename . ,nov-file-name)
|
|
||||||
(index . ,nov-documents-index)
|
|
||||||
(position . ,(point))
|
|
||||||
(handler . nov-bookmark-jump-handler))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun nov-bookmark-jump-handler (bmk)
|
|
||||||
"The bookmark handler-function interface for bookmark BMK.
|
|
||||||
|
|
||||||
See also `nov-bookmark-make-record'."
|
|
||||||
(let ((file (bookmark-prop-get bmk 'filename))
|
|
||||||
(index (bookmark-prop-get bmk 'index))
|
|
||||||
(position (bookmark-prop-get bmk 'position)))
|
|
||||||
(nov--find-file file index position)))
|
|
||||||
|
|
||||||
|
|
||||||
;;; Org interop
|
|
||||||
|
|
||||||
(defun nov-org-link-follow (path)
|
|
||||||
"Follow nov: link designated by PATH."
|
|
||||||
(if (string-match "^\\(.*\\)::\\([0-9]+\\):\\([0-9]+\\)$" path)
|
|
||||||
(let ((file (match-string 1 path))
|
|
||||||
(index (string-to-number (match-string 2 path)))
|
|
||||||
(point (string-to-number (match-string 3 path))))
|
|
||||||
(nov--find-file file index point))
|
|
||||||
(error "Invalid nov.el link")))
|
|
||||||
|
|
||||||
(defun nov-org-link-store ()
|
|
||||||
"Store current EPUB location as nov: link."
|
|
||||||
(when (and (eq major-mode 'nov-mode) nov-file-name)
|
|
||||||
(when (not (integerp nov-documents-index))
|
|
||||||
(setq nov-documents-index 0))
|
|
||||||
(let ((org-store-props-function
|
|
||||||
(if (fboundp 'org-link-store-props)
|
|
||||||
'org-link-store-props
|
|
||||||
'org-store-link-props))
|
|
||||||
(link (format "nov:%s::%d:%d"
|
|
||||||
nov-file-name
|
|
||||||
nov-documents-index
|
|
||||||
(point)))
|
|
||||||
(description (format "EPUB file at %s" nov-file-name)))
|
|
||||||
(funcall org-store-props-function
|
|
||||||
:type "nov"
|
|
||||||
:link link
|
|
||||||
:description description))))
|
|
||||||
|
|
||||||
(cond
|
|
||||||
((fboundp 'org-link-set-parameters)
|
|
||||||
(org-link-set-parameters
|
|
||||||
"nov"
|
|
||||||
:follow 'nov-org-link-follow
|
|
||||||
:store 'nov-org-link-store))
|
|
||||||
((fboundp 'org-add-link-type)
|
|
||||||
(org-add-link-type "nov" 'nov-org-link-follow)
|
|
||||||
(add-hook 'org-store-link-functions 'nov-org-link-store)))
|
|
||||||
|
|
||||||
|
|
||||||
;;; Imenu interop
|
|
||||||
|
|
||||||
(defun nov-imenu-goto-function (_name filename target)
|
|
||||||
"Visit imenu item using FILENAME and TARGET."
|
|
||||||
(nov-visit-relative-file filename target))
|
|
||||||
|
|
||||||
(defun nov-imenu-create-index ()
|
|
||||||
"Generate Imenu index."
|
|
||||||
(let* ((toc-path (cdr (aref nov-documents 0)))
|
|
||||||
(ncxp (version< nov-epub-version "3.0"))
|
|
||||||
(toc (with-temp-buffer
|
|
||||||
(if ncxp
|
|
||||||
(insert (nov-ncx-to-html toc-path))
|
|
||||||
(insert-file-contents toc-path))
|
|
||||||
(libxml-parse-html-region (point-min) (point-max)))))
|
|
||||||
(mapcar
|
|
||||||
(lambda (node)
|
|
||||||
(let ((href (dom-attr node 'href))
|
|
||||||
(label (dom-text node)))
|
|
||||||
(seq-let (filename target) (nov-url-filename-and-target href)
|
|
||||||
(list label filename 'nov-imenu-goto-function target))))
|
|
||||||
(esxml-query-all "a" toc))))
|
|
||||||
|
|
||||||
(defun nov-imenu-setup ()
|
|
||||||
(setq imenu-create-index-function 'nov-imenu-create-index))
|
|
||||||
(add-hook 'nov-mode-hook 'nov-imenu-setup)
|
|
||||||
|
|
||||||
(provide 'nov)
|
|
||||||
;;; nov.el ends here
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
;;; org-noter-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(add-to-list 'load-path (directory-file-name
|
|
||||||
(or (file-name-directory #$) (car load-path))))
|
|
||||||
|
|
||||||
|
|
||||||
;;;### (autoloads nil "org-noter" "org-noter.el" (0 0 0 0))
|
|
||||||
;;; Generated autoloads from org-noter.el
|
|
||||||
|
|
||||||
(autoload 'org-noter "org-noter" "\
|
|
||||||
Start `org-noter' session.
|
|
||||||
|
|
||||||
There are two modes of operation. You may create the session from:
|
|
||||||
- The Org notes file
|
|
||||||
- The document to be annotated (PDF, EPUB, ...)
|
|
||||||
|
|
||||||
- Creating the session from notes file -----------------------------------------
|
|
||||||
This will open a session for taking your notes, with indirect
|
|
||||||
buffers to the document and the notes side by side. Your current
|
|
||||||
window configuration won't be changed, because this opens in a
|
|
||||||
new frame.
|
|
||||||
|
|
||||||
You only need to run this command inside a heading (which will
|
|
||||||
hold the notes for this document). If no document path property is found,
|
|
||||||
this command will ask you for the target file.
|
|
||||||
|
|
||||||
With a prefix universal argument ARG, only check for the property
|
|
||||||
in the current heading, don't inherit from parents.
|
|
||||||
|
|
||||||
With 2 prefix universal arguments ARG, ask for a new document,
|
|
||||||
even if the current heading annotates one.
|
|
||||||
|
|
||||||
With a prefix number ARG:
|
|
||||||
- Greater than 0: Open the document like `find-file'
|
|
||||||
- Equal to 0: Create session with `org-noter-always-create-frame' toggled
|
|
||||||
- Less than 0: Open the folder containing the document
|
|
||||||
|
|
||||||
- Creating the session from the document ---------------------------------------
|
|
||||||
This will try to find a notes file in any of the parent folders.
|
|
||||||
The names it will search for are defined in `org-noter-default-notes-file-names'.
|
|
||||||
It will also try to find a notes file with the same name as the
|
|
||||||
document, giving it the maximum priority.
|
|
||||||
|
|
||||||
When it doesn't find anything, it will interactively ask you what
|
|
||||||
you want it to do. The target notes file must be in a parent
|
|
||||||
folder (direct or otherwise) of the document.
|
|
||||||
|
|
||||||
You may pass a prefix ARG in order to make it let you choose the
|
|
||||||
notes file, even if it finds one.
|
|
||||||
|
|
||||||
\(fn &optional ARG)" t nil)
|
|
||||||
|
|
||||||
(register-definition-prefixes "org-noter" '("org-noter-"))
|
|
||||||
|
|
||||||
;;;***
|
|
||||||
|
|
||||||
;; Local Variables:
|
|
||||||
;; version-control: never
|
|
||||||
;; no-byte-compile: t
|
|
||||||
;; no-update-autoloads: t
|
|
||||||
;; coding: utf-8
|
|
||||||
;; End:
|
|
||||||
;;; org-noter-autoloads.el ends here
|
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
;;; Generated package description from org-noter.el -*- no-byte-compile: t -*-
|
|
||||||
(define-package "org-noter" "20191020.1212" "A synchronized, Org-mode, document annotator" '((emacs "24.4") (cl-lib "0.6") (org "9.0")) :commit "9ead81d42dd4dd5074782d239b2efddf9b8b7b3d" :authors '((nil . "Gonçalo Santos (aka. weirdNox@GitHub)")) :maintainer '(nil . "Gonçalo Santos (aka. weirdNox@GitHub)") :keywords '("lisp" "pdf" "interleave" "annotate" "external" "sync" "notes" "documents" "org-mode") :url "https://github.com/weirdNox/org-noter")
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,47 +0,0 @@
|
||||||
;;; org-pdftools-autoloads.el --- automatically extracted autoloads -*- lexical-binding: t -*-
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(add-to-list 'load-path (directory-file-name
|
|
||||||
(or (file-name-directory #$) (car load-path))))
|
|
||||||
|
|
||||||
|
|
||||||
;;;### (autoloads nil "org-pdftools" "org-pdftools.el" (0 0 0 0))
|
|
||||||
;;; Generated autoloads from org-pdftools.el
|
|
||||||
|
|
||||||
(autoload 'org-pdftools-open "org-pdftools" "\
|
|
||||||
Function to open org-pdftools LINK.
|
|
||||||
|
|
||||||
\(fn LINK)" nil nil)
|
|
||||||
|
|
||||||
(autoload 'org-pdftools-store-link "org-pdftools" "\
|
|
||||||
Store a link to a pdfview/pdfoccur buffer." nil nil)
|
|
||||||
|
|
||||||
(autoload 'org-pdftools-export "org-pdftools" "\
|
|
||||||
Export the pdfview LINK with DESCRIPTION for FORMAT from Org files.
|
|
||||||
|
|
||||||
\(fn LINK DESCRIPTION FORMAT)" nil nil)
|
|
||||||
|
|
||||||
(autoload 'org-pdftools-setup-link "org-pdftools" "\
|
|
||||||
Set up pdf: links in org-mode.
|
|
||||||
|
|
||||||
\(fn &optional PREFIX)" nil nil)
|
|
||||||
|
|
||||||
(autoload 'org-pdftools-complete-link "org-pdftools" "\
|
|
||||||
Use the existing file name completion for file.
|
|
||||||
Links to get the file name, then ask the user for the page number
|
|
||||||
and append it. ARG is passed to `org-link-complete-file'.
|
|
||||||
|
|
||||||
\(fn &optional ARG)" nil nil)
|
|
||||||
|
|
||||||
(register-definition-prefixes "org-pdftools" '("org-pdftools-"))
|
|
||||||
|
|
||||||
;;;***
|
|
||||||
|
|
||||||
;; Local Variables:
|
|
||||||
;; version-control: never
|
|
||||||
;; no-byte-compile: t
|
|
||||||
;; no-update-autoloads: t
|
|
||||||
;; coding: utf-8
|
|
||||||
;; End:
|
|
||||||
;;; org-pdftools-autoloads.el ends here
|
|
||||||
|
|
@ -1,2 +0,0 @@
|
||||||
;;; Generated package description from org-pdftools.el -*- no-byte-compile: t -*-
|
|
||||||
(define-package "org-pdftools" "20220320.301" "Support for links to documents in pdfview mode" '((emacs "26.1") (org "9.3.6") (pdf-tools "0.8") (org-noter "1.4.1")) :commit "967f48fb5038bba32915ee9da8dc4e8b10ba3376" :authors '(("Alexander Fu Xi" . "fuxialexander@gmail.com")) :maintainer '("Alexander Fu Xi" . "fuxialexnader@gmail.com") :keywords '("convenience") :url "https://github.com/fuxialexander/org-pdftools")
|
|
||||||
|
|
@ -1,435 +0,0 @@
|
||||||
;;; org-pdftools.el --- Support for links to documents in pdfview mode -*- lexical-binding: t; -*-
|
|
||||||
;; Copyright (C) 2020 Alexander Fu Xi
|
|
||||||
|
|
||||||
;; Author: Alexander Fu Xi <fuxialexander@gmail.com>
|
|
||||||
;; Maintainer: Alexander Fu Xi <fuxialexnader@gmail.com>
|
|
||||||
;; Homepage: https://github.com/fuxialexander/org-pdftools
|
|
||||||
;; Version: 1.0
|
|
||||||
;; Package-Version: 20220320.301
|
|
||||||
;; Package-Commit: 967f48fb5038bba32915ee9da8dc4e8b10ba3376
|
|
||||||
;; Keywords: convenience
|
|
||||||
;; Package-Requires: ((emacs "26.1") (org "9.3.6") (pdf-tools "0.8") (org-noter "1.4.1"))
|
|
||||||
|
|
||||||
;; This program 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 3 of the License, or
|
|
||||||
;; (at your option) any later version.
|
|
||||||
;;
|
|
||||||
;; This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
;; Add support for org links from pdftools buffers with more precise location control.
|
|
||||||
;;
|
|
||||||
;; https://github.com/fuxialexander/org-pdftools/
|
|
||||||
|
|
||||||
|
|
||||||
;;; Code:
|
|
||||||
(require 'subr-x)
|
|
||||||
(require 'cl-lib)
|
|
||||||
(require 'org)
|
|
||||||
(require 'org-refile nil t)
|
|
||||||
(require 'org-noter)
|
|
||||||
(require 'pdf-tools)
|
|
||||||
(require 'pdf-view)
|
|
||||||
(require 'pdf-annot)
|
|
||||||
(require 'pdf-occur)
|
|
||||||
|
|
||||||
(defgroup org-pdftools nil
|
|
||||||
"Tools for adding pdftools link support in Org mode."
|
|
||||||
:group 'tools)
|
|
||||||
|
|
||||||
(defcustom org-pdftools-get-desc-function #'org-pdftools-get-desc-default
|
|
||||||
"A function that takes 3 arguments and output a link description.
|
|
||||||
- `file': basename of the PDF file
|
|
||||||
- `page': current page number converted to string
|
|
||||||
- `text' (should have optional tag): additional text infomation like highlighted text or isearch string.
|
|
||||||
See `org-pdftools-get-desc-default' as an example."
|
|
||||||
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'function)
|
|
||||||
(defcustom org-pdftools-path-generator #'abbreviate-file-name
|
|
||||||
"Translate your PDF file path the way you like. Take buffer-file-name as the argument."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'function)
|
|
||||||
(defcustom org-pdftools-path-resolver #'expand-file-name
|
|
||||||
"Resolve your translated PDF file path back to an absolute path."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'function)
|
|
||||||
(defcustom org-pdftools-open-custom-open nil
|
|
||||||
"Custom function to open linked pdf files."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type '(choice function nil))
|
|
||||||
|
|
||||||
(defcustom org-pdftools-use-freepointer-annot nil
|
|
||||||
"Whether prompt to use freepointer annotation or not. "
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'boolean)
|
|
||||||
|
|
||||||
(defcustom org-pdftools-use-isearch-link nil
|
|
||||||
"Whether prompt to use isearch link or not. "
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'boolean)
|
|
||||||
|
|
||||||
(defcustom org-pdftools-export-style 'pdftools
|
|
||||||
"Export style of org-pdftools links.
|
|
||||||
- pdftools :: export the link as is
|
|
||||||
- protocol :: export the link as a org-protocal link such that it could open pdf-tools when clicked
|
|
||||||
"
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'symbol)
|
|
||||||
(defcustom org-pdftools-markup-pointer-function 'pdf-annot-add-underline-markup-annotation
|
|
||||||
"Color for markup pointer annotations.
|
|
||||||
Can be one of highlight/underline/strikeout/squiggly."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'function)
|
|
||||||
(defcustom org-pdftools-markup-pointer-color "#A9A9A9"
|
|
||||||
"Color for markup pointer annotations."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'string)
|
|
||||||
(defcustom org-pdftools-markup-pointer-opacity 1.0
|
|
||||||
"Opacity for markup pointer annotations."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'float)
|
|
||||||
(defcustom org-pdftools-free-pointer-icon "Circle"
|
|
||||||
"Color for free pointer annotations. Refer to `pdf-annot-standard-text-icons`."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'string)
|
|
||||||
(defcustom org-pdftools-link-prefix "pdf"
|
|
||||||
"Prefix for org-pdftools link"
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'string)
|
|
||||||
(defcustom org-pdftools-search-string-separator "??"
|
|
||||||
"Separator of search-string."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'string)
|
|
||||||
(defcustom org-pdftools-free-pointer-color "#FFFFFF"
|
|
||||||
"Color for free pointer annotations."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'string)
|
|
||||||
(defcustom org-pdftools-free-pointer-opacity 1.0
|
|
||||||
"Opacity for free pointer annotations."
|
|
||||||
:group 'org-pdftools
|
|
||||||
:type 'float)
|
|
||||||
|
|
||||||
|
|
||||||
;; pdf://path::page++height_percent;;annot_id??isearch_string or @@occur_search_string
|
|
||||||
(defun org-pdftools-open-pdftools (link)
|
|
||||||
"Internal function to open org-pdftools LINK."
|
|
||||||
(let ((link-regexp
|
|
||||||
(concat "\\(.*\\)::\\([0-9]*\\)\\(\\+\\+\\)?\\([[0-9]\\.*[0-9]*\\)?\\(;;\\|"
|
|
||||||
(regexp-quote org-pdftools-search-string-separator)
|
|
||||||
"\\)?\\(.*\\)")))
|
|
||||||
(cond ((string-match link-regexp link)
|
|
||||||
(let ((path (match-string 1 link))
|
|
||||||
(page (match-string 2 link))
|
|
||||||
(height (match-string 4 link))
|
|
||||||
annot-id
|
|
||||||
search-string)
|
|
||||||
(cond ((string-equal
|
|
||||||
(match-string 5 link)
|
|
||||||
";;")
|
|
||||||
(setq annot-id
|
|
||||||
(match-string 6 link)))
|
|
||||||
((string-equal
|
|
||||||
(match-string 5 link)
|
|
||||||
org-pdftools-search-string-separator)
|
|
||||||
(setq search-string
|
|
||||||
(replace-regexp-in-string
|
|
||||||
"%20"
|
|
||||||
" "
|
|
||||||
(match-string 6 link)))))
|
|
||||||
(when (and path
|
|
||||||
(not (string-empty-p path)))
|
|
||||||
(if (bound-and-true-p org-noter--session)
|
|
||||||
(org-noter--with-valid-session
|
|
||||||
(let ((doc (with-selected-window
|
|
||||||
(org-noter--get-doc-window)
|
|
||||||
buffer-file-name))
|
|
||||||
(fullpath (funcall org-pdftools-path-resolver path)))
|
|
||||||
(if (string-equal doc fullpath)
|
|
||||||
(select-window
|
|
||||||
(org-noter--get-doc-window))
|
|
||||||
(let ((org-link-frame-setup
|
|
||||||
(cl-acons 'file 'find-file-other-frame org-link-frame-setup)))
|
|
||||||
(org-open-file fullpath 1)))))
|
|
||||||
(org-open-file (funcall org-pdftools-path-resolver path) 1)))
|
|
||||||
(if (and page
|
|
||||||
(not (string-empty-p page)))
|
|
||||||
(progn
|
|
||||||
(setq page (string-to-number page))
|
|
||||||
(if (bound-and-true-p org-noter--session)
|
|
||||||
(org-noter--with-valid-session
|
|
||||||
(with-selected-window
|
|
||||||
(org-noter--get-doc-window)
|
|
||||||
(pdf-view-goto-page page)))
|
|
||||||
(pdf-view-goto-page page)))
|
|
||||||
(setq page nil))
|
|
||||||
(when (and height
|
|
||||||
(not (string-empty-p height)))
|
|
||||||
(if (bound-and-true-p org-noter--session)
|
|
||||||
(org-noter--with-valid-session
|
|
||||||
(with-selected-window
|
|
||||||
(org-noter--get-doc-window)
|
|
||||||
(image-set-window-vscroll
|
|
||||||
(round
|
|
||||||
(/
|
|
||||||
(*
|
|
||||||
(string-to-number height)
|
|
||||||
(cdr (pdf-view-image-size)))
|
|
||||||
(frame-char-height))))))
|
|
||||||
(image-set-window-vscroll
|
|
||||||
(round
|
|
||||||
(/
|
|
||||||
(*
|
|
||||||
(string-to-number height)
|
|
||||||
(cdr (pdf-view-image-size)))
|
|
||||||
(frame-char-height))))))
|
|
||||||
(when (and annot-id
|
|
||||||
(not (string-empty-p annot-id)))
|
|
||||||
(if (bound-and-true-p org-noter--session)
|
|
||||||
(org-noter--with-valid-session
|
|
||||||
(with-selected-window
|
|
||||||
(org-noter--get-doc-window)
|
|
||||||
(pdf-annot-show-annotation
|
|
||||||
(pdf-info-getannot annot-id)
|
|
||||||
t)))
|
|
||||||
(pdf-annot-show-annotation
|
|
||||||
(pdf-info-getannot annot-id)
|
|
||||||
t)))
|
|
||||||
(when (and search-string
|
|
||||||
(not (string-empty-p search-string)))
|
|
||||||
(if (bound-and-true-p org-noter--session)
|
|
||||||
(org-noter--with-valid-session
|
|
||||||
(with-selected-window
|
|
||||||
(org-noter--get-doc-window)
|
|
||||||
(isearch-mode t)
|
|
||||||
(let (pdf-isearch-narrow-to-page t)
|
|
||||||
(isearch-yank-string search-string))
|
|
||||||
))
|
|
||||||
(isearch-mode t)
|
|
||||||
(let (pdf-isearch-narrow-to-page t)
|
|
||||||
(isearch-yank-string search-string))))))
|
|
||||||
((string-match
|
|
||||||
"\\(.*\\)@@\\(.*\\)"
|
|
||||||
link)
|
|
||||||
(let* ((paths (match-string 1 link))
|
|
||||||
(occur-search-string (match-string 2 link))
|
|
||||||
(pathlist (split-string paths "%&%")))
|
|
||||||
(pdf-occur-search
|
|
||||||
pathlist
|
|
||||||
occur-search-string)))
|
|
||||||
((org-open-file link 1)))))
|
|
||||||
|
|
||||||
(defun org-pdftools-get-link ()
|
|
||||||
"Get link from the active pdf buffer."
|
|
||||||
(let* ((path
|
|
||||||
(with-current-buffer (current-buffer)
|
|
||||||
(funcall org-pdftools-path-generator (buffer-file-name))))
|
|
||||||
(page (pdf-view-current-page))
|
|
||||||
(annot-id (if (pdf-view-active-region-p)
|
|
||||||
(pdf-annot-get-id
|
|
||||||
(funcall
|
|
||||||
org-pdftools-markup-pointer-function
|
|
||||||
(pdf-view-active-region)
|
|
||||||
org-pdftools-markup-pointer-color
|
|
||||||
`((opacity . ,org-pdftools-markup-pointer-opacity))))
|
|
||||||
(if (and (not (bound-and-true-p org-noter--session))
|
|
||||||
(pdf-annot-getannots page))
|
|
||||||
(condition-case nil
|
|
||||||
(pdf-annot-get-id
|
|
||||||
(pdf-annot-read-annotation
|
|
||||||
"Click the annotation that you want to link to."))
|
|
||||||
(error
|
|
||||||
(if org-pdftools-use-freepointer-annot
|
|
||||||
(pdf-annot-get-id
|
|
||||||
(funcall-interactively
|
|
||||||
#'pdf-annot-add-text-annotation
|
|
||||||
(pdf-util-read-image-position
|
|
||||||
"Click where a new text annotation should be added ...")
|
|
||||||
org-pdftools-free-pointer-icon
|
|
||||||
`((color . ,org-pdftools-free-pointer-color)
|
|
||||||
(opacity . ,org-pdftools-free-pointer-opacity))))
|
|
||||||
nil)))
|
|
||||||
(if org-pdftools-use-freepointer-annot
|
|
||||||
(pdf-annot-get-id
|
|
||||||
(funcall-interactively
|
|
||||||
#'pdf-annot-add-text-annotation
|
|
||||||
(pdf-util-read-image-position
|
|
||||||
"Click where a new text annotation should be added ...")
|
|
||||||
org-pdftools-free-pointer-icon
|
|
||||||
`((color . ,org-pdftools-free-pointer-color)
|
|
||||||
(opacity . ,org-pdftools-free-pointer-opacity))))
|
|
||||||
nil))))
|
|
||||||
(height (cond ((bound-and-true-p annot-id)
|
|
||||||
(nth 1 (pdf-annot-get
|
|
||||||
(pdf-info-getannot
|
|
||||||
annot-id
|
|
||||||
path)
|
|
||||||
'edges)))
|
|
||||||
(t
|
|
||||||
(/
|
|
||||||
(*
|
|
||||||
(or (image-mode-window-get
|
|
||||||
'vscroll)
|
|
||||||
0)
|
|
||||||
(frame-char-height))
|
|
||||||
(float
|
|
||||||
(cdr (pdf-view-image-size)))))))
|
|
||||||
;; pdf://path::page++height_percent;;annot_id\\|??search-string
|
|
||||||
(search-string (if (and (not annot-id)
|
|
||||||
org-pdftools-use-isearch-link)
|
|
||||||
isearch-string
|
|
||||||
""))
|
|
||||||
(link (concat
|
|
||||||
|
|
||||||
org-pdftools-link-prefix ":"
|
|
||||||
path
|
|
||||||
"::"
|
|
||||||
(number-to-string page)
|
|
||||||
"++"
|
|
||||||
(format "%.2f" height)
|
|
||||||
(if annot-id
|
|
||||||
(concat
|
|
||||||
";;"
|
|
||||||
(symbol-name annot-id))
|
|
||||||
(if (not (string-empty-p search-string))
|
|
||||||
(concat
|
|
||||||
org-pdftools-search-string-separator
|
|
||||||
(replace-regexp-in-string
|
|
||||||
" "
|
|
||||||
"%20"
|
|
||||||
search-string))
|
|
||||||
(message
|
|
||||||
" Reminder: You haven't performed a isearch!") "")))))
|
|
||||||
link))
|
|
||||||
|
|
||||||
(defun org-pdftools-get-desc-default (file page &optional text)
|
|
||||||
(concat file ".pdf: Page " page (when text (concat "; Quoting: " text))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-pdftools-open (link)
|
|
||||||
"Function to open org-pdftools LINK."
|
|
||||||
(if (and (display-graphic-p)
|
|
||||||
(featurep 'pdf-tools))
|
|
||||||
(org-pdftools-open-pdftools
|
|
||||||
link)
|
|
||||||
(if (bound-and-true-p org-pdftools-open-custom-open)
|
|
||||||
(funcall org-pdftools-open-custom-open link)
|
|
||||||
(let* ((path (when (string-match
|
|
||||||
"\\(.+\\)::.+" link)
|
|
||||||
(match-string 1 link))))
|
|
||||||
(org-open-file path)))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-pdftools-store-link ()
|
|
||||||
"Store a link to a pdfview/pdfoccur buffer."
|
|
||||||
(cond ((eq major-mode 'pdf-view-mode)
|
|
||||||
;; This buffer is in pdf-view-mode
|
|
||||||
(let* ((file (file-name-base (pdf-view-buffer-file-name)))
|
|
||||||
(quot (if (pdf-view-active-region-p)
|
|
||||||
(replace-regexp-in-string "\n" " "
|
|
||||||
(mapconcat 'identity (pdf-view-active-region-text) ? ))))
|
|
||||||
(page (number-to-string (pdf-view-current-page)))
|
|
||||||
(link (org-pdftools-get-link))
|
|
||||||
(isearchstr (if (string-match (concat ".*" (regexp-quote org-pdftools-search-string-separator) "\\(.*\\)") link)
|
|
||||||
(match-string 1 link)))
|
|
||||||
(desc (funcall org-pdftools-get-desc-function file page (or quot isearchstr))))
|
|
||||||
(org-link-store-props
|
|
||||||
:type org-pdftools-link-prefix
|
|
||||||
:link link
|
|
||||||
:description desc)))
|
|
||||||
((eq major-mode 'pdf-occur-buffer-mode)
|
|
||||||
(let* ((paths (mapconcat #'identity (mapcar #'car
|
|
||||||
pdf-occur-search-documents) "%&%"))
|
|
||||||
(occur-search-string pdf-occur-search-string)
|
|
||||||
(link (concat org-pdftools-link-prefix ":"
|
|
||||||
paths "@@" occur-search-string)))
|
|
||||||
(org-link-store-props
|
|
||||||
:type org-pdftools-link-prefix
|
|
||||||
:link link
|
|
||||||
:description (concat "Search: " occur-search-string))))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-pdftools-export (link description format)
|
|
||||||
"Export the pdfview LINK with DESCRIPTION for FORMAT from Org files."
|
|
||||||
(let* (path loc page)
|
|
||||||
(if (string-match "\\(.+\\)::\\(.*\\)" link)
|
|
||||||
(progn
|
|
||||||
(setq path (match-string 1 link))
|
|
||||||
(setq loc (match-string 2 link))
|
|
||||||
(if (string-match "\\([0-9]+\\)++\\(.*\\)" loc)
|
|
||||||
(setq page (match-string 1 loc))
|
|
||||||
(setq page loc)))
|
|
||||||
(setq path link))
|
|
||||||
|
|
||||||
;; `org-export-file-uri` expands the filename correctly
|
|
||||||
(setq path (org-export-file-uri (org-link-escape path)))
|
|
||||||
|
|
||||||
(cond ((eq format 'html)
|
|
||||||
(format
|
|
||||||
"<a href=\"%s#page=%s\">%s</a>"
|
|
||||||
path
|
|
||||||
page
|
|
||||||
description))
|
|
||||||
((eq format 'latex)
|
|
||||||
(format
|
|
||||||
"\\href{%s}{%s}"
|
|
||||||
path
|
|
||||||
description))
|
|
||||||
((eq format 'ascii)
|
|
||||||
(format "%s (%s)" description path))
|
|
||||||
(t path))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-pdftools-setup-link (&optional prefix)
|
|
||||||
"Set up pdf: links in org-mode."
|
|
||||||
(setq org-pdftools-prefix (or prefix org-pdftools-link-prefix))
|
|
||||||
(org-link-set-parameters org-pdftools-prefix
|
|
||||||
:follow #'org-pdftools-open
|
|
||||||
:complete #'org-pdftools-complete-link
|
|
||||||
:store #'org-pdftools-store-link
|
|
||||||
:export #'org-pdftools-export))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-pdftools-complete-link (&optional arg)
|
|
||||||
"Use the existing file name completion for file.
|
|
||||||
Links to get the file name, then ask the user for the page number
|
|
||||||
and append it. ARG is passed to `org-link-complete-file'."
|
|
||||||
(let* ((pdf-or-dir-p '(lambda (file-name)
|
|
||||||
(string-match "/$\\|.pdf$" file-name)))
|
|
||||||
;; pdf-or-dir-p, a predicate returns t when file's path
|
|
||||||
;; is a directory or ends with .pdf.
|
|
||||||
(current-read-file-name-function read-file-name-function)
|
|
||||||
;; Replace the `read-file-name-function' temporarily,
|
|
||||||
;; See its docstring for more.
|
|
||||||
(read-file-name-function
|
|
||||||
;; This is the replacement, it's just a wrapper, it passes
|
|
||||||
;; the same argument to the old read file name function, one
|
|
||||||
;; difference is the PREDICATE arguement being our defined
|
|
||||||
;; pdf-or-dir-p.
|
|
||||||
;; Why?: So that `org-link-complete-file' only "show" pdf file
|
|
||||||
;; or directory.
|
|
||||||
(lambda
|
|
||||||
(prompt &optional dir default-filename mustmatch initial
|
|
||||||
predicate)
|
|
||||||
(funcall current-read-file-name-function
|
|
||||||
prompt dir default-filename mustmatch initial
|
|
||||||
pdf-or-dir-p))))
|
|
||||||
(concat
|
|
||||||
(replace-regexp-in-string
|
|
||||||
"^file:"
|
|
||||||
(concat org-pdftools-link-prefix ":")
|
|
||||||
(org-link-complete-file arg))
|
|
||||||
"::"
|
|
||||||
(read-from-minibuffer
|
|
||||||
"Page:"
|
|
||||||
"1"))))
|
|
||||||
|
|
||||||
(provide 'org-pdftools)
|
|
||||||
;;; org-pdftools.el ends here
|
|
||||||
Reference in a new issue