* bug#32281: shr.el align support patch
@ 2018-07-26 14:06 Bad Blue Bull
2018-08-06 2:52 ` Noam Postavsky
2018-08-06 17:36 ` Noam Postavsky
0 siblings, 2 replies; 15+ messages in thread
From: Bad Blue Bull @ 2018-07-26 14:06 UTC (permalink / raw)
To: 32281
[-- Attachment #1: Type: text/html, Size: 558 bytes --]
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: shr.el.diff --]
[-- Type: text/x-diff; name="shr.el.diff", Size: 3400 bytes --]
--- shr-old.el 2018-07-21 03:37:08.299506430 +0300
+++ shr.el 2018-07-22 16:49:02.803829992 +0300
@@ -62,7 +62,7 @@
:group 'shr
:type '(choice (const nil) regexp))
-(defcustom shr-use-fonts t
+(defcustom shr-use-fonts nil ; set default value to nil because monospace fonts are better for Emacs
"If non-nil, use proportional fonts for text."
:version "25.1"
:group 'shr
@@ -292,6 +292,45 @@
(when shr-warning
(message "%s" shr-warning))))
+(defun shr-fill-paragraph-with-breaks (&optional justify bre-del bre-regexp)
+ "Fill paragraph at or after point, breaking lines at positions matching regexp argument BRE-REGEXP.
+If JUSTIFY is non-nil justify as well.
+Delete matched text if BRE-DEL is non nil
+BRE-REGEXP must be a regexp that determines positions where to break lines, default value is \\x2028."
+ (unless bre-regexp (setq bre-regexp "\x2028"))
+ (setq bre-regexp (concat bre-regexp "\\|\x2029"))
+ (save-excursion
+ (let ((line-begin) (paragraph-end))
+ (forward-paragraph)
+ (insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end of a paragraph
+ (backward-paragraph)
+ (setq line-begin (point))
+ (while (not paragraph-end)
+ (re-search-forward bre-regexp)
+ (if (equal (match-string 0) "\x2029") (setq paragraph-end t)) ; end of paragraph reached
+ (if (or bre-del paragraph-end) (replace-match ""))
+ (unless (equal (char-after) ?\n) (insert "\n")) ; I don't know why but two adjacent \n leave an empty line after fill
+ (fill-region-as-paragraph line-begin (- (point) 1) justify)
+ (setq line-begin (point)))
+ (delete-char -1)
+ )))
+
+(defun shr-fill-paragraph (dom)
+ "Fill paragraph"
+ (when (not shr-use-fonts) ;fill-paragraph is useful only with monospace fonts
+ (shr-fill-paragraph-with-breaks
+ ((lambda (x)
+ (cond
+ ((equal x "right") 'right)
+ ((equal x "center") 'center)
+ ((equal x "left") 'left)
+ ))
+ (cdr (assq 'align (dom-attributes dom)))) ; justify parameter
+ t) ; bre-del t
+ )
+ )
+
+
(defun shr--remove-blank-lines-at-the-end (start end)
(save-restriction
(save-excursion
@@ -1191,6 +1230,7 @@
(defun shr-heading (dom &rest types)
(shr-ensure-paragraph)
(apply #'shr-fontize-dom dom types)
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-urlify (start url &optional title)
@@ -1354,6 +1394,7 @@
(defun shr-tag-p (dom)
(shr-ensure-paragraph)
(shr-generic dom)
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-div (dom)
@@ -1742,12 +1783,14 @@
;; paragraph.
(unless (bolp)
(insert "\n"))
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-ol (dom)
(shr-ensure-paragraph)
(let ((shr-list-mode 1))
(shr-generic dom))
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-li (dom)
@@ -1770,6 +1813,7 @@
(put-text-property start (1+ start) 'shr-prefix-length (length bullet))
(shr-generic dom))))
(unless (bolp)
+ (unless shr-use-fonts (insert "\x2028")) ; insert a line separator
(insert "\n")))
(defun shr-mark-fill (start)
@@ -1785,7 +1829,8 @@
(or (not (bolp))
(and (> (- (point) 2) (point-min))
(not (= (char-after (- (point) 2)) ?\n)))))
- (insert "\n"))
+ (unless shr-use-fonts (insert "\x2028")) ; insert a line separator
+ (insert "\n"))
(shr-generic dom))
(defun shr-tag-span (dom)
[-- Attachment #3: fill.png --]
[-- Type: image/png, Size: 139008 bytes --]
[-- Attachment #4: no_fill.png --]
[-- Type: image/png, Size: 143725 bytes --]
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #5: shr.el --]
[-- Type: text/x-lisp; name="shr.el", Size: 87062 bytes --]
;;; shr.el --- Simple HTML Renderer -*- lexical-binding: t -*-
;; Copyright (C) 2010-2018 Free Software Foundation, Inc.
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: html
;; This file is part of 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 3 of the License, 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. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package takes a HTML parse tree (as provided by
;; libxml-parse-html-region) and renders it in the current buffer. It
;; does not do CSS, JavaScript or anything advanced: It's geared
;; towards rendering typical short snippets of HTML, like what you'd
;; find in HTML email and the like.
;;; Code:
(require 'cl-lib)
(eval-when-compile (require 'url)) ;For url-filename's setf handler.
(require 'browse-url)
(eval-when-compile (require 'subr-x))
(require 'dom)
(require 'seq)
(require 'svg)
(require 'image)
(require 'puny)
(require 'text-property-search)
(defgroup shr nil
"Simple HTML Renderer"
:version "25.1"
:group 'web)
(defcustom shr-max-image-proportion 0.9
"How big pictures displayed are in relation to the window they're in.
A value of 0.7 means that they are allowed to take up 70% of the
width and height of the window. If they are larger than this,
and Emacs supports it, then the images will be rescaled down to
fit these criteria."
:version "24.1"
:group 'shr
:type 'float)
(defcustom shr-blocked-images nil
"Images that have URLs matching this regexp will be blocked."
:version "24.1"
:group 'shr
:type '(choice (const nil) regexp))
(defcustom shr-use-fonts nil ; set default value to nil because monospace fonts are better for Emacs
"If non-nil, use proportional fonts for text."
:version "25.1"
:group 'shr
:type 'boolean)
(defcustom shr-use-colors t
"If non-nil, respect color specifications in the HTML."
:version "26.1"
:group 'shr
:type 'boolean)
(defcustom shr-table-horizontal-line nil
"Character used to draw horizontal table lines.
If nil, don't draw horizontal table lines."
:group 'shr
:type '(choice (const nil) character))
(defcustom shr-table-vertical-line ?\s
"Character used to draw vertical table lines."
:group 'shr
:type 'character)
(defcustom shr-table-corner ?\s
"Character used to draw table corners."
:group 'shr
:type 'character)
(defcustom shr-hr-line ?-
"Character used to draw hr lines."
:group 'shr
:type 'character)
(defcustom shr-width nil
"Frame width to use for rendering.
May either be an integer specifying a fixed width in characters,
or nil, meaning that the full width of the window should be used.
If `shr-use-fonts' is set, the mean character width is used to
compute the pixel width, which is used instead."
:version "25.1"
:type '(choice (integer :tag "Fixed width in characters")
(const :tag "Use the width of the window" nil))
:group 'shr)
(defcustom shr-bullet "* "
"Bullet used for unordered lists.
Alternative suggestions are:
- \" \"
- \" \""
:version "24.4"
:type 'string
:group 'shr)
(defcustom shr-external-browser 'browse-url-default-browser
"Function used to launch an external browser."
:version "24.4"
:group 'shr
:type 'function)
(defcustom shr-image-animate t
"Non nil means that images that can be animated will be."
:version "24.4"
:group 'shr
:type 'boolean)
(defvar shr-content-function nil
"If bound, this should be a function that will return the content.
This is used for cid: URLs, and the function is called with the
cid: URL as the argument.")
(defvar shr-put-image-function 'shr-put-image
"Function called to put image and alt string.")
(defface shr-strike-through '((t :strike-through t))
"Face for <s> elements."
:version "24.1"
:group 'shr)
(defface shr-link
'((t :inherit link))
"Face for link elements."
:version "24.1"
:group 'shr)
(defface shr-selected-link
'((t :inherit shr-link :background "red"))
"Face for link elements."
:version "27.1"
:group 'shr)
(defvar shr-inhibit-images nil
"If non-nil, inhibit loading images.")
(defvar shr-external-rendering-functions nil
"Alist of tag/function pairs used to alter how shr renders certain tags.
For instance, eww uses this to alter rendering of title, forms
and other things:
\((title . eww-tag-title)
(form . eww-tag-form)
...)")
;;; Internal variables.
(defvar shr-folding-mode nil)
(defvar shr-start nil)
(defvar shr-indentation 0)
(defvar shr-internal-width nil)
(defvar shr-list-mode nil)
(defvar shr-content-cache nil)
(defvar shr-kinsoku-shorten nil)
(defvar shr-table-depth 0)
(defvar shr-stylesheet nil)
(defvar shr-base nil)
(defvar shr-depth 0)
(defvar shr-warning nil)
(defvar shr-ignore-cache nil)
(defvar shr-target-id nil)
(defvar shr-table-separator-length 1)
(defvar shr-table-separator-pixel-width 0)
(defvar shr-table-id nil)
(defvar shr-current-font nil)
(defvar shr-internal-bullet nil)
(defvar shr-map
(let ((map (make-sparse-keymap)))
(define-key map "a" 'shr-show-alt-text)
(define-key map "i" 'shr-browse-image)
(define-key map "z" 'shr-zoom-image)
(define-key map [?\t] 'shr-next-link)
(define-key map [?\M-\t] 'shr-previous-link)
(define-key map [follow-link] 'mouse-face)
(define-key map [mouse-2] 'shr-browse-url)
(define-key map "I" 'shr-insert-image)
(define-key map "w" 'shr-maybe-probe-and-copy-url)
(define-key map "u" 'shr-maybe-probe-and-copy-url)
(define-key map "v" 'shr-browse-url)
(define-key map "O" 'shr-save-contents)
(define-key map "\r" 'shr-browse-url)
map))
(defvar shr-image-map
(let ((map (copy-keymap shr-map)))
(when (boundp 'image-map)
(set-keymap-parent map image-map))
map))
;; Public functions and commands.
(declare-function libxml-parse-html-region "xml.c"
(start end &optional base-url discard-comments))
(defun shr-render-buffer (buffer)
"Display the HTML rendering of the current buffer."
(interactive (list (current-buffer)))
(or (fboundp 'libxml-parse-html-region)
(error "This function requires Emacs to be compiled with libxml2"))
(pop-to-buffer "*html*")
(erase-buffer)
(shr-insert-document
(with-current-buffer buffer
(libxml-parse-html-region (point-min) (point-max))))
(goto-char (point-min)))
;;;###autoload
(defun shr-render-region (begin end &optional buffer)
"Display the HTML rendering of the region between BEGIN and END."
(interactive "r")
(unless (fboundp 'libxml-parse-html-region)
(error "This function requires Emacs to be compiled with libxml2"))
(with-current-buffer (or buffer (current-buffer))
(let ((dom (libxml-parse-html-region begin end)))
(delete-region begin end)
(goto-char begin)
(shr-insert-document dom))))
(defun shr--have-one-fringe-p ()
"Return non-nil if we know at least one of the fringes has non-zero width."
(and (fboundp 'fringe-columns)
(or (not (zerop (fringe-columns 'right)))
(not (zerop (fringe-columns 'left))))))
;;;###autoload
(defun shr-insert-document (dom)
"Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
(setq shr-content-cache nil)
(let ((start (point))
(shr-start nil)
(shr-base nil)
(shr-depth 0)
(shr-table-id 0)
(shr-warning nil)
(shr-table-separator-pixel-width (shr-string-pixel-width "-"))
(shr-internal-bullet (cons shr-bullet
(shr-string-pixel-width shr-bullet)))
(shr-internal-width (or (and shr-width
(if (not shr-use-fonts)
shr-width
(* shr-width (frame-char-width))))
;; We need to adjust the available
;; width for when the user disables
;; the fringes, which will cause the
;; display engine usurp one column for
;; the continuation glyph.
(if (not shr-use-fonts)
(- (window-body-width) 1
(if (and (null shr-width)
(not (shr--have-one-fringe-p)))
0
1))
(- (window-body-width nil t)
(* 2 (frame-char-width))
(if (and (null shr-width)
(not (shr--have-one-fringe-p)))
(* (frame-char-width) 2)
0)
1))))
(max-specpdl-size max-specpdl-size)
bidi-display-reordering)
;; If the window was hscrolled for some reason, shr-fill-lines
;; below will misbehave, because it silently assumes that it
;; starts with a non-hscrolled window (vertical-motion will move
;; to a wrong place otherwise).
(set-window-hscroll nil 0)
(shr-descend dom)
(shr-fill-lines start (point))
(shr--remove-blank-lines-at-the-end start (point))
(when shr-warning
(message "%s" shr-warning))))
(defun shr-fill-paragraph-with-breaks (&optional justify bre-del bre-regexp)
"Fill paragraph at or after point, breaking lines at positions matching regexp argument BRE-REGEXP.
If JUSTIFY is non-nil justify as well.
Delete matched text if BRE-DEL is non nil
BRE-REGEXP must be a regexp that determines positions where to break lines, default value is \\x2028."
(unless bre-regexp (setq bre-regexp "\x2028"))
(setq bre-regexp (concat bre-regexp "\\|\x2029"))
(save-excursion
(let ((line-begin) (paragraph-end))
(forward-paragraph)
(insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end of a paragraph
(backward-paragraph)
(setq line-begin (point))
(while (not paragraph-end)
(re-search-forward bre-regexp)
(if (equal (match-string 0) "\x2029") (setq paragraph-end t)) ; end of paragraph reached
(if (or bre-del paragraph-end) (replace-match ""))
(unless (equal (char-after) ?\n) (insert "\n")) ; I don't know why but two adjacent \n leave an empty line after fill
(fill-region-as-paragraph line-begin (- (point) 1) justify)
(setq line-begin (point)))
(delete-char -1)
)))
(defun shr-fill-paragraph (dom)
"Fill paragraph"
(when (not shr-use-fonts) ;fill-paragraph is useful only with monospace fonts
(shr-fill-paragraph-with-breaks
((lambda (x)
(cond
((equal x "right") 'right)
((equal x "center") 'center)
((equal x "left") 'left)
))
(cdr (assq 'align (dom-attributes dom)))) ; justify parameter
t) ; bre-del t
)
)
(defun shr--remove-blank-lines-at-the-end (start end)
(save-restriction
(save-excursion
(narrow-to-region start end)
(goto-char end)
(when (and (re-search-backward "[^ \n]" nil t)
(not (eobp)))
(forward-line 1)
(delete-region (point) (point-max))))))
(defun shr-url-at-point (image-url)
"Return the URL under point as a string.
If IMAGE-URL is non-nil, or there is no link under point, but
there is an image under point then copy the URL of the image
under point instead."
(if image-url
(get-text-property (point) 'image-url)
(or (get-text-property (point) 'shr-url)
(get-text-property (point) 'image-url))))
(defun shr-copy-url (url)
"Copy the URL under point to the kill ring.
If IMAGE-URL (the prefix) is non-nil, or there is no link under
point, but there is an image under point then copy the URL of the
image under point instead."
(interactive (list (shr-url-at-point current-prefix-arg)))
(if (not url)
(message "No URL under point")
(setq url (url-encode-url url))
(kill-new url)
(message "Copied %s" url)))
(defun shr-probe-url (url cont)
"Pass URL's redirect destination to CONT, if it has one.
CONT should be a function of one argument, the redirect
destination URL. If URL is not redirected, then CONT is never
called."
(interactive "P")
(url-retrieve
url (lambda (a)
(pcase a
(`(:redirect ,destination . ,_)
;; Remove common tracking junk from the URL.
(funcall cont (replace-regexp-in-string
".utm_.*" "" destination)))))
nil t))
(defun shr-probe-and-copy-url (url)
"Copy the URL under point to the kill ring.
Like `shr-copy-url', but additionally fetch URL and use its
redirection destination if it has one."
(interactive (list (shr-url-at-point current-prefix-arg)))
(if url (shr-probe-url url #'shr-copy-url)
(shr-copy-url url)))
(defun shr-maybe-probe-and-copy-url (url)
"Copy the URL under point to the kill ring.
If the URL is already at the front of the kill ring act like
`shr-probe-and-copy-url', otherwise like `shr-copy-url'."
(interactive (list (shr-url-at-point current-prefix-arg)))
(if (equal url (car kill-ring))
(shr-probe-and-copy-url url)
(shr-copy-url url)))
(defun shr--current-link-region ()
(let ((current (get-text-property (point) 'shr-url))
start)
(save-excursion
;; Go to the beginning.
(while (and (not (bobp))
(equal (get-text-property (point) 'shr-url) current))
(forward-char -1))
(unless (equal (get-text-property (point) 'shr-url) current)
(forward-char 1))
(setq start (point))
;; Go to the end.
(while (and (not (eobp))
(equal (get-text-property (point) 'shr-url) current))
(forward-char 1))
(list start (point)))))
(defun shr--blink-link ()
(let* ((region (shr--current-link-region))
(overlay (make-overlay (car region) (cadr region))))
(overlay-put overlay 'face 'shr-selected-link)
(run-at-time 1 nil (lambda ()
(delete-overlay overlay)))))
(defun shr-next-link ()
"Skip to the next link."
(interactive)
(let ((match (text-property-search-forward 'shr-url nil nil t)))
(if (not match)
(message "No next link")
(goto-char (prop-match-beginning match))
(message "%s" (get-text-property (point) 'help-echo)))))
(defun shr-previous-link ()
"Skip to the previous link."
(interactive)
(if (not (text-property-search-backward 'shr-url nil nil t))
(message "No previous link")
(message "%s" (get-text-property (point) 'help-echo))))
(defun shr-show-alt-text ()
"Show the ALT text of the image under point."
(interactive)
(let ((text (get-text-property (point) 'shr-alt)))
(if (not text)
(message "No image under point")
(message "%s" (shr-fill-text text)))))
(defun shr-browse-image (&optional copy-url)
"Browse the image under point.
If COPY-URL (the prefix if called interactively) is non-nil, copy
the URL of the image to the kill buffer instead."
(interactive "P")
(let ((url (get-text-property (point) 'image-url)))
(cond
((not url)
(message "No image under point"))
(copy-url
(with-temp-buffer
(insert url)
(copy-region-as-kill (point-min) (point-max))
(message "Copied %s" url)))
(t
(message "Browsing %s..." url)
(browse-url url)))))
(defun shr-insert-image ()
"Insert the image under point into the buffer."
(interactive)
(let ((url (get-text-property (point) 'image-url)))
(if (not url)
(message "No image under point")
(message "Inserting %s..." url)
(url-retrieve url 'shr-image-fetched
(list (current-buffer) (1- (point)) (point-marker))
t t))))
(defun shr-zoom-image ()
"Toggle the image size.
The size will be rotated between the default size, the original
size, and full-buffer size."
(interactive)
(let ((url (get-text-property (point) 'image-url))
(size (get-text-property (point) 'image-size))
(buffer-read-only nil))
(if (not url)
(message "No image under point")
;; Delete the old picture.
(while (get-text-property (point) 'image-url)
(forward-char -1))
(forward-char 1)
(let ((start (point)))
(while (get-text-property (point) 'image-url)
(forward-char 1))
(forward-char -1)
(put-text-property start (point) 'display nil)
(when (> (- (point) start) 2)
(delete-region start (1- (point)))))
(message "Inserting %s..." url)
(url-retrieve url 'shr-image-fetched
(list (current-buffer) (1- (point)) (point-marker)
(list (cons 'size
(cond ((or (eq size 'default)
(null size))
'original)
((eq size 'original)
'full)
((eq size 'full)
'default)))))
t))))
;;; Utility functions.
(defsubst shr-generic (dom)
(dolist (sub (dom-children dom))
(if (stringp sub)
(shr-insert sub)
(shr-descend sub))))
(defun shr-indirect-call (tag-name dom &rest args)
(let ((function (intern (concat "shr-tag-" (symbol-name tag-name)) obarray))
;; Allow other packages to override (or provide) rendering
;; of elements.
(external (cdr (assq tag-name shr-external-rendering-functions))))
(cond (external
(apply external dom args))
((fboundp function)
(apply function dom args))
(t
(apply 'shr-generic dom args)))))
(defun shr-descend (dom)
(let ((function
(intern (concat "shr-tag-" (symbol-name (dom-tag dom))) obarray))
;; Allow other packages to override (or provide) rendering
;; of elements.
(external (cdr (assq (dom-tag dom) shr-external-rendering-functions)))
(style (dom-attr dom 'style))
(shr-stylesheet shr-stylesheet)
(shr-depth (1+ shr-depth))
(start (point)))
;; shr uses many frames per nested node.
(if (and (> shr-depth (/ max-specpdl-size 15))
(not (and (y-or-n-p "Too deeply nested to render properly; increase `max-specpdl-size'?")
(setq max-specpdl-size (* max-specpdl-size 2)))))
(setq shr-warning
"Not rendering the complete page because of too-deep nesting")
(when style
(if (string-match "color\\|display\\|border-collapse" style)
(setq shr-stylesheet (nconc (shr-parse-style style)
shr-stylesheet))
(setq style nil)))
;; If we have a display:none, then just ignore this part of the DOM.
(unless (equal (cdr (assq 'display shr-stylesheet)) "none")
;; We don't use shr-indirect-call here, since shr-descend is
;; the central bit of shr.el, and should be as fast as
;; possible. Having one more level of indirection with its
;; negative effect on performance is deemed unjustified in
;; this case.
(cond (external
(funcall external dom))
((fboundp function)
(funcall function dom))
(t
(shr-generic dom)))
(when (and shr-target-id
(equal (dom-attr dom 'id) shr-target-id))
;; If the element was empty, we don't have anything to put the
;; anchor on. So just insert a dummy character.
(when (= start (point))
(insert "*"))
(put-text-property start (1+ start) 'shr-target-id shr-target-id))
;; If style is set, then this node has set the color.
(when style
(shr-colorize-region
start (point)
(cdr (assq 'color shr-stylesheet))
(cdr (assq 'background-color shr-stylesheet))))))))
(defun shr-fill-text (text)
(if (zerop (length text))
text
(with-temp-buffer
(let ((shr-indentation 0)
(shr-start nil)
(shr-internal-width (- (window-body-width nil t)
(* 2 (frame-char-width))
;; Adjust the window width for when
;; the user disables the fringes,
;; which causes the display engine
;; to usurp one column for the
;; continuation glyph.
(if (and (null shr-width)
(not (shr--have-one-fringe-p)))
(* (frame-char-width) 2)
0))))
(shr-insert text)
(shr-fill-lines (point-min) (point-max))
(buffer-string)))))
(define-inline shr-char-breakable-p (char)
"Return non-nil if a line can be broken before and after CHAR."
(inline-quote (aref fill-find-break-point-function-table ,char)))
(define-inline shr-char-nospace-p (char)
"Return non-nil if no space is required before and after CHAR."
(inline-quote (aref fill-nospace-between-words-table ,char)))
;; KINSOKU is a Japanese word meaning a rule that should not be violated.
;; In Emacs, it is a term used for characters, e.g. punctuation marks,
;; parentheses, and so on, that should not be placed in the beginning
;; of a line or the end of a line.
(define-inline shr-char-kinsoku-bol-p (char)
"Return non-nil if a line ought not to begin with CHAR."
(inline-letevals (char)
(inline-quote (and (not (eq ,char ?'))
(aref (char-category-set ,char) ?>)))))
(define-inline shr-char-kinsoku-eol-p (char)
"Return non-nil if a line ought not to end with CHAR."
(inline-quote (aref (char-category-set ,char) ?<)))
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
(load "kinsoku" nil t))
(defun shr-pixel-column ()
(if (not shr-use-fonts)
(current-column)
(if (not (get-buffer-window (current-buffer)))
(save-window-excursion
;; Avoid errors if the selected window is a dedicated one,
;; and they just want to insert a document into it.
(set-window-dedicated-p nil nil)
(set-window-buffer nil (current-buffer))
(car (window-text-pixel-size nil (line-beginning-position) (point))))
(car (window-text-pixel-size nil (line-beginning-position) (point))))))
(defun shr-pixel-region ()
(- (shr-pixel-column)
(save-excursion
(goto-char (mark))
(shr-pixel-column))))
(defun shr-string-pixel-width (string)
(if (not shr-use-fonts)
(length string)
;; Save and restore point across with-temp-buffer, since
;; shr-pixel-column uses save-window-excursion, which can reset
;; point to 1.
(let ((pt (point)))
(prog1
(with-temp-buffer
(insert string)
(shr-pixel-column))
(goto-char pt)))))
(defsubst shr--translate-insertion-chars ()
;; Remove soft hyphens.
(goto-char (point-min))
(while (search-forward "" nil t)
(replace-match "" t t))
;; Translate non-breaking spaces into real spaces.
(goto-char (point-min))
(while (search-forward " " nil t)
(replace-match " " t t)))
(defun shr-insert (text)
(when (and (not (bolp))
(get-text-property (1- (point)) 'image-url))
(insert "\n"))
(cond
((eq shr-folding-mode 'none)
(let ((start (point)))
(insert text)
(save-restriction
(narrow-to-region start (point))
(shr--translate-insertion-chars)
(goto-char (point-max)))))
(t
(let ((font-start (point)))
(when (and (string-match "\\`[ \t\n\r]" text)
(not (bolp))
(not (eq (char-after (1- (point))) ? )))
(insert " "))
(let ((start (point))
(bolp (bolp)))
(insert text)
(save-restriction
(narrow-to-region start (point))
(goto-char start)
(when (looking-at "[ \t\n\r]+")
(replace-match "" t t))
(while (re-search-forward "[ \t\n\r]+" nil t)
(replace-match " " t t))
(shr--translate-insertion-chars)
(goto-char (point-max)))
;; We may have removed everything we inserted if it was just
;; spaces.
(unless (= font-start (point))
;; Mark all lines that should possibly be folded afterwards.
(when bolp
(shr-mark-fill start))
(when shr-use-fonts
(put-text-property font-start (point)
'face
(or shr-current-font 'variable-pitch)))))))))
(defun shr-fill-lines (start end)
(if (<= shr-internal-width 0)
nil
(save-restriction
(narrow-to-region start end)
(goto-char start)
(when (get-text-property (point) 'shr-indentation)
(shr-fill-line))
(while (setq start (next-single-property-change start 'shr-indentation))
(goto-char start)
(when (bolp)
(shr-fill-line)))
(goto-char (point-max)))))
(defun shr-vertical-motion (column)
(if (not shr-use-fonts)
(move-to-column column)
(unless (eolp)
(forward-char 1))
(vertical-motion (cons (/ column (frame-char-width)) 0))
(unless (eolp)
(forward-char 1))))
(defun shr-fill-line ()
(let ((shr-indentation (get-text-property (point) 'shr-indentation))
(continuation (get-text-property
(point) 'shr-continuation-indentation))
start)
(put-text-property (point) (1+ (point)) 'shr-indentation nil)
(let ((face (get-text-property (point) 'face))
(background-start (point)))
(shr-indent)
(when face
(put-text-property background-start (point) 'face
`,(shr-face-background face))))
(setq start (point))
(setq shr-indentation (or continuation shr-indentation))
;; If we have an indentation that's wider than the width we're
;; trying to fill to, then just give up and don't do any filling.
(when (< shr-indentation shr-internal-width)
(shr-vertical-motion shr-internal-width)
(when (looking-at " $")
(delete-region (point) (line-end-position)))
(while (not (eolp))
;; We have to do some folding. First find the first
;; previous point suitable for folding.
(if (or (not (shr-find-fill-point (line-beginning-position)))
(= (point) start))
;; We had unbreakable text (for this width), so just go to
;; the first space and carry on.
(progn
(beginning-of-line)
(skip-chars-forward " ")
(search-forward " " (line-end-position) 'move)))
;; Success; continue.
(when (= (preceding-char) ?\s)
(delete-char -1))
(let ((gap-start (point)))
(insert "\n")
(shr-indent)
(when (and (> (1- gap-start) (point-min))
;; The link on both sides of the newline are the
;; same...
(equal (get-text-property (point) 'shr-url)
(get-text-property (1- gap-start) 'shr-url)))
;; ... so we join the two bits into one link logically, but
;; not visually. This makes navigation between links work
;; well, but avoids underscores before the link on the next
;; line when indented.
(let ((props (copy-sequence (text-properties-at (point)))))
;; We don't want to use the faces on the indentation, because
;; that's ugly.
(setq props (plist-put props 'face nil))
(add-text-properties gap-start (point) props))))
(setq start (point))
(shr-vertical-motion shr-internal-width)
(when (looking-at " $")
(delete-region (point) (line-end-position)))))))
(defun shr-find-fill-point (start)
(let ((bp (point))
(end (point))
failed)
(while (not (or (setq failed (<= (point) start))
(eq (preceding-char) ? )
(eq (following-char) ? )
(shr-char-breakable-p (preceding-char))
(shr-char-breakable-p (following-char))
(and (shr-char-kinsoku-bol-p (preceding-char))
(shr-char-breakable-p (following-char))
(not (shr-char-kinsoku-bol-p (following-char))))
(shr-char-kinsoku-eol-p (following-char))
(bolp)))
(backward-char 1))
(if failed
;; There's no breakable point, so we give it up.
(let (found)
(goto-char bp)
;; Don't overflow the window edge, even if
;; shr-kinsoku-shorten is nil.
(unless (or shr-kinsoku-shorten (null shr-width))
(while (setq found (re-search-forward
"\\(\\c>\\)\\| \\|\\c<\\|\\c|"
(line-end-position) 'move)))
(if (and found
(not (match-beginning 1)))
(goto-char (match-beginning 0)))))
(or
(eolp)
;; Don't put kinsoku-bol characters at the beginning of a line,
;; or kinsoku-eol characters at the end of a line.
(cond
;; Don't overflow the window edge, even if shr-kinsoku-shorten
;; is nil.
((or shr-kinsoku-shorten (null shr-width))
(while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
(or (shr-char-kinsoku-eol-p (preceding-char))
(shr-char-kinsoku-bol-p (following-char))))
(backward-char 1))
(when (setq failed (<= (point) start))
;; There's no breakable point that doesn't violate kinsoku,
;; so we look for the second best position.
(while (and (progn
(forward-char 1)
(<= (point) end))
(progn
(setq bp (point))
(shr-char-kinsoku-eol-p (following-char)))))
(goto-char bp)))
((shr-char-kinsoku-eol-p (preceding-char))
;; Find backward the point where kinsoku-eol characters begin.
(let ((count 4))
(while
(progn
(backward-char 1)
(and (> (setq count (1- count)) 0)
(not (memq (preceding-char) (list ?\C-@ ?\n ? )))
(or (shr-char-kinsoku-eol-p (preceding-char))
(shr-char-kinsoku-bol-p (following-char)))))))
(when (setq failed (<= (point) start))
;; There's no breakable point that doesn't violate kinsoku,
;; so we go to the second best position.
(if (looking-at "\\(\\c<+\\)\\c<")
(goto-char (match-end 1))
(forward-char 1))))
((shr-char-kinsoku-bol-p (following-char))
;; Find forward the point where kinsoku-bol characters end.
(let ((count 4))
(while (progn
(forward-char 1)
(and (>= (setq count (1- count)) 0)
(shr-char-kinsoku-bol-p (following-char))
(shr-char-breakable-p (following-char))))))))
(when (eq (following-char) ? )
(forward-char 1))))
(not failed)))
(defun shr-parse-base (url)
;; Always chop off anchors.
(when (string-match "#.*" url)
(setq url (substring url 0 (match-beginning 0))))
;; NB: <base href="" > URI may itself be relative to the document s URI
(setq url (shr-expand-url url))
(let* ((parsed (url-generic-parse-url url))
(local (url-filename parsed)))
(setf (url-filename parsed) "")
;; Chop off the bit after the last slash.
(when (string-match "\\`\\(.*/\\)[^/]+\\'" local)
(setq local (match-string 1 local)))
;; Always make the local bit end with a slash.
(when (and (not (zerop (length local)))
(not (eq (aref local (1- (length local))) ?/)))
(setq local (concat local "/")))
(list (url-recreate-url parsed)
local
(url-type parsed)
url)))
(autoload 'url-expand-file-name "url-expand")
;; FIXME This needs some tests writing.
;; Does it even need to exist, given that url-expand-file-name does?
(defun shr-expand-url (url &optional base)
(setq base
(if base
;; shr-parse-base should never call this with non-nil base!
(shr-parse-base base)
;; Bound by the parser.
shr-base))
(when (zerop (length url))
(setq url nil))
;; Strip leading whitespace
(and url (string-match "\\`\\s-+" url)
(setq url (substring url (match-end 0))))
(cond ((zerop (length url))
(nth 3 base))
((or (not base)
(string-match "\\`[a-z]*:" url))
;; Absolute or empty URI
url)
((eq (aref url 0) ?/)
(if (and (> (length url) 1)
(eq (aref url 1) ?/))
;; //host...; just use the protocol
(concat (nth 2 base) ":" url)
;; Just use the host name part.
(concat (car base) url)))
((eq (aref url 0) ?#)
;; A link to an anchor.
(concat (nth 3 base) url))
(t
;; Totally relative.
(url-expand-file-name url (concat (car base) (cadr base))))))
(defun shr-ensure-newline ()
(unless (bobp)
(let ((prefix (get-text-property (line-beginning-position)
'shr-prefix-length)))
(unless (or (zerop (current-column))
(and prefix
(= prefix (- (point) (line-beginning-position)))))
(insert "\n")))))
(defun shr-ensure-paragraph ()
(unless (bobp)
(let ((prefix (get-text-property (line-beginning-position)
'shr-prefix-length)))
(cond
((and (bolp)
(save-excursion
(forward-line -1)
(looking-at " *$")))
;; We're already at a new paragraph; do nothing.
)
((and prefix
(= prefix (- (point) (line-beginning-position))))
;; Do nothing; we're at the start of a <li>.
)
((save-excursion
(beginning-of-line)
;; If the current line is totally blank, and doesn't even
;; have any face properties set, then delete the blank
;; space.
(and (looking-at " *$")
(not (get-text-property (point) 'face))
(not (= (next-single-property-change (point) 'face nil
(line-end-position))
(line-end-position)))))
(delete-region (match-beginning 0) (match-end 0)))
;; We have a single blank line.
((and (eolp) (bolp))
(insert "\n"))
;; Insert new paragraph.
(t
(insert "\n\n"))))))
(defun shr-indent ()
(when (> shr-indentation 0)
(insert
(if (not shr-use-fonts)
(make-string shr-indentation ?\s)
(propertize " "
'display
`(space :width (,shr-indentation)))))))
(defun shr-fontize-dom (dom &rest types)
(let ((start (point)))
(shr-generic dom)
(dolist (type types)
(shr-add-font start (point) type))))
;; Add face to the region, but avoid putting the font properties on
;; blank text at the start of the line, and the newline at the end, to
;; avoid ugliness.
(defun shr-add-font (start end type)
(save-excursion
(goto-char start)
(while (< (point) end)
(when (bolp)
(skip-chars-forward " "))
(add-face-text-property (point) (min (line-end-position) end) type t)
(if (< (line-end-position) end)
(forward-line 1)
(goto-char end)))))
(defun shr-mouse-browse-url (ev)
"Browse the URL under the mouse cursor."
(interactive "e")
(mouse-set-point ev)
(shr-browse-url))
(defun shr-browse-url (&optional external mouse-event)
"Browse the URL at point using `browse-url'.
If EXTERNAL is non-nil (interactively, the prefix argument), browse
the URL using `shr-external-browser'.
If this function is invoked by a mouse click, it will browse the URL
at the position of the click. Optional argument MOUSE-EVENT describes
the mouse click event."
(interactive (list current-prefix-arg last-nonmenu-event))
(mouse-set-point mouse-event)
(let ((url (get-text-property (point) 'shr-url)))
(cond
((not url)
(message "No link under point"))
((string-match "^mailto:" url)
(browse-url-mail url))
(t
(if external
(progn
(funcall shr-external-browser url)
(shr--blink-link))
(browse-url url))))))
(defun shr-save-contents (directory)
"Save the contents from URL in a file."
(interactive "DSave contents of URL to directory: ")
(let ((url (get-text-property (point) 'shr-url)))
(if (not url)
(message "No link under point")
(url-retrieve (shr-encode-url url)
'shr-store-contents (list url directory)
nil t))))
(defun shr-store-contents (status url directory)
(unless (plist-get status :error)
(when (or (search-forward "\n\n" nil t)
(search-forward "\r\n\r\n" nil t))
(write-region (point) (point-max)
(expand-file-name (file-name-nondirectory url)
directory)))))
(defun shr-image-fetched (status buffer start end &optional flags)
(let ((image-buffer (current-buffer)))
(when (and (buffer-name buffer)
(not (plist-get status :error)))
(url-store-in-cache image-buffer)
(goto-char (point-min))
(when (or (search-forward "\n\n" nil t)
(search-forward "\r\n\r\n" nil t))
(let ((data (shr-parse-image-data)))
(with-current-buffer buffer
(save-excursion
(save-restriction
(widen)
(let ((alt (buffer-substring start end))
(properties (text-properties-at start))
(inhibit-read-only t))
(delete-region start end)
(goto-char start)
(funcall shr-put-image-function data alt flags)
(while properties
(let ((type (pop properties))
(value (pop properties)))
(unless (memq type '(display image-size))
(put-text-property start (point) type value)))))))))))
(kill-buffer image-buffer)))
(defun shr-image-from-data (data)
"Return an image from the data: URI content DATA."
(when (string-match
"\\(\\([^/;,]+\\(/[^;,]+\\)?\\)\\(;[^;,]+\\)*\\)?,\\(.*\\)"
data)
(let ((param (match-string 4 data))
(payload (url-unhex-string (match-string 5 data))))
(when (and param
(string-match "^.*\\(;[ \t]*base64\\)$" param))
(setq payload (ignore-errors
(base64-decode-string payload))))
payload)))
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))
(defun shr-put-image (spec alt &optional flags)
"Insert image SPEC with a string ALT. Return image.
SPEC is either an image data blob, or a list where the first
element is the data blob and the second element is the content-type."
(if (display-graphic-p)
(let* ((size (cdr (assq 'size flags)))
(data (if (consp spec)
(car spec)
spec))
(content-type (and (consp spec)
(cadr spec)))
(start (point))
(image (cond
((eq size 'original)
(create-image data nil t :ascent 100
:format content-type))
((eq content-type 'image/svg+xml)
(create-image data 'svg t :ascent 100))
((eq size 'full)
(ignore-errors
(shr-rescale-image data content-type
(plist-get flags :width)
(plist-get flags :height))))
(t
(ignore-errors
(shr-rescale-image data content-type
(plist-get flags :width)
(plist-get flags :height)))))))
(when image
;; When inserting big-ish pictures, put them at the
;; beginning of the line.
(when (and (> (current-column) 0)
(> (car (image-size image t)) 400))
(insert "\n"))
(if (eq size 'original)
(insert-sliced-image image (or alt "*") nil 20 1)
(insert-image image (or alt "*")))
(put-text-property start (point) 'image-size size)
(when (and shr-image-animate
(cond ((fboundp 'image-multi-frame-p)
;; Only animate multi-frame things that specify a
;; delay; eg animated gifs as opposed to
;; multi-page tiffs. FIXME?
(cdr (image-multi-frame-p image)))
((fboundp 'image-animated-p)
(image-animated-p image))))
(image-animate image nil 60)))
image)
(insert (or alt ""))))
(defun shr-rescale-image (data content-type width height
&optional max-width max-height)
"Rescale DATA, if too big, to fit the current buffer.
WIDTH and HEIGHT are the sizes given in the HTML data, if any.
The size of the displayed image will not exceed
MAX-WIDTH/MAX-HEIGHT. If not given, use the current window
width/height instead."
(if (or (not (fboundp 'imagemagick-types))
(not (get-buffer-window (current-buffer))))
(create-image data nil t :ascent 100)
(let* ((edges (window-inside-pixel-edges
(get-buffer-window (current-buffer))))
(max-width (truncate (* shr-max-image-proportion
(or max-width
(- (nth 2 edges) (nth 0 edges))))))
(max-height (truncate (* shr-max-image-proportion
(or max-height
(- (nth 3 edges) (nth 1 edges))))))
(scaling (image-compute-scaling-factor image-scaling-factor)))
(when (or (and width
(> width max-width))
(and height
(> height max-height)))
(setq width nil
height nil))
(if (and width height
(< (* width scaling) max-width)
(< (* height scaling) max-height))
(create-image
data 'imagemagick t
:ascent 100
:width width
:height height
:format content-type)
(create-image
data 'imagemagick t
:ascent 100
:max-width max-width
:max-height max-height
:format content-type)))))
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
(autoload 'browse-url-mail "browse-url")
(defun shr-get-image-data (url)
"Get image data for URL.
Return a string with image data."
(with-temp-buffer
(mm-disable-multibyte)
(when (ignore-errors
(url-cache-extract (url-cache-create-filename (shr-encode-url url)))
t)
(when (re-search-forward "\r?\n\r?\n" nil t)
(shr-parse-image-data)))))
(declare-function libxml-parse-xml-region "xml.c"
(start end &optional base-url discard-comments))
(defun shr-parse-image-data ()
(let ((data (buffer-substring (point) (point-max)))
(content-type
(save-excursion
(save-restriction
(narrow-to-region (point-min) (point))
(let ((content-type (mail-fetch-field "content-type")))
(and content-type
;; Remove any comments in the type string.
(intern (replace-regexp-in-string ";.*" "" content-type)
obarray)))))))
;; SVG images may contain references to further images that we may
;; want to block. So special-case these by parsing the XML data
;; and remove anything that looks like a blocked bit.
(when (and shr-blocked-images
(eq content-type 'image/svg+xml))
(setq data
;; Note that libxml2 doesn't parse everything perfectly,
;; so glitches may occur during this transformation.
(shr-dom-to-xml
(libxml-parse-xml-region (point) (point-max)))))
(list data content-type)))
(defun shr-image-displayer (content-function)
"Return a function to display an image.
CONTENT-FUNCTION is a function to retrieve an image for a cid url that
is an argument. The function to be returned takes three arguments URL,
START, and END. Note that START and END should be markers."
`(lambda (url start end)
(when url
(if (string-match "\\`cid:" url)
,(when content-function
`(let ((image (funcall ,content-function
(substring url (match-end 0)))))
(when image
(goto-char start)
(funcall shr-put-image-function
image (buffer-substring start end))
(delete-region (point) end))))
(url-retrieve url 'shr-image-fetched
(list (current-buffer) start end)
t t)))))
(defun shr-heading (dom &rest types)
(shr-ensure-paragraph)
(apply #'shr-fontize-dom dom types)
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-urlify (start url &optional title)
(shr-add-font start (point) 'shr-link)
(add-text-properties
start (point)
(list 'shr-url url
'help-echo (let ((parsed (url-generic-parse-url
(or (ignore-errors
(decode-coding-string
(url-unhex-string url)
'utf-8 t))
url)))
iri)
;; If we have an IDNA domain, then show the
;; decoded version in the mouseover to let the
;; user know that there's something possibly
;; fishy.
(when (url-host parsed)
(setf (url-host parsed)
(puny-encode-domain (url-host parsed))))
(setq iri (url-recreate-url parsed))
(if title
(format "%s (%s)" iri title)
iri))
'follow-link t
'mouse-face 'highlight))
;; Don't overwrite any keymaps that are already in the buffer (i.e.,
;; image keymaps).
(while (and start
(< start (point)))
(let ((next (next-single-property-change start 'keymap nil (point))))
(if (get-text-property start 'keymap)
(setq start next)
(put-text-property start (or next (point)) 'keymap shr-map)))))
(defun shr-encode-url (url)
"Encode URL."
(browse-url-url-encode-chars url "[)$ ]"))
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
(defun shr-color-check (fg bg)
"Check that FG is visible on BG.
Returns (fg bg) with corrected values.
Returns nil if the colors that would be used are the default
ones, in case fg and bg are nil."
(when (or fg bg)
(let ((fixed (cond ((null fg) 'fg)
((null bg) 'bg))))
;; Convert colors to hexadecimal, or set them to default.
(let ((fg (or (shr-color->hexadecimal fg)
(frame-parameter nil 'foreground-color)))
(bg (or (shr-color->hexadecimal bg)
(frame-parameter nil 'background-color))))
(cond ((eq fixed 'bg)
;; Only return the new fg
(list nil (cadr (shr-color-visible bg fg t))))
((eq fixed 'fg)
;; Invert args and results and return only the new bg
(list (cadr (shr-color-visible fg bg t)) nil))
(t
(shr-color-visible bg fg)))))))
(defun shr-colorize-region (start end fg &optional bg)
(when (and shr-use-colors
(or fg bg)
(>= (display-color-cells) 88))
(let ((new-colors (shr-color-check fg bg)))
(when new-colors
(when fg
(add-face-text-property start end
(list :foreground (cadr new-colors))
t))
(when bg
(add-face-text-property start end
(list :background (car new-colors))
t)))
new-colors)))
;;; Tag-specific rendering rules.
(defun shr-tag-html (dom)
(let ((dir (dom-attr dom 'dir)))
(cond
((equal dir "ltr")
(setq bidi-paragraph-direction 'left-to-right))
((equal dir "rtl")
(setq bidi-paragraph-direction 'right-to-left))
((equal dir "auto")
(setq bidi-paragraph-direction nil))))
(shr-generic dom))
(defun shr-tag-body (dom)
(let* ((start (point))
(fgcolor (or (dom-attr dom 'fgcolor) (dom-attr dom 'text)))
(bgcolor (dom-attr dom 'bgcolor))
(shr-stylesheet (list (cons 'color fgcolor)
(cons 'background-color bgcolor))))
(shr-generic dom)
(shr-colorize-region start (point) fgcolor bgcolor)))
(defun shr-tag-style (_dom)
)
(defun shr-tag-script (_dom)
)
(defun shr-tag-comment (_dom)
)
(defun shr-dom-to-xml (dom)
(with-temp-buffer
(shr-dom-print dom)
(buffer-string)))
(defun shr-dom-print (dom)
"Convert DOM into a string containing the xml representation."
(insert (format "<%s" (dom-tag dom)))
(dolist (attr (dom-attributes dom))
;; Ignore attributes that start with a colon because they are
;; private elements.
(unless (= (aref (format "%s" (car attr)) 0) ?:)
(insert (format " %s=\"%s\"" (car attr) (cdr attr)))))
(insert ">")
(let (url)
(dolist (elem (dom-children dom))
(cond
((stringp elem)
(insert elem))
((eq (dom-tag elem) 'comment)
)
((or (not (eq (dom-tag elem) 'image))
;; Filter out blocked elements inside the SVG image.
(not (setq url (dom-attr elem ':xlink:href)))
(not shr-blocked-images)
(not (string-match shr-blocked-images url)))
(insert " ")
(shr-dom-print elem)))))
(insert (format "</%s>" (dom-tag dom))))
(defun shr-tag-svg (dom)
(when (and (image-type-available-p 'svg)
(not shr-inhibit-images)
(dom-attr dom 'width)
(dom-attr dom 'height))
(funcall shr-put-image-function (list (shr-dom-to-xml dom) 'image/svg+xml)
"SVG Image")))
(defun shr-tag-sup (dom)
(let ((start (point)))
(shr-generic dom)
(put-text-property start (point) 'display '(raise 0.5))))
(defun shr-tag-sub (dom)
(let ((start (point)))
(shr-generic dom)
(put-text-property start (point) 'display '(raise -0.5))))
(defun shr-tag-p (dom)
(shr-ensure-paragraph)
(shr-generic dom)
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-div (dom)
(let ((display (cdr (assq 'display shr-stylesheet))))
(if (or (equal display "inline")
(equal display "inline-block"))
(shr-generic dom)
(shr-ensure-newline)
(shr-generic dom)
(shr-ensure-newline))))
(defun shr-tag-s (dom)
(shr-fontize-dom dom 'shr-strike-through))
(defun shr-tag-b (dom)
(shr-fontize-dom dom 'bold))
(defun shr-tag-i (dom)
(shr-fontize-dom dom 'italic))
(defun shr-tag-em (dom)
(shr-fontize-dom dom 'italic))
(defun shr-tag-strong (dom)
(shr-fontize-dom dom 'bold))
(defun shr-tag-u (dom)
(shr-fontize-dom dom 'underline))
(defun shr-tag-tt (dom)
(let ((shr-current-font 'default))
(shr-generic dom)))
(defun shr-tag-ins (cont)
(let* ((start (point))
(color "green")
(shr-stylesheet (nconc (list (cons 'color color))
shr-stylesheet)))
(shr-generic cont)
(shr-colorize-region start (point) color
(cdr (assq 'background-color shr-stylesheet)))))
(defun shr-tag-del (cont)
(let* ((start (point))
(color "red")
(shr-stylesheet (nconc (list (cons 'color color))
shr-stylesheet)))
(shr-fontize-dom cont 'shr-strike-through)
(shr-colorize-region start (point) color
(cdr (assq 'background-color shr-stylesheet)))))
(defun shr-parse-style (style)
(when style
(save-match-data
(when (string-match "\n" style)
(setq style (replace-match " " t t style))))
(let ((plist nil))
(dolist (elem (split-string style ";"))
(when elem
(setq elem (split-string elem ":"))
(when (and (car elem)
(cadr elem))
(let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
(value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
(when (string-match " *!important\\'" value)
(setq value (substring value 0 (match-beginning 0))))
(unless (equal value "inherit")
(push (cons (intern name obarray)
value)
plist))))))
plist)))
(defun shr-tag-base (dom)
(when-let* ((base (dom-attr dom 'href)))
(setq shr-base (shr-parse-base base)))
(shr-generic dom))
(defun shr-tag-a (dom)
(let ((url (dom-attr dom 'href))
(title (dom-attr dom 'title))
(start (point))
shr-start)
(shr-generic dom)
(when (and shr-target-id
(equal (dom-attr dom 'name) shr-target-id))
;; We have a zero-length <a name="foo"> element, so just
;; insert... something.
(when (= start (point))
(shr-ensure-newline)
(insert " "))
(put-text-property start (1+ start) 'shr-target-id shr-target-id))
(when url
(shr-urlify (or shr-start start) (shr-expand-url url) title))))
(defun shr-tag-object (dom)
(unless shr-inhibit-images
(let ((start (point))
url multimedia image)
(when-let* ((type (dom-attr dom 'type)))
(when (string-match "\\`image/svg" type)
(setq url (dom-attr dom 'data)
image t)))
(dolist (child (dom-non-text-children dom))
(cond
((eq (dom-tag child) 'embed)
(setq url (or url (dom-attr child 'src))
multimedia t))
((and (eq (dom-tag child) 'param)
(equal (dom-attr child 'name) "movie"))
(setq url (or url (dom-attr child 'value))
multimedia t))))
(when url
(cond
(image
(shr-indirect-call 'img dom url)
(setq dom nil))
(multimedia
(shr-insert " [multimedia] ")
(shr-urlify start (shr-expand-url url)))))
(when dom
(shr-generic dom)))))
(defcustom shr-prefer-media-type-alist '(("webm" . 1.0)
("ogv" . 1.0)
("ogg" . 1.0)
("opus" . 1.0)
("flac" . 0.9)
("wav" . 0.5))
"Preferences for media types.
The key element should be a regexp matched against the type of the source or
url if no type is specified. The value should be a float in the range 0.0 to
1.0. Media elements with higher value are preferred."
:version "24.4"
:group 'shr
:type '(alist :key-type regexp :value-type float))
(defun shr--get-media-pref (elem)
"Determine the preference for ELEM.
The preference is a float determined from `shr-prefer-media-type'."
(let ((type (dom-attr elem 'type))
(p 0.0))
(unless type
(setq type (dom-attr elem 'src)))
(when type
(dolist (pref shr-prefer-media-type-alist)
(when (and
(> (cdr pref) p)
(string-match-p (car pref) type))
(setq p (cdr pref)))))
p))
(defun shr--extract-best-source (dom &optional url pref)
"Extract the best `:src' property from <source> blocks in DOM."
(setq pref (or pref -1.0))
(let (new-pref)
(dolist (elem (dom-non-text-children dom))
(when (and (eq (dom-tag elem) 'source)
(< pref
(setq new-pref
(shr--get-media-pref elem))))
(setq pref new-pref
url (dom-attr elem 'src))
;; libxml's html parser isn't HTML5 compliant and non terminated
;; source tags might end up as children. So recursion it is...
(dolist (child (dom-non-text-children elem))
(when (eq (dom-tag child) 'source)
(let ((ret (shr--extract-best-source (list child) url pref)))
(when (< pref (cdr ret))
(setq url (car ret)
pref (cdr ret)))))))))
(cons url pref))
(defun shr-tag-video (dom)
(let ((image (dom-attr dom 'poster))
(url (dom-attr dom 'src))
(start (point)))
(unless url
(setq url (car (shr--extract-best-source dom))))
(if (> (length image) 0)
(shr-indirect-call 'img nil image)
(shr-insert " [video] "))
(shr-urlify start (shr-expand-url url))))
(defun shr-tag-audio (dom)
(let ((url (dom-attr dom 'src))
(start (point)))
(unless url
(setq url (car (shr--extract-best-source dom))))
(shr-insert " [audio] ")
(shr-urlify start (shr-expand-url url))))
(defun shr-tag-img (dom &optional url)
(when (or url
(and dom
(or (> (length (dom-attr dom 'src)) 0)
(> (length (dom-attr dom 'srcset)) 0))))
(when (> (current-column) 0)
(insert "\n"))
(let ((alt (dom-attr dom 'alt))
(width (shr-string-number (dom-attr dom 'width)))
(height (shr-string-number (dom-attr dom 'height)))
(url (shr-expand-url (or url (shr--preferred-image dom)))))
(let ((start (point-marker)))
(when (zerop (length alt))
(setq alt "*"))
(cond
((null url)
;; After further expansion, there turned out to be no valid
;; src in the img after all.
)
((or (member (dom-attr dom 'height) '("0" "1"))
(member (dom-attr dom 'width) '("0" "1")))
;; Ignore zero-sized or single-pixel images.
)
((and (not shr-inhibit-images)
(string-match "\\`data:" url))
(let ((image (shr-image-from-data (substring url (match-end 0)))))
(if image
(funcall shr-put-image-function image alt
(list :width width :height height))
(insert alt))))
((and (not shr-inhibit-images)
(string-match "\\`cid:" url))
(let ((url (substring url (match-end 0)))
image)
(if (or (not shr-content-function)
(not (setq image (funcall shr-content-function url))))
(insert alt)
(funcall shr-put-image-function image alt
(list :width width :height height)))))
((or shr-inhibit-images
(and shr-blocked-images
(string-match shr-blocked-images url)))
(setq shr-start (point))
(shr-insert alt))
((and (not shr-ignore-cache)
(url-is-cached (shr-encode-url url)))
(funcall shr-put-image-function (shr-get-image-data url) alt
(list :width width :height height)))
(t
(when (and shr-ignore-cache
(url-is-cached (shr-encode-url url)))
(let ((file (url-cache-create-filename (shr-encode-url url))))
(when (file-exists-p file)
(delete-file file))))
(when (image-type-available-p 'svg)
(insert-image
(shr-make-placeholder-image dom)
(or alt "")))
(insert " ")
(url-queue-retrieve
(shr-encode-url url) 'shr-image-fetched
(list (current-buffer) start (set-marker (make-marker) (point))
(list :width width :height height))
t t)))
(when (zerop shr-table-depth) ;; We are not in a table.
(put-text-property start (point) 'keymap shr-image-map)
(put-text-property start (point) 'shr-alt alt)
(put-text-property start (point) 'image-url url)
(put-text-property start (point) 'image-displayer
(shr-image-displayer shr-content-function))
(put-text-property start (point) 'help-echo
(shr-fill-text
(or (dom-attr dom 'title) alt))))))))
(defun shr--preferred-image (dom)
(let ((srcset (dom-attr dom 'srcset))
(frame-width (frame-pixel-width))
(width (string-to-number (or (dom-attr dom 'width) "100")))
candidate)
(when (> (length srcset) 0)
;; srcset consist of a series of URL/size specifications
;; separated by the ", " string.
(setq srcset
(sort (mapcar
(lambda (elem)
(let ((spec (split-string elem "[\t\n\r ]+")))
(cond
((= (length spec) 1)
;; Make sure it's well formed.
(list (car spec) 0))
((string-match "\\([0-9]+\\)x\\'" (cadr spec))
;; If we have an "x" form, then use the width
;; spec to compute the real width.
(list (car spec)
(* width (string-to-number
(match-string 1 (cadr spec))))))
(t
(list (car spec)
(string-to-number (cadr spec)))))))
(split-string (replace-regexp-in-string
"\\`[\t\n\r ]+\\|[\t\n\r ]+\\'" "" srcset)
"[\t\n\r ]*,[\t\n\r ]*"))
(lambda (e1 e2)
(> (cadr e1) (cadr e2)))))
;; Choose the smallest picture that's bigger than the current
;; frame.
(setq candidate (caar srcset))
(while (and srcset
(> (cadr (car srcset)) frame-width))
(setq candidate (caar srcset))
(pop srcset)))
(or candidate (dom-attr dom 'src))))
(defun shr-string-number (string)
(if (null string)
nil
(setq string (replace-regexp-in-string "[^0-9]" "" string))
(if (zerop (length string))
nil
(string-to-number string))))
(defun shr-make-placeholder-image (dom)
(let* ((edges (and
(get-buffer-window (current-buffer))
(window-inside-pixel-edges
(get-buffer-window (current-buffer)))))
(scaling (image-compute-scaling-factor image-scaling-factor))
(width (truncate
(* (or (shr-string-number (dom-attr dom 'width)) 100)
scaling)))
(height (truncate
(* (or (shr-string-number (dom-attr dom 'height)) 100)
scaling)))
(max-width
(and edges
(truncate (* shr-max-image-proportion
(- (nth 2 edges) (nth 0 edges))))))
(max-height (and edges
(truncate (* shr-max-image-proportion
(- (nth 3 edges) (nth 1 edges))))))
svg)
(when (and max-width
(> width max-width))
(setq height (truncate (* (/ (float max-width) width) height))
width max-width))
(when (and max-height
(> height max-height))
(setq width (truncate (* (/ (float max-height) height) width))
height max-height))
(setq svg (svg-create width height))
(svg-gradient svg "background" 'linear '((0 . "#b0b0b0") (100 . "#808080")))
(svg-rectangle svg 0 0 width height :gradient "background"
:stroke-width 2 :stroke-color "black")
(let ((image (svg-image svg)))
(setf (image-property image :ascent) 100)
image)))
(defun shr-tag-pre (dom)
(let ((shr-folding-mode 'none)
(shr-current-font 'default))
(shr-ensure-newline)
(shr-generic dom)
(shr-ensure-newline)))
(defun shr-tag-blockquote (dom)
(shr-ensure-paragraph)
(let ((start (point))
(shr-indentation (+ shr-indentation
(* 4 shr-table-separator-pixel-width))))
(shr-generic dom)
(shr-ensure-paragraph)
(shr-mark-fill start)))
(defun shr-tag-dl (dom)
(shr-ensure-paragraph)
(shr-generic dom)
(shr-ensure-paragraph))
(defun shr-tag-dt (dom)
(shr-ensure-newline)
(shr-generic dom)
(shr-ensure-newline))
(defun shr-tag-dd (dom)
(shr-ensure-newline)
(let ((shr-indentation (+ shr-indentation
(* 4 shr-table-separator-pixel-width))))
(shr-generic dom)))
(defun shr-tag-ul (dom)
(shr-ensure-paragraph)
(let ((shr-list-mode 'ul))
(shr-generic dom))
;; If we end on an empty <li>, then make sure we really end on a new
;; paragraph.
(unless (bolp)
(insert "\n"))
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-ol (dom)
(shr-ensure-paragraph)
(let ((shr-list-mode 1))
(shr-generic dom))
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-li (dom)
(shr-ensure-newline)
(let ((start (point)))
(let* ((bullet
(if (numberp shr-list-mode)
(prog1
(format "%d " shr-list-mode)
(setq shr-list-mode (1+ shr-list-mode)))
(car shr-internal-bullet)))
(width (if (numberp shr-list-mode)
(shr-string-pixel-width bullet)
(cdr shr-internal-bullet))))
(insert bullet)
(shr-mark-fill start)
(let ((shr-indentation (+ shr-indentation width)))
(put-text-property start (1+ start)
'shr-continuation-indentation shr-indentation)
(put-text-property start (1+ start) 'shr-prefix-length (length bullet))
(shr-generic dom))))
(unless (bolp)
(unless shr-use-fonts (insert "\x2028")) ; insert a line separator
(insert "\n")))
(defun shr-mark-fill (start)
;; We may not have inserted any text to fill.
(unless (= start (point))
(put-text-property start (1+ start)
'shr-indentation shr-indentation)))
(defun shr-tag-br (dom)
(when (and (not (bobp))
;; Only add a newline if we break the current line, or
;; the previous line isn't a blank line.
(or (not (bolp))
(and (> (- (point) 2) (point-min))
(not (= (char-after (- (point) 2)) ?\n)))))
(unless shr-use-fonts (insert "\x2028")) ; insert a line separator
(insert "\n"))
(shr-generic dom))
(defun shr-tag-span (dom)
(shr-generic dom))
(defun shr-tag-h1 (dom)
(shr-heading dom (if shr-use-fonts
'(variable-pitch (:height 1.3 :weight bold))
'bold)))
(defun shr-tag-h2 (dom)
(shr-heading dom 'bold))
(defun shr-tag-h3 (dom)
(shr-heading dom 'italic))
(defun shr-tag-h4 (dom)
(shr-heading dom))
(defun shr-tag-h5 (dom)
(shr-heading dom))
(defun shr-tag-h6 (dom)
(shr-heading dom))
(defun shr-tag-hr (_dom)
(shr-ensure-newline)
(insert (make-string (if (not shr-use-fonts)
shr-internal-width
(1+ (/ shr-internal-width
shr-table-separator-pixel-width)))
shr-hr-line)
"\n"))
(defun shr-tag-title (dom)
(shr-heading dom 'bold 'underline))
(defun shr-tag-font (dom)
(let* ((start (point))
(color (dom-attr dom 'color))
(shr-stylesheet (nconc (list (cons 'color color))
shr-stylesheet)))
(shr-generic dom)
(when color
(shr-colorize-region start (point) color
(cdr (assq 'background-color shr-stylesheet))))))
(defun shr-tag-bdo (dom)
(let* ((direction (dom-attr dom 'dir))
(char (cond
((equal direction "ltr")
?\N{LEFT-TO-RIGHT OVERRIDE})
((equal direction "rtl")
?\N{RIGHT-TO-LEFT OVERRIDE}))))
(when char
(insert ?\N{FIRST STRONG ISOLATE} char))
(shr-generic dom)
(when char
(insert ?\N{POP DIRECTIONAL FORMATTING} ?\N{POP DIRECTIONAL ISOLATE}))))
(defun shr-tag-bdi (dom)
(insert ?\N{FIRST STRONG ISOLATE})
(shr-generic dom)
(insert ?\N{POP DIRECTIONAL ISOLATE}))
;;; Table rendering algorithm.
;; Table rendering is the only complicated thing here. We do this by
;; first counting how many TDs there are in each TR, and registering
;; how wide they think they should be ("width=45%", etc). Then we
;; render each TD separately (this is done in temporary buffers, so
;; that we can use all the rendering machinery as if we were in the
;; main buffer). Now we know how much space each TD really takes, so
;; we then render everything again with the new widths, and finally
;; insert all these boxes into the main buffer.
(defun shr-tag-table-1 (dom)
(setq dom (or (dom-child-by-tag dom 'tbody) dom))
(let* ((shr-inhibit-images t)
(shr-table-depth (1+ shr-table-depth))
(shr-kinsoku-shorten t)
;; Find all suggested widths.
(columns (shr-column-specs dom))
;; Compute how many pixels wide each TD should be.
(suggested-widths (shr-pro-rate-columns columns))
;; Do a "test rendering" to see how big each TD is (this can
;; be smaller (if there's little text) or bigger (if there's
;; unbreakable text).
(elems (or (dom-attr dom 'shr-suggested-widths)
(shr-make-table dom suggested-widths nil
'shr-suggested-widths)))
(sketch (cl-loop for line in elems
collect (mapcar #'car line)))
(natural (cl-loop for line in elems
collect (mapcar #'cdr line)))
(sketch-widths (shr-table-widths sketch natural suggested-widths)))
;; This probably won't work very well.
(when (> (+ (cl-loop for width across sketch-widths
summing (1+ width))
shr-indentation shr-table-separator-pixel-width)
(frame-width))
(setq truncate-lines t))
;; Then render the table again with these new "hard" widths.
(shr-insert-table (shr-make-table dom sketch-widths t) sketch-widths)))
(defun shr-table-body (dom)
(let ((tbodies (seq-filter (lambda (child)
(eq (dom-tag child) 'tbody))
(dom-non-text-children dom))))
(cond
((null tbodies)
dom)
((= (length tbodies) 1)
(car tbodies))
(t
;; Table with multiple tbodies. Convert into a single tbody.
`(tbody nil ,@(cl-reduce 'append
(mapcar 'dom-non-text-children tbodies)))))))
(defun shr-tag-table (dom)
(shr-ensure-paragraph)
(let* ((caption (dom-children (dom-child-by-tag dom 'caption)))
(header (dom-non-text-children (dom-child-by-tag dom 'thead)))
(body (dom-non-text-children (shr-table-body dom)))
(footer (dom-non-text-children (dom-child-by-tag dom 'tfoot)))
(bgcolor (dom-attr dom 'bgcolor))
(start (point))
(shr-stylesheet (nconc (list (cons 'background-color bgcolor))
shr-stylesheet))
(nheader (if header (shr-max-columns header)))
(nbody (if body (shr-max-columns body) 0))
(nfooter (if footer (shr-max-columns footer))))
(if (and (not caption)
(not header)
(not (dom-child-by-tag dom 'tbody))
(not (dom-child-by-tag dom 'tr))
(not footer))
;; The table is totally invalid and just contains random junk.
;; Try to output it anyway.
(shr-generic dom)
;; It's a real table, so render it.
(if (dom-attr dom 'shr-fixed-table)
(shr-tag-table-1 dom)
;; Only fix up the table once.
(let ((table
(nconc
(list 'table nil)
(if caption `((tr nil (td nil ,@caption))))
(cond
(header
(if footer
;; header + body + footer
(if (= nheader nbody)
(if (= nbody nfooter)
`((tr nil (td nil (table nil
(tbody nil ,@header
,@body ,@footer)))))
(nconc `((tr nil (td nil (table nil
(tbody nil ,@header
,@body)))))
(if (= nfooter 1)
footer
`((tr nil (td nil (table
nil (tbody
nil ,@footer))))))))
(nconc `((tr nil (td nil (table nil (tbody
nil ,@header)))))
(if (= nbody nfooter)
`((tr nil (td nil (table
nil (tbody nil ,@body
,@footer)))))
(nconc `((tr nil (td nil (table
nil (tbody nil
,@body)))))
(if (= nfooter 1)
footer
`((tr nil (td nil (table
nil
(tbody
nil
,@footer))))))))))
;; header + body
(if (= nheader nbody)
`((tr nil (td nil (table nil (tbody nil ,@header
,@body)))))
(if (= nheader 1)
`(,@header (tr nil (td nil (table
nil (tbody nil ,@body)))))
`((tr nil (td nil (table nil (tbody nil ,@header))))
(tr nil (td nil (table nil (tbody nil ,@body)))))))))
(footer
;; body + footer
(if (= nbody nfooter)
`((tr nil (td nil (table
nil (tbody nil ,@body ,@footer)))))
(nconc `((tr nil (td nil (table nil (tbody nil ,@body)))))
(if (= nfooter 1)
footer
`((tr nil (td nil (table
nil (tbody nil ,@footer)))))))))
(caption
`((tr nil (td nil (table nil (tbody nil ,@body))))))
(body)))))
(dom-set-attribute table 'shr-fixed-table t)
(setcdr dom (cdr table))
(shr-tag-table-1 dom))))
(when bgcolor
(shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
bgcolor))
;; Finally, insert all the images after the table. The Emacs buffer
;; model isn't strong enough to allow us to put the images actually
;; into the tables. It inserts also non-td/th objects.
(when (zerop shr-table-depth)
(save-excursion
(shr-expand-alignments start (point)))
(let ((strings (shr-collect-extra-strings-in-table dom)))
(when strings
(save-restriction
(narrow-to-region (point) (point))
(insert (mapconcat #'identity strings "\n"))
(shr-fill-lines (point-min) (point-max))))))))
(defun shr-collect-extra-strings-in-table (dom &optional flags)
"Return extra strings in DOM of which the root is a table clause.
Render <img>s and <object>s, and strings and child <table>s of which
the parent <td> or <th> is lacking. FLAGS is a cons of two boolean
flags that control whether to collect or render objects."
;; This function runs recursively and collects strings if the cdr of
;; FLAGS is nil and the car is not nil, and it renders also child
;; <table>s if the cdr is nil. Note: FLAGS may be nil, not a cons.
;; FLAGS becomes (t . nil) if a <tr> clause is found in the children
;; of DOM, and becomes (t . t) if a <td> or a <th> clause is found
;; and the car is t then. When a <table> clause is found, FLAGS
;; becomes nil if the cdr is t then. But if FLAGS is (t . nil) then,
;; it renders the <table>.
(cl-loop for child in (dom-children dom) with recurse with tag
do (setq recurse nil)
if (stringp child)
unless (or (not (car flags)) (cdr flags))
when (string-match "\\(?:[^\t\n\r ]+[\t\n\r ]+\\)*[^\t\n\r ]+"
child)
collect (match-string 0 child)
end end
else if (consp child)
do (setq tag (dom-tag child)) and
unless (memq tag '(comment style))
if (eq tag 'img)
do (shr-indirect-call 'img child)
else if (eq tag 'object)
do (shr-indirect-call 'object child)
else
do (setq recurse t) and
if (eq tag 'tr)
do (setq flags '(t . nil))
else if (memq tag '(td th))
when (car flags)
do (setq flags '(t . t))
end
else if (eq tag 'table)
if (cdr flags)
do (setq flags nil)
else if (car flags)
do (setq recurse nil)
(shr-indirect-call 'table child)
end end end end end end end end end end
when recurse
append (shr-collect-extra-strings-in-table child flags)))
(defun shr-insert-table (table widths)
(let* ((collapse (equal (cdr (assq 'border-collapse shr-stylesheet))
"collapse"))
(shr-table-separator-length (if collapse 0 1))
(shr-table-vertical-line (if collapse "" shr-table-vertical-line))
(start (point)))
(setq shr-table-id (1+ shr-table-id))
(unless collapse
(shr-insert-table-ruler widths))
(dolist (row table)
(let ((start (point))
(align 0)
(column-number 0)
(height (let ((max 0))
(dolist (column row)
(setq max (max max (nth 2 column))))
max)))
(dotimes (_ (max height 1))
(shr-indent)
(insert shr-table-vertical-line "\n"))
(dolist (column row)
(when (> (nth 2 column) -1)
(goto-char start)
;; Sum up all the widths from the column. (There may be
;; more than one if this is a "colspan" column.)
(dotimes (_ (nth 4 column))
;; The colspan directive may be wrong and there may not be
;; that number of columns.
(when (<= column-number (1- (length widths)))
(setq align (+ align
(aref widths column-number)
(* 2 shr-table-separator-pixel-width))))
(setq column-number (1+ column-number)))
(let ((lines (nth 3 column))
(pixel-align (if (not shr-use-fonts)
(* align (frame-char-width))
align)))
(dolist (line lines)
(end-of-line)
(let ((start (point))
(background (and (> (length line) 0)
(shr-face-background
(get-text-property
(1- (length line)) 'face line))))
(space (propertize
" "
'display `(space :align-to (,pixel-align))
'shr-table-indent shr-table-id)))
(when background
(setq space (propertize space 'face background)))
(insert line space shr-table-vertical-line)
(shr-colorize-region
start (1- (point)) (nth 5 column) (nth 6 column)))
(forward-line 1))
;; Add blank lines at padding at the bottom of the TD,
;; possibly.
(dotimes (_ (- height (length lines)))
(end-of-line)
(let ((start (point)))
(insert (propertize " "
'display `(space :align-to (,pixel-align))
'shr-table-indent shr-table-id)
shr-table-vertical-line)
(shr-colorize-region
start (1- (point)) (nth 5 column) (nth 6 column)))
(forward-line 1))))))
(unless collapse
(shr-insert-table-ruler widths)))
(unless (= start (point))
(put-text-property start (1+ start) 'shr-table-id shr-table-id))))
(defun shr-face-background (face)
(and (consp face)
(or (and (plist-get face :background)
(list :background (plist-get face :background)))
(let ((background nil))
(dolist (elem face)
(when (and (consp elem)
(eq (car elem) :background)
(not background))
(setq background (cadr elem))))
(and background
(list :background background))))))
(defun shr-expand-alignments (start end)
(while (< (setq start (next-single-property-change
start 'shr-table-id nil end))
end)
(goto-char start)
(let* ((shr-use-fonts t)
(id (get-text-property (point) 'shr-table-id))
(base (shr-pixel-column))
elem)
(when id
(save-excursion
(while (setq elem (text-property-any
(point) end 'shr-table-indent id))
(goto-char elem)
(let ((align (get-text-property (point) 'display)))
(put-text-property (point) (1+ (point)) 'display
`(space :align-to (,(+ (car (nth 2 align))
base)))))
(forward-char 1)))))
(setq start (1+ start))))
(defun shr-insert-table-ruler (widths)
(when shr-table-horizontal-line
(when (and (bolp)
(> shr-indentation 0))
(shr-indent))
(insert shr-table-corner)
(let ((total-width 0))
(dotimes (i (length widths))
(setq total-width (+ total-width (aref widths i)
(* shr-table-separator-pixel-width 2)))
(insert (make-string (1+ (/ (aref widths i)
shr-table-separator-pixel-width))
shr-table-horizontal-line)
(propertize " "
'display `(space :align-to (,total-width))
'shr-table-indent shr-table-id)
shr-table-corner)))
(insert "\n")))
(defun shr-table-widths (table natural-table suggested-widths)
(let* ((length (length suggested-widths))
(widths (make-vector length 0))
(natural-widths (make-vector length 0)))
(dolist (row table)
(let ((i 0))
(dolist (column row)
(aset widths i (max (aref widths i) column))
(setq i (1+ i)))))
(dolist (row natural-table)
(let ((i 0))
(dolist (column row)
(aset natural-widths i (max (aref natural-widths i) column))
(setq i (1+ i)))))
(let ((extra (- (apply '+ (append suggested-widths nil))
(apply '+ (append widths nil))
(* shr-table-separator-pixel-width (1+ (length widths)))))
(expanded-columns 0))
;; We have extra, unused space, so divide this space amongst the
;; columns.
(when (> extra 0)
;; If the natural width is wider than the rendered width, we
;; want to allow the column to expand.
(dotimes (i length)
(when (> (aref natural-widths i) (aref widths i))
(setq expanded-columns (1+ expanded-columns))))
(dotimes (i length)
(when (> (aref natural-widths i) (aref widths i))
(aset widths i (min
(aref natural-widths i)
(+ (/ extra expanded-columns)
(aref widths i))))))))
widths))
(defun shr-make-table (dom widths &optional fill storage-attribute)
(or (cadr (assoc (list dom widths fill) shr-content-cache))
(let ((data (shr-make-table-1 dom widths fill)))
(push (list (list dom widths fill) data)
shr-content-cache)
(when storage-attribute
(dom-set-attribute dom storage-attribute data))
data)))
(defun shr-make-table-1 (dom widths &optional fill)
(let ((trs nil)
(rowspans (make-vector (length widths) 0))
(colspan-remaining 0)
colspan-width colspan-count
width colspan)
(dolist (row (dom-non-text-children dom))
(when (eq (dom-tag row) 'tr)
(let ((tds nil)
(columns (dom-non-text-children row))
(i 0)
(width-column 0)
column)
(while (< i (length widths))
;; If we previously had a rowspan definition, then that
;; means that we now have a "missing" td/th element here.
;; So just insert a dummy, empty one to (sort of) emulate
;; rowspan.
(setq column
(if (zerop (aref rowspans i))
(pop columns)
(aset rowspans i (1- (aref rowspans i)))
'(td)))
(when (and (not (stringp column))
(or (memq (dom-tag column) '(td th))
(not column)))
(when-let* ((span (dom-attr column 'rowspan)))
(aset rowspans i (+ (aref rowspans i)
(1- (string-to-number span)))))
;; Sanity check for invalid column-spans.
(when (>= width-column (length widths))
(setq width-column 0))
(setq width
(if column
(aref widths width-column)
(* 10 shr-table-separator-pixel-width)))
(when (setq colspan (dom-attr column 'colspan))
(setq colspan (min (string-to-number colspan)
;; The colspan may be wrong, so
;; truncate it to the length of the
;; remaining columns.
(- (length widths) i)))
(dotimes (j (1- colspan))
(setq width
(if (> (+ i 1 j) (1- (length widths)))
;; If we have a colspan spec that's longer
;; than the table is wide, just use the last
;; width as the width.
(aref widths (1- (length widths)))
;; Sum up the widths of the columns we're
;; spanning.
(+ width
shr-table-separator-length
(aref widths (+ i 1 j))))))
(setq width-column (+ width-column (1- colspan))
colspan-count colspan
colspan-remaining colspan))
(when column
(let ((data (shr-render-td column width fill)))
(if (and (not fill)
(> colspan-remaining 0))
(progn
(setq colspan-width (car data))
(let ((this-width (/ colspan-width colspan-count)))
(push (cons this-width (cadr data)) tds)
(setq colspan-remaining (1- colspan-remaining))))
(if (not fill)
(push (cons (car data) (cadr data)) tds)
(push data tds)))))
(when (and colspan
(> colspan 1))
(dotimes (_ (1- colspan))
(setq i (1+ i))
(push
(if fill
(list 0 0 -1 nil 1 nil nil)
'(0 . 0))
tds)))
(setq i (1+ i)
width-column (1+ width-column))))
(push (nreverse tds) trs))))
(nreverse trs)))
(defun shr-pixel-buffer-width ()
(if (not shr-use-fonts)
(save-excursion
(goto-char (point-min))
(let ((max 0))
(while (not (eobp))
(end-of-line)
(setq max (max max (current-column)))
(forward-line 1))
max))
(if (get-buffer-window)
(car (window-text-pixel-size nil (point-min) (point-max)))
(save-window-excursion
;; Avoid errors if the selected window is a dedicated one,
;; and they just want to insert a document into it.
(set-window-dedicated-p nil nil)
(set-window-buffer nil (current-buffer))
(car (window-text-pixel-size nil (point-min) (point-max)))))))
(defun shr-render-td (dom width fill)
(let ((cache (intern (format "shr-td-cache-%s-%s" width fill))))
(or (dom-attr dom cache)
(and fill
(let (result)
(dolist (attr (dom-attributes dom))
(let ((name (symbol-name (car attr))))
(when (string-match "shr-td-cache-\\([0-9]+\\)-nil" name)
(let ((cache-width (string-to-number
(match-string 1 name))))
(when (and (>= cache-width width)
(<= (car (cdr attr)) width))
(setq result (cdr attr)))))))
result))
(let* ((pt (point))
(result (shr-render-td-1 dom width fill)))
(dom-set-attribute dom cache result)
(goto-char pt)
result))))
(defun shr-render-td-1 (dom width fill)
(with-temp-buffer
(let ((bgcolor (dom-attr dom 'bgcolor))
(fgcolor (dom-attr dom 'fgcolor))
(style (dom-attr dom 'style))
(shr-stylesheet shr-stylesheet)
(max-width 0)
natural-width)
(when style
(setq style (and (string-match "color" style)
(shr-parse-style style))))
(when bgcolor
(setq style (nconc (list (cons 'background-color bgcolor))
style)))
(when fgcolor
(setq style (nconc (list (cons 'color fgcolor)) style)))
(when style
(setq shr-stylesheet (append style shr-stylesheet)))
(let ((shr-internal-width width)
(shr-indentation 0))
(shr-descend dom))
(save-window-excursion
;; Avoid errors if the selected window is a dedicated one,
;; and they just want to insert a document into it.
(set-window-dedicated-p nil nil)
(set-window-buffer nil (current-buffer))
(unless fill
(setq natural-width
(or (dom-attr dom 'shr-td-cache-natural)
(let ((natural (max (shr-pixel-buffer-width)
(shr-dom-max-natural-width dom 0))))
(dom-set-attribute dom 'shr-td-cache-natural natural)
natural))))
(if (and natural-width
(<= natural-width width))
(setq max-width natural-width)
(let ((shr-internal-width width))
(shr-fill-lines (point-min) (point-max))
(setq max-width (shr-pixel-buffer-width)))))
(goto-char (point-max))
;; Delete padding at the bottom of the TDs.
(delete-region
(point)
(progn
(skip-chars-backward " \t\n")
(end-of-line)
(point)))
(goto-char (point-min))
(list max-width
natural-width
(count-lines (point-min) (point-max))
(split-string (buffer-string) "\n")
(if (dom-attr dom 'colspan)
(string-to-number (dom-attr dom 'colspan))
1)
(cdr (assq 'color shr-stylesheet))
(cdr (assq 'background-color shr-stylesheet))))))
(defun shr-dom-max-natural-width (dom max)
(if (eq (dom-tag dom) 'table)
(max max (or
(cl-loop
for line in (dom-attr dom 'shr-suggested-widths)
maximize (+
shr-table-separator-length
(cl-loop for elem in line
summing
(+ (cdr elem)
(* 2 shr-table-separator-length)))))
0))
(dolist (child (dom-children dom))
(unless (stringp child)
(setq max (max (shr-dom-max-natural-width child max)))))
max))
(defun shr-buffer-width ()
(goto-char (point-min))
(let ((max 0))
(while (not (eobp))
(end-of-line)
(setq max (max max (current-column)))
(forward-line 1))
max))
(defun shr-pro-rate-columns (columns)
(let ((total-percentage 0)
(widths (make-vector (length columns) 0)))
(dotimes (i (length columns))
(setq total-percentage (+ total-percentage (aref columns i))))
(setq total-percentage (/ 1.0 total-percentage))
(dotimes (i (length columns))
(aset widths i (max (truncate (* (aref columns i)
total-percentage
(- shr-internal-width
(* (1+ (length columns))
shr-table-separator-pixel-width))))
10)))
widths))
;; Return a summary of the number and shape of the TDs in the table.
(defun shr-column-specs (dom)
(let ((columns (make-vector (shr-max-columns dom) 1)))
(dolist (row (dom-non-text-children dom))
(when (eq (dom-tag row) 'tr)
(let ((i 0))
(dolist (column (dom-non-text-children row))
(when (memq (dom-tag column) '(td th))
(let ((width (dom-attr column 'width)))
(when (and width
(string-match "\\([0-9]+\\)%" width)
(not (zerop (setq width (string-to-number
(match-string 1 width))))))
(aset columns i (/ width 100.0))))
(setq i (1+ i)))))))
columns))
(defun shr-count (dom elem)
(let ((i 0))
(dolist (sub (dom-children dom))
(when (and (not (stringp sub))
(eq (dom-tag sub) elem))
(setq i (1+ i))))
i))
(defun shr-max-columns (dom)
(let ((max 0))
(dolist (row (dom-children dom))
(when (and (not (stringp row))
(eq (dom-tag row) 'tr))
(setq max (max max (+ (shr-count row 'td)
(shr-count row 'th))))))
max))
(provide 'shr)
;;; shr.el ends here
^ permalink raw reply [flat|nested] 15+ messages in thread* bug#32281: shr.el align support patch
2018-07-26 14:06 bug#32281: shr.el align support patch Bad Blue Bull
@ 2018-08-06 2:52 ` Noam Postavsky
2018-08-06 15:13 ` Eli Zaretskii
2018-08-06 17:36 ` Noam Postavsky
1 sibling, 1 reply; 15+ messages in thread
From: Noam Postavsky @ 2018-08-06 2:52 UTC (permalink / raw)
To: Bad Blue Bull; +Cc: 32281
severity 32281 wishlist
tags 32281 + patch
quit
Bad Blue Bull <ibmbull@yandex.ru> writes:
> Here's a patch for shr.el that makes it handle "align" attribute for
> headers, paragraphs and lists, works only when monospace font is used
> (becoz of lame implementation of fill-paragraph). Also default value
> of shr-use-fonts set to nil so monospace fonts are used by default.
Seems reasonable overall, but I'm not sure if changing the default is
justified.
> -(defcustom shr-use-fonts t
> +(defcustom shr-use-fonts nil ; set default value to nil because monospace fonts are better for Emacs
Although I do somewhat agree with the "monospace fonts are better for
Emacs" sentiment.
> +(defun shr-fill-paragraph-with-breaks (&optional justify bre-del bre-regexp)
> + "Fill paragraph at or after point, breaking lines at positions matching regexp argument BRE-REGEXP.
> +If JUSTIFY is non-nil justify as well.
> +Delete matched text if BRE-DEL is non nil
> +BRE-REGEXP must be a regexp that determines positions where to break lines, default value is \\x2028."
> + (unless bre-regexp (setq bre-regexp "\x2028"))
> + (setq bre-regexp (concat bre-regexp "\\|\x2029"))
> + (save-excursion
> + (let ((line-begin) (paragraph-end))
> + (forward-paragraph)
> + (insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end of a paragraph
> + (backward-paragraph)
> + (setq line-begin (point))
> + (while (not paragraph-end)
> + (re-search-forward bre-regexp)
> + (if (equal (match-string 0) "\x2029") (setq paragraph-end t)) ; end of paragraph reached
> + (if (or bre-del paragraph-end) (replace-match ""))
> + (unless (equal (char-after) ?\n) (insert "\n")) ; I don't know why but two adjacent \n leave an empty line after fill
> + (fill-region-as-paragraph line-begin (- (point) 1) justify)
> + (setq line-begin (point)))
> + (delete-char -1)
> + )))
> +(defun shr-fill-paragraph (dom)
> + "Fill paragraph"
> + (when (not shr-use-fonts) ;fill-paragraph is useful only with monospace fonts
> + (shr-fill-paragraph-with-breaks
> + ((lambda (x)
> + (cond
> + ((equal x "right") 'right)
> + ((equal x "center") 'center)
> + ((equal x "left") 'left)
> + ))
> + (cdr (assq 'align (dom-attributes dom)))) ; justify parameter
> + t) ; bre-del t
> + )
> + )
> +
> (defun shr-tag-li (dom)
> @@ -1770,6 +1813,7 @@
> (put-text-property start (1+ start) 'shr-prefix-length (length bullet))
> (shr-generic dom))))
> (unless (bolp)
> + (unless shr-use-fonts (insert "\x2028")) ; insert a line separator
> (insert "\n")))
>
> (defun shr-mark-fill (start)
> @@ -1785,7 +1829,8 @@
> (or (not (bolp))
> (and (> (- (point) 2) (point-min))
> (not (= (char-after (- (point) 2)) ?\n)))))
> - (insert "\n"))
> + (unless shr-use-fonts (insert "\x2028")) ; insert a line separator
> + (insert "\n"))
> (shr-generic dom))
The indentation in your patch looks kind of off, are you not using
Emacs' builtin auto-indentation? (also, don't leave hanging parens.)
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-06 2:52 ` Noam Postavsky
@ 2018-08-06 15:13 ` Eli Zaretskii
2018-08-07 0:51 ` Bad Blue Bull
0 siblings, 1 reply; 15+ messages in thread
From: Eli Zaretskii @ 2018-08-06 15:13 UTC (permalink / raw)
To: Noam Postavsky; +Cc: ibmbull, 32281
> From: Noam Postavsky <npostavs@gmail.com>
> Date: Sun, 05 Aug 2018 22:52:35 -0400
> Cc: 32281@debbugs.gnu.org
>
> Bad Blue Bull <ibmbull@yandex.ru> writes:
>
> > Here's a patch for shr.el that makes it handle "align" attribute for
> > headers, paragraphs and lists, works only when monospace font is used
> > (becoz of lame implementation of fill-paragraph). Also default value
> > of shr-use-fonts set to nil so monospace fonts are used by default.
>
> Seems reasonable overall, but I'm not sure if changing the default is
> justified.
And I'm sure it isn't. Not only do we not change past defaults so
easily, I personally don't think I'd like such a change, or consider
it correct.
> > + "Fill paragraph at or after point, breaking lines at positions matching regexp argument BRE-REGEXP.
The first line of the doc string should not be longer than 78
characters, and should be a complete sentence.
> > +BRE-REGEXP must be a regexp that determines positions where to break lines, default value is \\x2028."
> > + (unless bre-regexp (setq bre-regexp "\x2028"))
> > + (setq bre-regexp (concat bre-regexp "\\|\x2029"))
> > + (save-excursion
> > + (let ((line-begin) (paragraph-end))
> > + (forward-paragraph)
> > + (insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end of a paragraph
Why did you decide to use u+2028 and u+2029 for these purposes? Emacs
doesn't yet support these characters as Unicode intended, so using
them might have unexpected effects, and might produce different effect
if we start supporting them in the future.
This needs a NEWS entry, I think.
Thanks.
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-06 15:13 ` Eli Zaretskii
@ 2018-08-07 0:51 ` Bad Blue Bull
2018-08-07 0:59 ` Bad Blue Bull
` (3 more replies)
0 siblings, 4 replies; 15+ messages in thread
From: Bad Blue Bull @ 2018-08-07 0:51 UTC (permalink / raw)
To: Eli Zaretskii, Noam Postavsky; +Cc: 32281@debbugs.gnu.org
[-- Attachment #1: Type: text/html, Size: 1407 bytes --]
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: shr.el.diff --]
[-- Type: text/x-diff; name="shr.el.diff", Size: 3166 bytes --]
--- shr-old.el 2018-07-21 03:37:08.299506430 +0300
+++ shr.el 2018-08-07 03:14:00.677563202 +0300
@@ -292,6 +292,52 @@
(when shr-warning
(message "%s" shr-warning))))
+(defun shr-fill-paragraph-with-breaks (&optional justify bre-del bre-regexp)
+ "Fill paragraph at or after point, breaking lines at positions
+matching regexp argument BRE-REGEXP.
+
+If JUSTIFY is non-nil justify as well.
+
+Delete matched text if BRE-DEL is non nil.
+
+BRE-REGEXP must be a regexp that determines positions where to
+break lines, default value is \\x2028."
+ (unless bre-regexp (setq bre-regexp "\x2028"))
+ (setq bre-regexp (concat bre-regexp "\\|\x2029"))
+ (save-excursion
+ (let ((line-begin) (paragraph-end))
+ (forward-paragraph)
+ (insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end
+ ; of a paragraph
+ (backward-paragraph)
+ (setq line-begin (point))
+ (while (not paragraph-end)
+ (re-search-forward bre-regexp)
+ (if (equal (match-string 0) "\x2029") (setq paragraph-end t))
+ ; end of paragraph reached
+ (if (or bre-del paragraph-end) (replace-match ""))
+ (unless (equal (char-after) ?\n) (insert "\n"))
+ ; I don't know why but two adjacent \n
+ ; leave an empty line after fill
+ (fill-region-as-paragraph line-begin (- (point) 1)
+ justify)
+ (setq line-begin (point)))
+ (delete-char -1))))
+
+(defun shr-fill-paragraph (dom)
+ "Fill paragraph"
+ (when (not shr-use-fonts) ;fill-paragraph is useful only with monospace
+ ;fonts
+ (shr-fill-paragraph-with-breaks
+ ((lambda (x)
+ (cond
+ ((equal x "right") 'right)
+ ((equal x "center") 'center)
+ ((equal x "left") 'left)))
+ (cdr (assq 'align (dom-attributes dom)))) ; justify
+ parameter t ; bre-del t
+ )))
+
(defun shr--remove-blank-lines-at-the-end (start end)
(save-restriction
(save-excursion
@@ -1191,6 +1237,7 @@
(defun shr-heading (dom &rest types)
(shr-ensure-paragraph)
(apply #'shr-fontize-dom dom types)
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-urlify (start url &optional title)
@@ -1354,6 +1401,7 @@
(defun shr-tag-p (dom)
(shr-ensure-paragraph)
(shr-generic dom)
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-div (dom)
@@ -1742,12 +1790,14 @@
;; paragraph.
(unless (bolp)
(insert "\n"))
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-ol (dom)
(shr-ensure-paragraph)
(let ((shr-list-mode 1))
(shr-generic dom))
+ (shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-li (dom)
@@ -1770,6 +1820,7 @@
(put-text-property start (1+ start) 'shr-prefix-length (length bullet))
(shr-generic dom))))
(unless (bolp)
+ (unless shr-use-fonts (insert "\x2028")) ; insert a line separator
(insert "\n")))
(defun shr-mark-fill (start)
@@ -1785,7 +1836,8 @@
(or (not (bolp))
(and (> (- (point) 2) (point-min))
(not (= (char-after (- (point) 2)) ?\n)))))
- (insert "\n"))
+ (unless shr-use-fonts (insert "\x2028")) ; insert a line separator
+ (insert "\n"))
(shr-generic dom))
(defun shr-tag-span (dom)
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: shr.el --]
[-- Type: text/x-lisp; name="shr.el", Size: 87035 bytes --]
;;; shr.el --- Simple HTML Renderer -*- lexical-binding: t -*-
;; Copyright (C) 2010-2018 Free Software Foundation, Inc.
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: html
;; This file is part of 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 3 of the License, 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. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package takes a HTML parse tree (as provided by
;; libxml-parse-html-region) and renders it in the current buffer. It
;; does not do CSS, JavaScript or anything advanced: It's geared
;; towards rendering typical short snippets of HTML, like what you'd
;; find in HTML email and the like.
;;; Code:
(require 'cl-lib)
(eval-when-compile (require 'url)) ;For url-filename's setf handler.
(require 'browse-url)
(eval-when-compile (require 'subr-x))
(require 'dom)
(require 'seq)
(require 'svg)
(require 'image)
(require 'puny)
(require 'text-property-search)
(defgroup shr nil
"Simple HTML Renderer"
:version "25.1"
:group 'web)
(defcustom shr-max-image-proportion 0.9
"How big pictures displayed are in relation to the window they're in.
A value of 0.7 means that they are allowed to take up 70% of the
width and height of the window. If they are larger than this,
and Emacs supports it, then the images will be rescaled down to
fit these criteria."
:version "24.1"
:group 'shr
:type 'float)
(defcustom shr-blocked-images nil
"Images that have URLs matching this regexp will be blocked."
:version "24.1"
:group 'shr
:type '(choice (const nil) regexp))
(defcustom shr-use-fonts t
"If non-nil, use proportional fonts for text."
:version "25.1"
:group 'shr
:type 'boolean)
(defcustom shr-use-colors t
"If non-nil, respect color specifications in the HTML."
:version "26.1"
:group 'shr
:type 'boolean)
(defcustom shr-table-horizontal-line nil
"Character used to draw horizontal table lines.
If nil, don't draw horizontal table lines."
:group 'shr
:type '(choice (const nil) character))
(defcustom shr-table-vertical-line ?\s
"Character used to draw vertical table lines."
:group 'shr
:type 'character)
(defcustom shr-table-corner ?\s
"Character used to draw table corners."
:group 'shr
:type 'character)
(defcustom shr-hr-line ?-
"Character used to draw hr lines."
:group 'shr
:type 'character)
(defcustom shr-width nil
"Frame width to use for rendering.
May either be an integer specifying a fixed width in characters,
or nil, meaning that the full width of the window should be used.
If `shr-use-fonts' is set, the mean character width is used to
compute the pixel width, which is used instead."
:version "25.1"
:type '(choice (integer :tag "Fixed width in characters")
(const :tag "Use the width of the window" nil))
:group 'shr)
(defcustom shr-bullet "* "
"Bullet used for unordered lists.
Alternative suggestions are:
- \" \"
- \" \""
:version "24.4"
:type 'string
:group 'shr)
(defcustom shr-external-browser 'browse-url-default-browser
"Function used to launch an external browser."
:version "24.4"
:group 'shr
:type 'function)
(defcustom shr-image-animate t
"Non nil means that images that can be animated will be."
:version "24.4"
:group 'shr
:type 'boolean)
(defvar shr-content-function nil
"If bound, this should be a function that will return the content.
This is used for cid: URLs, and the function is called with the
cid: URL as the argument.")
(defvar shr-put-image-function 'shr-put-image
"Function called to put image and alt string.")
(defface shr-strike-through '((t :strike-through t))
"Face for <s> elements."
:version "24.1"
:group 'shr)
(defface shr-link
'((t :inherit link))
"Face for link elements."
:version "24.1"
:group 'shr)
(defface shr-selected-link
'((t :inherit shr-link :background "red"))
"Face for link elements."
:version "27.1"
:group 'shr)
(defvar shr-inhibit-images nil
"If non-nil, inhibit loading images.")
(defvar shr-external-rendering-functions nil
"Alist of tag/function pairs used to alter how shr renders certain tags.
For instance, eww uses this to alter rendering of title, forms
and other things:
\((title . eww-tag-title)
(form . eww-tag-form)
...)")
;;; Internal variables.
(defvar shr-folding-mode nil)
(defvar shr-start nil)
(defvar shr-indentation 0)
(defvar shr-internal-width nil)
(defvar shr-list-mode nil)
(defvar shr-content-cache nil)
(defvar shr-kinsoku-shorten nil)
(defvar shr-table-depth 0)
(defvar shr-stylesheet nil)
(defvar shr-base nil)
(defvar shr-depth 0)
(defvar shr-warning nil)
(defvar shr-ignore-cache nil)
(defvar shr-target-id nil)
(defvar shr-table-separator-length 1)
(defvar shr-table-separator-pixel-width 0)
(defvar shr-table-id nil)
(defvar shr-current-font nil)
(defvar shr-internal-bullet nil)
(defvar shr-map
(let ((map (make-sparse-keymap)))
(define-key map "a" 'shr-show-alt-text)
(define-key map "i" 'shr-browse-image)
(define-key map "z" 'shr-zoom-image)
(define-key map [?\t] 'shr-next-link)
(define-key map [?\M-\t] 'shr-previous-link)
(define-key map [follow-link] 'mouse-face)
(define-key map [mouse-2] 'shr-browse-url)
(define-key map "I" 'shr-insert-image)
(define-key map "w" 'shr-maybe-probe-and-copy-url)
(define-key map "u" 'shr-maybe-probe-and-copy-url)
(define-key map "v" 'shr-browse-url)
(define-key map "O" 'shr-save-contents)
(define-key map "\r" 'shr-browse-url)
map))
(defvar shr-image-map
(let ((map (copy-keymap shr-map)))
(when (boundp 'image-map)
(set-keymap-parent map image-map))
map))
;; Public functions and commands.
(declare-function libxml-parse-html-region "xml.c"
(start end &optional base-url discard-comments))
(defun shr-render-buffer (buffer)
"Display the HTML rendering of the current buffer."
(interactive (list (current-buffer)))
(or (fboundp 'libxml-parse-html-region)
(error "This function requires Emacs to be compiled with libxml2"))
(pop-to-buffer "*html*")
(erase-buffer)
(shr-insert-document
(with-current-buffer buffer
(libxml-parse-html-region (point-min) (point-max))))
(goto-char (point-min)))
;;;###autoload
(defun shr-render-region (begin end &optional buffer)
"Display the HTML rendering of the region between BEGIN and END."
(interactive "r")
(unless (fboundp 'libxml-parse-html-region)
(error "This function requires Emacs to be compiled with libxml2"))
(with-current-buffer (or buffer (current-buffer))
(let ((dom (libxml-parse-html-region begin end)))
(delete-region begin end)
(goto-char begin)
(shr-insert-document dom))))
(defun shr--have-one-fringe-p ()
"Return non-nil if we know at least one of the fringes has non-zero width."
(and (fboundp 'fringe-columns)
(or (not (zerop (fringe-columns 'right)))
(not (zerop (fringe-columns 'left))))))
;;;###autoload
(defun shr-insert-document (dom)
"Render the parsed document DOM into the current buffer.
DOM should be a parse tree as generated by
`libxml-parse-html-region' or similar."
(setq shr-content-cache nil)
(let ((start (point))
(shr-start nil)
(shr-base nil)
(shr-depth 0)
(shr-table-id 0)
(shr-warning nil)
(shr-table-separator-pixel-width (shr-string-pixel-width "-"))
(shr-internal-bullet (cons shr-bullet
(shr-string-pixel-width shr-bullet)))
(shr-internal-width (or (and shr-width
(if (not shr-use-fonts)
shr-width
(* shr-width (frame-char-width))))
;; We need to adjust the available
;; width for when the user disables
;; the fringes, which will cause the
;; display engine usurp one column for
;; the continuation glyph.
(if (not shr-use-fonts)
(- (window-body-width) 1
(if (and (null shr-width)
(not (shr--have-one-fringe-p)))
0
1))
(- (window-body-width nil t)
(* 2 (frame-char-width))
(if (and (null shr-width)
(not (shr--have-one-fringe-p)))
(* (frame-char-width) 2)
0)
1))))
(max-specpdl-size max-specpdl-size)
bidi-display-reordering)
;; If the window was hscrolled for some reason, shr-fill-lines
;; below will misbehave, because it silently assumes that it
;; starts with a non-hscrolled window (vertical-motion will move
;; to a wrong place otherwise).
(set-window-hscroll nil 0)
(shr-descend dom)
(shr-fill-lines start (point))
(shr--remove-blank-lines-at-the-end start (point))
(when shr-warning
(message "%s" shr-warning))))
(defun shr-fill-paragraph-with-breaks (&optional justify bre-del bre-regexp)
"Fill paragraph at or after point, breaking lines at positions
matching regexp argument BRE-REGEXP.
If JUSTIFY is non-nil justify as well.
Delete matched text if BRE-DEL is non nil.
BRE-REGEXP must be a regexp that determines positions where to
break lines, default value is \\x2028."
(unless bre-regexp (setq bre-regexp "\x2028"))
(setq bre-regexp (concat bre-regexp "\\|\x2029"))
(save-excursion
(let ((line-begin) (paragraph-end))
(forward-paragraph)
(insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end
; of a paragraph
(backward-paragraph)
(setq line-begin (point))
(while (not paragraph-end)
(re-search-forward bre-regexp)
(if (equal (match-string 0) "\x2029") (setq paragraph-end t))
; end of paragraph reached
(if (or bre-del paragraph-end) (replace-match ""))
(unless (equal (char-after) ?\n) (insert "\n"))
; I don't know why but two adjacent \n
; leave an empty line after fill
(fill-region-as-paragraph line-begin (- (point) 1)
justify)
(setq line-begin (point)))
(delete-char -1))))
(defun shr-fill-paragraph (dom)
"Fill paragraph"
(when (not shr-use-fonts) ;fill-paragraph is useful only with monospace
;fonts
(shr-fill-paragraph-with-breaks
((lambda (x)
(cond
((equal x "right") 'right)
((equal x "center") 'center)
((equal x "left") 'left)))
(cdr (assq 'align (dom-attributes dom)))) ; justify
parameter t ; bre-del t
)))
(defun shr--remove-blank-lines-at-the-end (start end)
(save-restriction
(save-excursion
(narrow-to-region start end)
(goto-char end)
(when (and (re-search-backward "[^ \n]" nil t)
(not (eobp)))
(forward-line 1)
(delete-region (point) (point-max))))))
(defun shr-url-at-point (image-url)
"Return the URL under point as a string.
If IMAGE-URL is non-nil, or there is no link under point, but
there is an image under point then copy the URL of the image
under point instead."
(if image-url
(get-text-property (point) 'image-url)
(or (get-text-property (point) 'shr-url)
(get-text-property (point) 'image-url))))
(defun shr-copy-url (url)
"Copy the URL under point to the kill ring.
If IMAGE-URL (the prefix) is non-nil, or there is no link under
point, but there is an image under point then copy the URL of the
image under point instead."
(interactive (list (shr-url-at-point current-prefix-arg)))
(if (not url)
(message "No URL under point")
(setq url (url-encode-url url))
(kill-new url)
(message "Copied %s" url)))
(defun shr-probe-url (url cont)
"Pass URL's redirect destination to CONT, if it has one.
CONT should be a function of one argument, the redirect
destination URL. If URL is not redirected, then CONT is never
called."
(interactive "P")
(url-retrieve
url (lambda (a)
(pcase a
(`(:redirect ,destination . ,_)
;; Remove common tracking junk from the URL.
(funcall cont (replace-regexp-in-string
".utm_.*" "" destination)))))
nil t))
(defun shr-probe-and-copy-url (url)
"Copy the URL under point to the kill ring.
Like `shr-copy-url', but additionally fetch URL and use its
redirection destination if it has one."
(interactive (list (shr-url-at-point current-prefix-arg)))
(if url (shr-probe-url url #'shr-copy-url)
(shr-copy-url url)))
(defun shr-maybe-probe-and-copy-url (url)
"Copy the URL under point to the kill ring.
If the URL is already at the front of the kill ring act like
`shr-probe-and-copy-url', otherwise like `shr-copy-url'."
(interactive (list (shr-url-at-point current-prefix-arg)))
(if (equal url (car kill-ring))
(shr-probe-and-copy-url url)
(shr-copy-url url)))
(defun shr--current-link-region ()
(let ((current (get-text-property (point) 'shr-url))
start)
(save-excursion
;; Go to the beginning.
(while (and (not (bobp))
(equal (get-text-property (point) 'shr-url) current))
(forward-char -1))
(unless (equal (get-text-property (point) 'shr-url) current)
(forward-char 1))
(setq start (point))
;; Go to the end.
(while (and (not (eobp))
(equal (get-text-property (point) 'shr-url) current))
(forward-char 1))
(list start (point)))))
(defun shr--blink-link ()
(let* ((region (shr--current-link-region))
(overlay (make-overlay (car region) (cadr region))))
(overlay-put overlay 'face 'shr-selected-link)
(run-at-time 1 nil (lambda ()
(delete-overlay overlay)))))
(defun shr-next-link ()
"Skip to the next link."
(interactive)
(let ((match (text-property-search-forward 'shr-url nil nil t)))
(if (not match)
(message "No next link")
(goto-char (prop-match-beginning match))
(message "%s" (get-text-property (point) 'help-echo)))))
(defun shr-previous-link ()
"Skip to the previous link."
(interactive)
(if (not (text-property-search-backward 'shr-url nil nil t))
(message "No previous link")
(message "%s" (get-text-property (point) 'help-echo))))
(defun shr-show-alt-text ()
"Show the ALT text of the image under point."
(interactive)
(let ((text (get-text-property (point) 'shr-alt)))
(if (not text)
(message "No image under point")
(message "%s" (shr-fill-text text)))))
(defun shr-browse-image (&optional copy-url)
"Browse the image under point.
If COPY-URL (the prefix if called interactively) is non-nil, copy
the URL of the image to the kill buffer instead."
(interactive "P")
(let ((url (get-text-property (point) 'image-url)))
(cond
((not url)
(message "No image under point"))
(copy-url
(with-temp-buffer
(insert url)
(copy-region-as-kill (point-min) (point-max))
(message "Copied %s" url)))
(t
(message "Browsing %s..." url)
(browse-url url)))))
(defun shr-insert-image ()
"Insert the image under point into the buffer."
(interactive)
(let ((url (get-text-property (point) 'image-url)))
(if (not url)
(message "No image under point")
(message "Inserting %s..." url)
(url-retrieve url 'shr-image-fetched
(list (current-buffer) (1- (point)) (point-marker))
t t))))
(defun shr-zoom-image ()
"Toggle the image size.
The size will be rotated between the default size, the original
size, and full-buffer size."
(interactive)
(let ((url (get-text-property (point) 'image-url))
(size (get-text-property (point) 'image-size))
(buffer-read-only nil))
(if (not url)
(message "No image under point")
;; Delete the old picture.
(while (get-text-property (point) 'image-url)
(forward-char -1))
(forward-char 1)
(let ((start (point)))
(while (get-text-property (point) 'image-url)
(forward-char 1))
(forward-char -1)
(put-text-property start (point) 'display nil)
(when (> (- (point) start) 2)
(delete-region start (1- (point)))))
(message "Inserting %s..." url)
(url-retrieve url 'shr-image-fetched
(list (current-buffer) (1- (point)) (point-marker)
(list (cons 'size
(cond ((or (eq size 'default)
(null size))
'original)
((eq size 'original)
'full)
((eq size 'full)
'default)))))
t))))
;;; Utility functions.
(defsubst shr-generic (dom)
(dolist (sub (dom-children dom))
(if (stringp sub)
(shr-insert sub)
(shr-descend sub))))
(defun shr-indirect-call (tag-name dom &rest args)
(let ((function (intern (concat "shr-tag-" (symbol-name tag-name)) obarray))
;; Allow other packages to override (or provide) rendering
;; of elements.
(external (cdr (assq tag-name shr-external-rendering-functions))))
(cond (external
(apply external dom args))
((fboundp function)
(apply function dom args))
(t
(apply 'shr-generic dom args)))))
(defun shr-descend (dom)
(let ((function
(intern (concat "shr-tag-" (symbol-name (dom-tag dom))) obarray))
;; Allow other packages to override (or provide) rendering
;; of elements.
(external (cdr (assq (dom-tag dom) shr-external-rendering-functions)))
(style (dom-attr dom 'style))
(shr-stylesheet shr-stylesheet)
(shr-depth (1+ shr-depth))
(start (point)))
;; shr uses many frames per nested node.
(if (and (> shr-depth (/ max-specpdl-size 15))
(not (and (y-or-n-p "Too deeply nested to render properly; increase `max-specpdl-size'?")
(setq max-specpdl-size (* max-specpdl-size 2)))))
(setq shr-warning
"Not rendering the complete page because of too-deep nesting")
(when style
(if (string-match "color\\|display\\|border-collapse" style)
(setq shr-stylesheet (nconc (shr-parse-style style)
shr-stylesheet))
(setq style nil)))
;; If we have a display:none, then just ignore this part of the DOM.
(unless (equal (cdr (assq 'display shr-stylesheet)) "none")
;; We don't use shr-indirect-call here, since shr-descend is
;; the central bit of shr.el, and should be as fast as
;; possible. Having one more level of indirection with its
;; negative effect on performance is deemed unjustified in
;; this case.
(cond (external
(funcall external dom))
((fboundp function)
(funcall function dom))
(t
(shr-generic dom)))
(when (and shr-target-id
(equal (dom-attr dom 'id) shr-target-id))
;; If the element was empty, we don't have anything to put the
;; anchor on. So just insert a dummy character.
(when (= start (point))
(insert "*"))
(put-text-property start (1+ start) 'shr-target-id shr-target-id))
;; If style is set, then this node has set the color.
(when style
(shr-colorize-region
start (point)
(cdr (assq 'color shr-stylesheet))
(cdr (assq 'background-color shr-stylesheet))))))))
(defun shr-fill-text (text)
(if (zerop (length text))
text
(with-temp-buffer
(let ((shr-indentation 0)
(shr-start nil)
(shr-internal-width (- (window-body-width nil t)
(* 2 (frame-char-width))
;; Adjust the window width for when
;; the user disables the fringes,
;; which causes the display engine
;; to usurp one column for the
;; continuation glyph.
(if (and (null shr-width)
(not (shr--have-one-fringe-p)))
(* (frame-char-width) 2)
0))))
(shr-insert text)
(shr-fill-lines (point-min) (point-max))
(buffer-string)))))
(define-inline shr-char-breakable-p (char)
"Return non-nil if a line can be broken before and after CHAR."
(inline-quote (aref fill-find-break-point-function-table ,char)))
(define-inline shr-char-nospace-p (char)
"Return non-nil if no space is required before and after CHAR."
(inline-quote (aref fill-nospace-between-words-table ,char)))
;; KINSOKU is a Japanese word meaning a rule that should not be violated.
;; In Emacs, it is a term used for characters, e.g. punctuation marks,
;; parentheses, and so on, that should not be placed in the beginning
;; of a line or the end of a line.
(define-inline shr-char-kinsoku-bol-p (char)
"Return non-nil if a line ought not to begin with CHAR."
(inline-letevals (char)
(inline-quote (and (not (eq ,char ?'))
(aref (char-category-set ,char) ?>)))))
(define-inline shr-char-kinsoku-eol-p (char)
"Return non-nil if a line ought not to end with CHAR."
(inline-quote (aref (char-category-set ,char) ?<)))
(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
(load "kinsoku" nil t))
(defun shr-pixel-column ()
(if (not shr-use-fonts)
(current-column)
(if (not (get-buffer-window (current-buffer)))
(save-window-excursion
;; Avoid errors if the selected window is a dedicated one,
;; and they just want to insert a document into it.
(set-window-dedicated-p nil nil)
(set-window-buffer nil (current-buffer))
(car (window-text-pixel-size nil (line-beginning-position) (point))))
(car (window-text-pixel-size nil (line-beginning-position) (point))))))
(defun shr-pixel-region ()
(- (shr-pixel-column)
(save-excursion
(goto-char (mark))
(shr-pixel-column))))
(defun shr-string-pixel-width (string)
(if (not shr-use-fonts)
(length string)
;; Save and restore point across with-temp-buffer, since
;; shr-pixel-column uses save-window-excursion, which can reset
;; point to 1.
(let ((pt (point)))
(prog1
(with-temp-buffer
(insert string)
(shr-pixel-column))
(goto-char pt)))))
(defsubst shr--translate-insertion-chars ()
;; Remove soft hyphens.
(goto-char (point-min))
(while (search-forward "" nil t)
(replace-match "" t t))
;; Translate non-breaking spaces into real spaces.
(goto-char (point-min))
(while (search-forward " " nil t)
(replace-match " " t t)))
(defun shr-insert (text)
(when (and (not (bolp))
(get-text-property (1- (point)) 'image-url))
(insert "\n"))
(cond
((eq shr-folding-mode 'none)
(let ((start (point)))
(insert text)
(save-restriction
(narrow-to-region start (point))
(shr--translate-insertion-chars)
(goto-char (point-max)))))
(t
(let ((font-start (point)))
(when (and (string-match "\\`[ \t\n\r]" text)
(not (bolp))
(not (eq (char-after (1- (point))) ? )))
(insert " "))
(let ((start (point))
(bolp (bolp)))
(insert text)
(save-restriction
(narrow-to-region start (point))
(goto-char start)
(when (looking-at "[ \t\n\r]+")
(replace-match "" t t))
(while (re-search-forward "[ \t\n\r]+" nil t)
(replace-match " " t t))
(shr--translate-insertion-chars)
(goto-char (point-max)))
;; We may have removed everything we inserted if it was just
;; spaces.
(unless (= font-start (point))
;; Mark all lines that should possibly be folded afterwards.
(when bolp
(shr-mark-fill start))
(when shr-use-fonts
(put-text-property font-start (point)
'face
(or shr-current-font 'variable-pitch)))))))))
(defun shr-fill-lines (start end)
(if (<= shr-internal-width 0)
nil
(save-restriction
(narrow-to-region start end)
(goto-char start)
(when (get-text-property (point) 'shr-indentation)
(shr-fill-line))
(while (setq start (next-single-property-change start 'shr-indentation))
(goto-char start)
(when (bolp)
(shr-fill-line)))
(goto-char (point-max)))))
(defun shr-vertical-motion (column)
(if (not shr-use-fonts)
(move-to-column column)
(unless (eolp)
(forward-char 1))
(vertical-motion (cons (/ column (frame-char-width)) 0))
(unless (eolp)
(forward-char 1))))
(defun shr-fill-line ()
(let ((shr-indentation (get-text-property (point) 'shr-indentation))
(continuation (get-text-property
(point) 'shr-continuation-indentation))
start)
(put-text-property (point) (1+ (point)) 'shr-indentation nil)
(let ((face (get-text-property (point) 'face))
(background-start (point)))
(shr-indent)
(when face
(put-text-property background-start (point) 'face
`,(shr-face-background face))))
(setq start (point))
(setq shr-indentation (or continuation shr-indentation))
;; If we have an indentation that's wider than the width we're
;; trying to fill to, then just give up and don't do any filling.
(when (< shr-indentation shr-internal-width)
(shr-vertical-motion shr-internal-width)
(when (looking-at " $")
(delete-region (point) (line-end-position)))
(while (not (eolp))
;; We have to do some folding. First find the first
;; previous point suitable for folding.
(if (or (not (shr-find-fill-point (line-beginning-position)))
(= (point) start))
;; We had unbreakable text (for this width), so just go to
;; the first space and carry on.
(progn
(beginning-of-line)
(skip-chars-forward " ")
(search-forward " " (line-end-position) 'move)))
;; Success; continue.
(when (= (preceding-char) ?\s)
(delete-char -1))
(let ((gap-start (point)))
(insert "\n")
(shr-indent)
(when (and (> (1- gap-start) (point-min))
;; The link on both sides of the newline are the
;; same...
(equal (get-text-property (point) 'shr-url)
(get-text-property (1- gap-start) 'shr-url)))
;; ... so we join the two bits into one link logically, but
;; not visually. This makes navigation between links work
;; well, but avoids underscores before the link on the next
;; line when indented.
(let ((props (copy-sequence (text-properties-at (point)))))
;; We don't want to use the faces on the indentation, because
;; that's ugly.
(setq props (plist-put props 'face nil))
(add-text-properties gap-start (point) props))))
(setq start (point))
(shr-vertical-motion shr-internal-width)
(when (looking-at " $")
(delete-region (point) (line-end-position)))))))
(defun shr-find-fill-point (start)
(let ((bp (point))
(end (point))
failed)
(while (not (or (setq failed (<= (point) start))
(eq (preceding-char) ? )
(eq (following-char) ? )
(shr-char-breakable-p (preceding-char))
(shr-char-breakable-p (following-char))
(and (shr-char-kinsoku-bol-p (preceding-char))
(shr-char-breakable-p (following-char))
(not (shr-char-kinsoku-bol-p (following-char))))
(shr-char-kinsoku-eol-p (following-char))
(bolp)))
(backward-char 1))
(if failed
;; There's no breakable point, so we give it up.
(let (found)
(goto-char bp)
;; Don't overflow the window edge, even if
;; shr-kinsoku-shorten is nil.
(unless (or shr-kinsoku-shorten (null shr-width))
(while (setq found (re-search-forward
"\\(\\c>\\)\\| \\|\\c<\\|\\c|"
(line-end-position) 'move)))
(if (and found
(not (match-beginning 1)))
(goto-char (match-beginning 0)))))
(or
(eolp)
;; Don't put kinsoku-bol characters at the beginning of a line,
;; or kinsoku-eol characters at the end of a line.
(cond
;; Don't overflow the window edge, even if shr-kinsoku-shorten
;; is nil.
((or shr-kinsoku-shorten (null shr-width))
(while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
(or (shr-char-kinsoku-eol-p (preceding-char))
(shr-char-kinsoku-bol-p (following-char))))
(backward-char 1))
(when (setq failed (<= (point) start))
;; There's no breakable point that doesn't violate kinsoku,
;; so we look for the second best position.
(while (and (progn
(forward-char 1)
(<= (point) end))
(progn
(setq bp (point))
(shr-char-kinsoku-eol-p (following-char)))))
(goto-char bp)))
((shr-char-kinsoku-eol-p (preceding-char))
;; Find backward the point where kinsoku-eol characters begin.
(let ((count 4))
(while
(progn
(backward-char 1)
(and (> (setq count (1- count)) 0)
(not (memq (preceding-char) (list ?\C-@ ?\n ? )))
(or (shr-char-kinsoku-eol-p (preceding-char))
(shr-char-kinsoku-bol-p (following-char)))))))
(when (setq failed (<= (point) start))
;; There's no breakable point that doesn't violate kinsoku,
;; so we go to the second best position.
(if (looking-at "\\(\\c<+\\)\\c<")
(goto-char (match-end 1))
(forward-char 1))))
((shr-char-kinsoku-bol-p (following-char))
;; Find forward the point where kinsoku-bol characters end.
(let ((count 4))
(while (progn
(forward-char 1)
(and (>= (setq count (1- count)) 0)
(shr-char-kinsoku-bol-p (following-char))
(shr-char-breakable-p (following-char))))))))
(when (eq (following-char) ? )
(forward-char 1))))
(not failed)))
(defun shr-parse-base (url)
;; Always chop off anchors.
(when (string-match "#.*" url)
(setq url (substring url 0 (match-beginning 0))))
;; NB: <base href="" > URI may itself be relative to the document s URI
(setq url (shr-expand-url url))
(let* ((parsed (url-generic-parse-url url))
(local (url-filename parsed)))
(setf (url-filename parsed) "")
;; Chop off the bit after the last slash.
(when (string-match "\\`\\(.*/\\)[^/]+\\'" local)
(setq local (match-string 1 local)))
;; Always make the local bit end with a slash.
(when (and (not (zerop (length local)))
(not (eq (aref local (1- (length local))) ?/)))
(setq local (concat local "/")))
(list (url-recreate-url parsed)
local
(url-type parsed)
url)))
(autoload 'url-expand-file-name "url-expand")
;; FIXME This needs some tests writing.
;; Does it even need to exist, given that url-expand-file-name does?
(defun shr-expand-url (url &optional base)
(setq base
(if base
;; shr-parse-base should never call this with non-nil base!
(shr-parse-base base)
;; Bound by the parser.
shr-base))
(when (zerop (length url))
(setq url nil))
;; Strip leading whitespace
(and url (string-match "\\`\\s-+" url)
(setq url (substring url (match-end 0))))
(cond ((zerop (length url))
(nth 3 base))
((or (not base)
(string-match "\\`[a-z]*:" url))
;; Absolute or empty URI
url)
((eq (aref url 0) ?/)
(if (and (> (length url) 1)
(eq (aref url 1) ?/))
;; //host...; just use the protocol
(concat (nth 2 base) ":" url)
;; Just use the host name part.
(concat (car base) url)))
((eq (aref url 0) ?#)
;; A link to an anchor.
(concat (nth 3 base) url))
(t
;; Totally relative.
(url-expand-file-name url (concat (car base) (cadr base))))))
(defun shr-ensure-newline ()
(unless (bobp)
(let ((prefix (get-text-property (line-beginning-position)
'shr-prefix-length)))
(unless (or (zerop (current-column))
(and prefix
(= prefix (- (point) (line-beginning-position)))))
(insert "\n")))))
(defun shr-ensure-paragraph ()
(unless (bobp)
(let ((prefix (get-text-property (line-beginning-position)
'shr-prefix-length)))
(cond
((and (bolp)
(save-excursion
(forward-line -1)
(looking-at " *$")))
;; We're already at a new paragraph; do nothing.
)
((and prefix
(= prefix (- (point) (line-beginning-position))))
;; Do nothing; we're at the start of a <li>.
)
((save-excursion
(beginning-of-line)
;; If the current line is totally blank, and doesn't even
;; have any face properties set, then delete the blank
;; space.
(and (looking-at " *$")
(not (get-text-property (point) 'face))
(not (= (next-single-property-change (point) 'face nil
(line-end-position))
(line-end-position)))))
(delete-region (match-beginning 0) (match-end 0)))
;; We have a single blank line.
((and (eolp) (bolp))
(insert "\n"))
;; Insert new paragraph.
(t
(insert "\n\n"))))))
(defun shr-indent ()
(when (> shr-indentation 0)
(insert
(if (not shr-use-fonts)
(make-string shr-indentation ?\s)
(propertize " "
'display
`(space :width (,shr-indentation)))))))
(defun shr-fontize-dom (dom &rest types)
(let ((start (point)))
(shr-generic dom)
(dolist (type types)
(shr-add-font start (point) type))))
;; Add face to the region, but avoid putting the font properties on
;; blank text at the start of the line, and the newline at the end, to
;; avoid ugliness.
(defun shr-add-font (start end type)
(save-excursion
(goto-char start)
(while (< (point) end)
(when (bolp)
(skip-chars-forward " "))
(add-face-text-property (point) (min (line-end-position) end) type t)
(if (< (line-end-position) end)
(forward-line 1)
(goto-char end)))))
(defun shr-mouse-browse-url (ev)
"Browse the URL under the mouse cursor."
(interactive "e")
(mouse-set-point ev)
(shr-browse-url))
(defun shr-browse-url (&optional external mouse-event)
"Browse the URL at point using `browse-url'.
If EXTERNAL is non-nil (interactively, the prefix argument), browse
the URL using `shr-external-browser'.
If this function is invoked by a mouse click, it will browse the URL
at the position of the click. Optional argument MOUSE-EVENT describes
the mouse click event."
(interactive (list current-prefix-arg last-nonmenu-event))
(mouse-set-point mouse-event)
(let ((url (get-text-property (point) 'shr-url)))
(cond
((not url)
(message "No link under point"))
((string-match "^mailto:" url)
(browse-url-mail url))
(t
(if external
(progn
(funcall shr-external-browser url)
(shr--blink-link))
(browse-url url))))))
(defun shr-save-contents (directory)
"Save the contents from URL in a file."
(interactive "DSave contents of URL to directory: ")
(let ((url (get-text-property (point) 'shr-url)))
(if (not url)
(message "No link under point")
(url-retrieve (shr-encode-url url)
'shr-store-contents (list url directory)
nil t))))
(defun shr-store-contents (status url directory)
(unless (plist-get status :error)
(when (or (search-forward "\n\n" nil t)
(search-forward "\r\n\r\n" nil t))
(write-region (point) (point-max)
(expand-file-name (file-name-nondirectory url)
directory)))))
(defun shr-image-fetched (status buffer start end &optional flags)
(let ((image-buffer (current-buffer)))
(when (and (buffer-name buffer)
(not (plist-get status :error)))
(url-store-in-cache image-buffer)
(goto-char (point-min))
(when (or (search-forward "\n\n" nil t)
(search-forward "\r\n\r\n" nil t))
(let ((data (shr-parse-image-data)))
(with-current-buffer buffer
(save-excursion
(save-restriction
(widen)
(let ((alt (buffer-substring start end))
(properties (text-properties-at start))
(inhibit-read-only t))
(delete-region start end)
(goto-char start)
(funcall shr-put-image-function data alt flags)
(while properties
(let ((type (pop properties))
(value (pop properties)))
(unless (memq type '(display image-size))
(put-text-property start (point) type value)))))))))))
(kill-buffer image-buffer)))
(defun shr-image-from-data (data)
"Return an image from the data: URI content DATA."
(when (string-match
"\\(\\([^/;,]+\\(/[^;,]+\\)?\\)\\(;[^;,]+\\)*\\)?,\\(.*\\)"
data)
(let ((param (match-string 4 data))
(payload (url-unhex-string (match-string 5 data))))
(when (and param
(string-match "^.*\\(;[ \t]*base64\\)$" param))
(setq payload (ignore-errors
(base64-decode-string payload))))
payload)))
;; Behind display-graphic-p test.
(declare-function image-size "image.c" (spec &optional pixels frame))
(declare-function image-animate "image" (image &optional index limit))
(defun shr-put-image (spec alt &optional flags)
"Insert image SPEC with a string ALT. Return image.
SPEC is either an image data blob, or a list where the first
element is the data blob and the second element is the content-type."
(if (display-graphic-p)
(let* ((size (cdr (assq 'size flags)))
(data (if (consp spec)
(car spec)
spec))
(content-type (and (consp spec)
(cadr spec)))
(start (point))
(image (cond
((eq size 'original)
(create-image data nil t :ascent 100
:format content-type))
((eq content-type 'image/svg+xml)
(create-image data 'svg t :ascent 100))
((eq size 'full)
(ignore-errors
(shr-rescale-image data content-type
(plist-get flags :width)
(plist-get flags :height))))
(t
(ignore-errors
(shr-rescale-image data content-type
(plist-get flags :width)
(plist-get flags :height)))))))
(when image
;; When inserting big-ish pictures, put them at the
;; beginning of the line.
(when (and (> (current-column) 0)
(> (car (image-size image t)) 400))
(insert "\n"))
(if (eq size 'original)
(insert-sliced-image image (or alt "*") nil 20 1)
(insert-image image (or alt "*")))
(put-text-property start (point) 'image-size size)
(when (and shr-image-animate
(cond ((fboundp 'image-multi-frame-p)
;; Only animate multi-frame things that specify a
;; delay; eg animated gifs as opposed to
;; multi-page tiffs. FIXME?
(cdr (image-multi-frame-p image)))
((fboundp 'image-animated-p)
(image-animated-p image))))
(image-animate image nil 60)))
image)
(insert (or alt ""))))
(defun shr-rescale-image (data content-type width height
&optional max-width max-height)
"Rescale DATA, if too big, to fit the current buffer.
WIDTH and HEIGHT are the sizes given in the HTML data, if any.
The size of the displayed image will not exceed
MAX-WIDTH/MAX-HEIGHT. If not given, use the current window
width/height instead."
(if (or (not (fboundp 'imagemagick-types))
(not (get-buffer-window (current-buffer))))
(create-image data nil t :ascent 100)
(let* ((edges (window-inside-pixel-edges
(get-buffer-window (current-buffer))))
(max-width (truncate (* shr-max-image-proportion
(or max-width
(- (nth 2 edges) (nth 0 edges))))))
(max-height (truncate (* shr-max-image-proportion
(or max-height
(- (nth 3 edges) (nth 1 edges))))))
(scaling (image-compute-scaling-factor image-scaling-factor)))
(when (or (and width
(> width max-width))
(and height
(> height max-height)))
(setq width nil
height nil))
(if (and width height
(< (* width scaling) max-width)
(< (* height scaling) max-height))
(create-image
data 'imagemagick t
:ascent 100
:width width
:height height
:format content-type)
(create-image
data 'imagemagick t
:ascent 100
:max-width max-width
:max-height max-height
:format content-type)))))
;; url-cache-extract autoloads url-cache.
(declare-function url-cache-create-filename "url-cache" (url))
(autoload 'mm-disable-multibyte "mm-util")
(autoload 'browse-url-mail "browse-url")
(defun shr-get-image-data (url)
"Get image data for URL.
Return a string with image data."
(with-temp-buffer
(mm-disable-multibyte)
(when (ignore-errors
(url-cache-extract (url-cache-create-filename (shr-encode-url url)))
t)
(when (re-search-forward "\r?\n\r?\n" nil t)
(shr-parse-image-data)))))
(declare-function libxml-parse-xml-region "xml.c"
(start end &optional base-url discard-comments))
(defun shr-parse-image-data ()
(let ((data (buffer-substring (point) (point-max)))
(content-type
(save-excursion
(save-restriction
(narrow-to-region (point-min) (point))
(let ((content-type (mail-fetch-field "content-type")))
(and content-type
;; Remove any comments in the type string.
(intern (replace-regexp-in-string ";.*" "" content-type)
obarray)))))))
;; SVG images may contain references to further images that we may
;; want to block. So special-case these by parsing the XML data
;; and remove anything that looks like a blocked bit.
(when (and shr-blocked-images
(eq content-type 'image/svg+xml))
(setq data
;; Note that libxml2 doesn't parse everything perfectly,
;; so glitches may occur during this transformation.
(shr-dom-to-xml
(libxml-parse-xml-region (point) (point-max)))))
(list data content-type)))
(defun shr-image-displayer (content-function)
"Return a function to display an image.
CONTENT-FUNCTION is a function to retrieve an image for a cid url that
is an argument. The function to be returned takes three arguments URL,
START, and END. Note that START and END should be markers."
`(lambda (url start end)
(when url
(if (string-match "\\`cid:" url)
,(when content-function
`(let ((image (funcall ,content-function
(substring url (match-end 0)))))
(when image
(goto-char start)
(funcall shr-put-image-function
image (buffer-substring start end))
(delete-region (point) end))))
(url-retrieve url 'shr-image-fetched
(list (current-buffer) start end)
t t)))))
(defun shr-heading (dom &rest types)
(shr-ensure-paragraph)
(apply #'shr-fontize-dom dom types)
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-urlify (start url &optional title)
(shr-add-font start (point) 'shr-link)
(add-text-properties
start (point)
(list 'shr-url url
'help-echo (let ((parsed (url-generic-parse-url
(or (ignore-errors
(decode-coding-string
(url-unhex-string url)
'utf-8 t))
url)))
iri)
;; If we have an IDNA domain, then show the
;; decoded version in the mouseover to let the
;; user know that there's something possibly
;; fishy.
(when (url-host parsed)
(setf (url-host parsed)
(puny-encode-domain (url-host parsed))))
(setq iri (url-recreate-url parsed))
(if title
(format "%s (%s)" iri title)
iri))
'follow-link t
'mouse-face 'highlight))
;; Don't overwrite any keymaps that are already in the buffer (i.e.,
;; image keymaps).
(while (and start
(< start (point)))
(let ((next (next-single-property-change start 'keymap nil (point))))
(if (get-text-property start 'keymap)
(setq start next)
(put-text-property start (or next (point)) 'keymap shr-map)))))
(defun shr-encode-url (url)
"Encode URL."
(browse-url-url-encode-chars url "[)$ ]"))
(autoload 'shr-color-visible "shr-color")
(autoload 'shr-color->hexadecimal "shr-color")
(defun shr-color-check (fg bg)
"Check that FG is visible on BG.
Returns (fg bg) with corrected values.
Returns nil if the colors that would be used are the default
ones, in case fg and bg are nil."
(when (or fg bg)
(let ((fixed (cond ((null fg) 'fg)
((null bg) 'bg))))
;; Convert colors to hexadecimal, or set them to default.
(let ((fg (or (shr-color->hexadecimal fg)
(frame-parameter nil 'foreground-color)))
(bg (or (shr-color->hexadecimal bg)
(frame-parameter nil 'background-color))))
(cond ((eq fixed 'bg)
;; Only return the new fg
(list nil (cadr (shr-color-visible bg fg t))))
((eq fixed 'fg)
;; Invert args and results and return only the new bg
(list (cadr (shr-color-visible fg bg t)) nil))
(t
(shr-color-visible bg fg)))))))
(defun shr-colorize-region (start end fg &optional bg)
(when (and shr-use-colors
(or fg bg)
(>= (display-color-cells) 88))
(let ((new-colors (shr-color-check fg bg)))
(when new-colors
(when fg
(add-face-text-property start end
(list :foreground (cadr new-colors))
t))
(when bg
(add-face-text-property start end
(list :background (car new-colors))
t)))
new-colors)))
;;; Tag-specific rendering rules.
(defun shr-tag-html (dom)
(let ((dir (dom-attr dom 'dir)))
(cond
((equal dir "ltr")
(setq bidi-paragraph-direction 'left-to-right))
((equal dir "rtl")
(setq bidi-paragraph-direction 'right-to-left))
((equal dir "auto")
(setq bidi-paragraph-direction nil))))
(shr-generic dom))
(defun shr-tag-body (dom)
(let* ((start (point))
(fgcolor (or (dom-attr dom 'fgcolor) (dom-attr dom 'text)))
(bgcolor (dom-attr dom 'bgcolor))
(shr-stylesheet (list (cons 'color fgcolor)
(cons 'background-color bgcolor))))
(shr-generic dom)
(shr-colorize-region start (point) fgcolor bgcolor)))
(defun shr-tag-style (_dom)
)
(defun shr-tag-script (_dom)
)
(defun shr-tag-comment (_dom)
)
(defun shr-dom-to-xml (dom)
(with-temp-buffer
(shr-dom-print dom)
(buffer-string)))
(defun shr-dom-print (dom)
"Convert DOM into a string containing the xml representation."
(insert (format "<%s" (dom-tag dom)))
(dolist (attr (dom-attributes dom))
;; Ignore attributes that start with a colon because they are
;; private elements.
(unless (= (aref (format "%s" (car attr)) 0) ?:)
(insert (format " %s=\"%s\"" (car attr) (cdr attr)))))
(insert ">")
(let (url)
(dolist (elem (dom-children dom))
(cond
((stringp elem)
(insert elem))
((eq (dom-tag elem) 'comment)
)
((or (not (eq (dom-tag elem) 'image))
;; Filter out blocked elements inside the SVG image.
(not (setq url (dom-attr elem ':xlink:href)))
(not shr-blocked-images)
(not (string-match shr-blocked-images url)))
(insert " ")
(shr-dom-print elem)))))
(insert (format "</%s>" (dom-tag dom))))
(defun shr-tag-svg (dom)
(when (and (image-type-available-p 'svg)
(not shr-inhibit-images)
(dom-attr dom 'width)
(dom-attr dom 'height))
(funcall shr-put-image-function (list (shr-dom-to-xml dom) 'image/svg+xml)
"SVG Image")))
(defun shr-tag-sup (dom)
(let ((start (point)))
(shr-generic dom)
(put-text-property start (point) 'display '(raise 0.5))))
(defun shr-tag-sub (dom)
(let ((start (point)))
(shr-generic dom)
(put-text-property start (point) 'display '(raise -0.5))))
(defun shr-tag-p (dom)
(shr-ensure-paragraph)
(shr-generic dom)
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-div (dom)
(let ((display (cdr (assq 'display shr-stylesheet))))
(if (or (equal display "inline")
(equal display "inline-block"))
(shr-generic dom)
(shr-ensure-newline)
(shr-generic dom)
(shr-ensure-newline))))
(defun shr-tag-s (dom)
(shr-fontize-dom dom 'shr-strike-through))
(defun shr-tag-b (dom)
(shr-fontize-dom dom 'bold))
(defun shr-tag-i (dom)
(shr-fontize-dom dom 'italic))
(defun shr-tag-em (dom)
(shr-fontize-dom dom 'italic))
(defun shr-tag-strong (dom)
(shr-fontize-dom dom 'bold))
(defun shr-tag-u (dom)
(shr-fontize-dom dom 'underline))
(defun shr-tag-tt (dom)
(let ((shr-current-font 'default))
(shr-generic dom)))
(defun shr-tag-ins (cont)
(let* ((start (point))
(color "green")
(shr-stylesheet (nconc (list (cons 'color color))
shr-stylesheet)))
(shr-generic cont)
(shr-colorize-region start (point) color
(cdr (assq 'background-color shr-stylesheet)))))
(defun shr-tag-del (cont)
(let* ((start (point))
(color "red")
(shr-stylesheet (nconc (list (cons 'color color))
shr-stylesheet)))
(shr-fontize-dom cont 'shr-strike-through)
(shr-colorize-region start (point) color
(cdr (assq 'background-color shr-stylesheet)))))
(defun shr-parse-style (style)
(when style
(save-match-data
(when (string-match "\n" style)
(setq style (replace-match " " t t style))))
(let ((plist nil))
(dolist (elem (split-string style ";"))
(when elem
(setq elem (split-string elem ":"))
(when (and (car elem)
(cadr elem))
(let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
(value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
(when (string-match " *!important\\'" value)
(setq value (substring value 0 (match-beginning 0))))
(unless (equal value "inherit")
(push (cons (intern name obarray)
value)
plist))))))
plist)))
(defun shr-tag-base (dom)
(when-let* ((base (dom-attr dom 'href)))
(setq shr-base (shr-parse-base base)))
(shr-generic dom))
(defun shr-tag-a (dom)
(let ((url (dom-attr dom 'href))
(title (dom-attr dom 'title))
(start (point))
shr-start)
(shr-generic dom)
(when (and shr-target-id
(equal (dom-attr dom 'name) shr-target-id))
;; We have a zero-length <a name="foo"> element, so just
;; insert... something.
(when (= start (point))
(shr-ensure-newline)
(insert " "))
(put-text-property start (1+ start) 'shr-target-id shr-target-id))
(when url
(shr-urlify (or shr-start start) (shr-expand-url url) title))))
(defun shr-tag-object (dom)
(unless shr-inhibit-images
(let ((start (point))
url multimedia image)
(when-let* ((type (dom-attr dom 'type)))
(when (string-match "\\`image/svg" type)
(setq url (dom-attr dom 'data)
image t)))
(dolist (child (dom-non-text-children dom))
(cond
((eq (dom-tag child) 'embed)
(setq url (or url (dom-attr child 'src))
multimedia t))
((and (eq (dom-tag child) 'param)
(equal (dom-attr child 'name) "movie"))
(setq url (or url (dom-attr child 'value))
multimedia t))))
(when url
(cond
(image
(shr-indirect-call 'img dom url)
(setq dom nil))
(multimedia
(shr-insert " [multimedia] ")
(shr-urlify start (shr-expand-url url)))))
(when dom
(shr-generic dom)))))
(defcustom shr-prefer-media-type-alist '(("webm" . 1.0)
("ogv" . 1.0)
("ogg" . 1.0)
("opus" . 1.0)
("flac" . 0.9)
("wav" . 0.5))
"Preferences for media types.
The key element should be a regexp matched against the type of the source or
url if no type is specified. The value should be a float in the range 0.0 to
1.0. Media elements with higher value are preferred."
:version "24.4"
:group 'shr
:type '(alist :key-type regexp :value-type float))
(defun shr--get-media-pref (elem)
"Determine the preference for ELEM.
The preference is a float determined from `shr-prefer-media-type'."
(let ((type (dom-attr elem 'type))
(p 0.0))
(unless type
(setq type (dom-attr elem 'src)))
(when type
(dolist (pref shr-prefer-media-type-alist)
(when (and
(> (cdr pref) p)
(string-match-p (car pref) type))
(setq p (cdr pref)))))
p))
(defun shr--extract-best-source (dom &optional url pref)
"Extract the best `:src' property from <source> blocks in DOM."
(setq pref (or pref -1.0))
(let (new-pref)
(dolist (elem (dom-non-text-children dom))
(when (and (eq (dom-tag elem) 'source)
(< pref
(setq new-pref
(shr--get-media-pref elem))))
(setq pref new-pref
url (dom-attr elem 'src))
;; libxml's html parser isn't HTML5 compliant and non terminated
;; source tags might end up as children. So recursion it is...
(dolist (child (dom-non-text-children elem))
(when (eq (dom-tag child) 'source)
(let ((ret (shr--extract-best-source (list child) url pref)))
(when (< pref (cdr ret))
(setq url (car ret)
pref (cdr ret)))))))))
(cons url pref))
(defun shr-tag-video (dom)
(let ((image (dom-attr dom 'poster))
(url (dom-attr dom 'src))
(start (point)))
(unless url
(setq url (car (shr--extract-best-source dom))))
(if (> (length image) 0)
(shr-indirect-call 'img nil image)
(shr-insert " [video] "))
(shr-urlify start (shr-expand-url url))))
(defun shr-tag-audio (dom)
(let ((url (dom-attr dom 'src))
(start (point)))
(unless url
(setq url (car (shr--extract-best-source dom))))
(shr-insert " [audio] ")
(shr-urlify start (shr-expand-url url))))
(defun shr-tag-img (dom &optional url)
(when (or url
(and dom
(or (> (length (dom-attr dom 'src)) 0)
(> (length (dom-attr dom 'srcset)) 0))))
(when (> (current-column) 0)
(insert "\n"))
(let ((alt (dom-attr dom 'alt))
(width (shr-string-number (dom-attr dom 'width)))
(height (shr-string-number (dom-attr dom 'height)))
(url (shr-expand-url (or url (shr--preferred-image dom)))))
(let ((start (point-marker)))
(when (zerop (length alt))
(setq alt "*"))
(cond
((null url)
;; After further expansion, there turned out to be no valid
;; src in the img after all.
)
((or (member (dom-attr dom 'height) '("0" "1"))
(member (dom-attr dom 'width) '("0" "1")))
;; Ignore zero-sized or single-pixel images.
)
((and (not shr-inhibit-images)
(string-match "\\`data:" url))
(let ((image (shr-image-from-data (substring url (match-end 0)))))
(if image
(funcall shr-put-image-function image alt
(list :width width :height height))
(insert alt))))
((and (not shr-inhibit-images)
(string-match "\\`cid:" url))
(let ((url (substring url (match-end 0)))
image)
(if (or (not shr-content-function)
(not (setq image (funcall shr-content-function url))))
(insert alt)
(funcall shr-put-image-function image alt
(list :width width :height height)))))
((or shr-inhibit-images
(and shr-blocked-images
(string-match shr-blocked-images url)))
(setq shr-start (point))
(shr-insert alt))
((and (not shr-ignore-cache)
(url-is-cached (shr-encode-url url)))
(funcall shr-put-image-function (shr-get-image-data url) alt
(list :width width :height height)))
(t
(when (and shr-ignore-cache
(url-is-cached (shr-encode-url url)))
(let ((file (url-cache-create-filename (shr-encode-url url))))
(when (file-exists-p file)
(delete-file file))))
(when (image-type-available-p 'svg)
(insert-image
(shr-make-placeholder-image dom)
(or alt "")))
(insert " ")
(url-queue-retrieve
(shr-encode-url url) 'shr-image-fetched
(list (current-buffer) start (set-marker (make-marker) (point))
(list :width width :height height))
t t)))
(when (zerop shr-table-depth) ;; We are not in a table.
(put-text-property start (point) 'keymap shr-image-map)
(put-text-property start (point) 'shr-alt alt)
(put-text-property start (point) 'image-url url)
(put-text-property start (point) 'image-displayer
(shr-image-displayer shr-content-function))
(put-text-property start (point) 'help-echo
(shr-fill-text
(or (dom-attr dom 'title) alt))))))))
(defun shr--preferred-image (dom)
(let ((srcset (dom-attr dom 'srcset))
(frame-width (frame-pixel-width))
(width (string-to-number (or (dom-attr dom 'width) "100")))
candidate)
(when (> (length srcset) 0)
;; srcset consist of a series of URL/size specifications
;; separated by the ", " string.
(setq srcset
(sort (mapcar
(lambda (elem)
(let ((spec (split-string elem "[\t\n\r ]+")))
(cond
((= (length spec) 1)
;; Make sure it's well formed.
(list (car spec) 0))
((string-match "\\([0-9]+\\)x\\'" (cadr spec))
;; If we have an "x" form, then use the width
;; spec to compute the real width.
(list (car spec)
(* width (string-to-number
(match-string 1 (cadr spec))))))
(t
(list (car spec)
(string-to-number (cadr spec)))))))
(split-string (replace-regexp-in-string
"\\`[\t\n\r ]+\\|[\t\n\r ]+\\'" "" srcset)
"[\t\n\r ]*,[\t\n\r ]*"))
(lambda (e1 e2)
(> (cadr e1) (cadr e2)))))
;; Choose the smallest picture that's bigger than the current
;; frame.
(setq candidate (caar srcset))
(while (and srcset
(> (cadr (car srcset)) frame-width))
(setq candidate (caar srcset))
(pop srcset)))
(or candidate (dom-attr dom 'src))))
(defun shr-string-number (string)
(if (null string)
nil
(setq string (replace-regexp-in-string "[^0-9]" "" string))
(if (zerop (length string))
nil
(string-to-number string))))
(defun shr-make-placeholder-image (dom)
(let* ((edges (and
(get-buffer-window (current-buffer))
(window-inside-pixel-edges
(get-buffer-window (current-buffer)))))
(scaling (image-compute-scaling-factor image-scaling-factor))
(width (truncate
(* (or (shr-string-number (dom-attr dom 'width)) 100)
scaling)))
(height (truncate
(* (or (shr-string-number (dom-attr dom 'height)) 100)
scaling)))
(max-width
(and edges
(truncate (* shr-max-image-proportion
(- (nth 2 edges) (nth 0 edges))))))
(max-height (and edges
(truncate (* shr-max-image-proportion
(- (nth 3 edges) (nth 1 edges))))))
svg)
(when (and max-width
(> width max-width))
(setq height (truncate (* (/ (float max-width) width) height))
width max-width))
(when (and max-height
(> height max-height))
(setq width (truncate (* (/ (float max-height) height) width))
height max-height))
(setq svg (svg-create width height))
(svg-gradient svg "background" 'linear '((0 . "#b0b0b0") (100 . "#808080")))
(svg-rectangle svg 0 0 width height :gradient "background"
:stroke-width 2 :stroke-color "black")
(let ((image (svg-image svg)))
(setf (image-property image :ascent) 100)
image)))
(defun shr-tag-pre (dom)
(let ((shr-folding-mode 'none)
(shr-current-font 'default))
(shr-ensure-newline)
(shr-generic dom)
(shr-ensure-newline)))
(defun shr-tag-blockquote (dom)
(shr-ensure-paragraph)
(let ((start (point))
(shr-indentation (+ shr-indentation
(* 4 shr-table-separator-pixel-width))))
(shr-generic dom)
(shr-ensure-paragraph)
(shr-mark-fill start)))
(defun shr-tag-dl (dom)
(shr-ensure-paragraph)
(shr-generic dom)
(shr-ensure-paragraph))
(defun shr-tag-dt (dom)
(shr-ensure-newline)
(shr-generic dom)
(shr-ensure-newline))
(defun shr-tag-dd (dom)
(shr-ensure-newline)
(let ((shr-indentation (+ shr-indentation
(* 4 shr-table-separator-pixel-width))))
(shr-generic dom)))
(defun shr-tag-ul (dom)
(shr-ensure-paragraph)
(let ((shr-list-mode 'ul))
(shr-generic dom))
;; If we end on an empty <li>, then make sure we really end on a new
;; paragraph.
(unless (bolp)
(insert "\n"))
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-ol (dom)
(shr-ensure-paragraph)
(let ((shr-list-mode 1))
(shr-generic dom))
(shr-fill-paragraph dom)
(shr-ensure-paragraph))
(defun shr-tag-li (dom)
(shr-ensure-newline)
(let ((start (point)))
(let* ((bullet
(if (numberp shr-list-mode)
(prog1
(format "%d " shr-list-mode)
(setq shr-list-mode (1+ shr-list-mode)))
(car shr-internal-bullet)))
(width (if (numberp shr-list-mode)
(shr-string-pixel-width bullet)
(cdr shr-internal-bullet))))
(insert bullet)
(shr-mark-fill start)
(let ((shr-indentation (+ shr-indentation width)))
(put-text-property start (1+ start)
'shr-continuation-indentation shr-indentation)
(put-text-property start (1+ start) 'shr-prefix-length (length bullet))
(shr-generic dom))))
(unless (bolp)
(unless shr-use-fonts (insert "\x2028")) ; insert a line separator
(insert "\n")))
(defun shr-mark-fill (start)
;; We may not have inserted any text to fill.
(unless (= start (point))
(put-text-property start (1+ start)
'shr-indentation shr-indentation)))
(defun shr-tag-br (dom)
(when (and (not (bobp))
;; Only add a newline if we break the current line, or
;; the previous line isn't a blank line.
(or (not (bolp))
(and (> (- (point) 2) (point-min))
(not (= (char-after (- (point) 2)) ?\n)))))
(unless shr-use-fonts (insert "\x2028")) ; insert a line separator
(insert "\n"))
(shr-generic dom))
(defun shr-tag-span (dom)
(shr-generic dom))
(defun shr-tag-h1 (dom)
(shr-heading dom (if shr-use-fonts
'(variable-pitch (:height 1.3 :weight bold))
'bold)))
(defun shr-tag-h2 (dom)
(shr-heading dom 'bold))
(defun shr-tag-h3 (dom)
(shr-heading dom 'italic))
(defun shr-tag-h4 (dom)
(shr-heading dom))
(defun shr-tag-h5 (dom)
(shr-heading dom))
(defun shr-tag-h6 (dom)
(shr-heading dom))
(defun shr-tag-hr (_dom)
(shr-ensure-newline)
(insert (make-string (if (not shr-use-fonts)
shr-internal-width
(1+ (/ shr-internal-width
shr-table-separator-pixel-width)))
shr-hr-line)
"\n"))
(defun shr-tag-title (dom)
(shr-heading dom 'bold 'underline))
(defun shr-tag-font (dom)
(let* ((start (point))
(color (dom-attr dom 'color))
(shr-stylesheet (nconc (list (cons 'color color))
shr-stylesheet)))
(shr-generic dom)
(when color
(shr-colorize-region start (point) color
(cdr (assq 'background-color shr-stylesheet))))))
(defun shr-tag-bdo (dom)
(let* ((direction (dom-attr dom 'dir))
(char (cond
((equal direction "ltr")
?\N{LEFT-TO-RIGHT OVERRIDE})
((equal direction "rtl")
?\N{RIGHT-TO-LEFT OVERRIDE}))))
(when char
(insert ?\N{FIRST STRONG ISOLATE} char))
(shr-generic dom)
(when char
(insert ?\N{POP DIRECTIONAL FORMATTING} ?\N{POP DIRECTIONAL ISOLATE}))))
(defun shr-tag-bdi (dom)
(insert ?\N{FIRST STRONG ISOLATE})
(shr-generic dom)
(insert ?\N{POP DIRECTIONAL ISOLATE}))
;;; Table rendering algorithm.
;; Table rendering is the only complicated thing here. We do this by
;; first counting how many TDs there are in each TR, and registering
;; how wide they think they should be ("width=45%", etc). Then we
;; render each TD separately (this is done in temporary buffers, so
;; that we can use all the rendering machinery as if we were in the
;; main buffer). Now we know how much space each TD really takes, so
;; we then render everything again with the new widths, and finally
;; insert all these boxes into the main buffer.
(defun shr-tag-table-1 (dom)
(setq dom (or (dom-child-by-tag dom 'tbody) dom))
(let* ((shr-inhibit-images t)
(shr-table-depth (1+ shr-table-depth))
(shr-kinsoku-shorten t)
;; Find all suggested widths.
(columns (shr-column-specs dom))
;; Compute how many pixels wide each TD should be.
(suggested-widths (shr-pro-rate-columns columns))
;; Do a "test rendering" to see how big each TD is (this can
;; be smaller (if there's little text) or bigger (if there's
;; unbreakable text).
(elems (or (dom-attr dom 'shr-suggested-widths)
(shr-make-table dom suggested-widths nil
'shr-suggested-widths)))
(sketch (cl-loop for line in elems
collect (mapcar #'car line)))
(natural (cl-loop for line in elems
collect (mapcar #'cdr line)))
(sketch-widths (shr-table-widths sketch natural suggested-widths)))
;; This probably won't work very well.
(when (> (+ (cl-loop for width across sketch-widths
summing (1+ width))
shr-indentation shr-table-separator-pixel-width)
(frame-width))
(setq truncate-lines t))
;; Then render the table again with these new "hard" widths.
(shr-insert-table (shr-make-table dom sketch-widths t) sketch-widths)))
(defun shr-table-body (dom)
(let ((tbodies (seq-filter (lambda (child)
(eq (dom-tag child) 'tbody))
(dom-non-text-children dom))))
(cond
((null tbodies)
dom)
((= (length tbodies) 1)
(car tbodies))
(t
;; Table with multiple tbodies. Convert into a single tbody.
`(tbody nil ,@(cl-reduce 'append
(mapcar 'dom-non-text-children tbodies)))))))
(defun shr-tag-table (dom)
(shr-ensure-paragraph)
(let* ((caption (dom-children (dom-child-by-tag dom 'caption)))
(header (dom-non-text-children (dom-child-by-tag dom 'thead)))
(body (dom-non-text-children (shr-table-body dom)))
(footer (dom-non-text-children (dom-child-by-tag dom 'tfoot)))
(bgcolor (dom-attr dom 'bgcolor))
(start (point))
(shr-stylesheet (nconc (list (cons 'background-color bgcolor))
shr-stylesheet))
(nheader (if header (shr-max-columns header)))
(nbody (if body (shr-max-columns body) 0))
(nfooter (if footer (shr-max-columns footer))))
(if (and (not caption)
(not header)
(not (dom-child-by-tag dom 'tbody))
(not (dom-child-by-tag dom 'tr))
(not footer))
;; The table is totally invalid and just contains random junk.
;; Try to output it anyway.
(shr-generic dom)
;; It's a real table, so render it.
(if (dom-attr dom 'shr-fixed-table)
(shr-tag-table-1 dom)
;; Only fix up the table once.
(let ((table
(nconc
(list 'table nil)
(if caption `((tr nil (td nil ,@caption))))
(cond
(header
(if footer
;; header + body + footer
(if (= nheader nbody)
(if (= nbody nfooter)
`((tr nil (td nil (table nil
(tbody nil ,@header
,@body ,@footer)))))
(nconc `((tr nil (td nil (table nil
(tbody nil ,@header
,@body)))))
(if (= nfooter 1)
footer
`((tr nil (td nil (table
nil (tbody
nil ,@footer))))))))
(nconc `((tr nil (td nil (table nil (tbody
nil ,@header)))))
(if (= nbody nfooter)
`((tr nil (td nil (table
nil (tbody nil ,@body
,@footer)))))
(nconc `((tr nil (td nil (table
nil (tbody nil
,@body)))))
(if (= nfooter 1)
footer
`((tr nil (td nil (table
nil
(tbody
nil
,@footer))))))))))
;; header + body
(if (= nheader nbody)
`((tr nil (td nil (table nil (tbody nil ,@header
,@body)))))
(if (= nheader 1)
`(,@header (tr nil (td nil (table
nil (tbody nil ,@body)))))
`((tr nil (td nil (table nil (tbody nil ,@header))))
(tr nil (td nil (table nil (tbody nil ,@body)))))))))
(footer
;; body + footer
(if (= nbody nfooter)
`((tr nil (td nil (table
nil (tbody nil ,@body ,@footer)))))
(nconc `((tr nil (td nil (table nil (tbody nil ,@body)))))
(if (= nfooter 1)
footer
`((tr nil (td nil (table
nil (tbody nil ,@footer)))))))))
(caption
`((tr nil (td nil (table nil (tbody nil ,@body))))))
(body)))))
(dom-set-attribute table 'shr-fixed-table t)
(setcdr dom (cdr table))
(shr-tag-table-1 dom))))
(when bgcolor
(shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
bgcolor))
;; Finally, insert all the images after the table. The Emacs buffer
;; model isn't strong enough to allow us to put the images actually
;; into the tables. It inserts also non-td/th objects.
(when (zerop shr-table-depth)
(save-excursion
(shr-expand-alignments start (point)))
(let ((strings (shr-collect-extra-strings-in-table dom)))
(when strings
(save-restriction
(narrow-to-region (point) (point))
(insert (mapconcat #'identity strings "\n"))
(shr-fill-lines (point-min) (point-max))))))))
(defun shr-collect-extra-strings-in-table (dom &optional flags)
"Return extra strings in DOM of which the root is a table clause.
Render <img>s and <object>s, and strings and child <table>s of which
the parent <td> or <th> is lacking. FLAGS is a cons of two boolean
flags that control whether to collect or render objects."
;; This function runs recursively and collects strings if the cdr of
;; FLAGS is nil and the car is not nil, and it renders also child
;; <table>s if the cdr is nil. Note: FLAGS may be nil, not a cons.
;; FLAGS becomes (t . nil) if a <tr> clause is found in the children
;; of DOM, and becomes (t . t) if a <td> or a <th> clause is found
;; and the car is t then. When a <table> clause is found, FLAGS
;; becomes nil if the cdr is t then. But if FLAGS is (t . nil) then,
;; it renders the <table>.
(cl-loop for child in (dom-children dom) with recurse with tag
do (setq recurse nil)
if (stringp child)
unless (or (not (car flags)) (cdr flags))
when (string-match "\\(?:[^\t\n\r ]+[\t\n\r ]+\\)*[^\t\n\r ]+"
child)
collect (match-string 0 child)
end end
else if (consp child)
do (setq tag (dom-tag child)) and
unless (memq tag '(comment style))
if (eq tag 'img)
do (shr-indirect-call 'img child)
else if (eq tag 'object)
do (shr-indirect-call 'object child)
else
do (setq recurse t) and
if (eq tag 'tr)
do (setq flags '(t . nil))
else if (memq tag '(td th))
when (car flags)
do (setq flags '(t . t))
end
else if (eq tag 'table)
if (cdr flags)
do (setq flags nil)
else if (car flags)
do (setq recurse nil)
(shr-indirect-call 'table child)
end end end end end end end end end end
when recurse
append (shr-collect-extra-strings-in-table child flags)))
(defun shr-insert-table (table widths)
(let* ((collapse (equal (cdr (assq 'border-collapse shr-stylesheet))
"collapse"))
(shr-table-separator-length (if collapse 0 1))
(shr-table-vertical-line (if collapse "" shr-table-vertical-line))
(start (point)))
(setq shr-table-id (1+ shr-table-id))
(unless collapse
(shr-insert-table-ruler widths))
(dolist (row table)
(let ((start (point))
(align 0)
(column-number 0)
(height (let ((max 0))
(dolist (column row)
(setq max (max max (nth 2 column))))
max)))
(dotimes (_ (max height 1))
(shr-indent)
(insert shr-table-vertical-line "\n"))
(dolist (column row)
(when (> (nth 2 column) -1)
(goto-char start)
;; Sum up all the widths from the column. (There may be
;; more than one if this is a "colspan" column.)
(dotimes (_ (nth 4 column))
;; The colspan directive may be wrong and there may not be
;; that number of columns.
(when (<= column-number (1- (length widths)))
(setq align (+ align
(aref widths column-number)
(* 2 shr-table-separator-pixel-width))))
(setq column-number (1+ column-number)))
(let ((lines (nth 3 column))
(pixel-align (if (not shr-use-fonts)
(* align (frame-char-width))
align)))
(dolist (line lines)
(end-of-line)
(let ((start (point))
(background (and (> (length line) 0)
(shr-face-background
(get-text-property
(1- (length line)) 'face line))))
(space (propertize
" "
'display `(space :align-to (,pixel-align))
'shr-table-indent shr-table-id)))
(when background
(setq space (propertize space 'face background)))
(insert line space shr-table-vertical-line)
(shr-colorize-region
start (1- (point)) (nth 5 column) (nth 6 column)))
(forward-line 1))
;; Add blank lines at padding at the bottom of the TD,
;; possibly.
(dotimes (_ (- height (length lines)))
(end-of-line)
(let ((start (point)))
(insert (propertize " "
'display `(space :align-to (,pixel-align))
'shr-table-indent shr-table-id)
shr-table-vertical-line)
(shr-colorize-region
start (1- (point)) (nth 5 column) (nth 6 column)))
(forward-line 1))))))
(unless collapse
(shr-insert-table-ruler widths)))
(unless (= start (point))
(put-text-property start (1+ start) 'shr-table-id shr-table-id))))
(defun shr-face-background (face)
(and (consp face)
(or (and (plist-get face :background)
(list :background (plist-get face :background)))
(let ((background nil))
(dolist (elem face)
(when (and (consp elem)
(eq (car elem) :background)
(not background))
(setq background (cadr elem))))
(and background
(list :background background))))))
(defun shr-expand-alignments (start end)
(while (< (setq start (next-single-property-change
start 'shr-table-id nil end))
end)
(goto-char start)
(let* ((shr-use-fonts t)
(id (get-text-property (point) 'shr-table-id))
(base (shr-pixel-column))
elem)
(when id
(save-excursion
(while (setq elem (text-property-any
(point) end 'shr-table-indent id))
(goto-char elem)
(let ((align (get-text-property (point) 'display)))
(put-text-property (point) (1+ (point)) 'display
`(space :align-to (,(+ (car (nth 2 align))
base)))))
(forward-char 1)))))
(setq start (1+ start))))
(defun shr-insert-table-ruler (widths)
(when shr-table-horizontal-line
(when (and (bolp)
(> shr-indentation 0))
(shr-indent))
(insert shr-table-corner)
(let ((total-width 0))
(dotimes (i (length widths))
(setq total-width (+ total-width (aref widths i)
(* shr-table-separator-pixel-width 2)))
(insert (make-string (1+ (/ (aref widths i)
shr-table-separator-pixel-width))
shr-table-horizontal-line)
(propertize " "
'display `(space :align-to (,total-width))
'shr-table-indent shr-table-id)
shr-table-corner)))
(insert "\n")))
(defun shr-table-widths (table natural-table suggested-widths)
(let* ((length (length suggested-widths))
(widths (make-vector length 0))
(natural-widths (make-vector length 0)))
(dolist (row table)
(let ((i 0))
(dolist (column row)
(aset widths i (max (aref widths i) column))
(setq i (1+ i)))))
(dolist (row natural-table)
(let ((i 0))
(dolist (column row)
(aset natural-widths i (max (aref natural-widths i) column))
(setq i (1+ i)))))
(let ((extra (- (apply '+ (append suggested-widths nil))
(apply '+ (append widths nil))
(* shr-table-separator-pixel-width (1+ (length widths)))))
(expanded-columns 0))
;; We have extra, unused space, so divide this space amongst the
;; columns.
(when (> extra 0)
;; If the natural width is wider than the rendered width, we
;; want to allow the column to expand.
(dotimes (i length)
(when (> (aref natural-widths i) (aref widths i))
(setq expanded-columns (1+ expanded-columns))))
(dotimes (i length)
(when (> (aref natural-widths i) (aref widths i))
(aset widths i (min
(aref natural-widths i)
(+ (/ extra expanded-columns)
(aref widths i))))))))
widths))
(defun shr-make-table (dom widths &optional fill storage-attribute)
(or (cadr (assoc (list dom widths fill) shr-content-cache))
(let ((data (shr-make-table-1 dom widths fill)))
(push (list (list dom widths fill) data)
shr-content-cache)
(when storage-attribute
(dom-set-attribute dom storage-attribute data))
data)))
(defun shr-make-table-1 (dom widths &optional fill)
(let ((trs nil)
(rowspans (make-vector (length widths) 0))
(colspan-remaining 0)
colspan-width colspan-count
width colspan)
(dolist (row (dom-non-text-children dom))
(when (eq (dom-tag row) 'tr)
(let ((tds nil)
(columns (dom-non-text-children row))
(i 0)
(width-column 0)
column)
(while (< i (length widths))
;; If we previously had a rowspan definition, then that
;; means that we now have a "missing" td/th element here.
;; So just insert a dummy, empty one to (sort of) emulate
;; rowspan.
(setq column
(if (zerop (aref rowspans i))
(pop columns)
(aset rowspans i (1- (aref rowspans i)))
'(td)))
(when (and (not (stringp column))
(or (memq (dom-tag column) '(td th))
(not column)))
(when-let* ((span (dom-attr column 'rowspan)))
(aset rowspans i (+ (aref rowspans i)
(1- (string-to-number span)))))
;; Sanity check for invalid column-spans.
(when (>= width-column (length widths))
(setq width-column 0))
(setq width
(if column
(aref widths width-column)
(* 10 shr-table-separator-pixel-width)))
(when (setq colspan (dom-attr column 'colspan))
(setq colspan (min (string-to-number colspan)
;; The colspan may be wrong, so
;; truncate it to the length of the
;; remaining columns.
(- (length widths) i)))
(dotimes (j (1- colspan))
(setq width
(if (> (+ i 1 j) (1- (length widths)))
;; If we have a colspan spec that's longer
;; than the table is wide, just use the last
;; width as the width.
(aref widths (1- (length widths)))
;; Sum up the widths of the columns we're
;; spanning.
(+ width
shr-table-separator-length
(aref widths (+ i 1 j))))))
(setq width-column (+ width-column (1- colspan))
colspan-count colspan
colspan-remaining colspan))
(when column
(let ((data (shr-render-td column width fill)))
(if (and (not fill)
(> colspan-remaining 0))
(progn
(setq colspan-width (car data))
(let ((this-width (/ colspan-width colspan-count)))
(push (cons this-width (cadr data)) tds)
(setq colspan-remaining (1- colspan-remaining))))
(if (not fill)
(push (cons (car data) (cadr data)) tds)
(push data tds)))))
(when (and colspan
(> colspan 1))
(dotimes (_ (1- colspan))
(setq i (1+ i))
(push
(if fill
(list 0 0 -1 nil 1 nil nil)
'(0 . 0))
tds)))
(setq i (1+ i)
width-column (1+ width-column))))
(push (nreverse tds) trs))))
(nreverse trs)))
(defun shr-pixel-buffer-width ()
(if (not shr-use-fonts)
(save-excursion
(goto-char (point-min))
(let ((max 0))
(while (not (eobp))
(end-of-line)
(setq max (max max (current-column)))
(forward-line 1))
max))
(if (get-buffer-window)
(car (window-text-pixel-size nil (point-min) (point-max)))
(save-window-excursion
;; Avoid errors if the selected window is a dedicated one,
;; and they just want to insert a document into it.
(set-window-dedicated-p nil nil)
(set-window-buffer nil (current-buffer))
(car (window-text-pixel-size nil (point-min) (point-max)))))))
(defun shr-render-td (dom width fill)
(let ((cache (intern (format "shr-td-cache-%s-%s" width fill))))
(or (dom-attr dom cache)
(and fill
(let (result)
(dolist (attr (dom-attributes dom))
(let ((name (symbol-name (car attr))))
(when (string-match "shr-td-cache-\\([0-9]+\\)-nil" name)
(let ((cache-width (string-to-number
(match-string 1 name))))
(when (and (>= cache-width width)
(<= (car (cdr attr)) width))
(setq result (cdr attr)))))))
result))
(let* ((pt (point))
(result (shr-render-td-1 dom width fill)))
(dom-set-attribute dom cache result)
(goto-char pt)
result))))
(defun shr-render-td-1 (dom width fill)
(with-temp-buffer
(let ((bgcolor (dom-attr dom 'bgcolor))
(fgcolor (dom-attr dom 'fgcolor))
(style (dom-attr dom 'style))
(shr-stylesheet shr-stylesheet)
(max-width 0)
natural-width)
(when style
(setq style (and (string-match "color" style)
(shr-parse-style style))))
(when bgcolor
(setq style (nconc (list (cons 'background-color bgcolor))
style)))
(when fgcolor
(setq style (nconc (list (cons 'color fgcolor)) style)))
(when style
(setq shr-stylesheet (append style shr-stylesheet)))
(let ((shr-internal-width width)
(shr-indentation 0))
(shr-descend dom))
(save-window-excursion
;; Avoid errors if the selected window is a dedicated one,
;; and they just want to insert a document into it.
(set-window-dedicated-p nil nil)
(set-window-buffer nil (current-buffer))
(unless fill
(setq natural-width
(or (dom-attr dom 'shr-td-cache-natural)
(let ((natural (max (shr-pixel-buffer-width)
(shr-dom-max-natural-width dom 0))))
(dom-set-attribute dom 'shr-td-cache-natural natural)
natural))))
(if (and natural-width
(<= natural-width width))
(setq max-width natural-width)
(let ((shr-internal-width width))
(shr-fill-lines (point-min) (point-max))
(setq max-width (shr-pixel-buffer-width)))))
(goto-char (point-max))
;; Delete padding at the bottom of the TDs.
(delete-region
(point)
(progn
(skip-chars-backward " \t\n")
(end-of-line)
(point)))
(goto-char (point-min))
(list max-width
natural-width
(count-lines (point-min) (point-max))
(split-string (buffer-string) "\n")
(if (dom-attr dom 'colspan)
(string-to-number (dom-attr dom 'colspan))
1)
(cdr (assq 'color shr-stylesheet))
(cdr (assq 'background-color shr-stylesheet))))))
(defun shr-dom-max-natural-width (dom max)
(if (eq (dom-tag dom) 'table)
(max max (or
(cl-loop
for line in (dom-attr dom 'shr-suggested-widths)
maximize (+
shr-table-separator-length
(cl-loop for elem in line
summing
(+ (cdr elem)
(* 2 shr-table-separator-length)))))
0))
(dolist (child (dom-children dom))
(unless (stringp child)
(setq max (max (shr-dom-max-natural-width child max)))))
max))
(defun shr-buffer-width ()
(goto-char (point-min))
(let ((max 0))
(while (not (eobp))
(end-of-line)
(setq max (max max (current-column)))
(forward-line 1))
max))
(defun shr-pro-rate-columns (columns)
(let ((total-percentage 0)
(widths (make-vector (length columns) 0)))
(dotimes (i (length columns))
(setq total-percentage (+ total-percentage (aref columns i))))
(setq total-percentage (/ 1.0 total-percentage))
(dotimes (i (length columns))
(aset widths i (max (truncate (* (aref columns i)
total-percentage
(- shr-internal-width
(* (1+ (length columns))
shr-table-separator-pixel-width))))
10)))
widths))
;; Return a summary of the number and shape of the TDs in the table.
(defun shr-column-specs (dom)
(let ((columns (make-vector (shr-max-columns dom) 1)))
(dolist (row (dom-non-text-children dom))
(when (eq (dom-tag row) 'tr)
(let ((i 0))
(dolist (column (dom-non-text-children row))
(when (memq (dom-tag column) '(td th))
(let ((width (dom-attr column 'width)))
(when (and width
(string-match "\\([0-9]+\\)%" width)
(not (zerop (setq width (string-to-number
(match-string 1 width))))))
(aset columns i (/ width 100.0))))
(setq i (1+ i)))))))
columns))
(defun shr-count (dom elem)
(let ((i 0))
(dolist (sub (dom-children dom))
(when (and (not (stringp sub))
(eq (dom-tag sub) elem))
(setq i (1+ i))))
i))
(defun shr-max-columns (dom)
(let ((max 0))
(dolist (row (dom-children dom))
(when (and (not (stringp row))
(eq (dom-tag row) 'tr))
(setq max (max max (+ (shr-count row 'td)
(shr-count row 'th))))))
max))
(provide 'shr)
;;; shr.el ends here
^ permalink raw reply [flat|nested] 15+ messages in thread* bug#32281: shr.el align support patch
2018-08-07 0:51 ` Bad Blue Bull
@ 2018-08-07 0:59 ` Bad Blue Bull
2018-08-07 2:34 ` Noam Postavsky
` (2 subsequent siblings)
3 siblings, 0 replies; 15+ messages in thread
From: Bad Blue Bull @ 2018-08-07 0:59 UTC (permalink / raw)
To: Eli Zaretskii, Noam Postavsky; +Cc: 32281@debbugs.gnu.org
[-- Attachment #1: Type: text/html, Size: 487 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread* bug#32281: shr.el align support patch
2018-08-07 0:51 ` Bad Blue Bull
2018-08-07 0:59 ` Bad Blue Bull
@ 2018-08-07 2:34 ` Noam Postavsky
2018-08-07 15:07 ` Eli Zaretskii
2018-08-07 18:15 ` Lars Ingebrigtsen
3 siblings, 0 replies; 15+ messages in thread
From: Noam Postavsky @ 2018-08-07 2:34 UTC (permalink / raw)
To: Bad Blue Bull; +Cc: 32281@debbugs.gnu.org
Bad Blue Bull <ibmbull@yandex.ru> writes:
>> The first line of the doc string should not be longer than 78
>> characters, and should be a complete sentence.
>
> I don't know what do you mean of "complete sentence", docs say it must
> start with a capital letter and end with a period. First sentence now
> fills 2 lines I know it's not good for apropos, I can edit it again if
> needed.
Yeah, that's all we mean there, the whole sentence (i.e., from capital
letter to period) needs to fit on the first line.
>> Why did you decide to use u+2028 and u+2029 for these purposes? Emacs
>> doesn't yet support these characters as Unicode intended, so using
>> them might have unexpected effects, and might produce different effect
>> if we start supporting them in the future.
>
> I need to use a character to mark places where lines must be split
> (specified by <br> tags and end of list items), also a character to
> mark end of a paragraph to be filled (a mark can be used for this
> purpose but docs warn against it).
[also quoting clarification from following message]
> This phrase looks confusing, sorry, I meant push-mark can be used for
> this purpose but it's no good.
By "docs warn against it", were you referring to
Novice Emacs Lisp programmers often try to use the mark for the wrong
purposes. See the documentation of ‘set-mark’ for more information.
That's just about using that particular function for non-interactive use
cases. If it does makes sense to use a mark for this, just don't use
push-mark or set-mark, but rather copy-mark and save the resulting mark
object to a local variable.
> + (save-excursion
> + (let ((line-begin) (paragraph-end))
> + (forward-paragraph)
> + (insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end
> + ; of a paragraph
> + (backward-paragraph)
> + (setq line-begin (point))
> + (while (not paragraph-end)
> + (re-search-forward bre-regexp)
> + (if (equal (match-string 0) "\x2029") (setq paragraph-end t))
> + ; end of paragraph reached
> + (if (or bre-del paragraph-end) (replace-match ""))
> + (unless (equal (char-after) ?\n) (insert "\n"))
> + ; I don't know why but two adjacent \n
> + ; leave an empty line after fill
> + (fill-region-as-paragraph line-begin (- (point) 1)
> + justify)
> + (setq line-begin (point)))
> + (delete-char -1))))
Regarding the indentation, here's what I get after running indent-region
over the above code:
(save-excursion
(let ((line-begin) (paragraph-end))
(forward-paragraph)
(insert "\x2029") ; use \x2029 (unicode paragraph separator) to mark end
; of a paragraph
(backward-paragraph)
(setq line-begin (point))
(while (not paragraph-end)
(re-search-forward bre-regexp)
(if (equal (match-string 0) "\x2029") (setq paragraph-end t))
; end of paragraph reached
(if (or bre-del paragraph-end) (replace-match ""))
(unless (equal (char-after) ?\n) (insert "\n"))
; I don't know why but two adjacent \n
; leave an empty line after fill
(fill-region-as-paragraph line-begin (- (point) 1)
justify)
(setq line-begin (point)))
(delete-char -1)))
Notice especially the difference in the while loop body. You mentioned
lisp-body-indent, but that only affects indentation increase after a
defun line. I do see that your indentation after the let seems to be
based on 4-space tabs, but Emacs uses 8-space tabs. If you could set
indent-tabs-mode to nil (which is what the .dir-locals in the git
repository does), that would take care of it regardless.
^ permalink raw reply [flat|nested] 15+ messages in thread* bug#32281: shr.el align support patch
2018-08-07 0:51 ` Bad Blue Bull
2018-08-07 0:59 ` Bad Blue Bull
2018-08-07 2:34 ` Noam Postavsky
@ 2018-08-07 15:07 ` Eli Zaretskii
2018-08-07 16:54 ` Bad Blue Bull
2018-08-07 18:15 ` Lars Ingebrigtsen
3 siblings, 1 reply; 15+ messages in thread
From: Eli Zaretskii @ 2018-08-07 15:07 UTC (permalink / raw)
To: Bad Blue Bull; +Cc: npostavs, 32281
> From: Bad Blue Bull <ibmbull@yandex.ru>
> Cc: "32281@debbugs.gnu.org" <32281@debbugs.gnu.org>
> Date: Tue, 07 Aug 2018 03:51:52 +0300
>
> Why did you decide to use u+2028 and u+2029 for these purposes? Emacs
> doesn't yet support these characters as Unicode intended, so using
> them might have unexpected effects, and might produce different effect
> if we start supporting them in the future.
>
> I need to use a character to mark places where lines must be split (specified by <br> tags and end of list
> items), also a character to mark end of a paragraph to be filled (a mark can be used for this purpose but docs
> warn against it). These chars will be removed when a paragraph gets filled, I don't see them cause any trouble
> in the future and those values can easily be altered to diffirent ones if it happens.
I'm not sure I understand why you needed a character for that role.
fill-region-as-paragraph accepts buffer positions, and
re-search-forward can be told not to search beyond a certain buffer
position. So you should be able to record the positions in some
variables, and use them instead of inserting characters that need to
be deleted afterwards.
The disadvantage of inserting characters that were not there in the
first place is that if the user types C-g at some unfortunate moment,
these characters might be left in the buffer (unless you complicate
the code by arranging for them to be deleted in that case). Using
buffer positions avoids all those complications.
Am I missing some reason why you needed characters as markers?
Thanks.
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-07 15:07 ` Eli Zaretskii
@ 2018-08-07 16:54 ` Bad Blue Bull
2018-08-07 17:11 ` Bad Blue Bull
2018-08-07 17:19 ` Eli Zaretskii
0 siblings, 2 replies; 15+ messages in thread
From: Bad Blue Bull @ 2018-08-07 16:54 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: npostavs@gmail.com, 32281@debbugs.gnu.org
[-- Attachment #1: Type: text/html, Size: 3353 bytes --]
[-- Attachment #2: test.jpg --]
[-- Type: image/jpeg, Size: 133083 bytes --]
[-- Attachment #3: test_ff.jpg --]
[-- Type: image/jpeg, Size: 147212 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-07 16:54 ` Bad Blue Bull
@ 2018-08-07 17:11 ` Bad Blue Bull
2018-08-07 17:19 ` Eli Zaretskii
1 sibling, 0 replies; 15+ messages in thread
From: Bad Blue Bull @ 2018-08-07 17:11 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: npostavs@gmail.com, 32281@debbugs.gnu.org
[-- Attachment #1: Type: text/html, Size: 1006 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-07 16:54 ` Bad Blue Bull
2018-08-07 17:11 ` Bad Blue Bull
@ 2018-08-07 17:19 ` Eli Zaretskii
2018-08-07 18:15 ` Bad Blue Bull
1 sibling, 1 reply; 15+ messages in thread
From: Eli Zaretskii @ 2018-08-07 17:19 UTC (permalink / raw)
To: Bad Blue Bull; +Cc: npostavs, 32281
> From: Bad Blue Bull <ibmbull@yandex.ru>
> Cc: "npostavs@gmail.com" <npostavs@gmail.com>,
> "32281@debbugs.gnu.org" <32281@debbugs.gnu.org>
> Date: Tue, 07 Aug 2018 19:54:58 +0300
>
> I've escaped using of paragraph separator symbol by using narrowing
That's also fine.
> (can't just use constant position as
> fill-region-as-paragraph will change the text before it and it won't correspond the end of paragraph anymore).
We have markers for that. But if narrowing solves your problem, it's
okay to use that.
> Using a marker symbol to mark line breaks is still necessary, any attempt to avoid it would lead to ridicously
> complicated solution.
Can you explain why? I still don't think I understand.
> fill-region-as-paragraph disregards fill-collumn when aligns pic, all I can do is not to justify images at all (but I'm
> really puzzled how to do it, I could use other marker just to determine where image starts and ends and skip
> that region, but since you're against such approach... )
> Justification is badly implemented in fill, it's useless for proportional fonts and you can see it's bad for images
> too. TBH would be good to make fill.el just ignore justify in such cases (maybe giving a warning message).
To support proportional fonts, we need:
. convert all the calculations to work in pixels instead of in
columns (or, equivalently, in units of the canonical character
width, in which case you then must use floating-point values)
. put on some (or all?) SPC characters a :width display property,
with the suitably calculated width in pixels
The infrastructure for all of that already exists, it's just a matter
of coding.
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-07 0:51 ` Bad Blue Bull
` (2 preceding siblings ...)
2018-08-07 15:07 ` Eli Zaretskii
@ 2018-08-07 18:15 ` Lars Ingebrigtsen
2018-08-07 19:56 ` Bad Blue Bull
3 siblings, 1 reply; 15+ messages in thread
From: Lars Ingebrigtsen @ 2018-08-07 18:15 UTC (permalink / raw)
To: Bad Blue Bull; +Cc: Noam Postavsky, 32281@debbugs.gnu.org
Bad Blue Bull <ibmbull@yandex.ru> writes:
> + (fill-region-as-paragraph line-begin (- (point) 1)
My guess is that this would be so slow as to make shr/eww unusable on
typical pages.
shr lives within the constraints of being written in a slow language
(Emacs Lisp) and eschews features that makes it too slow for normal
usage. There's a gazillion rendering features we could add, but we
haven't because it's not practical within normal timing constraints.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 15+ messages in thread* bug#32281: shr.el align support patch
2018-08-07 18:15 ` Lars Ingebrigtsen
@ 2018-08-07 19:56 ` Bad Blue Bull
2018-08-10 0:12 ` Noam Postavsky
0 siblings, 1 reply; 15+ messages in thread
From: Bad Blue Bull @ 2018-08-07 19:56 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: Noam Postavsky, 32281@debbugs.gnu.org
[-- Attachment #1: Type: text/html, Size: 1378 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-08-07 19:56 ` Bad Blue Bull
@ 2018-08-10 0:12 ` Noam Postavsky
0 siblings, 0 replies; 15+ messages in thread
From: Noam Postavsky @ 2018-08-10 0:12 UTC (permalink / raw)
To: Bad Blue Bull; +Cc: Lars Ingebrigtsen, 32281@debbugs.gnu.org
tags 32281 wontfix
close 32281
quit
Bad Blue Bull <ibmbull@yandex.ru> writes:
> Lars Ingebrigtsen yeah I knew you'd say smth like that :-)
> I wanted to make Emacs view fb2 files (ebooks), and I wanted to
> convert them into HTML and view them in EWW, but I've just found out
> that nov.el is a great package that displays epub files and I'll
> rather convert fb2 files to epub and view them in it.
> So I withdraw this patch, can't say it was somehow slow on pages I tested though.
Okay, I'll close the bug then.
By the way, it seems to me there was some miscommunication over the term
"marker": you were using it to describe actual characters inserted into
the buffer, but you might want to take a look at `(elisp) Markers' which
can be used to similar effect but without actual characters cluttering
things up.
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#32281: shr.el align support patch
2018-07-26 14:06 bug#32281: shr.el align support patch Bad Blue Bull
2018-08-06 2:52 ` Noam Postavsky
@ 2018-08-06 17:36 ` Noam Postavsky
1 sibling, 0 replies; 15+ messages in thread
From: Noam Postavsky @ 2018-08-06 17:36 UTC (permalink / raw)
To: 32281; +Cc: Bad Blue Bull
[-- Attachment #1: Type: text/plain, Size: 82 bytes --]
[forwarding to list, please use "Reply All" to keep 32281@debbugs.gnu.org on Cc]
[-- Attachment #2: Type: message/rfc822, Size: 1141 bytes --]
From: Bad Blue Bull <ibmbull@yandex.ru>
To: Noam Postavsky <npostavs@gmail.com>
Subject: Re: bug#32281: shr.el align support patch
Date: Mon, 06 Aug 2018 16:01:49 +0300
Message-ID: <17599871533560509@sas2-7b909973f402.qloud-c.yandex.net>
> The indentation in your patch looks kind of off, are you not using
> Emacs' builtin auto-indentation? (also, don't leave hanging parens.)
I have (setq-default lisp-body-indent 2) in my ~/.emacs, things seemed
for me indented like the rest of the source, as for hanging parens -
there's a comment (that though should be put before paren as it relates
to the last argument), it's unnecessary.
As for monospace/proportional fonts: I don't insist on change of
shr-use-fonts default value, paragraph justification won't work with
proportional fonts though.
Current version of shr.el don't fill the text at all and I don't know
maybe smb likes it and won't welcome the change (see pics), although ERC
fills text for example.
^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2018-08-10 0:12 UTC | newest]
Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-07-26 14:06 bug#32281: shr.el align support patch Bad Blue Bull
2018-08-06 2:52 ` Noam Postavsky
2018-08-06 15:13 ` Eli Zaretskii
2018-08-07 0:51 ` Bad Blue Bull
2018-08-07 0:59 ` Bad Blue Bull
2018-08-07 2:34 ` Noam Postavsky
2018-08-07 15:07 ` Eli Zaretskii
2018-08-07 16:54 ` Bad Blue Bull
2018-08-07 17:11 ` Bad Blue Bull
2018-08-07 17:19 ` Eli Zaretskii
2018-08-07 18:15 ` Bad Blue Bull
2018-08-07 18:15 ` Lars Ingebrigtsen
2018-08-07 19:56 ` Bad Blue Bull
2018-08-10 0:12 ` Noam Postavsky
2018-08-06 17:36 ` Noam Postavsky
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
![[-- Attachment #2: test.jpg --] [-- Type: image/jpeg, Size: 133083 bytes --]](../../2042111533660898@iva4-406defa25fee.qloud-c.yandex.net/2-test.jpg){kind=link}
![[-- Attachment #3: test_ff.jpg --] [-- Type: image/jpeg, Size: 147212 bytes --]](../../2042111533660898@iva4-406defa25fee.qloud-c.yandex.net/3-test_ff.jpg){kind=link}