Merge branch 'feature/emacs-26.3'

Creating a merge commit in order to create a 1.0.0 tag.

Note that this merge has breaking changes, as described in the NEWS
section.

* feature/emacs-26.3:
  autobuild: Recognize NetBSD and install packages via pkgin
  Bump the minimum Emacs version to 26.3! 🎉🤞
  Extend docker testing framework to test against Emacs versions
  Update and cleanup the Install section
  Make sure pkg-config is correctly set in autobuild
  Add support for Alpine Linux to autobuild
  Render crisp images for HiDPI screens by default
  Remove Emacs 24.4 guards for cua-mode
  Remove compatibility function for image-mode-winprops
  Remove pdf-util-window-pixel-width, fallback to window-body-width
  Remove macro / function re-definitions
  Remove bugfix for imenu in Emacs 24.3 and below
  Remove guards in `pdf-virtual` tests and code.
  Explicitly declare documentation files as Org files
  Add a byteclean target in the Makefile

Author: vedang

.circleci/config.yml

@@ -95,7 +95,7 @@ jobs:
       - run:
           name: Add Cask and Gnu-SED to the Path
           command: |
-            echo 'export PATH="$HOME"/.cask/bin:"$(brew --prefix)"/opt/gnu-sed/libexec/gnubin:"$PATH"' >> "$BASH_ENV"
+            echo 'export PATH="$HOME"/.cask/bin:"$(brew --prefix gnu-sed)"/libexec/gnubin:"$PATH"' >> "$BASH_ENV"
       - install-pdf-tools-server
 
 workflows:

Cask

@@ -9,7 +9,5 @@
        "server/epdfinfo.exe")
 
 (development
- (depends-on "let-alist")
- (depends-on "tablist")
  (depends-on "ert-runner")
  (depends-on "undercover"))

Makefile

@@ -27,6 +27,11 @@ $(pkgfile): .cask/$(emacs_version) server/epdfinfo lisp/*.el
 bytecompile: .cask/$(emacs_version)
 	$(CASK) exec $(emacs) --batch -L lisp -f batch-byte-compile lisp/*.el
 
+# Clean bytecompiled sources
+byteclean:
+	rm -f -- lisp/*.elc
+	rm -f -- lisp/*.eln
+
 # Run ERT tests
 test: all
 	PACKAGE_TAR=$(pkgfile) $(CASK) exec ert-runner
@@ -68,9 +73,8 @@ melpa-package: $(pkgfile)
 		-f $(pkgname)-melpa.tar
 
 # Various clean targets
-clean: server-clean
+clean: server-clean byteclean
 	rm -f -- $(pkgfile)
-	rm -f -- lisp/*.elc
 	rm -f -- pdf-tools-readme.txt
 	rm -f -- pdf-tools-$(version).entry
 

NEWS

@@ -2,8 +2,24 @@
 
 * Version 1.0.0 (Under Development)
 From this version onward, we will follow Semantic Versioning for new ~pdf-tools~ releases.
-** Raise the minimum supported version of Emacs to 26.1
-Drop support for Emacs 24 and 25. This allows for some code cleanup.
+
+** Breaking changes:
+*** Raise the minimum supported version of Emacs to 26.3 #26
+Drop support for Emacs 24 and 25. This allows for some code cleanup. *This is a major breaking change*.
+*** Change the default value of pdf-view-use-scaling #133
+~pdf-view-use-scaling~ is now true by default, leading to rendering of crisp images on high-resolution screens. This should not cause problems on low-resolution screen (other than taking up more cache space / increasing rendering time), but if it does, please ~(setq pdf-view-use-scaling nil)~ in your configuration.
+
+** Improve overall user experience
+- Set ~pdf-annot-list-highlight-type~ to true by default.
+  + Show annotation color when listing them by default, allow the user to turn them off if need be.
+
+** Make changes required by newer versions of Emacs
+- Emacs 29 introduces ~pixel-scroll-precision-mode~, which interferes with ~pdf-view~ scrolling. This is fixed in #124
+
+** Functionality fixes and improvements
+- Fix ~revert-buffer~ to correctly work over Tramp #128
+- Fix sorting by date in ~pdf-annot-list-mode~ #75
+
 * Version 0.91
 ** Change the keybindings for traversing history
 This is a minor but *breaking change*. ~l~ (backward) and ~r~ (forward) are the conventional bindings for history navigation in Emacs, but ~pdf-tools~ uses ~B~ and ~N~. The previous keybindings are kept as-is for people who were used to it, while introducing ~l~ and ~r~ keybindings as well.

README.org

@@ -0,0 +1,21 @@
+#+TITLE: A list of important / desirable tasks
+
+* pdf-isearch
+** Allow for entering multi-byte characters with some input-methods.
+The PDF buffer is in uni-byte mode. It prohibits the user from inserting multi-byte characters in the minibuffer with some input-methods, while editing the search string.
+* pdf-forms
+Recent poppler versions have some support for editing forms.
+* pdf-annot
+** Updating the list buffer is too slow
++ Update it incrementally.
++ Possibly skip the update if the buffer is not visible.
+** Make highlighting customizable
+* epdfinfo
+** Maybe split the code up in several files.
+* pdf-view
+** Provide some kind of multi-page view
+** Make persistent scrolling relative
+Currently the scrolling is kept when changing the image's size (in pdf-view-display-image), which is actually not so desirable, since it is absolute. This results e.g. in the image popping out of the window, when it is shrunken.
+* pdf-info
+** Add a report/debug command, displaying a list of open files and other information.
+** Use alists for results instead of positional lists.

TODO

@@ -429,9 +429,9 @@ WINDOW and IMAGE-WIDTH decide the page and scale of the final image."
                   (pdf-cache-lookup-image
                    page
                    image-width
-                   (if (not pdf-view-use-scaling)
-                       image-width
-                     (* 2 image-width))))
+                   (if pdf-view-use-scaling
+                       (* 2 image-width)
+                     image-width)))
         (setq page (pop pdf-cache--prefetch-pages)))
       (pdf-util-debug
         (when (null page)

TODO.org

@@ -305,7 +305,9 @@ error."
       (setq pdf-info--queue (tq-create proc))))
   pdf-info--queue)
 
-(when (< emacs-major-version 27) (advice-add 'tq-process-buffer :around #'pdf-info--tq-workaround))
+(when (< emacs-major-version 27)
+  (advice-add 'tq-process-buffer :around #'pdf-info--tq-workaround))
+
 (defun pdf-info--tq-workaround (orig-fun tq &rest args)
   "Fix a bug in trunk where the wrong callback gets called.
 

lisp/pdf-cache.el

@@ -572,23 +572,6 @@ not call `imenu-sort-function'."
     (cons title
           (nconc (nreverse keep-at-top) menulist))))
 
-;; bugfix for imenu in Emacs 24.3 and below.
-(when (condition-case nil
-          (progn (imenu--truncate-items '(("" 0))) nil)
-        (error t))
-  (eval-after-load "imenu"
-    '(defun imenu--truncate-items (menulist)
-       "Truncate all strings in MENULIST to `imenu-max-item-length'."
-       (mapc (lambda (item)
-               ;; Truncate if necessary.
-               (when (and (numberp imenu-max-item-length)
-                          (> (length (car item)) imenu-max-item-length))
-                 (setcar item (substring (car item) 0 imenu-max-item-length)))
-               (when (imenu--subalist-p item)
-                 (imenu--truncate-items (cdr item))))
-             menulist))))
-
-
 
 (provide 'pdf-outline)