Merge branch 'maint'
[org-mode/org-tableheadings.git] / lisp / org-table.el
blob4bd1c89c0c1eb9e08d8a71b110ac00604d8b8787
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2016 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
37 (require 'cl-lib)
38 (require 'org)
40 (declare-function org-element-at-point "org-element" ())
41 (declare-function org-element-contents "org-element" (element))
42 (declare-function org-element-extract-element "org-element" (element))
43 (declare-function org-element-interpret-data "org-element" (data))
44 (declare-function org-element-lineage "org-element"
45 (blob &optional types with-self))
46 (declare-function org-element-map "org-element"
47 (data types fun
48 &optional info first-match no-recursion with-affiliated))
49 (declare-function org-element-parse-buffer "org-element"
50 (&optional granularity visible-only))
51 (declare-function org-element-property "org-element" (property element))
52 (declare-function org-element-type "org-element" (element))
54 (declare-function org-export-create-backend "ox" (&rest rest) t)
55 (declare-function org-export-data-with-backend "ox" (data backend info))
56 (declare-function org-export-filter-apply-functions "ox"
57 (filters value info))
58 (declare-function org-export-first-sibling-p "ox" (blob info))
59 (declare-function org-export-get-backend "ox" (name))
60 (declare-function org-export-get-environment "ox"
61 (&optional backend subtreep ext-plist))
62 (declare-function org-export-install-filters "ox" (info))
63 (declare-function org-export-table-has-special-column-p "ox" (table))
64 (declare-function org-export-table-row-is-special-p "ox" (table-row info))
66 (declare-function calc-eval "calc" (str &optional separator &rest args))
68 (defvar orgtbl-mode) ; defined below
69 (defvar orgtbl-mode-menu) ; defined when orgtbl mode get initialized
70 (defvar constants-unit-system)
71 (defvar org-export-filters-alist)
72 (defvar org-table-follow-field-mode)
73 (defvar sort-fold-case)
75 (defvar orgtbl-after-send-table-hook nil
76 "Hook for functions attaching to `C-c C-c', if the table is sent.
77 This can be used to add additional functionality after the table is sent
78 to the receiver position, otherwise, if table is not sent, the functions
79 are not run.")
81 (defvar org-table-TBLFM-begin-regexp "^[ \t]*|.*\n[ \t]*#\\+TBLFM: ")
83 (defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized)
84 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
85 In the optimized version, the table editor takes over all simple keys that
86 normally just insert a character. In tables, the characters are inserted
87 in a way to minimize disturbing the table structure (i.e. in overwrite mode
88 for empty fields). Outside tables, the correct binding of the keys is
89 restored.
91 The default for this option is t if the optimized version is also used in
92 Org mode. See the variable `org-enable-table-editor' for details. Changing
93 this variable requires a restart of Emacs to become effective."
94 :group 'org-table
95 :type 'boolean)
97 (defcustom orgtbl-radio-table-templates
98 '((latex-mode "% BEGIN RECEIVE ORGTBL %n
99 % END RECEIVE ORGTBL %n
100 \\begin{comment}
101 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
102 | | |
103 \\end{comment}\n")
104 (texinfo-mode "@c BEGIN RECEIVE ORGTBL %n
105 @c END RECEIVE ORGTBL %n
106 @ignore
107 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
108 | | |
109 @end ignore\n")
110 (html-mode "<!-- BEGIN RECEIVE ORGTBL %n -->
111 <!-- END RECEIVE ORGTBL %n -->
112 <!--
113 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
114 | | |
115 -->\n")
116 (org-mode "#+ BEGIN RECEIVE ORGTBL %n
117 #+ END RECEIVE ORGTBL %n
119 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
120 | | |
122 "Templates for radio tables in different major modes.
123 Each template must define lines that will be treated as a comment and that
124 must contain the \"BEGIN RECEIVE ORGTBL %n\" and \"END RECEIVE ORGTBL\"
125 lines where \"%n\" will be replaced with the name of the table during
126 insertion of the template. The transformed table will later be inserted
127 between these lines.
129 The template should also contain a minimal table in a multiline comment.
130 If multiline comments are not possible in the buffer language,
131 you can pack it into a string that will not be used when the code
132 is compiled or executed. Above the table will you need a line with
133 the fixed string \"#+ORGTBL: SEND\", followed by instruction on how to
134 convert the table into a data structure useful in the
135 language of the buffer. Check the manual for the section on
136 \"Translator functions\", and more generally check out
137 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
139 All occurrences of %n in a template will be replaced with the name of the
140 table, obtained by prompting the user."
141 :group 'org-table
142 :type '(repeat
143 (list (symbol :tag "Major mode")
144 (string :tag "Format"))))
146 (defgroup org-table-settings nil
147 "Settings for tables in Org mode."
148 :tag "Org Table Settings"
149 :group 'org-table)
151 (defcustom org-table-default-size "5x2"
152 "The default size for newly created tables, Columns x Rows."
153 :group 'org-table-settings
154 :type 'string)
156 (defcustom org-table-number-regexp
157 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
158 "Regular expression for recognizing numbers in table columns.
159 If a table column contains mostly numbers, it will be aligned to the
160 right. If not, it will be aligned to the left.
162 The default value of this option is a regular expression which allows
163 anything which looks remotely like a number as used in scientific
164 context. For example, all of the following will be considered a
165 number:
166 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
168 Other options offered by the customize interface are more restrictive."
169 :group 'org-table-settings
170 :type '(choice
171 (const :tag "Positive Integers"
172 "^[0-9]+$")
173 (const :tag "Integers"
174 "^[-+]?[0-9]+$")
175 (const :tag "Floating Point Numbers"
176 "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
177 (const :tag "Floating Point Number or Integer"
178 "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
179 (const :tag "Exponential, Floating point, Integer"
180 "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
181 (const :tag "Very General Number-Like, including hex and Calc radix"
182 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
183 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
184 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
185 (string :tag "Regexp:")))
187 (defcustom org-table-number-fraction 0.5
188 "Fraction of numbers in a column required to make the column align right.
189 In a column all non-white fields are considered. If at least
190 this fraction of fields is matched by `org-table-number-regexp',
191 alignment to the right border applies."
192 :group 'org-table-settings
193 :type 'number)
195 (defgroup org-table-editing nil
196 "Behavior of tables during editing in Org mode."
197 :tag "Org Table Editing"
198 :group 'org-table)
200 (defcustom org-table-automatic-realign t
201 "Non-nil means automatically re-align table when pressing TAB or RETURN.
202 When nil, aligning is only done with `\\[org-table-align]', or after column
203 removal/insertion."
204 :group 'org-table-editing
205 :type 'boolean)
207 (defcustom org-table-auto-blank-field t
208 "Non-nil means automatically blank table field when starting to type into it.
209 This only happens when typing immediately after a field motion
210 command (TAB, S-TAB or RET).
211 Only relevant when `org-enable-table-editor' is equal to `optimized'."
212 :group 'org-table-editing
213 :type 'boolean)
215 (defcustom org-table-exit-follow-field-mode-when-leaving-table t
216 "Non-nil means automatically exit the follow mode.
217 When nil, the follow mode will stay on and be active in any table
218 the cursor enters. Since the table follow filed mode messes with the
219 window configuration, it is not recommended to set this variable to nil,
220 except maybe locally in a special file that has mostly tables with long
221 fields."
222 :group 'org-table
223 :version "24.1"
224 :type 'boolean)
226 (defcustom org-table-fix-formulas-confirm nil
227 "Whether the user should confirm when Org fixes formulas."
228 :group 'org-table-editing
229 :version "24.1"
230 :type '(choice
231 (const :tag "with yes-or-no" yes-or-no-p)
232 (const :tag "with y-or-n" y-or-n-p)
233 (const :tag "no confirmation" nil)))
234 (put 'org-table-fix-formulas-confirm
235 'safe-local-variable
236 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
238 (defcustom org-table-tab-jumps-over-hlines t
239 "Non-nil means tab in the last column of a table with jump over a hline.
240 If a horizontal separator line is following the current line,
241 `org-table-next-field' can either create a new row before that line, or jump
242 over the line. When this option is nil, a new line will be created before
243 this line."
244 :group 'org-table-editing
245 :type 'boolean)
247 (defgroup org-table-calculation nil
248 "Options concerning tables in Org mode."
249 :tag "Org Table Calculation"
250 :group 'org-table)
252 (defcustom org-table-use-standard-references 'from
253 "Non-nil means using table references like B3 instead of @3$2.
254 Possible values are:
255 nil never use them
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
258 :group 'org-table-calculation
259 :type '(choice
260 (const :tag "Never, don't even check user input for them" nil)
261 (const :tag "Always, both as user input, and when editing" t)
262 (const :tag "Convert user input, don't offer during editing" from)))
264 (defcustom org-table-copy-increment t
265 "Non-nil means increment when copying current field with \
266 `\\[org-table-copy-down]'."
267 :group 'org-table-calculation
268 :version "25.2"
269 :package-version '(Org . "8.3")
270 :type '(choice
271 (const :tag "Use the difference between the current and the above fields" t)
272 (integer :tag "Use a number" 1)
273 (const :tag "Don't increment the value when copying a field" nil)))
275 (defcustom org-calc-default-modes
276 '(calc-internal-prec 12
277 calc-float-format (float 8)
278 calc-angle-mode deg
279 calc-prefer-frac nil
280 calc-symbolic-mode nil
281 calc-date-format (YYYY "-" MM "-" DD " " Www (" " hh ":" mm))
282 calc-display-working-message t
284 "List with Calc mode settings for use in `calc-eval' for table formulas.
285 The list must contain alternating symbols (Calc modes variables and values).
286 Don't remove any of the default settings, just change the values. Org mode
287 relies on the variables to be present in the list."
288 :group 'org-table-calculation
289 :type 'plist)
291 (defcustom org-table-duration-custom-format 'hours
292 "Format for the output of calc computations like $1+$2;t.
293 The default value is `hours', and will output the results as a
294 number of hours. Other allowed values are `seconds', `minutes' and
295 `days', and the output will be a fraction of seconds, minutes or
296 days."
297 :group 'org-table-calculation
298 :version "24.1"
299 :type '(choice (symbol :tag "Seconds" 'seconds)
300 (symbol :tag "Minutes" 'minutes)
301 (symbol :tag "Hours " 'hours)
302 (symbol :tag "Days " 'days)))
304 (defcustom org-table-formula-field-format "%s"
305 "Format for fields which contain the result of a formula.
306 For example, using \"~%s~\" will display the result within tilde
307 characters. Beware that modifying the display can prevent the
308 field from being used in another formula."
309 :group 'org-table-settings
310 :version "24.1"
311 :type 'string)
313 (defcustom org-table-formula-evaluate-inline t
314 "Non-nil means TAB and RET evaluate a formula in current table field.
315 If the current field starts with an equal sign, it is assumed to be a formula
316 which should be evaluated as described in the manual and in the documentation
317 string of the command `org-table-eval-formula'. This feature requires the
318 Emacs calc package.
319 When this variable is nil, formula calculation is only available through
320 the command `\\[org-table-eval-formula]'."
321 :group 'org-table-calculation
322 :type 'boolean)
324 (defcustom org-table-formula-use-constants t
325 "Non-nil means interpret constants in formulas in tables.
326 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
327 by the value given in `org-table-formula-constants', or by a value obtained
328 from the `constants.el' package."
329 :group 'org-table-calculation
330 :type 'boolean)
332 (defcustom org-table-formula-constants nil
333 "Alist with constant names and values, for use in table formulas.
334 The car of each element is a name of a constant, without the `$' before it.
335 The cdr is the value as a string. For example, if you'd like to use the
336 speed of light in a formula, you would configure
338 (setq org-table-formula-constants \\='((\"c\" . \"299792458.\")))
340 and then use it in an equation like `$1*$c'.
342 Constants can also be defined on a per-file basis using a line like
344 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
345 :group 'org-table-calculation
346 :type '(repeat
347 (cons (string :tag "name")
348 (string :tag "value"))))
350 (defcustom org-table-allow-automatic-line-recalculation t
351 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
352 \\<org-mode-map>\
353 Automatically means when `TAB' or `RET' or `\\[org-ctrl-c-ctrl-c]' \
354 are pressed in the line."
355 :group 'org-table-calculation
356 :type 'boolean)
358 (defcustom org-table-relative-ref-may-cross-hline t
359 "Non-nil means relative formula references may cross hlines.
360 Here are the allowed values:
362 nil Relative references may not cross hlines. They will reference the
363 field next to the hline instead. Coming from below, the reference
364 will be to the field below the hline. Coming from above, it will be
365 to the field above.
366 t Relative references may cross hlines.
367 error An attempt to cross a hline will throw an error.
369 It is probably good to never set this variable to nil, for the sake of
370 portability of tables."
371 :group 'org-table-calculation
372 :type '(choice
373 (const :tag "Allow to cross" t)
374 (const :tag "Stick to hline" nil)
375 (const :tag "Error on attempt to cross" error)))
377 (defcustom org-table-formula-create-columns nil
378 "Non-nil means that evaluation of a field formula can add new
379 columns if an out-of-bounds field is being set."
380 :group 'org-table-calculation
381 :version "25.2"
382 :package-version '(Org . "8.3")
383 :type '(choice
384 (const :tag "Setting an out-of-bounds field generates an error (default)" nil)
385 (const :tag "Setting an out-of-bounds field silently adds columns as needed" t)
386 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
387 (const :tag "When setting an out-of-bounds field, the user is prompted" prompt)))
389 (defgroup org-table-import-export nil
390 "Options concerning table import and export in Org mode."
391 :tag "Org Table Import Export"
392 :group 'org-table)
394 (defcustom org-table-export-default-format "orgtbl-to-tsv"
395 "Default export parameters for `org-table-export'.
396 These can be overridden for a specific table by setting the
397 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
398 radio tables for the different export transformations and
399 available parameters."
400 :group 'org-table-import-export
401 :type 'string)
403 (defcustom org-table-convert-region-max-lines 999
404 "Max lines that `org-table-convert-region' will attempt to process.
406 The function can be slow on larger regions; this safety feature
407 prevents it from hanging emacs."
408 :group 'org-table-import-export
409 :type 'integer
410 :version "25.2"
411 :package-version '(Org . "8.3"))
413 (defconst org-table-auto-recalculate-regexp "^[ \t]*| *# *\\(|\\|$\\)"
414 "Regexp matching a line marked for automatic recalculation.")
416 (defconst org-table-recalculate-regexp "^[ \t]*| *[#*] *\\(|\\|$\\)"
417 "Regexp matching a line marked for recalculation.")
419 (defconst org-table-calculate-mark-regexp "^[ \t]*| *[!$^_#*] *\\(|\\|$\\)"
420 "Regexp matching a line marked for calculation.")
422 (defconst org-table-border-regexp "^[ \t]*[^| \t]"
423 "Regexp matching any line outside an Org table.")
425 (defvar org-table-last-highlighted-reference nil)
427 (defvar org-table-formula-history nil)
429 (defvar org-table-column-names nil
430 "Alist with column names, derived from the `!' line.
431 This variable is initialized with `org-table-analyze'.")
433 (defvar org-table-column-name-regexp nil
434 "Regular expression matching the current column names.
435 This variable is initialized with `org-table-analyze'.")
437 (defvar org-table-local-parameters nil
438 "Alist with parameter names, derived from the `$' line.
439 This variable is initialized with `org-table-analyze'.")
441 (defvar org-table-named-field-locations nil
442 "Alist with locations of named fields.
443 Associations follow the pattern (NAME LINE COLUMN) where
444 NAME is the name of the field as a string,
445 LINE is the number of lines from the beginning of the table,
446 COLUMN is the column of the field, as an integer.
447 This variable is initialized with `org-table-analyze'.")
449 (defvar org-table-current-line-types nil
450 "Table row types in current table.
451 This variable is initialized with `org-table-analyze'.")
453 (defvar org-table-current-begin-pos nil
454 "Current table begin position, as a marker.
455 This variable is initialized with `org-table-analyze'.")
457 (defvar org-table-current-ncol nil
458 "Number of columns in current table.
459 This variable is initialized with `org-table-analyze'.")
461 (defvar org-table-dlines nil
462 "Vector of data line line numbers in the current table.
463 Line numbers are counted from the beginning of the table. This
464 variable is initialized with `org-table-analyze'.")
466 (defvar org-table-hlines nil
467 "Vector of hline line numbers in the current table.
468 Line numbers are counted from the beginning of the table. This
469 variable is initialized with `org-table-analyze'.")
471 (defconst org-table-range-regexp
472 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
473 ;; 1 2 3 4 5
474 "Regular expression for matching ranges in formulas.")
476 (defconst org-table-range-regexp2
477 (concat
478 "\\(" "@[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)"
479 "\\.\\."
480 "\\(" "@?[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)")
481 "Match a range for reference display.")
483 (defconst org-table-translate-regexp
484 (concat "\\(" "@[-0-9I$]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\)")
485 "Match a reference that needs translation, for reference display.")
487 (defmacro org-table-save-field (&rest body)
488 "Save current field; execute BODY; restore field.
489 Field is restored even in case of abnormal exit."
490 (declare (debug (body)))
491 (org-with-gensyms (line column)
492 `(let ((,line (copy-marker (line-beginning-position)))
493 (,column (org-table-current-column)))
494 (unwind-protect
495 (progn ,@body)
496 (goto-char ,line)
497 (org-table-goto-column ,column)
498 (set-marker ,line nil)))))
500 ;;;###autoload
501 (defun org-table-create-with-table.el ()
502 "Use the table.el package to insert a new table.
503 If there is already a table at point, convert between Org tables
504 and table.el tables."
505 (interactive)
506 (require 'table)
507 (cond
508 ((org-at-table.el-p)
509 (if (y-or-n-p "Convert table to Org table? ")
510 (org-table-convert)))
511 ((org-at-table-p)
512 (when (y-or-n-p "Convert table to table.el table? ")
513 (org-table-align)
514 (org-table-convert)))
515 (t (call-interactively 'table-insert))))
517 ;;;###autoload
518 (defun org-table-create-or-convert-from-region (arg)
519 "Convert region to table, or create an empty table.
520 If there is an active region, convert it to a table, using the function
521 `org-table-convert-region'. See the documentation of that function
522 to learn how the prefix argument is interpreted to determine the field
523 separator.
524 If there is no such region, create an empty table with `org-table-create'."
525 (interactive "P")
526 (if (org-region-active-p)
527 (org-table-convert-region (region-beginning) (region-end) arg)
528 (org-table-create arg)))
530 ;;;###autoload
531 (defun org-table-create (&optional size)
532 "Query for a size and insert a table skeleton.
533 SIZE is a string Columns x Rows like for example \"3x2\"."
534 (interactive "P")
535 (unless size
536 (setq size (read-string
537 (concat "Table size Columns x Rows [e.g. "
538 org-table-default-size "]: ")
539 "" nil org-table-default-size)))
541 (let* ((pos (point))
542 (indent (make-string (current-column) ?\ ))
543 (split (org-split-string size " *x *"))
544 (rows (string-to-number (nth 1 split)))
545 (columns (string-to-number (car split)))
546 (line (concat (apply 'concat indent "|" (make-list columns " |"))
547 "\n")))
548 (if (string-match "^[ \t]*$" (buffer-substring-no-properties
549 (point-at-bol) (point)))
550 (beginning-of-line 1)
551 (newline))
552 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
553 (dotimes (_ rows) (insert line))
554 (goto-char pos)
555 (if (> rows 1)
556 ;; Insert a hline after the first row.
557 (progn
558 (end-of-line 1)
559 (insert "\n|-")
560 (goto-char pos)))
561 (org-table-align)))
563 ;;;###autoload
564 (defun org-table-convert-region (beg0 end0 &optional separator)
565 "Convert region to a table.
567 The region goes from BEG0 to END0, but these borders will be moved
568 slightly, to make sure a beginning of line in the first line is included.
570 SEPARATOR specifies the field separator in the lines. It can have the
571 following values:
573 (4) Use the comma as a field separator
574 (16) Use a TAB as field separator
575 (64) Prompt for a regular expression as field separator
576 integer When a number, use that many spaces, or a TAB, as field separator
577 regexp When a regular expression, use it to match the separator
578 nil When nil, the command tries to be smart and figure out the
579 separator in the following way:
580 - when each line contains a TAB, assume TAB-separated material
581 - when each line contains a comma, assume CSV material
582 - else, assume one or more SPACE characters as separator."
583 (interactive "r\nP")
584 (let* ((beg (min beg0 end0))
585 (end (max beg0 end0))
587 (if (> (count-lines beg end) org-table-convert-region-max-lines)
588 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
589 org-table-convert-region-max-lines)
590 (if (equal separator '(64))
591 (setq separator (read-regexp "Regexp for field separator")))
592 (goto-char beg)
593 (beginning-of-line 1)
594 (setq beg (point-marker))
595 (goto-char end)
596 (if (bolp) (backward-char 1) (end-of-line 1))
597 (setq end (point-marker))
598 ;; Get the right field separator
599 (unless separator
600 (goto-char beg)
601 (setq separator
602 (cond
603 ((not (re-search-forward "^[^\n\t]+$" end t)) '(16))
604 ((not (re-search-forward "^[^\n,]+$" end t)) '(4))
605 (t 1))))
606 (goto-char beg)
607 (if (equal separator '(4))
608 (while (< (point) end)
609 ;; parse the csv stuff
610 (cond
611 ((looking-at "^") (insert "| "))
612 ((looking-at "[ \t]*$") (replace-match " |") (beginning-of-line 2))
613 ((looking-at "[ \t]*\"\\([^\"\n]*\\)\"")
614 (replace-match "\\1")
615 (if (looking-at "\"") (insert "\"")))
616 ((looking-at "[^,\n]+") (goto-char (match-end 0)))
617 ((looking-at "[ \t]*,") (replace-match " | "))
618 (t (beginning-of-line 2))))
619 (setq re (cond
620 ((equal separator '(4)) "^\\|\"?[ \t]*,[ \t]*\"?")
621 ((equal separator '(16)) "^\\|\t")
622 ((integerp separator)
623 (if (< separator 1)
624 (user-error "Number of spaces in separator must be >= 1")
625 (format "^ *\\| *\t *\\| \\{%d,\\}" separator)))
626 ((stringp separator)
627 (format "^ *\\|%s" separator))
628 (t (error "This should not happen"))))
629 (while (re-search-forward re end t)
630 (replace-match "| " t t)))
631 (goto-char beg)
632 (org-table-align))))
634 ;;;###autoload
635 (defun org-table-import (file arg)
636 "Import FILE as a table.
637 The file is assumed to be tab-separated. Such files can be produced by most
638 spreadsheet and database applications. If no tabs (at least one per line)
639 are found, lines will be split on whitespace into fields."
640 (interactive "f\nP")
641 (or (bolp) (newline))
642 (let ((beg (point))
643 (pm (point-max)))
644 (insert-file-contents file)
645 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
648 ;;;###autoload
649 (defun org-table-export (&optional file format)
650 "Export table to a file, with configurable format.
651 Such a file can be imported into usual spreadsheet programs.
653 FILE can be the output file name. If not given, it will be taken
654 from a TABLE_EXPORT_FILE property in the current entry or higher
655 up in the hierarchy, or the user will be prompted for a file
656 name. FORMAT can be an export format, of the same kind as it
657 used when `orgtbl-mode' sends a table in a different format.
659 The command suggests a format depending on TABLE_EXPORT_FORMAT,
660 whether it is set locally or up in the hierarchy, then on the
661 extension of the given file name, and finally on the variable
662 `org-table-export-default-format'."
663 (interactive)
664 (unless (org-at-table-p) (user-error "No table at point"))
665 (org-table-align) ; Make sure we have everything we need.
666 (let ((file (or file (org-entry-get (point) "TABLE_EXPORT_FILE" t))))
667 (unless file
668 (setq file (read-file-name "Export table to: "))
669 (unless (or (not (file-exists-p file))
670 (y-or-n-p (format "Overwrite file %s? " file)))
671 (user-error "File not written")))
672 (when (file-directory-p file)
673 (user-error "This is a directory path, not a file"))
674 (when (and (buffer-file-name (buffer-base-buffer))
675 (file-equal-p
676 (file-truename file)
677 (file-truename (buffer-file-name (buffer-base-buffer)))))
678 (user-error "Please specify a file name that is different from current"))
679 (let ((fileext (concat (file-name-extension file) "$"))
680 (format (or format (org-entry-get (point) "TABLE_EXPORT_FORMAT" t))))
681 (unless format
682 (let* ((formats '("orgtbl-to-tsv" "orgtbl-to-csv" "orgtbl-to-latex"
683 "orgtbl-to-html" "orgtbl-to-generic"
684 "orgtbl-to-texinfo" "orgtbl-to-orgtbl"
685 "orgtbl-to-unicode"))
686 (deffmt-readable
687 (replace-regexp-in-string
688 "\t" "\\t"
689 (replace-regexp-in-string
690 "\n" "\\n"
691 (or (car (delq nil
692 (mapcar
693 (lambda (f)
694 (and (string-match-p fileext f) f))
695 formats)))
696 org-table-export-default-format)
697 t t) t t)))
698 (setq format
699 (org-completing-read
700 "Format: " formats nil nil deffmt-readable))))
701 (if (string-match "\\([^ \t\r\n]+\\)\\( +.*\\)?" format)
702 (let ((transform (intern (match-string 1 format)))
703 (params (and (match-end 2)
704 (read (concat "(" (match-string 2 format) ")"))))
705 (table (org-table-to-lisp
706 (buffer-substring-no-properties
707 (org-table-begin) (org-table-end)))))
708 (unless (fboundp transform)
709 (user-error "No such transformation function %s" transform))
710 (let (buf)
711 (with-current-buffer (find-file-noselect file)
712 (setq buf (current-buffer))
713 (erase-buffer)
714 (fundamental-mode)
715 (insert (funcall transform table params) "\n")
716 (save-buffer))
717 (kill-buffer buf))
718 (message "Export done."))
719 (user-error "TABLE_EXPORT_FORMAT invalid")))))
721 (defvar org-table-aligned-begin-marker (make-marker)
722 "Marker at the beginning of the table last aligned.
723 Used to check if cursor still is in that table, to minimize realignment.")
724 (defvar org-table-aligned-end-marker (make-marker)
725 "Marker at the end of the table last aligned.
726 Used to check if cursor still is in that table, to minimize realignment.")
727 (defvar org-table-last-alignment nil
728 "List of flags for flushright alignment, from the last re-alignment.
729 This is being used to correctly align a single field after TAB or RET.")
730 (defvar org-table-last-column-widths nil
731 "List of max width of fields in each column.
732 This is being used to correctly align a single field after TAB or RET.")
733 (defvar-local org-table-formula-debug nil
734 "Non-nil means debug table formulas.
735 When nil, simply write \"#ERROR\" in corrupted fields.")
736 (defvar-local org-table-overlay-coordinates nil
737 "Overlay coordinates after each align of a table.")
739 (defvar org-last-recalc-line nil)
740 (defvar org-table-do-narrow t) ; for dynamic scoping
741 (defconst org-narrow-column-arrow "=>"
742 "Used as display property in narrowed table columns.")
744 ;;;###autoload
745 (defun org-table-align ()
746 "Align the table at point by aligning all vertical bars."
747 (interactive)
748 (let* ((beg (org-table-begin))
749 (end (copy-marker (org-table-end))))
750 (org-table-save-field
751 ;; Make sure invisible characters in the table are at the right
752 ;; place since column widths take them into account.
753 (font-lock-fontify-region beg end)
754 (move-marker org-table-aligned-begin-marker beg)
755 (move-marker org-table-aligned-end-marker end)
756 (goto-char beg)
757 (let* ((indent (progn (looking-at "[ \t]*") (match-string 0)))
758 ;; Table's rows. Separators are replaced by nil. Trailing
759 ;; spaces are also removed.
760 (lines (mapcar (lambda (l)
761 (and (not (string-match-p "\\`[ \t]*|-" l))
762 (let ((l (org-trim l)))
763 (remove-text-properties
764 0 (length l) '(display t org-cwidth t) l)
765 l)))
766 (org-split-string (buffer-substring beg end) "\n")))
767 ;; Get the data fields by splitting the lines.
768 (fields (mapcar (lambda (l) (org-split-string l " *| *"))
769 (remq nil lines)))
770 ;; Compute number of fields in the longest line. If the
771 ;; table contains no field, create a default table.
772 (maxfields (if fields (apply #'max (mapcar #'length fields))
773 (kill-region beg end)
774 (org-table-create org-table-default-size)
775 (user-error "Empty table - created default table")))
776 ;; A list of empty strings to fill any short rows on output.
777 (emptycells (make-list maxfields ""))
778 lengths typenums)
779 ;; Check for special formatting.
780 (dotimes (i maxfields)
781 (let ((column (mapcar (lambda (x) (or (nth i x) "")) fields))
782 fmax falign)
783 ;; Look for an explicit width or alignment.
784 (when (save-excursion
785 (or (re-search-forward "| *<[lrc][0-9]*> *\\(|\\|$\\)" end t)
786 (and org-table-do-narrow
787 (re-search-forward
788 "| *<[lrc]?[0-9]+> *\\(|\\|$\\)" end t))))
789 (catch :exit
790 (dolist (cell column)
791 (when (string-match "\\`<\\([lrc]\\)?\\([0-9]+\\)?>\\'" cell)
792 (when (match-end 1) (setq falign (match-string 1 cell)))
793 (when (and org-table-do-narrow (match-end 2))
794 (setq fmax (string-to-number (match-string 2 cell))))
795 (when (or falign fmax) (throw :exit nil)))))
796 ;; Find fields that are wider than FMAX, and shorten them.
797 (when fmax
798 (dolist (x column)
799 (when (> (org-string-width x) fmax)
800 (org-add-props x nil
801 'help-echo
802 (concat
803 "Clipped table field, use `\\[org-table-edit-field]' to \
804 edit. Full value is:\n"
805 (substring-no-properties x)))
806 (let ((l (length x))
807 (f1 (min fmax
808 (or (string-match org-bracket-link-regexp x)
809 fmax)))
810 (f2 1))
811 (unless (> f1 1)
812 (user-error
813 "Cannot narrow field starting with wide link \"%s\""
814 (match-string 0 x)))
815 (if (= (org-string-width x) l) (setq f2 f1)
816 (setq f2 1)
817 (while (< (org-string-width (substring x 0 f2)) f1)
818 (cl-incf f2)))
819 (add-text-properties f2 l (list 'org-cwidth t) x)
820 (add-text-properties
821 (if (>= (string-width (substring x (1- f2) f2)) 2) (1- f2)
822 (- f2 2))
824 (list 'display org-narrow-column-arrow)
825 x))))))
826 ;; Get the maximum width for each column
827 (push (apply #'max (or fmax 1) 1 (mapcar #'org-string-width column))
828 lengths)
829 ;; Get the fraction of numbers among non-empty cells to
830 ;; decide about alignment of the column.
831 (if falign (push (equal (downcase falign) "r") typenums)
832 (let ((cnt 0)
833 (frac 0.0))
834 (dolist (x column)
835 (unless (equal x "")
836 (setq frac
837 (/ (+ (* frac cnt)
838 (if (string-match-p org-table-number-regexp x)
841 (cl-incf cnt)))))
842 (push (>= frac org-table-number-fraction) typenums)))))
843 (setq lengths (nreverse lengths))
844 (setq typenums (nreverse typenums))
845 ;; Store alignment of this table, for later editing of single
846 ;; fields.
847 (setq org-table-last-alignment typenums)
848 (setq org-table-last-column-widths lengths)
849 ;; With invisible characters, `format' does not get the field
850 ;; width right So we need to make these fields wide by hand.
851 ;; Invisible characters may be introduced by fontified links,
852 ;; emphasis, macros or sub/superscripts.
853 (when (or (text-property-any beg end 'invisible 'org-link)
854 (text-property-any beg end 'invisible t))
855 (dotimes (i maxfields)
856 (let ((len (nth i lengths)))
857 (dotimes (j (length fields))
858 (let* ((c (nthcdr i (nth j fields)))
859 (cell (car c)))
860 (when (and
861 (stringp cell)
862 (let ((l (length cell)))
863 (or (text-property-any 0 l 'invisible 'org-link cell)
864 (text-property-any beg end 'invisible t)))
865 (< (org-string-width cell) len))
866 (let ((s (make-string (- len (org-string-width cell)) ?\s)))
867 (setcar c (if (nth i typenums) (concat s cell)
868 (concat cell s))))))))))
870 ;; Compute the formats needed for output of the table.
871 (let ((hfmt (concat indent "|"))
872 (rfmt (concat indent "|"))
873 (rfmt1 " %%%s%ds |")
874 (hfmt1 "-%s-+"))
875 (dolist (l lengths (setq hfmt (concat (substring hfmt 0 -1) "|")))
876 (let ((ty (if (pop typenums) "" "-"))) ; Flush numbers right.
877 (setq rfmt (concat rfmt (format rfmt1 ty l)))
878 (setq hfmt (concat hfmt (format hfmt1 (make-string l ?-))))))
879 ;; Replace modified lines only. Check not only contents, but
880 ;; also columns' width.
881 (dolist (l lines)
882 (let ((line
883 (if l (apply #'format rfmt (append (pop fields) emptycells))
884 hfmt))
885 (previous (buffer-substring (point) (line-end-position))))
886 (if (and (equal previous line)
887 (let ((a 0)
888 (b 0))
889 (while (and (progn
890 (setq a (next-single-property-change
891 a 'org-cwidth previous))
892 (setq b (next-single-property-change
893 b 'org-cwidth line)))
894 (eq a b)))
895 (eq a b)))
896 (forward-line)
897 (insert line "\n")
898 (delete-region (point) (line-beginning-position 2))))))
899 (when (and orgtbl-mode (not (derived-mode-p 'org-mode)))
900 (goto-char org-table-aligned-begin-marker)
901 (while (org-hide-wide-columns org-table-aligned-end-marker)))
902 (set-marker end nil)
903 (when org-table-overlay-coordinates (org-table-overlay-coordinates))
904 (setq org-table-may-need-update nil)))))
906 ;;;###autoload
907 (defun org-table-begin (&optional table-type)
908 "Find the beginning of the table and return its position.
909 With a non-nil optional argument TABLE-TYPE, return the beginning
910 of a table.el-type table. This function assumes point is on
911 a table."
912 (cond (table-type
913 (org-element-property :post-affiliated (org-element-at-point)))
914 ((save-excursion
915 (and (re-search-backward org-table-border-regexp nil t)
916 (line-beginning-position 2))))
917 (t (point-min))))
919 ;;;###autoload
920 (defun org-table-end (&optional table-type)
921 "Find the end of the table and return its position.
922 With a non-nil optional argument TABLE-TYPE, return the end of
923 a table.el-type table. This function assumes point is on
924 a table."
925 (save-excursion
926 (cond (table-type
927 (goto-char (org-element-property :end (org-element-at-point)))
928 (skip-chars-backward " \t\n")
929 (line-beginning-position 2))
930 ((re-search-forward org-table-border-regexp nil t)
931 (match-beginning 0))
932 ;; When the line right after the table is the last line in
933 ;; the buffer with trailing spaces but no final newline
934 ;; character, be sure to catch the correct ending at its
935 ;; beginning. In any other case, ending is expected to be
936 ;; at point max.
937 (t (goto-char (point-max))
938 (skip-chars-backward " \t")
939 (if (bolp) (point) (line-end-position))))))
941 ;;;###autoload
942 (defun org-table-justify-field-maybe (&optional new)
943 "Justify the current field, text to left, number to right.
944 Optional argument NEW may specify text to replace the current field content."
945 (cond
946 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
947 ((org-at-table-hline-p))
948 ((and (not new)
949 (or (not (eq (marker-buffer org-table-aligned-begin-marker)
950 (current-buffer)))
951 (< (point) org-table-aligned-begin-marker)
952 (>= (point) org-table-aligned-end-marker)))
953 ;; This is not the same table, force a full re-align.
954 (setq org-table-may-need-update t))
956 ;; Realign the current field, based on previous full realign.
957 (let ((pos (point))
958 (col (org-table-current-column)))
959 (when (> col 0)
960 (skip-chars-backward "^|")
961 (if (not (looking-at " *\\([^|\n]*?\\) *\\(|\\|$\\)"))
962 (setq org-table-may-need-update t)
963 (let* ((numbers? (nth (1- col) org-table-last-alignment))
964 (cell (match-string 0))
965 (field (match-string 1))
966 (len (max 1 (- (org-string-width cell) 3)))
967 (properly-closed? (/= (match-beginning 2) (match-end 2)))
968 (fmt (format (if numbers? " %%%ds %s" " %%-%ds %s")
970 (if properly-closed? "|"
971 (setq org-table-may-need-update t)
972 "")))
973 (new-cell
974 (cond ((not new) (format fmt field))
975 ((<= (org-string-width new) len) (format fmt new))
977 (setq org-table-may-need-update t)
978 (format " %s |" new)))))
979 (unless (equal new-cell cell)
980 (let (org-table-may-need-update)
981 (replace-match new-cell t t)))
982 (goto-char pos))))))))
984 ;;;###autoload
985 (defun org-table-next-field ()
986 "Go to the next field in the current table, creating new lines as needed.
987 Before doing so, re-align the table if necessary."
988 (interactive)
989 (org-table-maybe-eval-formula)
990 (org-table-maybe-recalculate-line)
991 (if (and org-table-automatic-realign
992 org-table-may-need-update)
993 (org-table-align))
994 (let ((end (org-table-end)))
995 (if (org-at-table-hline-p)
996 (end-of-line 1))
997 (condition-case nil
998 (progn
999 (re-search-forward "|" end)
1000 (if (looking-at "[ \t]*$")
1001 (re-search-forward "|" end))
1002 (if (and (looking-at "-")
1003 org-table-tab-jumps-over-hlines
1004 (re-search-forward "^[ \t]*|\\([^-]\\)" end t))
1005 (goto-char (match-beginning 1)))
1006 (if (looking-at "-")
1007 (progn
1008 (beginning-of-line 0)
1009 (org-table-insert-row 'below))
1010 (if (looking-at " ") (forward-char 1))))
1011 (error
1012 (org-table-insert-row 'below)))))
1014 ;;;###autoload
1015 (defun org-table-previous-field ()
1016 "Go to the previous field in the table.
1017 Before doing so, re-align the table if necessary."
1018 (interactive)
1019 (org-table-justify-field-maybe)
1020 (org-table-maybe-recalculate-line)
1021 (if (and org-table-automatic-realign
1022 org-table-may-need-update)
1023 (org-table-align))
1024 (if (org-at-table-hline-p)
1025 (end-of-line 1))
1026 (condition-case nil
1027 (progn
1028 (re-search-backward "|" (org-table-begin))
1029 (re-search-backward "|" (org-table-begin)))
1030 (error (user-error "Cannot move to previous table field")))
1031 (while (looking-at "|\\(-\\|[ \t]*$\\)")
1032 (re-search-backward "|" (org-table-begin)))
1033 (if (looking-at "| ?")
1034 (goto-char (match-end 0))))
1036 (defun org-table-beginning-of-field (&optional n)
1037 "Move to the beginning of the current table field.
1038 If already at or before the beginning, move to the beginning of the
1039 previous field.
1040 With numeric argument N, move N-1 fields backward first."
1041 (interactive "p")
1042 (let ((pos (point)))
1043 (while (> n 1)
1044 (setq n (1- n))
1045 (org-table-previous-field))
1046 (if (not (re-search-backward "|" (point-at-bol 0) t))
1047 (user-error "No more table fields before the current")
1048 (goto-char (match-end 0))
1049 (and (looking-at " ") (forward-char 1)))
1050 (if (>= (point) pos) (org-table-beginning-of-field 2))))
1052 (defun org-table-end-of-field (&optional n)
1053 "Move to the end of the current table field.
1054 If already at or after the end, move to the end of the next table field.
1055 With numeric argument N, move N-1 fields forward first."
1056 (interactive "p")
1057 (let ((pos (point)))
1058 (while (> n 1)
1059 (setq n (1- n))
1060 (org-table-next-field))
1061 (when (re-search-forward "|" (point-at-eol 1) t)
1062 (backward-char 1)
1063 (skip-chars-backward " ")
1064 (if (and (equal (char-before (point)) ?|) (looking-at " "))
1065 (forward-char 1)))
1066 (if (<= (point) pos) (org-table-end-of-field 2))))
1068 ;;;###autoload
1069 (defun org-table-next-row ()
1070 "Go to the next row (same column) in the current table.
1071 Before doing so, re-align the table if necessary."
1072 (interactive)
1073 (org-table-maybe-eval-formula)
1074 (org-table-maybe-recalculate-line)
1075 (if (or (looking-at "[ \t]*$")
1076 (save-excursion (skip-chars-backward " \t") (bolp)))
1077 (newline)
1078 (if (and org-table-automatic-realign
1079 org-table-may-need-update)
1080 (org-table-align))
1081 (let ((col (org-table-current-column)))
1082 (beginning-of-line 2)
1083 (if (or (not (org-at-table-p))
1084 (org-at-table-hline-p))
1085 (progn
1086 (beginning-of-line 0)
1087 (org-table-insert-row 'below)))
1088 (org-table-goto-column col)
1089 (skip-chars-backward "^|\n\r")
1090 (if (looking-at " ") (forward-char 1)))))
1092 ;;;###autoload
1093 (defun org-table-copy-down (n)
1094 "Copy the value of the current field one row below.
1096 If the field at the cursor is empty, copy the content of the
1097 nearest non-empty field above. With argument N, use the Nth
1098 non-empty field.
1100 If the current field is not empty, it is copied down to the next
1101 row, and the cursor is moved with it. Therefore, repeating this
1102 command causes the column to be filled row-by-row.
1104 If the variable `org-table-copy-increment' is non-nil and the
1105 field is an integer or a timestamp, it will be incremented while
1106 copying. By default, increment by the difference between the
1107 value in the current field and the one in the field above. To
1108 increment using a fixed integer, set `org-table-copy-increment'
1109 to a number. In the case of a timestamp, increment by days."
1110 (interactive "p")
1111 (let* ((colpos (org-table-current-column))
1112 (col (current-column))
1113 (field (save-excursion (org-table-get-field)))
1114 (field-up (or (save-excursion
1115 (org-table-get (1- (org-table-current-line))
1116 (org-table-current-column))) ""))
1117 (non-empty (string-match "[^ \t]" field))
1118 (non-empty-up (string-match "[^ \t]" field-up))
1119 (beg (org-table-begin))
1120 (orig-n n)
1121 txt txt-up inc)
1122 (org-table-check-inside-data-field)
1123 (if (not non-empty)
1124 (save-excursion
1125 (setq txt
1126 (catch 'exit
1127 (while (progn (beginning-of-line 1)
1128 (re-search-backward org-table-dataline-regexp
1129 beg t))
1130 (org-table-goto-column colpos t)
1131 (if (and (looking-at
1132 "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
1133 (<= (setq n (1- n)) 0))
1134 (throw 'exit (match-string 1))))))
1135 (setq field-up
1136 (catch 'exit
1137 (while (progn (beginning-of-line 1)
1138 (re-search-backward org-table-dataline-regexp
1139 beg t))
1140 (org-table-goto-column colpos t)
1141 (if (and (looking-at
1142 "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
1143 (<= (setq n (1- n)) 0))
1144 (throw 'exit (match-string 1))))))
1145 (setq non-empty-up (and field-up (string-match "[^ \t]" field-up))))
1146 ;; Above field was not empty, go down to the next row
1147 (setq txt (org-trim field))
1148 (org-table-next-row)
1149 (org-table-blank-field))
1150 (if non-empty-up (setq txt-up (org-trim field-up)))
1151 (setq inc (cond
1152 ((numberp org-table-copy-increment) org-table-copy-increment)
1153 (txt-up (cond ((and (string-match org-ts-regexp3 txt-up)
1154 (string-match org-ts-regexp3 txt))
1155 (- (org-time-string-to-absolute txt)
1156 (org-time-string-to-absolute txt-up)))
1157 ((string-match org-ts-regexp3 txt) 1)
1158 ((string-match "^[0-9]+\\(\.[0-9]+\\)?" txt-up)
1159 (- (string-to-number txt)
1160 (string-to-number (match-string 0 txt-up))))
1161 (t 1)))
1162 (t 1)))
1163 (if (not txt)
1164 (user-error "No non-empty field found")
1165 (if (and org-table-copy-increment
1166 (not (equal orig-n 0))
1167 (string-match-p "^[-+^/*0-9eE.]+$" txt)
1168 (< (string-to-number txt) 100000000))
1169 (setq txt (calc-eval (concat txt "+" (number-to-string inc)))))
1170 (insert txt)
1171 (org-move-to-column col)
1172 (if (and org-table-copy-increment (org-at-timestamp-p t))
1173 (org-timestamp-up-day inc)
1174 (org-table-maybe-recalculate-line))
1175 (org-table-align)
1176 (org-move-to-column col))))
1178 (defun org-table-check-inside-data-field (&optional noerror)
1179 "Is point inside a table data field?
1180 I.e. not on a hline or before the first or after the last column?
1181 This actually throws an error, so it aborts the current command."
1182 (cond ((and (org-at-table-p)
1183 (not (save-excursion (skip-chars-backward " \t") (bolp)))
1184 (not (org-at-table-hline-p))
1185 (not (looking-at "[ \t]*$"))))
1186 (noerror nil)
1187 (t (user-error "Not in table data field"))))
1189 (defvar org-table-clip nil
1190 "Clipboard for table regions.")
1192 (defun org-table-get (line column)
1193 "Get the field in table line LINE, column COLUMN.
1194 If LINE is larger than the number of data lines in the table, the function
1195 returns nil. However, if COLUMN is too large, we will simply return an
1196 empty string.
1197 If LINE is nil, use the current line.
1198 If COLUMN is nil, use the current column."
1199 (setq column (or column (org-table-current-column)))
1200 (save-excursion
1201 (and (or (not line) (org-table-goto-line line))
1202 (org-trim (org-table-get-field column)))))
1204 (defun org-table-put (line column value &optional align)
1205 "Put VALUE into line LINE, column COLUMN.
1206 When ALIGN is set, also realign the table."
1207 (setq column (or column (org-table-current-column)))
1208 (prog1 (save-excursion
1209 (and (or (not line) (org-table-goto-line line))
1210 (progn (org-table-goto-column column nil 'force) t)
1211 (org-table-get-field column value)))
1212 (and align (org-table-align))))
1214 (defun org-table-current-line ()
1215 "Return the index of the current data line."
1216 (let ((pos (point)) (end (org-table-end)) (cnt 0))
1217 (save-excursion
1218 (goto-char (org-table-begin))
1219 (while (and (re-search-forward org-table-dataline-regexp end t)
1220 (setq cnt (1+ cnt))
1221 (< (point-at-eol) pos))))
1222 cnt))
1224 (defun org-table-goto-line (N)
1225 "Go to the Nth data line in the current table.
1226 Return t when the line exists, nil if it does not exist."
1227 (goto-char (org-table-begin))
1228 (let ((end (org-table-end)) (cnt 0))
1229 (while (and (re-search-forward org-table-dataline-regexp end t)
1230 (< (setq cnt (1+ cnt)) N)))
1231 (= cnt N)))
1233 ;;;###autoload
1234 (defun org-table-blank-field ()
1235 "Blank the current table field or active region."
1236 (interactive)
1237 (org-table-check-inside-data-field)
1238 (if (and (called-interactively-p 'any) (org-region-active-p))
1239 (let (org-table-clip)
1240 (org-table-cut-region (region-beginning) (region-end)))
1241 (skip-chars-backward "^|")
1242 (backward-char 1)
1243 (if (looking-at "|[^|\n]+")
1244 (let* ((pos (match-beginning 0))
1245 (match (match-string 0))
1246 (len (org-string-width match)))
1247 (replace-match (concat "|" (make-string (1- len) ?\ )))
1248 (goto-char (+ 2 pos))
1249 (substring match 1)))))
1251 (defun org-table-get-field (&optional n replace)
1252 "Return the value of the field in column N of current row.
1253 N defaults to current field.
1254 If REPLACE is a string, replace field with this value. The return value
1255 is always the old value."
1256 (and n (org-table-goto-column n))
1257 (skip-chars-backward "^|\n")
1258 (backward-char 1)
1259 (if (looking-at "|[^|\r\n]*")
1260 (let* ((pos (match-beginning 0))
1261 (val (buffer-substring (1+ pos) (match-end 0))))
1262 (if replace
1263 (replace-match (concat "|" (if (equal replace "") " " replace))
1264 t t))
1265 (goto-char (min (point-at-eol) (+ 2 pos)))
1266 val)
1267 (forward-char 1) ""))
1269 ;;;###autoload
1270 (defun org-table-field-info (_arg)
1271 "Show info about the current field, and highlight any reference at point."
1272 (interactive "P")
1273 (unless (org-at-table-p) (user-error "Not at a table"))
1274 (org-table-analyze)
1275 (save-excursion
1276 (let* ((pos (point))
1277 (col (org-table-current-column))
1278 (cname (car (rassoc (int-to-string col) org-table-column-names)))
1279 (name (car (rassoc (list (count-lines org-table-current-begin-pos
1280 (line-beginning-position))
1281 col)
1282 org-table-named-field-locations)))
1283 (eql (org-table-expand-lhs-ranges
1284 (mapcar
1285 (lambda (e)
1286 (cons (org-table-formula-handle-first/last-rc (car e))
1287 (cdr e)))
1288 (org-table-get-stored-formulas))))
1289 (dline (org-table-current-dline))
1290 (ref (format "@%d$%d" dline col))
1291 (ref1 (org-table-convert-refs-to-an ref))
1292 ;; Prioritize field formulas over column formulas.
1293 (fequation (or (assoc name eql) (assoc ref eql)))
1294 (cequation (assoc (format "$%d" col) eql))
1295 (eqn (or fequation cequation)))
1296 (let ((p (and eqn (get-text-property 0 :orig-eqn (car eqn)))))
1297 (when p (setq eqn p)))
1298 (goto-char pos)
1299 (ignore-errors (org-table-show-reference 'local))
1300 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
1301 dline col
1302 (if cname (concat " or $" cname) "")
1303 dline col ref1
1304 (if name (concat " or $" name) "")
1305 ;; FIXME: formula info not correct if special table line
1306 (if eqn
1307 (concat ", formula: "
1308 (org-table-formula-to-user
1309 (concat
1310 (if (or (string-prefix-p "$" (car eqn))
1311 (string-prefix-p "@" (car eqn)))
1313 "$")
1314 (car eqn) "=" (cdr eqn))))
1315 "")))))
1317 (defun org-table-current-column ()
1318 "Find out which column we are in."
1319 (interactive)
1320 (when (called-interactively-p 'any) (org-table-check-inside-data-field))
1321 (save-excursion
1322 (let ((column 0) (pos (point)))
1323 (beginning-of-line)
1324 (while (search-forward "|" pos t) (cl-incf column))
1325 (when (called-interactively-p 'interactive)
1326 (message "In table column %d" column))
1327 column)))
1329 ;;;###autoload
1330 (defun org-table-current-dline ()
1331 "Find out what table data line we are in.
1332 Only data lines count for this."
1333 (interactive)
1334 (when (called-interactively-p 'any)
1335 (org-table-check-inside-data-field))
1336 (save-excursion
1337 (let ((c 0)
1338 (pos (point)))
1339 (goto-char (org-table-begin))
1340 (while (<= (point) pos)
1341 (when (looking-at org-table-dataline-regexp) (cl-incf c))
1342 (forward-line))
1343 (when (called-interactively-p 'any)
1344 (message "This is table line %d" c))
1345 c)))
1347 ;;;###autoload
1348 (defun org-table-goto-column (n &optional on-delim force)
1349 "Move the cursor to the Nth column in the current table line.
1350 With optional argument ON-DELIM, stop with point before the left delimiter
1351 of the field.
1352 If there are less than N fields, just go to after the last delimiter.
1353 However, when FORCE is non-nil, create new columns if necessary."
1354 (interactive "p")
1355 (beginning-of-line 1)
1356 (when (> n 0)
1357 (while (and (> (setq n (1- n)) -1)
1358 (or (search-forward "|" (point-at-eol) t)
1359 (and force
1360 (progn (end-of-line 1)
1361 (skip-chars-backward "^|")
1362 (insert " | ")
1363 t)))))
1364 (when (and force (not (looking-at ".*|")))
1365 (save-excursion (end-of-line 1) (insert " | ")))
1366 (if on-delim
1367 (backward-char 1)
1368 (if (looking-at " ") (forward-char 1)))))
1370 ;;;###autoload
1371 (defun org-table-insert-column ()
1372 "Insert a new column into the table."
1373 (interactive)
1374 (unless (org-at-table-p) (user-error "Not at a table"))
1375 (org-table-find-dataline)
1376 (let* ((col (max 1 (org-table-current-column)))
1377 (beg (org-table-begin))
1378 (end (copy-marker (org-table-end))))
1379 (org-table-save-field
1380 (goto-char beg)
1381 (while (< (point) end)
1382 (unless (org-at-table-hline-p)
1383 (org-table-goto-column col t)
1384 (insert "| "))
1385 (forward-line)))
1386 (set-marker end nil)
1387 (org-table-align)
1388 (when (or (not org-table-fix-formulas-confirm)
1389 (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1390 (org-table-fix-formulas "$" nil (1- col) 1)
1391 (org-table-fix-formulas "$LR" nil (1- col) 1))))
1393 (defun org-table-find-dataline ()
1394 "Find a data line in the current table, which is needed for column commands."
1395 (if (and (org-at-table-p)
1396 (not (org-at-table-hline-p)))
1398 (let ((col (current-column))
1399 (end (org-table-end)))
1400 (org-move-to-column col)
1401 (while (and (< (point) end)
1402 (or (not (= (current-column) col))
1403 (org-at-table-hline-p)))
1404 (beginning-of-line 2)
1405 (org-move-to-column col))
1406 (if (and (org-at-table-p)
1407 (not (org-at-table-hline-p)))
1409 (user-error
1410 "Please position cursor in a data line for column operations")))))
1412 (defun org-table-line-to-dline (line &optional above)
1413 "Turn a buffer line number into a data line number.
1415 If there is no data line in this line, return nil.
1417 If there is no matching dline (most likely the reference was
1418 a hline), the first dline below it is used. When ABOVE is
1419 non-nil, the one above is used."
1420 (let ((min 1)
1421 (max (1- (length org-table-dlines))))
1422 (cond ((or (> (aref org-table-dlines min) line)
1423 (< (aref org-table-dlines max) line))
1424 nil)
1425 ((= (aref org-table-dlines max) line) max)
1426 (t (catch 'exit
1427 (while (> (- max min) 1)
1428 (let* ((mean (/ (+ max min) 2))
1429 (v (aref org-table-dlines mean)))
1430 (cond ((= v line) (throw 'exit mean))
1431 ((> v line) (setq max mean))
1432 (t (setq min mean)))))
1433 (if above min max))))))
1435 ;;;###autoload
1436 (defun org-table-delete-column ()
1437 "Delete a column from the table."
1438 (interactive)
1439 (unless (org-at-table-p) (user-error "Not at a table"))
1440 (org-table-find-dataline)
1441 (org-table-check-inside-data-field)
1442 (let ((col (org-table-current-column))
1443 (beg (org-table-begin))
1444 (end (copy-marker (org-table-end))))
1445 (org-table-save-field
1446 (goto-char beg)
1447 (while (< (point) end)
1448 (if (org-at-table-hline-p)
1450 (org-table-goto-column col t)
1451 (and (looking-at "|[^|\n]+|")
1452 (replace-match "|")))
1453 (forward-line)))
1454 (set-marker end nil)
1455 (org-table-goto-column (max 1 (1- col)))
1456 (org-table-align)
1457 (when (or (not org-table-fix-formulas-confirm)
1458 (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1459 (org-table-fix-formulas
1460 "$" (list (cons (number-to-string col) "INVALID")) col -1 col)
1461 (org-table-fix-formulas
1462 "$LR" (list (cons (number-to-string col) "INVALID")) col -1 col))))
1464 ;;;###autoload
1465 (defun org-table-move-column-right ()
1466 "Move column to the right."
1467 (interactive)
1468 (org-table-move-column nil))
1469 ;;;###autoload
1470 (defun org-table-move-column-left ()
1471 "Move column to the left."
1472 (interactive)
1473 (org-table-move-column 'left))
1475 ;;;###autoload
1476 (defun org-table-move-column (&optional left)
1477 "Move the current column to the right. With arg LEFT, move to the left."
1478 (interactive "P")
1479 (unless (org-at-table-p) (user-error "Not at a table"))
1480 (org-table-find-dataline)
1481 (org-table-check-inside-data-field)
1482 (let* ((col (org-table-current-column))
1483 (col1 (if left (1- col) col))
1484 (colpos (if left (1- col) (1+ col)))
1485 (beg (org-table-begin))
1486 (end (copy-marker (org-table-end))))
1487 (when (and left (= col 1))
1488 (user-error "Cannot move column further left"))
1489 (when (and (not left) (looking-at "[^|\n]*|[^|\n]*$"))
1490 (user-error "Cannot move column further right"))
1491 (org-table-save-field
1492 (goto-char beg)
1493 (while (< (point) end)
1494 (unless (org-at-table-hline-p)
1495 (org-table-goto-column col1 t)
1496 (when (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
1497 (replace-match "|\\2|\\1|")))
1498 (forward-line)))
1499 (set-marker end nil)
1500 (org-table-goto-column colpos)
1501 (org-table-align)
1502 (when (or (not org-table-fix-formulas-confirm)
1503 (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1504 (org-table-fix-formulas
1505 "$" (list (cons (number-to-string col) (number-to-string colpos))
1506 (cons (number-to-string colpos) (number-to-string col))))
1507 (org-table-fix-formulas
1508 "$LR" (list (cons (number-to-string col) (number-to-string colpos))
1509 (cons (number-to-string colpos) (number-to-string col)))))))
1511 ;;;###autoload
1512 (defun org-table-move-row-down ()
1513 "Move table row down."
1514 (interactive)
1515 (org-table-move-row nil))
1516 ;;;###autoload
1517 (defun org-table-move-row-up ()
1518 "Move table row up."
1519 (interactive)
1520 (org-table-move-row 'up))
1522 ;;;###autoload
1523 (defun org-table-move-row (&optional up)
1524 "Move the current table line down. With arg UP, move it up."
1525 (interactive "P")
1526 (let* ((col (current-column))
1527 (pos (point))
1528 (hline1p (save-excursion (beginning-of-line 1)
1529 (looking-at org-table-hline-regexp)))
1530 (dline1 (org-table-current-dline))
1531 (dline2 (+ dline1 (if up -1 1)))
1532 (tonew (if up 0 2))
1533 txt hline2p)
1534 (beginning-of-line tonew)
1535 (unless (org-at-table-p)
1536 (goto-char pos)
1537 (user-error "Cannot move row further"))
1538 (setq hline2p (looking-at org-table-hline-regexp))
1539 (goto-char pos)
1540 (beginning-of-line 1)
1541 (setq pos (point))
1542 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
1543 (delete-region (point) (1+ (point-at-eol)))
1544 (beginning-of-line tonew)
1545 (insert txt)
1546 (beginning-of-line 0)
1547 (org-move-to-column col)
1548 (unless (or hline1p hline2p
1549 (not (or (not org-table-fix-formulas-confirm)
1550 (funcall org-table-fix-formulas-confirm
1551 "Fix formulas? "))))
1552 (org-table-fix-formulas
1553 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
1554 (cons (number-to-string dline2) (number-to-string dline1)))))))
1556 ;;;###autoload
1557 (defun org-table-insert-row (&optional arg)
1558 "Insert a new row above the current line into the table.
1559 With prefix ARG, insert below the current line."
1560 (interactive "P")
1561 (unless (org-at-table-p) (user-error "Not at a table"))
1562 (let* ((line (buffer-substring (line-beginning-position) (line-end-position)))
1563 (new (org-table-clean-line line)))
1564 ;; Fix the first field if necessary
1565 (if (string-match "^[ \t]*| *[#$] *|" line)
1566 (setq new (replace-match (match-string 0 line) t t new)))
1567 (beginning-of-line (if arg 2 1))
1568 ;; Buffer may not end of a newline character, so ensure
1569 ;; (beginning-of-line 2) moves point to a new line.
1570 (unless (bolp) (insert "\n"))
1571 (let (org-table-may-need-update) (insert-before-markers new "\n"))
1572 (beginning-of-line 0)
1573 (re-search-forward "| ?" (line-end-position) t)
1574 (when (or org-table-may-need-update org-table-overlay-coordinates)
1575 (org-table-align))
1576 (when (or (not org-table-fix-formulas-confirm)
1577 (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1578 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1))))
1580 ;;;###autoload
1581 (defun org-table-insert-hline (&optional above)
1582 "Insert a horizontal-line below the current line into the table.
1583 With prefix ABOVE, insert above the current line."
1584 (interactive "P")
1585 (if (not (org-at-table-p))
1586 (user-error "Not at a table"))
1587 (when (eobp) (insert "\n") (backward-char 1))
1588 (if (not (string-match-p "|[ \t]*$" (org-current-line-string)))
1589 (org-table-align))
1590 (let ((line (org-table-clean-line
1591 (buffer-substring (point-at-bol) (point-at-eol))))
1592 (col (current-column)))
1593 (while (string-match "|\\( +\\)|" line)
1594 (setq line (replace-match
1595 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
1596 ?-) "|") t t line)))
1597 (and (string-match "\\+" line) (setq line (replace-match "|" t t line)))
1598 (beginning-of-line (if above 1 2))
1599 (insert line "\n")
1600 (beginning-of-line (if above 1 -1))
1601 (org-move-to-column col)
1602 (and org-table-overlay-coordinates (org-table-align))))
1604 ;;;###autoload
1605 (defun org-table-hline-and-move (&optional same-column)
1606 "Insert a hline and move to the row below that line."
1607 (interactive "P")
1608 (let ((col (org-table-current-column)))
1609 (org-table-maybe-eval-formula)
1610 (org-table-maybe-recalculate-line)
1611 (org-table-insert-hline)
1612 (end-of-line 2)
1613 (if (looking-at "\n[ \t]*|-")
1614 (progn (insert "\n|") (org-table-align))
1615 (org-table-next-field))
1616 (if same-column (org-table-goto-column col))))
1618 (defun org-table-clean-line (s)
1619 "Convert a table line S into a string with only \"|\" and space.
1620 In particular, this does handle wide and invisible characters."
1621 (if (string-match "^[ \t]*|-" s)
1622 ;; It's a hline, just map the characters
1623 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
1624 (while (string-match "|\\([ \t]*?[^ \t\r\n|][^\r\n|]*\\)|" s)
1625 (setq s (replace-match
1626 (concat "|" (make-string (org-string-width (match-string 1 s))
1627 ?\ ) "|")
1628 t t s)))
1631 ;;;###autoload
1632 (defun org-table-kill-row ()
1633 "Delete the current row or horizontal line from the table."
1634 (interactive)
1635 (if (not (org-at-table-p))
1636 (user-error "Not at a table"))
1637 (let ((col (current-column))
1638 (dline (org-table-current-dline)))
1639 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
1640 (if (not (org-at-table-p)) (beginning-of-line 0))
1641 (org-move-to-column col)
1642 (when (or (not org-table-fix-formulas-confirm)
1643 (funcall org-table-fix-formulas-confirm "Fix formulas? "))
1644 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
1645 dline -1 dline))))
1647 ;;;###autoload
1648 (defun org-table-sort-lines (with-case &optional sorting-type getkey-func compare-func)
1649 "Sort table lines according to the column at point.
1651 The position of point indicates the column to be used for
1652 sorting, and the range of lines is the range between the nearest
1653 horizontal separator lines, or the entire table of no such lines
1654 exist. If point is before the first column, you will be prompted
1655 for the sorting column. If there is an active region, the mark
1656 specifies the first line and the sorting column, while point
1657 should be in the last line to be included into the sorting.
1659 The command then prompts for the sorting type which can be
1660 alphabetically, numerically, or by time (as given in a time stamp
1661 in the field, or as a HH:MM value). Sorting in reverse order is
1662 also possible.
1664 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1666 If SORTING-TYPE is specified when this function is called from a Lisp
1667 program, no prompting will take place. SORTING-TYPE must be a character,
1668 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1669 sorting should be done in reverse order.
1671 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1672 a function to be called to extract the key. It must return either
1673 a string or a number that should serve as the sorting key for that
1674 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1675 is specified interactively, the comparison will be either a string or
1676 numeric compare based on the type of the first key in the table."
1677 (interactive "P")
1678 (when (org-region-active-p) (goto-char (region-beginning)))
1679 ;; Point must be either within a field or before a data line.
1680 (save-excursion
1681 (skip-chars-backward " \t")
1682 (when (bolp) (search-forward "|" (line-end-position) t))
1683 (org-table-check-inside-data-field))
1684 ;; Set appropriate case sensitivity and column used for sorting.
1685 (let ((column (let ((c (org-table-current-column)))
1686 (cond ((> c 0) c)
1687 ((called-interactively-p 'any)
1688 (read-number "Use column N for sorting: "))
1689 (t 1))))
1690 (sorting-type
1691 (or sorting-type
1692 (read-char-exclusive "Sort Table: [a]lphabetic, [n]umeric, \
1693 \[t]ime, [f]unc. A/N/T/F means reversed: "))))
1694 (save-restriction
1695 ;; Narrow buffer to appropriate sorting area.
1696 (if (org-region-active-p)
1697 (progn (goto-char (region-beginning))
1698 (narrow-to-region
1699 (point)
1700 (save-excursion (goto-char (region-end))
1701 (line-beginning-position 2))))
1702 (let ((start (org-table-begin))
1703 (end (org-table-end)))
1704 (narrow-to-region
1705 (save-excursion
1706 (if (re-search-backward org-table-hline-regexp start t)
1707 (line-beginning-position 2)
1708 start))
1709 (if (save-excursion (re-search-forward org-table-hline-regexp end t))
1710 (match-beginning 0)
1711 end))))
1712 ;; Determine arguments for `sort-subr'. Also record original
1713 ;; position. `org-table-save-field' cannot help here since
1714 ;; sorting is too much destructive.
1715 (let* ((sort-fold-case (not with-case))
1716 (coordinates
1717 (cons (count-lines (point-min) (line-beginning-position))
1718 (current-column)))
1719 (extract-key-from-field
1720 ;; Function to be called on the contents of the field
1721 ;; used for sorting in the current row.
1722 (cl-case sorting-type
1723 ((?n ?N) #'string-to-number)
1724 ((?a ?A) #'org-sort-remove-invisible)
1725 ((?t ?T)
1726 (lambda (f)
1727 (cond ((string-match org-ts-regexp-both f)
1728 (float-time
1729 (org-time-string-to-time (match-string 0 f))))
1730 ((string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" f)
1731 (org-hh:mm-string-to-minutes f))
1732 (t 0))))
1733 ((?f ?F)
1734 (or getkey-func
1735 (and (called-interactively-p 'any)
1736 (intern
1737 (completing-read "Sort using function: "
1738 obarray #'fboundp t)))
1739 (error "Missing key extractor to sort rows")))
1740 (t (user-error "Invalid sorting type `%c'" sorting-type))))
1741 (predicate
1742 (cl-case sorting-type
1743 ((?n ?N ?t ?T) #'<)
1744 ((?a ?A) #'string<)
1745 ((?f ?F) compare-func))))
1746 (goto-char (point-min))
1747 (sort-subr (memq sorting-type '(?A ?N ?T ?F))
1748 (lambda ()
1749 (forward-line)
1750 (while (and (not (eobp))
1751 (not (looking-at org-table-dataline-regexp)))
1752 (forward-line)))
1753 #'end-of-line
1754 (lambda ()
1755 (funcall extract-key-from-field
1756 (org-trim (org-table-get-field column))))
1758 predicate)
1759 ;; Move back to initial field.
1760 (forward-line (car coordinates))
1761 (move-to-column (cdr coordinates))))))
1763 ;;;###autoload
1764 (defun org-table-cut-region (beg end)
1765 "Copy region in table to the clipboard and blank all relevant fields.
1766 If there is no active region, use just the field at point."
1767 (interactive (list
1768 (if (org-region-active-p) (region-beginning) (point))
1769 (if (org-region-active-p) (region-end) (point))))
1770 (org-table-copy-region beg end 'cut))
1772 ;;;###autoload
1773 (defun org-table-copy-region (beg end &optional cut)
1774 "Copy rectangular region in table to clipboard.
1775 A special clipboard is used which can only be accessed
1776 with `org-table-paste-rectangle'."
1777 (interactive (list
1778 (if (org-region-active-p) (region-beginning) (point))
1779 (if (org-region-active-p) (region-end) (point))
1780 current-prefix-arg))
1781 (goto-char (min beg end))
1782 (org-table-check-inside-data-field)
1783 (let ((beg (line-beginning-position))
1784 (c01 (org-table-current-column))
1785 region)
1786 (goto-char (max beg end))
1787 (org-table-check-inside-data-field)
1788 (let* ((end (copy-marker (line-end-position)))
1789 (c02 (org-table-current-column))
1790 (column-start (min c01 c02))
1791 (column-end (max c01 c02))
1792 (column-number (1+ (- column-end column-start)))
1793 (rpl (and cut " ")))
1794 (goto-char beg)
1795 (while (< (point) end)
1796 (unless (org-at-table-hline-p)
1797 ;; Collect every cell between COLUMN-START and COLUMN-END.
1798 (let (cols)
1799 (dotimes (c column-number)
1800 (push (org-table-get-field (+ c column-start) rpl) cols))
1801 (push (nreverse cols) region)))
1802 (forward-line))
1803 (set-marker end nil))
1804 (when cut (org-table-align))
1805 (setq org-table-clip (nreverse region))))
1807 ;;;###autoload
1808 (defun org-table-paste-rectangle ()
1809 "Paste a rectangular region into a table.
1810 The upper right corner ends up in the current field. All involved fields
1811 will be overwritten. If the rectangle does not fit into the present table,
1812 the table is enlarged as needed. The process ignores horizontal separator
1813 lines."
1814 (interactive)
1815 (unless (consp org-table-clip)
1816 (user-error "First cut/copy a region to paste!"))
1817 (org-table-check-inside-data-field)
1818 (let* ((column (org-table-current-column))
1819 (org-enable-table-editor t)
1820 (org-table-automatic-realign nil))
1821 (org-table-save-field
1822 (dolist (row org-table-clip)
1823 (while (org-at-table-hline-p) (forward-line))
1824 ;; If we left the table, create a new row.
1825 (when (and (bolp) (not (looking-at "[ \t]*|")))
1826 (end-of-line 0)
1827 (org-table-next-field))
1828 (let ((c column))
1829 (dolist (field row)
1830 (org-table-goto-column c nil 'force)
1831 (org-table-get-field nil field)
1832 (cl-incf c)))
1833 (forward-line)))
1834 (org-table-align)))
1836 ;;;###autoload
1837 (defun org-table-convert ()
1838 "Convert from `org-mode' table to table.el and back.
1839 Obviously, this only works within limits. When an Org table is converted
1840 to table.el, all horizontal separator lines get lost, because table.el uses
1841 these as cell boundaries and has no notion of horizontal lines. A table.el
1842 table can be converted to an Org table only if it does not do row or column
1843 spanning. Multiline cells will become multiple cells. Beware, Org mode
1844 does not test if the table can be successfully converted - it blindly
1845 applies a recipe that works for simple tables."
1846 (interactive)
1847 (require 'table)
1848 (if (org-at-table.el-p)
1849 ;; convert to Org table
1850 (let ((beg (copy-marker (org-table-begin t)))
1851 (end (copy-marker (org-table-end t))))
1852 (table-unrecognize-region beg end)
1853 (goto-char beg)
1854 (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t)
1855 (replace-match ""))
1856 (goto-char beg))
1857 (if (org-at-table-p)
1858 ;; convert to table.el table
1859 (let ((beg (copy-marker (org-table-begin)))
1860 (end (copy-marker (org-table-end))))
1861 ;; first, get rid of all horizontal lines
1862 (goto-char beg)
1863 (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t)
1864 (replace-match ""))
1865 ;; insert a hline before first
1866 (goto-char beg)
1867 (org-table-insert-hline 'above)
1868 (beginning-of-line -1)
1869 ;; insert a hline after each line
1870 (while (progn (beginning-of-line 3) (< (point) end))
1871 (org-table-insert-hline))
1872 (goto-char beg)
1873 (setq end (move-marker end (org-table-end)))
1874 ;; replace "+" at beginning and ending of hlines
1875 (while (re-search-forward "^\\([ \t]*\\)|-" end t)
1876 (replace-match "\\1+-"))
1877 (goto-char beg)
1878 (while (re-search-forward "-|[ \t]*$" end t)
1879 (replace-match "-+"))
1880 (goto-char beg)))))
1882 (defun org-table-transpose-table-at-point ()
1883 "Transpose Org table at point and eliminate hlines.
1884 So a table like
1886 | 1 | 2 | 4 | 5 |
1887 |---+---+---+---|
1888 | a | b | c | d |
1889 | e | f | g | h |
1891 will be transposed as
1893 | 1 | a | e |
1894 | 2 | b | f |
1895 | 4 | c | g |
1896 | 5 | d | h |
1898 Note that horizontal lines disappear."
1899 (interactive)
1900 (let* ((table (delete 'hline (org-table-to-lisp)))
1901 (dline_old (org-table-current-line))
1902 (col_old (org-table-current-column))
1903 (contents (mapcar (lambda (_)
1904 (let ((tp table))
1905 (mapcar
1906 (lambda (_)
1907 (prog1
1908 (pop (car tp))
1909 (setq tp (cdr tp))))
1910 table)))
1911 (car table))))
1912 (goto-char (org-table-begin))
1913 (re-search-forward "|")
1914 (backward-char)
1915 (delete-region (point) (org-table-end))
1916 (insert (mapconcat
1917 (lambda(x)
1918 (concat "| " (mapconcat 'identity x " | " ) " |\n" ))
1919 contents ""))
1920 (org-table-goto-line col_old)
1921 (org-table-goto-column dline_old))
1922 (org-table-align))
1924 ;;;###autoload
1925 (defun org-table-wrap-region (arg)
1926 "Wrap several fields in a column like a paragraph.
1927 This is useful if you'd like to spread the contents of a field over several
1928 lines, in order to keep the table compact.
1930 If there is an active region, and both point and mark are in the same column,
1931 the text in the column is wrapped to minimum width for the given number of
1932 lines. Generally, this makes the table more compact. A prefix ARG may be
1933 used to change the number of desired lines. For example, \
1934 `C-2 \\[org-table-wrap-region]'
1935 formats the selected text to two lines. If the region was longer than two
1936 lines, the remaining lines remain empty. A negative prefix argument reduces
1937 the current number of lines by that amount. The wrapped text is pasted back
1938 into the table. If you formatted it to more lines than it was before, fields
1939 further down in the table get overwritten - so you might need to make space in
1940 the table first.
1942 If there is no region, the current field is split at the cursor position and
1943 the text fragment to the right of the cursor is prepended to the field one
1944 line down.
1946 If there is no region, but you specify a prefix ARG, the current field gets
1947 blank, and the content is appended to the field above."
1948 (interactive "P")
1949 (org-table-check-inside-data-field)
1950 (if (org-region-active-p)
1951 ;; There is a region: fill as a paragraph.
1952 (let ((start (region-beginning)))
1953 (org-table-cut-region (region-beginning) (region-end))
1954 (when (> (length (car org-table-clip)) 1)
1955 (user-error "Region must be limited to single column"))
1956 (let ((nlines (cond ((not arg) (length org-table-clip))
1957 ((< arg 1) (+ (length org-table-clip) arg))
1958 (t arg))))
1959 (setq org-table-clip
1960 (mapcar #'list
1961 (org-wrap (mapconcat #'car org-table-clip " ")
1963 nlines))))
1964 (goto-char start)
1965 (org-table-paste-rectangle))
1966 ;; No region, split the current field at point.
1967 (unless (org-get-alist-option org-M-RET-may-split-line 'table)
1968 (skip-chars-forward "^\r\n|"))
1969 (cond
1970 (arg ; Combine with field above.
1971 (let ((s (org-table-blank-field))
1972 (col (org-table-current-column)))
1973 (forward-line -1)
1974 (while (org-at-table-hline-p) (forward-line -1))
1975 (org-table-goto-column col)
1976 (skip-chars-forward "^|")
1977 (skip-chars-backward " ")
1978 (insert " " (org-trim s))
1979 (org-table-align)))
1980 ((looking-at "\\([^|]+\\)+|") ; Split field.
1981 (let ((s (match-string 1)))
1982 (replace-match " |")
1983 (goto-char (match-beginning 0))
1984 (org-table-next-row)
1985 (insert (org-trim s) " ")
1986 (org-table-align)))
1987 (t (org-table-next-row)))))
1989 (defvar org-field-marker nil)
1991 ;;;###autoload
1992 (defun org-table-edit-field (arg)
1993 "Edit table field in a different window.
1994 This is mainly useful for fields that contain hidden parts. When called
1995 with a `\\[universal-argument]' prefix, just make the full field \
1996 visible so that it can be
1997 edited in place."
1998 (interactive "P")
1999 (cond
2000 ((equal arg '(16))
2001 (org-table-follow-field-mode (if org-table-follow-field-mode -1 1)))
2002 (arg
2003 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
2004 (e (save-excursion (skip-chars-forward "^|\r\n") (point))))
2005 (remove-text-properties b e '(org-cwidth t invisible t
2006 display t intangible t))
2007 (if (and (boundp 'font-lock-mode) font-lock-mode)
2008 (font-lock-fontify-block))))
2010 (let ((pos (point-marker))
2011 (coord
2012 (if (eq org-table-use-standard-references t)
2013 (concat (org-number-to-letters (org-table-current-column))
2014 (int-to-string (org-table-current-dline)))
2015 (concat "@" (int-to-string (org-table-current-dline))
2016 "$" (int-to-string (org-table-current-column)))))
2017 (field (org-table-get-field))
2018 (cw (current-window-configuration))
2020 (goto-char pos)
2021 (org-switch-to-buffer-other-window "*Org Table Edit Field*")
2022 (when (and (local-variable-p 'org-field-marker)
2023 (markerp org-field-marker))
2024 (move-marker org-field-marker nil))
2025 (erase-buffer)
2026 (insert "#\n# Edit field " coord " and finish with C-c C-c\n#\n")
2027 (let ((org-inhibit-startup t)) (org-mode))
2028 (auto-fill-mode -1)
2029 (setq truncate-lines nil)
2030 (setq word-wrap t)
2031 (goto-char (setq p (point-max)))
2032 (insert (org-trim field))
2033 (remove-text-properties p (point-max)
2034 '(invisible t org-cwidth t display t
2035 intangible t))
2036 (goto-char p)
2037 (setq-local org-finish-function 'org-table-finish-edit-field)
2038 (setq-local org-window-configuration cw)
2039 (setq-local org-field-marker pos)
2040 (message "Edit and finish with C-c C-c")))))
2042 (defun org-table-finish-edit-field ()
2043 "Finish editing a table data field.
2044 Remove all newline characters, insert the result into the table, realign
2045 the table and kill the editing buffer."
2046 (let ((pos org-field-marker)
2047 (cw org-window-configuration)
2048 (cb (current-buffer))
2049 text)
2050 (goto-char (point-min))
2051 (while (re-search-forward "^#.*\n?" nil t) (replace-match ""))
2052 (while (re-search-forward "\\([ \t]*\n[ \t]*\\)+" nil t)
2053 (replace-match " "))
2054 (setq text (org-trim (buffer-string)))
2055 (set-window-configuration cw)
2056 (kill-buffer cb)
2057 (select-window (get-buffer-window (marker-buffer pos)))
2058 (goto-char pos)
2059 (move-marker pos nil)
2060 (org-table-check-inside-data-field)
2061 (org-table-get-field nil text)
2062 (org-table-align)
2063 (message "New field value inserted")))
2065 (define-minor-mode org-table-follow-field-mode
2066 "Minor mode to make the table field editor window follow the cursor.
2067 When this mode is active, the field editor window will always show the
2068 current field. The mode exits automatically when the cursor leaves the
2069 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2070 nil " TblFollow" nil
2071 (if org-table-follow-field-mode
2072 (add-hook 'post-command-hook 'org-table-follow-fields-with-editor
2073 'append 'local)
2074 (remove-hook 'post-command-hook 'org-table-follow-fields-with-editor 'local)
2075 (let* ((buf (get-buffer "*Org Table Edit Field*"))
2076 (win (and buf (get-buffer-window buf))))
2077 (when win (delete-window win))
2078 (when buf
2079 (with-current-buffer buf
2080 (move-marker org-field-marker nil))
2081 (kill-buffer buf)))))
2083 (defun org-table-follow-fields-with-editor ()
2084 (if (and org-table-exit-follow-field-mode-when-leaving-table
2085 (not (org-at-table-p)))
2086 ;; We have left the table, exit the follow mode
2087 (org-table-follow-field-mode -1)
2088 (when (org-table-check-inside-data-field 'noerror)
2089 (let ((win (selected-window)))
2090 (org-table-edit-field nil)
2091 (org-fit-window-to-buffer)
2092 (select-window win)))))
2094 (defvar org-timecnt) ; dynamically scoped parameter
2096 ;;;###autoload
2097 (defun org-table-sum (&optional beg end nlast)
2098 "Sum numbers in region of current table column.
2099 The result will be displayed in the echo area, and will be available
2100 as kill to be inserted with \\[yank].
2102 If there is an active region, it is interpreted as a rectangle and all
2103 numbers in that rectangle will be summed. If there is no active
2104 region and point is located in a table column, sum all numbers in that
2105 column.
2107 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2108 numbers are assumed to be times as well (in decimal hours) and the
2109 numbers are added as such.
2111 If NLAST is a number, only the NLAST fields will actually be summed."
2112 (interactive)
2113 (save-excursion
2114 (let (col (org-timecnt 0) diff h m s org-table-clip)
2115 (cond
2116 ((and beg end)) ; beg and end given explicitly
2117 ((org-region-active-p)
2118 (setq beg (region-beginning) end (region-end)))
2120 (setq col (org-table-current-column))
2121 (goto-char (org-table-begin))
2122 (unless (re-search-forward "^[ \t]*|[^-]" nil t)
2123 (user-error "No table data"))
2124 (org-table-goto-column col)
2125 (setq beg (point))
2126 (goto-char (org-table-end))
2127 (unless (re-search-backward "^[ \t]*|[^-]" nil t)
2128 (user-error "No table data"))
2129 (org-table-goto-column col)
2130 (setq end (point))))
2131 (let* ((items (apply 'append (org-table-copy-region beg end)))
2132 (items1 (cond ((not nlast) items)
2133 ((>= nlast (length items)) items)
2134 (t (setq items (reverse items))
2135 (setcdr (nthcdr (1- nlast) items) nil)
2136 (nreverse items))))
2137 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
2138 items1)))
2139 (res (apply '+ numbers))
2140 (sres (if (= org-timecnt 0)
2141 (number-to-string res)
2142 (setq diff (* 3600 res)
2143 h (floor (/ diff 3600)) diff (mod diff 3600)
2144 m (floor (/ diff 60)) diff (mod diff 60)
2145 s diff)
2146 (format "%.0f:%02.0f:%02.0f" h m s))))
2147 (kill-new sres)
2148 (when (called-interactively-p 'interactive)
2149 (message "%s" (substitute-command-keys
2150 (format "Sum of %d items: %-20s \
2151 \(\\[yank] will insert result into buffer)" (length numbers) sres))))
2152 sres))))
2154 (defun org-table-get-number-for-summing (s)
2155 (let (n)
2156 (if (string-match "^ *|? *" s)
2157 (setq s (replace-match "" nil nil s)))
2158 (if (string-match " *|? *$" s)
2159 (setq s (replace-match "" nil nil s)))
2160 (setq n (string-to-number s))
2161 (cond
2162 ((and (string-match "0" s)
2163 (string-match "\\`[-+ \t0.edED]+\\'" s)) 0)
2164 ((string-match "\\`[ \t]+\\'" s) nil)
2165 ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s)
2166 (let ((h (string-to-number (or (match-string 1 s) "0")))
2167 (m (string-to-number (or (match-string 2 s) "0")))
2168 (s (string-to-number (or (match-string 4 s) "0"))))
2169 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
2170 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
2171 ((equal n 0) nil)
2172 (t n))))
2174 (defun org-table-current-field-formula (&optional key noerror)
2175 "Return the formula active for the current field.
2177 Assumes that table is already analyzed. If KEY is given, return
2178 the key to this formula. Otherwise return the formula preceded
2179 with \"=\" or \":=\"."
2180 (let* ((line (count-lines org-table-current-begin-pos
2181 (line-beginning-position)))
2182 (row (org-table-line-to-dline line)))
2183 (cond
2184 (row
2185 (let* ((col (org-table-current-column))
2186 (name (car (rassoc (list line col)
2187 org-table-named-field-locations)))
2188 (scol (format "$%d" col))
2189 (ref (format "@%d$%d" (org-table-current-dline) col))
2190 (stored-list (org-table-get-stored-formulas noerror))
2191 (ass (or (assoc name stored-list)
2192 (assoc ref stored-list)
2193 (assoc scol stored-list))))
2194 (cond (key (car ass))
2195 (ass (concat (if (string-match-p "^[0-9]+$" (car ass)) "=" ":=")
2196 (cdr ass))))))
2197 (noerror nil)
2198 (t (error "No formula active for the current field")))))
2200 (defun org-table-get-formula (&optional equation named)
2201 "Read a formula from the minibuffer, offer stored formula as default.
2202 When NAMED is non-nil, look for a named equation."
2203 (let* ((stored-list (org-table-get-stored-formulas))
2204 (name (car (rassoc (list (count-lines org-table-current-begin-pos
2205 (line-beginning-position))
2206 (org-table-current-column))
2207 org-table-named-field-locations)))
2208 (ref (format "@%d$%d"
2209 (org-table-current-dline)
2210 (org-table-current-column)))
2211 (scol (cond
2212 ((not named) (format "$%d" (org-table-current-column)))
2213 ((and name (not (string-match "\\`LR[0-9]+\\'" name))) name)
2214 (t ref)))
2215 (name (or name ref))
2216 (org-table-may-need-update nil)
2217 (stored (cdr (assoc scol stored-list)))
2218 (eq (cond
2219 ((and stored equation (string-match-p "^ *=? *$" equation))
2220 stored)
2221 ((stringp equation)
2222 equation)
2223 (t (org-table-formula-from-user
2224 (read-string
2225 (org-table-formula-to-user
2226 (format "%s formula %s="
2227 (if named "Field" "Column")
2228 scol))
2229 (if stored (org-table-formula-to-user stored) "")
2230 'org-table-formula-history
2231 )))))
2232 mustsave)
2233 (when (not (string-match "\\S-" eq))
2234 ;; remove formula
2235 (setq stored-list (delq (assoc scol stored-list) stored-list))
2236 (org-table-store-formulas stored-list)
2237 (user-error "Formula removed"))
2238 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
2239 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
2240 (if (and name (not named))
2241 ;; We set the column equation, delete the named one.
2242 (setq stored-list (delq (assoc name stored-list) stored-list)
2243 mustsave t))
2244 (if stored
2245 (setcdr (assoc scol stored-list) eq)
2246 (setq stored-list (cons (cons scol eq) stored-list)))
2247 (if (or mustsave (not (equal stored eq)))
2248 (org-table-store-formulas stored-list))
2249 eq))
2251 (defun org-table-store-formulas (alist &optional location)
2252 "Store the list of formulas below the current table.
2253 If optional argument LOCATION is a buffer position, insert it at
2254 LOCATION instead."
2255 (save-excursion
2256 (if location
2257 (progn (goto-char location) (beginning-of-line))
2258 (goto-char (org-table-end)))
2259 (let ((case-fold-search t))
2260 (if (looking-at "\\([ \t]*\n\\)*[ \t]*\\(#\\+TBLFM:\\)\\(.*\n?\\)")
2261 (progn
2262 ;; Don't overwrite TBLFM, we might use text properties to
2263 ;; store stuff.
2264 (goto-char (match-beginning 3))
2265 (delete-region (match-beginning 3) (match-end 0)))
2266 (org-indent-line)
2267 (insert (or (match-string 2) "#+TBLFM:")))
2268 (insert " "
2269 (mapconcat (lambda (x) (concat (car x) "=" (cdr x)))
2270 (sort alist #'org-table-formula-less-p)
2271 "::")
2272 "\n"))))
2274 (defsubst org-table-formula-make-cmp-string (a)
2275 (when (string-match "\\`$[<>]" a)
2276 (let ((arrow (string-to-char (substring a 1))))
2277 ;; Fake a high number to make sure this is sorted at the end.
2278 (setq a (org-table-formula-handle-first/last-rc a))
2279 (setq a (format "$%d" (+ 10000
2280 (if (= arrow ?<) -1000 0)
2281 (string-to-number (substring a 1)))))))
2282 (when (string-match
2283 "^\\(@\\([0-9]+\\)\\)?\\(\\$?\\([0-9]+\\)\\)?\\(\\$?[a-zA-Z0-9]+\\)?"
2285 (concat
2286 (if (match-end 2)
2287 (format "@%05d" (string-to-number (match-string 2 a))) "")
2288 (if (match-end 4)
2289 (format "$%05d" (string-to-number (match-string 4 a))) "")
2290 (if (match-end 5)
2291 (concat "@@" (match-string 5 a))))))
2293 (defun org-table-formula-less-p (a b)
2294 "Compare two formulas for sorting."
2295 (let ((as (org-table-formula-make-cmp-string (car a)))
2296 (bs (org-table-formula-make-cmp-string (car b))))
2297 (and as bs (string< as bs))))
2299 ;;;###autoload
2300 (defun org-table-get-stored-formulas (&optional noerror location)
2301 "Return an alist with the stored formulas directly after current table.
2302 By default, only return active formulas, i.e., formulas located
2303 on the first line after the table. However, if optional argument
2304 LOCATION is a buffer position, consider the formulas there."
2305 (save-excursion
2306 (if location
2307 (progn (goto-char location) (beginning-of-line))
2308 (goto-char (org-table-end)))
2309 (let ((case-fold-search t))
2310 (when (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM: *\\(.*\\)")
2311 (let ((strings (org-split-string (match-string-no-properties 2)
2312 " *:: *"))
2313 eq-alist seen)
2314 (dolist (string strings (nreverse eq-alist))
2315 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|\\$\\([_a-zA-Z0-9]+\\|\
2316 [<>]+\\)\\) *= *\\(.*[^ \t]\\)"
2317 string)
2318 (let ((lhs
2319 (let ((m (match-string 1 string)))
2320 (cond
2321 ((not (match-end 2)) m)
2322 ;; Is it a column reference?
2323 ((string-match-p "\\`$\\([0-9]+\\|[<>]+\\)\\'" m) m)
2324 ;; Since named columns are not possible in
2325 ;; LHS, assume this is a named field.
2326 (t (match-string 2 string)))))
2327 (rhs (match-string 3 string)))
2328 (push (cons lhs rhs) eq-alist)
2329 (cond
2330 ((not (member lhs seen)) (push lhs seen))
2331 (noerror
2332 (message
2333 "Double definition `%s=' in TBLFM line, please fix by hand"
2334 lhs)
2335 (ding)
2336 (sit-for 2))
2338 (user-error
2339 "Double definition `%s=' in TBLFM line, please fix by hand"
2340 lhs)))))))))))
2342 (defun org-table-fix-formulas (key replace &optional limit delta remove)
2343 "Modify the equations after the table structure has been edited.
2344 KEY is \"@\" or \"$\". REPLACE is an alist of numbers to replace.
2345 For all numbers larger than LIMIT, shift them by DELTA."
2346 (save-excursion
2347 (goto-char (org-table-end))
2348 (while (let ((case-fold-search t)) (looking-at "[ \t]*#\\+tblfm:"))
2349 (let ((msg "The formulas in #+TBLFM have been updated")
2350 (re (concat key "\\([0-9]+\\)"))
2351 (re2
2352 (when remove
2353 (if (or (equal key "$") (equal key "$LR"))
2354 (format "\\(@[0-9]+\\)?%s%d=.*?\\(::\\|$\\)"
2355 (regexp-quote key) remove)
2356 (format "@%d\\$[0-9]+=.*?\\(::\\|$\\)" remove))))
2357 s n a)
2358 (when remove
2359 (while (re-search-forward re2 (point-at-eol) t)
2360 (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
2361 (if (equal (char-before (match-beginning 0)) ?.)
2362 (user-error
2363 "Change makes TBLFM term %s invalid, use undo to recover"
2364 (match-string 0))
2365 (replace-match "")))))
2366 (while (re-search-forward re (point-at-eol) t)
2367 (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
2368 (setq s (match-string 1) n (string-to-number s))
2369 (cond
2370 ((setq a (assoc s replace))
2371 (replace-match (concat key (cdr a)) t t)
2372 (message msg))
2373 ((and limit (> n limit))
2374 (replace-match (concat key (int-to-string (+ n delta))) t t)
2375 (message msg))))))
2376 (forward-line))))
2378 ;;;###autoload
2379 (defun org-table-maybe-eval-formula ()
2380 "Check if the current field starts with \"=\" or \":=\".
2381 If yes, store the formula and apply it."
2382 ;; We already know we are in a table. Get field will only return a formula
2383 ;; when appropriate. It might return a separator line, but no problem.
2384 (when org-table-formula-evaluate-inline
2385 (let* ((field (org-trim (or (org-table-get-field) "")))
2386 named eq)
2387 (when (string-match "^:?=\\(.*[^=]\\)$" field)
2388 (setq named (equal (string-to-char field) ?:)
2389 eq (match-string 1 field))
2390 (org-table-eval-formula (and named '(4))
2391 (org-table-formula-from-user eq))))))
2393 (defvar org-recalc-commands nil
2394 "List of commands triggering the recalculation of a line.
2395 Will be filled automatically during use.")
2397 (defvar org-recalc-marks
2398 '((" " . "Unmarked: no special line, no automatic recalculation")
2399 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
2400 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
2401 ("!" . "Column name definition line. Reference in formula as $name.")
2402 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
2403 ("_" . "Names for values in row below this one.")
2404 ("^" . "Names for values in row above this one.")))
2406 ;;;###autoload
2407 (defun org-table-rotate-recalc-marks (&optional newchar)
2408 "Rotate the recalculation mark in the first column.
2409 If in any row, the first field is not consistent with a mark,
2410 insert a new column for the markers.
2411 When there is an active region, change all the lines in the region,
2412 after prompting for the marking character.
2413 After each change, a message will be displayed indicating the meaning
2414 of the new mark."
2415 (interactive)
2416 (unless (org-at-table-p) (user-error "Not at a table"))
2417 (let* ((region (org-region-active-p))
2418 (l1 (and region
2419 (save-excursion (goto-char (region-beginning))
2420 (copy-marker (line-beginning-position)))))
2421 (l2 (and region
2422 (save-excursion (goto-char (region-end))
2423 (copy-marker (line-beginning-position)))))
2424 (l (copy-marker (line-beginning-position)))
2425 (col (org-table-current-column))
2426 (newchar (if region
2427 (char-to-string
2428 (read-char-exclusive
2429 "Change region to what mark? Type # * ! $ or SPC: "))
2430 newchar))
2431 (no-special-column
2432 (save-excursion
2433 (goto-char (org-table-begin))
2434 (re-search-forward
2435 "^[ \t]*|[^-|][^|]*[^#!$*_^| \t][^|]*|" (org-table-end) t))))
2436 (when (and newchar (not (assoc newchar org-recalc-marks)))
2437 (user-error "Invalid character `%s' in `org-table-rotate-recalc-marks'"
2438 newchar))
2439 (when l1 (goto-char l1))
2440 (save-excursion
2441 (beginning-of-line)
2442 (unless (looking-at org-table-dataline-regexp)
2443 (user-error "Not at a table data line")))
2444 (when no-special-column
2445 (org-table-goto-column 1)
2446 (org-table-insert-column))
2447 (let ((previous-line-end (line-end-position))
2448 (newchar
2449 (save-excursion
2450 (beginning-of-line)
2451 (cond ((not (looking-at "^[ \t]*| *\\([#!$*^_ ]\\) *|")) "#")
2452 (newchar)
2453 (t (cadr (member (match-string 1)
2454 (append (mapcar #'car org-recalc-marks)
2455 '(" ")))))))))
2456 ;; Rotate mark in first row.
2457 (org-table-get-field 1 (format " %s " newchar))
2458 ;; Rotate marks in additional rows if a region is active.
2459 (when region
2460 (save-excursion
2461 (forward-line)
2462 (while (<= (point) l2)
2463 (when (looking-at org-table-dataline-regexp)
2464 (org-table-get-field 1 (format " %s " newchar)))
2465 (forward-line))))
2466 ;; Only align if rotation actually changed lines' length.
2467 (when (/= previous-line-end (line-end-position)) (org-table-align)))
2468 (goto-char l)
2469 (org-table-goto-column (if no-special-column (1+ col) col))
2470 (when l1 (set-marker l1 nil))
2471 (when l2 (set-marker l2 nil))
2472 (set-marker l nil)
2473 (when (called-interactively-p 'interactive)
2474 (message "%s" (cdr (assoc newchar org-recalc-marks))))))
2476 ;;;###autoload
2477 (defun org-table-analyze ()
2478 "Analyze table at point and store results.
2480 This function sets up the following dynamically scoped variables:
2482 `org-table-column-name-regexp',
2483 `org-table-column-names',
2484 `org-table-current-begin-pos',
2485 `org-table-current-line-types',
2486 `org-table-current-ncol',
2487 `org-table-dlines',
2488 `org-table-hlines',
2489 `org-table-local-parameters',
2490 `org-table-named-field-locations'."
2491 (let ((beg (org-table-begin))
2492 (end (org-table-end)))
2493 (save-excursion
2494 (goto-char beg)
2495 ;; Extract column names.
2496 (setq org-table-column-names nil)
2497 (when (save-excursion
2498 (re-search-forward "^[ \t]*| *! *\\(|.*\\)" end t))
2499 (let ((c 1))
2500 (dolist (name (org-split-string (match-string 1) " *| *"))
2501 (cl-incf c)
2502 (when (string-match "\\`[a-zA-Z][_a-zA-Z0-9]*\\'" name)
2503 (push (cons name (int-to-string c)) org-table-column-names)))))
2504 (setq org-table-column-names (nreverse org-table-column-names))
2505 (setq org-table-column-name-regexp
2506 (format "\\$\\(%s\\)\\>"
2507 (regexp-opt (mapcar #'car org-table-column-names) t)))
2508 ;; Extract local parameters.
2509 (setq org-table-local-parameters nil)
2510 (save-excursion
2511 (while (re-search-forward "^[ \t]*| *\\$ *\\(|.*\\)" end t)
2512 (dolist (field (org-split-string (match-string 1) " *| *"))
2513 (when (string-match
2514 "\\`\\([a-zA-Z][_a-zA-Z0-9]*\\|%\\) *= *\\(.*\\)" field)
2515 (push (cons (match-string 1 field) (match-string 2 field))
2516 org-table-local-parameters)))))
2517 ;; Update named fields locations. We minimize `count-lines'
2518 ;; processing by storing last known number of lines in LAST.
2519 (setq org-table-named-field-locations nil)
2520 (save-excursion
2521 (let ((last (cons (point) 0)))
2522 (while (re-search-forward "^[ \t]*| *\\([_^]\\) *\\(|.*\\)" end t)
2523 (let ((c (match-string 1))
2524 (fields (org-split-string (match-string 2) " *| *")))
2525 (save-excursion
2526 (forward-line (if (equal c "_") 1 -1))
2527 (let ((fields1
2528 (and (looking-at "^[ \t]*|[^|]*\\(|.*\\)")
2529 (org-split-string (match-string 1) " *| *")))
2530 (line (cl-incf (cdr last) (count-lines (car last) (point))))
2531 (col 1))
2532 (setcar last (point)) ; Update last known position.
2533 (while (and fields fields1)
2534 (let ((field (pop fields))
2535 (v (pop fields1)))
2536 (cl-incf col)
2537 (when (and (stringp field)
2538 (stringp v)
2539 (string-match "\\`[a-zA-Z][_a-zA-Z0-9]*\\'"
2540 field))
2541 (push (cons field v) org-table-local-parameters)
2542 (push (list field line col)
2543 org-table-named-field-locations))))))))))
2544 ;; Re-use existing markers when possible.
2545 (if (markerp org-table-current-begin-pos)
2546 (move-marker org-table-current-begin-pos (point))
2547 (setq org-table-current-begin-pos (point-marker)))
2548 ;; Analyze the line types.
2549 (let ((l 0) hlines dlines types)
2550 (while (looking-at "[ \t]*|\\(-\\)?")
2551 (push (if (match-end 1) 'hline 'dline) types)
2552 (if (match-end 1) (push l hlines) (push l dlines))
2553 (forward-line)
2554 (cl-incf l))
2555 (push 'hline types) ; Add an imaginary extra hline to the end.
2556 (setq org-table-current-line-types (apply #'vector (nreverse types)))
2557 (setq org-table-dlines (apply #'vector (cons nil (nreverse dlines))))
2558 (setq org-table-hlines (apply #'vector (cons nil (nreverse hlines)))))
2559 ;; Get the number of columns from the first data line in table.
2560 (goto-char beg)
2561 (forward-line (aref org-table-dlines 1))
2562 (let* ((fields
2563 (org-split-string
2564 (buffer-substring (line-beginning-position) (line-end-position))
2565 "[ \t]*|[ \t]*"))
2566 (nfields (length fields))
2567 al al2)
2568 (setq org-table-current-ncol nfields)
2569 (let ((last-dline
2570 (aref org-table-dlines (1- (length org-table-dlines)))))
2571 (dotimes (i nfields)
2572 (let ((column (1+ i)))
2573 (push (list (format "LR%d" column) last-dline column) al)
2574 (push (cons (format "LR%d" column) (nth i fields)) al2))))
2575 (setq org-table-named-field-locations
2576 (append org-table-named-field-locations al))
2577 (setq org-table-local-parameters
2578 (append org-table-local-parameters al2))))))
2580 (defun org-table-goto-field (ref &optional create-column-p)
2581 "Move point to a specific field in the current table.
2583 REF is either the name of a field its absolute reference, as
2584 a string. No column is created unless CREATE-COLUMN-P is
2585 non-nil. If it is a function, it is called with the column
2586 number as its argument as is used as a predicate to know if the
2587 column can be created.
2589 This function assumes the table is already analyzed (i.e., using
2590 `org-table-analyze')."
2591 (let* ((coordinates
2592 (cond
2593 ((cdr (assoc ref org-table-named-field-locations)))
2594 ((string-match "\\`@\\([1-9][0-9]*\\)\\$\\([1-9][0-9]*\\)\\'" ref)
2595 (list (condition-case nil
2596 (aref org-table-dlines
2597 (string-to-number (match-string 1 ref)))
2598 (error (user-error "Invalid row number in %s" ref)))
2599 (string-to-number (match-string 2 ref))))
2600 (t (user-error "Unknown field: %s" ref))))
2601 (line (car coordinates))
2602 (column (nth 1 coordinates))
2603 (create-new-column (if (functionp create-column-p)
2604 (funcall create-column-p column)
2605 create-column-p)))
2606 (when coordinates
2607 (goto-char org-table-current-begin-pos)
2608 (forward-line line)
2609 (org-table-goto-column column nil create-new-column))))
2611 ;;;###autoload
2612 (defun org-table-maybe-recalculate-line ()
2613 "Recompute the current line if marked for it, and if we haven't just done it."
2614 (interactive)
2615 (and org-table-allow-automatic-line-recalculation
2616 (not (and (memq last-command org-recalc-commands)
2617 (eq org-last-recalc-line (line-beginning-position))))
2618 (save-excursion (beginning-of-line 1)
2619 (looking-at org-table-auto-recalculate-regexp))
2620 (org-table-recalculate) t))
2622 (defvar org-tbl-calc-modes) ;; Dynamically bound in `org-table-eval-formula'
2623 (defsubst org-set-calc-mode (var &optional value)
2624 (if (stringp var)
2625 (setq var (assoc var '(("D" calc-angle-mode deg)
2626 ("R" calc-angle-mode rad)
2627 ("F" calc-prefer-frac t)
2628 ("S" calc-symbolic-mode t)))
2629 value (nth 2 var) var (nth 1 var)))
2630 (if (memq var org-tbl-calc-modes)
2631 (setcar (cdr (memq var org-tbl-calc-modes)) value)
2632 (cons var (cons value org-tbl-calc-modes)))
2633 org-tbl-calc-modes)
2635 ;;;###autoload
2636 (defun org-table-eval-formula (&optional arg equation
2637 suppress-align suppress-const
2638 suppress-store suppress-analysis)
2639 "Replace the table field value at the cursor by the result of a calculation.
2641 In a table, this command replaces the value in the current field with the
2642 result of a formula. It also installs the formula as the \"current\" column
2643 formula, by storing it in a special line below the table. When called
2644 with a `\\[universal-argument]' prefix the formula is installed as a \
2645 field formula.
2647 When called with a `\\[universal-argument] \\[universal-argument]' prefix, \
2648 insert the active equation for the field
2649 back into the current field, so that it can be edited there. This is \
2650 useful
2651 in order to use \\<org-table-fedit-map>`\\[org-table-show-reference]' to \
2652 check the referenced fields.
2654 When called, the command first prompts for a formula, which is read in
2655 the minibuffer. Previously entered formulas are available through the
2656 history list, and the last used formula is offered as a default.
2657 These stored formulas are adapted correctly when moving, inserting, or
2658 deleting columns with the corresponding commands.
2660 The formula can be any algebraic expression understood by the Calc package.
2661 For details, see the Org mode manual.
2663 This function can also be called from Lisp programs and offers
2664 additional arguments: EQUATION can be the formula to apply. If this
2665 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2666 used to speed-up recursive calls by by-passing unnecessary aligns.
2667 SUPPRESS-CONST suppresses the interpretation of constants in the
2668 formula, assuming that this has been done already outside the function.
2669 SUPPRESS-STORE means the formula should not be stored, either because
2670 it is already stored, or because it is a modified equation that should
2671 not overwrite the stored one. SUPPRESS-ANALYSIS prevents any call to
2672 `org-table-analyze'."
2673 (interactive "P")
2674 (org-table-check-inside-data-field)
2675 (or suppress-analysis (org-table-analyze))
2676 (if (equal arg '(16))
2677 (let ((eq (org-table-current-field-formula)))
2678 (org-table-get-field nil eq)
2679 (org-table-align)
2680 (setq org-table-may-need-update t))
2681 (let* (fields
2682 (ndown (if (integerp arg) arg 1))
2683 (org-table-automatic-realign nil)
2684 (case-fold-search nil)
2685 (down (> ndown 1))
2686 (formula (if (and equation suppress-store)
2687 equation
2688 (org-table-get-formula equation (equal arg '(4)))))
2689 (n0 (org-table-current-column))
2690 (org-tbl-calc-modes (copy-sequence org-calc-default-modes))
2691 (numbers nil) ; was a variable, now fixed default
2692 (keep-empty nil)
2693 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2694 duration duration-output-format)
2695 ;; Parse the format string. Since we have a lot of modes, this is
2696 ;; a lot of work. However, I think calc still uses most of the time.
2697 (if (string-match ";" formula)
2698 (let ((tmp (org-split-string formula ";")))
2699 (setq formula (car tmp)
2700 fmt (concat (cdr (assoc "%" org-table-local-parameters))
2701 (nth 1 tmp)))
2702 (while (string-match "\\([pnfse]\\)\\(-?[0-9]+\\)" fmt)
2703 (setq c (string-to-char (match-string 1 fmt))
2704 n (string-to-number (match-string 2 fmt)))
2705 (if (= c ?p)
2706 (setq org-tbl-calc-modes (org-set-calc-mode 'calc-internal-prec n))
2707 (setq org-tbl-calc-modes
2708 (org-set-calc-mode
2709 'calc-float-format
2710 (list (cdr (assoc c '((?n . float) (?f . fix)
2711 (?s . sci) (?e . eng))))
2712 n))))
2713 (setq fmt (replace-match "" t t fmt)))
2714 (if (string-match "T" fmt)
2715 (setq duration t numbers t
2716 duration-output-format nil
2717 fmt (replace-match "" t t fmt)))
2718 (if (string-match "t" fmt)
2719 (setq duration t
2720 duration-output-format org-table-duration-custom-format
2721 numbers t
2722 fmt (replace-match "" t t fmt)))
2723 (if (string-match "N" fmt)
2724 (setq numbers t
2725 fmt (replace-match "" t t fmt)))
2726 (if (string-match "L" fmt)
2727 (setq literal t
2728 fmt (replace-match "" t t fmt)))
2729 (if (string-match "E" fmt)
2730 (setq keep-empty t
2731 fmt (replace-match "" t t fmt)))
2732 (while (string-match "[DRFS]" fmt)
2733 (setq org-tbl-calc-modes (org-set-calc-mode (match-string 0 fmt)))
2734 (setq fmt (replace-match "" t t fmt)))
2735 (unless (string-match "\\S-" fmt)
2736 (setq fmt nil))))
2737 (when (and (not suppress-const) org-table-formula-use-constants)
2738 (setq formula (org-table-formula-substitute-names formula)))
2739 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
2740 (setq formula (org-table-formula-handle-first/last-rc formula))
2741 (while (> ndown 0)
2742 (setq fields (org-split-string
2743 (org-trim
2744 (buffer-substring-no-properties
2745 (line-beginning-position) (line-end-position)))
2746 " *| *"))
2747 ;; replace fields with duration values if relevant
2748 (if duration
2749 (setq fields
2750 (mapcar (lambda (x) (org-table-time-string-to-seconds x))
2751 fields)))
2752 (if (eq numbers t)
2753 (setq fields (mapcar
2754 (lambda (x)
2755 (if (string-match "\\S-" x)
2756 (number-to-string (string-to-number x))
2758 fields)))
2759 (setq ndown (1- ndown))
2760 (setq form (copy-sequence formula)
2761 lispp (and (> (length form) 2) (equal (substring form 0 2) "'(")))
2762 (if (and lispp literal) (setq lispp 'literal))
2764 ;; Insert row and column number of formula result field
2765 (while (string-match "[@$]#" form)
2766 (setq form
2767 (replace-match
2768 (format "%d"
2769 (save-match-data
2770 (if (equal (substring form (match-beginning 0)
2771 (1+ (match-beginning 0)))
2772 "@")
2773 (org-table-current-dline)
2774 (org-table-current-column))))
2775 t t form)))
2777 ;; Check for old vertical references
2778 (org-table--error-on-old-row-references form)
2779 ;; Insert remote references
2780 (setq form (org-table-remote-reference-indirection form))
2781 (while (string-match "\\<remote([ \t]*\\([^,)]+\\)[ \t]*,[ \t]*\\([^\n)]+\\))" form)
2782 (setq form
2783 (replace-match
2784 (save-match-data
2785 (org-table-make-reference
2786 (let ((rmtrng (org-table-get-remote-range
2787 (match-string 1 form) (match-string 2 form))))
2788 (if duration
2789 (if (listp rmtrng)
2790 (mapcar (lambda(x) (org-table-time-string-to-seconds x)) rmtrng)
2791 (org-table-time-string-to-seconds rmtrng))
2792 rmtrng))
2793 keep-empty numbers lispp))
2794 t t form)))
2795 ;; Insert complex ranges
2796 (while (and (string-match org-table-range-regexp form)
2797 (> (length (match-string 0 form)) 1))
2798 (setq formrg
2799 (save-match-data
2800 (org-table-get-range
2801 (match-string 0 form) org-table-current-begin-pos n0)))
2802 (setq formrpl
2803 (save-match-data
2804 (org-table-make-reference
2805 ;; possibly handle durations
2806 (if duration
2807 (if (listp formrg)
2808 (mapcar (lambda(x) (org-table-time-string-to-seconds x)) formrg)
2809 (org-table-time-string-to-seconds formrg))
2810 formrg)
2811 keep-empty numbers lispp)))
2812 (if (not (save-match-data
2813 (string-match (regexp-quote form) formrpl)))
2814 (setq form (replace-match formrpl t t form))
2815 (user-error "Spreadsheet error: invalid reference \"%s\"" form)))
2816 ;; Insert simple ranges, i.e. included in the current row.
2817 (while (string-match
2818 "\\$\\(\\([-+]\\)?[0-9]+\\)\\.\\.\\$\\(\\([-+]\\)?[0-9]+\\)"
2819 form)
2820 (setq form
2821 (replace-match
2822 (save-match-data
2823 (org-table-make-reference
2824 (cl-subseq fields
2825 (+ (if (match-end 2) n0 0)
2826 (string-to-number (match-string 1 form))
2828 (+ (if (match-end 4) n0 0)
2829 (string-to-number (match-string 3 form))))
2830 keep-empty numbers lispp))
2831 t t form)))
2832 (setq form0 form)
2833 ;; Insert the references to fields in same row
2834 (while (string-match "\\$\\(\\([-+]\\)?[0-9]+\\)" form)
2835 (setq n (+ (string-to-number (match-string 1 form))
2836 (if (match-end 2) n0 0))
2837 x (nth (1- (if (= n 0) n0 (max n 1))) fields)
2838 formrpl (save-match-data
2839 (org-table-make-reference
2840 x keep-empty numbers lispp)))
2841 (when (or (not x)
2842 (save-match-data
2843 (string-match (regexp-quote formula) formrpl)))
2844 (user-error "Invalid field specifier \"%s\""
2845 (match-string 0 form)))
2846 (setq form (replace-match formrpl t t form)))
2848 (if lispp
2849 (setq ev (condition-case nil
2850 (eval (eval (read form)))
2851 (error "#ERROR"))
2852 ev (if (numberp ev) (number-to-string ev) ev)
2853 ev (if duration (org-table-time-seconds-to-string
2854 (string-to-number ev)
2855 duration-output-format) ev))
2857 ;; Use <...> time-stamps so that Calc can handle them.
2858 (setq form
2859 (replace-regexp-in-string org-ts-regexp-inactive "<\\1>" form))
2860 ;; Internationalize local time-stamps by setting locale to
2861 ;; "C".
2862 (setq form
2863 (replace-regexp-in-string
2864 org-ts-regexp
2865 (lambda (ts)
2866 (let ((system-time-locale "C"))
2867 (format-time-string
2868 (org-time-stamp-format
2869 (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts))
2870 (apply #'encode-time
2871 (save-match-data (org-parse-time-string ts))))))
2872 form t t))
2874 (setq ev (if (and duration (string-match "^[0-9]+:[0-9]+\\(?::[0-9]+\\)?$" form))
2875 form
2876 (calc-eval (cons form org-tbl-calc-modes)
2877 (when (and (not keep-empty) numbers) 'num)))
2878 ev (if duration (org-table-time-seconds-to-string
2879 (if (string-match "^[0-9]+:[0-9]+\\(?::[0-9]+\\)?$" ev)
2880 (string-to-number (org-table-time-string-to-seconds ev))
2881 (string-to-number ev))
2882 duration-output-format)
2883 ev)))
2885 (when org-table-formula-debug
2886 (with-output-to-temp-buffer "*Substitution History*"
2887 (princ (format "Substitution history of formula
2888 Orig: %s
2889 $xyz-> %s
2890 @r$c-> %s
2891 $1-> %s\n" orig formula form0 form))
2892 (if (consp ev)
2893 (princ (format " %s^\nError: %s"
2894 (make-string (car ev) ?\-) (nth 1 ev)))
2895 (princ (format "Result: %s\nFormat: %s\nFinal: %s"
2896 ev (or fmt "NONE")
2897 (if fmt (format fmt (string-to-number ev)) ev)))))
2898 (setq bw (get-buffer-window "*Substitution History*"))
2899 (org-fit-window-to-buffer bw)
2900 (unless (and (called-interactively-p 'any) (not ndown))
2901 (unless (let (inhibit-redisplay)
2902 (y-or-n-p "Debugging Formula. Continue to next? "))
2903 (org-table-align)
2904 (user-error "Abort"))
2905 (delete-window bw)
2906 (message "")))
2907 (when (consp ev) (setq fmt nil ev "#ERROR"))
2908 (org-table-justify-field-maybe
2909 (format org-table-formula-field-format
2910 (if fmt (format fmt (string-to-number ev)) ev)))
2911 (if (and down (> ndown 0) (looking-at ".*\n[ \t]*|[^-]"))
2912 (call-interactively 'org-return)
2913 (setq ndown 0)))
2914 (and down (org-table-maybe-recalculate-line))
2915 (or suppress-align (and org-table-may-need-update
2916 (org-table-align))))))
2918 (defun org-table-put-field-property (prop value)
2919 (save-excursion
2920 (put-text-property (progn (skip-chars-backward "^|") (point))
2921 (progn (skip-chars-forward "^|") (point))
2922 prop value)))
2924 (defun org-table-get-range (desc &optional tbeg col highlight corners-only)
2925 "Get a calc vector from a column, according to descriptor DESC.
2927 Optional arguments TBEG and COL can give the beginning of the table and
2928 the current column, to avoid unnecessary parsing.
2930 HIGHLIGHT means just highlight the range.
2932 When CORNERS-ONLY is set, only return the corners of the range as
2933 a list (line1 column1 line2 column2) where line1 and line2 are
2934 line numbers relative to beginning of table, or TBEG, and column1
2935 and column2 are table column numbers."
2936 (let* ((desc (if (string-match-p "\\`\\$[0-9]+\\.\\.\\$[0-9]+\\'" desc)
2937 (replace-regexp-in-string "\\$" "@0$" desc)
2938 desc))
2939 (col (or col (org-table-current-column)))
2940 (tbeg (or tbeg (org-table-begin)))
2941 (thisline (count-lines tbeg (line-beginning-position))))
2942 (unless (string-match org-table-range-regexp desc)
2943 (user-error "Invalid table range specifier `%s'" desc))
2944 (let ((rangep (match-end 3))
2945 (r1 (let ((r (and (match-end 1) (match-string 1 desc))))
2946 (or (save-match-data
2947 (and (org-string-nw-p r)
2948 (org-table--descriptor-line r thisline)))
2949 thisline)))
2950 (r2 (let ((r (and (match-end 4) (match-string 4 desc))))
2951 (or (save-match-data
2952 (and (org-string-nw-p r)
2953 (org-table--descriptor-line r thisline)))
2954 thisline)))
2955 (c1 (let ((c (and (match-end 2) (substring (match-string 2 desc) 1))))
2956 (if (or (not c) (= (string-to-number c) 0)) col
2957 (+ (string-to-number c)
2958 (if (memq (string-to-char c) '(?- ?+)) col 0)))))
2959 (c2 (let ((c (and (match-end 5) (substring (match-string 5 desc) 1))))
2960 (if (or (not c) (= (string-to-number c) 0)) col
2961 (+ (string-to-number c)
2962 (if (memq (string-to-char c) '(?- ?+)) col 0))))))
2963 (save-excursion
2964 (if (and (not corners-only)
2965 (or (not rangep) (and (= r1 r2) (= c1 c2))))
2966 ;; Just one field.
2967 (progn
2968 (forward-line (- r1 thisline))
2969 (while (not (looking-at org-table-dataline-regexp))
2970 (forward-line))
2971 (prog1 (org-trim (org-table-get-field c1))
2972 (when highlight (org-table-highlight-rectangle))))
2973 ;; A range, return a vector. First sort the numbers to get
2974 ;; a regular rectangle.
2975 (let ((first-row (min r1 r2))
2976 (last-row (max r1 r2))
2977 (first-column (min c1 c2))
2978 (last-column (max c1 c2)))
2979 (if corners-only (list first-row first-column last-row last-column)
2980 ;; Copy the range values into a list.
2981 (forward-line (- first-row thisline))
2982 (while (not (looking-at org-table-dataline-regexp))
2983 (forward-line)
2984 (cl-incf first-row))
2985 (org-table-goto-column first-column)
2986 (let ((beg (point)))
2987 (forward-line (- last-row first-row))
2988 (while (not (looking-at org-table-dataline-regexp))
2989 (forward-line -1))
2990 (org-table-goto-column last-column)
2991 (let ((end (point)))
2992 (when highlight
2993 (org-table-highlight-rectangle
2994 beg (progn (skip-chars-forward "^|\n") (point))))
2995 ;; Return string representation of calc vector.
2996 (mapcar #'org-trim
2997 (apply #'append
2998 (org-table-copy-region beg end))))))))))))
3000 (defun org-table--descriptor-line (desc cline)
3001 "Return relative line number corresponding to descriptor DESC.
3002 The cursor is currently in relative line number CLINE."
3003 (if (string-match "\\`[0-9]+\\'" desc)
3004 (aref org-table-dlines (string-to-number desc))
3005 (when (or (not (string-match
3006 "^\\(\\([-+]\\)?\\(I+\\)\\)?\\(\\([-+]\\)?\\([0-9]+\\)\\)?"
3007 ;; 1 2 3 4 5 6
3008 desc))
3009 (and (not (match-end 3)) (not (match-end 6)))
3010 (and (match-end 3) (match-end 6) (not (match-end 5))))
3011 (user-error "Invalid row descriptor `%s'" desc))
3012 (let* ((hn (and (match-end 3) (- (match-end 3) (match-beginning 3))))
3013 (hdir (match-string 2 desc))
3014 (odir (match-string 5 desc))
3015 (on (and (match-end 6) (string-to-number (match-string 6 desc))))
3016 (rel (and (match-end 6)
3017 (or (and (match-end 1) (not (match-end 3)))
3018 (match-end 5)))))
3019 (when (and hn (not hdir))
3020 (setq cline 0)
3021 (setq hdir "+")
3022 (when (eq (aref org-table-current-line-types 0) 'hline) (cl-decf hn)))
3023 (when (and (not hn) on (not odir)) (user-error "Should never happen"))
3024 (when hn
3025 (setq cline
3026 (org-table--row-type 'hline hn cline (equal hdir "-") nil desc)))
3027 (when on
3028 (setq cline
3029 (org-table--row-type 'dline on cline (equal odir "-") rel desc)))
3030 cline)))
3032 (defun org-table--row-type (type n i backwards relative desc)
3033 "Return relative line of Nth row with type TYPE.
3034 Search starts from relative line I. When BACKWARDS in non-nil,
3035 look before I. When RELATIVE is non-nil, the reference is
3036 relative. DESC is the original descriptor that started the
3037 search, as a string."
3038 (let ((l (length org-table-current-line-types)))
3039 (catch :exit
3040 (dotimes (_ n)
3041 (while (and (cl-incf i (if backwards -1 1))
3042 (>= i 0)
3043 (< i l)
3044 (not (eq (aref org-table-current-line-types i) type))
3045 ;; We are going to cross a hline. Check if this is
3046 ;; an authorized move.
3047 (cond
3048 ((not relative))
3049 ((not (eq (aref org-table-current-line-types i) 'hline)))
3050 ((eq org-table-relative-ref-may-cross-hline t))
3051 ((eq org-table-relative-ref-may-cross-hline 'error)
3052 (user-error "Row descriptor %s crosses hline" desc))
3053 (t (cl-decf i (if backwards -1 1)) ; Step back.
3054 (throw :exit nil)))))))
3055 (cond ((or (< i 0) (>= i l))
3056 (user-error "Row descriptor %s leads outside table" desc))
3057 ;; The last hline doesn't exist. Instead, point to last row
3058 ;; in table.
3059 ((= i (1- l)) (1- i))
3060 (t i))))
3062 (defun org-table--error-on-old-row-references (s)
3063 (when (string-match "&[-+0-9I]" s)
3064 (user-error "Formula contains old &row reference, please rewrite using @-syntax")))
3066 (defun org-table-make-reference (elements keep-empty numbers lispp)
3067 "Convert list ELEMENTS to something appropriate to insert into formula.
3068 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3069 NUMBERS indicates that everything should be converted to numbers.
3070 LISPP non-nil means to return something appropriate for a Lisp
3071 list, `literal' is for the format specifier L."
3072 ;; Calc nan (not a number) is used for the conversion of the empty
3073 ;; field to a reference for several reasons: (i) It is accepted in a
3074 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3075 ;; (ii) In a single field (not in range) it can be distinguished
3076 ;; from "(nan)" which is the reference made from a single field
3077 ;; containing "nan".
3078 (if (stringp elements)
3079 ;; field reference
3080 (if lispp
3081 (if (eq lispp 'literal)
3082 elements
3083 (if (and (eq elements "") (not keep-empty))
3085 (prin1-to-string
3086 (if numbers (string-to-number elements) elements))))
3087 (if (string-match "\\S-" elements)
3088 (progn
3089 (when numbers (setq elements (number-to-string
3090 (string-to-number elements))))
3091 (concat "(" elements ")"))
3092 (if (or (not keep-empty) numbers) "(0)" "nan")))
3093 ;; range reference
3094 (unless keep-empty
3095 (setq elements
3096 (delq nil
3097 (mapcar (lambda (x) (if (string-match "\\S-" x) x nil))
3098 elements))))
3099 (setq elements (or elements '())) ; if delq returns nil then we need '()
3100 (if lispp
3101 (mapconcat
3102 (lambda (x)
3103 (if (eq lispp 'literal)
3105 (prin1-to-string (if numbers (string-to-number x) x))))
3106 elements " ")
3107 (concat "[" (mapconcat
3108 (lambda (x)
3109 (if (string-match "\\S-" x)
3110 (if numbers
3111 (number-to-string (string-to-number x))
3113 (if (or (not keep-empty) numbers) "0" "nan")))
3114 elements
3115 ",") "]"))))
3117 (defun org-table-message-once-per-second (t1 &rest args)
3118 "If there has been more than one second since T1, display message.
3119 ARGS are passed as arguments to the `message' function. Returns
3120 current time if a message is printed, otherwise returns T1. If
3121 T1 is nil, always messages."
3122 (let ((curtime (current-time)))
3123 (if (or (not t1) (< 0 (nth 1 (time-subtract curtime t1))))
3124 (progn (apply 'message args)
3125 curtime)
3126 t1)))
3128 ;;;###autoload
3129 (defun org-table-recalculate (&optional all noalign)
3130 "Recalculate the current table line by applying all stored formulas.
3132 With prefix arg ALL, do this for all lines in the table.
3134 When called with a `\\[universal-argument] \\[universal-argument]' prefix, or \
3135 if ALL is the symbol `iterate',
3136 recompute the table until it no longer changes.
3138 If NOALIGN is not nil, do not re-align the table after the computations
3139 are done. This is typically used internally to save time, if it is
3140 known that the table will be realigned a little later anyway."
3141 (interactive "P")
3142 (unless (memq this-command org-recalc-commands)
3143 (push this-command org-recalc-commands))
3144 (unless (org-at-table-p) (user-error "Not at a table"))
3145 (if (or (eq all 'iterate) (equal all '(16)))
3146 (org-table-iterate)
3147 (org-table-analyze)
3148 (let* ((eqlist (sort (org-table-get-stored-formulas)
3149 (lambda (a b) (string< (car a) (car b)))))
3150 (inhibit-redisplay (not debug-on-error))
3151 (line-re org-table-dataline-regexp)
3152 (log-first-time (current-time))
3153 (log-last-time log-first-time)
3154 (cnt 0)
3155 beg end eqlcol eqlfield)
3156 ;; Insert constants in all formulas.
3157 (when eqlist
3158 (org-table-save-field
3159 ;; Expand equations, then split the equation list between
3160 ;; column formulas and field formulas.
3161 (dolist (eq eqlist)
3162 (let* ((rhs (org-table-formula-substitute-names
3163 (org-table-formula-handle-first/last-rc (cdr eq))))
3164 (old-lhs (car eq))
3165 (lhs
3166 (org-table-formula-handle-first/last-rc
3167 (cond
3168 ((string-match "\\`@-?I+" old-lhs)
3169 (user-error "Can't assign to hline relative reference"))
3170 ((string-match "\\`$[<>]" old-lhs)
3171 (let ((new (org-table-formula-handle-first/last-rc
3172 old-lhs)))
3173 (when (assoc new eqlist)
3174 (user-error "\"%s=\" formula tries to overwrite \
3175 existing formula for column %s"
3176 old-lhs
3177 new))
3178 new))
3179 (t old-lhs)))))
3180 (if (string-match-p "\\`\\$[0-9]+\\'" lhs)
3181 (push (cons lhs rhs) eqlcol)
3182 (push (cons lhs rhs) eqlfield))))
3183 (setq eqlcol (nreverse eqlcol))
3184 ;; Expand ranges in lhs of formulas
3185 (setq eqlfield (org-table-expand-lhs-ranges (nreverse eqlfield)))
3186 ;; Get the correct line range to process.
3187 (if all
3188 (progn
3189 (setq end (copy-marker (org-table-end)))
3190 (goto-char (setq beg org-table-current-begin-pos))
3191 (cond
3192 ((re-search-forward org-table-calculate-mark-regexp end t)
3193 ;; This is a table with marked lines, compute selected
3194 ;; lines.
3195 (setq line-re org-table-recalculate-regexp))
3196 ;; Move forward to the first non-header line.
3197 ((and (re-search-forward org-table-dataline-regexp end t)
3198 (re-search-forward org-table-hline-regexp end t)
3199 (re-search-forward org-table-dataline-regexp end t))
3200 (setq beg (match-beginning 0)))
3201 ;; Just leave BEG at the start of the table.
3202 (t nil)))
3203 (setq beg (line-beginning-position)
3204 end (copy-marker (line-beginning-position 2))))
3205 (goto-char beg)
3206 ;; Mark named fields untouchable. Also check if several
3207 ;; field/range formulas try to set the same field.
3208 (remove-text-properties beg end '(org-untouchable t))
3209 (let ((current-line (count-lines org-table-current-begin-pos
3210 (line-beginning-position)))
3211 seen-fields)
3212 (dolist (eq eqlfield)
3213 (let* ((name (car eq))
3214 (location (assoc name org-table-named-field-locations))
3215 (eq-line (or (nth 1 location)
3216 (and (string-match "\\`@\\([0-9]+\\)" name)
3217 (aref org-table-dlines
3218 (string-to-number
3219 (match-string 1 name))))))
3220 (reference
3221 (if location
3222 ;; Turn field coordinates associated to NAME
3223 ;; into an absolute reference.
3224 (format "@%d$%d"
3225 (org-table-line-to-dline eq-line)
3226 (nth 2 location))
3227 name)))
3228 (when (member reference seen-fields)
3229 (user-error "Several field/range formulas try to set %s"
3230 reference))
3231 (push reference seen-fields)
3232 (when (or all (eq eq-line current-line))
3233 (org-table-goto-field name)
3234 (org-table-put-field-property :org-untouchable t)))))
3235 ;; Evaluate the column formulas, but skip fields covered by
3236 ;; field formulas.
3237 (goto-char beg)
3238 (while (re-search-forward line-re end t)
3239 (unless (string-match "\\` *[_^!$/] *\\'" (org-table-get-field 1))
3240 ;; Unprotected line, recalculate.
3241 (cl-incf cnt)
3242 (when all
3243 (setq log-last-time
3244 (org-table-message-once-per-second
3245 log-last-time
3246 "Re-applying formulas to full table...(line %d)" cnt)))
3247 (if (markerp org-last-recalc-line)
3248 (move-marker org-last-recalc-line (line-beginning-position))
3249 (setq org-last-recalc-line
3250 (copy-marker (line-beginning-position))))
3251 (dolist (entry eqlcol)
3252 (goto-char org-last-recalc-line)
3253 (org-table-goto-column
3254 (string-to-number (substring (car entry) 1)) nil 'force)
3255 (unless (get-text-property (point) :org-untouchable)
3256 (org-table-eval-formula
3257 nil (cdr entry) 'noalign 'nocst 'nostore 'noanalysis)))))
3258 ;; Evaluate the field formulas.
3259 (dolist (eq eqlfield)
3260 (let ((reference (car eq))
3261 (formula (cdr eq)))
3262 (setq log-last-time
3263 (org-table-message-once-per-second
3264 (and all log-last-time)
3265 "Re-applying formula to field: %s" (car eq)))
3266 (org-table-goto-field
3267 reference
3268 ;; Possibly create a new column, as long as
3269 ;; `org-table-formula-create-columns' allows it.
3270 (let ((column-count (progn (end-of-line)
3271 (1- (org-table-current-column)))))
3272 (lambda (column)
3273 (when (> column 1000)
3274 (user-error "Formula column target too large"))
3275 (and (> column column-count)
3276 (or (eq org-table-formula-create-columns t)
3277 (and (eq org-table-formula-create-columns 'warn)
3278 (progn
3279 (org-display-warning
3280 "Out-of-bounds formula added columns")
3282 (and (eq org-table-formula-create-columns 'prompt)
3283 (yes-or-no-p
3284 "Out-of-bounds formula. Add columns? ")))))))
3285 (org-table-eval-formula nil formula t t t t))))
3286 ;; Clean up markers and internal text property.
3287 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
3288 (set-marker end nil)
3289 (unless noalign
3290 (when org-table-may-need-update (org-table-align))
3291 (when all
3292 (org-table-message-once-per-second
3293 log-first-time "Re-applying formulas to %d lines... done" cnt)))
3294 (org-table-message-once-per-second
3295 (and all log-first-time) "Re-applying formulas... done")))))
3297 ;;;###autoload
3298 (defun org-table-iterate (&optional arg)
3299 "Recalculate the table until it does not change anymore.
3300 The maximum number of iterations is 10, but you can choose a different value
3301 with the prefix ARG."
3302 (interactive "P")
3303 (let ((imax (if arg (prefix-numeric-value arg) 10))
3304 (i 0)
3305 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
3306 thistbl)
3307 (catch 'exit
3308 (while (< i imax)
3309 (setq i (1+ i))
3310 (org-table-recalculate 'all)
3311 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
3312 (if (not (string= lasttbl thistbl))
3313 (setq lasttbl thistbl)
3314 (if (> i 1)
3315 (message "Convergence after %d iterations" i)
3316 (message "Table was already stable"))
3317 (throw 'exit t)))
3318 (user-error "No convergence after %d iterations" i))))
3320 ;;;###autoload
3321 (defun org-table-recalculate-buffer-tables ()
3322 "Recalculate all tables in the current buffer."
3323 (interactive)
3324 (org-with-wide-buffer
3325 (org-table-map-tables
3326 (lambda ()
3327 ;; Reason for separate `org-table-align': When repeating
3328 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3329 ;; the way.
3330 (org-table-recalculate t t)
3331 (org-table-align))
3332 t)))
3334 ;;;###autoload
3335 (defun org-table-iterate-buffer-tables ()
3336 "Iterate all tables in the buffer, to converge inter-table dependencies."
3337 (interactive)
3338 (let* ((imax 10)
3339 (i imax)
3340 (checksum (md5 (buffer-string)))
3342 (org-with-wide-buffer
3343 (catch 'exit
3344 (while (> i 0)
3345 (setq i (1- i))
3346 (org-table-map-tables (lambda () (org-table-recalculate t t)) t)
3347 (if (equal checksum (setq c1 (md5 (buffer-string))))
3348 (progn
3349 (org-table-map-tables #'org-table-align t)
3350 (message "Convergence after %d iterations" (- imax i))
3351 (throw 'exit t))
3352 (setq checksum c1)))
3353 (org-table-map-tables #'org-table-align t)
3354 (user-error "No convergence after %d iterations" imax)))))
3356 (defun org-table-calc-current-TBLFM (&optional arg)
3357 "Apply the #+TBLFM in the line at point to the table."
3358 (interactive "P")
3359 (unless (org-at-TBLFM-p) (user-error "Not at a #+TBLFM line"))
3360 (let ((formula (buffer-substring
3361 (line-beginning-position)
3362 (line-end-position))))
3363 (save-excursion
3364 ;; Insert a temporary formula at right after the table
3365 (goto-char (org-table-TBLFM-begin))
3366 (let ((s (point-marker)))
3367 (insert formula "\n")
3368 (let ((e (point-marker)))
3369 ;; Recalculate the table.
3370 (beginning-of-line 0) ; move to the inserted line
3371 (skip-chars-backward " \r\n\t")
3372 (unwind-protect
3373 (org-call-with-arg #'org-table-recalculate (or arg t))
3374 ;; Delete the formula inserted temporarily.
3375 (delete-region s e)
3376 (set-marker s nil)
3377 (set-marker e nil)))))))
3379 (defun org-table-TBLFM-begin ()
3380 "Find the beginning of the TBLFM lines and return its position.
3381 Return nil when the beginning of TBLFM line was not found."
3382 (save-excursion
3383 (when (progn (forward-line 1)
3384 (re-search-backward org-table-TBLFM-begin-regexp nil t))
3385 (line-beginning-position 2))))
3387 (defun org-table-expand-lhs-ranges (equations)
3388 "Expand list of formulas.
3389 If some of the RHS in the formulas are ranges or a row reference,
3390 expand them to individual field equations for each field. This
3391 function assumes the table is already analyzed (i.e., using
3392 `org-table-analyze')."
3393 (let (res)
3394 (dolist (e equations (nreverse res))
3395 (let ((lhs (car e))
3396 (rhs (cdr e)))
3397 (cond
3398 ((string-match-p "\\`@-?[-+0-9]+\\$-?[0-9]+\\'" lhs)
3399 ;; This just refers to one fixed field.
3400 (push e res))
3401 ((string-match-p "\\`[a-zA-Z][_a-zA-Z0-9]*\\'" lhs)
3402 ;; This just refers to one fixed named field.
3403 (push e res))
3404 ((string-match-p "\\`\\$[0-9]+\\'" lhs)
3405 ;; Column formulas are treated specially and are not
3406 ;; expanded.
3407 (push e res))
3408 ((string-match "\\`@[0-9]+\\'" lhs)
3409 (dotimes (ic org-table-current-ncol)
3410 (push (cons (propertize (format "%s$%d" lhs (1+ ic)) :orig-eqn e)
3411 rhs)
3412 res)))
3414 (let* ((range (org-table-get-range
3415 lhs org-table-current-begin-pos 1 nil 'corners))
3416 (r1 (org-table-line-to-dline (nth 0 range)))
3417 (c1 (nth 1 range))
3418 (r2 (org-table-line-to-dline (nth 2 range) 'above))
3419 (c2 (nth 3 range)))
3420 (cl-loop for ir from r1 to r2 do
3421 (cl-loop for ic from c1 to c2 do
3422 (push (cons (propertize
3423 (format "@%d$%d" ir ic) :orig-eqn e)
3424 rhs)
3425 res))))))))))
3427 (defun org-table-formula-handle-first/last-rc (s)
3428 "Replace @<, @>, $<, $> with first/last row/column of the table.
3429 So @< and $< will always be replaced with @1 and $1, respectively.
3430 The advantage of these special markers are that structure editing of
3431 the table will not change them, while @1 and $1 will be modified
3432 when a line/row is swapped out of that privileged position. So for
3433 formulas that use a range of rows or columns, it may often be better
3434 to anchor the formula with \"I\" row markers, or to offset from the
3435 borders of the table using the @< @> $< $> makers."
3436 (let (n nmax len char (start 0))
3437 (while (string-match "\\([@$]\\)\\(<+\\|>+\\)\\|\\(remote([^)]+)\\)"
3438 s start)
3439 (if (match-end 3)
3440 (setq start (match-end 3))
3441 (setq nmax (if (equal (match-string 1 s) "@")
3442 (1- (length org-table-dlines))
3443 org-table-current-ncol)
3444 len (- (match-end 2) (match-beginning 2))
3445 char (string-to-char (match-string 2 s))
3446 n (if (= char ?<)
3448 (- nmax len -1)))
3449 (if (or (< n 1) (> n nmax))
3450 (user-error "Reference \"%s\" in expression \"%s\" points outside table"
3451 (match-string 0 s) s))
3452 (setq start (match-beginning 0))
3453 (setq s (replace-match (format "%s%d" (match-string 1 s) n) t t s)))))
3456 (defun org-table-formula-substitute-names (f)
3457 "Replace $const with values in string F."
3458 (let ((start 0)
3459 (pp (/= (string-to-char f) ?'))
3460 (duration (string-match-p ";.*[Tt].*\\'" f))
3461 (new (replace-regexp-in-string ; Check for column names.
3462 org-table-column-name-regexp
3463 (lambda (m)
3464 (concat "$" (cdr (assoc (match-string 1 m)
3465 org-table-column-names))))
3466 f t t)))
3467 ;; Parameters and constants.
3468 (while (setq start
3469 (string-match
3470 "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)"
3471 new start))
3472 (if (match-end 2) (setq start (match-end 2))
3473 (cl-incf start)
3474 ;; When a duration is expected, convert value on the fly.
3475 (let ((value
3476 (save-match-data
3477 (let ((v (org-table-get-constant (match-string 1 new))))
3478 (if (and (org-string-nw-p v) duration)
3479 (org-table-time-string-to-seconds v)
3480 v)))))
3481 (when value
3482 (setq new (replace-match
3483 (concat (and pp "(") value (and pp ")")) t t new))))))
3484 (if org-table-formula-debug (propertize new :orig-formula f) new)))
3486 (defun org-table-get-constant (const)
3487 "Find the value for a parameter or constant in a formula.
3488 Parameters get priority."
3489 (or (cdr (assoc const org-table-local-parameters))
3490 (cdr (assoc const org-table-formula-constants-local))
3491 (cdr (assoc const org-table-formula-constants))
3492 (and (fboundp 'constants-get) (constants-get const))
3493 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
3494 (org-entry-get nil (substring const 5) 'inherit))
3495 "#UNDEFINED_NAME"))
3497 (defvar org-table-fedit-map
3498 (let ((map (make-sparse-keymap)))
3499 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
3500 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
3501 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
3502 (org-defkey map "\C-c'" 'org-table-fedit-finish)
3503 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
3504 (org-defkey map "\C-c?" 'org-table-show-reference)
3505 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
3506 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
3507 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
3508 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
3509 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
3510 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
3511 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
3512 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
3513 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
3514 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
3515 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
3516 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
3517 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
3518 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
3519 map))
3521 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
3522 '("Edit-Formulas"
3523 ["Finish and Install" org-table-fedit-finish t]
3524 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
3525 ["Abort" org-table-fedit-abort t]
3526 "--"
3527 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
3528 ["Complete Lisp Symbol" lisp-complete-symbol t]
3529 "--"
3530 "Shift Reference at Point"
3531 ["Up" org-table-fedit-ref-up t]
3532 ["Down" org-table-fedit-ref-down t]
3533 ["Left" org-table-fedit-ref-left t]
3534 ["Right" org-table-fedit-ref-right t]
3536 "Change Test Row for Column Formulas"
3537 ["Up" org-table-fedit-line-up t]
3538 ["Down" org-table-fedit-line-down t]
3539 "--"
3540 ["Scroll Table Window" org-table-fedit-scroll t]
3541 ["Scroll Table Window down" org-table-fedit-scroll-down t]
3542 ["Show Table Grid" org-table-fedit-toggle-coordinates
3543 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
3544 org-table-overlay-coordinates)]
3545 "--"
3546 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
3547 :style toggle :selected org-table-buffer-is-an]))
3549 (defvar org-pos)
3550 (defvar org-table--fedit-source nil
3551 "Position of the TBLFM line being edited.")
3553 ;;;###autoload
3554 (defun org-table-edit-formulas ()
3555 "Edit the formulas of the current table in a separate buffer."
3556 (interactive)
3557 (let ((at-tblfm (org-at-TBLFM-p)))
3558 (unless (or at-tblfm (org-at-table-p))
3559 (user-error "Not at a table"))
3560 (save-excursion
3561 ;; Move point within the table before analyzing it.
3562 (when at-tblfm (re-search-backward "^[ \t]*|"))
3563 (org-table-analyze))
3564 (let ((key (org-table-current-field-formula 'key 'noerror))
3565 (eql (sort (org-table-get-stored-formulas t (and at-tblfm (point)))
3566 #'org-table-formula-less-p))
3567 (pos (point-marker))
3568 (source (copy-marker (line-beginning-position)))
3569 (startline 1)
3570 (wc (current-window-configuration))
3571 (sel-win (selected-window))
3572 (titles '((column . "# Column Formulas\n")
3573 (field . "# Field and Range Formulas\n")
3574 (named . "# Named Field Formulas\n"))))
3575 (org-switch-to-buffer-other-window "*Edit Formulas*")
3576 (erase-buffer)
3577 ;; Keep global-font-lock-mode from turning on font-lock-mode
3578 (let ((font-lock-global-modes '(not fundamental-mode)))
3579 (fundamental-mode))
3580 (setq-local font-lock-global-modes (list 'not major-mode))
3581 (setq-local org-pos pos)
3582 (setq-local org-table--fedit-source source)
3583 (setq-local org-window-configuration wc)
3584 (setq-local org-selected-window sel-win)
3585 (use-local-map org-table-fedit-map)
3586 (add-hook 'post-command-hook #'org-table-fedit-post-command t t)
3587 (easy-menu-add org-table-fedit-menu)
3588 (setq startline (org-current-line))
3589 (dolist (entry eql)
3590 (let* ((type (cond
3591 ((string-match "\\`$\\([0-9]+\\|[<>]+\\)\\'" (car entry))
3592 'column)
3593 ((equal (string-to-char (car entry)) ?@) 'field)
3594 (t 'named)))
3595 (title (assq type titles)))
3596 (when title
3597 (unless (bobp) (insert "\n"))
3598 (insert
3599 (org-add-props (cdr title) nil 'face font-lock-comment-face))
3600 (setq titles (remove title titles)))
3601 (when (equal key (car entry)) (setq startline (org-current-line)))
3602 (let ((s (concat
3603 (if (memq (string-to-char (car entry)) '(?@ ?$)) "" "$")
3604 (car entry) " = " (cdr entry) "\n")))
3605 (remove-text-properties 0 (length s) '(face nil) s)
3606 (insert s))))
3607 (when (eq org-table-use-standard-references t)
3608 (org-table-fedit-toggle-ref-type))
3609 (org-goto-line startline)
3610 (message "%s" (substitute-command-keys "\\<org-mode-map>\
3611 Edit formulas, finish with `\\[org-ctrl-c-ctrl-c]' or `\\[org-edit-special]'. \
3612 See menu for more commands.")))))
3614 (defun org-table-fedit-post-command ()
3615 (when (not (memq this-command '(lisp-complete-symbol)))
3616 (let ((win (selected-window)))
3617 (save-excursion
3618 (ignore-errors (org-table-show-reference))
3619 (select-window win)))))
3621 (defun org-table-formula-to-user (s)
3622 "Convert a formula from internal to user representation."
3623 (if (eq org-table-use-standard-references t)
3624 (org-table-convert-refs-to-an s)
3627 (defun org-table-formula-from-user (s)
3628 "Convert a formula from user to internal representation."
3629 (if org-table-use-standard-references
3630 (org-table-convert-refs-to-rc s)
3633 (defun org-table-convert-refs-to-rc (s)
3634 "Convert spreadsheet references from A7 to @7$28.
3635 Works for single references, but also for entire formulas and even the
3636 full TBLFM line."
3637 (let ((start 0))
3638 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3639 (cond
3640 ((match-end 3)
3641 ;; format match, just advance
3642 (setq start (match-end 0)))
3643 ((and (> (match-beginning 0) 0)
3644 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
3645 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
3646 ;; 3.e5 or something like this.
3647 (setq start (match-end 0)))
3648 ((or (> (- (match-end 1) (match-beginning 1)) 2)
3649 ;; (member (match-string 1 s)
3650 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3652 ;; function name, just advance
3653 (setq start (match-end 0)))
3655 (setq start (match-beginning 0)
3656 s (replace-match
3657 (if (equal (match-string 2 s) "&")
3658 (format "$%d" (org-letters-to-number (match-string 1 s)))
3659 (format "@%d$%d"
3660 (string-to-number (match-string 2 s))
3661 (org-letters-to-number (match-string 1 s))))
3662 t t s)))))
3665 (defun org-table-convert-refs-to-an (s)
3666 "Convert spreadsheet references from to @7$28 to AB7.
3667 Works for single references, but also for entire formulas and even the
3668 full TBLFM line."
3669 (while (string-match "@\\([0-9]+\\)\\$\\([0-9]+\\)" s)
3670 (setq s (replace-match
3671 (format "%s%d"
3672 (org-number-to-letters
3673 (string-to-number (match-string 2 s)))
3674 (string-to-number (match-string 1 s)))
3675 t t s)))
3676 (while (string-match "\\(^\\|[^0-9a-zA-Z]\\)\\$\\([0-9]+\\)" s)
3677 (setq s (replace-match (concat "\\1"
3678 (org-number-to-letters
3679 (string-to-number (match-string 2 s))) "&")
3680 t nil s)))
3683 (defun org-letters-to-number (s)
3684 "Convert a base 26 number represented by letters into an integer.
3685 For example: AB -> 28."
3686 (let ((n 0))
3687 (setq s (upcase s))
3688 (while (> (length s) 0)
3689 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
3690 s (substring s 1)))
3693 (defun org-number-to-letters (n)
3694 "Convert an integer into a base 26 number represented by letters.
3695 For example: 28 -> AB."
3696 (let ((s ""))
3697 (while (> n 0)
3698 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
3699 n (/ (1- n) 26)))
3702 (defun org-table-time-string-to-seconds (s)
3703 "Convert a time string into numerical duration in seconds.
3704 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3705 If S is a string representing a number, keep this number."
3706 (if (equal s "")
3708 (let (hour minus min sec res)
3709 (cond
3710 ((and (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)" s))
3711 (setq minus (< 0 (length (match-string 1 s)))
3712 hour (string-to-number (match-string 2 s))
3713 min (string-to-number (match-string 3 s))
3714 sec (string-to-number (match-string 4 s)))
3715 (if minus
3716 (setq res (- (+ (* hour 3600) (* min 60) sec)))
3717 (setq res (+ (* hour 3600) (* min 60) sec))))
3718 ((and (not (string-match org-ts-regexp-both s))
3719 (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\)" s))
3720 (setq minus (< 0 (length (match-string 1 s)))
3721 hour (string-to-number (match-string 2 s))
3722 min (string-to-number (match-string 3 s)))
3723 (if minus
3724 (setq res (- (+ (* hour 3600) (* min 60))))
3725 (setq res (+ (* hour 3600) (* min 60)))))
3726 (t (setq res (string-to-number s))))
3727 (number-to-string res))))
3729 (defun org-table-time-seconds-to-string (secs &optional output-format)
3730 "Convert a number of seconds to a time string.
3731 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3732 minutes or seconds."
3733 (let* ((secs0 (abs secs))
3734 (res
3735 (cond ((eq output-format 'days)
3736 (format "%.3f" (/ (float secs0) 86400)))
3737 ((eq output-format 'hours)
3738 (format "%.2f" (/ (float secs0) 3600)))
3739 ((eq output-format 'minutes)
3740 (format "%.1f" (/ (float secs0) 60)))
3741 ((eq output-format 'seconds)
3742 (format "%d" secs0))
3743 (t (format-seconds "%.2h:%.2m:%.2s" secs0)))))
3744 (if (< secs 0) (concat "-" res) res)))
3746 (defun org-table-fedit-convert-buffer (function)
3747 "Convert all references in this buffer, using FUNCTION."
3748 (let ((origin (copy-marker (line-beginning-position))))
3749 (goto-char (point-min))
3750 (while (not (eobp))
3751 (insert (funcall function (buffer-substring (point) (line-end-position))))
3752 (delete-region (point) (line-end-position))
3753 (forward-line))
3754 (goto-char origin)
3755 (set-marker origin nil)))
3757 (defun org-table-fedit-toggle-ref-type ()
3758 "Convert all references in the buffer from B3 to @3$2 and back."
3759 (interactive)
3760 (setq-local org-table-buffer-is-an (not org-table-buffer-is-an))
3761 (org-table-fedit-convert-buffer
3762 (if org-table-buffer-is-an
3763 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
3764 (message "Reference type switched to %s"
3765 (if org-table-buffer-is-an "A1 etc" "@row$column")))
3767 (defun org-table-fedit-ref-up ()
3768 "Shift the reference at point one row/hline up."
3769 (interactive)
3770 (org-table-fedit-shift-reference 'up))
3771 (defun org-table-fedit-ref-down ()
3772 "Shift the reference at point one row/hline down."
3773 (interactive)
3774 (org-table-fedit-shift-reference 'down))
3775 (defun org-table-fedit-ref-left ()
3776 "Shift the reference at point one field to the left."
3777 (interactive)
3778 (org-table-fedit-shift-reference 'left))
3779 (defun org-table-fedit-ref-right ()
3780 "Shift the reference at point one field to the right."
3781 (interactive)
3782 (org-table-fedit-shift-reference 'right))
3784 (defun org-table-fedit-shift-reference (dir)
3785 (cond
3786 ((org-in-regexp "\\(\\<[a-zA-Z]\\)&")
3787 (if (memq dir '(left right))
3788 (org-rematch-and-replace 1 (eq dir 'left))
3789 (user-error "Cannot shift reference in this direction")))
3790 ((org-in-regexp "\\(\\<[a-zA-Z]\\{1,2\\}\\)\\([0-9]+\\)")
3791 ;; A B3-like reference
3792 (if (memq dir '(up down))
3793 (org-rematch-and-replace 2 (eq dir 'up))
3794 (org-rematch-and-replace 1 (eq dir 'left))))
3795 ((org-in-regexp
3796 "\\(@\\|\\.\\.\\)\\([-+]?\\(I+\\>\\|[0-9]+\\)\\)\\(\\$\\([-+]?[0-9]+\\)\\)?")
3797 ;; An internal reference
3798 (if (memq dir '(up down))
3799 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
3800 (org-rematch-and-replace 5 (eq dir 'left))))))
3802 (defun org-rematch-and-replace (n &optional decr hline)
3803 "Re-match the group N, and replace it with the shifted reference."
3804 (or (match-end n) (user-error "Cannot shift reference in this direction"))
3805 (goto-char (match-beginning n))
3806 (and (looking-at (regexp-quote (match-string n)))
3807 (replace-match (org-table-shift-refpart (match-string 0) decr hline)
3808 t t)))
3810 (defun org-table-shift-refpart (ref &optional decr hline)
3811 "Shift a reference part REF.
3812 If DECR is set, decrease the references row/column, else increase.
3813 If HLINE is set, this may be a hline reference, it certainly is not
3814 a translation reference."
3815 (save-match-data
3816 (let* ((sign (string-match "^[-+]" ref)) n)
3818 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
3819 (cond
3820 ((and hline (string-match "^I+" ref))
3821 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
3822 (setq n (+ n (if decr -1 1)))
3823 (if (= n 0) (setq n (+ n (if decr -1 1))))
3824 (if sign
3825 (setq sign (if (< n 0) "-" "+") n (abs n))
3826 (setq n (max 1 n)))
3827 (concat sign (make-string n ?I)))
3829 ((string-match "^[0-9]+" ref)
3830 (setq n (string-to-number (concat sign ref)))
3831 (setq n (+ n (if decr -1 1)))
3832 (if sign
3833 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
3834 (number-to-string (max 1 n))))
3836 ((string-match "^[a-zA-Z]+" ref)
3837 (org-number-to-letters
3838 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
3840 (t (user-error "Cannot shift reference"))))))
3842 (defun org-table-fedit-toggle-coordinates ()
3843 "Toggle the display of coordinates in the referenced table."
3844 (interactive)
3845 (let ((pos (marker-position org-pos)))
3846 (with-current-buffer (marker-buffer org-pos)
3847 (save-excursion
3848 (goto-char pos)
3849 (org-table-toggle-coordinate-overlays)))))
3851 (defun org-table-fedit-finish (&optional arg)
3852 "Parse the buffer for formula definitions and install them.
3853 With prefix ARG, apply the new formulas to the table."
3854 (interactive "P")
3855 (org-table-remove-rectangle-highlight)
3856 (when org-table-use-standard-references
3857 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
3858 (setq org-table-buffer-is-an nil))
3859 (let ((pos org-pos)
3860 (sel-win org-selected-window)
3861 (source org-table--fedit-source)
3862 eql)
3863 (goto-char (point-min))
3864 (while (re-search-forward
3865 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3866 nil t)
3867 (let ((var (match-string 1))
3868 (form (org-trim (match-string 3))))
3869 (unless (equal form "")
3870 (while (string-match "[ \t]*\n[ \t]*" form)
3871 (setq form (replace-match " " t t form)))
3872 (when (assoc var eql)
3873 (user-error "Double formulas for %s" var))
3874 (push (cons var form) eql))))
3875 (set-window-configuration org-window-configuration)
3876 (select-window sel-win)
3877 (goto-char source)
3878 (org-table-store-formulas eql)
3879 (set-marker pos nil)
3880 (set-marker source nil)
3881 (kill-buffer "*Edit Formulas*")
3882 (if arg
3883 (org-table-recalculate 'all)
3884 (message "New formulas installed - press C-u C-c C-c to apply."))))
3886 (defun org-table-fedit-abort ()
3887 "Abort editing formulas, without installing the changes."
3888 (interactive)
3889 (org-table-remove-rectangle-highlight)
3890 (let ((pos org-pos) (sel-win org-selected-window))
3891 (set-window-configuration org-window-configuration)
3892 (select-window sel-win)
3893 (goto-char pos)
3894 (move-marker pos nil)
3895 (message "Formula editing aborted without installing changes")))
3897 (defun org-table-fedit-lisp-indent ()
3898 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3899 (interactive)
3900 (let ((pos (point)) beg end ind)
3901 (beginning-of-line 1)
3902 (cond
3903 ((looking-at "[ \t]")
3904 (goto-char pos)
3905 (call-interactively 'lisp-indent-line))
3906 ((looking-at "[$&@0-9a-zA-Z]+ *= *[^ \t\n']") (goto-char pos))
3907 ((not (fboundp 'pp-buffer))
3908 (user-error "Cannot pretty-print. Command `pp-buffer' is not available"))
3909 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
3910 (goto-char (- (match-end 0) 2))
3911 (setq beg (point))
3912 (setq ind (make-string (current-column) ?\ ))
3913 (condition-case nil (forward-sexp 1)
3914 (error
3915 (user-error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
3916 (setq end (point))
3917 (save-restriction
3918 (narrow-to-region beg end)
3919 (if (eq last-command this-command)
3920 (progn
3921 (goto-char (point-min))
3922 (setq this-command nil)
3923 (while (re-search-forward "[ \t]*\n[ \t]*" nil t)
3924 (replace-match " ")))
3925 (pp-buffer)
3926 (untabify (point-min) (point-max))
3927 (goto-char (1+ (point-min)))
3928 (while (re-search-forward "^." nil t)
3929 (beginning-of-line 1)
3930 (insert ind))
3931 (goto-char (point-max))
3932 (org-delete-backward-char 1)))
3933 (goto-char beg))
3934 (t nil))))
3936 (defvar org-show-positions nil)
3938 (defun org-table-show-reference (&optional local)
3939 "Show the location/value of the $ expression at point.
3940 When LOCAL is non-nil, show references for the table at point."
3941 (interactive)
3942 (org-table-remove-rectangle-highlight)
3943 (when local (org-table-analyze))
3944 (catch 'exit
3945 (let ((pos (if local (point) org-pos))
3946 (face2 'highlight)
3947 (org-inhibit-highlight-removal t)
3948 (win (selected-window))
3949 (org-show-positions nil)
3950 var name e what match dest)
3951 (setq what (cond
3952 ((org-in-regexp "^@[0-9]+[ \t=]")
3953 (setq match (concat (substring (match-string 0) 0 -1)
3954 "$1.."
3955 (substring (match-string 0) 0 -1)
3956 "$100"))
3957 'range)
3958 ((or (org-in-regexp org-table-range-regexp2)
3959 (org-in-regexp org-table-translate-regexp)
3960 (org-in-regexp org-table-range-regexp))
3961 (setq match
3962 (save-match-data
3963 (org-table-convert-refs-to-rc (match-string 0))))
3964 'range)
3965 ((org-in-regexp "\\$[a-zA-Z][a-zA-Z0-9]*") 'name)
3966 ((org-in-regexp "\\$[0-9]+") 'column)
3967 ((not local) nil)
3968 (t (user-error "No reference at point")))
3969 match (and what (or match (match-string 0))))
3970 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
3971 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
3972 'secondary-selection))
3973 (add-hook 'before-change-functions
3974 #'org-table-remove-rectangle-highlight)
3975 (when (eq what 'name) (setq var (substring match 1)))
3976 (when (eq what 'range)
3977 (unless (eq (string-to-char match) ?@) (setq match (concat "@" match)))
3978 (setq match (org-table-formula-substitute-names match)))
3979 (unless local
3980 (save-excursion
3981 (end-of-line)
3982 (re-search-backward "^\\S-" nil t)
3983 (beginning-of-line)
3984 (when (looking-at "\\(\\$[0-9a-zA-Z]+\\|@[0-9]+\\$[0-9]+\\|[a-zA-Z]+\
3985 \\([0-9]+\\|&\\)\\) *=")
3986 (setq dest
3987 (save-match-data
3988 (org-table-convert-refs-to-rc (match-string 1))))
3989 (org-table-add-rectangle-overlay
3990 (match-beginning 1) (match-end 1) face2))))
3991 (if (and (markerp pos) (marker-buffer pos))
3992 (if (get-buffer-window (marker-buffer pos))
3993 (select-window (get-buffer-window (marker-buffer pos)))
3994 (org-switch-to-buffer-other-window (get-buffer-window
3995 (marker-buffer pos)))))
3996 (goto-char pos)
3997 (org-table-force-dataline)
3998 (let ((table-start
3999 (if local org-table-current-begin-pos (org-table-begin))))
4000 (when dest
4001 (setq name (substring dest 1))
4002 (cond
4003 ((string-match-p "\\`\\$[a-zA-Z][a-zA-Z0-9]*" dest)
4004 (org-table-goto-field dest))
4005 ((string-match-p "\\`@\\([1-9][0-9]*\\)\\$\\([1-9][0-9]*\\)\\'"
4006 dest)
4007 (org-table-goto-field dest))
4008 (t (org-table-goto-column (string-to-number name))))
4009 (move-marker pos (point))
4010 (org-table-highlight-rectangle nil nil face2))
4011 (cond
4012 ((equal dest match))
4013 ((not match))
4014 ((eq what 'range)
4015 (ignore-errors (org-table-get-range match table-start nil 'highlight)))
4016 ((setq e (assoc var org-table-named-field-locations))
4017 (org-table-goto-field var)
4018 (org-table-highlight-rectangle)
4019 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
4020 ((setq e (assoc var org-table-column-names))
4021 (org-table-goto-column (string-to-number (cdr e)))
4022 (org-table-highlight-rectangle)
4023 (goto-char table-start)
4024 (if (re-search-forward (concat "^[ \t]*| *! *.*?| *\\(" var "\\) *|")
4025 (org-table-end) t)
4026 (progn
4027 (goto-char (match-beginning 1))
4028 (org-table-highlight-rectangle)
4029 (message "Named column (column %s)" (cdr e)))
4030 (user-error "Column name not found")))
4031 ((eq what 'column)
4032 ;; Column number.
4033 (org-table-goto-column (string-to-number (substring match 1)))
4034 (org-table-highlight-rectangle)
4035 (message "Column %s" (substring match 1)))
4036 ((setq e (assoc var org-table-local-parameters))
4037 (goto-char table-start)
4038 (if (re-search-forward (concat "^[ \t]*| *\\$ *.*?| *\\(" var "=\\)") nil t)
4039 (progn
4040 (goto-char (match-beginning 1))
4041 (org-table-highlight-rectangle)
4042 (message "Local parameter."))
4043 (user-error "Parameter not found")))
4044 ((not var) (user-error "No reference at point"))
4045 ((setq e (assoc var org-table-formula-constants-local))
4046 (message "Local Constant: $%s=%s in #+CONSTANTS line."
4047 var (cdr e)))
4048 ((setq e (assoc var org-table-formula-constants))
4049 (message "Constant: $%s=%s in `org-table-formula-constants'."
4050 var (cdr e)))
4051 ((setq e (and (fboundp 'constants-get) (constants-get var)))
4052 (message "Constant: $%s=%s, from `constants.el'%s."
4053 var e (format " (%s units)" constants-unit-system)))
4054 (t (user-error "Undefined name $%s" var)))
4055 (goto-char pos)
4056 (when (and org-show-positions
4057 (not (memq this-command '(org-table-fedit-scroll
4058 org-table-fedit-scroll-down))))
4059 (push pos org-show-positions)
4060 (push table-start org-show-positions)
4061 (let ((min (apply 'min org-show-positions))
4062 (max (apply 'max org-show-positions)))
4063 (set-window-start (selected-window) min)
4064 (goto-char max)
4065 (or (pos-visible-in-window-p max)
4066 (set-window-start (selected-window) max)))))
4067 (select-window win))))
4069 (defun org-table-force-dataline ()
4070 "Make sure the cursor is in a dataline in a table."
4071 (unless (save-excursion
4072 (beginning-of-line 1)
4073 (looking-at org-table-dataline-regexp))
4074 (let* ((re org-table-dataline-regexp)
4075 (p1 (save-excursion (re-search-forward re nil 'move)))
4076 (p2 (save-excursion (re-search-backward re nil 'move))))
4077 (cond ((and p1 p2)
4078 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
4079 p1 p2)))
4080 ((or p1 p2) (goto-char (or p1 p2)))
4081 (t (user-error "No table dataline around here"))))))
4083 (defun org-table-fedit-line-up ()
4084 "Move cursor one line up in the window showing the table."
4085 (interactive)
4086 (org-table-fedit-move 'previous-line))
4088 (defun org-table-fedit-line-down ()
4089 "Move cursor one line down in the window showing the table."
4090 (interactive)
4091 (org-table-fedit-move 'next-line))
4093 (defun org-table-fedit-move (command)
4094 "Move the cursor in the window showing the table.
4095 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4096 (let ((org-table-allow-automatic-line-recalculation nil)
4097 (pos org-pos) (win (selected-window)) p)
4098 (select-window (get-buffer-window (marker-buffer org-pos)))
4099 (setq p (point))
4100 (call-interactively command)
4101 (while (and (org-at-table-p)
4102 (org-at-table-hline-p))
4103 (call-interactively command))
4104 (or (org-at-table-p) (goto-char p))
4105 (move-marker pos (point))
4106 (select-window win)))
4108 (defun org-table-fedit-scroll (N)
4109 (interactive "p")
4110 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
4111 (scroll-other-window N)))
4113 (defun org-table-fedit-scroll-down (N)
4114 (interactive "p")
4115 (org-table-fedit-scroll (- N)))
4117 (defvar org-table-rectangle-overlays nil)
4119 (defun org-table-add-rectangle-overlay (beg end &optional face)
4120 "Add a new overlay."
4121 (let ((ov (make-overlay beg end)))
4122 (overlay-put ov 'face (or face 'secondary-selection))
4123 (push ov org-table-rectangle-overlays)))
4125 (defun org-table-highlight-rectangle (&optional beg end face)
4126 "Highlight rectangular region in a table.
4127 When buffer positions BEG and END are provided, use them to
4128 delimit the region to highlight. Otherwise, refer to point. Use
4129 FACE, when non-nil, for the highlight."
4130 (let* ((beg (or beg (point)))
4131 (end (or end (point)))
4132 (b (min beg end))
4133 (e (max beg end))
4134 (start-coordinates
4135 (save-excursion
4136 (goto-char b)
4137 (cons (line-beginning-position) (org-table-current-column))))
4138 (end-coordinates
4139 (save-excursion
4140 (goto-char e)
4141 (cons (line-beginning-position) (org-table-current-column)))))
4142 (when (boundp 'org-show-positions)
4143 (setq org-show-positions (cons b (cons e org-show-positions))))
4144 (goto-char (car start-coordinates))
4145 (let ((column-start (min (cdr start-coordinates) (cdr end-coordinates)))
4146 (column-end (max (cdr start-coordinates) (cdr end-coordinates)))
4147 (last-row (car end-coordinates)))
4148 (while (<= (point) last-row)
4149 (when (looking-at org-table-dataline-regexp)
4150 (org-table-goto-column column-start)
4151 (skip-chars-backward "^|\n")
4152 (let ((p (point)))
4153 (org-table-goto-column column-end)
4154 (skip-chars-forward "^|\n")
4155 (org-table-add-rectangle-overlay p (point) face)))
4156 (forward-line)))
4157 (goto-char (car start-coordinates)))
4158 (add-hook 'before-change-functions #'org-table-remove-rectangle-highlight))
4160 (defun org-table-remove-rectangle-highlight (&rest _ignore)
4161 "Remove the rectangle overlays."
4162 (unless org-inhibit-highlight-removal
4163 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
4164 (mapc 'delete-overlay org-table-rectangle-overlays)
4165 (setq org-table-rectangle-overlays nil)))
4167 (defvar-local org-table-coordinate-overlays nil
4168 "Collects the coordinate grid overlays, so that they can be removed.")
4170 (defun org-table-overlay-coordinates ()
4171 "Add overlays to the table at point, to show row/column coordinates."
4172 (interactive)
4173 (mapc 'delete-overlay org-table-coordinate-overlays)
4174 (setq org-table-coordinate-overlays nil)
4175 (save-excursion
4176 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
4177 (goto-char (org-table-begin))
4178 (while (org-at-table-p)
4179 (setq eol (point-at-eol))
4180 (setq ov (make-overlay (point-at-bol) (1+ (point-at-bol))))
4181 (push ov org-table-coordinate-overlays)
4182 (setq hline (looking-at org-table-hline-regexp))
4183 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
4184 (format "%4d" (setq id (1+ id)))))
4185 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
4186 (when hline
4187 (setq ic 0)
4188 (while (re-search-forward "[+|]\\(-+\\)" eol t)
4189 (setq beg (1+ (match-beginning 0))
4190 ic (1+ ic)
4191 s1 (concat "$" (int-to-string ic))
4192 s2 (org-number-to-letters ic)
4193 str (if (eq org-table-use-standard-references t) s2 s1))
4194 (setq ov (make-overlay beg (+ beg (length str))))
4195 (push ov org-table-coordinate-overlays)
4196 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
4197 (beginning-of-line 2)))))
4199 ;;;###autoload
4200 (defun org-table-toggle-coordinate-overlays ()
4201 "Toggle the display of Row/Column numbers in tables."
4202 (interactive)
4203 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
4204 (message "Tables Row/Column numbers display turned %s"
4205 (if org-table-overlay-coordinates "on" "off"))
4206 (if (and (org-at-table-p) org-table-overlay-coordinates)
4207 (org-table-align))
4208 (unless org-table-overlay-coordinates
4209 (mapc 'delete-overlay org-table-coordinate-overlays)
4210 (setq org-table-coordinate-overlays nil)))
4212 ;;;###autoload
4213 (defun org-table-toggle-formula-debugger ()
4214 "Toggle the formula debugger in tables."
4215 (interactive)
4216 (setq org-table-formula-debug (not org-table-formula-debug))
4217 (message "Formula debugging has been turned %s"
4218 (if org-table-formula-debug "on" "off")))
4220 ;;; The orgtbl minor mode
4222 ;; Define a minor mode which can be used in other modes in order to
4223 ;; integrate the Org table editor.
4225 ;; This is really a hack, because the Org table editor uses several
4226 ;; keys which normally belong to the major mode, for example the TAB
4227 ;; and RET keys. Here is how it works: The minor mode defines all the
4228 ;; keys necessary to operate the table editor, but wraps the commands
4229 ;; into a function which tests if the cursor is currently inside
4230 ;; a table. If that is the case, the table editor command is
4231 ;; executed. However, when any of those keys is used outside a table,
4232 ;; the function uses `key-binding' to look up if the key has an
4233 ;; associated command in another currently active keymap (minor modes,
4234 ;; major mode, global), and executes that command. There might be
4235 ;; problems if any of the keys used by the table editor is otherwise
4236 ;; used as a prefix key.
4238 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4239 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4240 ;; addresses this by checking explicitly for both bindings.
4242 ;; The optimized version (see variable `orgtbl-optimized') takes over
4243 ;; all keys which are bound to `self-insert-command' in the *global map*.
4244 ;; Some modes bind other commands to simple characters, for example
4245 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4246 ;; active, this binding is ignored inside tables and replaced with a
4247 ;; modified self-insert.
4250 (defvar orgtbl-mode-map (make-keymap)
4251 "Keymap for `orgtbl-mode'.")
4253 (defvar org-old-auto-fill-inhibit-regexp nil
4254 "Local variable used by `orgtbl-mode'.")
4256 (defconst orgtbl-line-start-regexp
4257 "[ \t]*\\(|\\|#\\+\\(tblfm\\|orgtbl\\|tblname\\):\\)"
4258 "Matches a line belonging to an orgtbl.")
4260 (defconst orgtbl-extra-font-lock-keywords
4261 (list (list (concat "^" orgtbl-line-start-regexp ".*")
4262 0 (quote 'org-table) 'prepend))
4263 "Extra `font-lock-keywords' to be added when `orgtbl-mode' is active.")
4265 ;; Install it as a minor mode.
4266 (put 'orgtbl-mode :included t)
4267 (put 'orgtbl-mode :menu-tag "Org Table Mode")
4269 ;;;###autoload
4270 (define-minor-mode orgtbl-mode
4271 "The `org-mode' table editor as a minor mode for use in other modes."
4272 :lighter " OrgTbl" :keymap orgtbl-mode-map
4273 (org-load-modules-maybe)
4274 (cond
4275 ((derived-mode-p 'org-mode)
4276 ;; Exit without error, in case some hook functions calls this
4277 ;; by accident in org-mode.
4278 (message "Orgtbl-mode is not useful in org-mode, command ignored"))
4279 (orgtbl-mode
4280 (and (orgtbl-setup) (defun orgtbl-setup () nil)) ;; FIXME: Yuck!?!
4281 ;; Make sure we are first in minor-mode-map-alist
4282 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
4283 ;; FIXME: maybe it should use emulation-mode-map-alists?
4284 (and c (setq minor-mode-map-alist
4285 (cons c (delq c minor-mode-map-alist)))))
4286 (setq-local org-table-may-need-update t)
4287 (add-hook 'before-change-functions 'org-before-change-function
4288 nil 'local)
4289 (setq-local org-old-auto-fill-inhibit-regexp
4290 auto-fill-inhibit-regexp)
4291 (setq-local auto-fill-inhibit-regexp
4292 (if auto-fill-inhibit-regexp
4293 (concat orgtbl-line-start-regexp "\\|"
4294 auto-fill-inhibit-regexp)
4295 orgtbl-line-start-regexp))
4296 (add-to-invisibility-spec '(org-cwidth))
4297 (when (fboundp 'font-lock-add-keywords)
4298 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
4299 (org-restart-font-lock))
4300 (easy-menu-add orgtbl-mode-menu))
4302 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
4303 (org-table-cleanup-narrow-column-properties)
4304 (org-remove-from-invisibility-spec '(org-cwidth))
4305 (remove-hook 'before-change-functions 'org-before-change-function t)
4306 (when (fboundp 'font-lock-remove-keywords)
4307 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
4308 (org-restart-font-lock))
4309 (easy-menu-remove orgtbl-mode-menu)
4310 (force-mode-line-update 'all))))
4312 (defun org-table-cleanup-narrow-column-properties ()
4313 "Remove all properties related to narrow-column invisibility."
4314 (let ((s (point-min)))
4315 (while (setq s (text-property-any s (point-max)
4316 'display org-narrow-column-arrow))
4317 (remove-text-properties s (1+ s) '(display t)))
4318 (setq s (point-min))
4319 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
4320 (remove-text-properties s (1+ s) '(org-cwidth t)))
4321 (setq s (point-min))
4322 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
4323 (remove-text-properties s (1+ s) '(invisible t)))))
4325 (defun orgtbl-make-binding (fun n &rest keys)
4326 "Create a function for binding in the table minor mode.
4327 FUN is the command to call inside a table. N is used to create a unique
4328 command name. KEYS are keys that should be checked in for a command
4329 to execute outside of tables."
4330 (eval
4331 (list 'defun
4332 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
4333 '(arg)
4334 (concat "In tables, run `" (symbol-name fun) "'.\n"
4335 "Outside of tables, run the binding of `"
4336 (mapconcat #'key-description keys "' or `")
4337 "'.")
4338 '(interactive "p")
4339 (list 'if
4340 '(org-at-table-p)
4341 (list 'call-interactively (list 'quote fun))
4342 (list 'let '(orgtbl-mode)
4343 (list 'call-interactively
4344 (append '(or)
4345 (mapcar (lambda (k)
4346 (list 'key-binding k))
4347 keys)
4348 '('orgtbl-error))))))))
4350 (defun orgtbl-error ()
4351 "Error when there is no default binding for a table key."
4352 (interactive)
4353 (user-error "This key has no function outside tables"))
4355 (defun orgtbl-setup ()
4356 "Setup orgtbl keymaps."
4357 (let ((nfunc 0)
4358 (bindings
4359 '(([(meta shift left)] org-table-delete-column)
4360 ([(meta left)] org-table-move-column-left)
4361 ([(meta right)] org-table-move-column-right)
4362 ([(meta shift right)] org-table-insert-column)
4363 ([(meta shift up)] org-table-kill-row)
4364 ([(meta shift down)] org-table-insert-row)
4365 ([(meta up)] org-table-move-row-up)
4366 ([(meta down)] org-table-move-row-down)
4367 ("\C-c\C-w" org-table-cut-region)
4368 ("\C-c\M-w" org-table-copy-region)
4369 ("\C-c\C-y" org-table-paste-rectangle)
4370 ("\C-c\C-w" org-table-wrap-region)
4371 ("\C-c-" org-table-insert-hline)
4372 ("\C-c}" org-table-toggle-coordinate-overlays)
4373 ("\C-c{" org-table-toggle-formula-debugger)
4374 ("\C-m" org-table-next-row)
4375 ([(shift return)] org-table-copy-down)
4376 ("\C-c?" org-table-field-info)
4377 ("\C-c " org-table-blank-field)
4378 ("\C-c+" org-table-sum)
4379 ("\C-c=" org-table-eval-formula)
4380 ("\C-c'" org-table-edit-formulas)
4381 ("\C-c`" org-table-edit-field)
4382 ("\C-c*" org-table-recalculate)
4383 ("\C-c^" org-table-sort-lines)
4384 ("\M-a" org-table-beginning-of-field)
4385 ("\M-e" org-table-end-of-field)
4386 ([(control ?#)] org-table-rotate-recalc-marks)))
4387 elt key fun cmd)
4388 (while (setq elt (pop bindings))
4389 (setq nfunc (1+ nfunc))
4390 (setq key (org-key (car elt))
4391 fun (nth 1 elt)
4392 cmd (orgtbl-make-binding fun nfunc key))
4393 (org-defkey orgtbl-mode-map key cmd))
4395 ;; Special treatment needed for TAB, RET and DEL
4396 (org-defkey orgtbl-mode-map [(return)]
4397 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
4398 (org-defkey orgtbl-mode-map "\C-m"
4399 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
4400 (org-defkey orgtbl-mode-map [(tab)]
4401 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
4402 (org-defkey orgtbl-mode-map "\C-i"
4403 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
4404 (org-defkey orgtbl-mode-map [(shift tab)]
4405 (orgtbl-make-binding 'org-table-previous-field 104
4406 [(shift tab)] [(tab)] "\C-i"))
4407 (org-defkey orgtbl-mode-map [backspace]
4408 (orgtbl-make-binding 'org-delete-backward-char 109
4409 [backspace] (kbd "DEL")))
4411 (org-defkey orgtbl-mode-map [S-iso-lefttab]
4412 (orgtbl-make-binding 'org-table-previous-field 107
4413 [S-iso-lefttab] [backtab] [(shift tab)]
4414 [(tab)] "\C-i"))
4416 (org-defkey orgtbl-mode-map [backtab]
4417 (orgtbl-make-binding 'org-table-previous-field 108
4418 [backtab] [S-iso-lefttab] [(shift tab)]
4419 [(tab)] "\C-i"))
4421 (org-defkey orgtbl-mode-map "\M-\C-m"
4422 (orgtbl-make-binding 'org-table-wrap-region 105
4423 "\M-\C-m" [(meta return)]))
4424 (org-defkey orgtbl-mode-map [(meta return)]
4425 (orgtbl-make-binding 'org-table-wrap-region 106
4426 [(meta return)] "\M-\C-m"))
4428 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4429 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4431 (when orgtbl-optimized
4432 ;; If the user wants maximum table support, we need to hijack
4433 ;; some standard editing functions
4434 (org-remap orgtbl-mode-map
4435 'self-insert-command 'orgtbl-self-insert-command
4436 'delete-char 'org-delete-char
4437 'delete-backward-char 'org-delete-backward-char)
4438 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4439 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4440 '("OrgTbl"
4441 ["Create or convert" org-table-create-or-convert-from-region
4442 :active (not (org-at-table-p)) :keys "C-c |" ]
4443 "--"
4444 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4445 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4446 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4447 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4448 "--"
4449 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4450 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4451 ["Copy Field from Above"
4452 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4453 "--"
4454 ("Column"
4455 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4456 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4457 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4458 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4459 ("Row"
4460 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4461 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4462 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4463 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4464 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4465 "--"
4466 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4467 ("Rectangle"
4468 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4469 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4470 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4471 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4472 "--"
4473 ("Radio tables"
4474 ["Insert table template" orgtbl-insert-radio-table
4475 (assq major-mode orgtbl-radio-table-templates)]
4476 ["Comment/uncomment table" orgtbl-toggle-comment t])
4477 "--"
4478 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4479 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4480 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4481 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4482 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4483 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4484 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4485 ["Sum Column/Rectangle" org-table-sum
4486 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4487 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4488 ["Debug Formulas"
4489 org-table-toggle-formula-debugger :active (org-at-table-p)
4490 :keys "C-c {"
4491 :style toggle :selected org-table-formula-debug]
4492 ["Show Col/Row Numbers"
4493 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4494 :keys "C-c }"
4495 :style toggle :selected org-table-overlay-coordinates]
4496 "--"
4497 ("Plot"
4498 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
4499 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
4502 (defun orgtbl-ctrl-c-ctrl-c (arg)
4503 "If the cursor is inside a table, realign the table.
4504 If it is a table to be sent away to a receiver, do it.
4505 With prefix arg, also recompute table."
4506 (interactive "P")
4507 (let ((case-fold-search t) (pos (point)) action)
4508 (save-excursion
4509 (beginning-of-line 1)
4510 (setq action (cond
4511 ((looking-at "[ \t]*#\\+ORGTBL:.*\n[ \t]*|") (match-end 0))
4512 ((looking-at "[ \t]*|") pos)
4513 ((looking-at "[ \t]*#\\+tblfm:") 'recalc))))
4514 (cond
4515 ((integerp action)
4516 (goto-char action)
4517 (org-table-maybe-eval-formula)
4518 (if arg
4519 (call-interactively 'org-table-recalculate)
4520 (org-table-maybe-recalculate-line))
4521 (call-interactively 'org-table-align)
4522 (when (orgtbl-send-table 'maybe)
4523 (run-hooks 'orgtbl-after-send-table-hook)))
4524 ((eq action 'recalc)
4525 (save-excursion
4526 (beginning-of-line 1)
4527 (skip-chars-backward " \r\n\t")
4528 (if (org-at-table-p)
4529 (org-call-with-arg 'org-table-recalculate t))))
4530 (t (let (orgtbl-mode)
4531 (call-interactively (key-binding "\C-c\C-c")))))))
4533 (defun orgtbl-create-or-convert-from-region (_arg)
4534 "Create table or convert region to table, if no conflicting binding.
4535 This installs the table binding `C-c |', but only if there is no
4536 conflicting binding to this key outside orgtbl-mode."
4537 (interactive "P")
4538 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4539 (if cmd
4540 (call-interactively cmd)
4541 (call-interactively 'org-table-create-or-convert-from-region))))
4543 (defun orgtbl-tab (arg)
4544 "Justification and field motion for `orgtbl-mode'."
4545 (interactive "P")
4546 (if arg (org-table-edit-field t)
4547 (org-table-justify-field-maybe)
4548 (org-table-next-field)))
4550 (defun orgtbl-ret ()
4551 "Justification and field motion for `orgtbl-mode'."
4552 (interactive)
4553 (if (bobp)
4554 (newline)
4555 (org-table-justify-field-maybe)
4556 (org-table-next-row)))
4558 (defun orgtbl-self-insert-command (N)
4559 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4560 If the cursor is in a table looking at whitespace, the whitespace is
4561 overwritten, and the table is not marked as requiring realignment."
4562 (interactive "p")
4563 (if (and (org-at-table-p)
4565 (and org-table-auto-blank-field
4566 (member last-command
4567 '(orgtbl-hijacker-command-100
4568 orgtbl-hijacker-command-101
4569 orgtbl-hijacker-command-102
4570 orgtbl-hijacker-command-103
4571 orgtbl-hijacker-command-104
4572 orgtbl-hijacker-command-105
4573 yas/expand))
4574 (org-table-blank-field))
4576 (eq N 1)
4577 (looking-at "[^|\n]* \\( \\)|"))
4578 (let (org-table-may-need-update)
4579 (delete-region (match-beginning 1) (match-end 1))
4580 (self-insert-command N))
4581 (setq org-table-may-need-update t)
4582 (let* (orgtbl-mode
4584 (cmd (or (key-binding
4585 (or (and (listp function-key-map)
4586 (setq a (assoc last-input-event function-key-map))
4587 (cdr a))
4588 (vector last-input-event)))
4589 'self-insert-command)))
4590 (call-interactively cmd)
4591 (if (and org-self-insert-cluster-for-undo
4592 (eq cmd 'self-insert-command))
4593 (if (not (eq last-command 'orgtbl-self-insert-command))
4594 (setq org-self-insert-command-undo-counter 1)
4595 (if (>= org-self-insert-command-undo-counter 20)
4596 (setq org-self-insert-command-undo-counter 1)
4597 (and (> org-self-insert-command-undo-counter 0)
4598 buffer-undo-list
4599 (not (cadr buffer-undo-list)) ; remove nil entry
4600 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4601 (setq org-self-insert-command-undo-counter
4602 (1+ org-self-insert-command-undo-counter))))))))
4604 ;;;###autoload
4605 (defvar orgtbl-exp-regexp "^\\([-+]?[0-9][0-9.]*\\)[eE]\\([-+]?[0-9]+\\)$"
4606 "Regular expression matching exponentials as produced by calc.")
4608 (defun orgtbl-gather-send-defs ()
4609 "Gather a plist of :name, :transform, :params for each destination before
4610 a radio table."
4611 (save-excursion
4612 (goto-char (org-table-begin))
4613 (let (rtn)
4614 (beginning-of-line 0)
4615 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4616 (let ((name (org-no-properties (match-string 1)))
4617 (transform (intern (match-string 2)))
4618 (params (if (match-end 3)
4619 (read (concat "(" (match-string 3) ")")))))
4620 (push (list :name name :transform transform :params params)
4621 rtn)
4622 (beginning-of-line 0)))
4623 rtn)))
4625 (defun orgtbl-send-replace-tbl (name text)
4626 "Find and replace table NAME with TEXT."
4627 (save-excursion
4628 (goto-char (point-min))
4629 (let* ((location-flag nil)
4630 (name (regexp-quote name))
4631 (begin-re (format "BEGIN +RECEIVE +ORGTBL +%s\\([ \t]\\|$\\)" name))
4632 (end-re (format "END +RECEIVE +ORGTBL +%s\\([ \t]\\|$\\)" name)))
4633 (while (re-search-forward begin-re nil t)
4634 (unless location-flag (setq location-flag t))
4635 (let ((beg (line-beginning-position 2)))
4636 (unless (re-search-forward end-re nil t)
4637 (user-error "Cannot find end of receiver location at %d" beg))
4638 (beginning-of-line)
4639 (delete-region beg (point))
4640 (insert text "\n")))
4641 (unless location-flag
4642 (user-error "No valid receiver location found in the buffer")))))
4644 ;;;###autoload
4645 (defun org-table-to-lisp (&optional txt)
4646 "Convert the table at point to a Lisp structure.
4647 The structure will be a list. Each item is either the symbol `hline'
4648 for a horizontal separator line, or a list of field values as strings.
4649 The table is taken from the parameter TXT, or from the buffer at point."
4650 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4651 (let ((txt (or txt
4652 (buffer-substring-no-properties (org-table-begin)
4653 (org-table-end)))))
4654 (mapcar (lambda (x)
4655 (if (string-match org-table-hline-regexp x) 'hline
4656 (org-split-string (org-trim x) "\\s-*|\\s-*")))
4657 (org-split-string txt "[ \t]*\n[ \t]*"))))
4659 (defun orgtbl-send-table (&optional maybe)
4660 "Send a transformed version of table at point to the receiver position.
4661 With argument MAYBE, fail quietly if no transformation is defined
4662 for this table."
4663 (interactive)
4664 (catch 'exit
4665 (unless (org-at-table-p) (user-error "Not at a table"))
4666 ;; when non-interactive, we assume align has just happened.
4667 (when (called-interactively-p 'any) (org-table-align))
4668 (let ((dests (orgtbl-gather-send-defs))
4669 (table (org-table-to-lisp
4670 (buffer-substring-no-properties (org-table-begin)
4671 (org-table-end))))
4672 (ntbl 0))
4673 (unless dests
4674 (if maybe (throw 'exit nil)
4675 (user-error "Don't know how to transform this table")))
4676 (dolist (dest dests)
4677 (let ((name (plist-get dest :name))
4678 (transform (plist-get dest :transform))
4679 (params (plist-get dest :params)))
4680 (unless (fboundp transform)
4681 (user-error "No such transformation function %s" transform))
4682 (orgtbl-send-replace-tbl name (funcall transform table params)))
4683 (cl-incf ntbl))
4684 (message "Table converted and installed at %d receiver location%s"
4685 ntbl (if (> ntbl 1) "s" ""))
4686 (and (> ntbl 0) ntbl))))
4688 (defun org-remove-by-index (list indices &optional i0)
4689 "Remove the elements in LIST with indices in INDICES.
4690 First element has index 0, or I0 if given."
4691 (if (not indices)
4692 list
4693 (if (integerp indices) (setq indices (list indices)))
4694 (setq i0 (1- (or i0 0)))
4695 (delq :rm (mapcar (lambda (x)
4696 (setq i0 (1+ i0))
4697 (if (memq i0 indices) :rm x))
4698 list))))
4700 (defun orgtbl-toggle-comment ()
4701 "Comment or uncomment the orgtbl at point."
4702 (interactive)
4703 (let* ((case-fold-search t)
4704 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4705 (re2 (concat "^" orgtbl-line-start-regexp))
4706 (commented (save-excursion (beginning-of-line 1)
4707 (cond ((looking-at re1) t)
4708 ((looking-at re2) nil)
4709 (t (user-error "Not at an org table")))))
4710 (re (if commented re1 re2))
4711 beg end)
4712 (save-excursion
4713 (beginning-of-line 1)
4714 (while (looking-at re) (beginning-of-line 0))
4715 (beginning-of-line 2)
4716 (setq beg (point))
4717 (while (looking-at re) (beginning-of-line 2))
4718 (setq end (point)))
4719 (comment-region beg end (if commented '(4) nil))))
4721 (defun orgtbl-insert-radio-table ()
4722 "Insert a radio table template appropriate for this major mode."
4723 (interactive)
4724 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4725 (txt (nth 1 e))
4726 name pos)
4727 (unless e (user-error "No radio table setup defined for %s" major-mode))
4728 (setq name (read-string "Table name: "))
4729 (while (string-match "%n" txt)
4730 (setq txt (replace-match name t t txt)))
4731 (or (bolp) (insert "\n"))
4732 (setq pos (point))
4733 (insert txt)
4734 (goto-char pos)))
4736 ;;;###autoload
4737 (defun orgtbl-to-generic (table params)
4738 "Convert the orgtbl-mode TABLE to some other format.
4740 This generic routine can be used for many standard cases.
4742 TABLE is a list, each entry either the symbol `hline' for
4743 a horizontal separator line, or a list of fields for that
4744 line. PARAMS is a property list of parameters that can
4745 influence the conversion.
4747 Valid parameters are:
4749 :backend, :raw
4751 Export back-end used as a basis to transcode elements of the
4752 table, when no specific parameter applies to it. It is also
4753 used to translate cells contents. You can prevent this by
4754 setting :raw property to a non-nil value.
4756 :splice
4758 When non-nil, only convert rows, not the table itself. This is
4759 equivalent to setting to the empty string both :tstart
4760 and :tend, which see.
4762 :skip
4764 When set to an integer N, skip the first N lines of the table.
4765 Horizontal separation lines do count for this parameter!
4767 :skipcols
4769 List of columns that should be skipped. If the table has
4770 a column with calculation marks, that column is automatically
4771 discarded beforehand.
4773 :hline
4775 String to be inserted on horizontal separation lines. May be
4776 nil to ignore these lines altogether.
4778 :sep
4780 Separator between two fields, as a string.
4782 Each in the following group may be either a string or a function
4783 of no arguments returning a string:
4785 :tstart, :tend
4787 Strings to start and end the table. Ignored when :splice is t.
4789 :lstart, :lend
4791 Strings to start and end a new table line.
4793 :llstart, :llend
4795 Strings to start and end the last table line. Default,
4796 respectively, to :lstart and :lend.
4798 Each in the following group may be a string or a function of one
4799 argument (either the cells in the current row, as a list of
4800 strings, or the current cell) returning a string:
4802 :lfmt
4804 Format string for an entire row, with enough %s to capture all
4805 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4807 :llfmt
4809 Format for the entire last line, defaults to :lfmt.
4811 :fmt
4813 A format to be used to wrap the field, should contain %s for
4814 the original field value. For example, to wrap everything in
4815 dollars, you could use :fmt \"$%s$\". This may also be
4816 a property list with column numbers and format strings, or
4817 functions, e.g.,
4819 (:fmt (2 \"$%s$\" 4 (lambda (c) (format \"$%s$\" c))))
4821 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4823 Same as above, specific for the header lines in the table.
4824 All lines before the first hline are treated as header. If
4825 any of these is not present, the data line value is used.
4827 This may be either a string or a function of two arguments:
4829 :efmt
4831 Use this format to print numbers with exponential. The format
4832 should have %s twice for inserting mantissa and exponent, for
4833 example \"%s\\\\times10^{%s}\". This may also be a property
4834 list with column numbers and format strings or functions.
4835 :fmt will still be applied after :efmt."
4836 ;; Make sure `org-export-create-backend' is available.
4837 (require 'ox)
4838 (let* ((backend (plist-get params :backend))
4839 (custom-backend
4840 ;; Build a custom back-end according to PARAMS. Before
4841 ;; defining a translator, check if there is anything to do.
4842 ;; When there isn't, let BACKEND handle the element.
4843 (org-export-create-backend
4844 :parent (or backend 'org)
4845 :transcoders
4846 `((table . ,(org-table--to-generic-table params))
4847 (table-row . ,(org-table--to-generic-row params))
4848 (table-cell . ,(org-table--to-generic-cell params))
4849 ;; Macros are not going to be expanded. However, no
4850 ;; regular back-end has a transcoder for them. We
4851 ;; provide one so they are not ignored, but displayed
4852 ;; as-is instead.
4853 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4854 data info)
4855 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4856 ;; Initialize communication channel in INFO.
4857 (with-temp-buffer
4858 (let ((org-inhibit-startup t)) (org-mode))
4859 (let ((standard-output (current-buffer)))
4860 (dolist (e table)
4861 (cond ((eq e 'hline) (princ "|--\n"))
4862 ((consp e)
4863 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4864 (princ "\n")))))
4865 ;; Add back-end specific filters, but not user-defined ones. In
4866 ;; particular, make sure to call parse-tree filters on the
4867 ;; table.
4868 (setq info
4869 (let ((org-export-filters-alist nil))
4870 (org-export-install-filters
4871 (org-combine-plists
4872 (org-export-get-environment backend nil params)
4873 `(:back-end ,(org-export-get-backend backend))))))
4874 (setq data
4875 (org-export-filter-apply-functions
4876 (plist-get info :filter-parse-tree)
4877 (org-element-map (org-element-parse-buffer) 'table
4878 #'identity nil t)
4879 info)))
4880 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4881 (user-error "Unknown :backend value"))
4882 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4883 ;; Handle :skip parameter.
4884 (let ((skip (plist-get info :skip)))
4885 (when skip
4886 (unless (wholenump skip) (user-error "Wrong :skip value"))
4887 (let ((n 0))
4888 (org-element-map data 'table-row
4889 (lambda (row)
4890 (if (>= n skip) t
4891 (org-element-extract-element row)
4892 (cl-incf n)
4893 nil))
4894 nil t))))
4895 ;; Handle :skipcols parameter.
4896 (let ((skipcols (plist-get info :skipcols)))
4897 (when skipcols
4898 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4899 (org-element-map data 'table
4900 (lambda (table)
4901 (let ((specialp (org-export-table-has-special-column-p table)))
4902 (dolist (row (org-element-contents table))
4903 (when (eq (org-element-property :type row) 'standard)
4904 (let ((c 1))
4905 (dolist (cell (nthcdr (if specialp 1 0)
4906 (org-element-contents row)))
4907 (when (memq c skipcols)
4908 (org-element-extract-element cell))
4909 (cl-incf c))))))))))
4910 ;; Since we are going to export using a low-level mechanism,
4911 ;; ignore special column and special rows manually.
4912 (let ((special? (org-export-table-has-special-column-p data))
4913 ignore)
4914 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4915 (lambda (datum)
4916 (when (if (eq (org-element-type datum) 'table-row)
4917 (org-export-table-row-is-special-p datum nil)
4918 (org-export-first-sibling-p datum nil))
4919 (push datum ignore))))
4920 (setq info (plist-put info :ignore-list ignore)))
4921 ;; We use a low-level mechanism to export DATA so as to skip all
4922 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4923 ;; code evaluation, include keywords and macro expansion. Only
4924 ;; back-end specific filters are retained.
4925 (let ((output (org-export-data-with-backend data custom-backend info)))
4926 ;; Remove final newline.
4927 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4929 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4930 (cond ((null value) nil)
4931 ((functionp value) `(funcall ',value ,@args))
4932 ((stringp value)
4933 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4934 (args `(format ,value ,@args))
4935 (t value)))
4936 ((and with-cons (consp value))
4937 `(let ((val (cadr (memq column ',value))))
4938 (cond ((null val) contents)
4939 ((stringp val) (format val ,@args))
4940 ((functionp val) (funcall val ,@args))
4941 (t (user-error "Wrong %s value" ,name)))))
4942 (t (user-error "Wrong %s value" name))))
4944 (defun org-table--to-generic-table (params)
4945 "Return custom table transcoder according to PARAMS.
4946 PARAMS is a plist. See `orgtbl-to-generic' for more
4947 information."
4948 (let ((backend (plist-get params :backend))
4949 (splice (plist-get params :splice))
4950 (tstart (plist-get params :tstart))
4951 (tend (plist-get params :tend)))
4952 `(lambda (table contents info)
4953 (concat
4954 ,(and tstart (not splice)
4955 `(concat ,(org-table--generic-apply tstart ":tstart") "\n"))
4956 ,(if (or (not backend) tstart tend splice) 'contents
4957 `(org-export-with-backend ',backend table contents info))
4958 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4960 (defun org-table--to-generic-row (params)
4961 "Return custom table row transcoder according to PARAMS.
4962 PARAMS is a plist. See `orgtbl-to-generic' for more
4963 information."
4964 (let* ((backend (plist-get params :backend))
4965 (lstart (plist-get params :lstart))
4966 (llstart (plist-get params :llstart))
4967 (hlstart (plist-get params :hlstart))
4968 (hllstart (plist-get params :hllstart))
4969 (lend (plist-get params :lend))
4970 (llend (plist-get params :llend))
4971 (hlend (plist-get params :hlend))
4972 (hllend (plist-get params :hllend))
4973 (lfmt (plist-get params :lfmt))
4974 (llfmt (plist-get params :llfmt))
4975 (hlfmt (plist-get params :hlfmt))
4976 (hllfmt (plist-get params :hllfmt)))
4977 `(lambda (row contents info)
4978 (if (eq (org-element-property :type row) 'rule)
4979 ,(cond
4980 ((plist-member params :hline)
4981 (org-table--generic-apply (plist-get params :hline) ":hline"))
4982 (backend `(org-export-with-backend ',backend row nil info)))
4983 (let ((headerp (org-export-table-row-in-header-p row info))
4984 (lastp (not (org-export-get-next-element row info)))
4985 (last-header-p (org-export-table-row-ends-header-p row info)))
4986 (when contents
4987 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4988 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4989 ;; `:lstart', `:lend' and their relatives.
4990 ,(let ((cells
4991 '(org-element-map row 'table-cell
4992 (lambda (cell)
4993 ;; Export all cells, without separators.
4995 ;; Use `org-export-data-with-backend'
4996 ;; instead of `org-export-data' to eschew
4997 ;; cached values, which
4998 ;; ignore :orgtbl-ignore-sep parameter.
4999 (org-export-data-with-backend
5000 cell
5001 (plist-get info :back-end)
5002 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5003 info)))
5004 `(cond
5005 ,(and hllfmt
5006 `(last-header-p ,(org-table--generic-apply
5007 hllfmt ":hllfmt" nil cells)))
5008 ,(and hlfmt
5009 `(headerp ,(org-table--generic-apply
5010 hlfmt ":hlfmt" nil cells)))
5011 ,(and llfmt
5012 `(lastp ,(org-table--generic-apply
5013 llfmt ":llfmt" nil cells)))
5015 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5016 `(concat
5017 (cond
5018 ,(and
5019 (or hllstart hllend)
5020 `(last-header-p
5021 (concat
5022 ,(org-table--generic-apply hllstart ":hllstart")
5023 contents
5024 ,(org-table--generic-apply hllend ":hllend"))))
5025 ,(and
5026 (or hlstart hlend)
5027 `(headerp
5028 (concat
5029 ,(org-table--generic-apply hlstart ":hlstart")
5030 contents
5031 ,(org-table--generic-apply hlend ":hlend"))))
5032 ,(and
5033 (or llstart llend)
5034 `(lastp
5035 (concat
5036 ,(org-table--generic-apply llstart ":llstart")
5037 contents
5038 ,(org-table--generic-apply llend ":llend"))))
5040 ,(cond
5041 ((or lstart lend)
5042 `(concat
5043 ,(org-table--generic-apply lstart ":lstart")
5044 contents
5045 ,(org-table--generic-apply lend ":lend")))
5046 (backend
5047 `(org-export-with-backend
5048 ',backend row contents info))
5049 (t 'contents)))))))))))))))
5051 (defun org-table--to-generic-cell (params)
5052 "Return custom table cell transcoder according to PARAMS.
5053 PARAMS is a plist. See `orgtbl-to-generic' for more
5054 information."
5055 (let* ((backend (plist-get params :backend))
5056 (efmt (plist-get params :efmt))
5057 (fmt (plist-get params :fmt))
5058 (hfmt (plist-get params :hfmt))
5059 (sep (plist-get params :sep))
5060 (hsep (plist-get params :hsep)))
5061 `(lambda (cell contents info)
5062 (let ((headerp (org-export-table-row-in-header-p
5063 (org-export-get-parent-element cell) info))
5064 (column (1+ (cdr (org-export-table-cell-address cell info)))))
5065 ;; Make sure that contents are exported as Org data when :raw
5066 ;; parameter is non-nil.
5067 ,(when (and backend (plist-get params :raw))
5068 `(setq contents
5069 ;; Since we don't know what are the pseudo object
5070 ;; types defined in backend, we cannot pass them to
5071 ;; `org-element-interpret-data'. As a consequence,
5072 ;; they will be treated as pseudo elements, and
5073 ;; will have newlines appended instead of spaces.
5074 ;; Therefore, we must make sure :post-blank value
5075 ;; is really turned into spaces.
5076 (replace-regexp-in-string
5077 "\n" " "
5078 (org-trim
5079 (org-element-interpret-data
5080 (org-element-contents cell))))))
5081 (when contents
5082 ;; Check if we can apply `:efmt' on CONTENTS.
5083 ,(when efmt
5084 `(when (string-match orgtbl-exp-regexp contents)
5085 (let ((mantissa (match-string 1 contents))
5086 (exponent (match-string 2 contents)))
5087 (setq contents ,(org-table--generic-apply
5088 efmt ":efmt" t 'mantissa 'exponent)))))
5089 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5090 (cond
5091 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5092 hfmt ":hfmt" t 'contents))))
5093 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5094 fmt ":fmt" t 'contents))))))
5095 ;; If a separator is provided, use it instead of BACKEND's.
5096 ;; Separators are ignored when LFMT (or equivalent) is
5097 ;; provided.
5098 ,(cond
5099 ((or hsep sep)
5100 `(if (or ,(and (not sep) '(not headerp))
5101 (plist-get info :orgtbl-ignore-sep)
5102 (not (org-export-get-next-element cell info)))
5103 ,(if (not backend) 'contents
5104 `(org-export-with-backend ',backend cell contents info))
5105 (concat contents
5106 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5107 (or hsep sep)))))
5108 (backend `(org-export-with-backend ',backend cell contents info))
5109 (t 'contents))))))
5111 ;;;###autoload
5112 (defun orgtbl-to-tsv (table params)
5113 "Convert the orgtbl-mode table to TAB separated material."
5114 (orgtbl-to-generic table (org-combine-plists '(:sep "\t") params)))
5116 ;;;###autoload
5117 (defun orgtbl-to-csv (table params)
5118 "Convert the orgtbl-mode table to CSV material.
5119 This does take care of the proper quoting of fields with comma or quotes."
5120 (orgtbl-to-generic table
5121 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5122 params)))
5124 ;;;###autoload
5125 (defun orgtbl-to-latex (table params)
5126 "Convert the orgtbl-mode TABLE to LaTeX.
5128 TABLE is a list, each entry either the symbol `hline' for
5129 a horizontal separator line, or a list of fields for that line.
5130 PARAMS is a property list of parameters that can influence the
5131 conversion. All parameters from `orgtbl-to-generic' are
5132 supported. It is also possible to use the following ones:
5134 :booktabs
5136 When non-nil, use formal \"booktabs\" style.
5138 :environment
5140 Specify environment to use, as a string. If you use
5141 \"longtable\", you may also want to specify :language property,
5142 as a string, to get proper continuation strings."
5143 (require 'ox-latex)
5144 (orgtbl-to-generic
5145 table
5146 (org-combine-plists
5147 ;; Provide sane default values.
5148 (list :backend 'latex
5149 :latex-default-table-mode 'table
5150 :latex-tables-centered nil
5151 :latex-tables-booktabs (plist-get params :booktabs)
5152 :latex-table-scientific-notation nil
5153 :latex-default-table-environment
5154 (or (plist-get params :environment) "tabular"))
5155 params)))
5157 ;;;###autoload
5158 (defun orgtbl-to-html (table params)
5159 "Convert the orgtbl-mode TABLE to HTML.
5161 TABLE is a list, each entry either the symbol `hline' for
5162 a horizontal separator line, or a list of fields for that line.
5163 PARAMS is a property list of parameters that can influence the
5164 conversion. All parameters from `orgtbl-to-generic' are
5165 supported. It is also possible to use the following one:
5167 :attributes
5169 Attributes and values, as a plist, which will be used in
5170 <table> tag."
5171 (require 'ox-html)
5172 (orgtbl-to-generic
5173 table
5174 (org-combine-plists
5175 ;; Provide sane default values.
5176 (list :backend 'html
5177 :html-table-data-tags '("<td%s>" . "</td>")
5178 :html-table-use-header-tags-for-first-column nil
5179 :html-table-align-individual-fields t
5180 :html-table-row-tags '("<tr>" . "</tr>")
5181 :html-table-attributes
5182 (if (plist-member params :attributes)
5183 (plist-get params :attributes)
5184 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5185 :frame "hsides")))
5186 params)))
5188 ;;;###autoload
5189 (defun orgtbl-to-texinfo (table params)
5190 "Convert the orgtbl-mode TABLE to Texinfo.
5192 TABLE is a list, each entry either the symbol `hline' for
5193 a horizontal separator line, or a list of fields for that line.
5194 PARAMS is a property list of parameters that can influence the
5195 conversion. All parameters from `orgtbl-to-generic' are
5196 supported. It is also possible to use the following one:
5198 :columns
5200 Column widths, as a string. When providing column fractions,
5201 \"@columnfractions\" command can be omitted."
5202 (require 'ox-texinfo)
5203 (let ((output
5204 (orgtbl-to-generic
5205 table
5206 (org-combine-plists
5207 (list :backend 'texinfo
5208 :texinfo-tables-verbatim nil
5209 :texinfo-table-scientific-notation nil)
5210 params)))
5211 (columns (let ((w (plist-get params :columns)))
5212 (cond ((not w) nil)
5213 ((string-match-p "{\\|@columnfractions " w) w)
5214 (t (concat "@columnfractions " w))))))
5215 (if (not columns) output
5216 (replace-regexp-in-string
5217 "@multitable \\(.*\\)" columns output t nil 1))))
5219 ;;;###autoload
5220 (defun orgtbl-to-orgtbl (table params)
5221 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5223 TABLE is a list, each entry either the symbol `hline' for
5224 a horizontal separator line, or a list of fields for that line.
5225 PARAMS is a property list of parameters that can influence the
5226 conversion. All parameters from `orgtbl-to-generic' are
5227 supported.
5229 Useful when slicing one table into many. The :hline, :sep,
5230 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5231 be set to provide ORGTBL directives for the generated table."
5232 (require 'ox-org)
5233 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5235 (defun orgtbl-to-table.el (table params)
5236 "Convert the orgtbl-mode TABLE into a table.el table.
5237 TABLE is a list, each entry either the symbol `hline' for
5238 a horizontal separator line, or a list of fields for that line.
5239 PARAMS is a property list of parameters that can influence the
5240 conversion. All parameters from `orgtbl-to-generic' are
5241 supported."
5242 (with-temp-buffer
5243 (insert (orgtbl-to-orgtbl table params))
5244 (org-table-align)
5245 (replace-regexp-in-string
5246 "-|" "-+"
5247 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5249 (defun orgtbl-to-unicode (table params)
5250 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5252 TABLE is a list, each entry either the symbol `hline' for
5253 a horizontal separator line, or a list of fields for that line.
5254 PARAMS is a property list of parameters that can influence the
5255 conversion. All parameters from `orgtbl-to-generic' are
5256 supported. It is also possible to use the following ones:
5258 :ascii-art
5260 When non-nil, use \"ascii-art-to-unicode\" package to translate
5261 the table. You can download it here:
5262 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5264 :narrow
5266 When non-nil, narrow columns width than provided width cookie,
5267 using \"=>\" as an ellipsis, just like in an Org mode buffer."
5268 (require 'ox-ascii)
5269 (orgtbl-to-generic
5270 table
5271 (org-combine-plists
5272 (list :backend 'ascii
5273 :ascii-charset 'utf-8
5274 :ascii-table-widen-columns (not (plist-get params :narrow))
5275 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5276 params)))
5278 ;; Put the cursor in a column containing numerical values
5279 ;; of an Org table,
5280 ;; type C-c " a
5281 ;; A new column is added with a bar plot.
5282 ;; When the table is refreshed (C-u C-c *),
5283 ;; the plot is updated to reflect the new values.
5285 (defun orgtbl-ascii-draw (value min max &optional width characters)
5286 "Draw an ascii bar in a table.
5287 VALUE is the value to plot, it determines the width of the bar to draw.
5288 MIN is the value that will be displayed as empty (zero width bar).
5289 MAX is the value that will draw a bar filling all the WIDTH.
5290 WIDTH is the span in characters from MIN to MAX.
5291 CHARACTERS is a string that will compose the bar, with shades of grey
5292 from pure white to pure black. It defaults to a 10 characters string
5293 of regular ascii characters."
5294 (let* ((width (ceiling (or width 12)))
5295 (characters (or characters " .:;c!lhVHW"))
5296 (len (1- (length characters)))
5297 (value (float (if (numberp value)
5298 value (string-to-number value))))
5299 (relative (/ (- value min) (- max min)))
5300 (steps (round (* relative width len))))
5301 (cond ((< steps 0) "too small")
5302 ((> steps (* width len)) "too large")
5303 (t (let* ((int-division (/ steps len))
5304 (remainder (- steps (* int-division len))))
5305 (concat (make-string int-division (elt characters len))
5306 (string (elt characters remainder))))))))
5308 ;;;###autoload
5309 (defun orgtbl-ascii-plot (&optional ask)
5310 "Draw an ASCII bar plot in a column.
5312 With cursor in a column containing numerical values, this function
5313 will draw a plot in a new column.
5315 ASK, if given, is a numeric prefix to override the default 12
5316 characters width of the plot. ASK may also be the `\\[universal-argument]' \
5317 prefix,
5318 which will prompt for the width."
5319 (interactive "P")
5320 (let ((col (org-table-current-column))
5321 (min 1e999) ; 1e999 will be converted to infinity
5322 (max -1e999) ; which is the desired result
5323 (table (org-table-to-lisp))
5324 (length
5325 (cond ((consp ask)
5326 (read-number "Length of column " 12))
5327 ((numberp ask) ask)
5328 (t 12))))
5329 ;; Skip any hline a the top of table.
5330 (while (eq (car table) 'hline) (setq table (cdr table)))
5331 ;; Skip table header if any.
5332 (dolist (x (or (cdr (memq 'hline table)) table))
5333 (when (consp x)
5334 (setq x (nth (1- col) x))
5335 (when (string-match
5336 "^[-+]?\\([0-9]*[.]\\)?[0-9]*\\([eE][+-]?[0-9]+\\)?$"
5338 (setq x (string-to-number x))
5339 (when (> min x) (setq min x))
5340 (when (< max x) (setq max x)))))
5341 (org-table-insert-column)
5342 (org-table-move-column-right)
5343 (org-table-store-formulas
5344 (cons
5345 (cons
5346 (concat "$" (number-to-string (1+ col)))
5347 (format "'(%s $%s %s %s %s)"
5348 "orgtbl-ascii-draw" col min max length))
5349 (org-table-get-stored-formulas)))
5350 (org-table-recalculate t)))
5352 ;; Example of extension: unicode characters
5353 ;; Here are two examples of different styles.
5355 ;; Unicode block characters are used to give a smooth effect.
5356 ;; See http://en.wikipedia.org/wiki/Block_Elements
5357 ;; Use one of those drawing functions
5358 ;; - orgtbl-ascii-draw (the default ascii)
5359 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5360 ;; - orgtbl-uc-draw-cont (smooth unicode)
5362 ;; This is best viewed with the "DejaVu Sans Mono" font
5363 ;; (use M-x set-default-font).
5365 (defun orgtbl-uc-draw-grid (value min max &optional width)
5366 "Draw a bar in a table using block unicode characters.
5367 It is a variant of orgtbl-ascii-draw with Unicode block
5368 characters, for a smooth display. Bars appear as grids (to the
5369 extent the font allows)."
5370 ;; http://en.wikipedia.org/wiki/Block_Elements
5371 ;; best viewed with the "DejaVu Sans Mono" font.
5372 (orgtbl-ascii-draw value min max width
5373 " \u258F\u258E\u258D\u258C\u258B\u258A\u2589"))
5375 (defun orgtbl-uc-draw-cont (value min max &optional width)
5376 "Draw a bar in a table using block unicode characters.
5377 It is a variant of orgtbl-ascii-draw with Unicode block
5378 characters, for a smooth display. Bars are solid (to the extent
5379 the font allows)."
5380 (orgtbl-ascii-draw value min max width
5381 " \u258F\u258E\u258D\u258C\u258B\u258A\u2589\u2588"))
5383 (defun org-table-get-remote-range (name-or-id form)
5384 "Get a field value or a list of values in a range from table at ID.
5386 NAME-OR-ID may be the name of a table in the current file as set
5387 by a \"#+NAME:\" directive. The first table following this line
5388 will then be used. Alternatively, it may be an ID referring to
5389 any entry, also in a different file. In this case, the first
5390 table in that entry will be referenced.
5391 FORM is a field or range descriptor like \"@2$3\" or \"B3\" or
5392 \"@I$2..@II$2\". All the references must be absolute, not relative.
5394 The return value is either a single string for a single field, or a
5395 list of the fields in the rectangle."
5396 (save-match-data
5397 (let ((case-fold-search t) (id-loc nil)
5398 ;; Protect a bunch of variables from being overwritten by
5399 ;; the context of the remote table.
5400 org-table-column-names org-table-column-name-regexp
5401 org-table-local-parameters org-table-named-field-locations
5402 org-table-current-line-types
5403 org-table-current-begin-pos org-table-dlines
5404 org-table-current-ncol
5405 org-table-hlines org-table-last-alignment
5406 org-table-last-column-widths org-table-last-alignment
5407 org-table-last-column-widths
5408 buffer loc)
5409 (setq form (org-table-convert-refs-to-rc form))
5410 (org-with-wide-buffer
5411 (goto-char (point-min))
5412 (if (re-search-forward
5413 (concat "^[ \t]*#\\+\\(tbl\\)?name:[ \t]*"
5414 (regexp-quote name-or-id) "[ \t]*$")
5415 nil t)
5416 (setq buffer (current-buffer) loc (match-beginning 0))
5417 (setq id-loc (org-id-find name-or-id 'marker))
5418 (unless (and id-loc (markerp id-loc))
5419 (user-error "Can't find remote table \"%s\"" name-or-id))
5420 (setq buffer (marker-buffer id-loc)
5421 loc (marker-position id-loc))
5422 (move-marker id-loc nil))
5423 (with-current-buffer buffer
5424 (org-with-wide-buffer
5425 (goto-char loc)
5426 (forward-char 1)
5427 (unless (and (re-search-forward "^\\(\\*+ \\)\\|^[ \t]*|" nil t)
5428 (not (match-beginning 1)))
5429 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5430 (org-table-analyze)
5431 (setq form (org-table-formula-substitute-names
5432 (org-table-formula-handle-first/last-rc form)))
5433 (if (and (string-match org-table-range-regexp form)
5434 (> (length (match-string 0 form)) 1))
5435 (org-table-get-range
5436 (match-string 0 form) org-table-current-begin-pos 1)
5437 form)))))))
5439 (defun org-table-remote-reference-indirection (form)
5440 "Return formula with table remote references substituted by indirection.
5441 For example \"remote($1, @>$2)\" => \"remote(year_2013, @>$1)\".
5442 This indirection works only with the format @ROW$COLUMN. The
5443 format \"B3\" is not supported because it can not be
5444 distinguished from a plain table name or ID."
5445 (let ((regexp
5446 ;; Same as in `org-table-eval-formula'.
5447 (concat "\\<remote([ \t]*\\("
5448 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5449 "[@$][^ \t,]+"
5450 "\\)[ \t]*,[ \t]*\\([^\n)]+\\))")))
5451 (replace-regexp-in-string
5452 regexp
5453 (lambda (m)
5454 (save-match-data
5455 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5456 (org-table-get-range
5457 (if (string-match-p "\\`\\$[0-9]+\\'" eq)
5458 (concat "@0" eq)
5459 eq)))))
5460 form t t 1)))
5462 (defmacro org-define-lookup-function (mode)
5463 (let ((mode-str (symbol-name mode))
5464 (first-p (eq mode 'first))
5465 (all-p (eq mode 'all)))
5466 (let ((plural-str (if all-p "s" "")))
5467 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5468 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5469 If R-LIST is nil, return matching element%s of S-LIST.
5470 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5471 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5472 This function is generated by a call to the macro `org-define-lookup-function'."
5473 mode-str plural-str plural-str plural-str)
5474 (let ,(let ((lvars '((p (or predicate 'equal))
5475 (sl s-list)
5476 (rl (or r-list s-list))
5477 (ret nil))))
5478 (if first-p (cons '(match-p nil) lvars) lvars))
5479 (while ,(if first-p '(and (not match-p) sl) 'sl)
5480 (when (funcall p val (car sl))
5481 ,(when first-p '(setq match-p t))
5482 (let ((rval (car rl)))
5483 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5484 (setq sl (cdr sl) rl (cdr rl)))
5485 ret)))))
5487 (org-define-lookup-function first)
5488 (org-define-lookup-function last)
5489 (org-define-lookup-function all)
5491 (provide 'org-table)
5493 ;; Local variables:
5494 ;; generated-autoload-file: "org-loaddefs.el"
5495 ;; End:
5497 ;;; org-table.el ends here