org-src.el 24.5 KB
Newer Older
1 2
;;; org-src.el --- Source code examples in Org
;;
Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 5 6 7
;;   Free Software Foundation, Inc.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;;	   Bastien Guerry <bzg AT altern DOT org>
8
;;         Dan Davison <davison at stats dot ox dot ac dot uk>
9 10
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
11
;; Version: 6.35i
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:

;; This file contains the code dealing with source code examples in Org-mode.

;;; Code:

(require 'org-macs)
(require 'org-compat)
37 38
(eval-when-compile
  (require 'cl))
39 40

(declare-function org-do-remove-indentation "org" (&optional n))
41
(declare-function org-at-table.el-p "org" ())
42
(declare-function org-get-indentation "org" (&optional line))
43
(declare-function org-switch-to-buffer-other-window "org" (&rest args))
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88

(defcustom org-edit-src-region-extra nil
  "Additional regexps to identify regions for editing with `org-edit-src-code'.
For examples see the function `org-edit-src-find-region-and-lang'.
The regular expression identifying the begin marker should end with a newline,
and the regexp marking the end line should start with a newline, to make sure
there are kept outside the narrowed region."
  :group 'org-edit-structure
  :type '(repeat
	  (list
	   (regexp :tag "begin regexp")
	   (regexp :tag "end regexp")
	   (choice :tag "language"
		   (string :tag "specify")
		   (integer :tag "from match group")
		   (const :tag "from `lang' element")
		   (const :tag "from `style' element")))))

(defcustom org-coderef-label-format "(ref:%s)"
  "The default coderef format.
This format string will be used to search for coderef labels in literal
examples (EXAMPLE and SRC blocks).  The format can be overwritten in
an individual literal example with the -f option, like

#+BEGIN_SRC pascal +n -r -l \"((%s))\"
...
#+END_SRC

If you want to use this for HTML export, make sure that the format does
not introduce special font-locking, and avoid the HTML special
characters `<', `>', and `&'.  The reason for this restriction is that
the labels are searched for only after htmlize has done its job."
  :group 'org-edit-structure ; FIXME this is not in the right group
  :type 'string)

(defcustom org-edit-fixed-width-region-mode 'artist-mode
  "The mode that should be used to edit fixed-width regions.
These are the regions where each line starts with a colon."
  :group 'org-edit-structure
  :type '(choice
	  (const artist-mode)
	  (const picture-mode)
	  (const fundamental-mode)
	  (function :tag "Other (specify)")))

89 90 91 92 93 94 95 96 97 98 99
(defcustom org-src-preserve-indentation nil
  "If non-nil, leading whitespace characters in source code
blocks are preserved on export, and when switching between the
org buffer and the language mode edit buffer. If this variable
is nil then, after editing with \\[org-edit-src-code], the
minimum (across-lines) number of leading whitespace characters
are removed from all lines, and the code block is uniformly
indented according to the value of `org-edit-src-content-indentation'."
  :group 'org-edit-structure
  :type 'boolean)

100
(defcustom org-edit-src-content-indentation 2
101
  "Indentation for the content of a source code block.
102 103
This should be the number of spaces added to the indentation of the #+begin
line in order to compute the indentation of the block content after
104 105
editing it with \\[org-edit-src-code]. Has no effect if
`org-src-preserve-indentation' is non-nil."
106 107 108 109 110 111 112 113 114 115 116
  :group 'org-edit-structure
  :type 'integer)

(defcustom org-edit-src-persistent-message t
  "Non-nil means show persistent exit help message while editing src examples.
The message is shown in the header-line, which will be created in the
first line of the window showing the editing buffer.
When nil, the message will only be shown intermittently in the echo area."
  :group 'org-edit-structure
  :type 'boolean)

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
(defcustom org-src-window-setup 'reorganize-frame
  "How the source code edit buffer should be displayed.
Possible values for this option are:

current-window    Show edit buffer in the current window, keeping all other
                  windows.
other-window      Use `switch-to-buffer-other-window' to display edit buffer.
reorganize-frame  Show only two windows on the current frame, the current
                  window and the edit buffer. When exiting the edit buffer,
                  return to one window.
other-frame       Use `switch-to-buffer-other-frame' to display edit buffer.
                  Also, when exiting the edit buffer, kill that frame."
  :group 'org-edit-structure
  :type '(choice
	  (const current-window)
	  (const other-frame)
	  (const other-window)
	  (const reorganize-frame)))

136 137 138 139 140 141 142 143 144 145 146
(defvar org-src-mode-hook nil
  "Hook  run after Org switched a source code snippet to its Emacs mode.
This hook will run

- when editing a source code snippet with \"C-c '\".
- When formatting a source code snippet for export with htmlize.

You may want to use this hook for example to turn off `outline-minor-mode'
or similar things which you want to have when editing a source code file,
but which mess up the display of a snippet in Org exported files.")

147
(defcustom org-src-lang-modes
148
  '(("ocaml" . tuareg) ("elisp" . emacs-lisp) ("ditaa" . artist)
149
    ("asymptote" . asy) ("dot" . fundamental))
150 151 152 153 154 155 156 157 158 159 160 161 162
  "Alist mapping languages to their major mode.
The key is the language name, the value is the string that should
be inserted as the name of the major mode.  For many languages this is
simple, but for language where this is not the case, this variable
provides a way to simplify things on the user side.
For example, there is no ocaml-mode in Emacs, but the mode to use is
`tuareg-mode'."
  :group 'org-edit-structure
  :type '(repeat
	  (cons
	   (string "Language name")
	   (symbol "Major mode"))))

163 164 165 166 167 168 169 170 171 172
;;; Editing source examples

(defvar org-src-mode-map (make-sparse-keymap))
(define-key org-src-mode-map "\C-c'" 'org-edit-src-exit)
(defvar org-edit-src-force-single-line nil)
(defvar org-edit-src-from-org-mode nil)
(defvar org-edit-src-picture nil)
(defvar org-edit-src-beg-marker nil)
(defvar org-edit-src-end-marker nil)
(defvar org-edit-src-overlay nil)
173 174 175 176 177 178 179 180
(defvar org-edit-src-block-indentation nil)
(defvar org-edit-src-saved-temp-window-config nil)

(defvar org-src-ask-before-returning-to-edit-buffer t
  "If nil, when org-edit-src code is used on a block that already
  has an active edit buffer, it will switch to that edit buffer
  immediately; otherwise it will ask whether you want to return
  to the existing edit buffer.")
181 182 183 184 185 186 187 188 189

(define-minor-mode org-src-mode
  "Minor mode for language major mode buffers generated by org.
This minor mode is turned on in two situations:
- when editing a source code snippet with \"C-c '\".
- When formatting a source code snippet for export with htmlize.
There is a mode hook, and keybindings for `org-edit-src-exit' and
`org-edit-src-save'")

190
(defun org-edit-src-code (&optional context)
191 192 193 194
  "Edit the source code example at point.
The example is copied to a separate buffer, and that buffer is switched
to the correct language mode.  When done, exit with \\[org-edit-src-exit].
This will remove the original code in the Org buffer, and replace it with
195
the edited version. Optional argument CONTEXT is used by
196
\\[org-edit-src-save] when calling this function."
197
  (interactive)
198 199
  (unless (eq context 'save)
    (setq org-edit-src-saved-temp-window-config (current-window-configuration)))
200
  (let ((line (org-current-line))
201
	(col (current-column))
202 203 204 205 206 207 208
	(case-fold-search t)
	(msg (substitute-command-keys
	      "Edit, then exit with C-c ' (C-c and single quote)"))
	(info (org-edit-src-find-region-and-lang))
	(org-mode-p (eq major-mode 'org-mode))
	(beg (make-marker))
	(end (make-marker))
209 210
	(preserve-indentation org-src-preserve-indentation)
	block-nindent total-nindent ovl lang lang-f single lfmt code begline buffer)
211 212 213 214 215
    (if (not info)
	nil
      (setq beg (move-marker beg (nth 0 info))
	    end (move-marker end (nth 1 info))
	    code (buffer-substring-no-properties beg end)
216 217 218
	    lang (or (cdr (assoc (nth 2 info) org-src-lang-modes))
                     (nth 2 info))
	    lang (if (symbolp lang) (symbol-name lang) lang)
219 220
	    single (nth 3 info)
	    lfmt (nth 4 info)
221
	    block-nindent (nth 5 info)
222 223
	    lang-f (intern (concat lang "-mode"))
	    begline (save-excursion (goto-char beg) (org-current-line)))
224 225 226 227 228 229 230
      (if (equal lang-f 'table.el-mode)
	  (setq lang-f (lambda ()
			 (text-mode)
			 (if (org-bound-and-true-p flyspell-mode)
			     (flyspell-mode -1))
			 (table-recognize)
			 (org-set-local 'org-edit-src-content-indentation 0))))
231 232
      (unless (functionp lang-f)
	(error "No such language mode: %s" lang-f))
233
      (org-goto-line line)
234
      (if (and (setq buffer (org-edit-src-find-buffer beg end))
235 236 237
	       (if org-src-ask-before-returning-to-edit-buffer
		   (y-or-n-p "Return to existing edit buffer? [n] will revert changes: ") t))
	  (org-src-switch-to-buffer buffer 'return)
238 239 240 241 242
	(when buffer
	  (with-current-buffer buffer
	    (if (boundp 'org-edit-src-overlay)
		(org-delete-overlay org-edit-src-overlay)))
	  (kill-buffer buffer))
243
	(setq buffer (generate-new-buffer
244
		      (org-src-construct-edit-buffer-name (buffer-name) lang)))
245 246 247 248 249 250 251 252 253 254
	(setq ovl (org-make-overlay beg end))
	(org-overlay-put ovl 'edit-buffer buffer)
	(org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
	(org-overlay-put ovl 'face 'secondary-selection)
	(org-overlay-put ovl
			 'keymap
			 (let ((map (make-sparse-keymap)))
			   (define-key map [mouse-1] 'org-edit-src-continue)
			   map))
	(org-overlay-put ovl :read-only "Leave me alone")
255 256 257
	(org-src-switch-to-buffer buffer 'edit)
	(if (eq single 'macro-definition)
	    (setq code (replace-regexp-in-string "\\\\n" "\n" code t t)))
258 259 260
	(insert code)
	(remove-text-properties (point-min) (point-max)
				'(display nil invisible nil intangible nil))
261 262
	(unless preserve-indentation
	  (setq total-nindent (or (org-do-remove-indentation) 0)))
263
	(let ((org-inhibit-startup t))
264
	  (funcall lang-f))
265 266
	(set (make-local-variable 'org-edit-src-force-single-line) single)
	(set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
267
	(set (make-local-variable 'org-src-preserve-indentation) preserve-indentation)
268 269 270 271 272
	(when lfmt
	  (set (make-local-variable 'org-coderef-label-format) lfmt))
	(when org-mode-p
	  (goto-char (point-min))
	  (while (re-search-forward "^," nil t)
273
	    (if (eq (org-current-line) line) (setq total-nindent (1+ total-nindent)))
274
	    (replace-match "")))
275
	(org-goto-line (1+ (- line begline)))
276 277
	(org-move-to-column
	 (if preserve-indentation col (max 0 (- col total-nindent))))
278 279 280
	(org-set-local 'org-edit-src-beg-marker beg)
	(org-set-local 'org-edit-src-end-marker end)
	(org-set-local 'org-edit-src-overlay ovl)
281
	(org-set-local 'org-edit-src-block-indentation block-nindent)
282 283
	(org-src-mode)
	(set-buffer-modified-p nil)
284 285 286 287 288 289 290 291 292
	(and org-edit-src-persistent-message
	     (org-set-local 'header-line-format msg)))
      (message "%s" msg)
      t)))

(defun org-edit-src-continue (e)
  (interactive "e")
  (mouse-set-point e)
  (let ((buf (get-char-property (point) 'edit-buffer)))
293
    (if buf (org-src-switch-to-buffer buf 'continue)
294 295
      (error "Something is wrong here"))))

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
(defun org-src-switch-to-buffer (buffer context)
  (case org-src-window-setup
    ('current-window
     (switch-to-buffer buffer))
    ('other-window
     (switch-to-buffer-other-window buffer))
    ('other-frame
     (case context
       ('exit
	(let ((frame (selected-frame)))
	  (switch-to-buffer-other-frame buffer)
	  (delete-frame frame)))
       ('save
	(kill-buffer (current-buffer))
	(switch-to-buffer buffer))
       (t
	(switch-to-buffer-other-frame buffer))))
    ('reorganize-frame
     (if (eq context 'edit) (delete-other-windows))
     (org-switch-to-buffer-other-window buffer)
     (if (eq context 'exit) (delete-other-windows)))
    (t
     (message "Invalid value %s for org-src-window-setup"
	      (symbol-name org-src-window-setup))
     (switch-to-buffer buffer))))

322 323 324 325
(defun org-src-construct-edit-buffer-name (org-buffer-name lang)
  "Construct the buffer name for a source editing buffer"
  (concat "*Org Src " org-buffer-name "[ " lang " ]*"))

326 327 328 329 330 331
(defun org-edit-src-find-buffer (beg end)
  "Find a source editing buffer that is already editing the region BEG to END."
  (catch 'exit
    (mapc
     (lambda (b)
       (with-current-buffer b
332
	 (if (and (string-match "\\`*Org Src " (buffer-name))
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
		  (local-variable-p 'org-edit-src-beg-marker (current-buffer))
		  (local-variable-p 'org-edit-src-end-marker (current-buffer))
		  (equal beg org-edit-src-beg-marker)
		  (equal end org-edit-src-end-marker))
	     (throw 'exit (current-buffer)))))
     (buffer-list))
    nil))

(defun org-edit-fixed-width-region ()
  "Edit the fixed-width ascii drawing at point.
This must be a region where each line starts with a colon followed by
a space character.
An new buffer is created and the fixed-width region is copied into it,
and the buffer is switched into `artist-mode' for editing.  When done,
exit with \\[org-edit-src-exit].  The edited text will then replace
the fragment in the Org-mode buffer."
  (interactive)
  (let ((line (org-current-line))
351
	(col (current-column))
352 353 354 355 356 357
	(case-fold-search t)
	(msg (substitute-command-keys
	      "Edit, then exit with C-c ' (C-c and single quote)"))
	(org-mode-p (eq major-mode 'org-mode))
	(beg (make-marker))
	(end (make-marker))
358 359
	(preserve-indentation org-src-preserve-indentation)
	block-nindent ovl beg1 end1 code begline buffer)
360 361 362 363 364 365 366 367 368 369 370 371 372
    (beginning-of-line 1)
    (if (looking-at "[ \t]*[^:\n \t]")
	nil
      (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
	  (setq beg1 (point) end1 beg1)
	(save-excursion
	  (if (re-search-backward "^[ \t]*[^: \t]" nil 'move)
	      (setq beg1 (point-at-bol 2))
	    (setq beg1 (point))))
	(save-excursion
	  (if (re-search-forward "^[ \t]*[^: \t]" nil 'move)
	      (setq end1 (1- (match-beginning 0)))
	    (setq end1 (point))))
373
	(org-goto-line line))
374 375 376 377 378 379 380 381 382 383 384 385
      (setq beg (move-marker beg beg1)
	    end (move-marker end end1)
	    code (buffer-substring-no-properties beg end)
	    begline (save-excursion (goto-char beg) (org-current-line)))
      (if (and (setq buffer (org-edit-src-find-buffer beg end))
	       (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
	  (switch-to-buffer buffer)
	(when buffer
	  (with-current-buffer buffer
	    (if (boundp 'org-edit-src-overlay)
		(org-delete-overlay org-edit-src-overlay)))
	  (kill-buffer buffer))
386 387 388
	(setq buffer (generate-new-buffer
		      (org-src-construct-edit-buffer-name
		       (buffer-name) "Fixed Width")))
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
	(setq ovl (org-make-overlay beg end))
	(org-overlay-put ovl 'face 'secondary-selection)
	(org-overlay-put ovl 'edit-buffer buffer)
	(org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
	(org-overlay-put ovl 'face 'secondary-selection)
	(org-overlay-put ovl
			 'keymap
			 (let ((map (make-sparse-keymap)))
			   (define-key map [mouse-1] 'org-edit-src-continue)
			   map))
	(org-overlay-put ovl :read-only "Leave me alone")
	(switch-to-buffer buffer)
	(insert code)
	(remove-text-properties (point-min) (point-max)
				'(display nil invisible nil intangible nil))
404
	(setq block-nindent (or (org-do-remove-indentation) 0))
405 406 407 408 409 410 411 412 413 414 415
	(cond
	 ((eq org-edit-fixed-width-region-mode 'artist-mode)
	  (fundamental-mode)
	  (artist-mode 1))
       (t (funcall org-edit-fixed-width-region-mode)))
	(set (make-local-variable 'org-edit-src-force-single-line) nil)
	(set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
	(set (make-local-variable 'org-edit-src-picture) t)
	(goto-char (point-min))
	(while (re-search-forward "^[ \t]*: ?" nil t)
	  (replace-match ""))
416
	(org-goto-line (1+ (- line begline)))
417
	(org-move-to-column (max 0 (- col block-nindent 2)))
418 419 420
	(org-set-local 'org-edit-src-beg-marker beg)
	(org-set-local 'org-edit-src-end-marker end)
	(org-set-local 'org-edit-src-overlay ovl)
421 422 423
	(org-set-local 'org-edit-src-block-indentation block-nindent)
	(org-set-local 'org-edit-src-content-indentation 0)
	(org-set-local 'org-src-preserve-indentation nil)
424 425
	(org-src-mode)
	(set-buffer-modified-p nil)
426 427 428 429 430 431 432 433
	(and org-edit-src-persistent-message
	     (org-set-local 'header-line-format msg)))
      (message "%s" msg)
      t)))

(defun org-edit-src-find-region-and-lang ()
  "Find the region and language for a local edit.
Return a list with beginning and end of the region, a string representing
434
the language, a switch telling if the content should be in a single line."
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  (let ((re-list
	 (append
	  org-edit-src-region-extra
	  '(
	    ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
	    ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
	    ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
	    ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
	    ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
	    ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
	    ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
	    ("^[ \t]*#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n[ \t]*#\\+end_src" 2)
	    ("^[ \t]*#\\+begin_example.*\n" "\n[ \t]*#\\+end_example" "fundamental")
	    ("^[ \t]*#\\+html:" "\n" "html" single-line)
	    ("^[ \t]*#\\+begin_html.*\n" "\n[ \t]*#\\+end_html" "html")
	    ("^[ \t]*#\\+latex:" "\n" "latex" single-line)
	    ("^[ \t]*#\\+begin_latex.*\n" "\n[ \t]*#\\+end_latex" "latex")
	    ("^[ \t]*#\\+ascii:" "\n" "fundamental" single-line)
	    ("^[ \t]*#\\+begin_ascii.*\n" "\n[ \t]*#\\+end_ascii" "fundamental")
	    ("^[ \t]*#\\+docbook:" "\n" "xml" single-line)
455 456
	    ("^[ \t]*#\\+macro:[ \t]+\\S-+\\( \\|$\\)"
	     "\n" "fundamental" macro-definition)
457 458 459 460 461
	    ("^[ \t]*#\\+begin_docbook.*\n" "\n[ \t]*#\\+end_docbook" "xml")
	    )))
	(pos (point))
	re1 re2 single beg end lang lfmt match-re1 ind entry)
    (catch 'exit
462 463 464 465 466 467 468 469 470
      (when (org-at-table.el-p)
	(re-search-backward "^[\t]*[^ \t|\\+]" nil t)
	(setq beg (1+ (point-at-eol)))
	(goto-char beg)
	(or (re-search-forward "^[\t]*[^ \t|\\+]" nil t)
	    (progn (goto-char (point-max)) (newline)))
	(setq end (point-at-bol))
	(setq ind (org-edit-src-get-indentation beg))
	(throw 'exit (list beg end 'table.el nil nil ind)))
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
      (while (setq entry (pop re-list))
	(setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
	      single (nth 3 entry))
	(save-excursion
	  (if (or (looking-at re1)
		  (re-search-backward re1 nil t))
	      (progn
		(setq match-re1 (match-string 0))
		(setq beg (match-end 0)
		      lang (org-edit-src-get-lang lang)
		      lfmt (org-edit-src-get-label-format match-re1)
		      ind (org-edit-src-get-indentation (match-beginning 0)))
		(if (and (re-search-forward re2 nil t)
			 (>= (match-end 0) pos))
		    (throw 'exit (list beg (match-beginning 0)
				       lang single lfmt ind))))
	    (if (or (looking-at re2)
		    (re-search-forward re2 nil t))
		(progn
		  (setq end (match-beginning 0))
		  (if (and (re-search-backward re1 nil t)
			   (<= (match-beginning 0) pos))
		      (progn
			(setq lfmt (org-edit-src-get-label-format
				    (match-string 0))
			      ind (org-edit-src-get-indentation
				   (match-beginning 0)))
			(throw 'exit
			       (list (match-end 0) end
				     (org-edit-src-get-lang lang)
				     single lfmt ind))))))))))))

(defun org-edit-src-get-lang (lang)
  "Extract the src language."
  (let ((m (match-string 0)))
    (cond
     ((stringp lang) lang)
     ((integerp lang) (match-string lang))
     ((and (eq lang 'lang)
	   (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
      (match-string 1 m))
     ((and (eq lang 'style)
	   (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
      (match-string 1 m))
     (t "fundamental"))))

(defun org-edit-src-get-label-format (s)
  "Extract the label format."
  (save-match-data
    (if (string-match "-l[ \t]+\\\\?\"\\([^\t\r\n\"]+\\)\\\\?\"" s)
	(match-string 1 s))))

(defun org-edit-src-get-indentation (pos)
524
  "Count leading whitespace characters on line"
525 526 527 528
  (save-match-data
    (goto-char pos)
    (org-get-indentation)))

529
(defun org-edit-src-exit (&optional context)
530 531
  "Exit special edit and protect problematic lines."
  (interactive)
532 533
  (unless org-edit-src-from-org-mode
    (error "This is not a sub-editing buffer, something is wrong..."))
534
  (widen)
535 536 537 538 539 540 541 542 543 544
  (let* ((beg org-edit-src-beg-marker)
	 (end org-edit-src-end-marker)
	 (ovl org-edit-src-overlay)
	 (buffer (current-buffer))
	 (single (org-bound-and-true-p org-edit-src-force-single-line))
	 (macro (eq single 'macro-definition))
	 (total-nindent (+ (or org-edit-src-block-indentation 0)
			   org-edit-src-content-indentation))
	 (preserve-indentation org-src-preserve-indentation)
	 (delta 0) code line col indent)
545
    (unless preserve-indentation (untabify (point-min) (point-max)))
546 547 548
    (save-excursion
      (goto-char (point-min))
      (if (looking-at "[ \t\n]*\n") (replace-match ""))
549 550
      (unless macro
	(if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match ""))))
551 552
    (setq line (if (org-bound-and-true-p org-edit-src-force-single-line)
		   1
553 554 555 556 557
		 (org-current-line))
	  col (current-column))
    (when single
      (goto-char (point-min))
      (if (re-search-forward "\\s-+\\'" nil t) (replace-match ""))
558
      (goto-char (point-min))
559 560 561 562 563 564
      (let ((cnt 0))
	(while (re-search-forward "\n" nil t)
	  (setq cnt (1+ cnt))
	  (replace-match (if macro "\\n" " ") t t))
	(when (and macro (> cnt 0))
	  (goto-char (point-max)) (insert "\\n")))
565
      (goto-char (point-min))
566
      (if (looking-at "\\s-*") (replace-match " ")))
567 568 569 570
    (when (org-bound-and-true-p org-edit-src-from-org-mode)
      (goto-char (point-min))
      (while (re-search-forward
	      (if (org-mode-p) "^\\(.\\)" "^\\([*]\\|[ \t]*#\\+\\)") nil t)
571
	(if (eq (org-current-line) line) (setq delta (1+ delta)))
572 573
	(replace-match ",\\1")))
    (when (org-bound-and-true-p org-edit-src-picture)
574
      (setq preserve-indentation nil)
575 576 577 578
      (untabify (point-min) (point-max))
      (goto-char (point-min))
      (while (re-search-forward "^" nil t)
	(replace-match ": ")))
579 580
    (unless (or single preserve-indentation (= total-nindent 0))
      (setq indent (make-string total-nindent ?\ ))
581 582
      (goto-char (point-min))
      (while (re-search-forward "^" nil t)
583 584 585
	(replace-match indent)))
    (if (org-bound-and-true-p org-edit-src-picture)
	(setq total-nindent (+ total-nindent 2)))
586
    (setq code (buffer-string))
587
    (set-buffer-modified-p nil)
588
    (org-src-switch-to-buffer (marker-buffer beg) (or context 'exit))
589 590 591 592 593
    (kill-buffer buffer)
    (goto-char beg)
    (delete-region beg end)
    (insert code)
    (goto-char beg)
594
    (if single (just-one-space))
595 596 597 598 599 600 601 602 603
    (if (memq t (mapcar (lambda (overlay)
			  (eq (org-overlay-get overlay 'invisible)
			      'org-hide-block))
			(org-overlays-at (point))))
	;; Block is hidden; put point at start of block
	(beginning-of-line 0)
      ;; Block is visible, put point where it was in the code buffer
      (org-goto-line (1- (+ (org-current-line) line)))
      (org-move-to-column (if preserve-indentation col (+ col total-nindent delta))))
604
    (move-marker beg nil)
605 606 607 608 609
    (move-marker end nil))
  (unless (eq context 'save)
    (when org-edit-src-saved-temp-window-config
      (set-window-configuration org-edit-src-saved-temp-window-config)
      (setq org-edit-src-saved-temp-window-config nil))))
610 611 612 613

(defun org-edit-src-save ()
  "Save parent buffer with current state source-code buffer."
  (interactive)
614 615 616
  (let ((p (point)) (m (mark)) msg)
    (save-window-excursion
      (org-edit-src-exit 'save)
617 618
      (save-buffer)
      (setq msg (current-message))
619 620 621 622 623 624 625
      (if (eq org-src-window-setup 'other-frame)
	  (let ((org-src-window-setup 'current-window))
	    (org-edit-src-code 'save))
	(org-edit-src-code 'save)))
    (push-mark m 'nomessage)
    (goto-char (min p (point-max)))
    (message (or msg ""))))
626

627 628 629 630 631 632 633 634 635 636 637 638 639
(defun org-src-mode-configure-edit-buffer ()
  (when org-edit-src-from-org-mode
    (setq buffer-offer-save t)
    (setq buffer-file-name
	  (concat (buffer-file-name (marker-buffer org-edit-src-beg-marker))
		  "[" (buffer-name) "]"))
    (set (if (featurep 'xemacs) 'write-contents-hooks 'write-contents-functions)
	 '(org-edit-src-save))
    (org-add-hook 'kill-buffer-hook
		  '(lambda () (org-delete-overlay org-edit-src-overlay)) nil 'local)))

(org-add-hook 'org-src-mode-hook 'org-src-mode-configure-edit-buffer)

640 641 642 643
(provide 'org-src)

;; arch-tag: 6a1fc84f-dec7-47be-a416-64be56bea5d8
;;; org-src.el ends here