* net/shr.el (image-size, image-animate): Declare.
[emacs.git] / lisp / net / shr.el
blobb742172be461a563a95c89a0b7fce1243993a5b6
1 ;;; shr.el --- Simple HTML Renderer
3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: html
8 ;; This file is part of GNU Emacs.
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.
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.
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/>.
23 ;;; Commentary:
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.
31 ;;; Code:
33 (eval-when-compile (require 'cl))
34 (eval-when-compile (require 'url)) ;For url-filename's setf handler.
35 (require 'browse-url)
37 (defgroup shr nil
38 "Simple HTML Renderer"
39 :version "24.1"
40 :group 'hypermedia)
42 (defcustom shr-max-image-proportion 0.9
43 "How big pictures displayed are in relation to the window they're in.
44 A value of 0.7 means that they are allowed to take up 70% of the
45 width and height of the window. If they are larger than this,
46 and Emacs supports it, then the images will be rescaled down to
47 fit these criteria."
48 :version "24.1"
49 :group 'shr
50 :type 'float)
52 (defcustom shr-blocked-images nil
53 "Images that have URLs matching this regexp will be blocked."
54 :version "24.1"
55 :group 'shr
56 :type '(choice (const nil) regexp))
58 (defcustom shr-table-horizontal-line nil
59 "Character used to draw horizontal table lines.
60 If nil, don't draw horizontal table lines."
61 :group 'shr
62 :type '(choice (const nil) character))
64 (defcustom shr-table-vertical-line ?\s
65 "Character used to draw vertical table lines."
66 :group 'shr
67 :type 'character)
69 (defcustom shr-table-corner ?\s
70 "Character used to draw table corners."
71 :group 'shr
72 :type 'character)
74 (defcustom shr-hr-line ?-
75 "Character used to draw hr lines."
76 :group 'shr
77 :type 'character)
79 (defcustom shr-width fill-column
80 "Frame width to use for rendering.
81 May either be an integer specifying a fixed width in characters,
82 or nil, meaning that the full width of the window should be
83 used."
84 :type '(choice (integer :tag "Fixed width in characters")
85 (const :tag "Use the width of the window" nil))
86 :group 'shr)
88 (defcustom shr-bullet "* "
89 "Bullet used for unordered lists.
90 Alternative suggestions are:
91 - \" \"
92 - \" \""
93 :type 'string
94 :group 'shr)
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)
102 (defvar shr-content-function nil
103 "If bound, this should be a function that will return the content.
104 This is used for cid: URLs, and the function is called with the
105 cid: URL as the argument.")
107 (defvar shr-put-image-function 'shr-put-image
108 "Function called to put image and alt string.")
110 (defface shr-strike-through '((t (:strike-through t)))
111 "Font for <s> elements."
112 :group 'shr)
114 (defface shr-link
115 '((t (:inherit link)))
116 "Font for link elements."
117 :group 'shr)
119 ;;; Internal variables.
121 (defvar shr-folding-mode nil)
122 (defvar shr-state nil)
123 (defvar shr-start nil)
124 (defvar shr-indentation 0)
125 (defvar shr-inhibit-images nil)
126 (defvar shr-list-mode nil)
127 (defvar shr-content-cache nil)
128 (defvar shr-kinsoku-shorten nil)
129 (defvar shr-table-depth 0)
130 (defvar shr-stylesheet nil)
131 (defvar shr-base nil)
132 (defvar shr-ignore-cache nil)
133 (defvar shr-external-rendering-functions nil)
134 (defvar shr-target-id nil)
135 (defvar shr-inhibit-decoration nil)
136 (defvar shr-table-separator-length 1)
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)
142 (define-key map "z" 'shr-zoom-image)
143 (define-key map [tab] 'shr-next-link)
144 (define-key map [backtab] 'shr-previous-link)
145 (define-key map [follow-link] 'mouse-face)
146 (define-key map [mouse-2] 'shr-browse-url)
147 (define-key map "I" 'shr-insert-image)
148 (define-key map "w" 'shr-copy-url)
149 (define-key map "u" 'shr-copy-url)
150 (define-key map "v" 'shr-browse-url)
151 (define-key map "o" 'shr-save-contents)
152 (define-key map "\r" 'shr-browse-url)
153 map))
155 ;; Public functions and commands.
156 (declare-function libxml-parse-html-region "xml.c"
157 (start end &optional base-url))
159 (defun shr-render-buffer (buffer)
160 "Display the HTML rendering of the current buffer."
161 (interactive (list (current-buffer)))
162 (or (fboundp 'libxml-parse-html-region)
163 (error "This function requires Emacs to be compiled with libxml2"))
164 (pop-to-buffer "*html*")
165 (erase-buffer)
166 (shr-insert-document
167 (with-current-buffer buffer
168 (libxml-parse-html-region (point-min) (point-max))))
169 (goto-char (point-min)))
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))))
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))))
189 ;;;###autoload
190 (defun shr-insert-document (dom)
191 "Render the parsed document DOM into the current buffer.
192 DOM should be a parse tree as generated by
193 `libxml-parse-html-region' or similar."
194 (setq shr-content-cache nil)
195 (let ((start (point))
196 (shr-state nil)
197 (shr-start nil)
198 (shr-base nil)
199 (shr-preliminary-table-render 0)
200 (shr-width (or shr-width (1- (window-width)))))
201 (shr-descend (shr-transform-dom dom))
202 (shr-remove-trailing-whitespace start (point))))
204 (defun shr-remove-trailing-whitespace (start end)
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)
211 (when (> (shr-previous-newline-padding-width (current-column)) width)
212 (dolist (overlay (overlays-at (point)))
213 (when (overlay-get overlay 'before-string)
214 (overlay-put overlay 'before-string nil))))
215 (forward-line 1)))))
217 (defun shr-copy-url ()
218 "Copy the URL under point to the kill ring.
219 If called twice, then try to fetch the URL and see whether it
220 redirects 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
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))
240 (copy-region-as-kill (point-min) (point-max)))))
241 nil t))
242 ;; Copy the URL to the kill ring.
244 (with-temp-buffer
245 (insert url)
246 (copy-region-as-kill (point-min) (point-max))
247 (message "Copied %s" url))))))
249 (defun shr-next-link ()
250 "Skip to the next link."
251 (interactive)
252 (let ((skip (text-property-any (point) (point-max) 'help-echo nil)))
253 (if (not (setq skip (text-property-not-all skip (point-max)
254 'help-echo nil)))
255 (message "No next link")
256 (goto-char skip)
257 (message "%s" (get-text-property (point) 'help-echo)))))
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))
266 (get-text-property (point) 'help-echo))
267 (forward-char -1))
268 ;; Find the previous link.
269 (while (and (not (bobp))
270 (not (setq found (get-text-property (point) 'help-echo))))
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))
278 (get-text-property (point) 'help-echo))
279 (forward-char -1))
280 (forward-char 1)
281 (message "%s" (get-text-property (point) 'help-echo)))))
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))))
291 (defun shr-browse-image (&optional copy-url)
292 "Browse the image under point.
293 If COPY-URL (the prefix if called interactively) is non-nil, copy
294 the URL of the image to the kill buffer instead."
295 (interactive "P")
296 (let ((url (get-text-property (point) 'image-url)))
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)))
306 (message "Browsing %s..." url)
307 (browse-url url)))))
309 (defun shr-insert-image ()
310 "Insert the image under point into the buffer."
311 (interactive)
312 (let ((url (get-text-property (point) 'image-url)))
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))
318 t t))))
320 (defun shr-zoom-image ()
321 "Toggle the image size.
322 The size will be rotated between the default size, the original
323 size, 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))))
354 ;;; Utility functions.
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)
364 (push (cons 'text sub) result)
365 (push (shr-transform-dom sub) result)))
366 (nreverse result)))
368 (defun shr-descend (dom)
369 (let ((function
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)))
375 (style (cdr (assq :style (cdr dom))))
376 (shr-stylesheet shr-stylesheet)
377 (start (point)))
378 (when style
379 (if (string-match "color\\|display\\|border-collapse" style)
380 (setq shr-stylesheet (nconc (shr-parse-style style)
381 shr-stylesheet))
382 (setq style nil)))
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)))))))
398 (defun shr-generic (cont)
399 (dolist (sub cont)
400 (cond
401 ((eq (car sub) 'text)
402 (shr-insert (cdr sub)))
403 ((listp (cdr sub))
404 (shr-descend sub)))))
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))
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))
426 (defun shr-insert (text)
427 (when (and (eq shr-state 'image)
428 (not (bolp))
429 (not (string-match "\\`[ \t\n]+\\'" text)))
430 (insert "\n")
431 (setq shr-state nil))
432 (cond
433 ((eq shr-folding-mode 'none)
434 (insert text))
436 (when (and (string-match "\\`[ \t\n ]" text)
437 (not (bolp))
438 (not (eq (char-after (1- (point))) ? )))
439 (insert " "))
440 (dolist (elem (split-string text "[ \f\t\n\r\v ]+" t))
441 (when (and (bolp)
442 (> shr-indentation 0))
443 (shr-indent))
444 ;; No space is needed behind a wide character categorized as
445 ;; kinsoku-bol, between characters both categorized as nospace,
446 ;; or at the beginning of a line.
447 (let (prev)
448 (when (and (> (current-column) shr-indentation)
449 (eq (preceding-char) ? )
450 (or (= (line-beginning-position) (1- (point)))
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)))))
456 (delete-char -1)))
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)))
462 (insert elem)
463 (setq shr-state nil)
464 (let (found)
465 (while (and (> (current-column) shr-width)
466 (progn
467 (setq found (shr-find-fill-point))
468 (not (eolp))))
469 (when (eq (preceding-char) ? )
470 (delete-char -1))
471 (insert "\n")
472 (unless found
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 " ")))
480 (unless (string-match "[ \t\r\n ]\\'" text)
481 (delete-char -1)))))
483 (defun shr-find-fill-point ()
484 (when (> (move-to-column shr-width) shr-width)
485 (backward-char 1))
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))
493 (if (eq (preceding-char) ?')
494 (not (memq (char-after (- (point) 2))
495 (list nil ?\n ? )))
496 (and (shr-char-kinsoku-bol-p (preceding-char))
497 (shr-char-breakable-p (following-char))
498 (not (shr-char-kinsoku-bol-p (following-char)))))
499 (shr-char-kinsoku-eol-p (following-char))))
500 (backward-char 1))
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)))
508 (if failed
509 ;; There's no breakable point, so we give it up.
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)))))
520 (eolp)
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))
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)
560 (shr-char-kinsoku-bol-p (following-char))
561 (shr-char-breakable-p (following-char))))))))
562 (when (eq (following-char) ? )
563 (forward-char 1))))
564 (not failed)))
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)))
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))
609 ;; Totally relative.
610 (concat (car base) (cadr base) url))))
612 (defun shr-ensure-newline ()
613 (unless (zerop (current-column))
614 (insert "\n")))
616 (defun shr-ensure-paragraph ()
617 (unless (bobp)
618 (if (<= (current-column) shr-indentation)
619 (unless (save-excursion
620 (forward-line -1)
621 (looking-at " *$"))
622 (insert "\n"))
623 (if (save-excursion
624 (beginning-of-line)
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)))))
633 (delete-region (match-beginning 0) (match-end 0))
634 (insert "\n\n")))))
636 (defun shr-indent ()
637 (when (> shr-indentation 0)
638 (insert (make-string shr-indentation ? ))))
640 (defun shr-fontize-cont (cont &rest types)
641 (let (shr-start)
642 (shr-generic cont)
643 (dolist (type types)
644 (shr-add-font (or shr-start (point)) (point) type))))
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.
649 (defun shr-add-font (start end type)
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))))))
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))
667 (defun shr-browse-url (&optional external mouse-event)
668 "Browse the URL under point.
669 If EXTERNAL, browse the URL using `shr-external-browser'."
670 (interactive (list current-prefix-arg last-nonmenu-event))
671 (mouse-set-point mouse-event)
672 (let ((url (get-text-property (point) 'shr-url)))
673 (cond
674 ((not url)
675 (message "No link under point"))
676 ((string-match "^mailto:" url)
677 (browse-url-mail url))
679 (if external
680 (funcall shr-external-browser url)
681 (browse-url url))))))
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)
690 'shr-store-contents (list url directory)
691 nil t))))
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)))))
701 (defun shr-image-fetched (status buffer start end &optional flags)
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 (shr-parse-image-data)))
709 (with-current-buffer buffer
710 (save-excursion
711 (let ((alt (buffer-substring start end))
712 (properties (text-properties-at start))
713 (inhibit-read-only t))
714 (delete-region start end)
715 (goto-char start)
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))))))))))
722 (kill-buffer image-buffer)))
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)))
735 ;; Behind display-graphic-p test.
736 (declare-function image-size "image.c" (spec &optional pixels frame))
737 (declare-function image-animate "image" (image &optional index limit))
739 (defun shr-put-image (spec alt &optional flags)
740 "Insert image SPEC with a string ALT. Return image.
741 SPEC is either an image data blob, or a list where the first
742 element is the data blob and the second element is the content-type."
743 (if (display-graphic-p)
744 (let* ((size (cdr (assq 'size flags)))
745 (data (if (consp spec)
746 (car spec)
747 spec))
748 (content-type (and (consp spec)
749 (cadr spec)))
750 (start (point))
751 (image (cond
752 ((eq size 'original)
753 (create-image data nil t :ascent 100
754 :format content-type))
755 ((eq size 'full)
756 (ignore-errors
757 (shr-rescale-image data t content-type)))
759 (ignore-errors
760 (shr-rescale-image data nil content-type))))))
761 (when image
762 ;; When inserting big-ish pictures, put them at the
763 ;; beginning of the line.
764 (when (and (> (current-column) 0)
765 (> (car (image-size image t)) 400))
766 (insert "\n"))
767 (if (eq size 'original)
768 (insert-sliced-image image (or alt "*") nil 20 1)
769 (insert-image image (or alt "*")))
770 (put-text-property start (point) 'image-size size)
771 (when (cond ((fboundp 'image-multi-frame-p)
772 ;; Only animate multi-frame things that specify a
773 ;; delay; eg animated gifs as opposed to
774 ;; multi-page tiffs. FIXME?
775 (cdr (image-multi-frame-p image)))
776 ((fboundp 'image-animated-p)
777 (image-animated-p image)))
778 (image-animate image nil 60)))
779 image)
780 (insert alt)))
782 (defun shr-rescale-image (data &optional force content-type)
783 "Rescale DATA, if too big, to fit the current buffer.
784 If FORCE, rescale the image anyway."
785 (if (or (not (fboundp 'imagemagick-types))
786 (not (get-buffer-window (current-buffer))))
787 (create-image data nil t :ascent 100)
788 (let ((edges (window-inside-pixel-edges
789 (get-buffer-window (current-buffer)))))
790 (create-image
791 data 'imagemagick t
792 :ascent 100
793 :max-width (truncate (* shr-max-image-proportion
794 (- (nth 2 edges) (nth 0 edges))))
795 :max-height (truncate (* shr-max-image-proportion
796 (- (nth 3 edges) (nth 1 edges))))
797 :format content-type))))
799 ;; url-cache-extract autoloads url-cache.
800 (declare-function url-cache-create-filename "url-cache" (url))
801 (autoload 'mm-disable-multibyte "mm-util")
802 (autoload 'browse-url-mail "browse-url")
804 (defun shr-get-image-data (url)
805 "Get image data for URL.
806 Return a string with image data."
807 (with-temp-buffer
808 (mm-disable-multibyte)
809 (when (ignore-errors
810 (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
812 (when (or (search-forward "\n\n" nil t)
813 (search-forward "\r\n\r\n" nil t))
814 (shr-parse-image-data)))))
816 (defun shr-parse-image-data ()
817 (list
818 (buffer-substring (point) (point-max))
819 (save-excursion
820 (save-restriction
821 (narrow-to-region (point-min) (point))
822 (let ((content-type (mail-fetch-field "content-type")))
823 (and content-type
824 (intern content-type obarray)))))))
826 (defun shr-image-displayer (content-function)
827 "Return a function to display an image.
828 CONTENT-FUNCTION is a function to retrieve an image for a cid url that
829 is an argument. The function to be returned takes three arguments URL,
830 START, and END. Note that START and END should be markers."
831 `(lambda (url start end)
832 (when url
833 (if (string-match "\\`cid:" url)
834 ,(when content-function
835 `(let ((image (funcall ,content-function
836 (substring url (match-end 0)))))
837 (when image
838 (goto-char start)
839 (funcall shr-put-image-function
840 image (buffer-substring start end))
841 (delete-region (point) end))))
842 (url-retrieve url 'shr-image-fetched
843 (list (current-buffer) start end)
844 t t)))))
846 (defun shr-heading (cont &rest types)
847 (shr-ensure-paragraph)
848 (apply #'shr-fontize-cont cont types)
849 (shr-ensure-paragraph))
851 (defun shr-urlify (start url &optional title)
852 (when (and title (string-match "ctx" title)) (debug))
853 (shr-add-font start (point) 'shr-link)
854 (add-text-properties
855 start (point)
856 (list 'shr-url url
857 'help-echo (if title (format "%s (%s)" url title) url)
858 'follow-link t
859 'mouse-face 'highlight
860 'keymap shr-map)))
862 (defun shr-encode-url (url)
863 "Encode URL."
864 (browse-url-url-encode-chars url "[)$ ]"))
866 (autoload 'shr-color-visible "shr-color")
867 (autoload 'shr-color->hexadecimal "shr-color")
869 (defun shr-color-check (fg bg)
870 "Check that FG is visible on BG.
871 Returns (fg bg) with corrected values.
872 Returns nil if the colors that would be used are the default
873 ones, in case fg and bg are nil."
874 (when (or fg bg)
875 (let ((fixed (cond ((null fg) 'fg)
876 ((null bg) 'bg))))
877 ;; Convert colors to hexadecimal, or set them to default.
878 (let ((fg (or (shr-color->hexadecimal fg)
879 (frame-parameter nil 'foreground-color)))
880 (bg (or (shr-color->hexadecimal bg)
881 (frame-parameter nil 'background-color))))
882 (cond ((eq fixed 'bg)
883 ;; Only return the new fg
884 (list nil (cadr (shr-color-visible bg fg t))))
885 ((eq fixed 'fg)
886 ;; Invert args and results and return only the new bg
887 (list (cadr (shr-color-visible fg bg t)) nil))
889 (shr-color-visible bg fg)))))))
891 (defun shr-colorize-region (start end fg &optional bg)
892 (when (and (not shr-inhibit-decoration)
893 (or fg bg))
894 (let ((new-colors (shr-color-check fg bg)))
895 (when new-colors
896 (when fg
897 (add-face-text-property start end
898 (list :foreground (cadr new-colors))
900 (when bg
901 (add-face-text-property start end
902 (list :background (car new-colors))
903 t)))
904 new-colors)))
906 (defun shr-expand-newlines (start end color)
907 (save-restriction
908 ;; Skip past all white space at the start and ends.
909 (goto-char start)
910 (skip-chars-forward " \t\n")
911 (beginning-of-line)
912 (setq start (point))
913 (goto-char end)
914 (skip-chars-backward " \t\n")
915 (forward-line 1)
916 (setq end (point))
917 (narrow-to-region start end)
918 (let ((width (shr-buffer-width))
919 column)
920 (goto-char (point-min))
921 (while (not (eobp))
922 (end-of-line)
923 (when (and (< (setq column (current-column)) width)
924 (< (setq column (shr-previous-newline-padding-width column))
925 width))
926 (let ((overlay (make-overlay (point) (1+ (point)))))
927 (overlay-put overlay 'before-string
928 (concat
929 (mapconcat
930 (lambda (overlay)
931 (let ((string (plist-get
932 (overlay-properties overlay)
933 'before-string)))
934 (if (not string)
936 (overlay-put overlay 'before-string "")
937 string)))
938 (overlays-at (point))
940 (propertize (make-string (- width column) ? )
941 'face (list :background color))))))
942 (forward-line 1)))))
944 (defun shr-previous-newline-padding-width (width)
945 (let ((overlays (overlays-at (point)))
946 (previous-width 0))
947 (if (null overlays)
948 width
949 (dolist (overlay overlays)
950 (setq previous-width
951 (+ previous-width
952 (length (plist-get (overlay-properties overlay)
953 'before-string)))))
954 (+ width previous-width))))
956 ;;; Tag-specific rendering rules.
958 (defun shr-tag-body (cont)
959 (let* ((start (point))
960 (fgcolor (cdr (or (assq :fgcolor cont)
961 (assq :text cont))))
962 (bgcolor (cdr (assq :bgcolor cont)))
963 (shr-stylesheet (list (cons 'color fgcolor)
964 (cons 'background-color bgcolor))))
965 (shr-generic cont)
966 (shr-colorize-region start (point) fgcolor bgcolor)))
968 (defun shr-tag-style (cont)
971 (defun shr-tag-script (cont)
974 (defun shr-tag-comment (cont)
977 (defun shr-dom-to-xml (dom)
978 "Convert DOM into a string containing the xml representation."
979 (let ((arg " ")
980 (text ""))
981 (dolist (sub (cdr dom))
982 (cond
983 ((listp (cdr sub))
984 (setq text (concat text (shr-dom-to-xml sub))))
985 ((eq (car sub) 'text)
986 (setq text (concat text (cdr sub))))
988 (setq arg (concat arg (format "%s=\"%s\" "
989 (substring (symbol-name (car sub)) 1)
990 (cdr sub)))))))
991 (format "<%s%s>%s</%s>"
992 (car dom)
993 (substring arg 0 (1- (length arg)))
994 text
995 (car dom))))
997 (defun shr-tag-svg (cont)
998 (when (image-type-available-p 'svg)
999 (funcall shr-put-image-function
1000 (shr-dom-to-xml (cons 'svg cont))
1001 "SVG Image")))
1003 (defun shr-tag-sup (cont)
1004 (let ((start (point)))
1005 (shr-generic cont)
1006 (put-text-property start (point) 'display '(raise 0.5))))
1008 (defun shr-tag-sub (cont)
1009 (let ((start (point)))
1010 (shr-generic cont)
1011 (put-text-property start (point) 'display '(raise -0.5))))
1013 (defun shr-tag-label (cont)
1014 (shr-generic cont)
1015 (shr-ensure-paragraph))
1017 (defun shr-tag-p (cont)
1018 (shr-ensure-paragraph)
1019 (shr-indent)
1020 (shr-generic cont)
1021 (shr-ensure-paragraph))
1023 (defun shr-tag-div (cont)
1024 (shr-ensure-newline)
1025 (shr-indent)
1026 (shr-generic cont)
1027 (shr-ensure-newline))
1029 (defun shr-tag-s (cont)
1030 (shr-fontize-cont cont 'shr-strike-through))
1032 (defun shr-tag-del (cont)
1033 (shr-fontize-cont cont 'shr-strike-through))
1035 (defun shr-tag-b (cont)
1036 (shr-fontize-cont cont 'bold))
1038 (defun shr-tag-i (cont)
1039 (shr-fontize-cont cont 'italic))
1041 (defun shr-tag-em (cont)
1042 (shr-fontize-cont cont 'italic))
1044 (defun shr-tag-strong (cont)
1045 (shr-fontize-cont cont 'bold))
1047 (defun shr-tag-u (cont)
1048 (shr-fontize-cont cont 'underline))
1050 (defun shr-parse-style (style)
1051 (when style
1052 (save-match-data
1053 (when (string-match "\n" style)
1054 (setq style (replace-match " " t t style))))
1055 (let ((plist nil))
1056 (dolist (elem (split-string style ";"))
1057 (when elem
1058 (setq elem (split-string elem ":"))
1059 (when (and (car elem)
1060 (cadr elem))
1061 (let ((name (replace-regexp-in-string "^ +\\| +$" "" (car elem)))
1062 (value (replace-regexp-in-string "^ +\\| +$" "" (cadr elem))))
1063 (when (string-match " *!important\\'" value)
1064 (setq value (substring value 0 (match-beginning 0))))
1065 (push (cons (intern name obarray)
1066 value)
1067 plist)))))
1068 plist)))
1070 (defun shr-tag-base (cont)
1071 (let ((base (cdr (assq :href cont))))
1072 (when base
1073 (setq shr-base (shr-parse-base base))))
1074 (shr-generic cont))
1076 (defun shr-tag-a (cont)
1077 (let ((url (cdr (assq :href cont)))
1078 (title (cdr (assq :title cont)))
1079 (start (point))
1080 shr-start)
1081 (shr-generic cont)
1082 (when (and url
1083 (not shr-inhibit-decoration))
1084 (shr-urlify (or shr-start start) (shr-expand-url url) title))))
1086 (defun shr-tag-object (cont)
1087 (let ((start (point))
1088 url)
1089 (dolist (elem cont)
1090 (when (eq (car elem) 'embed)
1091 (setq url (or url (cdr (assq :src (cdr elem))))))
1092 (when (and (eq (car elem) 'param)
1093 (equal (cdr (assq :name (cdr elem))) "movie"))
1094 (setq url (or url (cdr (assq :value (cdr elem)))))))
1095 (when url
1096 (shr-insert " [multimedia] ")
1097 (shr-urlify start (shr-expand-url url)))
1098 (shr-generic cont)))
1100 (defun shr-tag-video (cont)
1101 (let ((image (cdr (assq :poster cont)))
1102 (url (cdr (assq :src cont)))
1103 (start (point)))
1104 (shr-tag-img nil image)
1105 (shr-urlify start (shr-expand-url url))))
1107 (defun shr-tag-img (cont &optional url)
1108 (when (or url
1109 (and cont
1110 (cdr (assq :src cont))))
1111 (when (and (> (current-column) 0)
1112 (not (eq shr-state 'image)))
1113 (insert "\n"))
1114 (let ((alt (cdr (assq :alt cont)))
1115 (url (shr-expand-url (or url (cdr (assq :src cont))))))
1116 (let ((start (point-marker)))
1117 (when (zerop (length alt))
1118 (setq alt "*"))
1119 (cond
1120 ((or (member (cdr (assq :height cont)) '("0" "1"))
1121 (member (cdr (assq :width cont)) '("0" "1")))
1122 ;; Ignore zero-sized or single-pixel images.
1124 ((and (not shr-inhibit-images)
1125 (string-match "\\`data:" url))
1126 (let ((image (shr-image-from-data (substring url (match-end 0)))))
1127 (if image
1128 (funcall shr-put-image-function image alt)
1129 (insert alt))))
1130 ((and (not shr-inhibit-images)
1131 (string-match "\\`cid:" url))
1132 (let ((url (substring url (match-end 0)))
1133 image)
1134 (if (or (not shr-content-function)
1135 (not (setq image (funcall shr-content-function url))))
1136 (insert alt)
1137 (funcall shr-put-image-function image alt))))
1138 ((or shr-inhibit-images
1139 (and shr-blocked-images
1140 (string-match shr-blocked-images url)))
1141 (setq shr-start (point))
1142 (let ((shr-state 'space))
1143 (if (> (string-width alt) 8)
1144 (shr-insert (truncate-string-to-width alt 8))
1145 (shr-insert alt))))
1146 ((and (not shr-ignore-cache)
1147 (url-is-cached (shr-encode-url url)))
1148 (funcall shr-put-image-function (shr-get-image-data url) alt))
1150 (insert alt " ")
1151 (when (and shr-ignore-cache
1152 (url-is-cached (shr-encode-url url)))
1153 (let ((file (url-cache-create-filename (shr-encode-url url))))
1154 (when (file-exists-p file)
1155 (delete-file file))))
1156 (url-queue-retrieve
1157 (shr-encode-url url) 'shr-image-fetched
1158 (list (current-buffer) start (set-marker (make-marker) (1- (point))))
1159 t t)))
1160 (when (zerop shr-table-depth) ;; We are not in a table.
1161 (put-text-property start (point) 'keymap shr-map)
1162 (put-text-property start (point) 'shr-alt alt)
1163 (put-text-property start (point) 'image-url url)
1164 (put-text-property start (point) 'image-displayer
1165 (shr-image-displayer shr-content-function))
1166 (put-text-property start (point) 'help-echo alt))
1167 (setq shr-state 'image)))))
1169 (defun shr-tag-pre (cont)
1170 (let ((shr-folding-mode 'none))
1171 (shr-ensure-newline)
1172 (shr-indent)
1173 (shr-generic cont)
1174 (shr-ensure-newline)))
1176 (defun shr-tag-blockquote (cont)
1177 (shr-ensure-paragraph)
1178 (shr-indent)
1179 (let ((shr-indentation (+ shr-indentation 4)))
1180 (shr-generic cont))
1181 (shr-ensure-paragraph))
1183 (defun shr-tag-dl (cont)
1184 (shr-ensure-paragraph)
1185 (shr-generic cont)
1186 (shr-ensure-paragraph))
1188 (defun shr-tag-dt (cont)
1189 (shr-ensure-newline)
1190 (shr-generic cont)
1191 (shr-ensure-newline))
1193 (defun shr-tag-dd (cont)
1194 (shr-ensure-newline)
1195 (let ((shr-indentation (+ shr-indentation 4)))
1196 (shr-generic cont)))
1198 (defun shr-tag-ul (cont)
1199 (shr-ensure-paragraph)
1200 (let ((shr-list-mode 'ul))
1201 (shr-generic cont))
1202 (shr-ensure-paragraph))
1204 (defun shr-tag-ol (cont)
1205 (shr-ensure-paragraph)
1206 (let ((shr-list-mode 1))
1207 (shr-generic cont))
1208 (shr-ensure-paragraph))
1210 (defun shr-tag-li (cont)
1211 (shr-ensure-newline)
1212 (shr-indent)
1213 (let* ((bullet
1214 (if (numberp shr-list-mode)
1215 (prog1
1216 (format "%d " shr-list-mode)
1217 (setq shr-list-mode (1+ shr-list-mode)))
1218 shr-bullet))
1219 (shr-indentation (+ shr-indentation (length bullet))))
1220 (insert bullet)
1221 (shr-generic cont)))
1223 (defun shr-tag-br (cont)
1224 (when (and (not (bobp))
1225 ;; Only add a newline if we break the current line, or
1226 ;; the previous line isn't a blank line.
1227 (or (not (bolp))
1228 (and (> (- (point) 2) (point-min))
1229 (not (= (char-after (- (point) 2)) ?\n)))))
1230 (insert "\n")
1231 (shr-indent))
1232 (shr-generic cont))
1234 (defun shr-tag-span (cont)
1235 (shr-generic cont))
1237 (defun shr-tag-h1 (cont)
1238 (shr-heading cont 'bold 'underline))
1240 (defun shr-tag-h2 (cont)
1241 (shr-heading cont 'bold))
1243 (defun shr-tag-h3 (cont)
1244 (shr-heading cont 'italic))
1246 (defun shr-tag-h4 (cont)
1247 (shr-heading cont))
1249 (defun shr-tag-h5 (cont)
1250 (shr-heading cont))
1252 (defun shr-tag-h6 (cont)
1253 (shr-heading cont))
1255 (defun shr-tag-hr (cont)
1256 (shr-ensure-newline)
1257 (insert (make-string shr-width shr-hr-line) "\n"))
1259 (defun shr-tag-title (cont)
1260 (shr-heading cont 'bold 'underline))
1262 (defun shr-tag-font (cont)
1263 (let* ((start (point))
1264 (color (cdr (assq :color cont)))
1265 (shr-stylesheet (nconc (list (cons 'color color))
1266 shr-stylesheet)))
1267 (shr-generic cont)
1268 (when color
1269 (shr-colorize-region start (point) color
1270 (cdr (assq 'background-color shr-stylesheet))))))
1272 ;;; Table rendering algorithm.
1274 ;; Table rendering is the only complicated thing here. We do this by
1275 ;; first counting how many TDs there are in each TR, and registering
1276 ;; how wide they think they should be ("width=45%", etc). Then we
1277 ;; render each TD separately (this is done in temporary buffers, so
1278 ;; that we can use all the rendering machinery as if we were in the
1279 ;; main buffer). Now we know how much space each TD really takes, so
1280 ;; we then render everything again with the new widths, and finally
1281 ;; insert all these boxes into the main buffer.
1282 (defun shr-tag-table-1 (cont)
1283 (setq cont (or (cdr (assq 'tbody cont))
1284 cont))
1285 (let* ((shr-inhibit-images t)
1286 (shr-table-depth (1+ shr-table-depth))
1287 (shr-kinsoku-shorten t)
1288 ;; Find all suggested widths.
1289 (columns (shr-column-specs cont))
1290 ;; Compute how many characters wide each TD should be.
1291 (suggested-widths (shr-pro-rate-columns columns))
1292 ;; Do a "test rendering" to see how big each TD is (this can
1293 ;; be smaller (if there's little text) or bigger (if there's
1294 ;; unbreakable text).
1295 (sketch (shr-make-table cont suggested-widths))
1296 ;; Compute the "natural" width by setting each column to 500
1297 ;; characters and see how wide they really render.
1298 (natural (shr-make-table cont (make-vector (length columns) 500)))
1299 (sketch-widths (shr-table-widths sketch natural suggested-widths)))
1300 ;; This probably won't work very well.
1301 (when (> (+ (loop for width across sketch-widths
1302 summing (1+ width))
1303 shr-indentation 1)
1304 (frame-width))
1305 (setq truncate-lines t))
1306 ;; Then render the table again with these new "hard" widths.
1307 (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths)))
1309 (defun shr-tag-table (cont)
1310 (shr-ensure-paragraph)
1311 (let* ((caption (cdr (assq 'caption cont)))
1312 (header (cdr (assq 'thead cont)))
1313 (body (or (cdr (assq 'tbody cont)) cont))
1314 (footer (cdr (assq 'tfoot cont)))
1315 (bgcolor (cdr (assq :bgcolor cont)))
1316 (start (point))
1317 (shr-stylesheet (nconc (list (cons 'background-color bgcolor))
1318 shr-stylesheet))
1319 (nheader (if header (shr-max-columns header)))
1320 (nbody (if body (shr-max-columns body)))
1321 (nfooter (if footer (shr-max-columns footer))))
1322 (if (and (not caption)
1323 (not header)
1324 (not (cdr (assq 'tbody cont)))
1325 (not (cdr (assq 'tr cont)))
1326 (not footer))
1327 ;; The table is totally invalid and just contains random junk.
1328 ;; Try to output it anyway.
1329 (shr-generic cont)
1330 ;; It's a real table, so render it.
1331 (shr-tag-table-1
1332 (nconc
1333 (if caption `((tr (td ,@caption))))
1334 (if header
1335 (if footer
1336 ;; hader + body + footer
1337 (if (= nheader nbody)
1338 (if (= nbody nfooter)
1339 `((tr (td (table (tbody ,@header ,@body ,@footer)))))
1340 (nconc `((tr (td (table (tbody ,@header ,@body)))))
1341 (if (= nfooter 1)
1342 footer
1343 `((tr (td (table (tbody ,@footer))))))))
1344 (nconc `((tr (td (table (tbody ,@header)))))
1345 (if (= nbody nfooter)
1346 `((tr (td (table (tbody ,@body ,@footer)))))
1347 (nconc `((tr (td (table (tbody ,@body)))))
1348 (if (= nfooter 1)
1349 footer
1350 `((tr (td (table (tbody ,@footer))))))))))
1351 ;; header + body
1352 (if (= nheader nbody)
1353 `((tr (td (table (tbody ,@header ,@body)))))
1354 (if (= nheader 1)
1355 `(,@header (tr (td (table (tbody ,@body)))))
1356 `((tr (td (table (tbody ,@header))))
1357 (tr (td (table (tbody ,@body))))))))
1358 (if footer
1359 ;; body + footer
1360 (if (= nbody nfooter)
1361 `((tr (td (table (tbody ,@body ,@footer)))))
1362 (nconc `((tr (td (table (tbody ,@body)))))
1363 (if (= nfooter 1)
1364 footer
1365 `((tr (td (table (tbody ,@footer))))))))
1366 (if caption
1367 `((tr (td (table (tbody ,@body)))))
1368 body))))))
1369 (when bgcolor
1370 (shr-colorize-region start (point) (cdr (assq 'color shr-stylesheet))
1371 bgcolor))
1372 ;; Finally, insert all the images after the table. The Emacs buffer
1373 ;; model isn't strong enough to allow us to put the images actually
1374 ;; into the tables.
1375 (when (zerop shr-table-depth)
1376 (dolist (elem (shr-find-elements cont 'img))
1377 (shr-tag-img (cdr elem))))))
1379 (defun shr-find-elements (cont type)
1380 (let (result)
1381 (dolist (elem cont)
1382 (cond ((eq (car elem) type)
1383 (push elem result))
1384 ((consp (cdr elem))
1385 (setq result (nconc (shr-find-elements (cdr elem) type) result)))))
1386 (nreverse result)))
1388 (defun shr-insert-table (table widths)
1389 (let* ((collapse (equal (cdr (assq 'border-collapse shr-stylesheet))
1390 "collapse"))
1391 (shr-table-separator-length (if collapse 0 1))
1392 (shr-table-vertical-line (if collapse "" shr-table-vertical-line)))
1393 (unless collapse
1394 (shr-insert-table-ruler widths))
1395 (dolist (row table)
1396 (let ((start (point))
1397 (height (let ((max 0))
1398 (dolist (column row)
1399 (setq max (max max (cadr column))))
1400 max)))
1401 (dotimes (i height)
1402 (shr-indent)
1403 (insert shr-table-vertical-line "\n"))
1404 (dolist (column row)
1405 (goto-char start)
1406 (let ((lines (nth 2 column)))
1407 (dolist (line lines)
1408 (end-of-line)
1409 (insert line shr-table-vertical-line)
1410 (forward-line 1))
1411 ;; Add blank lines at padding at the bottom of the TD,
1412 ;; possibly.
1413 (dotimes (i (- height (length lines)))
1414 (end-of-line)
1415 (let ((start (point)))
1416 (insert (make-string (string-width (car lines)) ? )
1417 shr-table-vertical-line)
1418 (when (nth 4 column)
1419 (shr-add-font start (1- (point))
1420 (list :background (nth 4 column)))))
1421 (forward-line 1)))))
1422 (unless collapse
1423 (shr-insert-table-ruler widths)))))
1425 (defun shr-insert-table-ruler (widths)
1426 (when shr-table-horizontal-line
1427 (when (and (bolp)
1428 (> shr-indentation 0))
1429 (shr-indent))
1430 (insert shr-table-corner)
1431 (dotimes (i (length widths))
1432 (insert (make-string (aref widths i) shr-table-horizontal-line)
1433 shr-table-corner))
1434 (insert "\n")))
1436 (defun shr-table-widths (table natural-table suggested-widths)
1437 (let* ((length (length suggested-widths))
1438 (widths (make-vector length 0))
1439 (natural-widths (make-vector length 0)))
1440 (dolist (row table)
1441 (let ((i 0))
1442 (dolist (column row)
1443 (aset widths i (max (aref widths i) column))
1444 (setq i (1+ i)))))
1445 (dolist (row natural-table)
1446 (let ((i 0))
1447 (dolist (column row)
1448 (aset natural-widths i (max (aref natural-widths i) column))
1449 (setq i (1+ i)))))
1450 (let ((extra (- (apply '+ (append suggested-widths nil))
1451 (apply '+ (append widths nil))))
1452 (expanded-columns 0))
1453 ;; We have extra, unused space, so divide this space amongst the
1454 ;; columns.
1455 (when (> extra 0)
1456 ;; If the natural width is wider than the rendered width, we
1457 ;; want to allow the column to expand.
1458 (dotimes (i length)
1459 (when (> (aref natural-widths i) (aref widths i))
1460 (setq expanded-columns (1+ expanded-columns))))
1461 (dotimes (i length)
1462 (when (> (aref natural-widths i) (aref widths i))
1463 (aset widths i (min
1464 (aref natural-widths i)
1465 (+ (/ extra expanded-columns)
1466 (aref widths i))))))))
1467 widths))
1469 (defun shr-make-table (cont widths &optional fill)
1470 (or (cadr (assoc (list cont widths fill) shr-content-cache))
1471 (let ((data (shr-make-table-1 cont widths fill)))
1472 (push (list (list cont widths fill) data)
1473 shr-content-cache)
1474 data)))
1476 (defun shr-make-table-1 (cont widths &optional fill)
1477 (let ((trs nil)
1478 (shr-inhibit-decoration (not fill))
1479 (rowspans (make-vector (length widths) 0))
1480 width colspan)
1481 (dolist (row cont)
1482 (when (eq (car row) 'tr)
1483 (let ((tds nil)
1484 (columns (cdr row))
1485 (i 0)
1486 (width-column 0)
1487 column)
1488 (while (< i (length widths))
1489 ;; If we previously had a rowspan definition, then that
1490 ;; means that we now have a "missing" td/th element here.
1491 ;; So just insert a dummy, empty one to (sort of) emulate
1492 ;; rowspan.
1493 (setq column
1494 (if (zerop (aref rowspans i))
1495 (pop columns)
1496 (aset rowspans i (1- (aref rowspans i)))
1497 '(td)))
1498 (when (or (memq (car column) '(td th))
1499 (not column))
1500 (when (cdr (assq :rowspan (cdr column)))
1501 (aset rowspans i (+ (aref rowspans i)
1502 (1- (string-to-number
1503 (cdr (assq :rowspan (cdr column))))))))
1504 ;; Sanity check for invalid column-spans.
1505 (when (>= width-column (length widths))
1506 (setq width-column 0))
1507 (setq width
1508 (if column
1509 (aref widths width-column)
1510 10))
1511 (when (and fill
1512 (setq colspan (cdr (assq :colspan (cdr column)))))
1513 (setq colspan (min (string-to-number colspan)
1514 ;; The colspan may be wrong, so
1515 ;; truncate it to the length of the
1516 ;; remaining columns.
1517 (- (length widths) i)))
1518 (dotimes (j (1- colspan))
1519 (if (> (+ i 1 j) (1- (length widths)))
1520 (setq width (aref widths (1- (length widths))))
1521 (setq width (+ width
1522 shr-table-separator-length
1523 (aref widths (+ i 1 j))))))
1524 (setq width-column (+ width-column (1- colspan))))
1525 (when (or column
1526 (not fill))
1527 (push (shr-render-td (cdr column) width fill)
1528 tds))
1529 (setq i (1+ i)
1530 width-column (1+ width-column))))
1531 (push (nreverse tds) trs))))
1532 (nreverse trs)))
1534 (defun shr-render-td (cont width fill)
1535 (with-temp-buffer
1536 (let ((bgcolor (cdr (assq :bgcolor cont)))
1537 (fgcolor (cdr (assq :fgcolor cont)))
1538 (style (cdr (assq :style cont)))
1539 (shr-stylesheet shr-stylesheet)
1540 actual-colors)
1541 (when style
1542 (setq style (and (string-match "color" style)
1543 (shr-parse-style style))))
1544 (when bgcolor
1545 (setq style (nconc (list (cons 'background-color bgcolor)) style)))
1546 (when fgcolor
1547 (setq style (nconc (list (cons 'color fgcolor)) style)))
1548 (when style
1549 (setq shr-stylesheet (append style shr-stylesheet)))
1550 (let ((shr-width width)
1551 (shr-indentation 0))
1552 (shr-descend (cons 'td cont)))
1553 ;; Delete padding at the bottom of the TDs.
1554 (delete-region
1555 (point)
1556 (progn
1557 (skip-chars-backward " \t\n")
1558 (end-of-line)
1559 (point)))
1560 (goto-char (point-min))
1561 (let ((max 0))
1562 (while (not (eobp))
1563 (end-of-line)
1564 (setq max (max max (current-column)))
1565 (forward-line 1))
1566 (when fill
1567 (goto-char (point-min))
1568 ;; If the buffer is totally empty, then put a single blank
1569 ;; line here.
1570 (if (zerop (buffer-size))
1571 (insert (make-string width ? ))
1572 ;; Otherwise, fill the buffer.
1573 (let ((align (cdr (assq :align cont)))
1574 length)
1575 (while (not (eobp))
1576 (end-of-line)
1577 (setq length (- width (current-column)))
1578 (when (> length 0)
1579 (cond
1580 ((equal align "right")
1581 (beginning-of-line)
1582 (insert (make-string length ? )))
1583 ((equal align "center")
1584 (insert (make-string (/ length 2) ? ))
1585 (beginning-of-line)
1586 (insert (make-string (- length (/ length 2)) ? )))
1588 (insert (make-string length ? )))))
1589 (forward-line 1))))
1590 (when style
1591 (setq actual-colors
1592 (shr-colorize-region
1593 (point-min) (point-max)
1594 (cdr (assq 'color shr-stylesheet))
1595 (cdr (assq 'background-color shr-stylesheet))))))
1596 (if fill
1597 (list max
1598 (count-lines (point-min) (point-max))
1599 (split-string (buffer-string) "\n")
1601 (car actual-colors))
1602 max)))))
1604 (defun shr-buffer-width ()
1605 (goto-char (point-min))
1606 (let ((max 0))
1607 (while (not (eobp))
1608 (end-of-line)
1609 (setq max (max max (current-column)))
1610 (forward-line 1))
1611 max))
1613 (defun shr-pro-rate-columns (columns)
1614 (let ((total-percentage 0)
1615 (widths (make-vector (length columns) 0)))
1616 (dotimes (i (length columns))
1617 (setq total-percentage (+ total-percentage (aref columns i))))
1618 (setq total-percentage (/ 1.0 total-percentage))
1619 (dotimes (i (length columns))
1620 (aset widths i (max (truncate (* (aref columns i)
1621 total-percentage
1622 (- shr-width (1+ (length columns)))))
1623 10)))
1624 widths))
1626 ;; Return a summary of the number and shape of the TDs in the table.
1627 (defun shr-column-specs (cont)
1628 (let ((columns (make-vector (shr-max-columns cont) 1)))
1629 (dolist (row cont)
1630 (when (eq (car row) 'tr)
1631 (let ((i 0))
1632 (dolist (column (cdr row))
1633 (when (memq (car column) '(td th))
1634 (let ((width (cdr (assq :width (cdr column)))))
1635 (when (and width
1636 (string-match "\\([0-9]+\\)%" width)
1637 (not (zerop (setq width (string-to-number
1638 (match-string 1 width))))))
1639 (aset columns i (/ width 100.0))))
1640 (setq i (1+ i)))))))
1641 columns))
1643 (defun shr-count (cont elem)
1644 (let ((i 0))
1645 (dolist (sub cont)
1646 (when (eq (car sub) elem)
1647 (setq i (1+ i))))
1650 (defun shr-max-columns (cont)
1651 (let ((max 0))
1652 (dolist (row cont)
1653 (when (eq (car row) 'tr)
1654 (setq max (max max (+ (shr-count (cdr row) 'td)
1655 (shr-count (cdr row) 'th))))))
1656 max))
1658 (provide 'shr)
1660 ;; Local Variables:
1661 ;; coding: utf-8
1662 ;; End:
1664 ;;; shr.el ends here