shr table rendering touch-ups
[bpt/emacs.git] / lisp / net / shr.el
CommitLineData
367f7f81
LMI
1;;; shr.el --- Simple HTML Renderer
2
ab422c4d 3;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
367f7f81
LMI
4
5;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6;; Keywords: html
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software: you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
12;; the Free Software Foundation, either version 3 of the License, or
13;; (at your option) any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22
23;;; Commentary:
24
25;; This package takes a HTML parse tree (as provided by
26;; libxml-parse-html-region) and renders it in the current buffer. It
27;; does not do CSS, JavaScript or anything advanced: It's geared
28;; towards rendering typical short snippets of HTML, like what you'd
29;; find in HTML email and the like.
30
31;;; Code:
32
3d319c8f 33(eval-when-compile (require 'cl))
7545bd25 34(eval-when-compile (require 'url)) ;For url-filename's setf handler.
71e691a5
G
35(require 'browse-url)
36
870409d4
G
37(defgroup shr nil
38 "Simple HTML Renderer"
2bed3f04 39 :version "24.1"
0ebd92a3 40 :group 'hypermedia)
870409d4
G
41
42(defcustom shr-max-image-proportion 0.9
43 "How big pictures displayed are in relation to the window they're in.
44A value of 0.7 means that they are allowed to take up 70% of the
45width and height of the window. If they are larger than this,
46and Emacs supports it, then the images will be rescaled down to
47fit these criteria."
48 :version "24.1"
49 :group 'shr
50 :type 'float)
51
52(defcustom shr-blocked-images nil
53 "Images that have URLs matching this regexp will be blocked."
54 :version "24.1"
55 :group 'shr
a931698a 56 :type '(choice (const nil) regexp))
870409d4 57
924d6997
G
58(defcustom shr-table-horizontal-line nil
59 "Character used to draw horizontal table lines.
60If nil, don't draw horizontal table lines."
d3098750
LMI
61 :group 'shr
62 :type 'character)
63
e37df674 64(defcustom shr-table-vertical-line ?\s
d3098750 65 "Character used to draw vertical table lines."
afba0c4b 66 :group 'shr
030158f3 67 :type 'character)
afba0c4b 68
e37df674 69(defcustom shr-table-corner ?\s
d3098750 70 "Character used to draw table corners."
6b7df8d3 71 :group 'shr
030158f3 72 :type 'character)
6b7df8d3
G
73
74(defcustom shr-hr-line ?-
d3098750 75 "Character used to draw hr lines."
afba0c4b 76 :group 'shr
030158f3 77 :type 'character)
afba0c4b 78
d0e0de31 79(defcustom shr-width fill-column
bb7f5cbc
G
80 "Frame width to use for rendering.
81May either be an integer specifying a fixed width in characters,
82or nil, meaning that the full width of the window should be
83used."
84 :type '(choice (integer :tag "Fixed width in characters")
85 (const :tag "Use the width of the window" nil))
d0e0de31
JD
86 :group 'shr)
87
c74cb344
G
88(defcustom shr-bullet "* "
89 "Bullet used for unordered lists.
90Alternative suggestions are:
91- \" \"
92- \" \""
93 :type 'string
94 :group 'shr)
95
0ebd92a3
LMI
96(defcustom shr-external-browser 'browse-url-default-browser
97 "Function used to launch an external browser."
98 :version "24.4"
99 :group 'shr
100 :type 'function)
101
130e977f
LMI
102(defvar shr-content-function nil
103 "If bound, this should be a function that will return the content.
104This is used for cid: URLs, and the function is called with the
105cid: URL as the argument.")
106
b9bdaf74
KY
107(defvar shr-put-image-function 'shr-put-image
108 "Function called to put image and alt string.")
109
6eee2678
LMI
110(defface shr-strike-through '((t (:strike-through t)))
111 "Font for <s> elements."
112 :group 'shr)
113
f8774e35 114(defface shr-link
7ef1d634 115 '((t (:inherit link)))
df26ce09 116 "Font for link elements."
c2f51e23
G
117 :group 'shr)
118
66627fa9
G
119;;; Internal variables.
120
870409d4
G
121(defvar shr-folding-mode nil)
122(defvar shr-state nil)
123(defvar shr-start nil)
a41c2e6d 124(defvar shr-indentation 0)
130e977f 125(defvar shr-inhibit-images nil)
66627fa9 126(defvar shr-list-mode nil)
3d319c8f 127(defvar shr-content-cache nil)
83ffd571 128(defvar shr-kinsoku-shorten nil)
99e65b2d 129(defvar shr-table-depth 0)
04db63bc 130(defvar shr-stylesheet nil)
dbd5ffad 131(defvar shr-base nil)
728518c3 132(defvar shr-ignore-cache nil)
2644071e 133(defvar shr-external-rendering-functions nil)
c74cb344 134(defvar shr-target-id nil)
be2aa135 135(defvar shr-inhibit-decoration nil)
924d6997 136(defvar shr-table-separator-length 1)
870409d4 137
71e691a5
G
138(defvar shr-map
139 (let ((map (make-sparse-keymap)))
140 (define-key map "a" 'shr-show-alt-text)
141 (define-key map "i" 'shr-browse-image)
89b163db 142 (define-key map "z" 'shr-zoom-image)
7304e4dd
LMI
143 (define-key map [tab] 'shr-next-link)
144 (define-key map [backtab] 'shr-previous-link)
970ad972 145 (define-key map [follow-link] 'mouse-face)
1211de50 146 (define-key map [mouse-2] 'shr-browse-url)
71e691a5 147 (define-key map "I" 'shr-insert-image)
16f74f10 148 (define-key map "w" 'shr-copy-url)
2d756ae0 149 (define-key map "u" 'shr-copy-url)
71e691a5 150 (define-key map "v" 'shr-browse-url)
cdf1fca4 151 (define-key map "o" 'shr-save-contents)
71e691a5
G
152 (define-key map "\r" 'shr-browse-url)
153 map))
154
66627fa9 155;; Public functions and commands.
0143b8a3
GM
156(declare-function libxml-parse-html-region "xml.c"
157 (start end &optional base-url))
66627fa9 158
7b953864
SM
159(defun shr-render-buffer (buffer)
160 "Display the HTML rendering of the current buffer."
161 (interactive (list (current-buffer)))
0143b8a3
GM
162 (or (fboundp 'libxml-parse-html-region)
163 (error "This function requires Emacs to be compiled with libxml2"))
1518e4f0
G
164 (pop-to-buffer "*html*")
165 (erase-buffer)
166 (shr-insert-document
7b953864 167 (with-current-buffer buffer
edd9679c
LMI
168 (libxml-parse-html-region (point-min) (point-max))))
169 (goto-char (point-min)))
1518e4f0 170
eadb6068
IK
171(defun shr-render-region (begin end &optional buffer)
172 "Display the HTML rendering of the region between BEGIN and END."
173 (interactive "r")
174 (unless (fboundp 'libxml-parse-html-region)
175 (error "This function requires Emacs to be compiled with libxml2"))
176 (with-current-buffer (or buffer (current-buffer))
177 (let ((dom (libxml-parse-html-region begin end)))
178 (delete-region begin end)
179 (goto-char begin)
180 (shr-insert-document dom))))
181
7b953864
SM
182(defun shr-visit-file (file)
183 "Parse FILE as an HTML document, and render it in a new buffer."
184 (interactive "fHTML file name: ")
185 (with-temp-buffer
186 (insert-file-contents file)
187 (shr-render-buffer (current-buffer))))
188
66627fa9
G
189;;;###autoload
190(defun shr-insert-document (dom)
9ed5a258
LI
191 "Render the parsed document DOM into the current buffer.
192DOM should be a parse tree as generated by
193`libxml-parse-html-region' or similar."
3d319c8f 194 (setq shr-content-cache nil)
9ed5a258
LI
195 (let ((start (point))
196 (shr-state nil)
bb7f5cbc 197 (shr-start nil)
dbd5ffad 198 (shr-base nil)
4452891d 199 (shr-preliminary-table-render 0)
924d6997 200 (shr-width (or shr-width (1- (window-width)))))
9ed5a258
LI
201 (shr-descend (shr-transform-dom dom))
202 (shr-remove-trailing-whitespace start (point))))
203
204(defun shr-remove-trailing-whitespace (start end)
7c4bbb69
LI
205 (let ((width (window-width)))
206 (save-restriction
207 (narrow-to-region start end)
208 (goto-char start)
209 (while (not (eobp))
210 (end-of-line)
888ab661 211 (when (> (shr-previous-newline-padding-width (current-column)) width)
7c4bbb69
LI
212 (dolist (overlay (overlays-at (point)))
213 (when (overlay-get overlay 'before-string)
214 (overlay-put overlay 'before-string nil))))
215 (forward-line 1)))))
66627fa9
G
216
217(defun shr-copy-url ()
218 "Copy the URL under point to the kill ring.
219If called twice, then try to fetch the URL and see whether it
220redirects somewhere else."
221 (interactive)
222 (let ((url (get-text-property (point) 'shr-url)))
223 (cond
224 ((not url)
225 (message "No URL under point"))
226 ;; Resolve redirected URLs.
227 ((equal url (car kill-ring))
228 (url-retrieve
229 url
230 (lambda (a)
231 (when (and (consp a)
232 (eq (car a) :redirect))
233 (with-temp-buffer
234 (insert (cadr a))
235 (goto-char (point-min))
236 ;; Remove common tracking junk from the URL.
237 (when (re-search-forward ".utm_.*" nil t)
238 (replace-match "" t t))
239 (message "Copied %s" (buffer-string))
038b3495
LI
240 (copy-region-as-kill (point-min) (point-max)))))
241 nil t))
66627fa9
G
242 ;; Copy the URL to the kill ring.
243 (t
244 (with-temp-buffer
245 (insert url)
246 (copy-region-as-kill (point-min) (point-max))
247 (message "Copied %s" url))))))
248
7304e4dd
LMI
249(defun shr-next-link ()
250 "Skip to the next link."
251 (interactive)
be2aa135 252 (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
7304e4dd 253 (if (not (setq skip (text-property-not-all skip (point-max)
be2aa135 254 'help-echo nil)))
7304e4dd
LMI
255 (message "No next link")
256 (goto-char skip)
257 (message "%s" (get-text-property (point) 'help-echo)))))
258
259(defun shr-previous-link ()
260 "Skip to the previous link."
261 (interactive)
262 (let ((start (point))
263 (found nil))
264 ;; Skip past the current link.
265 (while (and (not (bobp))
be2aa135 266 (get-text-property (point) 'help-echo))
7304e4dd
LMI
267 (forward-char -1))
268 ;; Find the previous link.
269 (while (and (not (bobp))
be2aa135 270 (not (setq found (get-text-property (point) 'help-echo))))
7304e4dd
LMI
271 (forward-char -1))
272 (if (not found)
273 (progn
274 (message "No previous link")
275 (goto-char start))
276 ;; Put point at the start of the link.
277 (while (and (not (bobp))
be2aa135 278 (get-text-property (point) 'help-echo))
7304e4dd
LMI
279 (forward-char -1))
280 (forward-char 1)
281 (message "%s" (get-text-property (point) 'help-echo)))))
282
66627fa9
G
283(defun shr-show-alt-text ()
284 "Show the ALT text of the image under point."
285 (interactive)
286 (let ((text (get-text-property (point) 'shr-alt)))
287 (if (not text)
288 (message "No image under point")
289 (message "%s" text))))
290
2da9c605
G
291(defun shr-browse-image (&optional copy-url)
292 "Browse the image under point.
293If COPY-URL (the prefix if called interactively) is non-nil, copy
294the URL of the image to the kill buffer instead."
295 (interactive "P")
8b6f6573 296 (let ((url (get-text-property (point) 'image-url)))
2da9c605
G
297 (cond
298 ((not url)
299 (message "No image under point"))
300 (copy-url
301 (with-temp-buffer
302 (insert url)
303 (copy-region-as-kill (point-min) (point-max))
304 (message "Copied %s" url)))
305 (t
66627fa9 306 (message "Browsing %s..." url)
2da9c605 307 (browse-url url)))))
66627fa9 308
3d319c8f
LMI
309(defun shr-insert-image ()
310 "Insert the image under point into the buffer."
311 (interactive)
8b6f6573 312 (let ((url (get-text-property (point) 'image-url)))
3d319c8f
LMI
313 (if (not url)
314 (message "No image under point")
315 (message "Inserting %s..." url)
316 (url-retrieve url 'shr-image-fetched
317 (list (current-buffer) (1- (point)) (point-marker))
038b3495 318 t t))))
3d319c8f 319
89b163db
G
320(defun shr-zoom-image ()
321 "Toggle the image size.
322The size will be rotated between the default size, the original
323size, and full-buffer size."
324 (interactive)
325 (let ((url (get-text-property (point) 'image-url))
326 (size (get-text-property (point) 'image-size))
327 (buffer-read-only nil))
328 (if (not url)
329 (message "No image under point")
330 ;; Delete the old picture.
331 (while (get-text-property (point) 'image-url)
332 (forward-char -1))
333 (forward-char 1)
334 (let ((start (point)))
335 (while (get-text-property (point) 'image-url)
336 (forward-char 1))
337 (forward-char -1)
338 (put-text-property start (point) 'display nil)
339 (when (> (- (point) start) 2)
340 (delete-region start (1- (point)))))
341 (message "Inserting %s..." url)
342 (url-retrieve url 'shr-image-fetched
343 (list (current-buffer) (1- (point)) (point-marker)
344 (list (cons 'size
345 (cond ((or (eq size 'default)
346 (null size))
347 'original)
348 ((eq size 'original)
349 'full)
350 ((eq size 'full)
351 'default)))))
352 t))))
353
66627fa9
G
354;;; Utility functions.
355
870409d4
G
356(defun shr-transform-dom (dom)
357 (let ((result (list (pop dom))))
358 (dolist (arg (pop dom))
359 (push (cons (intern (concat ":" (symbol-name (car arg))) obarray)
360 (cdr arg))
361 result))
362 (dolist (sub dom)
363 (if (stringp sub)
953d41c4 364 (push (cons 'text sub) result)
870409d4
G
365 (push (shr-transform-dom sub) result)))
366 (nreverse result)))
367
870409d4 368(defun shr-descend (dom)
2644071e
LMI
369 (let ((function
370 (or
371 ;; Allow other packages to override (or provide) rendering
372 ;; of elements.
373 (cdr (assq (car dom) shr-external-rendering-functions))
374 (intern (concat "shr-tag-" (symbol-name (car dom))) obarray)))
ebe79557 375 (style (cdr (assq :style (cdr dom))))
04db63bc 376 (shr-stylesheet shr-stylesheet)
ebe79557 377 (start (point)))
b31b26b4 378 (when style
be2aa135 379 (if (string-match "color\\|display\\|border-collapse" style)
b31b26b4
G
380 (setq shr-stylesheet (nconc (shr-parse-style style)
381 shr-stylesheet))
382 (setq style nil)))
c74cb344
G
383 ;; If we have a display:none, then just ignore this part of the
384 ;; DOM.
385 (unless (equal (cdr (assq 'display shr-stylesheet)) "none")
386 (if (fboundp function)
387 (funcall function (cdr dom))
388 (shr-generic (cdr dom)))
389 (when (and shr-target-id
390 (equal (cdr (assq :id (cdr dom))) shr-target-id))
391 (put-text-property start (1+ start) 'shr-target-id shr-target-id))
392 ;; If style is set, then this node has set the color.
393 (when style
394 (shr-colorize-region start (point)
395 (cdr (assq 'color shr-stylesheet))
396 (cdr (assq 'background-color shr-stylesheet)))))))
870409d4
G
397
398(defun shr-generic (cont)
399 (dolist (sub cont)
400 (cond
953d41c4 401 ((eq (car sub) 'text)
870409d4 402 (shr-insert (cdr sub)))
a41c2e6d 403 ((listp (cdr sub))
870409d4
G
404 (shr-descend sub)))))
405
ed797193
G
406(defmacro shr-char-breakable-p (char)
407 "Return non-nil if a line can be broken before and after CHAR."
408 `(aref fill-find-break-point-function-table ,char))
409(defmacro shr-char-nospace-p (char)
410 "Return non-nil if no space is required before and after CHAR."
411 `(aref fill-nospace-between-words-table ,char))
412
413;; KINSOKU is a Japanese word meaning a rule that should not be violated.
414;; In Emacs, it is a term used for characters, e.g. punctuation marks,
415;; parentheses, and so on, that should not be placed in the beginning
416;; of a line or the end of a line.
417(defmacro shr-char-kinsoku-bol-p (char)
418 "Return non-nil if a line ought not to begin with CHAR."
419 `(aref (char-category-set ,char) ?>))
420(defmacro shr-char-kinsoku-eol-p (char)
421 "Return non-nil if a line ought not to end with CHAR."
422 `(aref (char-category-set ,char) ?<))
423(unless (shr-char-kinsoku-bol-p (make-char 'japanese-jisx0208 33 35))
424 (load "kinsoku" nil t))
425
66627fa9 426(defun shr-insert (text)
6b7df8d3 427 (when (and (eq shr-state 'image)
89b163db 428 (not (bolp))
6b7df8d3 429 (not (string-match "\\`[ \t\n]+\\'" text)))
66627fa9
G
430 (insert "\n")
431 (setq shr-state nil))
432 (cond
433 ((eq shr-folding-mode 'none)
434 (insert text))
435 (t
c38e0c97 436 (when (and (string-match "\\`[ \t\n ]" text)
73db8b08
KY
437 (not (bolp))
438 (not (eq (char-after (1- (point))) ? )))
439 (insert " "))
c38e0c97 440 (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
73db8b08
KY
441 (when (and (bolp)
442 (> shr-indentation 0))
443 (shr-indent))
73db8b08 444 ;; No space is needed behind a wide character categorized as
b41c2f65
KY
445 ;; kinsoku-bol, between characters both categorized as nospace,
446 ;; or at the beginning of a line.
73db8b08 447 (let (prev)
48ba8195
KY
448 (when (and (> (current-column) shr-indentation)
449 (eq (preceding-char) ? )
20438017 450 (or (= (line-beginning-position) (1- (point)))
ed797193
G
451 (and (shr-char-breakable-p
452 (setq prev (char-after (- (point) 2))))
453 (shr-char-kinsoku-bol-p prev))
454 (and (shr-char-nospace-p prev)
455 (shr-char-nospace-p (aref elem 0)))))
73db8b08 456 (delete-char -1)))
48ba8195
KY
457 ;; The shr-start is a special variable that is used to pass
458 ;; upwards the first point in the buffer where the text really
459 ;; starts.
460 (unless shr-start
461 (setq shr-start (point)))
73db8b08 462 (insert elem)
e76917e6 463 (setq shr-state nil)
e7102c0a
KY
464 (let (found)
465 (while (and (> (current-column) shr-width)
466 (progn
467 (setq found (shr-find-fill-point))
b40950bf 468 (not (eolp))))
fe98a42f
KY
469 (when (eq (preceding-char) ? )
470 (delete-char -1))
471 (insert "\n")
472 (unless found
e7102c0a
KY
473 ;; No space is needed at the beginning of a line.
474 (when (eq (following-char) ? )
475 (delete-char 1)))
476 (when (> shr-indentation 0)
477 (shr-indent))
478 (end-of-line))
479 (insert " ")))
c38e0c97 480 (unless (string-match "[ \t\r\n ]\\'" text)
73db8b08 481 (delete-char -1)))))
66627fa9 482
6b7df8d3 483(defun shr-find-fill-point ()
83ffd571
KY
484 (when (> (move-to-column shr-width) shr-width)
485 (backward-char 1))
ed797193
G
486 (let ((bp (point))
487 failed)
488 (while (not (or (setq failed (= (current-column) shr-indentation))
489 (eq (preceding-char) ? )
490 (eq (following-char) ? )
491 (shr-char-breakable-p (preceding-char))
492 (shr-char-breakable-p (following-char))
7454326a
G
493 (if (eq (preceding-char) ?')
494 (not (memq (char-after (- (point) 2))
495 (list nil ?\n ? )))
7454326a 496 (and (shr-char-kinsoku-bol-p (preceding-char))
6568edea 497 (shr-char-breakable-p (following-char))
7454326a 498 (not (shr-char-kinsoku-bol-p (following-char)))))
ed797193 499 (shr-char-kinsoku-eol-p (following-char))))
83ffd571 500 (backward-char 1))
ed797193
G
501 (if (and (not (or failed (eolp)))
502 (eq (preceding-char) ?'))
503 (while (not (or (setq failed (eolp))
504 (eq (following-char) ? )
505 (shr-char-breakable-p (following-char))
506 (shr-char-kinsoku-eol-p (following-char))))
507 (forward-char 1)))
83ffd571 508 (if failed
20438017 509 ;; There's no breakable point, so we give it up.
ed797193
G
510 (let (found)
511 (goto-char bp)
512 (unless shr-kinsoku-shorten
513 (while (and (setq found (re-search-forward
514 "\\(\\c>\\)\\| \\|\\c<\\|\\c|"
515 (line-end-position) 'move))
516 (eq (preceding-char) ?')))
517 (if (and found (not (match-beginning 1)))
518 (goto-char (match-beginning 0)))))
b40950bf
KY
519 (or
520 (eolp)
ed797193
G
521 ;; Don't put kinsoku-bol characters at the beginning of a line,
522 ;; or kinsoku-eol characters at the end of a line.
523 (cond
524 (shr-kinsoku-shorten
525 (while (and (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
526 (shr-char-kinsoku-eol-p (preceding-char)))
527 (backward-char 1))
528 (when (setq failed (= (current-column) shr-indentation))
529 ;; There's no breakable point that doesn't violate kinsoku,
530 ;; so we look for the second best position.
531 (while (and (progn
532 (forward-char 1)
533 (<= (current-column) shr-width))
534 (progn
535 (setq bp (point))
536 (shr-char-kinsoku-eol-p (following-char)))))
537 (goto-char bp)))
538 ((shr-char-kinsoku-eol-p (preceding-char))
89b163db
G
539 ;; Find backward the point where kinsoku-eol characters begin.
540 (let ((count 4))
541 (while
542 (progn
543 (backward-char 1)
544 (and (> (setq count (1- count)) 0)
545 (not (memq (preceding-char) (list ?\C-@ ?\n ? )))
546 (or (shr-char-kinsoku-eol-p (preceding-char))
547 (shr-char-kinsoku-bol-p (following-char)))))))
548 (if (setq failed (= (current-column) shr-indentation))
549 ;; There's no breakable point that doesn't violate kinsoku,
550 ;; so we go to the second best position.
551 (if (looking-at "\\(\\c<+\\)\\c<")
552 (goto-char (match-end 1))
553 (forward-char 1))))
554 ((shr-char-kinsoku-bol-p (following-char))
555 ;; Find forward the point where kinsoku-bol characters end.
556 (let ((count 4))
557 (while (progn
558 (forward-char 1)
559 (and (>= (setq count (1- count)) 0)
ed797193 560 (shr-char-kinsoku-bol-p (following-char))
89b163db 561 (shr-char-breakable-p (following-char))))))))
ed797193
G
562 (when (eq (following-char) ? )
563 (forward-char 1))))
564 (not failed)))
6b7df8d3 565
c74cb344
G
566(defun shr-parse-base (url)
567 ;; Always chop off anchors.
568 (when (string-match "#.*" url)
569 (setq url (substring url 0 (match-beginning 0))))
570 (let* ((parsed (url-generic-parse-url url))
571 (local (url-filename parsed)))
572 (setf (url-filename parsed) "")
573 ;; Chop off the bit after the last slash.
574 (when (string-match "\\`\\(.*/\\)[^/]+\\'" local)
575 (setq local (match-string 1 local)))
576 ;; Always make the local bit end with a slash.
577 (when (and (not (zerop (length local)))
578 (not (eq (aref local (1- (length local))) ?/)))
579 (setq local (concat local "/")))
580 (list (url-recreate-url parsed)
581 local
582 (url-type parsed)
583 url)))
584
585(defun shr-expand-url (url &optional base)
586 (setq base
587 (if base
588 (shr-parse-base base)
589 ;; Bound by the parser.
590 shr-base))
591 (when (zerop (length url))
592 (setq url nil))
593 (cond ((or (not url)
594 (not base)
595 (string-match "\\`[a-z]*:" url))
596 ;; Absolute URL.
597 (or url (car base)))
598 ((eq (aref url 0) ?/)
599 (if (and (> (length url) 1)
600 (eq (aref url 1) ?/))
601 ;; //host...; just use the protocol
602 (concat (nth 2 base) ":" url)
603 ;; Just use the host name part.
604 (concat (car base) url)))
605 ((eq (aref url 0) ?#)
606 ;; A link to an anchor.
607 (concat (nth 3 base) url))
608 (t
609 ;; Totally relative.
610 (concat (car base) (cadr base) url))))
dbd5ffad 611
66627fa9
G
612(defun shr-ensure-newline ()
613 (unless (zerop (current-column))
614 (insert "\n")))
a41c2e6d
G
615
616(defun shr-ensure-paragraph ()
617 (unless (bobp)
f7aa248a 618 (if (<= (current-column) shr-indentation)
71e691a5
G
619 (unless (save-excursion
620 (forward-line -1)
621 (looking-at " *$"))
a41c2e6d
G
622 (insert "\n"))
623 (if (save-excursion
624 (beginning-of-line)
be2aa135
LMI
625 ;; If the current line is totally blank, and doesn't even
626 ;; have any face properties set, then delete the blank
627 ;; space.
628 (and (looking-at " *$")
629 (not (get-text-property (point) 'face))
630 (not (= (next-single-property-change (point) 'face nil
631 (line-end-position))
632 (line-end-position)))))
89b163db 633 (delete-region (match-beginning 0) (match-end 0))
a41c2e6d
G
634 (insert "\n\n")))))
635
66627fa9 636(defun shr-indent ()
f7aa248a
G
637 (when (> shr-indentation 0)
638 (insert (make-string shr-indentation ? ))))
870409d4 639
a41c2e6d 640(defun shr-fontize-cont (cont &rest types)
870409d4
G
641 (let (shr-start)
642 (shr-generic cont)
a41c2e6d
G
643 (dolist (type types)
644 (shr-add-font (or shr-start (point)) (point) type))))
870409d4 645
7304e4dd
LMI
646;; Add face to the region, but avoid putting the font properties on
647;; blank text at the start of the line, and the newline at the end, to
648;; avoid ugliness.
870409d4 649(defun shr-add-font (start end type)
be2aa135
LMI
650 (unless shr-inhibit-decoration
651 (save-excursion
652 (goto-char start)
653 (while (< (point) end)
654 (when (bolp)
655 (skip-chars-forward " "))
656 (add-face-text-property (point) (min (line-end-position) end) type t)
657 (if (< (line-end-position) end)
658 (forward-line 1)
659 (goto-char end))))))
870409d4 660
8ba8eec5
LMI
661(defun shr-mouse-browse-url (ev)
662 "Browse the URL under the mouse cursor."
663 (interactive "e")
664 (mouse-set-point ev)
665 (shr-browse-url))
666
1211de50 667(defun shr-browse-url (&optional external mouse-event)
bdaa086b
LMI
668 "Browse the URL under point.
669If EXTERNAL, browse the URL using `shr-external-browser'."
1211de50
LMI
670 (interactive (list current-prefix-arg last-nonmenu-event))
671 (mouse-set-point mouse-event)
71e691a5 672 (let ((url (get-text-property (point) 'shr-url)))
181cb5fb
G
673 (cond
674 ((not url)
675 (message "No link under point"))
676 ((string-match "^mailto:" url)
39ddff39 677 (browse-url-mail url))
181cb5fb 678 (t
bdaa086b
LMI
679 (if external
680 (funcall shr-external-browser url)
681 (browse-url url))))))
71e691a5 682
cdf1fca4
LMI
683(defun shr-save-contents (directory)
684 "Save the contents from URL in a file."
685 (interactive "DSave contents of URL to directory: ")
686 (let ((url (get-text-property (point) 'shr-url)))
687 (if (not url)
688 (message "No link under point")
689 (url-retrieve (shr-encode-url url)
038b3495
LI
690 'shr-store-contents (list url directory)
691 nil t))))
cdf1fca4
LMI
692
693(defun shr-store-contents (status url directory)
694 (unless (plist-get status :error)
695 (when (or (search-forward "\n\n" nil t)
696 (search-forward "\r\n\r\n" nil t))
697 (write-region (point) (point-max)
698 (expand-file-name (file-name-nondirectory url)
699 directory)))))
700
89b163db 701(defun shr-image-fetched (status buffer start end &optional flags)
0e2cebe5
LI
702 (let ((image-buffer (current-buffer)))
703 (when (and (buffer-name buffer)
704 (not (plist-get status :error)))
705 (url-store-in-cache image-buffer)
706 (when (or (search-forward "\n\n" nil t)
707 (search-forward "\r\n\r\n" nil t))
708 (let ((data (buffer-substring (point) (point-max))))
709 (with-current-buffer buffer
710 (save-excursion
711 (let ((alt (buffer-substring start end))
89b163db 712 (properties (text-properties-at start))
0e2cebe5
LI
713 (inhibit-read-only t))
714 (delete-region start end)
715 (goto-char start)
89b163db
G
716 (funcall shr-put-image-function data alt flags)
717 (while properties
718 (let ((type (pop properties))
719 (value (pop properties)))
720 (unless (memq type '(display image-size))
721 (put-text-property start (point) type value))))))))))
0e2cebe5 722 (kill-buffer image-buffer)))
870409d4 723
2250b351
DE
724(defun shr-image-from-data (data)
725 "Return an image from the data: URI content DATA."
726 (when (string-match
727 "\\(\\([^/;,]+\\(/[^;,]+\\)?\\)\\(;[^;,]+\\)*\\)?,\\(.*\\)"
728 data)
729 (let ((param (match-string 4 data))
730 (payload (url-unhex-string (match-string 5 data))))
731 (when (string-match "^.*\\(;[ \t]*base64\\)$" param)
732 (setq payload (base64-decode-string payload)))
733 payload)))
734
89b163db 735(defun shr-put-image (data alt &optional flags)
b9bdaf74 736 "Put image DATA with a string ALT. Return image."
4abff904 737 (if (display-graphic-p)
89b163db
G
738 (let* ((size (cdr (assq 'size flags)))
739 (start (point))
740 (image (cond
741 ((eq size 'original)
742 (create-image data nil t :ascent 100))
743 ((eq size 'full)
744 (ignore-errors
745 (shr-rescale-image data t)))
746 (t
747 (ignore-errors
748 (shr-rescale-image data))))))
4abff904 749 (when image
c0f9edce
G
750 ;; When inserting big-ish pictures, put them at the
751 ;; beginning of the line.
752 (when (and (> (current-column) 0)
753 (> (car (image-size image t)) 400))
754 (insert "\n"))
89b163db 755 (if (eq size 'original)
7304e4dd 756 (insert-sliced-image image (or alt "*") nil 20 1)
89b163db
G
757 (insert-image image (or alt "*")))
758 (put-text-property start (point) 'image-size size)
dd8620de
GM
759 (when (cond ((fboundp 'image-multi-frame-p)
760 ;; Only animate multi-frame things that specify a
761 ;; delay; eg animated gifs as opposed to
762 ;; multi-page tiffs. FIXME?
763 (cdr (image-multi-frame-p image)))
764 ((fboundp 'image-animated-p)
765 (image-animated-p image)))
c146ad85 766 (image-animate image nil 60)))
b9bdaf74 767 image)
99e65b2d 768 (insert alt)))
870409d4 769
89b163db
G
770(defun shr-rescale-image (data &optional force)
771 "Rescale DATA, if too big, to fit the current buffer.
772If FORCE, rescale the image anyway."
f3f9606c 773 (if (or (not (fboundp 'imagemagick-types))
2fae38e5 774 (eq (image-type-from-data data) 'gif)
f3f9606c
LMI
775 (not (get-buffer-window (current-buffer))))
776 (create-image data nil t :ascent 100)
777 (let ((edges (window-inside-pixel-edges
778 (get-buffer-window (current-buffer)))))
779 (create-image
780 data 'imagemagick t
781 :ascent 100
782 :max-width (truncate (* shr-max-image-proportion
783 (- (nth 2 edges) (nth 0 edges))))
784 :max-height (truncate (* shr-max-image-proportion
785 (- (nth 3 edges) (nth 1 edges))))))))
870409d4 786
85a45a69
GM
787;; url-cache-extract autoloads url-cache.
788(declare-function url-cache-create-filename "url-cache" (url))
789(autoload 'mm-disable-multibyte "mm-util")
39ddff39 790(autoload 'browse-url-mail "browse-url")
85a45a69 791
870409d4
G
792(defun shr-get-image-data (url)
793 "Get image data for URL.
794Return a string with image data."
795 (with-temp-buffer
796 (mm-disable-multibyte)
71e691a5 797 (when (ignore-errors
ab67634f 798 (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
71e691a5
G
799 t)
800 (when (or (search-forward "\n\n" nil t)
801 (search-forward "\r\n\r\n" nil t))
802 (buffer-substring (point) (point-max))))))
870409d4 803
40de2c6d
KY
804(defun shr-image-displayer (content-function)
805 "Return a function to display an image.
806CONTENT-FUNCTION is a function to retrieve an image for a cid url that
807is an argument. The function to be returned takes three arguments URL,
53964682 808START, and END. Note that START and END should be markers."
40de2c6d 809 `(lambda (url start end)
f8d8a97b
KY
810 (when url
811 (if (string-match "\\`cid:" url)
812 ,(when content-function
813 `(let ((image (funcall ,content-function
814 (substring url (match-end 0)))))
815 (when image
816 (goto-char start)
b9bdaf74 817 (funcall shr-put-image-function
195b2593 818 image (buffer-substring start end))
e2d0ba98 819 (delete-region (point) end))))
f8d8a97b
KY
820 (url-retrieve url 'shr-image-fetched
821 (list (current-buffer) start end)
038b3495 822 t t)))))
40de2c6d 823
66627fa9
G
824(defun shr-heading (cont &rest types)
825 (shr-ensure-paragraph)
826 (apply #'shr-fontize-cont cont types)
827 (shr-ensure-paragraph))
828
04db63bc 829(defun shr-urlify (start url &optional title)
be2aa135 830 (when (and title (string-match "ctx" title)) (debug))
ca3cf0a5 831 (shr-add-font start (point) 'shr-link)
7304e4dd
LMI
832 (add-text-properties
833 start (point)
834 (list 'shr-url url
be2aa135 835 'help-echo (if title (format "%s (%s)" url title) url)
d50fceab 836 'follow-link t
5a2a7735 837 'mouse-face 'highlight
970ad972 838 'keymap shr-map)))
de635afe
G
839
840(defun shr-encode-url (url)
841 "Encode URL."
842 (browse-url-url-encode-chars url "[)$ ]"))
843
ebe79557
LMI
844(autoload 'shr-color-visible "shr-color")
845(autoload 'shr-color->hexadecimal "shr-color")
144b7b5c
G
846
847(defun shr-color-check (fg bg)
848 "Check that FG is visible on BG.
849Returns (fg bg) with corrected values.
850Returns nil if the colors that would be used are the default
851ones, in case fg and bg are nil."
852 (when (or fg bg)
853 (let ((fixed (cond ((null fg) 'fg)
854 ((null bg) 'bg))))
855 ;; Convert colors to hexadecimal, or set them to default.
856 (let ((fg (or (shr-color->hexadecimal fg)
857 (frame-parameter nil 'foreground-color)))
858 (bg (or (shr-color->hexadecimal bg)
859 (frame-parameter nil 'background-color))))
860 (cond ((eq fixed 'bg)
861 ;; Only return the new fg
862 (list nil (cadr (shr-color-visible bg fg t))))
863 ((eq fixed 'fg)
864 ;; Invert args and results and return only the new bg
865 (list (cadr (shr-color-visible fg bg t)) nil))
866 (t
867 (shr-color-visible bg fg)))))))
868
04db63bc 869(defun shr-colorize-region (start end fg &optional bg)
be2aa135
LMI
870 (when (and (not shr-inhibit-decoration)
871 (or fg bg))
04db63bc 872 (let ((new-colors (shr-color-check fg bg)))
144b7b5c 873 (when new-colors
60568d74 874 (when fg
be2aa135
LMI
875 (add-face-text-property start end
876 (list :foreground (cadr new-colors))
877 t))
04db63bc 878 (when bg
be2aa135
LMI
879 (add-face-text-property start end
880 (list :background (car new-colors))
881 t)))
ec72bf63 882 new-colors)))
04db63bc 883
c5ecc769
G
884(defun shr-expand-newlines (start end color)
885 (save-restriction
d709b79a
LI
886 ;; Skip past all white space at the start and ends.
887 (goto-char start)
888 (skip-chars-forward " \t\n")
889 (beginning-of-line)
890 (setq start (point))
891 (goto-char end)
892 (skip-chars-backward " \t\n")
893 (forward-line 1)
894 (setq end (point))
c5ecc769 895 (narrow-to-region start end)
160ae063 896 (let ((width (shr-buffer-width))
c5ecc769
G
897 column)
898 (goto-char (point-min))
899 (while (not (eobp))
900 (end-of-line)
19e0dbe0
KY
901 (when (and (< (setq column (current-column)) width)
902 (< (setq column (shr-previous-newline-padding-width column))
d709b79a 903 width))
7304e4dd 904 (let ((overlay (make-overlay (point) (1+ (point)))))
c5ecc769 905 (overlay-put overlay 'before-string
d709b79a
LI
906 (concat
907 (mapconcat
908 (lambda (overlay)
14596870
KY
909 (let ((string (plist-get
910 (overlay-properties overlay)
911 'before-string)))
d709b79a
LI
912 (if (not string)
913 ""
914 (overlay-put overlay 'before-string "")
915 string)))
916 (overlays-at (point))
917 "")
19e0dbe0 918 (propertize (make-string (- width column) ? )
d709b79a 919 'face (list :background color))))))
c5ecc769 920 (forward-line 1)))))
04db63bc 921
d709b79a
LI
922(defun shr-previous-newline-padding-width (width)
923 (let ((overlays (overlays-at (point)))
924 (previous-width 0))
925 (if (null overlays)
926 width
927 (dolist (overlay overlays)
928 (setq previous-width
929 (+ previous-width
14596870
KY
930 (length (plist-get (overlay-properties overlay)
931 'before-string)))))
d709b79a
LI
932 (+ width previous-width))))
933
66627fa9
G
934;;; Tag-specific rendering rules.
935
144b7b5c 936(defun shr-tag-body (cont)
04db63bc 937 (let* ((start (point))
af4e5f4c
G
938 (fgcolor (cdr (or (assq :fgcolor cont)
939 (assq :text cont))))
04db63bc 940 (bgcolor (cdr (assq :bgcolor cont)))
b31b26b4
G
941 (shr-stylesheet (list (cons 'color fgcolor)
942 (cons 'background-color bgcolor))))
144b7b5c 943 (shr-generic cont)
04db63bc 944 (shr-colorize-region start (point) fgcolor bgcolor)))
144b7b5c 945
b31b26b4
G
946(defun shr-tag-style (cont)
947 )
948
f73341e2
LMI
949(defun shr-tag-script (cont)
950 )
951
fb1b0ef6
LMI
952(defun shr-tag-comment (cont)
953 )
954
c74cb344
G
955(defun shr-dom-to-xml (dom)
956 "Convert DOM into a string containing the xml representation."
957 (let ((arg " ")
958 (text ""))
959 (dolist (sub (cdr dom))
960 (cond
961 ((listp (cdr sub))
962 (setq text (concat text (shr-dom-to-xml sub))))
963 ((eq (car sub) 'text)
964 (setq text (concat text (cdr sub))))
965 (t
966 (setq arg (concat arg (format "%s=\"%s\" "
967 (substring (symbol-name (car sub)) 1)
968 (cdr sub)))))))
969 (format "<%s%s>%s</%s>"
970 (car dom)
971 (substring arg 0 (1- (length arg)))
972 text
973 (car dom))))
974
65e704b9 975(defun shr-tag-svg (cont)
c74cb344
G
976 (when (image-type-available-p 'svg)
977 (funcall shr-put-image-function
978 (shr-dom-to-xml (cons 'svg cont))
979 "SVG Image")))
65e704b9 980
a3af2929
LMI
981(defun shr-tag-sup (cont)
982 (let ((start (point)))
983 (shr-generic cont)
984 (put-text-property start (point) 'display '(raise 0.5))))
985
986(defun shr-tag-sub (cont)
987 (let ((start (point)))
988 (shr-generic cont)
989 (put-text-property start (point) 'display '(raise -0.5))))
990
7bafe9bc
LMI
991(defun shr-tag-label (cont)
992 (shr-generic cont)
993 (shr-ensure-paragraph))
994
66627fa9
G
995(defun shr-tag-p (cont)
996 (shr-ensure-paragraph)
f7aa248a 997 (shr-indent)
66627fa9
G
998 (shr-generic cont)
999 (shr-ensure-paragraph))
1000
036d93bc
KY
1001(defun shr-tag-div (cont)
1002 (shr-ensure-newline)
1003 (shr-indent)
1004 (shr-generic cont)
1005 (shr-ensure-newline))
1006
6eee2678
LMI
1007(defun shr-tag-s (cont)
1008 (shr-fontize-cont cont 'shr-strike-through))
1009
55385ebc
JD
1010(defun shr-tag-del (cont)
1011 (shr-fontize-cont cont 'shr-strike-through))
1012
66627fa9
G
1013(defun shr-tag-b (cont)
1014 (shr-fontize-cont cont 'bold))
1015
1016(defun shr-tag-i (cont)
1017 (shr-fontize-cont cont 'italic))
1018
1019(defun shr-tag-em (cont)
087d8265 1020 (shr-fontize-cont cont 'italic))
66627fa9 1021
530f7b67
LMI
1022(defun shr-tag-strong (cont)
1023 (shr-fontize-cont cont 'bold))
1024
66627fa9
G
1025(defun shr-tag-u (cont)
1026 (shr-fontize-cont cont 'underline))
1027
2e76c12c
LMI
1028(defun shr-parse-style (style)
1029 (when style
a2994808
JD
1030 (save-match-data
1031 (when (string-match "\n" style)
1032 (setq style (replace-match " " t t style))))
2e76c12c
LMI
1033 (let ((plist nil))
1034 (dolist (elem (split-string style ";"))
1035 (when elem
1036 (setq elem (split-string elem ":"))
1037 (when (and (car elem)
1038 (cadr elem))
1039 (let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
1040 (value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
144b7b5c
G
1041 (when (string-match " *!important\\'" value)
1042 (setq value (substring value 0 (match-beginning 0))))
2e76c12c
LMI
1043 (push (cons (intern name obarray)
1044 value)
1045 plist)))))
1046 plist)))
1047
dbd5ffad 1048(defun shr-tag-base (cont)
be2aa135
LMI
1049 (let ((base (cdr (assq :href cont))))
1050 (when base
1051 (setq shr-base (shr-parse-base base))))
266c63b5 1052 (shr-generic cont))
dbd5ffad 1053
66627fa9
G
1054(defun shr-tag-a (cont)
1055 (let ((url (cdr (assq :href cont)))
04db63bc 1056 (title (cdr (assq :title cont)))
66627fa9
G
1057 (start (point))
1058 shr-start)
1059 (shr-generic cont)
be2aa135
LMI
1060 (when (and url
1061 (not shr-inhibit-decoration))
cc21c235 1062 (shr-urlify (or shr-start start) (shr-expand-url url) title))))
de635afe
G
1063
1064(defun shr-tag-object (cont)
99e65b2d
G
1065 (let ((start (point))
1066 url)
1067 (dolist (elem cont)
1068 (when (eq (car elem) 'embed)
1069 (setq url (or url (cdr (assq :src (cdr elem))))))
1070 (when (and (eq (car elem) 'param)
1071 (equal (cdr (assq :name (cdr elem))) "movie"))
1072 (setq url (or url (cdr (assq :value (cdr elem)))))))
de635afe
G
1073 (when url
1074 (shr-insert " [multimedia] ")
dbd5ffad 1075 (shr-urlify start (shr-expand-url url)))
99e65b2d
G
1076 (shr-generic cont)))
1077
1078(defun shr-tag-video (cont)
1079 (let ((image (cdr (assq :poster cont)))
1080 (url (cdr (assq :src cont)))
1081 (start (point)))
1082 (shr-tag-img nil image)
dbd5ffad 1083 (shr-urlify start (shr-expand-url url))))
ab67634f 1084
99e65b2d
G
1085(defun shr-tag-img (cont &optional url)
1086 (when (or url
1087 (and cont
1088 (cdr (assq :src cont))))
68f6bd17
KY
1089 (when (and (> (current-column) 0)
1090 (not (eq shr-state 'image)))
1091 (insert "\n"))
1092 (let ((alt (cdr (assq :alt cont)))
dbd5ffad 1093 (url (shr-expand-url (or url (cdr (assq :src cont))))))
68f6bd17
KY
1094 (let ((start (point-marker)))
1095 (when (zerop (length alt))
953d41c4 1096 (setq alt "*"))
68f6bd17 1097 (cond
99e65b2d
G
1098 ((or (member (cdr (assq :height cont)) '("0" "1"))
1099 (member (cdr (assq :width cont)) '("0" "1")))
1100 ;; Ignore zero-sized or single-pixel images.
1101 )
2250b351
DE
1102 ((and (not shr-inhibit-images)
1103 (string-match "\\`data:" url))
1104 (let ((image (shr-image-from-data (substring url (match-end 0)))))
1105 (if image
1106 (funcall shr-put-image-function image alt)
1107 (insert alt))))
68f6bd17
KY
1108 ((and (not shr-inhibit-images)
1109 (string-match "\\`cid:" url))
1110 (let ((url (substring url (match-end 0)))
1111 image)
1112 (if (or (not shr-content-function)
1113 (not (setq image (funcall shr-content-function url))))
1114 (insert alt)
b9bdaf74 1115 (funcall shr-put-image-function image alt))))
68f6bd17
KY
1116 ((or shr-inhibit-images
1117 (and shr-blocked-images
1118 (string-match shr-blocked-images url)))
1119 (setq shr-start (point))
1120 (let ((shr-state 'space))
b354bc53
KY
1121 (if (> (string-width alt) 8)
1122 (shr-insert (truncate-string-to-width alt 8))
68f6bd17 1123 (shr-insert alt))))
728518c3
LMI
1124 ((and (not shr-ignore-cache)
1125 (url-is-cached (shr-encode-url url)))
b9bdaf74 1126 (funcall shr-put-image-function (shr-get-image-data url) alt))
68f6bd17 1127 (t
64522086 1128 (insert alt " ")
728518c3
LMI
1129 (when (and shr-ignore-cache
1130 (url-is-cached (shr-encode-url url)))
1131 (let ((file (url-cache-create-filename (shr-encode-url url))))
1132 (when (file-exists-p file)
1133 (delete-file file))))
038b3495 1134 (url-queue-retrieve
f3b146e9 1135 (shr-encode-url url) 'shr-image-fetched
64522086 1136 (list (current-buffer) start (set-marker (make-marker) (1- (point))))
038b3495 1137 t t)))
a959fc40
KY
1138 (when (zerop shr-table-depth) ;; We are not in a table.
1139 (put-text-property start (point) 'keymap shr-map)
1140 (put-text-property start (point) 'shr-alt alt)
1141 (put-text-property start (point) 'image-url url)
1142 (put-text-property start (point) 'image-displayer
1143 (shr-image-displayer shr-content-function))
1144 (put-text-property start (point) 'help-echo alt))
68f6bd17 1145 (setq shr-state 'image)))))
66627fa9
G
1146
1147(defun shr-tag-pre (cont)
1148 (let ((shr-folding-mode 'none))
1149 (shr-ensure-newline)
f7aa248a 1150 (shr-indent)
66627fa9
G
1151 (shr-generic cont)
1152 (shr-ensure-newline)))
1153
1154(defun shr-tag-blockquote (cont)
1155 (shr-ensure-paragraph)
f7aa248a 1156 (shr-indent)
66627fa9
G
1157 (let ((shr-indentation (+ shr-indentation 4)))
1158 (shr-generic cont))
1159 (shr-ensure-paragraph))
a41c2e6d 1160
d2aa9780
LMI
1161(defun shr-tag-dl (cont)
1162 (shr-ensure-paragraph)
1163 (shr-generic cont)
1164 (shr-ensure-paragraph))
1165
1166(defun shr-tag-dt (cont)
1167 (shr-ensure-newline)
1168 (shr-generic cont)
1169 (shr-ensure-newline))
1170
1171(defun shr-tag-dd (cont)
1172 (shr-ensure-newline)
1173 (let ((shr-indentation (+ shr-indentation 4)))
1174 (shr-generic cont)))
1175
a41c2e6d
G
1176(defun shr-tag-ul (cont)
1177 (shr-ensure-paragraph)
1178 (let ((shr-list-mode 'ul))
3d319c8f
LMI
1179 (shr-generic cont))
1180 (shr-ensure-paragraph))
a41c2e6d
G
1181
1182(defun shr-tag-ol (cont)
3d319c8f 1183 (shr-ensure-paragraph)
a41c2e6d 1184 (let ((shr-list-mode 1))
3d319c8f
LMI
1185 (shr-generic cont))
1186 (shr-ensure-paragraph))
a41c2e6d
G
1187
1188(defun shr-tag-li (cont)
c74cb344 1189 (shr-ensure-newline)
f7aa248a 1190 (shr-indent)
8028ed5c
LMI
1191 (let* ((bullet
1192 (if (numberp shr-list-mode)
1193 (prog1
1194 (format "%d " shr-list-mode)
1195 (setq shr-list-mode (1+ shr-list-mode)))
c74cb344 1196 shr-bullet))
8028ed5c
LMI
1197 (shr-indentation (+ shr-indentation (length bullet))))
1198 (insert bullet)
1199 (shr-generic cont)))
a41c2e6d
G
1200
1201(defun shr-tag-br (cont)
89b163db
G
1202 (when (and (not (bobp))
1203 ;; Only add a newline if we break the current line, or
1204 ;; the previous line isn't a blank line.
1205 (or (not (bolp))
1206 (and (> (- (point) 2) (point-min))
1207 (not (= (char-after (- (point) 2)) ?\n)))))
f7aa248a
G
1208 (insert "\n")
1209 (shr-indent))
a41c2e6d
G
1210 (shr-generic cont))
1211
308c9d24 1212(defun shr-tag-span (cont)
be2aa135 1213 (shr-generic cont))
308c9d24 1214
a41c2e6d 1215(defun shr-tag-h1 (cont)
e4dbdb09 1216 (shr-heading cont 'bold 'underline))
a41c2e6d
G
1217
1218(defun shr-tag-h2 (cont)
e4dbdb09 1219 (shr-heading cont 'bold))
a41c2e6d
G
1220
1221(defun shr-tag-h3 (cont)
e4dbdb09 1222 (shr-heading cont 'italic))
a41c2e6d
G
1223
1224(defun shr-tag-h4 (cont)
e4dbdb09 1225 (shr-heading cont))
a41c2e6d
G
1226
1227(defun shr-tag-h5 (cont)
e4dbdb09 1228 (shr-heading cont))
a41c2e6d
G
1229
1230(defun shr-tag-h6 (cont)
e4dbdb09 1231 (shr-heading cont))
a41c2e6d 1232
3d319c8f
LMI
1233(defun shr-tag-hr (cont)
1234 (shr-ensure-newline)
6b7df8d3 1235 (insert (make-string shr-width shr-hr-line) "\n"))
3d319c8f 1236
144b7b5c
G
1237(defun shr-tag-title (cont)
1238 (shr-heading cont 'bold 'underline))
1239
1110d53b 1240(defun shr-tag-font (cont)
b31b26b4
G
1241 (let* ((start (point))
1242 (color (cdr (assq :color cont)))
1243 (shr-stylesheet (nconc (list (cons 'color color))
1244 shr-stylesheet)))
1110d53b 1245 (shr-generic cont)
b31b26b4
G
1246 (when color
1247 (shr-colorize-region start (point) color
1248 (cdr (assq 'background-color shr-stylesheet))))))
1110d53b 1249
66627fa9 1250;;; Table rendering algorithm.
a41c2e6d 1251
a0ec382a
LMI
1252;; Table rendering is the only complicated thing here. We do this by
1253;; first counting how many TDs there are in each TR, and registering
1254;; how wide they think they should be ("width=45%", etc). Then we
1255;; render each TD separately (this is done in temporary buffers, so
1256;; that we can use all the rendering machinery as if we were in the
1257;; main buffer). Now we know how much space each TD really takes, so
1258;; we then render everything again with the new widths, and finally
1259;; insert all these boxes into the main buffer.
6c769311 1260(defun shr-tag-table-1 (cont)
71e691a5
G
1261 (setq cont (or (cdr (assq 'tbody cont))
1262 cont))
130e977f 1263 (let* ((shr-inhibit-images t)
99e65b2d 1264 (shr-table-depth (1+ shr-table-depth))
83ffd571 1265 (shr-kinsoku-shorten t)
a0ec382a 1266 ;; Find all suggested widths.
130e977f 1267 (columns (shr-column-specs cont))
a0ec382a 1268 ;; Compute how many characters wide each TD should be.
71e691a5 1269 (suggested-widths (shr-pro-rate-columns columns))
a0ec382a
LMI
1270 ;; Do a "test rendering" to see how big each TD is (this can
1271 ;; be smaller (if there's little text) or bigger (if there's
1272 ;; unbreakable text).
71e691a5 1273 (sketch (shr-make-table cont suggested-widths))
160ae063
LMI
1274 ;; Compute the "natural" width by setting each column to 500
1275 ;; characters and see how wide they really render.
1276 (natural (shr-make-table cont (make-vector (length columns) 500)))
1277 (sketch-widths (shr-table-widths sketch natural suggested-widths)))
030158f3 1278 ;; This probably won't work very well.
83ffd571
KY
1279 (when (> (+ (loop for width across sketch-widths
1280 summing (1+ width))
1281 shr-indentation 1)
030158f3
G
1282 (frame-width))
1283 (setq truncate-lines t))
a0ec382a 1284 ;; Then render the table again with these new "hard" widths.
f462d10a 1285 (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths)))
130e977f 1286
6c769311
KY
1287(defun shr-tag-table (cont)
1288 (shr-ensure-paragraph)
1289 (let* ((caption (cdr (assq 'caption cont)))
1290 (header (cdr (assq 'thead cont)))
1291 (body (or (cdr (assq 'tbody cont)) cont))
1292 (footer (cdr (assq 'tfoot cont)))
144b7b5c 1293 (bgcolor (cdr (assq :bgcolor cont)))
60568d74
LMI
1294 (start (point))
1295 (shr-stylesheet (nconc (list (cons 'background-color bgcolor))
1296 shr-stylesheet))
6c769311
KY
1297 (nheader (if header (shr-max-columns header)))
1298 (nbody (if body (shr-max-columns body)))
1299 (nfooter (if footer (shr-max-columns footer))))
2146e256
LMI
1300 (if (and (not caption)
1301 (not header)
1302 (not (cdr (assq 'tbody cont)))
1303 (not (cdr (assq 'tr cont)))
1304 (not footer))
1305 ;; The table is totally invalid and just contains random junk.
1306 ;; Try to output it anyway.
1307 (shr-generic cont)
1308 ;; It's a real table, so render it.
1309 (shr-tag-table-1
1310 (nconc
1311 (if caption `((tr (td ,@caption))))
1312 (if header
1313 (if footer
1314 ;; hader + body + footer
1315 (if (= nheader nbody)
1316 (if (= nbody nfooter)
1317 `((tr (td (table (tbody ,@header ,@body ,@footer)))))
1318 (nconc `((tr (td (table (tbody ,@header ,@body)))))
1319 (if (= nfooter 1)
1320 footer
1321 `((tr (td (table (tbody ,@footer))))))))
1322 (nconc `((tr (td (table (tbody ,@header)))))
1323 (if (= nbody nfooter)
1324 `((tr (td (table (tbody ,@body ,@footer)))))
1325 (nconc `((tr (td (table (tbody ,@body)))))
1326 (if (= nfooter 1)
1327 footer
1328 `((tr (td (table (tbody ,@footer))))))))))
1329 ;; header + body
3c066373 1330 (if (= nheader nbody)
2146e256
LMI
1331 `((tr (td (table (tbody ,@header ,@body)))))
1332 (if (= nheader 1)
1333 `(,@header (tr (td (table (tbody ,@body)))))
1334 `((tr (td (table (tbody ,@header))))
1335 (tr (td (table (tbody ,@body))))))))
1336 (if footer
1337 ;; body + footer
1338 (if (= nbody nfooter)
1339 `((tr (td (table (tbody ,@body ,@footer)))))
1340 (nconc `((tr (td (table (tbody ,@body)))))
1341 (if (= nfooter 1)
1342 footer
1343 `((tr (td (table (tbody ,@footer))))))))
1344 (if caption
1345 `((tr (td (table (tbody ,@body)))))
1346 body))))))
60568d74
LMI
1347 (when bgcolor
1348 (shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
f462d10a
LMI
1349 bgcolor))
1350 ;; Finally, insert all the images after the table. The Emacs buffer
1351 ;; model isn't strong enough to allow us to put the images actually
1352 ;; into the tables.
1353 (when (zerop shr-table-depth)
1354 (dolist (elem (shr-find-elements cont 'img))
1355 (shr-tag-img (cdr elem))))))
6c769311 1356
130e977f
LMI
1357(defun shr-find-elements (cont type)
1358 (let (result)
1359 (dolist (elem cont)
1360 (cond ((eq (car elem) type)
1361 (push elem result))
1362 ((consp (cdr elem))
1363 (setq result (nconc (shr-find-elements (cdr elem) type) result)))))
1364 (nreverse result)))
71e691a5
G
1365
1366(defun shr-insert-table (table widths)
be2aa135
LMI
1367 (let* ((collapse (equal (cdr (assq 'border-collapse shr-stylesheet))
1368 "collapse"))
924d6997 1369 (shr-table-separator-length (if collapse 0 1))
be2aa135
LMI
1370 (shr-table-vertical-line (if collapse "" shr-table-vertical-line)))
1371 (unless collapse
1372 (shr-insert-table-ruler widths))
1373 (dolist (row table)
1374 (let ((start (point))
1375 (height (let ((max 0))
1376 (dolist (column row)
1377 (setq max (max max (cadr column))))
1378 max)))
1379 (dotimes (i height)
1380 (shr-indent)
1381 (insert shr-table-vertical-line "\n"))
1382 (dolist (column row)
1383 (goto-char start)
1384 (let ((lines (nth 2 column)))
1385 (dolist (line lines)
1386 (end-of-line)
1387 (insert line shr-table-vertical-line)
1388 (forward-line 1))
1389 ;; Add blank lines at padding at the bottom of the TD,
1390 ;; possibly.
1391 (dotimes (i (- height (length lines)))
1392 (end-of-line)
1393 (let ((start (point)))
1394 (insert (make-string (string-width (car lines)) ? )
1395 shr-table-vertical-line)
1396 (when (nth 4 column)
1397 (shr-add-font start (1- (point))
1398 (list :background (nth 4 column)))))
1399 (forward-line 1)))))
1400 (unless collapse
1401 (shr-insert-table-ruler widths)))))
71e691a5
G
1402
1403(defun shr-insert-table-ruler (widths)
924d6997
G
1404 (when shr-table-horizontal-line
1405 (when (and (bolp)
1406 (> shr-indentation 0))
1407 (shr-indent))
1408 (insert shr-table-corner)
1409 (dotimes (i (length widths))
1410 (insert (make-string (aref widths i) shr-table-horizontal-line)
1411 shr-table-corner))
1412 (insert "\n")))
71e691a5 1413
160ae063 1414(defun shr-table-widths (table natural-table suggested-widths)
a7dcc87b
G
1415 (let* ((length (length suggested-widths))
1416 (widths (make-vector length 0))
1417 (natural-widths (make-vector length 0)))
71e691a5
G
1418 (dolist (row table)
1419 (let ((i 0))
1420 (dolist (column row)
160ae063
LMI
1421 (aset widths i (max (aref widths i) column))
1422 (setq i (1+ i)))))
1423 (dolist (row natural-table)
1424 (let ((i 0))
1425 (dolist (column row)
1426 (aset natural-widths i (max (aref natural-widths i) column))
a7dcc87b 1427 (setq i (1+ i)))))
863b61d6
KY
1428 (let ((extra (- (apply '+ (append suggested-widths nil))
1429 (apply '+ (append widths nil))))
a7dcc87b 1430 (expanded-columns 0))
160ae063
LMI
1431 ;; We have extra, unused space, so divide this space amongst the
1432 ;; columns.
a7dcc87b 1433 (when (> extra 0)
160ae063
LMI
1434 ;; If the natural width is wider than the rendered width, we
1435 ;; want to allow the column to expand.
a7dcc87b 1436 (dotimes (i length)
a7dcc87b
G
1437 (when (> (aref natural-widths i) (aref widths i))
1438 (setq expanded-columns (1+ expanded-columns))))
1439 (dotimes (i length)
1440 (when (> (aref natural-widths i) (aref widths i))
1441 (aset widths i (min
160ae063 1442 (aref natural-widths i)
a7dcc87b
G
1443 (+ (/ extra expanded-columns)
1444 (aref widths i))))))))
71e691a5
G
1445 widths))
1446
1447(defun shr-make-table (cont widths &optional fill)
c74cb344
G
1448 (or (cadr (assoc (list cont widths fill) shr-content-cache))
1449 (let ((data (shr-make-table-1 cont widths fill)))
1450 (push (list (list cont widths fill) data)
1451 shr-content-cache)
1452 data)))
1453
1454(defun shr-make-table-1 (cont widths &optional fill)
be2aa135 1455 (let ((trs nil)
924d6997
G
1456 (shr-inhibit-decoration (not fill))
1457 (rowspans (make-vector (length widths) 0))
1458 width colspan)
71e691a5
G
1459 (dolist (row cont)
1460 (when (eq (car row) 'tr)
a0ec382a
LMI
1461 (let ((tds nil)
1462 (columns (cdr row))
1463 (i 0)
924d6997 1464 (width-column 0)
a0ec382a
LMI
1465 column)
1466 (while (< i (length widths))
924d6997
G
1467 ;; If we previously had a rowspan definition, then that
1468 ;; means that we now have a "missing" td/th element here.
1469 ;; So just insert a dummy, empty one to (sort of) emulate
1470 ;; rowspan.
1471 (setq column
1472 (if (zerop (aref rowspans i))
1473 (pop columns)
1474 (aset rowspans i (1- (aref rowspans i)))
1475 '(td)))
a0ec382a 1476 (when (or (memq (car column) '(td th))
924d6997
G
1477 (not column))
1478 (when (cdr (assq :rowspan (cdr column)))
1479 (aset rowspans i (+ (aref rowspans i)
1480 (1- (string-to-number
1481 (cdr (assq :rowspan (cdr column))))))))
970ad972
G
1482 ;; Sanity check for invalid column-spans.
1483 (when (>= width-column (length widths))
1484 (setq width-column 0))
924d6997
G
1485 (setq width
1486 (if column
1487 (aref widths width-column)
2fae38e5 1488 10))
924d6997
G
1489 (when (and fill
1490 (setq colspan (cdr (assq :colspan (cdr column)))))
1491 (setq colspan (string-to-number colspan))
1492 (dotimes (j (1- colspan))
1493 (if (> (+ i 1 j) (1- (length widths)))
1494 (setq width (aref widths (1- (length widths))))
1495 (setq width (+ width
1496 shr-table-separator-length
1497 (aref widths (+ i 1 j))))))
1498 (setq width-column (+ width-column (1- colspan))))
ec6a2d7a
LMI
1499 ;; Sanity check for degenerate tables.
1500 (when (zerop width)
1501 (setq width 10))
924d6997
G
1502 (when (or column
1503 (not fill))
1504 (push (shr-render-td (cdr column) width fill)
1505 tds))
1506 (setq i (1+ i)
1507 width-column (1+ width-column))))
71e691a5
G
1508 (push (nreverse tds) trs))))
1509 (nreverse trs)))
1510
1511(defun shr-render-td (cont width fill)
04db63bc 1512 (with-temp-buffer
60568d74
LMI
1513 (let ((bgcolor (cdr (assq :bgcolor cont)))
1514 (fgcolor (cdr (assq :fgcolor cont)))
1515 (style (cdr (assq :style cont)))
1516 (shr-stylesheet shr-stylesheet)
7304e4dd 1517 actual-colors)
60568d74
LMI
1518 (when style
1519 (setq style (and (string-match "color" style)
1520 (shr-parse-style style))))
1521 (when bgcolor
1522 (setq style (nconc (list (cons 'background-color bgcolor)) style)))
1523 (when fgcolor
1524 (setq style (nconc (list (cons 'color fgcolor)) style)))
1525 (when style
1526 (setq shr-stylesheet (append style shr-stylesheet)))
c74cb344
G
1527 (let ((shr-width width)
1528 (shr-indentation 0))
1529 (shr-descend (cons 'td cont)))
1530 ;; Delete padding at the bottom of the TDs.
1531 (delete-region
1532 (point)
1533 (progn
1534 (skip-chars-backward " \t\n")
1535 (end-of-line)
1536 (point)))
60568d74
LMI
1537 (goto-char (point-min))
1538 (let ((max 0))
1539 (while (not (eobp))
1540 (end-of-line)
1541 (setq max (max max (current-column)))
1542 (forward-line 1))
1543 (when fill
1544 (goto-char (point-min))
1545 ;; If the buffer is totally empty, then put a single blank
1546 ;; line here.
1547 (if (zerop (buffer-size))
1548 (insert (make-string width ? ))
1549 ;; Otherwise, fill the buffer.
544d4594
LMI
1550 (let ((align (cdr (assq :align cont)))
1551 length)
1552 (while (not (eobp))
1553 (end-of-line)
1554 (setq length (- width (current-column)))
1555 (when (> length 0)
1556 (cond
1557 ((equal align "right")
1558 (beginning-of-line)
1559 (insert (make-string length ? )))
1560 ((equal align "center")
1561 (insert (make-string (/ length 2) ? ))
1562 (beginning-of-line)
1563 (insert (make-string (- length (/ length 2)) ? )))
1564 (t
1565 (insert (make-string length ? )))))
1566 (forward-line 1))))
abb97fbb 1567 (when style
ec72bf63
G
1568 (setq actual-colors
1569 (shr-colorize-region
1570 (point-min) (point-max)
1571 (cdr (assq 'color shr-stylesheet))
1572 (cdr (assq 'background-color shr-stylesheet))))))
60568d74
LMI
1573 (if fill
1574 (list max
1575 (count-lines (point-min) (point-max))
1576 (split-string (buffer-string) "\n")
7304e4dd 1577 nil
ec72bf63 1578 (car actual-colors))
ec6a2d7a 1579 (max max 10))))))
a7dcc87b 1580
160ae063 1581(defun shr-buffer-width ()
a7dcc87b 1582 (goto-char (point-min))
160ae063 1583 (let ((max 0))
a7dcc87b
G
1584 (while (not (eobp))
1585 (end-of-line)
160ae063 1586 (setq max (max max (current-column)))
a7dcc87b
G
1587 (forward-line 1))
1588 max))
130e977f 1589
71e691a5
G
1590(defun shr-pro-rate-columns (columns)
1591 (let ((total-percentage 0)
1592 (widths (make-vector (length columns) 0)))
1593 (dotimes (i (length columns))
a7dcc87b 1594 (setq total-percentage (+ total-percentage (aref columns i))))
71e691a5
G
1595 (setq total-percentage (/ 1.0 total-percentage))
1596 (dotimes (i (length columns))
1597 (aset widths i (max (truncate (* (aref columns i)
1598 total-percentage
a7dcc87b 1599 (- shr-width (1+ (length columns)))))
71e691a5
G
1600 10)))
1601 widths))
1602
1603;; Return a summary of the number and shape of the TDs in the table.
1604(defun shr-column-specs (cont)
1605 (let ((columns (make-vector (shr-max-columns cont) 1)))
1606 (dolist (row cont)
1607 (when (eq (car row) 'tr)
1608 (let ((i 0))
1609 (dolist (column (cdr row))
1610 (when (memq (car column) '(td th))
1611 (let ((width (cdr (assq :width (cdr column)))))
1612 (when (and width
5d852256
LMI
1613 (string-match "\\([0-9]+\\)%" width)
1614 (not (zerop (setq width (string-to-number
1615 (match-string 1 width))))))
1616 (aset columns i (/ width 100.0))))
130e977f 1617 (setq i (1+ i)))))))
71e691a5
G
1618 columns))
1619
1620(defun shr-count (cont elem)
1621 (let ((i 0))
1622 (dolist (sub cont)
1623 (when (eq (car sub) elem)
1624 (setq i (1+ i))))
1625 i))
1626
1627(defun shr-max-columns (cont)
1628 (let ((max 0))
1629 (dolist (row cont)
1630 (when (eq (car row) 'tr)
130e977f
LMI
1631 (setq max (max max (+ (shr-count (cdr row) 'td)
1632 (shr-count (cdr row) 'th))))))
71e691a5
G
1633 max))
1634
f3fd95db 1635(provide 'shr)
367f7f81 1636
b4543a28 1637;; Local Variables:
c38e0c97 1638;; coding: utf-8
b4543a28
G
1639;; End:
1640
367f7f81 1641;;; shr.el ends here