Merge branch 'master' of https://git.gnus.org/gnus
[gnus] / lisp / shr.el
index 73011af..6499b35 100644 (file)
@@ -30,6 +30,7 @@
 
 ;;; Code:
 
+(eval-when-compile (require 'cl))
 (require 'browse-url)
 
 (defgroup shr nil
@@ -52,14 +53,31 @@ fit these criteria."
   :group 'shr
   :type 'regexp)
 
+(defcustom shr-table-line ?-
+  "Character used to draw table line."
+  :group 'shr
+  :type 'character)
+
+(defcustom shr-table-corner ?+
+  "Character used to draw table corner."
+  :group 'shr
+  :type 'character)
+
+(defcustom shr-hr-line ?-
+  "Character used to draw hr line."
+  :group 'shr
+  :type 'character)
+
+(defcustom shr-width fill-column
+  "Frame width to use for rendering."
+  :type 'integer
+  :group 'shr)
+
 (defvar shr-content-function nil
   "If bound, this should be a function that will return the content.
 This is used for cid: URLs, and the function is called with the
 cid: URL as the argument.")
 
-(defvar shr-width 70
-  "Frame width to use for rendering.")
-
 ;;; Internal variables.
 
 (defvar shr-folding-mode nil)
@@ -177,7 +195,8 @@ redirects somewhere else."
       (shr-descend sub)))))
 
 (defun shr-insert (text)
-  (when (eq shr-state 'image)
+  (when (and (eq shr-state 'image)
+            (not (string-match "\\`[ \t\n]+\\'" text)))
     (insert "\n")
     (setq shr-state nil))
   (cond
@@ -187,21 +206,10 @@ redirects somewhere else."
     (let ((first t)
          column)
       (when (and (string-match "\\`[ \t\n]" text)
-                (not (bolp)))
-       (insert " ")
-       (setq shr-state 'space))
+                (not (bolp))
+                (not (eq (char-after (1- (point))) ? )))
+       (insert " "))
       (dolist (elem (split-string text))
-       (setq column (current-column))
-       (when (> column 0)
-         (cond
-          ((and (or (not first)
-                    (eq shr-state 'space))
-                (> (+ column (length elem) 1) shr-width))
-           (insert "\n")
-           (put-text-property (1- (point)) (point) 'shr-break t))
-          ((not first)
-           (insert " "))))
-       (setq first nil)
        (when (and (bolp)
                   (> shr-indentation 0))
          (shr-indent))
@@ -210,12 +218,63 @@ redirects somewhere else."
        ;; starts.
        (unless shr-start
          (setq shr-start (point)))
-       (insert elem))
-      (setq shr-state nil)
-      (when (and (string-match "[ \t\n]\\'" text)
-                (not (bolp)))
-       (insert " ")
-       (setq shr-state 'space))))))
+       ;; No space is needed before or after a breakable character or
+       ;; at the beginning of a line.
+       (when (and (eq (preceding-char) ? )
+                  (or (= (line-beginning-position) (1- (point)))
+                      (aref fill-find-break-point-function-table
+                            (char-after (- (point) 2)))
+                      (aref fill-find-break-point-function-table
+                            (aref elem 0))))
+         (delete-char -1))
+       (insert elem)
+       (while (> (current-column) shr-width)
+         (unless (prog1
+                     (shr-find-fill-point)
+                   (when (eq (preceding-char) ? )
+                     (delete-char -1))
+                   (insert "\n"))
+           (put-text-property (1- (point)) (point) 'shr-break t)
+           ;; No space is needed at the beginning of a line.
+           (if (eq (following-char) ? )
+               (delete-char 1)))
+         (when (> shr-indentation 0)
+           (shr-indent))
+         (end-of-line))
+       (insert " "))
+      (unless (string-match "[ \t\n]\\'" text)
+       (delete-char -1))))))
+
+(eval-and-compile (autoload 'kinsoku-longer "kinsoku"))
+
+(defun shr-find-fill-point ()
+  (let ((found nil))
+    (while (and (not found)
+               (> (current-column) shr-indentation))
+      (when (and (or (eq (preceding-char) ? )
+                    (aref fill-find-break-point-function-table
+                          (preceding-char)))
+                (<= (current-column) shr-width))
+       (setq found t))
+      (backward-char 1)
+      (when (bolp)
+       ;; There's no breakable point, so we give it up.
+       (end-of-line)
+       (while (aref fill-find-break-point-function-table
+                    (preceding-char))
+         (backward-char 1))
+       (setq found 'failed)))
+    (cond ((eq found t)
+          ;; Don't put kinsoku-bol characters at the beginning of a line.
+          (or (eobp)
+              (kinsoku-longer)
+              (not (aref fill-find-break-point-function-table
+                         (following-char)))
+              (forward-char 1)))
+         (found t)
+         (t
+          (end-of-line)
+          nil))))
 
 (defun shr-ensure-newline ()
   (unless (zerop (current-column))
@@ -223,7 +282,7 @@ redirects somewhere else."
 
 (defun shr-ensure-paragraph ()
   (unless (bobp)
-    (if (bolp)
+    (if (<= (current-column) shr-indentation)
        (unless (save-excursion
                  (forward-line -1)
                  (looking-at " *$"))
@@ -235,7 +294,8 @@ redirects somewhere else."
        (insert "\n\n")))))
 
 (defun shr-indent ()
-  (insert (make-string shr-indentation ? )))
+  (when (> shr-indentation 0)
+    (insert (make-string shr-indentation ? ))))
 
 (defun shr-fontize-cont (cont &rest types)
   (let (shr-start)
@@ -310,7 +370,7 @@ Return a string with image data."
   (with-temp-buffer
     (mm-disable-multibyte)
     (when (ignore-errors
-           (url-cache-extract (url-cache-create-filename url))
+           (url-cache-extract (url-cache-create-filename (shr-encode-url url)))
            t)
       (when (or (search-forward "\n\n" nil t)
                (search-forward "\r\n\r\n" nil t))
@@ -325,6 +385,7 @@ Return a string with image data."
 
 (defun shr-tag-p (cont)
   (shr-ensure-paragraph)
+  (shr-indent)
   (shr-generic cont)
   (shr-ensure-paragraph))
 
@@ -349,59 +410,87 @@ Return a string with image data."
        shr-start)
     (shr-generic cont)
     (widget-convert-button
-     'link (or shr-start start) (point)
-     :help-echo url)
-    (put-text-property (or shr-start start) (point) 'keymap shr-map)
+     'url-link (or shr-start start) (point)
+     :help-echo url
+     :keymap shr-map
+     url)
     (put-text-property (or shr-start start) (point) 'shr-url url)))
 
+(defun shr-encode-url (url)
+  "Encode URL."
+  (browse-url-url-encode-chars url "[)$ ]"))
+
 (defun shr-tag-img (cont)
-  (when (and (> (current-column) 0)
-            (not (eq shr-state 'image)))
-    (insert "\n"))
-  (let ((start (point-marker)))
+  (when cont
+    (when (and (> (current-column) 0)
+              (not (eq shr-state 'image)))
+      (insert "\n"))
     (let ((alt (cdr (assq :alt cont)))
-         (url (cdr (assq :src cont))))
-      (when (zerop (length alt))
-       (setq alt "[img]"))
-      (cond
-       ((and (not shr-inhibit-images)
-            (string-match "\\`cid:" url))
-       (let ((url (substring url (match-end 0)))
-             image)
-         (if (or (not shr-content-function)
-                 (not (setq image (funcall shr-content-function url))))
-             (insert alt)
-           (shr-put-image image (point) alt))))
-       ((or shr-inhibit-images
-           (and shr-blocked-images
-                (string-match shr-blocked-images url)))
-       (setq shr-start (point))
-       (let ((shr-state 'space))
-         (if (> (length alt) 8)
-             (shr-insert (substring alt 0 8))
-           (shr-insert alt))))
-       ((url-is-cached (browse-url-url-encode-chars url "[&)$ ]"))
-       (shr-put-image (shr-get-image-data url) (point) alt))
-       (t
-       (insert alt)
-       (ignore-errors
-         (url-retrieve url 'shr-image-fetched
-                       (list (current-buffer) start (point-marker))
-                       t))))
-      (insert " ")
-      (put-text-property start (point) 'keymap shr-map)
-      (put-text-property start (point) 'shr-alt alt)
-      (put-text-property start (point) 'shr-image url)
-      (setq shr-state 'image))))
+         (url (cdr (assq :src cont)))
+         (width (cdr (assq :width cont))))
+      ;; Only respect align if width specified.
+      (when width
+       ;; Check that width is not larger than max width, otherwise ignore
+       ;; align
+       (let ((max-width (* shr-width (frame-char-width)))
+             (width (string-to-number width)))
+         (when (< width max-width)
+           (let ((align (cdr (assq :align cont))))
+             (cond
+              ((string= align "right")
+               (insert (propertize
+                        " " 'display
+                        `(space . (:align-to
+                                   ,(list (- max-width width)))))))
+              ((string= align "center")
+               (insert (propertize
+                        " " 'display
+                        `(space . (:balign-to
+                                   ,(list (- (/ max-width 2) width))))))))))))
+      (let ((start (point-marker)))
+       (when (zerop (length alt))
+         (setq alt "[img]"))
+       (cond
+        ((and (not shr-inhibit-images)
+              (string-match "\\`cid:" url))
+         (let ((url (substring url (match-end 0)))
+               image)
+           (if (or (not shr-content-function)
+                   (not (setq image (funcall shr-content-function url))))
+               (insert alt)
+             (shr-put-image image (point) alt))))
+        ((or shr-inhibit-images
+             (and shr-blocked-images
+                  (string-match shr-blocked-images url)))
+         (setq shr-start (point))
+         (let ((shr-state 'space))
+           (if (> (length alt) 8)
+               (shr-insert (substring alt 0 8))
+             (shr-insert alt))))
+        ((url-is-cached (shr-encode-url url))
+         (shr-put-image (shr-get-image-data url) (point) alt))
+        (t
+         (insert alt)
+         (ignore-errors
+           (url-retrieve (shr-encode-url url) 'shr-image-fetched
+                         (list (current-buffer) start (point-marker))
+                         t))))
+       (insert " ")
+       (put-text-property start (point) 'keymap shr-map)
+       (put-text-property start (point) 'shr-alt alt)
+       (put-text-property start (point) 'shr-image url)
+       (setq shr-state 'image)))))
 
 (defun shr-tag-pre (cont)
   (let ((shr-folding-mode 'none))
     (shr-ensure-newline)
+    (shr-indent)
     (shr-generic cont)
     (shr-ensure-newline)))
 
 (defun shr-tag-blockquote (cont)
   (shr-ensure-paragraph)
+  (shr-indent)
   (let ((shr-indentation (+ shr-indentation 4)))
     (shr-generic cont))
   (shr-ensure-paragraph))
@@ -409,14 +498,18 @@ Return a string with image data."
 (defun shr-tag-ul (cont)
   (shr-ensure-paragraph)
   (let ((shr-list-mode 'ul))
-    (shr-generic cont)))
+    (shr-generic cont))
+  (shr-ensure-paragraph))
 
 (defun shr-tag-ol (cont)
+  (shr-ensure-paragraph)
   (let ((shr-list-mode 1))
-    (shr-generic cont)))
+    (shr-generic cont))
+  (shr-ensure-paragraph))
 
 (defun shr-tag-li (cont)
-  (shr-ensure-newline)
+  (shr-ensure-paragraph)
+  (shr-indent)
   (let* ((bullet
          (if (numberp shr-list-mode)
              (prog1
@@ -429,7 +522,8 @@ Return a string with image data."
 
 (defun shr-tag-br (cont)
   (unless (bobp)
-    (insert "\n"))
+    (insert "\n")
+    (shr-indent))
   (shr-generic cont))
 
 (defun shr-tag-h1 (cont)
@@ -450,6 +544,10 @@ Return a string with image data."
 (defun shr-tag-h6 (cont)
   (shr-heading cont))
 
+(defun shr-tag-hr (cont)
+  (shr-ensure-newline)
+  (insert (make-string shr-width shr-hr-line) "\n"))
+
 ;;; Table rendering algorithm.
 
 ;; Table rendering is the only complicated thing here.  We do this by
@@ -474,6 +572,11 @@ Return a string with image data."
         ;; unbreakable text).
         (sketch (shr-make-table cont suggested-widths))
         (sketch-widths (shr-table-widths sketch suggested-widths)))
+    ;; This probably won't work very well.
+    (when (> (1+ (loop for width across sketch-widths
+                      summing (1+ width)))
+            (frame-width))
+      (setq truncate-lines t))
     ;; Then render the table again with these new "hard" widths.
     (shr-insert-table (shr-make-table cont sketch-widths t) sketch-widths))
   ;; Finally, insert all the images after the table.  The Emacs buffer
@@ -509,16 +612,15 @@ Return a string with image data."
              overlay overlay-line)
          (dolist (line lines)
            (setq overlay-line (pop overlay-lines))
-           (when (> (length line) 0)
-             (end-of-line)
-             (insert line "|")
-             (dolist (overlay overlay-line)
-               (let ((o (make-overlay (- (point) (nth 0 overlay) 1)
-                                      (- (point) (nth 1 overlay) 1)))
-                     (properties (nth 2 overlay)))
-                 (while properties
-                   (overlay-put o (pop properties) (pop properties)))))
-             (forward-line 1)))
+           (end-of-line)
+           (insert line "|")
+           (dolist (overlay overlay-line)
+             (let ((o (make-overlay (- (point) (nth 0 overlay) 1)
+                                    (- (point) (nth 1 overlay) 1)))
+                   (properties (nth 2 overlay)))
+               (while properties
+                 (overlay-put o (pop properties) (pop properties)))))
+           (forward-line 1))
          ;; Add blank lines at padding at the bottom of the TD,
          ;; possibly.
          (dotimes (i (- height (length lines)))
@@ -529,9 +631,9 @@ Return a string with image data."
 
 (defun shr-insert-table-ruler (widths)
   (shr-indent)
-  (insert "+")
+  (insert shr-table-corner)
   (dotimes (i (length widths))
-    (insert (make-string (aref widths i) ?-) ?+))
+    (insert (make-string (aref widths i) shr-table-line) shr-table-corner))
   (insert "\n"))
 
 (defun shr-table-widths (table suggested-widths)
@@ -546,8 +648,8 @@ Return a string with image data."
          (aset natural-widths i (max (aref natural-widths i)
                                      (cadr column)))
          (setq i (1+ i)))))
-    (let ((extra (- (reduce '+ suggested-widths)
-                   (reduce '+ widths)))
+    (let ((extra (- (apply '+ (append suggested-widths nil))
+                   (apply '+ (append widths nil))))
          (expanded-columns 0))
       (when (> extra 0)
        (dotimes (i length)