org-src.el 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. ;;; org-src.el --- Source code examples in Org
  2. ;;
  3. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
  4. ;; Free Software Foundation, Inc.
  5. ;;
  6. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  7. ;; Bastien Guerry <bzg AT altern DOT org>
  8. ;; Keywords: outlines, hypermedia, calendar, wp
  9. ;; Homepage: http://orgmode.org
  10. ;; Version: 6.27trans
  11. ;;
  12. ;; This file is part of GNU Emacs.
  13. ;;
  14. ;; GNU Emacs is free software: you can redistribute it and/or modify
  15. ;; it under the terms of the GNU General Public License as published by
  16. ;; the Free Software Foundation, either version 3 of the License, or
  17. ;; (at your option) any later version.
  18. ;; GNU Emacs is distributed in the hope that it will be useful,
  19. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21. ;; GNU General Public License for more details.
  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. ;; This file contains the code dealing with source code examples in Org-mode.
  28. ;;; Code:
  29. (require 'org-macs)
  30. (require 'org-compat)
  31. (declare-function org-do-remove-indentation "org" (&optional n))
  32. (declare-function org-get-indentation "org" (&optional line))
  33. (defcustom org-edit-src-region-extra nil
  34. "Additional regexps to identify regions for editing with `org-edit-src-code'.
  35. For examples see the function `org-edit-src-find-region-and-lang'.
  36. The regular expression identifying the begin marker should end with a newline,
  37. and the regexp marking the end line should start with a newline, to make sure
  38. there are kept outside the narrowed region."
  39. :group 'org-edit-structure
  40. :type '(repeat
  41. (list
  42. (regexp :tag "begin regexp")
  43. (regexp :tag "end regexp")
  44. (choice :tag "language"
  45. (string :tag "specify")
  46. (integer :tag "from match group")
  47. (const :tag "from `lang' element")
  48. (const :tag "from `style' element")))))
  49. (defcustom org-coderef-label-format "(ref:%s)"
  50. "The default coderef format.
  51. This format string will be used to search for coderef labels in literal
  52. examples (EXAMPLE and SRC blocks). The format can be overwritten
  53. an individual literal example with the -f option, like
  54. #+BEGIN_SRC pascal +n -r -l \"((%s))\"
  55. ...
  56. #+END_SRC
  57. If you want to use this for HTML export, make sure that the format does
  58. not introduce special font-locking, and avoid the HTML special
  59. characters `<', `>', and `&'. The reason for this restriction is that
  60. the labels are searched for only after htmlize has done its job."
  61. :group 'org-edit-structure ; FIXME this is not in the right group
  62. :type 'string)
  63. (defcustom org-edit-fixed-width-region-mode 'artist-mode
  64. "The mode that should be used to edit fixed-width regions.
  65. These are the regions where each line starts with a colon."
  66. :group 'org-edit-structure
  67. :type '(choice
  68. (const artist-mode)
  69. (const picture-mode)
  70. (const fundamental-mode)
  71. (function :tag "Other (specify)")))
  72. (defcustom org-edit-src-content-indentation 2
  73. "Indentation for the content is a source code block.
  74. This should be the number of spaces added to the indentation of the #+begin
  75. line in order to compute the indentation of the block content after
  76. editing it with \\[org-edit-src-code]."
  77. :group 'org-edit-structure
  78. :type 'integer)
  79. (defcustom org-edit-src-persistent-message t
  80. "Non-nil means show persistent exit help message while editing src examples.
  81. The message is shown in the header-line, which will be created in the
  82. first line of the window showing the editing buffer.
  83. When nil, the message will only be shown intermittently in the echo area."
  84. :group 'org-edit-structure
  85. :type 'boolean)
  86. (defvar org-src-mode-hook nil
  87. "Hook run after Org switched a source code snippet to its Emacs mode.
  88. This hook will run
  89. - when editing a source code snippet with \"C-c '\".
  90. - When formatting a source code snippet for export with htmlize.
  91. You may want to use this hook for example to turn off `outline-minor-mode'
  92. or similar things which you want to have when editing a source code file,
  93. but which mess up the display of a snippet in Org exported files.")
  94. (defvar org-protecting-blocks
  95. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  96. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  97. This is needed for font-lock setup.")
  98. ;;; Editing source examples
  99. (defvar org-src-mode-map (make-sparse-keymap))
  100. (define-key org-src-mode-map "\C-c'" 'org-edit-src-exit)
  101. (define-key org-src-mode-map "\C-x\C-s" 'org-edit-src-save)
  102. (defvar org-edit-src-force-single-line nil)
  103. (defvar org-edit-src-from-org-mode nil)
  104. (defvar org-edit-src-picture nil)
  105. (defvar org-edit-src-beg-marker nil)
  106. (defvar org-edit-src-end-marker nil)
  107. (defvar org-edit-src-overlay nil)
  108. (defvar org-edit-src-nindent nil)
  109. (define-minor-mode org-src-mode
  110. "Minor mode for language major mode buffers generated by org.
  111. This minor mode is turned on in two situations:
  112. - when editing a source code snippet with \"C-c '\".
  113. - When formatting a source code snippet for export with htmlize.
  114. There is a mode hook, and keybindings for `org-edit-src-exit' and
  115. `org-edit-src-save'")
  116. (defun org-edit-src-code ()
  117. "Edit the source code example at point.
  118. The example is copied to a separate buffer, and that buffer is switched
  119. to the correct language mode. When done, exit with \\[org-edit-src-exit].
  120. This will remove the original code in the Org buffer, and replace it with
  121. the edited version."
  122. (interactive)
  123. (let ((line (org-current-line))
  124. (case-fold-search t)
  125. (msg (substitute-command-keys
  126. "Edit, then exit with C-c ' (C-c and single quote)"))
  127. (info (org-edit-src-find-region-and-lang))
  128. (org-mode-p (eq major-mode 'org-mode))
  129. (beg (make-marker))
  130. (end (make-marker))
  131. nindent ovl lang lang-f single lfmt code begline buffer)
  132. (if (not info)
  133. nil
  134. (setq beg (move-marker beg (nth 0 info))
  135. end (move-marker end (nth 1 info))
  136. code (buffer-substring-no-properties beg end)
  137. lang (nth 2 info)
  138. single (nth 3 info)
  139. lfmt (nth 4 info)
  140. nindent (nth 5 info)
  141. lang-f (intern (concat lang "-mode"))
  142. begline (save-excursion (goto-char beg) (org-current-line)))
  143. (unless (functionp lang-f)
  144. (error "No such language mode: %s" lang-f))
  145. (goto-line line)
  146. (if (and (setq buffer (org-edit-src-find-buffer beg end))
  147. (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
  148. (switch-to-buffer buffer)
  149. (when buffer
  150. (with-current-buffer buffer
  151. (if (boundp 'org-edit-src-overlay)
  152. (org-delete-overlay org-edit-src-overlay)))
  153. (kill-buffer buffer))
  154. (setq buffer (generate-new-buffer "*Org Edit Src Example*"))
  155. (setq ovl (org-make-overlay beg end))
  156. (org-overlay-put ovl 'face 'secondary-selection)
  157. (org-overlay-put ovl 'edit-buffer buffer)
  158. (org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
  159. (org-overlay-put ovl 'face 'secondary-selection)
  160. (org-overlay-put ovl
  161. 'keymap
  162. (let ((map (make-sparse-keymap)))
  163. (define-key map [mouse-1] 'org-edit-src-continue)
  164. map))
  165. (org-overlay-put ovl :read-only "Leave me alone")
  166. (switch-to-buffer buffer)
  167. (insert code)
  168. (remove-text-properties (point-min) (point-max)
  169. '(display nil invisible nil intangible nil))
  170. (org-do-remove-indentation)
  171. (let ((org-inhibit-startup t))
  172. (funcall lang-f)
  173. (org-src-mode))
  174. (set (make-local-variable 'org-edit-src-force-single-line) single)
  175. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  176. (when lfmt
  177. (set (make-local-variable 'org-coderef-label-format) lfmt))
  178. (when org-mode-p
  179. (goto-char (point-min))
  180. (while (re-search-forward "^," nil t)
  181. (replace-match "")))
  182. (goto-line (1+ (- line begline)))
  183. (org-set-local 'org-edit-src-beg-marker beg)
  184. (org-set-local 'org-edit-src-end-marker end)
  185. (org-set-local 'org-edit-src-overlay ovl)
  186. (org-set-local 'org-edit-src-nindent nindent)
  187. (and org-edit-src-persistent-message
  188. (org-set-local 'header-line-format msg)))
  189. (message "%s" msg)
  190. t)))
  191. (defun org-edit-src-continue (e)
  192. (interactive "e")
  193. (mouse-set-point e)
  194. (let ((buf (get-char-property (point) 'edit-buffer)))
  195. (if buf (switch-to-buffer buf)
  196. (error "Something is wrong here"))))
  197. (defun org-edit-src-find-buffer (beg end)
  198. "Find a source editing buffer that is already editing the region BEG to END."
  199. (catch 'exit
  200. (mapc
  201. (lambda (b)
  202. (with-current-buffer b
  203. (if (and (string-match "\\`*Org Edit " (buffer-name))
  204. (local-variable-p 'org-edit-src-beg-marker (current-buffer))
  205. (local-variable-p 'org-edit-src-end-marker (current-buffer))
  206. (equal beg org-edit-src-beg-marker)
  207. (equal end org-edit-src-end-marker))
  208. (throw 'exit (current-buffer)))))
  209. (buffer-list))
  210. nil))
  211. (defun org-edit-fixed-width-region ()
  212. "Edit the fixed-width ascii drawing at point.
  213. This must be a region where each line starts with a colon followed by
  214. a space character.
  215. An new buffer is created and the fixed-width region is copied into it,
  216. and the buffer is switched into `artist-mode' for editing. When done,
  217. exit with \\[org-edit-src-exit]. The edited text will then replace
  218. the fragment in the Org-mode buffer."
  219. (interactive)
  220. (let ((line (org-current-line))
  221. (case-fold-search t)
  222. (msg (substitute-command-keys
  223. "Edit, then exit with C-c ' (C-c and single quote)"))
  224. (org-mode-p (eq major-mode 'org-mode))
  225. (beg (make-marker))
  226. (end (make-marker))
  227. nindent ovl beg1 end1 code begline buffer)
  228. (beginning-of-line 1)
  229. (if (looking-at "[ \t]*[^:\n \t]")
  230. nil
  231. (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
  232. (setq beg1 (point) end1 beg1)
  233. (save-excursion
  234. (if (re-search-backward "^[ \t]*[^: \t]" nil 'move)
  235. (setq beg1 (point-at-bol 2))
  236. (setq beg1 (point))))
  237. (save-excursion
  238. (if (re-search-forward "^[ \t]*[^: \t]" nil 'move)
  239. (setq end1 (1- (match-beginning 0)))
  240. (setq end1 (point))))
  241. (goto-line line))
  242. (setq beg (move-marker beg beg1)
  243. end (move-marker end end1)
  244. code (buffer-substring-no-properties beg end)
  245. begline (save-excursion (goto-char beg) (org-current-line)))
  246. (if (and (setq buffer (org-edit-src-find-buffer beg end))
  247. (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
  248. (switch-to-buffer buffer)
  249. (when buffer
  250. (with-current-buffer buffer
  251. (if (boundp 'org-edit-src-overlay)
  252. (org-delete-overlay org-edit-src-overlay)))
  253. (kill-buffer buffer))
  254. (setq buffer (generate-new-buffer "*Org Edit Src Example*"))
  255. (setq ovl (org-make-overlay beg end))
  256. (org-overlay-put ovl 'face 'secondary-selection)
  257. (org-overlay-put ovl 'edit-buffer buffer)
  258. (org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
  259. (org-overlay-put ovl 'face 'secondary-selection)
  260. (org-overlay-put ovl
  261. 'keymap
  262. (let ((map (make-sparse-keymap)))
  263. (define-key map [mouse-1] 'org-edit-src-continue)
  264. map))
  265. (org-overlay-put ovl :read-only "Leave me alone")
  266. (switch-to-buffer buffer)
  267. (insert code)
  268. (remove-text-properties (point-min) (point-max)
  269. '(display nil invisible nil intangible nil))
  270. (setq nindent (org-do-remove-indentation))
  271. (cond
  272. ((eq org-edit-fixed-width-region-mode 'artist-mode)
  273. (fundamental-mode)
  274. (artist-mode 1))
  275. (t (funcall org-edit-fixed-width-region-mode)))
  276. (set (make-local-variable 'org-edit-src-force-single-line) nil)
  277. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  278. (set (make-local-variable 'org-edit-src-picture) t)
  279. (goto-char (point-min))
  280. (while (re-search-forward "^[ \t]*: ?" nil t)
  281. (replace-match ""))
  282. (goto-line (1+ (- line begline)))
  283. (org-src-mode)
  284. (org-set-local 'org-edit-src-beg-marker beg)
  285. (org-set-local 'org-edit-src-end-marker end)
  286. (org-set-local 'org-edit-src-overlay ovl)
  287. (org-set-local 'org-edit-src-nindent nindent)
  288. (and org-edit-src-persistent-message
  289. (org-set-local 'header-line-format msg)))
  290. (message "%s" msg)
  291. t)))
  292. (defun org-edit-src-find-region-and-lang ()
  293. "Find the region and language for a local edit.
  294. Return a list with beginning and end of the region, a string representing
  295. the language, a switch telling of the content should be in a single line."
  296. (let ((re-list
  297. (append
  298. org-edit-src-region-extra
  299. '(
  300. ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
  301. ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
  302. ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
  303. ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
  304. ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
  305. ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
  306. ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
  307. ("^[ \t]*#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n[ \t]*#\\+end_src" 2)
  308. ("^[ \t]*#\\+begin_example.*\n" "\n[ \t]*#\\+end_example" "fundamental")
  309. ("^[ \t]*#\\+html:" "\n" "html" single-line)
  310. ("^[ \t]*#\\+begin_html.*\n" "\n[ \t]*#\\+end_html" "html")
  311. ("^[ \t]*#\\+latex:" "\n" "latex" single-line)
  312. ("^[ \t]*#\\+begin_latex.*\n" "\n[ \t]*#\\+end_latex" "latex")
  313. ("^[ \t]*#\\+ascii:" "\n" "fundamental" single-line)
  314. ("^[ \t]*#\\+begin_ascii.*\n" "\n[ \t]*#\\+end_ascii" "fundamental")
  315. ("^[ \t]*#\\+docbook:" "\n" "xml" single-line)
  316. ("^[ \t]*#\\+begin_docbook.*\n" "\n[ \t]*#\\+end_docbook" "xml")
  317. )))
  318. (pos (point))
  319. re1 re2 single beg end lang lfmt match-re1 ind entry)
  320. (catch 'exit
  321. (while (setq entry (pop re-list))
  322. (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
  323. single (nth 3 entry))
  324. (save-excursion
  325. (if (or (looking-at re1)
  326. (re-search-backward re1 nil t))
  327. (progn
  328. (setq match-re1 (match-string 0))
  329. (setq beg (match-end 0)
  330. lang (org-edit-src-get-lang lang)
  331. lfmt (org-edit-src-get-label-format match-re1)
  332. ind (org-edit-src-get-indentation (match-beginning 0)))
  333. (if (and (re-search-forward re2 nil t)
  334. (>= (match-end 0) pos))
  335. (throw 'exit (list beg (match-beginning 0)
  336. lang single lfmt ind))))
  337. (if (or (looking-at re2)
  338. (re-search-forward re2 nil t))
  339. (progn
  340. (setq end (match-beginning 0))
  341. (if (and (re-search-backward re1 nil t)
  342. (<= (match-beginning 0) pos))
  343. (progn
  344. (setq lfmt (org-edit-src-get-label-format
  345. (match-string 0))
  346. ind (org-edit-src-get-indentation
  347. (match-beginning 0)))
  348. (throw 'exit
  349. (list (match-end 0) end
  350. (org-edit-src-get-lang lang)
  351. single lfmt ind))))))))))))
  352. (defun org-edit-src-get-lang (lang)
  353. "Extract the src language."
  354. (let ((m (match-string 0)))
  355. (cond
  356. ((stringp lang) lang)
  357. ((integerp lang) (match-string lang))
  358. ((and (eq lang 'lang)
  359. (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
  360. (match-string 1 m))
  361. ((and (eq lang 'style)
  362. (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
  363. (match-string 1 m))
  364. (t "fundamental"))))
  365. (defun org-edit-src-get-label-format (s)
  366. "Extract the label format."
  367. (save-match-data
  368. (if (string-match "-l[ \t]+\\\\?\"\\([^\t\r\n\"]+\\)\\\\?\"" s)
  369. (match-string 1 s))))
  370. (defun org-edit-src-get-indentation (pos)
  371. "Extract the label format."
  372. (save-match-data
  373. (goto-char pos)
  374. (org-get-indentation)))
  375. (defun org-edit-src-exit ()
  376. "Exit special edit and protect problematic lines."
  377. (interactive)
  378. (unless (string-match "\\`*Org Edit " (buffer-name (current-buffer)))
  379. (error "This is not an sub-editing buffer, something is wrong..."))
  380. (let ((beg org-edit-src-beg-marker)
  381. (end org-edit-src-end-marker)
  382. (ovl org-edit-src-overlay)
  383. (buffer (current-buffer))
  384. (nindent org-edit-src-nindent)
  385. code line)
  386. (save-excursion
  387. (goto-char (point-min))
  388. (if (looking-at "[ \t\n]*\n") (replace-match ""))
  389. (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match "")))
  390. (setq line (if (org-bound-and-true-p org-edit-src-force-single-line)
  391. 1
  392. (org-current-line)))
  393. (when (org-bound-and-true-p org-edit-src-force-single-line)
  394. (goto-char (point-min))
  395. (while (re-search-forward "\n" nil t)
  396. (replace-match " "))
  397. (goto-char (point-min))
  398. (if (looking-at "\\s-*") (replace-match " "))
  399. (if (re-search-forward "\\s-+\\'" nil t)
  400. (replace-match "")))
  401. (when (org-bound-and-true-p org-edit-src-from-org-mode)
  402. (goto-char (point-min))
  403. (while (re-search-forward
  404. (if (org-mode-p) "^\\(.\\)" "^\\([*]\\|[ \t]*#\\+\\)") nil t)
  405. (replace-match ",\\1")))
  406. (when (org-bound-and-true-p org-edit-src-picture)
  407. (untabify (point-min) (point-max))
  408. (goto-char (point-min))
  409. (while (re-search-forward "^" nil t)
  410. (replace-match ": ")))
  411. (when nindent
  412. (setq nindent (make-string (+ org-edit-src-content-indentation nindent)
  413. ?\ ))
  414. (goto-char (point-min))
  415. (while (re-search-forward "^" nil t)
  416. (replace-match nindent)))
  417. (setq code (buffer-string))
  418. (switch-to-buffer (marker-buffer beg))
  419. (kill-buffer buffer)
  420. (goto-char beg)
  421. (org-delete-overlay ovl)
  422. (delete-region beg end)
  423. (insert code)
  424. (goto-char beg)
  425. (goto-line (1- (+ (org-current-line) line)))
  426. (move-marker beg nil)
  427. (move-marker end nil)))
  428. (defun org-edit-src-save ()
  429. "Save parent buffer with current state source-code buffer."
  430. (interactive)
  431. (let ((p (point)) (m (mark)) msg)
  432. (org-edit-src-exit)
  433. (save-buffer)
  434. (setq msg (current-message))
  435. (org-edit-src-code)
  436. (push-mark m 'nomessage)
  437. (goto-char (min p (point-max)))
  438. (message (or msg ""))))
  439. (provide 'org-src)
  440. ;; arch-tag: 6a1fc84f-dec7-47be-a416-64be56bea5d8
  441. ;;; org-src.el ends here