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