Replace org-mode-p with usual (eq major-mode 'org-mode) check
[org-mode.git] / lisp / org-table.el
1 ;;; org-table.el --- The table editor for Org-mode
2
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
26
27 ;; This file contains the table editor and spreadsheet for Org-mode.
28
29 ;; Watch out:  Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package.  We call the former org-type tables, and the latter
33 ;; table.el-type tables.
34
35 ;;; Code:
36
37 (eval-when-compile
38   (require 'cl))
39 (require 'org)
40
41 (declare-function org-table-clean-before-export "org-exp"
42                   (lines &optional maybe-quoted))
43 (declare-function org-format-org-table-html "org-html" (lines &optional splice))
44 (defvar orgtbl-mode) ; defined below
45 (defvar orgtbl-mode-menu) ; defined when orgtbl mode get initialized
46 (defvar org-export-html-table-tag) ; defined in org-exp.el
47 (defvar constants-unit-system)
48 (defvar org-table-follow-field-mode)
49
50 (defvar orgtbl-after-send-table-hook nil
51   "Hook for functions attaching to `C-c C-c', if the table is sent.
52 This can be used to add additional functionality after the table is sent
53 to the receiver position, othewise, if table is not sent, the functions
54 are not run.")
55
56 (defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized)
57   "Non-nil means use the optimized table editor version for `orgtbl-mode'.
58 In the optimized version, the table editor takes over all simple keys that
59 normally just insert a character.  In tables, the characters are inserted
60 in a way to minimize disturbing the table structure (i.e. in overwrite mode
61 for empty fields).  Outside tables, the correct binding of the keys is
62 restored.
63
64 The default for this option is t if the optimized version is also used in
65 Org-mode.  See the variable `org-enable-table-editor' for details.  Changing
66 this variable requires a restart of Emacs to become effective."
67   :group 'org-table
68   :type 'boolean)
69
70 (defcustom orgtbl-radio-table-templates
71   '((latex-mode "% BEGIN RECEIVE ORGTBL %n
72 % END RECEIVE ORGTBL %n
73 \\begin{comment}
74 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
75 | | |
76 \\end{comment}\n")
77     (texinfo-mode "@c BEGIN RECEIVE ORGTBL %n
78 @c END RECEIVE ORGTBL %n
79 @ignore
80 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
81 | | |
82 @end ignore\n")
83     (html-mode "<!-- BEGIN RECEIVE ORGTBL %n -->
84 <!-- END RECEIVE ORGTBL %n -->
85 <!--
86 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
87 | | |
88 -->\n"))
89   "Templates for radio tables in different major modes.
90 All occurrences of %n in a template will be replaced with the name of the
91 table, obtained by prompting the user."
92   :group 'org-table
93   :type '(repeat
94           (list (symbol :tag "Major mode")
95                 (string :tag "Format"))))
96
97 (defgroup org-table-settings nil
98   "Settings for tables in Org-mode."
99   :tag "Org Table Settings"
100   :group 'org-table)
101
102 (defcustom org-table-default-size "5x2"
103   "The default size for newly created tables, Columns x Rows."
104   :group 'org-table-settings
105    :type 'string)
106
107 (defcustom org-table-number-regexp
108   "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|\\(0[xX]\\)[0-9a-fA-F]+\\|nan\\)$"
109   "Regular expression for recognizing numbers in table columns.
110 If a table column contains mostly numbers, it will be aligned to the
111 right.  If not, it will be aligned to the left.
112
113 The default value of this option is a regular expression which allows
114 anything which looks remotely like a number as used in scientific
115 context.  For example, all of the following will be considered a
116 number:
117     12    12.2    2.4e-08    2x10^12    4.034+-0.02    2.7(10)  >3.5
118
119 Other options offered by the customize interface are more restrictive."
120   :group 'org-table-settings
121   :type '(choice
122           (const :tag "Positive Integers"
123                  "^[0-9]+$")
124           (const :tag "Integers"
125                  "^[-+]?[0-9]+$")
126           (const :tag "Floating Point Numbers"
127                  "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
128           (const :tag "Floating Point Number or Integer"
129                  "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
130           (const :tag "Exponential, Floating point, Integer"
131                  "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
132           (const :tag "Very General Number-Like, including hex"
133                  "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|\\(0[xX]\\)[0-9a-fA-F]+\\|nan\\)$")
134           (string :tag "Regexp:")))
135
136 (defcustom org-table-number-fraction 0.5
137   "Fraction of numbers in a column required to make the column align right.
138 In a column all non-white fields are considered.  If at least this
139 fraction of fields is matched by `org-table-number-fraction',
140 alignment to the right border applies."
141   :group 'org-table-settings
142   :type 'number)
143
144 (defgroup org-table-editing nil
145   "Behavior of tables during editing in Org-mode."
146   :tag "Org Table Editing"
147   :group 'org-table)
148
149 (defcustom org-table-automatic-realign t
150   "Non-nil means automatically re-align table when pressing TAB or RETURN.
151 When nil, aligning is only done with \\[org-table-align], or after column
152 removal/insertion."
153   :group 'org-table-editing
154   :type 'boolean)
155
156 (defcustom org-table-auto-blank-field t
157   "Non-nil means automatically blank table field when starting to type into it.
158 This only happens when typing immediately after a field motion
159 command (TAB, S-TAB or RET).
160 Only relevant when `org-enable-table-editor' is equal to `optimized'."
161   :group 'org-table-editing
162   :type 'boolean)
163
164 (defcustom org-table-exit-follow-field-mode-when-leaving-table t
165   "Non-nil means automatically exit the follow mode.
166 When nil, the follow mode will stay on and be active in any table
167 the cursor enters.  Since the table follow filed mode messes with the
168 window configuration, it is not recommended to set this variable to nil,
169 except maybe locally in a special file that has mostly tables with long
170 fields."
171   :group 'org-table
172   :type 'boolean)
173
174 (defcustom org-table-fix-formulas-confirm nil
175   "Whether the user should confirm when Org fixes formulas."
176   :group 'org-table-editing
177   :type '(choice
178           (const :tag "with yes-or-no" yes-or-no-p)
179           (const :tag "with y-or-n" y-or-n-p)
180           (const :tag "no confirmation" nil)))
181 (put 'org-table-fix-formulas-confirm
182      'safe-local-variable
183      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
184
185 (defcustom org-table-tab-jumps-over-hlines t
186   "Non-nil means tab in the last column of a table with jump over a hline.
187 If a horizontal separator line is following the current line,
188 `org-table-next-field' can either create a new row before that line, or jump
189 over the line.  When this option is nil, a new line will be created before
190 this line."
191   :group 'org-table-editing
192   :type 'boolean)
193
194 (defgroup org-table-calculation nil
195   "Options concerning tables in Org-mode."
196   :tag "Org Table Calculation"
197   :group 'org-table)
198
199 (defcustom org-table-use-standard-references 'from
200   "Should org-mode work with table references like B3 instead of @3$2?
201 Possible values are:
202 nil     never use them
203 from    accept as input, do not present for editing
204 t       accept as input and present for editing"
205   :group 'org-table-calculation
206   :type '(choice
207           (const :tag "Never, don't even check user input for them" nil)
208           (const :tag "Always, both as user input, and when editing" t)
209           (const :tag "Convert user input, don't offer during editing" from)))
210
211 (defcustom org-table-copy-increment t
212   "Non-nil means increment when copying current field with \\[org-table-copy-down]."
213   :group 'org-table-calculation
214   :type 'boolean)
215
216 (defcustom org-calc-default-modes
217   '(calc-internal-prec 12
218     calc-float-format  (float 8)
219     calc-angle-mode    deg
220     calc-prefer-frac   nil
221     calc-symbolic-mode nil
222     calc-date-format (YYYY "-" MM "-" DD " " Www (" " hh ":" mm))
223     calc-display-working-message t
224     )
225   "List with Calc mode settings for use in `calc-eval' for table formulas.
226 The list must contain alternating symbols (Calc modes variables and values).
227 Don't remove any of the default settings, just change the values.  Org-mode
228 relies on the variables to be present in the list."
229   :group 'org-table-calculation
230   :type 'plist)
231
232 (defcustom org-table-duration-custom-format 'hours
233   "Format for the output of calc computations like $1+$2;t.
234 The default value is 'hours, and will output the results as a
235 number of hours.  Other allowed values are 'seconds, 'minutes and
236 'days, and the output will be a fraction of seconds, minutes or
237 days."
238   :group 'org-table-calculation
239   :type '(choice (symbol :tag "Seconds" 'seconds)
240                  (symbol :tag "Minutes" 'minutes)
241                  (symbol :tag "Hours  " 'hours)
242                  (symbol :tag "Days   " 'days)))
243
244 (defcustom org-table-formula-evaluate-inline t
245   "Non-nil means TAB and RET evaluate a formula in current table field.
246 If the current field starts with an equal sign, it is assumed to be a formula
247 which should be evaluated as described in the manual and in the documentation
248 string of the command `org-table-eval-formula'.  This feature requires the
249 Emacs calc package.
250 When this variable is nil, formula calculation is only available through
251 the command \\[org-table-eval-formula]."
252   :group 'org-table-calculation
253   :type 'boolean)
254
255 (defcustom org-table-formula-use-constants t
256   "Non-nil means interpret constants in formulas in tables.
257 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
258 by the value given in `org-table-formula-constants', or by a value obtained
259 from the `constants.el' package."
260   :group 'org-table-calculation
261   :type 'boolean)
262
263 (defcustom org-table-formula-constants nil
264   "Alist with constant names and values, for use in table formulas.
265 The car of each element is a name of a constant, without the `$' before it.
266 The cdr is the value as a string.  For example, if you'd like to use the
267 speed of light in a formula, you would configure
268
269   (setq org-table-formula-constants '((\"c\" . \"299792458.\")))
270
271 and then use it in an equation like `$1*$c'.
272
273 Constants can also be defined on a per-file basis using a line like
274
275 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
276   :group 'org-table-calculation
277   :type '(repeat
278           (cons (string :tag "name")
279                 (string :tag "value"))))
280
281 (defcustom org-table-allow-automatic-line-recalculation t
282   "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
283 Automatically means when TAB or RET or C-c C-c are pressed in the line."
284   :group 'org-table-calculation
285   :type 'boolean)
286
287 (defcustom org-table-error-on-row-ref-crossing-hline t
288   "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
289   :group 'org-table
290   :type 'boolean)
291
292 (defcustom org-table-relative-ref-may-cross-hline t
293   "Non-nil means relative formula references may cross hlines.
294 Here are the allowed values:
295
296 nil    Relative references may not cross hlines.  They will reference the
297        field next to the hline instead.  Coming from below, the reference
298        will be to the field below the hline.  Coming from above, it will be
299        to the field above.
300 t      Relative references may cross hlines.
301 error  An attempt to cross a hline will throw an error.
302
303 It is probably good to never set this variable to nil, for the sake of
304 portability of tables."
305   :group 'org-table-calculation
306   :type '(choice
307           (const :tag "Allow to cross" t)
308           (const :tag "Stick to hline" nil)
309           (const :tag "Error on attempt to cross" error)))
310
311 (defgroup org-table-import-export nil
312   "Options concerning table import and export in Org-mode."
313   :tag "Org Table Import Export"
314   :group 'org-table)
315
316 (defcustom org-table-export-default-format "orgtbl-to-tsv"
317   "Default export parameters for `org-table-export'.
318 These can be overridden for a specific table by setting the
319 TABLE_EXPORT_FORMAT property.  See the manual section on orgtbl
320 radio tables for the different export transformations and
321 available parameters."
322   :group 'org-table-import-export
323   :type 'string)
324
325 (defconst org-table-auto-recalculate-regexp "^[ \t]*| *# *\\(|\\|$\\)"
326   "Detects a table line marked for automatic recalculation.")
327 (defconst org-table-recalculate-regexp "^[ \t]*| *[#*] *\\(|\\|$\\)"
328   "Detects a table line marked for automatic recalculation.")
329 (defconst org-table-calculate-mark-regexp "^[ \t]*| *[!$^_#*] *\\(|\\|$\\)"
330   "Detects a table line marked for automatic recalculation.")
331 (defconst org-table-border-regexp "^[ \t]*[^| \t]"
332   "Searching from within a table (any type) this finds the first line outside the table.")
333 (defvar org-table-last-highlighted-reference nil)
334 (defvar org-table-formula-history nil)
335
336 (defvar org-table-column-names nil
337   "Alist with column names, derived from the `!' line.")
338 (defvar org-table-column-name-regexp nil
339   "Regular expression matching the current column names.")
340 (defvar org-table-local-parameters nil
341   "Alist with parameter names, derived from the `$' line.")
342 (defvar org-table-named-field-locations nil
343   "Alist with locations of named fields.")
344
345 (defvar org-table-current-line-types nil
346   "Table row types, non-nil only for the duration of a command.")
347 (defvar org-table-current-begin-line nil
348   "Table begin line, non-nil only for the duration of a command.")
349 (defvar org-table-current-begin-pos nil
350   "Table begin position, non-nil only for the duration of a command.")
351 (defvar org-table-current-ncol nil
352   "Number of columns in table, non-nil only for the duration of a command.")
353 (defvar org-table-dlines nil
354   "Vector of data line line numbers in the current table.")
355 (defvar org-table-hlines nil
356   "Vector of hline line numbers in the current table.")
357
358 (defconst org-table-range-regexp
359    "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
360    ;;   1                        2                    3          4                        5
361   "Regular expression for matching ranges in formulas.")
362
363 (defconst org-table-range-regexp2
364   (concat
365    "\\(" "@[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)"
366    "\\.\\."
367    "\\(" "@?[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)")
368   "Match a range for reference display.")
369
370 (defun org-table-colgroup-line-p (line)
371   "Is this a table line colgroup information?"
372   (save-match-data
373     (and (string-match "[<>]\\|&[lg]t;" line)
374          (string-match "\\`[ \t]*|[ \t]*/[ \t]*\\(|[ \t<>0-9|lgt&;]+\\)\\'"
375                        line)
376          (not (delq
377                nil
378                (mapcar
379                 (lambda (s)
380                   (not (member s '("" "<" ">" "<>" "&lt;" "&gt;" "&lt;&gt;"))))
381                 (org-split-string (match-string 1 line) "[ \t]*|[ \t]*")))))))
382
383 (defun org-table-cookie-line-p (line)
384   "Is this a table line with only alignment/width cookies?"
385   (save-match-data
386     (and (string-match "[<>]\\|&[lg]t;" line)
387          (or (string-match
388               "\\`[ \t]*|[ \t]*/[ \t]*\\(|[ \t<>0-9|lrcgt&;]+\\)\\'" line)
389              (string-match "\\(\\`[ \t<>lrc0-9|gt&;]+\\'\\)" line))
390          (not (delq nil (mapcar
391                          (lambda (s)
392                            (not (or (equal s "")
393                                     (string-match
394                                      "\\`<\\([lrc]?[0-9]+\\|[lrc]\\)>\\'" s)
395                                     (string-match
396                                      "\\`&lt;\\([lrc]?[0-9]+\\|[lrc]\\)&gt;\\'"
397                                      s))))
398                          (org-split-string (match-string 1 line)
399                                            "[ \t]*|[ \t]*")))))))
400
401 (defconst org-table-translate-regexp
402   (concat "\\(" "@[-0-9I$]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\)")
403   "Match a reference that needs translation, for reference display.")
404
405 (defun org-table-create-with-table.el ()
406   "Use the table.el package to insert a new table.
407 If there is already a table at point, convert between Org-mode tables
408 and table.el tables."
409   (interactive)
410   (require 'table)
411   (cond
412    ((org-at-table.el-p)
413     (if (y-or-n-p "Convert table to Org-mode table? ")
414         (org-table-convert)))
415    ((org-at-table-p)
416     (when (y-or-n-p "Convert table to table.el table? ")
417       (org-table-align)
418       (org-table-convert)))
419    (t (call-interactively 'table-insert))))
420
421 (defun org-table-create-or-convert-from-region (arg)
422   "Convert region to table, or create an empty table.
423 If there is an active region, convert it to a table, using the function
424 `org-table-convert-region'.  See the documentation of that function
425 to learn how the prefix argument is interpreted to determine the field
426 separator.
427 If there is no such region, create an empty table with `org-table-create'."
428   (interactive "P")
429   (if (org-region-active-p)
430       (org-table-convert-region (region-beginning) (region-end) arg)
431     (org-table-create arg)))
432
433 (defun org-table-create (&optional size)
434   "Query for a size and insert a table skeleton.
435 SIZE is a string Columns x Rows like for example \"3x2\"."
436   (interactive "P")
437   (unless size
438     (setq size (read-string
439                 (concat "Table size Columns x Rows [e.g. "
440                         org-table-default-size "]: ")
441                 "" nil org-table-default-size)))
442
443   (let* ((pos (point))
444          (indent (make-string (current-column) ?\ ))
445          (split (org-split-string size " *x *"))
446          (rows (string-to-number (nth 1 split)))
447          (columns (string-to-number (car split)))
448          (line (concat (apply 'concat indent "|" (make-list columns "  |"))
449                        "\n")))
450     (if (string-match "^[ \t]*$" (buffer-substring-no-properties
451                                   (point-at-bol) (point)))
452         (beginning-of-line 1)
453       (newline))
454     ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
455     (dotimes (i rows) (insert line))
456     (goto-char pos)
457     (if (> rows 1)
458         ;; Insert a hline after the first row.
459         (progn
460           (end-of-line 1)
461           (insert "\n|-")
462           (goto-char pos)))
463     (org-table-align)))
464
465 (defun org-table-convert-region (beg0 end0 &optional separator)
466   "Convert region to a table.
467 The region goes from BEG0 to END0, but these borders will be moved
468 slightly, to make sure a beginning of line in the first line is included.
469
470 SEPARATOR specifies the field separator in the lines.  It can have the
471 following values:
472
473 '(4)     Use the comma as a field separator
474 '(16)    Use a TAB as field separator
475 integer  When a number, use that many spaces as field separator
476 nil      When nil, the command tries to be smart and figure out the
477          separator in the following way:
478          - when each line contains a TAB, assume TAB-separated material
479          - when each line contains a comma, assume CSV material
480          - else, assume one or more SPACE characters as separator."
481   (interactive "rP")
482   (let* ((beg (min beg0 end0))
483          (end (max beg0 end0))
484          re)
485     (goto-char beg)
486     (beginning-of-line 1)
487     (setq beg (move-marker (make-marker) (point)))
488     (goto-char end)
489     (if (bolp) (backward-char 1) (end-of-line 1))
490     (setq end (move-marker (make-marker) (point)))
491     ;; Get the right field separator
492     (unless separator
493       (goto-char beg)
494       (setq separator
495             (cond
496              ((not (re-search-forward "^[^\n\t]+$" end t)) '(16))
497              ((not (re-search-forward "^[^\n,]+$" end t)) '(4))
498              (t 1))))
499     (goto-char beg)
500     (if (equal separator '(4))
501         (while (< (point) end)
502           ;; parse the csv stuff
503           (cond
504            ((looking-at "^") (insert "| "))
505            ((looking-at "[ \t]*$") (replace-match " |") (beginning-of-line 2))
506            ((looking-at "[ \t]*\"\\([^\"\n]*\\)\"")
507             (replace-match "\\1")
508             (if (looking-at "\"") (insert "\"")))
509            ((looking-at "[^,\n]+") (goto-char (match-end 0)))
510            ((looking-at "[ \t]*,") (replace-match " | "))
511            (t (beginning-of-line 2))))
512       (setq re (cond
513                 ((equal separator '(4)) "^\\|\"?[ \t]*,[ \t]*\"?")
514                 ((equal separator '(16)) "^\\|\t")
515                 ((integerp separator)
516                  (if (< separator 1)
517                      (error "Number of spaces in separator must be >= 1")
518                    (format "^ *\\| *\t *\\| \\{%d,\\}" separator)))
519                 (t (error "This should not happen"))))
520       (while (re-search-forward re end t)
521         (replace-match "| " t t)))
522     (goto-char beg)
523     (org-table-align)))
524
525 (defun org-table-import (file arg)
526   "Import FILE as a table.
527 The file is assumed to be tab-separated.  Such files can be produced by most
528 spreadsheet and database applications.  If no tabs (at least one per line)
529 are found, lines will be split on whitespace into fields."
530   (interactive "f\nP")
531   (or (bolp) (newline))
532   (let ((beg (point))
533         (pm (point-max)))
534     (insert-file-contents file)
535     (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
536
537
538 (defvar org-table-last-alignment)
539 (defvar org-table-last-column-widths)
540 (defun org-table-export (&optional file format)
541   "Export table to a file, with configurable format.
542 Such a file can be imported into a spreadsheet program like Excel.
543 FILE can be the output file name.  If not given, it will be taken from
544 a TABLE_EXPORT_FILE property in the current entry or higher up in the
545 hierarchy, or the user will be prompted for a file name.
546 FORMAT can be an export format, of the same kind as it used when
547 `orgtbl-mode' sends a table in a different format.  The default format can
548 be found in the variable `org-table-export-default-format', but the function
549 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
550 property, locally or anywhere up in the hierarchy."
551   (interactive)
552   (unless (org-at-table-p)
553     (error "No table at point"))
554   (require 'org-exp)
555   (org-table-align) ;; make sure we have everything we need
556   (let* ((beg (org-table-begin))
557          (end (org-table-end))
558          (txt (buffer-substring-no-properties beg end))
559          (file (or file (org-entry-get beg "TABLE_EXPORT_FILE" t)))
560          (format (or format
561                      (org-entry-get beg "TABLE_EXPORT_FORMAT" t)))
562          buf deffmt-readable)
563     (unless file
564       (setq file (read-file-name "Export table to: "))
565       (unless (or (not (file-exists-p file))
566                   (y-or-n-p (format "Overwrite file %s? " file)))
567         (error "Abort")))
568     (if (file-directory-p file)
569         (error "This is a directory path, not a file"))
570     (if (and (buffer-file-name)
571              (equal (file-truename file)
572                     (file-truename (buffer-file-name))))
573         (error "Please specify a file name that is different from current"))
574     (unless format
575       (setq deffmt-readable org-table-export-default-format)
576       (while (string-match "\t" deffmt-readable)
577         (setq deffmt-readable (replace-match "\\t" t t deffmt-readable)))
578       (while (string-match "\n" deffmt-readable)
579         (setq deffmt-readable (replace-match "\\n" t t deffmt-readable)))
580       (setq format (org-completing-read
581                     "Format: "
582                     '("orgtbl-to-tsv" "orgtbl-to-csv"
583                       "orgtbl-to-latex" "orgtbl-to-html"
584                       "orgtbl-to-generic" "orgtbl-to-texinfo"
585                       "orgtbl-to-orgtbl") nil nil
586                       deffmt-readable)))
587     (if (string-match "\\([^ \t\r\n]+\\)\\( +.*\\)?" format)
588         (let* ((transform (intern (match-string 1 format)))
589                (params (if (match-end 2)
590                            (read (concat "(" (match-string 2 format) ")"))))
591                (skip (plist-get params :skip))
592                (skipcols (plist-get params :skipcols))
593                (lines (nthcdr (or skip 0) (org-split-string txt "[ \t]*\n[ \t]*")))
594                (lines (org-table-clean-before-export lines))
595                (i0 (if org-table-clean-did-remove-column 2 1))
596                (table (mapcar
597                        (lambda (x)
598                          (if (string-match org-table-hline-regexp x)
599                              'hline
600                            (org-remove-by-index
601                             (org-split-string (org-trim x) "\\s-*|\\s-*")
602                             skipcols i0)))
603                        lines))
604                (fun (if (= i0 2) 'cdr 'identity))
605                (org-table-last-alignment
606                 (org-remove-by-index (funcall fun org-table-last-alignment)
607                                      skipcols i0))
608                (org-table-last-column-widths
609                 (org-remove-by-index (funcall fun org-table-last-column-widths)
610                                      skipcols i0)))
611
612           (unless (fboundp transform)
613             (error "No such transformation function %s" transform))
614           (setq txt (funcall transform table params))
615
616           (with-current-buffer (find-file-noselect file)
617             (setq buf (current-buffer))
618             (erase-buffer)
619             (fundamental-mode)
620             (insert txt "\n")
621             (save-buffer))
622           (kill-buffer buf)
623           (message "Export done."))
624       (error "TABLE_EXPORT_FORMAT invalid"))))
625
626 (defvar org-table-aligned-begin-marker (make-marker)
627   "Marker at the beginning of the table last aligned.
628 Used to check if cursor still is in that table, to minimize realignment.")
629 (defvar org-table-aligned-end-marker (make-marker)
630   "Marker at the end of the table last aligned.
631 Used to check if cursor still is in that table, to minimize realignment.")
632 (defvar org-table-last-alignment nil
633   "List of flags for flushright alignment, from the last re-alignment.
634 This is being used to correctly align a single field after TAB or RET.")
635 (defvar org-table-last-column-widths nil
636   "List of max width of fields in each column.
637 This is being used to correctly align a single field after TAB or RET.")
638 (defvar org-table-formula-debug nil
639   "Non-nil means debug table formulas.
640 When nil, simply write \"#ERROR\" in corrupted fields.")
641 (make-variable-buffer-local 'org-table-formula-debug)
642 (defvar org-table-overlay-coordinates nil
643   "Overlay coordinates after each align of a table.")
644 (make-variable-buffer-local 'org-table-overlay-coordinates)
645
646 (defvar org-last-recalc-line nil)
647 (defvar org-table-do-narrow t)   ; for dynamic scoping
648 (defconst org-narrow-column-arrow "=>"
649   "Used as display property in narrowed table columns.")
650
651 (defun org-table-align ()
652   "Align the table at point by aligning all vertical bars."
653   (interactive)
654   (let* (
655          ;; Limits of table
656          (beg (org-table-begin))
657          (end (org-table-end))
658          ;; Current cursor position
659          (linepos (org-current-line))
660          (colpos (org-table-current-column))
661          (winstart (window-start))
662          (winstartline (org-current-line (min winstart (1- (point-max)))))
663          lines (new "") lengths l typenums ty fields maxfields i
664          column
665          (indent "") cnt frac
666          rfmt hfmt
667          (spaces '(1 . 1))
668          (sp1 (car spaces))
669          (sp2 (cdr spaces))
670          (rfmt1 (concat
671                  (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
672          (hfmt1 (concat
673                  (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
674          emptystrings links dates emph raise narrow
675          falign falign1 fmax f1 len c e space)
676     (untabify beg end)
677     (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
678     ;; Check if we have links or dates
679     (goto-char beg)
680     (setq links (re-search-forward org-bracket-link-regexp end t))
681     (goto-char beg)
682     (setq emph (and org-hide-emphasis-markers
683                     (re-search-forward org-emph-re end t)))
684     (goto-char beg)
685     (setq raise (and org-use-sub-superscripts
686                     (re-search-forward org-match-substring-regexp end t)))
687     (goto-char beg)
688     (setq dates (and org-display-custom-times
689                      (re-search-forward org-ts-regexp-both end t)))
690     ;; Make sure the link properties are right
691     (when links (goto-char beg) (while (org-activate-bracket-links end)))
692     ;; Make sure the date properties are right
693     (when dates (goto-char beg) (while (org-activate-dates end)))
694     (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
695     (when raise (goto-char beg) (while (org-raise-scripts end)))
696
697     ;; Check if we are narrowing any columns
698     (goto-char beg)
699     (setq narrow (and org-table-do-narrow
700                       org-format-transports-properties-p
701                       (re-search-forward "<[lrc]?[0-9]+>" end t)))
702     (goto-char beg)
703     (setq falign (re-search-forward "<[lrc][0-9]*>" end t))
704     (goto-char beg)
705     ;; Get the rows
706     (setq lines (org-split-string
707                  (buffer-substring beg end) "\n"))
708     ;; Store the indentation of the first line
709     (if (string-match "^ *" (car lines))
710         (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
711     ;; Mark the hlines by setting the corresponding element to nil
712     ;; At the same time, we remove trailing space.
713     (setq lines (mapcar (lambda (l)
714                           (if (string-match "^ *|-" l)
715                               nil
716                             (if (string-match "[ \t]+$" l)
717                                 (substring l 0 (match-beginning 0))
718                               l)))
719                         lines))
720     ;; Get the data fields by splitting the lines.
721     (setq fields (mapcar
722                   (lambda (l)
723                       (org-split-string l " *| *"))
724                   (delq nil (copy-sequence lines))))
725     ;; How many fields in the longest line?
726     (condition-case nil
727         (setq maxfields (apply 'max (mapcar 'length fields)))
728       (error
729        (kill-region beg end)
730        (org-table-create org-table-default-size)
731        (error "Empty table - created default table")))
732     ;; A list of empty strings to fill any short rows on output
733     (setq emptystrings (make-list maxfields ""))
734     ;; Check for special formatting.
735     (setq i -1)
736     (while (< (setq i (1+ i)) maxfields)   ;; Loop over all columns
737       (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
738       ;; Check if there is an explicit width specified
739       (setq fmax nil)
740       (when (or narrow falign)
741         (setq c column fmax nil falign1 nil)
742         (while c
743           (setq e (pop c))
744           (when (and (stringp e) (string-match "^<\\([lrc]\\)?\\([0-9]+\\)?>$" e))
745             (if (match-end 1) (setq falign1 (match-string 1 e)))
746             (if (and org-table-do-narrow (match-end 2))
747                 (setq fmax (string-to-number (match-string 2 e)) c nil))))
748         ;; Find fields that are wider than fmax, and shorten them
749         (when fmax
750           (loop for xx in column do
751                 (when (and (stringp xx)
752                            (> (org-string-width xx) fmax))
753                   (org-add-props xx nil
754                     'help-echo
755                     (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
756                   (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
757                   (unless (> f1 1)
758                     (error "Cannot narrow field starting with wide link \"%s\""
759                            (match-string 0 xx)))
760                   (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
761                   (add-text-properties (- f1 2) f1
762                                        (list 'display org-narrow-column-arrow)
763                                        xx)))))
764       ;; Get the maximum width for each column
765       (push (apply 'max (or fmax 1) 1 (mapcar 'org-string-width column))
766             lengths)
767       ;; Get the fraction of numbers, to decide about alignment of the column
768       (if falign1
769           (push (equal (downcase falign1) "r") typenums)
770         (setq cnt 0 frac 0.0)
771         (loop for x in column do
772               (if (equal x "")
773                   nil
774                 (setq frac ( / (+ (* frac cnt)
775                                   (if (string-match org-table-number-regexp x) 1 0))
776                                (setq cnt (1+ cnt))))))
777         (push (>= frac org-table-number-fraction) typenums)))
778     (setq lengths (nreverse lengths) typenums (nreverse typenums))
779
780     ;; Store the alignment of this table, for later editing of single fields
781     (setq org-table-last-alignment typenums
782           org-table-last-column-widths lengths)
783
784     ;; With invisible characters, `format' does not get the field width right
785     ;; So we need to make these fields wide by hand.
786     (when (or links emph raise)
787       (loop for i from 0 upto (1- maxfields) do
788             (setq len (nth i lengths))
789             (loop for j from 0 upto (1- (length fields)) do
790                   (setq c (nthcdr i (car (nthcdr j fields))))
791                   (if (and (stringp (car c))
792                            (or (text-property-any 0 (length (car c))
793                                                   'invisible 'org-link (car c))
794                                (text-property-any 0 (length (car c))
795                                                   'org-dwidth t (car c)))
796                            (< (org-string-width (car c)) len))
797                       (progn
798                         (setq space (make-string (- len (org-string-width (car c))) ?\ ))
799                         (setcar c (if (nth i typenums)
800                                       (concat space (car c))
801                                     (concat (car c) space))))))))
802
803     ;; Compute the formats needed for output of the table
804     (setq rfmt (concat indent "|") hfmt (concat indent "|"))
805     (while (setq l (pop lengths))
806       (setq ty (if (pop typenums) "" "-")) ; number types flushright
807       (setq rfmt (concat rfmt (format rfmt1 ty l))
808             hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
809     (setq rfmt (concat rfmt "\n")
810           hfmt (concat (substring hfmt 0 -1) "|\n"))
811
812     (setq new (mapconcat
813                (lambda (l)
814                  (if l (apply 'format rfmt
815                               (append (pop fields) emptystrings))
816                    hfmt))
817                lines ""))
818     (move-marker org-table-aligned-begin-marker (point))
819     (insert new)
820     ;; Replace the old one
821     (delete-region (point) end)
822     (move-marker end nil)
823     (move-marker org-table-aligned-end-marker (point))
824     (when (and orgtbl-mode (not (eq major-mode 'org-mode)))
825       (goto-char org-table-aligned-begin-marker)
826       (while (org-hide-wide-columns org-table-aligned-end-marker)))
827     ;; Try to move to the old location
828     (org-goto-line winstartline)
829     (setq winstart (point-at-bol))
830     (org-goto-line linepos)
831     (set-window-start (selected-window) winstart 'noforce)
832     (org-table-goto-column colpos)
833     (and org-table-overlay-coordinates (org-table-overlay-coordinates))
834     (setq org-table-may-need-update nil)
835     ))
836
837 (defun org-table-begin (&optional table-type)
838   "Find the beginning of the table and return its position.
839 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
840   (save-excursion
841     (if (not (re-search-backward
842               (if table-type org-table-any-border-regexp
843                 org-table-border-regexp)
844               nil t))
845         (progn (goto-char (point-min)) (point))
846       (goto-char (match-beginning 0))
847       (beginning-of-line 2)
848       (point))))
849
850 (defun org-table-end (&optional table-type)
851   "Find the end of the table and return its position.
852 With argument TABLE-TYPE, go to the end of a table.el-type table."
853   (save-excursion
854     (if (not (re-search-forward
855               (if table-type org-table-any-border-regexp
856                 org-table-border-regexp)
857               nil t))
858         (goto-char (point-max))
859       (goto-char (match-beginning 0)))
860     (point-marker)))
861
862 (defun org-table-justify-field-maybe (&optional new)
863   "Justify the current field, text to left, number to right.
864 Optional argument NEW may specify text to replace the current field content."
865   (cond
866    ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
867    ((org-at-table-hline-p))
868    ((and (not new)
869          (or (not (equal (marker-buffer org-table-aligned-begin-marker)
870                          (current-buffer)))
871              (< (point) org-table-aligned-begin-marker)
872              (>= (point) org-table-aligned-end-marker)))
873     ;; This is not the same table, force a full re-align
874     (setq org-table-may-need-update t))
875    (t ;; realign the current field, based on previous full realign
876     (let* ((pos (point)) s
877            (col (org-table-current-column))
878            (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
879            l f n o e)
880       (when (> col 0)
881         (skip-chars-backward "^|\n")
882         (if (looking-at " *\\([^|\n]*?\\) *\\(|\\|$\\)")
883             (progn
884               (setq s (match-string 1)
885                     o (match-string 0)
886                     l (max 1 (- (match-end 0) (match-beginning 0) 3))
887                     e (not (= (match-beginning 2) (match-end 2))))
888               (setq f (format (if num " %%%ds %s" " %%-%ds %s")
889                               l (if e "|" (setq org-table-may-need-update t) ""))
890                     n (format f s))
891               (if new
892                   (if (<= (length new) l)      ;; FIXME: length -> str-width?
893                       (setq n (format f new))
894                     (setq n (concat new "|") org-table-may-need-update t)))
895               (if (equal (string-to-char n) ?-) (setq n (concat " " n)))
896               (or (equal n o)
897                   (let (org-table-may-need-update)
898                     (replace-match n t t))))
899           (setq org-table-may-need-update t))
900         (goto-char pos))))))
901
902 (defun org-table-next-field ()
903   "Go to the next field in the current table, creating new lines as needed.
904 Before doing so, re-align the table if necessary."
905   (interactive)
906   (org-table-maybe-eval-formula)
907   (org-table-maybe-recalculate-line)
908   (if (and org-table-automatic-realign
909            org-table-may-need-update)
910       (org-table-align))
911   (let ((end (org-table-end)))
912     (if (org-at-table-hline-p)
913         (end-of-line 1))
914     (condition-case nil
915         (progn
916           (re-search-forward "|" end)
917           (if (looking-at "[ \t]*$")
918               (re-search-forward "|" end))
919           (if (and (looking-at "-")
920                    org-table-tab-jumps-over-hlines
921                    (re-search-forward "^[ \t]*|\\([^-]\\)" end t))
922               (goto-char (match-beginning 1)))
923           (if (looking-at "-")
924               (progn
925                 (beginning-of-line 0)
926                 (org-table-insert-row 'below))
927             (if (looking-at " ") (forward-char 1))))
928       (error
929        (org-table-insert-row 'below)))))
930
931 (defun org-table-previous-field ()
932   "Go to the previous field in the table.
933 Before doing so, re-align the table if necessary."
934   (interactive)
935   (org-table-justify-field-maybe)
936   (org-table-maybe-recalculate-line)
937   (if (and org-table-automatic-realign
938            org-table-may-need-update)
939       (org-table-align))
940   (if (org-at-table-hline-p)
941       (end-of-line 1))
942   (condition-case nil
943       (progn
944         (re-search-backward "|" (org-table-begin))
945         (re-search-backward "|" (org-table-begin)))
946     (error (error "Cannot move to previous table field")))
947   (while (looking-at "|\\(-\\|[ \t]*$\\)")
948     (re-search-backward "|" (org-table-begin)))
949   (if (looking-at "| ?")
950       (goto-char (match-end 0))))
951
952 (defun org-table-beginning-of-field (&optional n)
953   "Move to the end of the current table field.
954 If already at or after the end, move to the end of the next table field.
955 With numeric argument N, move N-1 fields forward first."
956   (interactive "p")
957   (let ((pos (point)))
958     (while (> n 1)
959       (setq n (1- n))
960       (org-table-previous-field))
961     (if (not (re-search-backward "|" (point-at-bol 0) t))
962         (error "No more table fields before the current")
963       (goto-char (match-end 0))
964       (and (looking-at " ") (forward-char 1)))
965     (if (>= (point) pos) (org-table-beginning-of-field 2))))
966
967 (defun org-table-end-of-field (&optional n)
968   "Move to the beginning of the current table field.
969 If already at or before the beginning, move to the beginning of the
970 previous field.
971 With numeric argument N, move N-1 fields backward first."
972   (interactive "p")
973   (let ((pos (point)))
974     (while (> n 1)
975       (setq n (1- n))
976       (org-table-next-field))
977     (when (re-search-forward "|" (point-at-eol 1) t)
978       (backward-char 1)
979       (skip-chars-backward " ")
980       (if (and (equal (char-before (point)) ?|) (looking-at " "))
981           (forward-char 1)))
982     (if (<= (point) pos) (org-table-end-of-field 2))))
983
984 (defun org-table-next-row ()
985   "Go to the next row (same column) in the current table.
986 Before doing so, re-align the table if necessary."
987   (interactive)
988   (org-table-maybe-eval-formula)
989   (org-table-maybe-recalculate-line)
990   (if (or (looking-at "[ \t]*$")
991           (save-excursion (skip-chars-backward " \t") (bolp)))
992       (newline)
993     (if (and org-table-automatic-realign
994              org-table-may-need-update)
995         (org-table-align))
996     (let ((col (org-table-current-column)))
997       (beginning-of-line 2)
998       (if (or (not (org-at-table-p))
999               (org-at-table-hline-p))
1000           (progn
1001             (beginning-of-line 0)
1002             (org-table-insert-row 'below)))
1003       (org-table-goto-column col)
1004       (skip-chars-backward "^|\n\r")
1005       (if (looking-at " ") (forward-char 1)))))
1006
1007 (defun org-table-copy-down (n)
1008   "Copy a field down in the current column.
1009 If the field at the cursor is empty, copy into it the content of
1010 the nearest non-empty field above.  With argument N, use the Nth
1011 non-empty field.  If the current field is not empty, it is copied
1012 down to the next row, and the cursor is moved with it.
1013 Therefore, repeating this command causes the column to be filled
1014 row-by-row.
1015 If the variable `org-table-copy-increment' is non-nil and the
1016 field is an integer or a timestamp, it will be incremented while
1017 copying.  In the case of a timestamp, increment by one day."
1018   (interactive "p")
1019   (let* ((colpos (org-table-current-column))
1020          (col (current-column))
1021          (field (org-table-get-field))
1022          (non-empty (string-match "[^ \t]" field))
1023          (beg (org-table-begin))
1024          (orig-n n)
1025          txt)
1026     (org-table-check-inside-data-field)
1027     (if non-empty
1028         (progn
1029           (setq txt (org-trim field))
1030           (org-table-next-row)
1031           (org-table-blank-field))
1032       (save-excursion
1033         (setq txt
1034               (catch 'exit
1035                 (while (progn (beginning-of-line 1)
1036                               (re-search-backward org-table-dataline-regexp
1037                                                   beg t))
1038                   (org-table-goto-column colpos t)
1039                   (if (and (looking-at
1040                             "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
1041                            (<= (setq n (1- n)) 0))
1042                       (throw 'exit (match-string 1))))))))
1043     (if txt
1044         (progn
1045           (if (and org-table-copy-increment
1046                    (not (equal orig-n 0))
1047                    (string-match "^[0-9]+$" txt)
1048                    (< (string-to-number txt) 100000000))
1049               (setq txt (format "%d" (+ (string-to-number txt) 1))))
1050           (insert txt)
1051           (org-move-to-column col)
1052           (if (and org-table-copy-increment (org-at-timestamp-p t))
1053               (org-timestamp-up-day)
1054             (org-table-maybe-recalculate-line))
1055           (org-table-align)
1056           (org-move-to-column col))
1057       (error "No non-empty field found"))))
1058
1059 (defun org-table-check-inside-data-field (&optional noerror)
1060   "Is point inside a table data field?
1061 I.e. not on a hline or before the first or after the last column?
1062 This actually throws an error, so it aborts the current command."
1063   (if (or (not (org-at-table-p))
1064           (= (org-table-current-column) 0)
1065           (org-at-table-hline-p)
1066           (looking-at "[ \t]*$"))
1067       (if noerror
1068           nil
1069         (error "Not in table data field"))
1070     t))
1071
1072 (defvar org-table-clip nil
1073   "Clipboard for table regions.")
1074
1075 (defun org-table-get (line column)
1076   "Get the field in table line LINE, column COLUMN.
1077 If LINE is larger than the number of data lines in the table, the function
1078 returns nil.  However, if COLUMN is too large, we will simply return an
1079 empty string.
1080 If LINE is nil, use the current line.
1081 If column is nil, use the current column."
1082   (setq column (or column (org-table-current-column)))
1083   (save-excursion
1084     (and (or (not line) (org-table-goto-line line))
1085          (org-trim (org-table-get-field column)))))
1086
1087 (defun org-table-put (line column value &optional align)
1088   "Put VALUE into line LINE, column COLUMN.
1089 When ALIGN is set, also realign the table."
1090   (setq column (or column (org-table-current-column)))
1091   (prog1 (save-excursion
1092            (and (or (not line) (org-table-goto-line line))
1093                 (progn (org-table-goto-column column nil 'force) t)
1094                 (org-table-get-field column value)))
1095     (and align (org-table-align))))
1096
1097 (defun org-table-current-line ()
1098   "Return the index of the current data line."
1099   (let ((pos (point)) (end (org-table-end)) (cnt 0))
1100     (save-excursion
1101       (goto-char (org-table-begin))
1102       (while (and (re-search-forward org-table-dataline-regexp end t)
1103                   (setq cnt (1+ cnt))
1104                   (< (point-at-eol) pos))))
1105     cnt))
1106
1107 (defun org-table-goto-line (N)
1108   "Go to the Nth data line in the current table.
1109 Return t when the line exists, nil if it does not exist."
1110   (goto-char (org-table-begin))
1111   (let ((end (org-table-end)) (cnt 0))
1112     (while (and (re-search-forward org-table-dataline-regexp end t)
1113                 (< (setq cnt (1+ cnt)) N)))
1114     (= cnt N)))
1115
1116 (defun org-table-blank-field ()
1117   "Blank the current table field or active region."
1118   (interactive)
1119   (org-table-check-inside-data-field)
1120   (if (and (org-called-interactively-p 'any) (org-region-active-p))
1121       (let (org-table-clip)
1122         (org-table-cut-region (region-beginning) (region-end)))
1123     (skip-chars-backward "^|")
1124     (backward-char 1)
1125     (if (looking-at "|[^|\n]+")
1126         (let* ((pos (match-beginning 0))
1127                (match (match-string 0))
1128                (len (org-string-width match)))
1129           (replace-match (concat "|" (make-string (1- len) ?\ )))
1130           (goto-char (+ 2 pos))
1131           (substring match 1)))))
1132
1133 (defun org-table-get-field (&optional n replace)
1134   "Return the value of the field in column N of current row.
1135 N defaults to current field.
1136 If REPLACE is a string, replace field with this value.  The return value
1137 is always the old value."
1138   (and n (org-table-goto-column n))
1139   (skip-chars-backward "^|\n")
1140   (backward-char 1)
1141   (if (looking-at "|[^|\r\n]*")
1142       (let* ((pos (match-beginning 0))
1143              (val (buffer-substring (1+ pos) (match-end 0))))
1144         (if replace
1145             (replace-match (concat "|" (if (equal replace "") " " replace))
1146                            t t))
1147         (goto-char (min (point-at-eol) (+ 2 pos)))
1148         val)
1149     (forward-char 1) ""))
1150
1151 (defun org-table-field-info (arg)
1152   "Show info about the current field, and highlight any reference at point."
1153   (interactive "P")
1154   (org-table-get-specials)
1155   (save-excursion
1156     (let* ((pos (point))
1157            (col (org-table-current-column))
1158            (cname (car (rassoc (int-to-string col) org-table-column-names)))
1159            (name (car (rassoc (list (org-current-line) col)
1160                               org-table-named-field-locations)))
1161            (eql (org-table-expand-lhs-ranges
1162                  (mapcar
1163                   (lambda (e)
1164                     (cons (org-table-formula-handle-first/last-rc
1165                            (car e)) (cdr e)))
1166                   (org-table-get-stored-formulas))))
1167            (dline (org-table-current-dline))
1168            (ref (format "@%d$%d" dline col))
1169            (ref1 (org-table-convert-refs-to-an ref))
1170            (fequation (or (assoc name eql) (assoc ref eql)))
1171            (cequation (assoc (int-to-string col) eql))
1172            (eqn (or fequation cequation)))
1173       (if (and eqn (get-text-property 0 :orig-eqn (car eqn)))
1174           (setq eqn (get-text-property 0 :orig-eqn (car eqn))))
1175       (goto-char pos)
1176       (condition-case nil
1177           (org-table-show-reference 'local)
1178         (error nil))
1179       (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
1180                dline col
1181                (if cname (concat " or $" cname) "")
1182                dline col ref1
1183                (if name (concat " or $" name) "")
1184                ;; FIXME: formula info not correct if special table line
1185                (if eqn
1186                    (concat ", formula: "
1187                            (org-table-formula-to-user
1188                             (concat
1189                              (if (string-match "^[$@]"(car eqn)) "" "$")
1190                              (car eqn) "=" (cdr eqn))))
1191                  "")))))
1192
1193 (defun org-table-current-column ()
1194   "Find out which column we are in."
1195   (interactive)
1196   (if (org-called-interactively-p 'any) (org-table-check-inside-data-field))
1197   (save-excursion
1198     (let ((cnt 0) (pos (point)))
1199       (beginning-of-line 1)
1200       (while (search-forward "|" pos t)
1201         (setq cnt (1+ cnt)))
1202       (when (org-called-interactively-p 'interactive)
1203         (message "In table column %d" cnt))
1204       cnt)))
1205
1206 (defun org-table-current-dline ()
1207   "Find out what table data line we are in.
1208 Only data lines count for this."
1209   (interactive)
1210   (when (org-called-interactively-p 'any)
1211     (org-table-check-inside-data-field))
1212   (save-excursion
1213     (let ((cnt 0) (pos (point)))
1214       (goto-char (org-table-begin))
1215       (while (<= (point) pos)
1216         (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
1217         (beginning-of-line 2))
1218       (when (org-called-interactively-p 'any)
1219         (message "This is table line %d" cnt))
1220       cnt)))
1221
1222 (defun org-table-goto-column (n &optional on-delim force)
1223   "Move the cursor to the Nth column in the current table line.
1224 With optional argument ON-DELIM, stop with point before the left delimiter
1225 of the field.
1226 If there are less than N fields, just go to after the last delimiter.
1227 However, when FORCE is non-nil, create new columns if necessary."
1228   (interactive "p")
1229   (beginning-of-line 1)
1230   (when (> n 0)
1231     (while (and (> (setq n (1- n)) -1)
1232                 (or (search-forward "|" (point-at-eol) t)
1233                     (and force
1234                          (progn (end-of-line 1)
1235                                 (skip-chars-backward "^|")
1236                                 (insert " | ")
1237                                 t)))))
1238     (when (and force (not (looking-at ".*|")))
1239       (save-excursion (end-of-line 1) (insert " | ")))
1240     (if on-delim
1241         (backward-char 1)
1242       (if (looking-at " ") (forward-char 1)))))
1243
1244 (defun org-table-insert-column ()
1245   "Insert a new column into the table."
1246   (interactive)
1247   (if (not (org-at-table-p))
1248       (error "Not at a table"))
1249   (org-table-find-dataline)
1250   (let* ((col (max 1 (org-table-current-column)))
1251          (beg (org-table-begin))
1252          (end (org-table-end))
1253          ;; Current cursor position
1254          (linepos (org-current-line))
1255          (colpos col))
1256     (goto-char beg)
1257     (while (< (point) end)
1258       (if (org-at-table-hline-p)
1259           nil
1260         (org-table-goto-column col t)
1261         (insert "|   "))
1262       (beginning-of-line 2))
1263     (move-marker end nil)
1264     (org-goto-line linepos)
1265     (org-table-goto-column colpos)
1266     (org-table-align)
1267     (when (or (not org-table-fix-formulas-confirm)
1268               (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1269       (org-table-fix-formulas "$" nil (1- col) 1)
1270       (org-table-fix-formulas "$LR" nil (1- col) 1))))
1271
1272 (defun org-table-find-dataline ()
1273   "Find a data line in the current table, which is needed for column commands."
1274   (if (and (org-at-table-p)
1275            (not (org-at-table-hline-p)))
1276       t
1277     (let ((col (current-column))
1278           (end (org-table-end)))
1279       (org-move-to-column col)
1280       (while (and (< (point) end)
1281                   (or (not (= (current-column) col))
1282                       (org-at-table-hline-p)))
1283         (beginning-of-line 2)
1284         (org-move-to-column col))
1285       (if (and (org-at-table-p)
1286                (not (org-at-table-hline-p)))
1287           t
1288         (error
1289          "Please position cursor in a data line for column operations")))))
1290
1291 (defun org-table-line-to-dline (line &optional above)
1292   "Turn a buffer line number into a data line number.
1293 If there is no data line in this line, return nil.
1294 If there is no matchin dline (most likely te refrence was a hline), the
1295 first dline below it is used.  When ABOVE is non-nil, the one above is used."
1296   (catch 'exit
1297     (let ((ll (length org-table-dlines))
1298           i)
1299       (if above
1300           (progn
1301             (setq i (1- ll))
1302             (while (> i 0)
1303               (if (<= (aref org-table-dlines i) line)
1304                   (throw 'exit i))
1305               (setq i (1- i))))
1306         (setq i 1)
1307         (while (< i ll)
1308           (if (>= (aref org-table-dlines i) line)
1309               (throw 'exit i))
1310         (setq i (1+ i)))))
1311       nil))
1312
1313 (defun org-table-delete-column ()
1314   "Delete a column from the table."
1315   (interactive)
1316   (if (not (org-at-table-p))
1317       (error "Not at a table"))
1318   (org-table-find-dataline)
1319   (org-table-check-inside-data-field)
1320   (let* ((col (org-table-current-column))
1321          (beg (org-table-begin))
1322          (end (org-table-end))
1323          ;; Current cursor position
1324          (linepos (org-current-line))
1325          (colpos col))
1326     (goto-char beg)
1327     (while (< (point) end)
1328       (if (org-at-table-hline-p)
1329           nil
1330         (org-table-goto-column col t)
1331         (and (looking-at "|[^|\n]+|")
1332              (replace-match "|")))
1333       (beginning-of-line 2))
1334     (move-marker end nil)
1335     (org-goto-line linepos)
1336     (org-table-goto-column colpos)
1337     (org-table-align)
1338     (when (or (not org-table-fix-formulas-confirm)
1339               (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1340       (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
1341                               col -1 col)
1342       (org-table-fix-formulas "$LR" (list (cons (number-to-string col) "INVALID"))
1343                               col -1 col))))
1344
1345 (defun org-table-move-column-right ()
1346   "Move column to the right."
1347   (interactive)
1348   (org-table-move-column nil))
1349 (defun org-table-move-column-left ()
1350   "Move column to the left."
1351   (interactive)
1352   (org-table-move-column 'left))
1353
1354 (defun org-table-move-column (&optional left)
1355   "Move the current column to the right.  With arg LEFT, move to the left."
1356   (interactive "P")
1357   (if (not (org-at-table-p))
1358       (error "Not at a table"))
1359   (org-table-find-dataline)
1360   (org-table-check-inside-data-field)
1361   (let* ((col (org-table-current-column))
1362          (col1 (if left (1- col) col))
1363          (beg (org-table-begin))
1364          (end (org-table-end))
1365          ;; Current cursor position
1366          (linepos (org-current-line))
1367          (colpos (if left (1- col) (1+ col))))
1368     (if (and left (= col 1))
1369         (error "Cannot move column further left"))
1370     (if (and (not left) (looking-at "[^|\n]*|[^|\n]*$"))
1371         (error "Cannot move column further right"))
1372     (goto-char beg)
1373     (while (< (point) end)
1374       (if (org-at-table-hline-p)
1375           nil
1376         (org-table-goto-column col1 t)
1377         (and (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
1378              (replace-match "|\\2|\\1|")))
1379       (beginning-of-line 2))
1380     (move-marker end nil)
1381     (org-goto-line linepos)
1382     (org-table-goto-column colpos)
1383     (org-table-align)
1384     (when (or (not org-table-fix-formulas-confirm)
1385               (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1386       (org-table-fix-formulas
1387        "$" (list (cons (number-to-string col) (number-to-string colpos))
1388                  (cons (number-to-string colpos) (number-to-string col))))
1389       (org-table-fix-formulas
1390        "$LR" (list (cons (number-to-string col) (number-to-string colpos))
1391                    (cons (number-to-string colpos) (number-to-string col)))))))
1392
1393 (defun org-table-move-row-down ()
1394   "Move table row down."
1395   (interactive)
1396   (org-table-move-row nil))
1397 (defun org-table-move-row-up ()
1398   "Move table row up."
1399   (interactive)
1400   (org-table-move-row 'up))
1401
1402 (defun org-table-move-row (&optional up)
1403   "Move the current table line down.  With arg UP, move it up."
1404   (interactive "P")
1405   (let* ((col (current-column))
1406          (pos (point))
1407          (hline1p (save-excursion (beginning-of-line 1)
1408                                   (looking-at org-table-hline-regexp)))
1409          (dline1 (org-table-current-dline))
1410          (dline2 (+ dline1 (if up -1 1)))
1411          (tonew (if up 0 2))
1412          txt hline2p)
1413     (beginning-of-line tonew)
1414     (unless (org-at-table-p)
1415       (goto-char pos)
1416       (error "Cannot move row further"))
1417     (setq hline2p (looking-at org-table-hline-regexp))
1418     (goto-char pos)
1419     (beginning-of-line 1)
1420     (setq pos (point))
1421     (setq txt (buffer-substring (point) (1+ (point-at-eol))))
1422     (delete-region (point) (1+ (point-at-eol)))
1423     (beginning-of-line tonew)
1424     (insert txt)
1425     (beginning-of-line 0)
1426     (org-move-to-column col)
1427     (unless (or hline1p hline2p
1428                 (not (or (not org-table-fix-formulas-confirm)
1429                          (funcall org-table-fix-formulas-confirm
1430                                   "Fix formulas? "))))
1431       (org-table-fix-formulas
1432        "@" (list (cons (number-to-string dline1) (number-to-string dline2))
1433                  (cons (number-to-string dline2) (number-to-string dline1)))))))
1434
1435 (defun org-table-insert-row (&optional arg)
1436   "Insert a new row above the current line into the table.
1437 With prefix ARG, insert below the current line."
1438   (interactive "P")
1439   (if (not (org-at-table-p))
1440       (error "Not at a table"))
1441   (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
1442          (new (org-table-clean-line line)))
1443     ;; Fix the first field if necessary
1444     (if (string-match "^[ \t]*| *[#$] *|" line)
1445         (setq new (replace-match (match-string 0 line) t t new)))
1446     (beginning-of-line (if arg 2 1))
1447     (let (org-table-may-need-update) (insert-before-markers new "\n"))
1448     (beginning-of-line 0)
1449     (re-search-forward "| ?" (point-at-eol) t)
1450     (and (or org-table-may-need-update org-table-overlay-coordinates)
1451          (org-table-align))
1452     (when (or (not org-table-fix-formulas-confirm)
1453               (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1454       (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1))))
1455
1456 (defun org-table-insert-hline (&optional above)
1457   "Insert a horizontal-line below the current line into the table.
1458 With prefix ABOVE, insert above the current line."
1459   (interactive "P")
1460   (if (not (org-at-table-p))
1461       (error "Not at a table"))
1462   (when (eobp) (insert "\n") (backward-char 1))
1463   (if (not (string-match "|[ \t]*$" (org-current-line-string)))
1464       (org-table-align))
1465   (let ((line (org-table-clean-line
1466                (buffer-substring (point-at-bol) (point-at-eol))))
1467         (col (current-column)))
1468     (while (string-match "|\\( +\\)|" line)
1469       (setq line (replace-match
1470                   (concat "+" (make-string (- (match-end 1) (match-beginning 1))
1471                                            ?-) "|") t t line)))
1472     (and (string-match "\\+" line) (setq line (replace-match "|" t t line)))
1473     (beginning-of-line (if above 1 2))
1474     (insert line "\n")
1475     (beginning-of-line (if above 1 -1))
1476     (org-move-to-column col)
1477     (and org-table-overlay-coordinates (org-table-align))))
1478
1479 (defun org-table-hline-and-move (&optional same-column)
1480   "Insert a hline and move to the row below that line."
1481   (interactive "P")
1482   (let ((col (org-table-current-column)))
1483     (org-table-maybe-eval-formula)
1484     (org-table-maybe-recalculate-line)
1485     (org-table-insert-hline)
1486     (end-of-line 2)
1487     (if (looking-at "\n[ \t]*|-")
1488         (progn (insert "\n|") (org-table-align))
1489       (org-table-next-field))
1490     (if same-column (org-table-goto-column col))))
1491
1492 (defun org-table-clean-line (s)
1493   "Convert a table line S into a string with only \"|\" and space.
1494 In particular, this does handle wide and invisible characters."
1495   (if (string-match "^[ \t]*|-" s)
1496       ;; It's a hline, just map the characters
1497       (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
1498     (while (string-match "|\\([ \t]*?[^ \t\r\n|][^\r\n|]*\\)|" s)
1499       (setq s (replace-match
1500                (concat "|" (make-string (org-string-width (match-string 1 s))
1501                                         ?\ ) "|")
1502                t t s)))
1503     s))
1504
1505 (defun org-table-kill-row ()
1506   "Delete the current row or horizontal line from the table."
1507   (interactive)
1508   (if (not (org-at-table-p))
1509       (error "Not at a table"))
1510   (let ((col (current-column))
1511         (dline (org-table-current-dline)))
1512     (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
1513     (if (not (org-at-table-p)) (beginning-of-line 0))
1514     (org-move-to-column col)
1515     (when (or (not org-table-fix-formulas-confirm)
1516               (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1517       (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
1518                               dline -1 dline))))
1519
1520 (defun org-table-sort-lines (with-case &optional sorting-type)
1521   "Sort table lines according to the column at point.
1522
1523 The position of point indicates the column to be used for
1524 sorting, and the range of lines is the range between the nearest
1525 horizontal separator lines, or the entire table of no such lines
1526 exist.  If point is before the first column, you will be prompted
1527 for the sorting column.  If there is an active region, the mark
1528 specifies the first line and the sorting column, while point
1529 should be in the last line to be included into the sorting.
1530
1531 The command then prompts for the sorting type which can be
1532 alphabetically, numerically, or by time (as given in a time stamp
1533 in the field).  Sorting in reverse order is also possible.
1534
1535 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1536
1537 If SORTING-TYPE is specified when this function is called from a Lisp
1538 program, no prompting will take place.  SORTING-TYPE must be a character,
1539 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1540 should be done in reverse order."
1541   (interactive "P")
1542   (let* ((thisline (org-current-line))
1543          (thiscol (org-table-current-column))
1544          beg end bcol ecol tend tbeg column lns pos)
1545     (when (equal thiscol 0)
1546       (if (org-called-interactively-p 'any)
1547           (setq thiscol
1548                 (string-to-number
1549                  (read-string "Use column N for sorting: ")))
1550         (setq thiscol 1))
1551       (org-table-goto-column thiscol))
1552     (org-table-check-inside-data-field)
1553     (if (org-region-active-p)
1554         (progn
1555           (setq beg (region-beginning) end (region-end))
1556           (goto-char beg)
1557           (setq column (org-table-current-column)
1558                 beg (point-at-bol))
1559           (goto-char end)
1560           (setq end (point-at-bol 2)))
1561       (setq column (org-table-current-column)
1562             pos (point)
1563             tbeg (org-table-begin)
1564             tend (org-table-end))
1565       (if (re-search-backward org-table-hline-regexp tbeg t)
1566           (setq beg (point-at-bol 2))
1567         (goto-char tbeg)
1568         (setq beg (point-at-bol 1)))
1569       (goto-char pos)
1570       (if (re-search-forward org-table-hline-regexp tend t)
1571           (setq end (point-at-bol 1))
1572         (goto-char tend)
1573         (setq end (point-at-bol))))
1574     (setq beg (move-marker (make-marker) beg)
1575           end (move-marker (make-marker) end))
1576     (untabify beg end)
1577     (goto-char beg)
1578     (org-table-goto-column column)
1579     (skip-chars-backward "^|")
1580     (setq bcol (current-column))
1581     (org-table-goto-column (1+ column))
1582     (skip-chars-backward "^|")
1583     (setq ecol (1- (current-column)))
1584     (org-table-goto-column column)
1585     (setq lns (mapcar (lambda(x) (cons
1586                                   (org-sort-remove-invisible
1587                                    (nth (1- column)
1588                                         (org-split-string x "[ \t]*|[ \t]*")))
1589                                   x))
1590                       (org-split-string (buffer-substring beg end) "\n")))
1591     (setq lns (org-do-sort lns "Table" with-case sorting-type))
1592     (delete-region beg end)
1593     (move-marker beg nil)
1594     (move-marker end nil)
1595     (insert (mapconcat 'cdr lns "\n") "\n")
1596     (org-goto-line thisline)
1597     (org-table-goto-column thiscol)
1598     (message "%d lines sorted, based on column %d" (length lns) column)))
1599
1600
1601 (defun org-table-cut-region (beg end)
1602   "Copy region in table to the clipboard and blank all relevant fields.
1603 If there is no active region, use just the field at point."
1604   (interactive (list
1605                 (if (org-region-active-p) (region-beginning) (point))
1606                 (if (org-region-active-p) (region-end) (point))))
1607   (org-table-copy-region beg end 'cut))
1608
1609 (defun org-table-copy-region (beg end &optional cut)
1610   "Copy rectangular region in table to clipboard.
1611 A special clipboard is used which can only be accessed
1612 with `org-table-paste-rectangle'."
1613   (interactive (list
1614                 (if (org-region-active-p) (region-beginning) (point))
1615                 (if (org-region-active-p) (region-end) (point))
1616                 current-prefix-arg))
1617   (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
1618          region cols
1619          (rpl (if cut "  " nil)))
1620     (goto-char beg)
1621     (org-table-check-inside-data-field)
1622     (setq l01 (org-current-line)
1623           c01 (org-table-current-column))
1624     (goto-char end)
1625     (org-table-check-inside-data-field)
1626     (setq l02 (org-current-line)
1627           c02 (org-table-current-column))
1628     (setq l1 (min l01 l02) l2 (max l01 l02)
1629           c1 (min c01 c02) c2 (max c01 c02))
1630     (catch 'exit
1631       (while t
1632         (catch 'nextline
1633           (if (> l1 l2) (throw 'exit t))
1634           (org-goto-line l1)
1635           (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
1636           (setq cols nil ic1 c1 ic2 c2)
1637           (while (< ic1 (1+ ic2))
1638             (push (org-table-get-field ic1 rpl) cols)
1639             (setq ic1 (1+ ic1)))
1640           (push (nreverse cols) region)
1641           (setq l1 (1+ l1)))))
1642     (setq org-table-clip (nreverse region))
1643     (if cut (org-table-align))
1644     org-table-clip))
1645
1646 (defun org-table-paste-rectangle ()
1647   "Paste a rectangular region into a table.
1648 The upper right corner ends up in the current field.  All involved fields
1649 will be overwritten.  If the rectangle does not fit into the present table,
1650 the table is enlarged as needed.  The process ignores horizontal separator
1651 lines."
1652   (interactive)
1653   (unless (and org-table-clip (listp org-table-clip))
1654     (error "First cut/copy a region to paste!"))
1655   (org-table-check-inside-data-field)
1656   (let* ((clip org-table-clip)
1657          (line (org-current-line))
1658          (col (org-table-current-column))
1659          (org-enable-table-editor t)
1660          (org-table-automatic-realign nil)
1661          c cols field)
1662     (while (setq cols (pop clip))
1663       (while (org-at-table-hline-p) (beginning-of-line 2))
1664       (if (not (org-at-table-p))
1665           (progn (end-of-line 0) (org-table-next-field)))
1666       (setq c col)
1667       (while (setq field (pop cols))
1668         (org-table-goto-column c nil 'force)
1669         (org-table-get-field nil field)
1670         (setq c (1+ c)))
1671       (beginning-of-line 2))
1672     (org-goto-line line)
1673     (org-table-goto-column col)
1674     (org-table-align)))
1675
1676 (defun org-table-convert ()
1677   "Convert from `org-mode' table to table.el and back.
1678 Obviously, this only works within limits.  When an Org-mode table is
1679 converted to table.el, all horizontal separator lines get lost, because
1680 table.el uses these as cell boundaries and has no notion of horizontal lines.
1681 A table.el table can be converted to an Org-mode table only if it does not
1682 do row or column spanning.  Multiline cells will become multiple cells.
1683 Beware, Org-mode does not test if the table can be successfully converted - it
1684 blindly applies a recipe that works for simple tables."
1685   (interactive)
1686   (require 'table)
1687   (if (org-at-table.el-p)
1688       ;; convert to Org-mode table
1689       (let ((beg (move-marker (make-marker) (org-table-begin t)))
1690             (end (move-marker (make-marker) (org-table-end t))))
1691         (table-unrecognize-region beg end)
1692         (goto-char beg)
1693         (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t)
1694           (replace-match ""))
1695         (goto-char beg))
1696     (if (org-at-table-p)
1697         ;; convert to table.el table
1698         (let ((beg (move-marker (make-marker) (org-table-begin)))
1699               (end (move-marker (make-marker) (org-table-end))))
1700           ;; first, get rid of all horizontal lines
1701           (goto-char beg)
1702           (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t)
1703             (replace-match ""))
1704           ;; insert a hline before first
1705           (goto-char beg)
1706           (org-table-insert-hline 'above)
1707           (beginning-of-line -1)
1708           ;; insert a hline after each line
1709           (while (progn (beginning-of-line 3) (< (point) end))
1710             (org-table-insert-hline))
1711           (goto-char beg)
1712           (setq end (move-marker end (org-table-end)))
1713           ;; replace "+" at beginning and ending of hlines
1714           (while (re-search-forward "^\\([ \t]*\\)|-" end t)
1715             (replace-match "\\1+-"))
1716           (goto-char beg)
1717           (while (re-search-forward "-|[ \t]*$" end t)
1718             (replace-match "-+"))
1719           (goto-char beg)))))
1720
1721 (defun org-table-wrap-region (arg)
1722   "Wrap several fields in a column like a paragraph.
1723 This is useful if you'd like to spread the contents of a field over several
1724 lines, in order to keep the table compact.
1725
1726 If there is an active region, and both point and mark are in the same column,
1727 the text in the column is wrapped to minimum width for the given number of
1728 lines.  Generally, this makes the table more compact.  A prefix ARG may be
1729 used to change the number of desired lines.  For example, `C-2 \\[org-table-wrap]'
1730 formats the selected text to two lines.  If the region was longer than two
1731 lines, the remaining lines remain empty.  A negative prefix argument reduces
1732 the current number of lines by that amount.  The wrapped text is pasted back
1733 into the table.  If you formatted it to more lines than it was before, fields
1734 further down in the table get overwritten - so you might need to make space in
1735 the table first.
1736
1737 If there is no region, the current field is split at the cursor position and
1738 the text fragment to the right of the cursor is prepended to the field one
1739 line down.
1740
1741 If there is no region, but you specify a prefix ARG, the current field gets
1742 blank, and the content is appended to the field above."
1743   (interactive "P")
1744   (org-table-check-inside-data-field)
1745   (if (org-region-active-p)
1746       ;; There is a region:  fill as a paragraph
1747       (let* ((beg (region-beginning))
1748              (cline (save-excursion (goto-char beg) (org-current-line)))
1749              (ccol (save-excursion (goto-char beg) (org-table-current-column)))
1750              nlines)
1751         (org-table-cut-region (region-beginning) (region-end))
1752         (if (> (length (car org-table-clip)) 1)
1753             (error "Region must be limited to single column"))
1754         (setq nlines (if arg
1755                          (if (< arg 1)
1756                              (+ (length org-table-clip) arg)
1757                            arg)
1758                        (length org-table-clip)))
1759         (setq org-table-clip
1760               (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
1761                                       nil nlines)))
1762         (org-goto-line cline)
1763         (org-table-goto-column ccol)
1764         (org-table-paste-rectangle))
1765     ;; No region, split the current field at point
1766     (unless (org-get-alist-option org-M-RET-may-split-line 'table)
1767       (skip-chars-forward "^\r\n|"))
1768     (if arg
1769         ;; combine with field above
1770         (let ((s (org-table-blank-field))
1771               (col (org-table-current-column)))
1772           (beginning-of-line 0)
1773           (while (org-at-table-hline-p) (beginning-of-line 0))
1774           (org-table-goto-column col)
1775           (skip-chars-forward "^|")
1776           (skip-chars-backward " ")
1777           (insert " " (org-trim s))
1778           (org-table-align))
1779       ;;  split field
1780       (if (looking-at "\\([^|]+\\)+|")
1781           (let ((s (match-string 1)))
1782             (replace-match " |")
1783             (goto-char (match-beginning 0))
1784             (org-table-next-row)
1785             (insert (org-trim s) " ")
1786             (org-table-align))
1787         (org-table-next-row)))))
1788
1789 (defvar org-field-marker nil)
1790
1791 (defun org-table-edit-field (arg)
1792   "Edit table field in a different window.
1793 This is mainly useful for fields that contain hidden parts.
1794 When called with a \\[universal-argument] prefix, just make the full field visible so that
1795 it can be edited in place."
1796   (interactive "P")
1797   (cond
1798    ((equal arg '(16))
1799     (org-table-follow-field-mode (if org-table-follow-field-mode -1 1)))
1800    (arg
1801     (let ((b (save-excursion (skip-chars-backward "^|") (point)))
1802           (e (save-excursion (skip-chars-forward "^|\r\n") (point))))
1803       (remove-text-properties b e '(org-cwidth t invisible t
1804                                                display t intangible t))
1805       (if (and (boundp 'font-lock-mode) font-lock-mode)
1806           (font-lock-fontify-block))))
1807    (t
1808     (let ((pos (move-marker (make-marker) (point)))
1809           (coord
1810            (if (eq org-table-use-standard-references t)
1811                (concat (org-number-to-letters (org-table-current-column))
1812                        (int-to-string (org-table-current-dline)))
1813              (concat "@" (int-to-string (org-table-current-dline))
1814                      "$" (int-to-string (org-table-current-column)))))
1815           (field (org-table-get-field))
1816           (cw (current-window-configuration))
1817           p)
1818       (goto-char pos)
1819       (org-switch-to-buffer-other-window "*Org Table Edit Field*")
1820       (when (and (local-variable-p 'org-field-marker)
1821                  (markerp org-field-marker))
1822         (move-marker org-field-marker nil))
1823       (erase-buffer)
1824       (insert "#\n# Edit field " coord " and finish with C-c C-c\n#\n")
1825       (let ((org-inhibit-startup t)) (org-mode))
1826       (auto-fill-mode -1)
1827       (setq truncate-lines nil)
1828       (setq word-wrap t)
1829       (goto-char (setq p (point-max)))
1830       (insert (org-trim field))
1831       (remove-text-properties p (point-max)
1832                               '(invisible t org-cwidth t display t
1833                                           intangible t))
1834       (goto-char p)
1835       (org-set-local 'org-finish-function 'org-table-finish-edit-field)
1836       (org-set-local 'org-window-configuration cw)
1837       (org-set-local 'org-field-marker pos)
1838       (message "Edit and finish with C-c C-c")))))
1839
1840 (defun org-table-finish-edit-field ()
1841   "Finish editing a table data field.
1842 Remove all newline characters, insert the result into the table, realign
1843 the table and kill the editing buffer."
1844   (let ((pos org-field-marker)
1845         (cw org-window-configuration)
1846         (cb (current-buffer))
1847         text)
1848     (goto-char (point-min))
1849     (while (re-search-forward "^#.*\n?" nil t) (replace-match ""))
1850     (while (re-search-forward "\\([ \t]*\n[ \t]*\\)+" nil t)
1851       (replace-match " "))
1852     (setq text (org-trim (buffer-string)))
1853     (set-window-configuration cw)
1854     (kill-buffer cb)
1855     (select-window (get-buffer-window (marker-buffer pos)))
1856     (goto-char pos)
1857     (move-marker pos nil)
1858     (org-table-check-inside-data-field)
1859     (org-table-get-field nil text)
1860     (org-table-align)
1861     (message "New field value inserted")))
1862
1863 (define-minor-mode org-table-follow-field-mode
1864   "Minor mode to make the table field editor window follow the cursor.
1865 When this mode is active, the field editor window will always show the
1866 current field.  The mode exits automatically when the cursor leaves the
1867 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1868   nil " TblFollow" nil
1869   (if org-table-follow-field-mode
1870       (org-add-hook 'post-command-hook 'org-table-follow-fields-with-editor
1871                     'append 'local)
1872     (remove-hook 'post-command-hook 'org-table-follow-fields-with-editor 'local)
1873     (let* ((buf (get-buffer "*Org Table Edit Field*"))
1874            (win (and buf (get-buffer-window buf))))
1875       (when win (delete-window win))
1876       (when buf
1877         (with-current-buffer buf
1878           (move-marker org-field-marker nil))
1879         (kill-buffer buf)))))
1880
1881 (defun org-table-follow-fields-with-editor ()
1882   (if (and org-table-exit-follow-field-mode-when-leaving-table
1883            (not (org-at-table-p)))
1884       ;; We have left the table, exit the follow mode
1885       (org-table-follow-field-mode -1)
1886     (when (org-table-check-inside-data-field 'noerror)
1887       (let ((win (selected-window)))
1888         (org-table-edit-field nil)
1889         (org-fit-window-to-buffer)
1890         (select-window win)))))
1891
1892 (defvar org-timecnt) ; dynamically scoped parameter
1893
1894 (defun org-table-sum (&optional beg end nlast)
1895   "Sum numbers in region of current table column.
1896 The result will be displayed in the echo area, and will be available
1897 as kill to be inserted with \\[yank].
1898
1899 If there is an active region, it is interpreted as a rectangle and all
1900 numbers in that rectangle will be summed.  If there is no active
1901 region and point is located in a table column, sum all numbers in that
1902 column.
1903
1904 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1905 numbers are assumed to be times as well (in decimal hours) and the
1906 numbers are added as such.
1907
1908 If NLAST is a number, only the NLAST fields will actually be summed."
1909   (interactive)
1910   (save-excursion
1911     (let (col (org-timecnt 0) diff h m s org-table-clip)
1912       (cond
1913        ((and beg end))   ; beg and end given explicitly
1914        ((org-region-active-p)
1915         (setq beg (region-beginning) end (region-end)))
1916        (t
1917         (setq col (org-table-current-column))
1918         (goto-char (org-table-begin))
1919         (unless (re-search-forward "^[ \t]*|[^-]" nil t)
1920           (error "No table data"))
1921         (org-table-goto-column col)
1922         (setq beg (point))
1923         (goto-char (org-table-end))
1924         (unless (re-search-backward "^[ \t]*|[^-]" nil t)
1925           (error "No table data"))
1926         (org-table-goto-column col)
1927         (setq end (point))))
1928       (let* ((items (apply 'append (org-table-copy-region beg end)))
1929              (items1 (cond ((not nlast) items)
1930                            ((>= nlast (length items)) items)
1931                            (t (setq items (reverse items))
1932                               (setcdr (nthcdr (1- nlast) items) nil)
1933                               (nreverse items))))
1934              (numbers (delq nil (mapcar 'org-table-get-number-for-summing
1935                                         items1)))
1936              (res (apply '+ numbers))
1937              (sres (if (= org-timecnt 0)
1938                        (number-to-string res)
1939                      (setq diff (* 3600 res)
1940                            h (floor (/ diff 3600)) diff (mod diff 3600)
1941                            m (floor (/ diff 60)) diff (mod diff 60)
1942                            s diff)
1943                      (format "%d:%02d:%02d" h m s))))
1944         (kill-new sres)
1945         (if (org-called-interactively-p 'interactive)
1946             (message "%s"
1947                      (substitute-command-keys
1948                       (format "Sum of %d items: %-20s     (\\[yank] will insert result into buffer)"
1949                               (length numbers) sres))))
1950         sres))))
1951
1952 (defun org-table-get-number-for-summing (s)
1953   (let (n)
1954     (if (string-match "^ *|? *" s)
1955         (setq s (replace-match "" nil nil s)))
1956     (if (string-match " *|? *$" s)
1957         (setq s (replace-match "" nil nil s)))
1958     (setq n (string-to-number s))
1959     (cond
1960      ((and (string-match "0" s)
1961            (string-match "\\`[-+ \t0.edED]+\\'" s)) 0)
1962      ((string-match "\\`[ \t]+\\'" s) nil)
1963      ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s)
1964       (let ((h (string-to-number (or (match-string 1 s) "0")))
1965             (m (string-to-number (or (match-string 2 s) "0")))
1966             (s (string-to-number (or (match-string 4 s) "0"))))
1967         (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
1968         (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
1969      ((equal n 0) nil)
1970      (t n))))
1971
1972 (defun org-table-current-field-formula (&optional key noerror)
1973   "Return the formula active for the current field.
1974 Assumes that specials are in place.
1975 If KEY is given, return the key to this formula.
1976 Otherwise return the formula preceded with \"=\" or \":=\"."
1977   (let* ((name (car (rassoc (list (org-current-line)
1978                                   (org-table-current-column))
1979                             org-table-named-field-locations)))
1980          (col (org-table-current-column))
1981          (scol (int-to-string col))
1982          (ref (format "@%d$%d" (org-table-current-dline) col))
1983          (stored-list (org-table-get-stored-formulas noerror))
1984          (ass (or (assoc name stored-list)
1985                   (assoc ref stored-list)
1986                   (assoc scol stored-list))))
1987     (if key
1988         (car ass)
1989       (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
1990                       (cdr ass))))))
1991
1992 (defun org-table-get-formula (&optional equation named)
1993   "Read a formula from the minibuffer, offer stored formula as default.
1994 When NAMED is non-nil, look for a named equation."
1995   (let* ((stored-list (org-table-get-stored-formulas))
1996          (name (car (rassoc (list (org-current-line)
1997                                   (org-table-current-column))
1998                             org-table-named-field-locations)))
1999          (ref (format "@%d$%d" (org-table-current-dline)
2000                       (org-table-current-column)))
2001          (refass (assoc ref stored-list))
2002          (nameass (assoc name stored-list))
2003          (scol (if named
2004                    (if (and name (not (string-match "^LR[0-9]+$" name)))
2005                        name
2006                      ref)
2007                  (int-to-string (org-table-current-column))))
2008          (dummy (and (or nameass refass) (not named)
2009                      (not (y-or-n-p "Replace existing field formula with column formula? " ))
2010                      (error "Abort")))
2011          (name (or name ref))
2012          (org-table-may-need-update nil)
2013          (stored (cdr (assoc scol stored-list)))
2014          (eq (cond
2015               ((and stored equation (string-match "^ *=? *$" equation))
2016                stored)
2017               ((stringp equation)
2018                equation)
2019               (t (org-table-formula-from-user
2020                   (read-string
2021                    (org-table-formula-to-user
2022                     (format "%s formula %s%s="
2023                             (if named "Field" "Column")
2024                             (if (member (string-to-char scol) '(?$ ?@)) "" "$")
2025                             scol))
2026                    (if stored (org-table-formula-to-user stored) "")
2027                    'org-table-formula-history
2028                    )))))
2029          mustsave)
2030     (when (not (string-match "\\S-" eq))
2031       ;; remove formula
2032       (setq stored-list (delq (assoc scol stored-list) stored-list))
2033       (org-table-store-formulas stored-list)
2034       (error "Formula removed"))
2035     (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
2036     (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
2037     (if (and name (not named))
2038         ;; We set the column equation, delete the named one.
2039         (setq stored-list (delq (assoc name stored-list) stored-list)
2040               mustsave t))
2041     (if stored
2042         (setcdr (assoc scol stored-list) eq)
2043       (setq stored-list (cons (cons scol eq) stored-list)))
2044     (if (or mustsave (not (equal stored eq)))
2045         (org-table-store-formulas stored-list))
2046     eq))
2047
2048 (defun org-table-store-formulas (alist)
2049   "Store the list of formulas below the current table."
2050   (setq alist (sort alist 'org-table-formula-less-p))
2051   (save-excursion
2052     (goto-char (org-table-end))
2053     (if (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM:\\(.*\n?\\)")
2054         (progn
2055           ;; don't overwrite TBLFM, we might use text properties to store stuff
2056           (goto-char (match-beginning 2))
2057           (delete-region (match-beginning 2) (match-end 0)))
2058       (org-indent-line-function)
2059       (insert "#+TBLFM:"))
2060     (insert " "
2061             (mapconcat (lambda (x)
2062                          (concat
2063                           (if (equal (string-to-char (car x)) ?@) "" "$")
2064                           (car x) "=" (cdr x)))
2065                        alist "::")
2066             "\n")))
2067
2068 (defsubst org-table-formula-make-cmp-string (a)
2069   (when (string-match "\\`$[<>]" a)
2070     (let ((arrow (string-to-char (substring a 1))))
2071       ;; Fake a high number to make sure this is sorted at the end.
2072       (setq a (org-table-formula-handle-first/last-rc a))
2073       (setq a (format "$%d" (+ 10000
2074                                (if (= arrow ?<) -1000 0)
2075                                (string-to-number (substring a 1)))))))
2076   (when (string-match
2077          "^\\(@\\([0-9]+\\)\\)?\\(\\$?\\([0-9]+\\)\\)?\\(\\$?[a-zA-Z0-9]+\\)?"
2078          a)
2079     (concat
2080      (if (match-end 2)
2081          (format "@%05d" (string-to-number (match-string 2 a))) "")
2082      (if (match-end 4)
2083          (format "$%05d" (string-to-number (match-string 4 a))) "")
2084      (if (match-end 5)
2085          (concat "@@" (match-string 5 a))))))
2086
2087 (defun org-table-formula-less-p (a b)
2088   "Compare two formulas for sorting."
2089   (let ((as (org-table-formula-make-cmp-string (car a)))
2090         (bs (org-table-formula-make-cmp-string (car b))))
2091     (and as bs (string< as bs))))
2092
2093 (defun org-table-get-stored-formulas (&optional noerror)
2094   "Return an alist with the stored formulas directly after current table."
2095   (interactive)
2096   (let (scol eq eq-alist strings string seen)
2097     (save-excursion
2098       (goto-char (org-table-end))
2099       (when (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM: *\\(.*\\)")
2100         (setq strings (org-split-string (org-match-string-no-properties 2)
2101                                         " *:: *"))
2102         (while (setq string (pop strings))
2103           (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2104             (setq scol (if (match-end 2)
2105                            (match-string 2 string)
2106                          (match-string 1 string))
2107                   scol (if (member (string-to-char scol) '(?< ?>))
2108                            (concat "$" scol) scol)
2109                   eq (match-string 3 string)
2110                   eq-alist (cons (cons scol eq) eq-alist))
2111             (if (member scol seen)
2112                 (if noerror
2113                     (progn
2114                       (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
2115                       (ding)
2116                       (sit-for 2))
2117                   (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
2118               (push scol seen))))))
2119     (nreverse eq-alist)))
2120
2121 (defun org-table-fix-formulas (key replace &optional limit delta remove)
2122   "Modify the equations after the table structure has been edited.
2123 KEY is \"@\" or \"$\".  REPLACE is an alist of numbers to replace.
2124 For all numbers larger than LIMIT, shift them by DELTA."
2125   (save-excursion
2126     (goto-char (org-table-end))
2127     (when (looking-at "[ \t]*#\\+TBLFM:")
2128       (let ((re (concat key "\\([0-9]+\\)"))
2129             (re2
2130              (when remove
2131                (if (or (equal key "$") (equal key "$LR"))
2132                    (format "\\(@[0-9]+\\)?%s%d=.*?\\(::\\|$\\)"
2133                            (regexp-quote key) remove)
2134                  (format "@%d\\$[0-9]+=.*?\\(::\\|$\\)" remove))))
2135             s n a)
2136         (when remove
2137           (while (re-search-forward re2 (point-at-eol) t)
2138             (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
2139               (if (equal (char-before (match-beginning 0)) ?.)
2140                   (error "Change makes TBLFM term %s invalid.  Use undo to recover."
2141                          (match-string 0))
2142                 (replace-match "")))))
2143         (while (re-search-forward re (point-at-eol) t)
2144           (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
2145             (setq s (match-string 1) n (string-to-number s))
2146             (cond
2147              ((setq a (assoc s replace))
2148               (replace-match (concat key (cdr a)) t t))
2149              ((and limit (> n limit))
2150               (replace-match (concat key (int-to-string (+ n delta)))
2151                              t t)))))))))
2152
2153 (defun org-table-get-specials ()
2154   "Get the column names and local parameters for this table."
2155   (save-excursion
2156     (let ((beg (org-table-begin)) (end (org-table-end))
2157           names name fields fields1 field cnt
2158           c v l line col types dlines hlines last-dline)
2159       (setq org-table-column-names nil
2160             org-table-local-parameters nil
2161             org-table-named-field-locations nil
2162             org-table-current-begin-line nil
2163             org-table-current-begin-pos nil
2164             org-table-current-line-types nil
2165             org-table-current-ncol 0)
2166       (goto-char beg)
2167       (when (re-search-forward "^[ \t]*| *! *\\(|.*\\)" end t)
2168         (setq names (org-split-string (match-string 1) " *| *")
2169               cnt 1)
2170         (while (setq name (pop names))
2171           (setq cnt (1+ cnt))
2172           (if (string-match "^[a-zA-Z][_a-zA-Z0-9]*$" name)
2173               (push (cons name (int-to-string cnt)) org-table-column-names))))
2174       (setq org-table-column-names (nreverse org-table-column-names))
2175       (setq org-table-column-name-regexp
2176             (concat "\\$\\(" (mapconcat 'car org-table-column-names "\\|") "\\)\\>"))
2177       (goto-char beg)
2178       (while (re-search-forward "^[ \t]*| *\\$ *\\(|.*\\)" end t)
2179         (setq fields (org-split-string (match-string 1) " *| *"))
2180         (while (setq field (pop fields))
2181           (if (string-match "^\\([a-zA-Z][_a-zA-Z0-9]*\\|%\\) *= *\\(.*\\)" field)
2182               (push (cons (match-string 1 field) (match-string 2 field))
2183                     org-table-local-parameters))))
2184       (goto-char beg)
2185       (while (re-search-forward "^[ \t]*| *\\([_^]\\) *\\(|.*\\)" end t)
2186         (setq c (match-string 1)
2187               fields (org-split-string (match-string 2) " *| *"))
2188         (save-excursion
2189           (beginning-of-line (if (equal c "_") 2 0))
2190           (setq line (org-current-line) col 1)
2191           (and (looking-at "^[ \t]*|[^|]*\\(|.*\\)")
2192                (setq fields1 (org-split-string (match-string 1) " *| *"))))
2193         (while (and fields1 (setq field (pop fields)))
2194           (setq v (pop fields1) col (1+ col))
2195           (when (and (stringp field) (stringp v)
2196                      (string-match "^[a-zA-Z][_a-zA-Z0-9]*$" field))
2197               (push (cons field v) org-table-local-parameters)
2198               (push (list field line col) org-table-named-field-locations))))
2199       ;; Analyse the line types
2200       (goto-char beg)
2201       (setq org-table-current-begin-line (org-current-line)
2202             org-table-current-begin-pos (point)
2203             l org-table-current-begin-line)
2204       (while (looking-at "[ \t]*|\\(-\\)?")
2205         (push (if (match-end 1) 'hline 'dline) types)
2206         (if (match-end 1) (push l hlines) (push l dlines))
2207         (beginning-of-line 2)
2208         (setq l (1+ l)))
2209       (push 'hline types) ;; add an imaginary extra hline to the end
2210       (setq org-table-current-line-types (apply 'vector (nreverse types))
2211             last-dline (car dlines)
2212             org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
2213             org-table-hlines (apply 'vector (cons nil (nreverse hlines))))
2214       (org-goto-line last-dline)
2215       (let* ((l last-dline)
2216              (fields (org-split-string
2217                       (buffer-substring (point-at-bol) (point-at-eol))
2218                       "[ \t]*|[ \t]*"))
2219              (nfields (length fields))
2220              al al2)
2221         (setq org-table-current-ncol nfields)
2222         (loop for i from 1 to nfields do
2223               (push (list (format "LR%d" i) l i) al)
2224               (push (cons (format "LR%d" i) (nth (1- i) fields)) al2))
2225         (setq org-table-named-field-locations
2226               (append org-table-named-field-locations al))
2227         (setq org-table-local-parameters
2228               (append org-table-local-parameters al2))))))
2229
2230 (defun org-table-maybe-eval-formula ()
2231   "Check if the current field starts with \"=\" or \":=\".
2232 If yes, store the formula and apply it."
2233   ;; We already know we are in a table.  Get field will only return a formula
2234   ;; when appropriate.  It might return a separator line, but no problem.
2235   (when org-table-formula-evaluate-inline
2236     (let* ((field (org-trim (or (org-table-get-field) "")))
2237            named eq)
2238       (when (string-match "^:?=\\(.*\\)" field)
2239         (setq named (equal (string-to-char field) ?:)
2240               eq (match-string 1 field))
2241         (if (or (fboundp 'calc-eval)
2242                 (equal (substring eq 0 (min 2 (length eq))) "'("))
2243             (org-table-eval-formula (if named '(4) nil)
2244                                     (org-table-formula-from-user eq))
2245           (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
2246
2247 (defvar org-recalc-commands nil
2248   "List of commands triggering the recalculation of a line.
2249 Will be filled automatically during use.")
2250
2251 (defvar org-recalc-marks
2252   '((" " . "Unmarked: no special line, no automatic recalculation")
2253     ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
2254     ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
2255     ("!" . "Column name definition line. Reference in formula as $name.")
2256     ("$" . "Parameter definition line name=value. Reference in formula as $name.")
2257     ("_" . "Names for values in row below this one.")
2258     ("^" . "Names for values in row above this one.")))
2259
2260 (defun org-table-rotate-recalc-marks (&optional newchar)
2261   "Rotate the recalculation mark in the first column.
2262 If in any row, the first field is not consistent with a mark,
2263 insert a new column for the markers.
2264 When there is an active region, change all the lines in the region,
2265 after prompting for the marking character.
2266 After each change, a message will be displayed indicating the meaning
2267 of the new mark."
2268   (interactive)
2269   (unless (org-at-table-p) (error "Not at a table"))
2270   (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
2271          (beg (org-table-begin))
2272          (end (org-table-end))
2273          (l (org-current-line))
2274          (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
2275          (l2 (if (org-region-active-p) (org-current-line (region-end))))
2276          (have-col
2277           (save-excursion
2278             (goto-char beg)
2279             (not (re-search-forward "^[ \t]*|[^-|][^|]*[^#!$*_^| \t][^|]*|" end t))))
2280          (col (org-table-current-column))
2281          (forcenew (car (assoc newchar org-recalc-marks)))
2282          epos new)
2283     (when l1
2284       (message "Change region to what mark?  Type # * ! $ or SPC: ")
2285       (setq newchar (char-to-string (read-char-exclusive))
2286             forcenew (car (assoc newchar org-recalc-marks))))
2287     (if (and newchar (not forcenew))
2288         (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
2289                newchar))
2290     (if l1 (org-goto-line l1))
2291     (save-excursion
2292       (beginning-of-line 1)
2293       (unless (looking-at org-table-dataline-regexp)
2294         (error "Not at a table data line")))
2295     (unless have-col
2296       (org-table-goto-column 1)
2297       (org-table-insert-column)
2298       (org-table-goto-column (1+ col)))
2299     (setq epos (point-at-eol))
2300     (save-excursion
2301       (beginning-of-line 1)
2302       (org-table-get-field
2303        1 (if (looking-at "^[ \t]*| *\\([#!$*^_ ]\\) *|")
2304              (concat " "
2305                      (setq new (or forcenew
2306                                    (cadr (member (match-string 1) marks))))
2307                      " ")
2308            " # ")))
2309     (if (and l1 l2)
2310         (progn
2311           (org-goto-line l1)
2312           (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
2313             (and (looking-at org-table-dataline-regexp)
2314                  (org-table-get-field 1 (concat " " new " "))))
2315           (org-goto-line l1)))
2316     (if (not (= epos (point-at-eol))) (org-table-align))
2317     (org-goto-line l)
2318     (and (org-called-interactively-p 'interactive)
2319          (message "%s" (cdr (assoc new org-recalc-marks))))))
2320
2321 (defun org-table-maybe-recalculate-line ()
2322   "Recompute the current line if marked for it, and if we haven't just done it."
2323   (interactive)
2324   (and org-table-allow-automatic-line-recalculation
2325        (not (and (memq last-command org-recalc-commands)
2326                  (equal org-last-recalc-line (org-current-line))))
2327        (save-excursion (beginning-of-line 1)
2328                        (looking-at org-table-auto-recalculate-regexp))
2329        (org-table-recalculate) t))
2330
2331 (defvar modes)
2332 (defsubst org-set-calc-mode (var &optional value)
2333   (if (stringp var)
2334       (setq var (assoc var '(("D" calc-angle-mode deg)
2335                              ("R" calc-angle-mode rad)
2336                              ("F" calc-prefer-frac t)
2337                              ("S" calc-symbolic-mode t)))
2338             value (nth 2 var) var (nth 1 var)))
2339   (if (memq var modes)
2340       (setcar (cdr (memq var modes)) value)
2341     (cons var (cons value modes)))
2342   modes)
2343
2344 (defun org-table-eval-formula (&optional arg equation
2345                                          suppress-align suppress-const
2346                                          suppress-store suppress-analysis)
2347   "Replace the table field value at the cursor by the result of a calculation.
2348
2349 This function makes use of Dave Gillespie's Calc package, in my view the
2350 most exciting program ever written for GNU Emacs.  So you need to have Calc
2351 installed in order to use this function.
2352
2353 In a table, this command replaces the value in the current field with the
2354 result of a formula.  It also installs the formula as the \"current\" column
2355 formula, by storing it in a special line below the table.  When called
2356 with a `C-u' prefix, the current field must be a named field, and the
2357 formula is installed as valid in only this specific field.
2358
2359 When called with two `C-u' prefixes, insert the active equation
2360 for the field back into the current field, so that it can be
2361 edited there.  This is useful in order to use \\[org-table-show-reference]
2362 to check the referenced fields.
2363
2364 When called, the command first prompts for a formula, which is read in
2365 the minibuffer.  Previously entered formulas are available through the
2366 history list, and the last used formula is offered as a default.
2367 These stored formulas are adapted correctly when moving, inserting, or
2368 deleting columns with the corresponding commands.
2369
2370 The formula can be any algebraic expression understood by the Calc package.
2371 For details, see the Org-mode manual.
2372
2373 This function can also be called from Lisp programs and offers
2374 additional arguments: EQUATION can be the formula to apply.  If this
2375 argument is given, the user will not be prompted.  SUPPRESS-ALIGN is
2376 used to speed-up recursive calls by by-passing unnecessary aligns.
2377 SUPPRESS-CONST suppresses the interpretation of constants in the
2378 formula, assuming that this has been done already outside the function.
2379 SUPPRESS-STORE means the formula should not be stored, either because
2380 it is already stored, or because it is a modified equation that should
2381 not overwrite the stored one."
2382   (interactive "P")
2383   (org-table-check-inside-data-field)
2384   (or suppress-analysis (org-table-get-specials))
2385   (if (equal arg '(16))
2386       (let ((eq (org-table-current-field-formula)))
2387         (or eq (error "No equation active for current field"))
2388         (org-table-get-field nil eq)
2389         (org-table-align)
2390         (setq org-table-may-need-update t))
2391     (let* (fields
2392            (ndown (if (integerp arg) arg 1))
2393            (org-table-automatic-realign nil)
2394            (case-fold-search nil)
2395            (down (> ndown 1))
2396            (formula (if (and equation suppress-store)
2397                         equation
2398                       (org-table-get-formula equation (equal arg '(4)))))
2399            (n0 (org-table-current-column))
2400            (modes (copy-sequence org-calc-default-modes))
2401            (numbers nil) ; was a variable, now fixed default
2402            (keep-empty nil)
2403            n form form0 formrpl formrg bw fmt x ev orig c lispp literal 
2404            duration duration-output-format)
2405       ;; Parse the format string.  Since we have a lot of modes, this is
2406       ;; a lot of work.  However, I think calc still uses most of the time.
2407       (if (string-match ";" formula)
2408           (let ((tmp (org-split-string formula ";")))
2409             (setq formula (car tmp)
2410                   fmt (concat (cdr (assoc "%" org-table-local-parameters))
2411                               (nth 1 tmp)))
2412             (while (string-match "\\([pnfse]\\)\\(-?[0-9]+\\)" fmt)
2413               (setq c (string-to-char (match-string 1 fmt))
2414                     n (string-to-number (match-string 2 fmt)))
2415               (if (= c ?p)
2416                   (setq modes (org-set-calc-mode 'calc-internal-prec n))
2417                 (setq modes (org-set-calc-mode
2418                              'calc-float-format
2419                              (list (cdr (assoc c '((?n . float) (?f . fix)
2420                                                    (?s . sci) (?e . eng))))
2421                                    n))))
2422               (setq fmt (replace-match "" t t fmt)))
2423             (if (string-match "T" fmt)
2424                 (setq duration t numbers t
2425                       duration-output-format nil
2426                       fmt (replace-match "" t t fmt)))
2427             (if (string-match "t" fmt)
2428                 (setq duration t 
2429                       duration-output-format org-table-duration-custom-format
2430                       numbers t
2431                       fmt (replace-match "" t t fmt)))
2432             (if (string-match "N" fmt)
2433                 (setq numbers t
2434                       fmt (replace-match "" t t fmt)))
2435             (if (string-match "L" fmt)
2436                 (setq literal t
2437                       fmt (replace-match "" t t fmt)))
2438             (if (string-match "E" fmt)
2439                 (setq keep-empty t
2440                       fmt (replace-match "" t t fmt)))
2441             (while (string-match "[DRFS]" fmt)
2442               (setq modes (org-set-calc-mode (match-string 0 fmt)))
2443               (setq fmt (replace-match "" t t fmt)))
2444             (unless (string-match "\\S-" fmt)
2445               (setq fmt nil))))
2446       (if (and (not suppress-const) org-table-formula-use-constants)
2447           (setq formula (org-table-formula-substitute-names formula)))
2448       (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
2449       (while (> ndown 0)
2450         (setq fields (org-split-string
2451                       (org-no-properties
2452                        (buffer-substring (point-at-bol) (point-at-eol)))
2453                       " *| *"))
2454         ;; replace fields with duration values if relevant
2455         (if duration
2456             (setq fields
2457                   (mapcar (lambda (x) (org-table-time-string-to-seconds x))
2458                           fields)))
2459         (if (eq numbers t)
2460             (setq fields (mapcar
2461                           (lambda (x) (number-to-string (string-to-number x)))
2462                           fields)))
2463         (setq ndown (1- ndown))
2464         (setq form (copy-sequence formula)
2465               lispp (and (> (length form) 2) (equal (substring form 0 2) "'(")))
2466         (if (and lispp literal) (setq lispp 'literal))
2467
2468         ;; Insert row and column number of formula result field
2469         (while (string-match "[@$]#" form)
2470           (setq form
2471                 (replace-match
2472                  (format "%d"
2473                          (save-match-data
2474                            (if (equal (substring form (match-beginning 0)
2475                                                  (1+ (match-beginning 0)))
2476                                       "@")
2477                                (org-table-current-dline)
2478                              (org-table-current-column))))
2479                  t t form)))
2480
2481         ;; Check for old vertical references
2482         (setq form (org-table-rewrite-old-row-references form))
2483         ;; Insert remote references
2484         (while (string-match "\\<remote([ \t]*\\([-_a-zA-Z0-9]+\\)[ \t]*,[ \t]*\\([^\n)]+\\))" form)
2485           (setq form
2486                 (replace-match
2487                  (save-match-data
2488                    (org-table-make-reference
2489                     (org-table-get-remote-range
2490                      (match-string 1 form) (match-string 2 form))
2491                     keep-empty numbers lispp))
2492                  t t form)))
2493         ;; Insert complex ranges
2494         (while (and (string-match org-table-range-regexp form)
2495                     (> (length (match-string 0 form)) 1))
2496           (setq formrg (save-match-data 
2497                          (org-table-get-range (match-string 0 form) nil n0)))
2498           (setq formrpl
2499                 (save-match-data
2500                   (org-table-make-reference
2501                    ;; possibly handle durations
2502                    (if duration
2503                        (if (listp formrg)
2504                            (mapcar (lambda(x) (org-table-time-string-to-seconds x)) formrg)
2505                          (org-table-time-string-to-seconds formrg))
2506                      formrg)
2507                    keep-empty numbers lispp)))
2508           (if (not (save-match-data
2509                      (string-match (regexp-quote form) formrpl)))
2510               (setq form (replace-match formrpl t t form))
2511             (error "Spreadsheet error: invalid reference \"%s\"" form)))
2512         ;; Insert simple ranges
2513         (while (string-match "\\$\\([0-9]+\\)\\.\\.\\$\\([0-9]+\\)"  form)
2514           (setq form
2515                 (replace-match
2516                  (save-match-data
2517                    (org-table-make-reference
2518                     (org-sublist
2519                      fields (string-to-number (match-string 1 form))
2520                      (string-to-number (match-string 2 form)))
2521                     keep-empty numbers lispp))
2522                  t t form)))
2523         (setq form0 form)
2524         ;; Insert the references to fields in same row
2525         (while (string-match "\\$\\(\\([-+]\\)?[0-9]+\\)" form)
2526           (setq n (+ (string-to-number (match-string 1 form))
2527                      (if (match-end 2) n0 0))
2528                 x (nth (1- (if (= n 0) n0 (max n 1))) fields))
2529           (unless x (error "Invalid field specifier \"%s\""
2530                            (match-string 0 form)))
2531           (setq form (replace-match
2532                       (save-match-data
2533                         (org-table-make-reference x nil numbers lispp))
2534                       t t form)))
2535
2536         (if lispp
2537             (setq ev (condition-case nil
2538                          (eval (eval (read form)))
2539                        (error "#ERROR"))
2540                   ev (if (numberp ev) (number-to-string ev) ev)
2541                   ev (if duration (org-table-time-seconds-to-string
2542                                    (string-to-number ev)
2543                                    duration-output-format) ev))
2544           (or (fboundp 'calc-eval)
2545               (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
2546           (setq ev (calc-eval (cons form modes) (if numbers 'num))
2547                 ev (if duration (org-table-time-seconds-to-string
2548                                  (string-to-number ev)
2549                                  duration-output-format) ev)))
2550
2551         (when org-table-formula-debug
2552           (with-output-to-temp-buffer "*Substitution History*"
2553             (princ (format "Substitution history of formula
2554 Orig:   %s
2555 $xyz->  %s
2556 @r$c->  %s
2557 $1->    %s\n" orig formula form0 form))
2558             (if (listp ev)
2559                 (princ (format "       %s^\nError:  %s"
2560                                (make-string (car ev) ?\-) (nth 1 ev)))
2561               (princ (format "Result: %s\nFormat: %s\nFinal:  %s"
2562                              ev (or fmt "NONE")
2563                              (if fmt (format fmt (string-to-number ev)) ev)))))
2564           (setq bw (get-buffer-window "*Substitution History*"))
2565           (org-fit-window-to-buffer bw)
2566           (unless (and (org-called-interactively-p 'any) (not ndown))
2567             (unless (let (inhibit-redisplay)
2568                       (y-or-n-p "Debugging Formula.  Continue to next? "))
2569               (org-table-align)
2570               (error "Abort"))
2571             (delete-window bw)
2572             (message "")))
2573         (if (listp ev) (setq fmt nil ev "#ERROR"))
2574         (org-table-justify-field-maybe
2575          (if fmt (format fmt (string-to-number ev)) ev))
2576         (if (and down (> ndown 0) (looking-at ".*\n[ \t]*|[^-]"))
2577             (call-interactively 'org-return)
2578           (setq ndown 0)))
2579       (and down (org-table-maybe-recalculate-line))
2580       (or suppress-align (and org-table-may-need-update
2581                               (org-table-align))))))
2582
2583 (defun org-table-put-field-property (prop value)
2584   (save-excursion
2585     (put-text-property (progn (skip-chars-backward "^|") (point))
2586                        (progn (skip-chars-forward "^|") (point))
2587                        prop value)))
2588
2589 (defun org-table-get-range (desc &optional tbeg col highlight corners-only)
2590   "Get a calc vector from a column, according to descriptor DESC.
2591 Optional arguments TBEG and COL can give the beginning of the table and
2592 the current column, to avoid unnecessary parsing.
2593
2594 HIGHLIGHT means just highlight the range.
2595
2596 When CORNERS-ONLY is set, only return the corners of the range as
2597 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2598 in the buffer and column1 and column2 are table column numbers."
2599   (if (not (equal (string-to-char desc) ?@))
2600       (setq desc (concat "@" desc)))
2601   (save-excursion
2602     (or tbeg (setq tbeg (org-table-begin)))
2603     (or col (setq col (org-table-current-column)))
2604     (let ((thisline (org-current-line))
2605           beg end c1 c2 r1 r2 rangep tmp)
2606       (unless (string-match org-table-range-regexp desc)
2607         (error "Invalid table range specifier `%s'" desc))
2608       (setq rangep (match-end 3)
2609             r1 (and (match-end 1) (match-string 1 desc))
2610             r2 (and (match-end 4) (match-string 4 desc))
2611             c1 (and (match-end 2) (substring (match-string 2 desc) 1))
2612             c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
2613
2614       (and c1 (setq c1 (+ (string-to-number c1)
2615                           (if (memq (string-to-char c1) '(?- ?+)) col 0))))
2616       (and c2 (setq c2 (+ (string-to-number c2)
2617                           (if (memq (string-to-char c2) '(?- ?+)) col 0))))
2618       (if (equal r1 "") (setq r1 nil))
2619       (if (equal r2 "") (setq r2 nil))
2620       (if r1 (setq r1 (org-table-get-descriptor-line r1)))
2621       (if r2 (setq r2 (org-table-get-descriptor-line r2)))
2622 ;      (setq r2 (or r2 r1) c2 (or c2 c1))
2623       (if (not r1) (setq r1 thisline))
2624       (if (not r2) (setq r2 thisline))
2625       (if (not c1) (setq c1 col))
2626       (if (not c2) (setq c2 col))
2627       (if (and (not corners-only)
2628                (or (not rangep) (and (= r1 r2) (= c1 c2))))
2629           ;; just one field
2630           (progn
2631             (org-goto-line r1)
2632             (while (not (looking-at org-table-dataline-regexp))
2633               (beginning-of-line 2))
2634             (prog1 (org-trim (org-table-get-field c1))
2635               (if highlight (org-table-highlight-rectangle (point) (point)))))
2636         ;; A range, return a vector
2637         ;; First sort the numbers to get a regular ractangle
2638         (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
2639         (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
2640         (if corners-only
2641             ;; Only return the corners of the range
2642             (list r1 c1 r2 c2)
2643           ;; Copy the range values into a list
2644           (org-goto-line r1)
2645           (while (not (looking-at org-table-dataline-regexp))
2646             (beginning-of-line 2))
2647           (org-table-goto-column c1)
2648           (setq beg (point))
2649           (org-goto-line r2)
2650           (while (not (looking-at org-table-dataline-regexp))
2651             (beginning-of-line 0))
2652           (org-table-goto-column c2)
2653           (setq end (point))
2654           (if highlight
2655               (org-table-highlight-rectangle
2656                beg (progn (skip-chars-forward "^|\n") (point))))
2657           ;; return string representation of calc vector
2658           (mapcar 'org-trim
2659                   (apply 'append (org-table-copy-region beg end))))))))
2660
2661 (defun org-table-get-descriptor-line (desc &optional cline bline table)
2662   "Analyze descriptor DESC and retrieve the corresponding line number.
2663 The cursor is currently in line CLINE, the table begins in line BLINE,
2664 and TABLE is a vector with line types."
2665   (if (string-match "^[0-9]+$" desc)
2666       (aref org-table-dlines (string-to-number desc))
2667     (setq cline (or cline (org-current-line))
2668           bline (or bline org-table-current-begin-line)
2669           table (or table org-table-current-line-types))
2670     (if (or
2671          (not (string-match "^\\(\\([-+]\\)?\\(I+\\)\\)?\\(\\([-+]\\)?\\([0-9]+\\)\\)?" desc))
2672          ;;                     1  2          3           4  5          6
2673          (and (not (match-end 3)) (not (match-end 6)))
2674          (and (match-end 3) (match-end 6) (not (match-end 5))))
2675         (error "Invalid row descriptor `%s'" desc))
2676     (let* ((hdir (and (match-end 2) (match-string 2 desc)))
2677            (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
2678            (odir (and (match-end 5) (match-string 5 desc)))
2679            (on (if (match-end 6) (string-to-number (match-string 6 desc))))
2680            (i (- cline bline))
2681            (rel (and (match-end 6)
2682                      (or (and (match-end 1) (not (match-end 3)))
2683                          (match-end 5)))))
2684       (if (and hn (not hdir))
2685           (progn
2686             (setq i 0 hdir "+")
2687             (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
2688       (if (and (not hn) on (not odir))
2689           (error "Should never happen");;(aref org-table-dlines on)
2690         (if (and hn (> hn 0))
2691             (setq i (org-table-find-row-type table i 'hline (equal hdir "-")
2692                                              nil hn cline desc)))
2693         (if on
2694             (setq i (org-table-find-row-type table i 'dline (equal odir "-")
2695                                              rel on cline desc)))
2696         (+ bline i)))))
2697
2698 (defun org-table-find-row-type (table i type backwards relative n cline desc)
2699   "FIXME: Needs more documentation."
2700   (let ((l (length table)))
2701     (while (> n 0)
2702       (while (and (setq i (+ i (if backwards -1 1)))
2703                   (>= i 0) (< i l)
2704                   (not (eq (aref table i) type))
2705                   (if (and relative (eq (aref table i) 'hline))
2706                       (cond
2707                        ((eq org-table-relative-ref-may-cross-hline t) t)
2708                        ((eq org-table-relative-ref-may-cross-hline 'error)
2709                         (error "Row descriptor %s used in line %d crosses hline" desc cline))
2710                        (t (setq i (- i (if backwards -1 1))
2711                                 n 1)
2712                           nil))
2713                     t)))
2714       (setq n (1- n)))
2715     (if (or (< i 0) (>= i l))
2716         (error "Row descriptor %s used in line %d leads outside table"
2717                desc cline)
2718       i)))
2719
2720 (defun org-table-rewrite-old-row-references (s)
2721   (if (string-match "&[-+0-9I]" s)
2722       (error "Formula contains old &row reference, please rewrite using @-syntax")
2723     s))
2724
2725 (defun org-table-make-reference (elements keep-empty numbers lispp)
2726   "Convert list ELEMENTS to something appropriate to insert into formula.
2727 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2728 NUMBERS indicates that everything should be converted to numbers.
2729 LISPP means to return something appropriate for a Lisp list."
2730   (if (stringp elements) ; just a single val
2731       (if lispp
2732           (if (eq lispp 'literal)
2733               elements
2734             (prin1-to-string (if numbers (string-to-number elements) elements)))
2735         (if (equal elements "") (setq elements "0"))
2736         (if numbers (setq elements (number-to-string (string-to-number elements))))
2737         (concat "(" elements ")"))
2738     (unless keep-empty
2739       (setq elements
2740             (delq nil
2741                   (mapcar (lambda (x) (if (string-match "\\S-" x) x nil))
2742                           elements))))
2743     (setq elements (or elements '("0")))
2744     (if lispp
2745         (mapconcat
2746          (lambda (x)
2747            (if (eq lispp 'literal)
2748                x
2749              (prin1-to-string (if numbers (string-to-number x) x))))
2750          elements " ")
2751       (concat "[" (mapconcat
2752                    (lambda (x)
2753                      (if numbers (number-to-string (string-to-number x)) x))
2754                    elements
2755                    ",") "]"))))
2756
2757 (defun org-table-recalculate (&optional all noalign)
2758   "Recalculate the current table line by applying all stored formulas.
2759 With prefix arg ALL, do this for all lines in the table.
2760 With the prefix argument ALL is `(16)' \
2761 \(a double \\[universal-prefix] \\[universal-prefix] prefix), or if
2762 it is the symbol `iterate', recompute the table until it no longer changes.
2763 If NOALIGN is not nil, do not re-align the table after the computations
2764 are done.  This is typically used internally to save time, if it is
2765 known that the table will be realigned a little later anyway."
2766   (interactive "P")
2767   (or (memq this-command org-recalc-commands)
2768       (setq org-recalc-commands (cons this-command org-recalc-commands)))
2769   (unless (org-at-table-p) (error "Not at a table"))
2770   (if (or (eq all 'iterate) (equal all '(16)))
2771       (org-table-iterate)
2772     (org-table-get-specials)
2773     (let* ((eqlist (sort (org-table-get-stored-formulas)
2774                          (lambda (a b) (string< (car a) (car b)))))
2775            (eqlist1 (copy-sequence eqlist))
2776            (inhibit-redisplay (not debug-on-error))
2777            (line-re org-table-dataline-regexp)
2778            (thisline (org-current-line))
2779            (thiscol (org-table-current-column))
2780            seen-fields lhs1
2781            beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name name1)
2782       ;; Insert constants in all formulas
2783       (setq eqlist
2784             (mapcar (lambda (x)
2785                       (when (string-match "\\`$[<>]" (car x))
2786                         (setq lhs1 (car x))
2787                         (setq x (cons (substring
2788                                        (org-table-formula-handle-first/last-rc
2789                                         (car x)) 1)
2790                                       (cdr x)))
2791                         (if (assoc (car x) eqlist1)
2792                             (error "\"%s=\" formula tries to overwrite existing formula for column %s"
2793                                    lhs1 (car x))))
2794                       (cons
2795                        (org-table-formula-handle-first/last-rc (car x))
2796                        (org-table-formula-substitute-names
2797                         (org-table-formula-handle-first/last-rc (cdr x)))))
2798                     eqlist))
2799       ;; Split the equation list
2800       (while (setq eq (pop eqlist))
2801         (if (<= (string-to-char (car eq)) ?9)
2802             (push eq eqlnum)
2803           (push eq eqlname)))
2804       (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
2805       ;; Expand ranges in lhs of formulas
2806       (setq eqlname (org-table-expand-lhs-ranges eqlname))
2807
2808       ;; Get the correct line range to process
2809       (if all
2810           (progn
2811             (setq end (move-marker (make-marker) (1+ (org-table-end))))
2812             (goto-char (setq beg (org-table-begin)))
2813             (if (re-search-forward org-table-calculate-mark-regexp end t)
2814                 ;; This is a table with marked lines, compute selected lines
2815                 (setq line-re org-table-recalculate-regexp)
2816               ;; Move forward to the first non-header line
2817               (if (and (re-search-forward org-table-dataline-regexp end t)
2818                        (re-search-forward org-table-hline-regexp end t)
2819                        (re-search-forward org-table-dataline-regexp end t))
2820                   (setq beg (match-beginning 0))
2821                 nil))) ;; just leave beg where it is
2822         (setq beg (point-at-bol)
2823               end (move-marker (make-marker) (1+ (point-at-eol)))))
2824       (goto-char beg)
2825       (and all (message "Re-applying formulas to full table..."))
2826
2827       ;; First find the named fields, and mark them untouchable.
2828       ;; Also check if several field/range formulas try to set the same field.
2829       (remove-text-properties beg end '(org-untouchable t))
2830       (while (setq eq (pop eqlname))
2831         (setq name (car eq)
2832               a (assoc name org-table-named-field-locations))
2833         (setq name1 name)
2834         (if a (setq name1 (format "@%d$%d" (org-table-line-to-dline (nth 1 a))
2835                                   (nth 2 a))))
2836         (when (member name1 seen-fields)
2837               (error "Several field/range formulas try to set %s" name1))
2838         (push name1 seen-fields)
2839
2840         (and (not a)
2841              (string-match "@\\([0-9]+\\)\\$\\([0-9]+\\)" name)
2842              (setq a (list name
2843                            (condition-case nil
2844                                (aref org-table-dlines
2845                                      (string-to-number (match-string 1 name)))
2846                              (error (error "Invalid row number in %s"
2847                                            name)))
2848                            (string-to-number (match-string 2 name)))))
2849         (when (and a (or all (equal (nth 1 a) thisline)))
2850           (message "Re-applying formula to field: %s" name)
2851           (org-goto-line (nth 1 a))
2852           (org-table-goto-column (nth 2 a))
2853           (push (append a (list (cdr eq))) eqlname1)
2854           (org-table-put-field-property :org-untouchable t)))
2855       (setq eqlname1 (nreverse eqlname1))
2856
2857       ;; Now evaluate the column formulas, but skip fields covered by
2858       ;; field formulas
2859       (goto-char beg)
2860       (while (re-search-forward line-re end t)
2861         (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
2862           ;; Unprotected line, recalculate
2863           (and all (message "Re-applying formulas to full table...(line %d)"
2864                             (setq cnt (1+ cnt))))
2865           (setq org-last-recalc-line (org-current-line))
2866           (setq eql eqlnum)
2867           (while (setq entry (pop eql))
2868             (org-goto-line org-last-recalc-line)
2869             (org-table-goto-column (string-to-number (car entry)) nil 'force)
2870             (unless (get-text-property (point) :org-untouchable)
2871               (org-table-eval-formula nil (cdr entry)
2872                                       'noalign 'nocst 'nostore 'noanalysis)))))
2873
2874       ;; Now evaluate the field formulas
2875       (while (setq eq (pop eqlname1))
2876         (message "Re-applying formula to field: %s" (car eq))
2877         (org-goto-line (nth 1 eq))
2878         (org-table-goto-column (nth 2 eq))
2879         (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
2880                                 'nostore 'noanalysis))
2881
2882       (org-goto-line thisline)
2883       (org-table-goto-column thiscol)
2884       (remove-text-properties (point-min) (point-max) '(org-untouchable t))
2885       (or noalign (and org-table-may-need-update (org-table-align))
2886           (and all (message "Re-applying formulas to %d lines...done" cnt)))
2887
2888       ;; back to initial position
2889       (message "Re-applying formulas...done")
2890       (org-goto-line thisline)
2891       (org-table-goto-column thiscol)
2892       (or noalign (and org-table-may-need-update (org-table-align))
2893           (and all (message "Re-applying formulas...done"))))))
2894
2895 (defun org-table-iterate (&optional arg)
2896   "Recalculate the table until it does not change anymore.
2897 The maximun number of iterations is 10, but you can chose a different value
2898 with the prefix ARG."
2899   (interactive "P")
2900   (let ((imax (if arg (prefix-numeric-value arg) 10))
2901         (i 0)
2902         (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
2903         thistbl)
2904     (catch 'exit
2905       (while (< i imax)
2906         (setq i (1+ i))
2907         (org-table-recalculate 'all)
2908         (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
2909         (if (not (string= lasttbl thistbl))
2910             (setq lasttbl thistbl)
2911           (if (> i 1)
2912               (message "Convergence after %d iterations" i)
2913             (message "Table was already stable"))
2914           (throw 'exit t)))
2915       (error "No convergence after %d iterations" i))))
2916
2917 (defun org-table-recalculate-buffer-tables ()
2918   "Recalculate all tables in the current buffer."
2919   (interactive)
2920   (save-excursion
2921     (save-restriction
2922       (widen)
2923       (org-table-map-tables (lambda () (org-table-recalculate t)) t))))
2924
2925 (defun org-table-iterate-buffer-tables ()
2926   "Iterate all tables in the buffer, to converge inter-table dependencies."
2927  (interactive)
2928  (let* ((imax 10)
2929         (checksum (md5 (buffer-string)))
2930
2931         c1
2932         (i imax))
2933    (save-excursion
2934      (save-restriction
2935        (widen)
2936        (catch 'exit
2937          (while (> i 0)
2938            (setq i (1- i))
2939            (org-table-map-tables (lambda () (org-table-recalculate t)) t)
2940            (if (equal checksum (setq c1 (md5 (buffer-string))))
2941                (progn
2942                  (message "Convergence after %d iterations" (- imax i))
2943                  (throw 'exit t))
2944              (setq checksum c1)))
2945          (error "No convergence after %d iterations" imax))))))
2946
2947 (defun org-table-expand-lhs-ranges (equations)
2948   "Expand list of formulas.
2949 If some of the RHS in the formulas are ranges or a row reference, expand
2950 them to individual field equations for each field."
2951   (let (e res lhs rhs range r1 r2 c1 c2)
2952     (while (setq e (pop equations))
2953       (setq lhs (car e) rhs (cdr e))
2954       (cond
2955        ((string-match "^@-?[-+I0-9]+\\$-?[0-9]+$" lhs)
2956         ;; This just refers to one fixed field
2957         (push e res))
2958        ((string-match "^[a-zA-Z][_a-zA-Z0-9]*$" lhs)
2959         ;; This just refers to one fixed named field
2960         (push e res))
2961        ((string-match "^@[0-9]+$" lhs)
2962         (loop for ic from 1 to org-table-current-ncol do
2963               (push (cons (format "%s$%d" lhs ic) rhs) res)
2964               (put-text-property 0 (length (caar res))
2965                                  :orig-eqn e (caar res))))
2966        (t
2967         (setq range (org-table-get-range lhs org-table-current-begin-pos
2968                                          1 nil 'corners))
2969         (setq r1 (nth 0 range) c1 (nth 1 range)
2970               r2 (nth 2 range) c2 (nth 3 range))
2971         (setq r1 (org-table-line-to-dline r1))
2972         (setq r2 (org-table-line-to-dline r2 'above))
2973         (loop for ir from r1 to r2 do
2974               (loop for ic from c1 to c2 do
2975                     (push (cons (format "@%d$%d" ir ic) rhs) res)
2976                     (put-text-property 0 (length (caar res))
2977                                        :orig-eqn e (caar res)))))))
2978     (nreverse res)))
2979
2980 (defun org-table-formula-handle-first/last-rc (s)
2981   "Replace @<, @>, $<, $> with first/last row/column of the table.
2982 So @< and $< will always be replaced with @1 and $1, respectively.
2983 The advantage of these special markers are that structure editing of
2984 the table will not change them, while @1 and $1 will be modified
2985 when a line/row is swaped out of that privileged position.  So for
2986 formulas that use a range of rows or columns, it may often be better
2987 to anchor the formula with \"I\" row markers, or to offset from the
2988 borders of the table using the @< @> $< $> makers."
2989   (let (n nmax len char)
2990     (while (string-match "\\([@$]\\)\\(<+\\|>+\\)" s)
2991       (setq nmax (if (equal (match-string 1 s) "@")
2992                      (1- (length org-table-dlines))
2993                    org-table-current-ncol)
2994             len (- (match-end 2) (match-beginning 2))
2995             char (string-to-char (match-string 2 s))
2996             n (if (= char ?<)
2997                   len
2998                 (- nmax len -1)))
2999       (if (or (< n 1) (> n nmax))
3000           (error "Reference \"%s\" in expression \"%s\" points outside table"
3001                  (match-string 0 s) s))
3002       (setq s (replace-match (format "%s%d" (match-string 1 s) n) t t s))))
3003   s)
3004
3005 (defun org-table-formula-substitute-names (f)
3006   "Replace $const with values in string F."
3007   (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
3008     ;; First, check for column names
3009     (while (setq start (string-match org-table-column-name-regexp f start))
3010       (setq start (1+ start))
3011       (setq a (assoc (match-string 1 f) org-table-column-names))
3012       (setq f (replace-match (concat "$" (cdr a)) t t f)))
3013     ;; Parameters and constants
3014     (setq start 0)
3015     (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3016       (if (match-end 2)
3017           (setq start (match-end 2))
3018         (setq start (1+ start))
3019         (if (setq a (save-match-data
3020                       (org-table-get-constant (match-string 1 f))))
3021             (setq f (replace-match
3022                      (concat (if pp "(") a (if pp ")")) t t f)))))
3023     (if org-table-formula-debug
3024         (put-text-property 0 (length f) :orig-formula f1 f))
3025     f))
3026
3027 (defun org-table-get-constant (const)
3028   "Find the value for a parameter or constant in a formula.
3029 Parameters get priority."
3030   (or (cdr (assoc const org-table-local-parameters))
3031       (cdr (assoc const org-table-formula-constants-local))
3032       (cdr (assoc const org-table-formula-constants))
3033       (and (fboundp 'constants-get) (constants-get const))
3034       (and (string= (substring const 0 (min 5 (length const))) "PROP_")
3035            (org-entry-get nil (substring const 5) 'inherit))
3036       "#UNDEFINED_NAME"))
3037
3038 (defvar org-table-fedit-map
3039   (let ((map (make-sparse-keymap)))
3040     (org-defkey map "\C-x\C-s"      'org-table-fedit-finish)
3041     (org-defkey map "\C-c\C-s"      'org-table-fedit-finish)
3042     (org-defkey map "\C-c\C-c"      'org-table-fedit-finish)
3043     (org-defkey map "\C-c'"         'org-table-fedit-finish)
3044     (org-defkey map "\C-c\C-q"      'org-table-fedit-abort)
3045     (org-defkey map "\C-c?"         'org-table-show-reference)
3046     (org-defkey map [(meta shift up)]    'org-table-fedit-line-up)
3047     (org-defkey map [(meta shift down)]  'org-table-fedit-line-down)
3048     (org-defkey map [(shift up)]    'org-table-fedit-ref-up)
3049     (org-defkey map [(shift down)]  'org-table-fedit-ref-down)
3050     (org-defkey map [(shift left)]  'org-table-fedit-ref-left)
3051     (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
3052     (org-defkey map [(meta up)]     'org-table-fedit-scroll-down)
3053     (org-defkey map [(meta down)]   'org-table-fedit-scroll)
3054     (org-defkey map [(meta tab)]    'lisp-complete-symbol)
3055     (org-defkey map "\M-\C-i"       'lisp-complete-symbol)
3056     (org-defkey map [(tab)]         'org-table-fedit-lisp-indent)
3057     (org-defkey map "\C-i"          'org-table-fedit-lisp-indent)
3058     (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
3059     (org-defkey map "\C-c}"    'org-table-fedit-toggle-coordinates)
3060     map))
3061
3062 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
3063   '("Edit-Formulas"
3064     ["Finish and Install" org-table-fedit-finish t]
3065     ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
3066     ["Abort" org-table-fedit-abort t]
3067     "--"
3068     ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
3069     ["Complete Lisp Symbol" lisp-complete-symbol t]
3070     "--"
3071     "Shift Reference at Point"
3072     ["Up" org-table-fedit-ref-up t]
3073     ["Down" org-table-fedit-ref-down t]
3074     ["Left" org-table-fedit-ref-left t]
3075     ["Right" org-table-fedit-ref-right t]
3076     "-"
3077     "Change Test Row for Column Formulas"
3078     ["Up" org-table-fedit-line-up t]
3079     ["Down" org-table-fedit-line-down t]
3080     "--"
3081     ["Scroll Table Window" org-table-fedit-scroll t]
3082     ["Scroll Table Window down" org-table-fedit-scroll-down t]
3083     ["Show Table Grid" org-table-fedit-toggle-coordinates
3084      :style toggle :selected (with-current-buffer (marker-buffer org-pos)
3085                                org-table-overlay-coordinates)]
3086     "--"
3087     ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
3088      :style toggle :selected org-table-buffer-is-an]))
3089
3090 (defvar org-pos)
3091
3092 (defun org-table-edit-formulas ()
3093   "Edit the formulas of the current table in a separate buffer."
3094   (interactive)
3095   (when (save-excursion (beginning-of-line 1) (looking-at "[ \t]*#\\+TBLFM"))
3096     (beginning-of-line 0))
3097   (unless (org-at-table-p) (error "Not at a table"))
3098   (org-table-get-specials)
3099   (let ((key (org-table-current-field-formula 'key 'noerror))
3100         (eql (sort (org-table-get-stored-formulas 'noerror)
3101                    'org-table-formula-less-p))
3102         (pos (move-marker (make-marker) (point)))
3103         (startline 1)
3104         (wc (current-window-configuration))
3105         (sel-win (selected-window))
3106         (titles '((column . "# Column Formulas\n")
3107                   (field . "# Field and Range Formulas\n")
3108                   (named . "# Named Field Formulas\n")))
3109         entry s type title)
3110     (org-switch-to-buffer-other-window "*Edit Formulas*")
3111     (erase-buffer)
3112     ;; Keep global-font-lock-mode from turning on font-lock-mode
3113     (let ((font-lock-global-modes '(not fundamental-mode)))
3114       (fundamental-mode))
3115     (org-set-local 'font-lock-global-modes (list 'not major-mode))
3116     (org-set-local 'org-pos pos)
3117     (org-set-local 'org-window-configuration wc)
3118     (org-set-local 'org-selected-window sel-win)
3119     (use-local-map org-table-fedit-map)
3120     (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
3121     (easy-menu-add org-table-fedit-menu)
3122     (setq startline (org-current-line))
3123     (while (setq entry (pop eql))
3124       (setq type (cond
3125                   ((string-match "\\`$[<>]" (car entry)) 'column)
3126                   ((equal (string-to-char (car entry)) ?@) 'field)
3127                   ((string-match "^[0-9]" (car entry)) 'column)
3128                   (t 'named)))
3129       (when (setq title (assq type titles))
3130         (or (bobp) (insert "\n"))
3131         (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
3132         (setq titles (remove title titles)))
3133       (if (equal key (car entry)) (setq startline (org-current-line)))
3134       (setq s (concat (if (member (string-to-char (car entry)) '(?@ ?$)) "" "$")
3135                       (car entry) " = " (cdr entry) "\n"))
3136       (remove-text-properties 0 (length s) '(face nil) s)
3137       (insert s))
3138     (if (eq org-table-use-standard-references t)
3139         (org-table-fedit-toggle-ref-type))
3140     (org-goto-line startline)
3141     (message "Edit formulas, finish with `C-c C-c' or `C-c ' '.  See menu for more commands.")))
3142
3143 (defun org-table-fedit-post-command ()
3144   (when (not (memq this-command '(lisp-complete-symbol)))
3145     (let ((win (selected-window)))
3146       (save-excursion
3147         (condition-case nil
3148             (org-table-show-reference)
3149           (error nil))
3150         (select-window win)))))
3151
3152 (defun org-table-formula-to-user (s)
3153   "Convert a formula from internal to user representation."
3154   (if (eq org-table-use-standard-references t)
3155       (org-table-convert-refs-to-an s)
3156     s))
3157
3158 (defun org-table-formula-from-user (s)
3159   "Convert a formula from user to internal representation."
3160   (if org-table-use-standard-references
3161       (org-table-convert-refs-to-rc s)
3162     s))
3163
3164 (defun org-table-convert-refs-to-rc (s)
3165   "Convert spreadsheet references from A7 to @7$28.
3166 Works for single references, but also for entire formulas and even the
3167 full TBLFM line."
3168   (let ((start 0))
3169     (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3170       (cond
3171        ((match-end 3)
3172         ;; format match, just advance
3173         (setq start (match-end 0)))
3174        ((and (> (match-beginning 0) 0)
3175              (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
3176              (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
3177         ;; 3.e5 or something like this.
3178         (setq start (match-end 0)))
3179        ((or (> (- (match-end 1) (match-beginning 1)) 2)
3180             ;; (member (match-string 1 s)
3181             ;;      '("arctan" "exp" "expm" "lnp" "log" "stir"))
3182             )
3183         ;; function name, just advance
3184         (setq start (match-end 0)))
3185        (t
3186         (setq start (match-beginning 0)
3187               s (replace-match
3188                  (if (equal (match-string 2 s) "&")
3189                      (format "$%d" (org-letters-to-number (match-string 1 s)))
3190                    (format "@%d$%d"
3191                            (string-to-number (match-string 2 s))
3192                            (org-letters-to-number (match-string 1 s))))
3193                  t t s)))))
3194     s))
3195
3196 (defun org-table-convert-refs-to-an (s)
3197   "Convert spreadsheet references from to @7$28 to AB7.
3198 Works for single references, but also for entire formulas and even the
3199 full TBLFM line."
3200   (while (string-match "@\\([0-9]+\\)\\$\\([0-9]+\\)" s)
3201     (setq s (replace-match
3202              (format "%s%d"
3203                      (org-number-to-letters
3204                       (string-to-number (match-string 2 s)))
3205                      (string-to-number (match-string 1 s)))
3206              t t s)))
3207   (while (string-match "\\(^\\|[^0-9a-zA-Z]\\)\\$\\([0-9]+\\)" s)
3208     (setq s (replace-match (concat "\\1"
3209                                    (org-number-to-letters
3210                                     (string-to-number (match-string 2 s))) "&")
3211                            t nil s)))
3212   s)
3213
3214 (defun org-letters-to-number (s)
3215   "Convert a base 26 number represented by letters into an integer.
3216 For example:  AB -> 28."
3217   (let ((n 0))
3218     (setq s (upcase s))
3219     (while (> (length s) 0)
3220           (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
3221                 s (substring s 1)))
3222     n))
3223
3224 (defun org-number-to-letters (n)
3225   "Convert an integer into a base 26 number represented by letters.
3226 For example:  28 -> AB."
3227   (let ((s ""))
3228     (while (> n 0)
3229       (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
3230             n (/ (1- n) 26)))
3231     s))
3232
3233 (defun org-table-time-string-to-seconds (s)
3234   "Convert a time string into numerical duration in seconds.
3235 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3236 If S is a string representing a number, keep this number."
3237   (let (hour minus min sec res)
3238     (cond
3239      ((and (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)" s))
3240       (setq minus (< 0 (length (match-string 1 s)))
3241             hour (string-to-number (match-string 2 s))
3242             min (string-to-number (match-string 3 s))
3243             sec (string-to-number (match-string 4 s)))
3244       (if minus
3245           (setq res (- (+ (* hour 3600) (* min 60) sec)))
3246         (setq res (+ (* hour 3600) (* min 60) sec))))
3247      ((and (not (string-match org-ts-regexp-both s))
3248            (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\)" s))
3249       (setq minus (< 0 (length (match-string 1 s)))
3250             hour (string-to-number (match-string 2 s))
3251             min (string-to-number (match-string 3 s)))
3252       (if minus
3253           (setq res (- (+ (* hour 3600) (* min 60))))
3254         (setq res (+ (* hour 3600) (* min 60)))))
3255      (t (setq res (string-to-number s))))
3256     (number-to-string res)))
3257
3258 (defun org-table-time-seconds-to-string (secs &optional output-format)
3259   "Convert a number of seconds to a time string.
3260 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3261 minutes or seconds."
3262   (cond ((eq output-format 'days)
3263          (format "%.3f" (/ (float secs) 86400)))
3264         ((eq output-format 'hours)
3265          (format "%.2f" (/ (float secs) 3600)))
3266         ((eq output-format 'minutes)
3267          (format "%.1f" (/ (float secs) 60)))
3268         ((eq output-format 'seconds)
3269          (format "%d" secs))
3270         (t (org-format-seconds "%.2h:%.2m:%.2s" secs))))
3271
3272 (defun org-table-fedit-convert-buffer (function)
3273   "Convert all references in this buffer, using FUNCTION."
3274   (let ((line (org-current-line)))
3275     (goto-char (point-min))
3276     (while (not (eobp))
3277       (insert (funcall function (buffer-substring (point) (point-at-eol))))
3278       (delete-region (point) (point-at-eol))
3279       (or (eobp) (forward-char 1)))
3280     (org-goto-line line)))
3281
3282 (defun org-table-fedit-toggle-ref-type ()
3283   "Convert all references in the buffer from B3 to @3$2 and back."
3284   (interactive)
3285   (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
3286   (org-table-fedit-convert-buffer
3287    (if org-table-buffer-is-an
3288        'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
3289   (message "Reference type switched to %s"
3290            (if org-table-buffer-is-an "A1 etc" "@row$column")))
3291
3292 (defun org-table-fedit-ref-up ()
3293   "Shift the reference at point one row/hline up."
3294   (interactive)
3295   (org-table-fedit-shift-reference 'up))
3296 (defun org-table-fedit-ref-down ()
3297   "Shift the reference at point one row/hline down."
3298   (interactive)
3299   (org-table-fedit-shift-reference 'down))
3300 (defun org-table-fedit-ref-left ()
3301   "Shift the reference at point one field to the left."
3302   (interactive)
3303   (org-table-fedit-shift-reference 'left))
3304 (defun org-table-fedit-ref-right ()
3305   "Shift the reference at point one field to the right."
3306   (interactive)
3307   (org-table-fedit-shift-reference 'right))
3308
3309 (defun org-table-fedit-shift-reference (dir)
3310   (cond
3311    ((org-at-regexp-p "\\(\\<[a-zA-Z]\\)&")
3312     (if (memq dir '(left right))
3313         (org-rematch-and-replace 1 (eq dir 'left))
3314       (error "Cannot shift reference in this direction")))
3315    ((org-at-regexp-p "\\(\\<[a-zA-Z]\\{1,2\\}\\)\\([0-9]+\\)")
3316     ;; A B3-like reference
3317     (if (memq dir '(up down))
3318         (org-rematch-and-replace 2 (eq dir 'up))
3319       (org-rematch-and-replace 1 (eq dir 'left))))
3320    ((org-at-regexp-p
3321      "\\(@\\|\\.\\.\\)\\([-+]?\\(I+\\>\\|[0-9]+\\)\\)\\(\\$\\([-+]?[0-9]+\\)\\)?")
3322     ;; An internal reference
3323     (if (memq dir '(up down))
3324         (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
3325       (org-rematch-and-replace 5 (eq dir 'left))))))
3326
3327 (defun org-rematch-and-replace (n &optional decr hline)
3328   "Re-match the group N, and replace it with the shifted reference."
3329   (or (match-end n) (error "Cannot shift reference in this direction"))
3330   (goto-char (match-beginning n))
3331   (and (looking-at (regexp-quote (match-string n)))
3332        (replace-match (org-table-shift-refpart (match-string 0) decr hline)
3333                       t t)))
3334
3335 (defun org-table-shift-refpart (ref &optional decr hline)
3336   "Shift a reference part REF.
3337 If DECR is set, decrease the references row/column, else increase.
3338 If HLINE is set, this may be a hline reference, it certainly is not
3339 a translation reference."
3340   (save-match-data
3341     (let* ((sign (string-match "^[-+]" ref)) n)
3342
3343       (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
3344       (cond
3345        ((and hline (string-match "^I+" ref))
3346         (setq n (string-to-number (concat sign (number-to-string (length ref)))))
3347         (setq n (+ n (if decr -1 1)))
3348         (if (= n 0) (setq n (+ n (if decr -1 1))))
3349         (if sign
3350             (setq sign (if (< n 0) "-" "+") n (abs n))
3351           (setq n (max 1 n)))
3352         (concat sign (make-string n ?I)))
3353
3354        ((string-match "^[0-9]+" ref)
3355         (setq n (string-to-number (concat sign ref)))
3356         (setq n (+ n (if decr -1 1)))
3357         (if sign
3358             (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
3359           (number-to-string (max 1 n))))
3360
3361        ((string-match "^[a-zA-Z]+" ref)
3362         (org-number-to-letters
3363          (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
3364
3365        (t (error "Cannot shift reference"))))))
3366
3367 (defun org-table-fedit-toggle-coordinates ()
3368   "Toggle the display of coordinates in the referenced table."
3369   (interactive)
3370   (let ((pos (marker-position org-pos)))
3371     (with-current-buffer (marker-buffer org-pos)
3372       (save-excursion
3373         (goto-char pos)
3374         (org-table-toggle-coordinate-overlays)))))
3375
3376 (defun org-table-fedit-finish (&optional arg)
3377   "Parse the buffer for formula definitions and install them.
3378 With prefix ARG, apply the new formulas to the table."
3379   (interactive "P")
3380   (org-table-remove-rectangle-highlight)
3381   (if org-table-use-standard-references
3382       (progn
3383         (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
3384         (setq org-table-buffer-is-an nil)))
3385   (let ((pos org-pos) (sel-win org-selected-window) eql var form)
3386     (goto-char (point-min))
3387     (while (re-search-forward
3388             "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3389             nil t)
3390       (setq var (if (match-end 2) (match-string 2) (match-string 1))
3391             form (match-string 3))
3392       (setq form (org-trim form))
3393       (when (not (equal form ""))
3394         (while (string-match "[ \t]*\n[ \t]*" form)
3395           (setq form (replace-match " " t t form)))
3396         (when (assoc var eql)
3397           (error "Double formulas for %s" var))
3398         (push (cons var form) eql)))
3399     (setq org-pos nil)
3400     (set-window-configuration org-window-configuration)
3401     (select-window sel-win)
3402     (goto-char pos)
3403     (unless (org-at-table-p)
3404       (error "Lost table position - cannot install formulas"))
3405     (org-table-store-formulas eql)
3406     (move-marker pos nil)
3407     (kill-buffer "*Edit Formulas*")
3408     (if arg
3409         (org-table-recalculate 'all)
3410       (message "New formulas installed - press C-u C-c C-c to apply."))))
3411
3412 (defun org-table-fedit-abort ()
3413   "Abort editing formulas, without installing the changes."
3414   (interactive)
3415   (org-table-remove-rectangle-highlight)
3416   (let ((pos org-pos) (sel-win org-selected-window))
3417     (set-window-configuration org-window-configuration)
3418     (select-window sel-win)
3419     (goto-char pos)
3420     (move-marker pos nil)
3421     (message "Formula editing aborted without installing changes")))
3422
3423 (defun org-table-fedit-lisp-indent ()
3424   "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3425   (interactive)
3426   (let ((pos (point)) beg end ind)
3427     (beginning-of-line 1)
3428     (cond
3429      ((looking-at "[ \t]")
3430       (goto-char pos)
3431       (call-interactively 'lisp-indent-line))
3432      ((looking-at "[$&@0-9a-zA-Z]+ *= *[^ \t\n']") (goto-char pos))
3433      ((not (fboundp 'pp-buffer))
3434       (error "Cannot pretty-print.  Command `pp-buffer' is not available"))
3435      ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
3436       (goto-char (- (match-end 0) 2))
3437       (setq beg (point))
3438       (setq ind (make-string (current-column) ?\ ))
3439       (condition-case nil (forward-sexp 1)
3440         (error
3441          (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
3442       (setq end (point))
3443       (save-restriction
3444         (narrow-to-region beg end)
3445         (if (eq last-command this-command)
3446             (progn
3447               (goto-char (point-min))
3448               (setq this-command nil)
3449               (while (re-search-forward "[ \t]*\n[ \t]*" nil t)
3450                 (replace-match " ")))
3451           (pp-buffer)
3452           (untabify (point-min) (point-max))
3453           (goto-char (1+ (point-min)))
3454           (while (re-search-forward "^." nil t)
3455             (beginning-of-line 1)
3456             (insert ind))
3457           (goto-char (point-max))
3458           (backward-delete-char 1)))
3459       (goto-char beg))
3460      (t nil))))
3461
3462 (defvar org-show-positions nil)
3463
3464 (defun org-table-show-reference (&optional local)
3465   "Show the location/value of the $ expression at point."
3466   (interactive)
3467   (org-table-remove-rectangle-highlight)
3468   (catch 'exit
3469     (let ((pos (if local (point) org-pos))
3470           (face2 'highlight)
3471           (org-inhibit-highlight-removal t)
3472           (win (selected-window))
3473           (org-show-positions nil)
3474           var name e what match dest)
3475       (if local (org-table-get-specials))
3476       (setq what (cond
3477                   ((org-at-regexp-p "^@[0-9]+[ \t=]")
3478                    (setq match (concat (substring (match-string 0) 0 -1)
3479                                        "$1.."
3480                                        (substring (match-string 0) 0 -1)
3481                                        "$100"))
3482                    'range)
3483                   ((or (org-at-regexp-p org-table-range-regexp2)
3484                        (org-at-regexp-p org-table-translate-regexp)
3485                        (org-at-regexp-p org-table-range-regexp))
3486                    (setq match
3487                          (save-match-data
3488                            (org-table-convert-refs-to-rc (match-string 0))))
3489                    'range)
3490                   ((org-at-regexp-p "\\$[a-zA-Z][a-zA-Z0-9]*") 'name)
3491                   ((org-at-regexp-p "\\$[0-9]+") 'column)
3492                   ((not local) nil)
3493                   (t (error "No reference at point")))
3494             match (and what (or match (match-string 0))))
3495       (when (and  match (not (equal (match-beginning 0) (point-at-bol))))
3496         (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
3497                                          'secondary-selection))
3498       (org-add-hook 'before-change-functions
3499                     'org-table-remove-rectangle-highlight)
3500       (if (eq what 'name) (setq var (substring match 1)))
3501       (when (eq what 'range)
3502         (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
3503         (setq match (org-table-formula-substitute-names match)))
3504       (unless local
3505         (save-excursion
3506           (end-of-line 1)
3507           (re-search-backward "^\\S-" nil t)
3508           (beginning-of-line 1)
3509           (when (looking-at "\\(\\$[0-9a-zA-Z]+\\|@[0-9]+\\$[0-9]+\\|[a-zA-Z]+\\([0-9]+\\|&\\)\\) *=")
3510             (setq dest
3511                   (save-match-data
3512                     (org-table-convert-refs-to-rc (match-string 1))))
3513             (org-table-add-rectangle-overlay
3514              (match-beginning 1) (match-end 1) face2))))
3515       (if (and (markerp pos) (marker-buffer pos))
3516           (if (get-buffer-window (marker-buffer pos))
3517               (select-window (get-buffer-window (marker-buffer pos)))
3518             (org-switch-to-buffer-other-window (get-buffer-window
3519                                             (marker-buffer pos)))))
3520       (goto-char pos)
3521       (org-table-force-dataline)
3522       (when dest
3523         (setq name (substring dest 1))
3524         (cond
3525          ((string-match "^\\$[a-zA-Z][a-zA-Z0-9]*" dest)
3526           (setq e (assoc name org-table-named-field-locations))
3527           (org-goto-line (nth 1 e))
3528           (org-table-goto-column (nth 2 e)))
3529          ((string-match "^@\\([0-9]+\\)\\$\\([0-9]+\\)" dest)
3530           (let ((l (string-to-number (match-string 1 dest)))
3531                 (c (string-to-number (match-string 2 dest))))
3532             (org-goto-line (aref org-table-dlines l))
3533             (org-table-goto-column c)))
3534          (t (org-table-goto-column (string-to-number name))))
3535         (move-marker pos (point))
3536         (org-table-highlight-rectangle nil nil face2))
3537       (cond
3538        ((equal dest match))
3539        ((not match))
3540        ((eq what 'range)
3541         (condition-case nil
3542             (save-excursion
3543               (org-table-get-range match nil nil 'highlight))
3544           (error nil)))
3545        ((setq e (assoc var org-table-named-field-locations))
3546         (org-goto-line (nth 1 e))
3547         (org-table-goto-column (nth 2 e))
3548         (org-table-highlight-rectangle (point) (point))
3549         (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
3550        ((setq e (assoc var org-table-column-names))
3551         (org-table-goto-column (string-to-number (cdr e)))
3552         (org-table-highlight-rectangle (point) (point))
3553         (goto-char (org-table-begin))
3554         (if (re-search-forward (concat "^[ \t]*| *! *.*?| *\\(" var "\\) *|")
3555                                (org-table-end) t)
3556             (progn
3557               (goto-char (match-beginning 1))
3558               (org-table-highlight-rectangle)
3559               (message "Named column (column %s)" (cdr e)))
3560           (error "Column name not found")))
3561        ((eq what 'column)
3562         ;; column number
3563         (org-table-goto-column (string-to-number (substring match 1)))
3564         (org-table-highlight-rectangle (point) (point))
3565         (message "Column %s" (substring match 1)))
3566        ((setq e (assoc var org-table-local-parameters))
3567         (goto-char (org-table-begin))
3568         (if (re-search-forward (concat "^[ \t]*| *\\$ *.*?| *\\(" var "=\\)") nil t)
3569             (progn
3570               (goto-char (match-beginning 1))
3571               (org-table-highlight-rectangle)
3572               (message "Local parameter."))
3573           (error "Parameter not found")))
3574        (t
3575         (cond
3576          ((not var) (error "No reference at point"))
3577          ((setq e (assoc var org-table-formula-constants-local))
3578           (message "Local Constant: $%s=%s in #+CONSTANTS line."
3579                    var (cdr e)))
3580          ((setq e (assoc var org-table-formula-constants))
3581           (message "Constant: $%s=%s in `org-table-formula-constants'."
3582                    var (cdr e)))
3583          ((setq e (and (fboundp 'constants-get) (constants-get var)))
3584           (message "Constant: $%s=%s, from `constants.el'%s."
3585                    var e (format " (%s units)" constants-unit-system)))
3586          (t (error "Undefined name $%s" var)))))
3587       (goto-char pos)
3588       (when (and org-show-positions
3589                  (not (memq this-command '(org-table-fedit-scroll
3590                                            org-table-fedit-scroll-down))))
3591         (push pos org-show-positions)
3592         (push org-table-current-begin-pos org-show-positions)
3593         (let ((min (apply 'min org-show-positions))
3594               (max (apply 'max org-show-positions)))
3595           (goto-char min) (recenter 0)
3596           (goto-char max)
3597           (or (pos-visible-in-window-p max) (recenter -1))))
3598       (select-window win))))
3599
3600 (defun org-table-force-dataline ()
3601   "Make sure the cursor is in a dataline in a table."
3602   (unless (save-excursion
3603             (beginning-of-line 1)
3604             (looking-at org-table-dataline-regexp))
3605     (let* ((re org-table-dataline-regexp)
3606            (p1 (save-excursion (re-search-forward re nil 'move)))
3607            (p2 (save-excursion (re-search-backward re nil 'move))))
3608       (cond ((and p1 p2)
3609              (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
3610                             p1 p2)))
3611             ((or p1 p2) (goto-char (or p1 p2)))
3612             (t (error "No table dataline around here"))))))
3613
3614 (defun org-table-fedit-line-up ()
3615   "Move cursor one line up in the window showing the table."
3616   (interactive)
3617   (org-table-fedit-move 'previous-line))
3618
3619 (defun org-table-fedit-line-down ()
3620   "Move cursor one line down in the window showing the table."
3621   (interactive)
3622   (org-table-fedit-move 'next-line))
3623
3624 (defun org-table-fedit-move (command)
3625   "Move the cursor in the window showing the table.
3626 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3627   (let ((org-table-allow-automatic-line-recalculation nil)
3628         (pos org-pos) (win (selected-window)) p)
3629     (select-window (get-buffer-window (marker-buffer org-pos)))
3630     (setq p (point))
3631     (call-interactively command)
3632     (while (and (org-at-table-p)
3633                 (org-at-table-hline-p))
3634       (call-interactively command))
3635     (or (org-at-table-p) (goto-char p))
3636     (move-marker pos (point))
3637     (select-window win)))
3638
3639 (defun org-table-fedit-scroll (N)
3640   (interactive "p")
3641   (let ((other-window-scroll-buffer (marker-buffer org-pos)))
3642     (scroll-other-window N)))
3643
3644 (defun org-table-fedit-scroll-down (N)
3645   (interactive "p")
3646   (org-table-fedit-scroll (- N)))
3647
3648 (defvar org-table-rectangle-overlays nil)
3649
3650 (defun org-table-add-rectangle-overlay (beg end &optional face)
3651   "Add a new overlay."
3652   (let ((ov (make-overlay beg end)))
3653     (overlay-put ov 'face (or face 'secondary-selection))
3654     (push ov org-table-rectangle-overlays)))
3655
3656 (defun org-table-highlight-rectangle (&optional beg end face)
3657   "Highlight rectangular region in a table."
3658   (setq beg (or beg (point)) end (or end (point)))
3659   (let ((b (min beg end))
3660         (e (max beg end))
3661         l1 c1 l2 c2 tmp)
3662     (and (boundp 'org-show-positions)
3663          (setq org-show-positions (cons b (cons e org-show-positions))))
3664     (goto-char (min beg end))
3665     (setq l1 (org-current-line)
3666           c1 (org-table-current-column))
3667     (goto-char (max beg end))
3668     (setq l2 (org-current-line)
3669           c2 (org-table-current-column))
3670     (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
3671     (org-goto-line l1)
3672     (beginning-of-line 1)
3673     (loop for line from l1 to l2 do
3674           (when (looking-at org-table-dataline-regexp)
3675             (org-table-goto-column c1)
3676             (skip-chars-backward "^|\n") (setq beg (point))
3677             (org-table-goto-column c2)
3678             (skip-chars-forward "^|\n")  (setq end (point))
3679             (org-table-add-rectangle-overlay beg end face))
3680           (beginning-of-line 2))
3681     (goto-char b))
3682   (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
3683
3684 (defun org-table-remove-rectangle-highlight (&rest ignore)
3685   "Remove the rectangle overlays."
3686   (unless org-inhibit-highlight-removal
3687     (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
3688     (mapc 'delete-overlay org-table-rectangle-overlays)
3689     (setq org-table-rectangle-overlays nil)))
3690
3691 (defvar org-table-coordinate-overlays nil
3692   "Collects the coordinate grid overlays, so that they can be removed.")
3693 (make-variable-buffer-local 'org-table-coordinate-overlays)
3694
3695 (defun org-table-overlay-coordinates ()
3696   "Add overlays to the table at point, to show row/column coordinates."
3697   (interactive)
3698   (mapc 'delete-overlay org-table-coordinate-overlays)
3699   (setq org-table-coordinate-overlays nil)
3700   (save-excursion
3701     (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
3702       (goto-char (org-table-begin))
3703       (while (org-at-table-p)
3704         (setq eol (point-at-eol))
3705         (setq ov (make-overlay (point-at-bol) (1+ (point-at-bol))))
3706         (push ov org-table-coordinate-overlays)
3707         (setq hline (looking-at org-table-hline-regexp))
3708         (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
3709                     (format "%4d" (setq id (1+ id)))))
3710         (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
3711         (when hline
3712           (setq ic 0)
3713           (while (re-search-forward "[+|]\\(-+\\)" eol t)
3714             (setq beg (1+ (match-beginning 0))
3715                   ic (1+ ic)
3716                   s1 (concat "$" (int-to-string ic))
3717                   s2 (org-number-to-letters ic)
3718                   str (if (eq org-table-use-standard-references t) s2 s1))
3719             (setq ov (make-overlay beg (+ beg (length str))))
3720             (push ov org-table-coordinate-overlays)
3721             (org-overlay-display ov str 'org-special-keyword 'evaporate)))
3722         (beginning-of-line 2)))))
3723
3724 (defun org-table-toggle-coordinate-overlays ()
3725   "Toggle the display of Row/Column numbers in tables."
3726   (interactive)
3727   (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
3728   (message "Row/Column number display turned %s"
3729            (if org-table-overlay-coordinates "on" "off"))
3730   (if (and (org-at-table-p) org-table-overlay-coordinates)
3731       (org-table-align))
3732   (unless org-table-overlay-coordinates
3733     (mapc 'delete-overlay org-table-coordinate-overlays)
3734     (setq org-table-coordinate-overlays nil)))
3735
3736 (defun org-table-toggle-formula-debugger ()
3737   "Toggle the formula debugger in tables."
3738   (interactive)
3739   (setq org-table-formula-debug (not org-table-formula-debug))
3740   (message "Formula debugging has been turned %s"
3741            (if org-table-formula-debug "on" "off")))
3742
3743 ;;; The orgtbl minor mode
3744
3745 ;; Define a minor mode which can be used in other modes in order to
3746 ;; integrate the org-mode table editor.
3747
3748 ;; This is really a hack, because the org-mode table editor uses several
3749 ;; keys which normally belong to the major mode, for example the TAB and
3750 ;; RET keys.  Here is how it works: The minor mode defines all the keys
3751 ;; necessary to operate the table editor, but wraps the commands into a
3752 ;; function which tests if the cursor is currently inside a table.  If that
3753 ;; is the case, the table editor command is executed.  However, when any of
3754 ;; those keys is used outside a table, the function uses `key-binding' to
3755 ;; look up if the key has an associated command in another currently active
3756 ;; keymap (minor modes, major mode, global), and executes that command.
3757 ;; There might be problems if any of the keys used by the table editor is
3758 ;; otherwise used as a prefix key.
3759
3760 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3761 ;; likewise the binding for RET can be return or \C-m.  Orgtbl-mode
3762 ;; addresses this by checking explicitly for both bindings.
3763
3764 ;; The optimized version (see variable `orgtbl-optimized') takes over
3765 ;; all keys which are bound to `self-insert-command' in the *global map*.
3766 ;; Some modes bind other commands to simple characters, for example
3767 ;; AUCTeX binds the double quote to `Tex-insert-quote'.  With orgtbl-mode
3768 ;; active, this binding is ignored inside tables and replaced with a
3769 ;; modified self-insert.
3770
3771
3772 (defvar orgtbl-mode-map (make-keymap)
3773   "Keymap for `orgtbl-mode'.")
3774
3775 ;;;###autoload
3776 (defun turn-on-orgtbl ()
3777   "Unconditionally turn on `orgtbl-mode'."
3778   (orgtbl-mode 1))
3779
3780 (defvar org-old-auto-fill-inhi