lisp/org-w3m.el

   1 ;;; org-w3m.el --- Support from copy and paste from w3m to Org-mode
   2
   3 ;; Copyright (C) 2008 Free Software Foundation, Inc.
   4
   5 ;; Author: Andy Stewart <lazycat dot manatee at gmail dot com>
   6 ;; Keywords: outlines, hypermedia, calendar, wp
   7 ;; Homepage: http://orgmode.org
   8 ;; Version: 6.17
   9 ;;
  10 ;; This file is part of GNU Emacs.
  11 ;;
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  25 ;;
  26 ;;; Commentary:
  27
  28 ;; This file implements copying HTML content from a w3m buffer and
  29 ;; transfomring the text on the fly so that it can be pasted into
  30 ;; an org-mode buffer with hot links.  It will also work for regions
  31 ;; in gnus buffers that have ben washed with w3m.
  32
  33 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  34 ;;
  35 ;;; Acknowledgements:
  36
  37 ;; Richard Riley <rileyrgdev at googlemail dot com>
  38 ;;
  39 ;;      The idea of transforming the HTML content with org-mode style is
  40 ;;      proposed by Richard, I'm just coding it.
  41 ;;
  42
  43 (require 'org)
  44 (declare-function w3m-anchor "ext:w3m-util" (position))
  45
  46 (defgroup org-w3m nil
  47   "Transforming the HTML content in w3m buffer with org-mode style."
  48   :group 'org)
  49
  50 (defcustom org-w3m-deactivate-mark t
  51   "Non-nil means, deactivate mark after copying and region in Org-mode style.
  52 When nil, keep the region active."
  53   :type 'boolean
  54   :group 'org-w3m)
  55
  56 (defun org-w3m-copy-for-org-mode ()
  57   "Copy current buffer content or active region with `org-mode' style links.
  58 This will encode `link-title' and `link-location' with
  59 `org-make-link-string', and insert the transformed test into the kill ring,
  60 so that it can be yanked into an Org-mode buffer with links working correctly."
  61   (interactive)
  62   (let* ((regionp (org-region-active-p))
  63          (transform-start (point-min))
  64          (transform-end (point-max))
  65          return-content
  66          link-location link-title
  67          temp-position out-bound)
  68     (when regionp
  69       (setq transform-start (region-beginning))
  70       (setq transform-end (region-end))
  71       ;; Deactivate mark if current mark is activate.
  72       (if org-w3m-deactivate-mark
  73           (deactivate-mark)))
  74     (message "Transforming links...")
  75     (save-excursion
  76       (goto-char transform-start)
  77       (while (and (not out-bound)                 ; still inside region to copy
  78                   (not (org-w3m-no-next-link-p))) ; no next link current buffer
  79         ;; store current point before jump next anchor
  80         (setq temp-position (point))
  81         ;; move to next anchor when current point is not at anchor
  82         (or (w3m-anchor (point)) (org-w3m-get-next-link-start))
  83         (if (<= (point) transform-end)  ; if point is inside transform bound
  84             (progn
  85               ;; get content between two links.
  86               (if (> (point) temp-position)
  87                   (setq return-content (concat return-content
  88                                                (buffer-substring
  89                                                 temp-position (point)))))
  90               ;; get link location at current point.
  91               (setq link-location (w3m-anchor (point)))
  92               ;; get link title at current point.
  93               (setq link-title (buffer-substring (point)
  94                                                  (org-w3m-get-anchor-end)))
  95               ;; concat `org-mode' style url to `return-content'.
  96               (setq return-content (concat return-content
  97                                            (org-make-link-string
  98                                             link-location link-title))))
  99           (goto-char temp-position)     ; reset point before jump next anchor
 100           (setq out-bound t)            ; for break out `while' loop
 101           ))
 102       ;; add the rest until end of the region to be copied
 103       (if (< (point) transform-end)
 104           (setq return-content
 105                 (concat return-content
 106                         (buffer-substring (point) transform-end))))
 107       (kill-new return-content)
 108       (message "Transforming links...done, use C-y to insert text into Org-mode file")
 109       (message "Copy with link transformation complete."))))
 110
 111 (defun org-w3m-get-anchor-start ()
 112   "Move cursor to the start of current anchor.  Return point."
 113   ;; get start position of anchor or current point
 114   (goto-char (or (previous-single-property-change (point) 'w3m-anchor-sequence)
 115                  (point))))
 116
 117 (defun org-w3m-get-anchor-end ()
 118   "Move cursor to the end of current anchor.  Return point."
 119   ;; get end position of anchor or point
 120   (goto-char (or (next-single-property-change (point) 'w3m-anchor-sequence)
 121                  (point))))
 122
 123 (defun org-w3m-get-next-link-start ()
 124   "Move cursor to the start of next link.  Return point."
 125   (catch 'reach
 126     (while (next-single-property-change (point) 'w3m-anchor-sequence)
 127       ;; jump to next anchor
 128       (goto-char (next-single-property-change (point) 'w3m-anchor-sequence))
 129       (when (w3m-anchor (point))
 130         ;; return point when current is valid link
 131         (throw 'reach nil))))
 132   (point))
 133
 134 (defun org-w3m-get-prev-link-start ()
 135   "Move cursor to the start of prevoius link.  Return point."
 136   (catch 'reach
 137     (while (previous-single-property-change (point) 'w3m-anchor-sequence)
 138       ;; jump to previous anchor
 139       (goto-char (previous-single-property-change (point) 'w3m-anchor-sequence))
 140       (when (w3m-anchor (point))
 141         ;; return point when current is valid link
 142         (throw 'reach nil))))
 143   (point))
 144
 145 (defun org-w3m-no-next-link-p ()
 146   "Whether there is no next link after the cursor.
 147 Return t if there is no next link; otherwise, return nil."
 148   (save-excursion
 149     (equal (point) (org-w3m-get-next-link-start))))
 150
 151 (defun org-w3m-no-prev-link-p ()
 152   "Whether there is no previous link after the cursor.
 153 Return t if there is no previous link; otherwise, return nil."
 154   (save-excursion
 155     (equal (point) (org-w3m-get-prev-link-start))))
 156
 157 ;; Install keys into the w3m keymap
 158 (defvar w3m-mode-map)
 159 (defvar w3m-minor-mode-map)
 160 (when (and (boundp 'w3m-mode-map)
 161            (keymapp w3m-mode-map))
 162   (define-key w3m-mode-map "\C-c\C-x\M-w" 'org-w3m-copy-for-org-mode)
 163   (define-key w3m-mode-map "\C-c\C-x\C-w" 'org-w3m-copy-for-org-mode))
 164 (when (and (boundp 'w3m-minor-mode-map)
 165            (keymapp w3m-minor-mode-map))
 166   (define-key w3m-minor-mode-map "\C-c\C-x\M-w" 'org-w3m-copy-for-org-mode)
 167   (define-key w3m-minor-mode-map "\C-c\C-x\C-w" 'org-w3m-copy-for-org-mode))
 168 (add-hook
 169  'w3m-mode-hook
 170  (lambda ()
 171    (define-key w3m-mode-map "\C-c\C-x\M-w" 'org-w3m-copy-for-org-mode)
 172    (define-key w3m-mode-map "\C-c\C-x\C-w" 'org-w3m-copy-for-org-mode)))
 173 (add-hook
 174  'w3m-minor-mode-hook
 175  (lambda ()
 176    (define-key w3m-minor-mode-map "\C-c\C-x\M-w" 'org-w3m-copy-for-org-mode)
 177    (define-key w3m-minor-mode-map "\C-c\C-x\C-w" 'org-w3m-copy-for-org-mode)))
 178
 179 (provide 'org-w3m)
 180
 181 ;; arch-tag: 851d7447-488d-49f0-a14d-46c092e84352
 182
 183 ;;; org-w3m.el ends here