1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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.
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"
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"
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
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
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."
97 (defcustom orgtbl-radio-table-templates
98 '((latex-mode "% BEGIN RECEIVE ORGTBL %n
99 % END RECEIVE ORGTBL %n
101 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
104 (texinfo-mode "@c BEGIN RECEIVE ORGTBL %n
105 @c END RECEIVE ORGTBL %n
107 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
110 (html-mode "<!-- BEGIN RECEIVE ORGTBL %n -->
111 <!-- END RECEIVE ORGTBL %n -->
113 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
116 (org-mode "#+ BEGIN RECEIVE ORGTBL %n
117 #+ END RECEIVE ORGTBL %n
119 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
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
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."
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"
151 (defcustom org-table-default-size
"5x2"
152 "The default size for newly created tables, Columns x Rows."
153 :group
'org-table-settings
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
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
171 (const :tag
"Positive Integers"
173 (const :tag
"Integers"
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
195 (defgroup org-table-editing nil
196 "Behavior of tables during editing in Org mode."
197 :tag
"Org Table Editing"
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
204 :group
'org-table-editing
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
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
226 (defcustom org-table-fix-formulas-confirm nil
227 "Whether the user should confirm when Org fixes formulas."
228 :group
'org-table-editing
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
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
244 :group
'org-table-editing
247 (defgroup org-table-calculation nil
248 "Options concerning tables in Org mode."
249 :tag
"Org Table Calculation"
252 (defcustom org-table-use-standard-references
'from
253 "Non-nil means using table references like B3 instead of @3$2.
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
258 :group
'org-table-calculation
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
269 :package-version
'(Org .
"8.3")
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)
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
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
297 :group
'org-table-calculation
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
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
319 When this variable is nil, formula calculation is only available through
320 the command `\\[org-table-eval-formula]'."
321 :group
'org-table-calculation
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
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
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.
353 Automatically means when `TAB' or `RET' or `\\[org-ctrl-c-ctrl-c]' \
354 are pressed in the line."
355 :group
'org-table-calculation
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
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
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
382 :package-version
'(Org .
"8.3")
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"
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
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
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]+\\)?\\)?"
474 "Regular expression for matching ranges in formulas.")
476 (defconst org-table-range-regexp2
478 "\\(" "@[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)"
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)))
497 (org-table-goto-column ,column
)
498 (set-marker ,line nil
)))))
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."
509 (if (y-or-n-p "Convert table to Org table? ")
510 (org-table-convert)))
512 (when (y-or-n-p "Convert table to table.el table? ")
514 (org-table-convert)))
515 (t (call-interactively 'table-insert
))))
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
524 If there is no such region, create an empty table with `org-table-create'."
526 (if (org-region-active-p)
527 (org-table-convert-region (region-beginning) (region-end) arg
)
528 (org-table-create arg
)))
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\"."
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
)))
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
" |"))
548 (if (string-match "^[ \t]*$" (buffer-substring-no-properties
549 (point-at-bol) (point)))
550 (beginning-of-line 1)
552 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
553 (dotimes (_ rows
) (insert line
))
556 ;; Insert a hline after the first row.
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
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."
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")))
593 (beginning-of-line 1)
594 (setq beg
(point-marker))
596 (if (bolp) (backward-char 1) (end-of-line 1))
597 (setq end
(point-marker))
598 ;; Get the right field separator
603 ((not (re-search-forward "^[^\n\t]+$" end t
)) '(16))
604 ((not (re-search-forward "^[^\n,]+$" end t
)) '(4))
607 (if (equal separator
'(4))
608 (while (< (point) end
)
609 ;; parse the csv stuff
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))))
620 ((equal separator
'(4)) "^\\|\"?[ \t]*,[ \t]*\"?")
621 ((equal separator
'(16)) "^\\|\t")
622 ((integerp separator
)
624 (user-error "Number of spaces in separator must be >= 1")
625 (format "^ *\\| *\t *\\| \\{%d,\\}" 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
)))
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."
641 (or (bolp) (newline))
644 (insert-file-contents file
)
645 (org-table-convert-region beg
(+ (point) (- (point-max) pm
)) arg
)))
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'."
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
))))
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))
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
))))
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"))
687 (replace-regexp-in-string
689 (replace-regexp-in-string
694 (and (string-match-p fileext f
) f
))
696 org-table-export-default-format
)
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
))
711 (with-current-buffer (find-file-noselect file
)
712 (setq buf
(current-buffer))
715 (insert (funcall transform table params
) "\n")
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.")
745 (defun org-table-align ()
746 "Align the table at point by aligning all vertical bars."
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
)
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
)
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
" *| *"))
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
""))
779 ;; Check for special formatting.
780 (dotimes (i maxfields
)
781 (let ((column (mapcar (lambda (x) (or (nth i x
) "")) fields
))
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
788 "| *<[lrc]?[0-9]+> *\\(|\\|$\\)" end t
))))
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.
799 (when (> (org-string-width x
) fmax
)
803 "Clipped table field, use `\\[org-table-edit-field]' to \
804 edit. Full value is:\n"
805 (substring-no-properties x
)))
808 (or (string-match org-bracket-link-regexp x
)
813 "Cannot narrow field starting with wide link \"%s\""
815 (if (= (org-string-width x
) l
) (setq f2 f1
)
817 (while (< (org-string-width (substring x
0 f2
)) f1
)
819 (add-text-properties f2 l
(list 'org-cwidth t
) x
)
821 (if (>= (string-width (substring x
(1- f2
) f2
)) 2) (1- f2
)
824 (list 'display org-narrow-column-arrow
)
826 ;; Get the maximum width for each column
827 (push (apply #'max
(or fmax
1) 1 (mapcar #'org-string-width column
))
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
)
838 (if (string-match-p org-table-number-regexp x
)
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
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
)))
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
"|"))
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.
883 (if l
(apply #'format rfmt
(append (pop fields
) emptycells
))
885 (previous (buffer-substring (point) (line-end-position))))
886 (if (and (equal previous line
)
890 (setq a
(next-single-property-change
891 a
'org-cwidth previous
))
892 (setq b
(next-single-property-change
893 b
'org-cwidth line
)))
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
)))
903 (when org-table-overlay-coordinates
(org-table-overlay-coordinates))
904 (setq org-table-may-need-update nil
)))))
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
913 (org-element-property :post-affiliated
(org-element-at-point)))
915 (and (re-search-backward org-table-border-regexp nil t
)
916 (line-beginning-position 2))))
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
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
)
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
937 (t (goto-char (point-max))
938 (skip-chars-backward " \t")
939 (if (bolp) (point) (line-end-position))))))
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."
946 ((and (not new
) org-table-may-need-update
)) ; Realignment will happen anyway
947 ((org-at-table-hline-p))
949 (or (not (eq (marker-buffer org-table-aligned-begin-marker
)
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.
958 (col (org-table-current-column)))
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
)
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
))))))))
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."
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
)
994 (let ((end (org-table-end)))
995 (if (org-at-table-hline-p)
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 "-")
1008 (beginning-of-line 0)
1009 (org-table-insert-row 'below
))
1010 (if (looking-at " ") (forward-char 1))))
1012 (org-table-insert-row 'below
)))))
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."
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
)
1024 (if (org-at-table-hline-p)
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
1040 With numeric argument N, move N-1 fields backward first."
1042 (let ((pos (point)))
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."
1057 (let ((pos (point)))
1060 (org-table-next-field))
1061 (when (re-search-forward "|" (point-at-eol 1) t
)
1063 (skip-chars-backward " ")
1064 (if (and (equal (char-before (point)) ?|
) (looking-at " "))
1066 (if (<= (point) pos
) (org-table-end-of-field 2))))
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."
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)))
1078 (if (and org-table-automatic-realign
1079 org-table-may-need-update
)
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))
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)))))
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
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."
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))
1122 (org-table-check-inside-data-field)
1127 (while (progn (beginning-of-line 1)
1128 (re-search-backward org-table-dataline-regexp
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))))))
1137 (while (progn (beginning-of-line 1)
1138 (re-search-backward org-table-dataline-regexp
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
)))
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
))))
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
)))))
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))
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]*$"))))
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
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)))
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))
1218 (goto-char (org-table-begin))
1219 (while (and (re-search-forward org-table-dataline-regexp end t
)
1221 (< (point-at-eol) pos
))))
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
)))
1234 (defun org-table-blank-field ()
1235 "Blank the current table field or active region."
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 "^|")
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 column. If REPLACE is a string, replace
1254 field with this value. The return value is always the old
1256 (when n
(org-table-goto-column n
))
1257 (skip-chars-backward "^|\n")
1258 (if (or (bolp) (looking-at-p "[ \t]*$"))
1259 ;; Before first column or after last one.
1261 (looking-at "[^|\r\n]*")
1262 (let* ((pos (match-beginning 0))
1263 (val (buffer-substring pos
(match-end 0))))
1265 (replace-match (if (equal replace
"") " " replace
) t t
))
1266 (goto-char (min (line-end-position) (1+ pos
)))
1270 (defun org-table-field-info (_arg)
1271 "Show info about the current field, and highlight any reference at point."
1273 (unless (org-at-table-p) (user-error "Not at a table"))
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))
1282 org-table-named-field-locations
)))
1283 (eql (org-table-expand-lhs-ranges
1286 (cons (org-table-formula-handle-first/last-rc
(car 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
)))
1299 (ignore-errors (org-table-show-reference 'local
))
1300 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
1302 (if cname
(concat " or $" cname
) "")
1304 (if name
(concat " or $" name
) "")
1305 ;; FIXME: formula info not correct if special table line
1307 (concat ", formula: "
1308 (org-table-formula-to-user
1310 (if (or (string-prefix-p "$" (car eqn
))
1311 (string-prefix-p "@" (car eqn
)))
1314 (car eqn
) "=" (cdr eqn
))))
1317 (defun org-table-current-column ()
1318 "Find out which column we are in."
1320 (when (called-interactively-p 'any
) (org-table-check-inside-data-field))
1322 (let ((column 0) (pos (point)))
1324 (while (search-forward "|" pos t
) (cl-incf column
))
1325 (when (called-interactively-p 'interactive
)
1326 (message "In table column %d" column
))
1330 (defun org-table-current-dline ()
1331 "Find out what table data line we are in.
1332 Only data lines count for this."
1334 (when (called-interactively-p 'any
)
1335 (org-table-check-inside-data-field))
1339 (goto-char (org-table-begin))
1340 (while (<= (point) pos
)
1341 (when (looking-at org-table-dataline-regexp
) (cl-incf c
))
1343 (when (called-interactively-p 'any
)
1344 (message "This is table line %d" c
))
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
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."
1355 (beginning-of-line 1)
1357 (while (and (> (setq n
(1- n
)) -
1)
1358 (or (search-forward "|" (point-at-eol) t
)
1360 (progn (end-of-line 1)
1361 (skip-chars-backward "^|")
1364 (when (and force
(not (looking-at ".*|")))
1365 (save-excursion (end-of-line 1) (insert " | ")))
1368 (if (looking-at " ") (forward-char 1)))))
1371 (defun org-table-insert-column ()
1372 "Insert a new column into the table."
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
1381 (while (< (point) end
)
1382 (unless (org-at-table-hline-p)
1383 (org-table-goto-column col t
)
1386 (set-marker end nil
)
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)))
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."
1421 (max (1- (length org-table-dlines
))))
1422 (cond ((or (> (aref org-table-dlines min
) line
)
1423 (< (aref org-table-dlines max
) line
))
1425 ((= (aref org-table-dlines max
) line
) max
)
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
))))))
1436 (defun org-table-delete-column ()
1437 "Delete a column from the table."
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
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 "|")))
1454 (set-marker end nil
)
1455 (org-table-goto-column (max 1 (1- col
)))
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
))))
1465 (defun org-table-move-column-right ()
1466 "Move column to the right."
1468 (org-table-move-column nil
))
1470 (defun org-table-move-column-left ()
1471 "Move column to the left."
1473 (org-table-move-column 'left
))
1476 (defun org-table-move-column (&optional left
)
1477 "Move the current column to the right. With arg LEFT, move to the left."
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
1493 (while (< (point) end
)
1494 (unless (org-at-table-hline-p)
1495 (org-table-goto-column col1 t
)
1496 (when (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
1498 (match-beginning 1) (match-end 1)
1499 (match-beginning 2) (match-end 2))))
1501 (set-marker end nil
)
1502 (org-table-goto-column colpos
)
1504 (when (or (not org-table-fix-formulas-confirm
)
1505 (funcall org-table-fix-formulas-confirm
"Fix formulas? "))
1506 (org-table-fix-formulas
1507 "$" (list (cons (number-to-string col
) (number-to-string colpos
))
1508 (cons (number-to-string colpos
) (number-to-string col
))))
1509 (org-table-fix-formulas
1510 "$LR" (list (cons (number-to-string col
) (number-to-string colpos
))
1511 (cons (number-to-string colpos
) (number-to-string col
)))))))
1514 (defun org-table-move-row-down ()
1515 "Move table row down."
1517 (org-table-move-row nil
))
1519 (defun org-table-move-row-up ()
1520 "Move table row up."
1522 (org-table-move-row 'up
))
1525 (defun org-table-move-row (&optional up
)
1526 "Move the current table line down. With arg UP, move it up."
1528 (let* ((col (current-column))
1530 (hline1p (save-excursion (beginning-of-line 1)
1531 (looking-at org-table-hline-regexp
)))
1532 (dline1 (org-table-current-dline))
1533 (dline2 (+ dline1
(if up -
1 1)))
1536 (beginning-of-line tonew
)
1537 (unless (org-at-table-p)
1539 (user-error "Cannot move row further"))
1540 (setq hline2p
(looking-at org-table-hline-regexp
))
1542 (beginning-of-line 1)
1544 (setq txt
(buffer-substring (point) (1+ (point-at-eol))))
1545 (delete-region (point) (1+ (point-at-eol)))
1546 (beginning-of-line tonew
)
1548 (beginning-of-line 0)
1549 (org-move-to-column col
)
1550 (unless (or hline1p hline2p
1551 (not (or (not org-table-fix-formulas-confirm
)
1552 (funcall org-table-fix-formulas-confirm
1553 "Fix formulas? "))))
1554 (org-table-fix-formulas
1555 "@" (list (cons (number-to-string dline1
) (number-to-string dline2
))
1556 (cons (number-to-string dline2
) (number-to-string dline1
)))))))
1559 (defun org-table-insert-row (&optional arg
)
1560 "Insert a new row above the current line into the table.
1561 With prefix ARG, insert below the current line."
1563 (unless (org-at-table-p) (user-error "Not at a table"))
1564 (let* ((line (buffer-substring (line-beginning-position) (line-end-position)))
1565 (new (org-table-clean-line line
)))
1566 ;; Fix the first field if necessary
1567 (if (string-match "^[ \t]*| *[#$] *|" line
)
1568 (setq new
(replace-match (match-string 0 line
) t t new
)))
1569 (beginning-of-line (if arg
2 1))
1570 ;; Buffer may not end of a newline character, so ensure
1571 ;; (beginning-of-line 2) moves point to a new line.
1572 (unless (bolp) (insert "\n"))
1573 (let (org-table-may-need-update) (insert-before-markers new
"\n"))
1574 (beginning-of-line 0)
1575 (re-search-forward "| ?" (line-end-position) t
)
1576 (when (or org-table-may-need-update org-table-overlay-coordinates
)
1578 (when (or (not org-table-fix-formulas-confirm
)
1579 (funcall org-table-fix-formulas-confirm
"Fix formulas? "))
1580 (org-table-fix-formulas "@" nil
(1- (org-table-current-dline)) 1))))
1583 (defun org-table-insert-hline (&optional above
)
1584 "Insert a horizontal-line below the current line into the table.
1585 With prefix ABOVE, insert above the current line."
1587 (if (not (org-at-table-p))
1588 (user-error "Not at a table"))
1589 (when (eobp) (insert "\n") (backward-char 1))
1590 (if (not (string-match-p "|[ \t]*$" (org-current-line-string)))
1592 (let ((line (org-table-clean-line
1593 (buffer-substring (point-at-bol) (point-at-eol))))
1594 (col (current-column)))
1595 (while (string-match "|\\( +\\)|" line
)
1596 (setq line
(replace-match
1597 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
1598 ?-
) "|") t t line
)))
1599 (and (string-match "\\+" line
) (setq line
(replace-match "|" t t line
)))
1600 (beginning-of-line (if above
1 2))
1602 (beginning-of-line (if above
1 -
1))
1603 (org-move-to-column col
)
1604 (and org-table-overlay-coordinates
(org-table-align))))
1607 (defun org-table-hline-and-move (&optional same-column
)
1608 "Insert a hline and move to the row below that line."
1610 (let ((col (org-table-current-column)))
1611 (org-table-maybe-eval-formula)
1612 (org-table-maybe-recalculate-line)
1613 (org-table-insert-hline)
1615 (if (looking-at "\n[ \t]*|-")
1616 (progn (insert "\n|") (org-table-align))
1617 (org-table-next-field))
1618 (if same-column
(org-table-goto-column col
))))
1620 (defun org-table-clean-line (s)
1621 "Convert a table line S into a string with only \"|\" and space.
1622 In particular, this does handle wide and invisible characters."
1623 (if (string-match "^[ \t]*|-" s
)
1624 ;; It's a hline, just map the characters
1625 (setq s
(mapconcat (lambda (x) (if (member x
'(?| ?
+)) "|" " ")) s
""))
1626 (while (string-match "|\\([ \t]*?[^ \t\r\n|][^\r\n|]*\\)|" s
)
1627 (setq s
(replace-match
1628 (concat "|" (make-string (org-string-width (match-string 1 s
))
1634 (defun org-table-kill-row ()
1635 "Delete the current row or horizontal line from the table."
1637 (if (not (org-at-table-p))
1638 (user-error "Not at a table"))
1639 (let ((col (current-column))
1640 (dline (org-table-current-dline)))
1641 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
1642 (if (not (org-at-table-p)) (beginning-of-line 0))
1643 (org-move-to-column col
)
1644 (when (or (not org-table-fix-formulas-confirm
)
1645 (funcall org-table-fix-formulas-confirm
"Fix formulas? "))
1646 (org-table-fix-formulas "@" (list (cons (number-to-string dline
) "INVALID"))
1650 (defun org-table-sort-lines
1651 (&optional with-case sorting-type getkey-func compare-func interactive?
)
1652 "Sort table lines according to the column at point.
1654 The position of point indicates the column to be used for
1655 sorting, and the range of lines is the range between the nearest
1656 horizontal separator lines, or the entire table of no such lines
1657 exist. If point is before the first column, you will be prompted
1658 for the sorting column. If there is an active region, the mark
1659 specifies the first line and the sorting column, while point
1660 should be in the last line to be included into the sorting.
1662 The command then prompts for the sorting type which can be
1663 alphabetically, numerically, or by time (as given in a time stamp
1664 in the field, or as a HH:MM value). Sorting in reverse order is
1667 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1669 If SORTING-TYPE is specified when this function is called from a Lisp
1670 program, no prompting will take place. SORTING-TYPE must be a character,
1671 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1672 sorting should be done in reverse order.
1674 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1675 a function to be called to extract the key. It must return a value
1676 that is compatible with COMPARE-FUNC, the function used to compare
1679 A non-nil value for INTERACTIVE? is used to signal that this
1680 function is being called interactively."
1681 (interactive (list current-prefix-arg nil nil nil t
))
1682 (when (org-region-active-p) (goto-char (region-beginning)))
1683 ;; Point must be either within a field or before a data line.
1685 (skip-chars-backward " \t")
1686 (when (bolp) (search-forward "|" (line-end-position) t
))
1687 (org-table-check-inside-data-field))
1688 ;; Set appropriate case sensitivity and column used for sorting.
1689 (let ((column (let ((c (org-table-current-column)))
1692 (read-number "Use column N for sorting: "))
1696 (read-char-exclusive "Sort Table: [a]lphabetic, [n]umeric, \
1697 \[t]ime, [f]unc. A/N/T/F means reversed: "))))
1699 ;; Narrow buffer to appropriate sorting area.
1700 (if (org-region-active-p)
1701 (progn (goto-char (region-beginning))
1704 (save-excursion (goto-char (region-end))
1705 (line-beginning-position 2))))
1706 (let ((start (org-table-begin))
1707 (end (org-table-end)))
1710 (if (re-search-backward org-table-hline-regexp start t
)
1711 (line-beginning-position 2)
1713 (if (save-excursion (re-search-forward org-table-hline-regexp end t
))
1716 ;; Determine arguments for `sort-subr'. Also record original
1717 ;; position. `org-table-save-field' cannot help here since
1718 ;; sorting is too much destructive.
1719 (let* ((sort-fold-case (not with-case
))
1721 (cons (count-lines (point-min) (line-beginning-position))
1723 (extract-key-from-field
1724 ;; Function to be called on the contents of the field
1725 ;; used for sorting in the current row.
1726 (cl-case sorting-type
1727 ((?n ?N
) #'string-to-number
)
1728 ((?a ?A
) #'org-sort-remove-invisible
)
1731 (cond ((string-match org-ts-regexp-both f
)
1733 (org-time-string-to-time (match-string 0 f
))))
1734 ((string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" f
)
1735 (org-hh:mm-string-to-minutes f
))
1740 (org-read-function "Function for extracting keys: "))
1741 (error "Missing key extractor to sort rows")))
1742 (t (user-error "Invalid sorting type `%c'" sorting-type
))))
1744 (cl-case sorting-type
1751 (concat "Function for comparing keys "
1752 "(empty for default `sort-subr' predicate): ")
1754 (goto-char (point-min))
1755 (sort-subr (memq sorting-type
'(?A ?N ?T ?F
))
1758 (while (and (not (eobp))
1759 (not (looking-at org-table-dataline-regexp
)))
1763 (funcall extract-key-from-field
1764 (org-trim (org-table-get-field column
))))
1767 ;; Move back to initial field.
1768 (forward-line (car coordinates
))
1769 (move-to-column (cdr coordinates
))))))
1772 (defun org-table-cut-region (beg end
)
1773 "Copy region in table to the clipboard and blank all relevant fields.
1774 If there is no active region, use just the field at point."
1776 (if (org-region-active-p) (region-beginning) (point))
1777 (if (org-region-active-p) (region-end) (point))))
1778 (org-table-copy-region beg end
'cut
))
1781 (defun org-table-copy-region (beg end
&optional cut
)
1782 "Copy rectangular region in table to clipboard.
1783 A special clipboard is used which can only be accessed
1784 with `org-table-paste-rectangle'."
1786 (if (org-region-active-p) (region-beginning) (point))
1787 (if (org-region-active-p) (region-end) (point))
1788 current-prefix-arg
))
1789 (goto-char (min beg end
))
1790 (org-table-check-inside-data-field)
1791 (let ((beg (line-beginning-position))
1792 (c01 (org-table-current-column))
1794 (goto-char (max beg end
))
1795 (org-table-check-inside-data-field)
1796 (let* ((end (copy-marker (line-end-position)))
1797 (c02 (org-table-current-column))
1798 (column-start (min c01 c02
))
1799 (column-end (max c01 c02
))
1800 (column-number (1+ (- column-end column-start
)))
1801 (rpl (and cut
" ")))
1803 (while (< (point) end
)
1804 (unless (org-at-table-hline-p)
1805 ;; Collect every cell between COLUMN-START and COLUMN-END.
1807 (dotimes (c column-number
)
1808 (push (org-table-get-field (+ c column-start
) rpl
) cols
))
1809 (push (nreverse cols
) region
)))
1811 (set-marker end nil
))
1812 (when cut
(org-table-align))
1813 (setq org-table-clip
(nreverse region
))))
1816 (defun org-table-paste-rectangle ()
1817 "Paste a rectangular region into a table.
1818 The upper right corner ends up in the current field. All involved fields
1819 will be overwritten. If the rectangle does not fit into the present table,
1820 the table is enlarged as needed. The process ignores horizontal separator
1823 (unless (consp org-table-clip
)
1824 (user-error "First cut/copy a region to paste!"))
1825 (org-table-check-inside-data-field)
1826 (let* ((column (org-table-current-column))
1827 (org-enable-table-editor t
)
1828 (org-table-automatic-realign nil
))
1829 (org-table-save-field
1830 (dolist (row org-table-clip
)
1831 (while (org-at-table-hline-p) (forward-line))
1832 ;; If we left the table, create a new row.
1833 (when (and (bolp) (not (looking-at "[ \t]*|")))
1835 (org-table-next-field))
1838 (org-table-goto-column c nil
'force
)
1839 (org-table-get-field nil field
)
1845 (defun org-table-convert ()
1846 "Convert from `org-mode' table to table.el and back.
1847 Obviously, this only works within limits. When an Org table is converted
1848 to table.el, all horizontal separator lines get lost, because table.el uses
1849 these as cell boundaries and has no notion of horizontal lines. A table.el
1850 table can be converted to an Org table only if it does not do row or column
1851 spanning. Multiline cells will become multiple cells. Beware, Org mode
1852 does not test if the table can be successfully converted - it blindly
1853 applies a recipe that works for simple tables."
1856 (if (org-at-table.el-p
)
1857 ;; convert to Org table
1858 (let ((beg (copy-marker (org-table-begin t
)))
1859 (end (copy-marker (org-table-end t
))))
1860 (table-unrecognize-region beg end
)
1862 (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t
)
1865 (if (org-at-table-p)
1866 ;; convert to table.el table
1867 (let ((beg (copy-marker (org-table-begin)))
1868 (end (copy-marker (org-table-end))))
1869 ;; first, get rid of all horizontal lines
1871 (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t
)
1873 ;; insert a hline before first
1875 (org-table-insert-hline 'above
)
1876 (beginning-of-line -
1)
1877 ;; insert a hline after each line
1878 (while (progn (beginning-of-line 3) (< (point) end
))
1879 (org-table-insert-hline))
1881 (setq end
(move-marker end
(org-table-end)))
1882 ;; replace "+" at beginning and ending of hlines
1883 (while (re-search-forward "^\\([ \t]*\\)|-" end t
)
1884 (replace-match "\\1+-"))
1886 (while (re-search-forward "-|[ \t]*$" end t
)
1887 (replace-match "-+"))
1890 (defun org-table-transpose-table-at-point ()
1891 "Transpose Org table at point and eliminate hlines.
1899 will be transposed as
1906 Note that horizontal lines disappear."
1908 (let* ((table (delete 'hline
(org-table-to-lisp)))
1909 (dline_old (org-table-current-line))
1910 (col_old (org-table-current-column))
1911 (contents (mapcar (lambda (_)
1917 (setq tp
(cdr tp
))))
1920 (goto-char (org-table-begin))
1921 (re-search-forward "|")
1923 (delete-region (point) (org-table-end))
1926 (concat "| " (mapconcat 'identity x
" | " ) " |\n" ))
1928 (org-table-goto-line col_old
)
1929 (org-table-goto-column dline_old
))
1933 (defun org-table-wrap-region (arg)
1934 "Wrap several fields in a column like a paragraph.
1935 This is useful if you'd like to spread the contents of a field over several
1936 lines, in order to keep the table compact.
1938 If there is an active region, and both point and mark are in the same column,
1939 the text in the column is wrapped to minimum width for the given number of
1940 lines. Generally, this makes the table more compact. A prefix ARG may be
1941 used to change the number of desired lines. For example, \
1942 `C-2 \\[org-table-wrap-region]'
1943 formats the selected text to two lines. If the region was longer than two
1944 lines, the remaining lines remain empty. A negative prefix argument reduces
1945 the current number of lines by that amount. The wrapped text is pasted back
1946 into the table. If you formatted it to more lines than it was before, fields
1947 further down in the table get overwritten - so you might need to make space in
1950 If there is no region, the current field is split at the cursor position and
1951 the text fragment to the right of the cursor is prepended to the field one
1954 If there is no region, but you specify a prefix ARG, the current field gets
1955 blank, and the content is appended to the field above."
1957 (org-table-check-inside-data-field)
1958 (if (org-region-active-p)
1959 ;; There is a region: fill as a paragraph.
1960 (let ((start (region-beginning)))
1961 (org-table-cut-region (region-beginning) (region-end))
1962 (when (> (length (car org-table-clip
)) 1)
1963 (user-error "Region must be limited to single column"))
1964 (let ((nlines (cond ((not arg
) (length org-table-clip
))
1965 ((< arg
1) (+ (length org-table-clip
) arg
))
1967 (setq org-table-clip
1969 (org-wrap (mapconcat #'car org-table-clip
" ")
1973 (org-table-paste-rectangle))
1974 ;; No region, split the current field at point.
1975 (unless (org-get-alist-option org-M-RET-may-split-line
'table
)
1976 (skip-chars-forward "^\r\n|"))
1978 (arg ; Combine with field above.
1979 (let ((s (org-table-blank-field))
1980 (col (org-table-current-column)))
1982 (while (org-at-table-hline-p) (forward-line -
1))
1983 (org-table-goto-column col
)
1984 (skip-chars-forward "^|")
1985 (skip-chars-backward " ")
1986 (insert " " (org-trim s
))
1988 ((looking-at "\\([^|]+\\)+|") ; Split field.
1989 (let ((s (match-string 1)))
1990 (replace-match " |")
1991 (goto-char (match-beginning 0))
1992 (org-table-next-row)
1993 (insert (org-trim s
) " ")
1995 (t (org-table-next-row)))))
1997 (defvar org-field-marker nil
)
2000 (defun org-table-edit-field (arg)
2001 "Edit table field in a different window.
2002 This is mainly useful for fields that contain hidden parts. When called
2003 with a `\\[universal-argument]' prefix, just make the full field \
2004 visible so that it can be
2009 (org-table-follow-field-mode (if org-table-follow-field-mode -
1 1)))
2011 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
2012 (e (save-excursion (skip-chars-forward "^|\r\n") (point))))
2013 (remove-text-properties b e
'(org-cwidth t invisible t
2014 display t intangible t
))
2015 (if (and (boundp 'font-lock-mode
) font-lock-mode
)
2016 (font-lock-fontify-block))))
2018 (let ((pos (point-marker))
2020 (if (eq org-table-use-standard-references t
)
2021 (concat (org-number-to-letters (org-table-current-column))
2022 (int-to-string (org-table-current-dline)))
2023 (concat "@" (int-to-string (org-table-current-dline))
2024 "$" (int-to-string (org-table-current-column)))))
2025 (field (org-table-get-field))
2026 (cw (current-window-configuration))
2029 (org-switch-to-buffer-other-window "*Org Table Edit Field*")
2030 (when (and (local-variable-p 'org-field-marker
)
2031 (markerp org-field-marker
))
2032 (move-marker org-field-marker nil
))
2034 (insert "#\n# Edit field " coord
" and finish with C-c C-c\n#\n")
2035 (let ((org-inhibit-startup t
)) (org-mode))
2037 (setq truncate-lines nil
)
2039 (goto-char (setq p
(point-max)))
2040 (insert (org-trim field
))
2041 (remove-text-properties p
(point-max)
2042 '(invisible t org-cwidth t display t
2045 (setq-local org-finish-function
'org-table-finish-edit-field
)
2046 (setq-local org-window-configuration cw
)
2047 (setq-local org-field-marker pos
)
2048 (message "Edit and finish with C-c C-c")))))
2050 (defun org-table-finish-edit-field ()
2051 "Finish editing a table data field.
2052 Remove all newline characters, insert the result into the table, realign
2053 the table and kill the editing buffer."
2054 (let ((pos org-field-marker
)
2055 (cw org-window-configuration
)
2056 (cb (current-buffer))
2058 (goto-char (point-min))
2059 (while (re-search-forward "^#.*\n?" nil t
) (replace-match ""))
2060 (while (re-search-forward "\\([ \t]*\n[ \t]*\\)+" nil t
)
2061 (replace-match " "))
2062 (setq text
(org-trim (buffer-string)))
2063 (set-window-configuration cw
)
2065 (select-window (get-buffer-window (marker-buffer pos
)))
2067 (move-marker pos nil
)
2068 (org-table-check-inside-data-field)
2069 (org-table-get-field nil text
)
2071 (message "New field value inserted")))
2073 (define-minor-mode org-table-follow-field-mode
2074 "Minor mode to make the table field editor window follow the cursor.
2075 When this mode is active, the field editor window will always show the
2076 current field. The mode exits automatically when the cursor leaves the
2077 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2078 nil
" TblFollow" nil
2079 (if org-table-follow-field-mode
2080 (add-hook 'post-command-hook
'org-table-follow-fields-with-editor
2082 (remove-hook 'post-command-hook
'org-table-follow-fields-with-editor
'local
)
2083 (let* ((buf (get-buffer "*Org Table Edit Field*"))
2084 (win (and buf
(get-buffer-window buf
))))
2085 (when win
(delete-window win
))
2087 (with-current-buffer buf
2088 (move-marker org-field-marker nil
))
2089 (kill-buffer buf
)))))
2091 (defun org-table-follow-fields-with-editor ()
2092 (if (and org-table-exit-follow-field-mode-when-leaving-table
2093 (not (org-at-table-p)))
2094 ;; We have left the table, exit the follow mode
2095 (org-table-follow-field-mode -
1)
2096 (when (org-table-check-inside-data-field 'noerror
)
2097 (let ((win (selected-window)))
2098 (org-table-edit-field nil
)
2099 (org-fit-window-to-buffer)
2100 (select-window win
)))))
2102 (defvar org-timecnt
) ; dynamically scoped parameter
2105 (defun org-table-sum (&optional beg end nlast
)
2106 "Sum numbers in region of current table column.
2107 The result will be displayed in the echo area, and will be available
2108 as kill to be inserted with \\[yank].
2110 If there is an active region, it is interpreted as a rectangle and all
2111 numbers in that rectangle will be summed. If there is no active
2112 region and point is located in a table column, sum all numbers in that
2115 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2116 numbers are assumed to be times as well (in decimal hours) and the
2117 numbers are added as such.
2119 If NLAST is a number, only the NLAST fields will actually be summed."
2122 (let (col (org-timecnt 0) diff h m s org-table-clip
)
2124 ((and beg end
)) ; beg and end given explicitly
2125 ((org-region-active-p)
2126 (setq beg
(region-beginning) end
(region-end)))
2128 (setq col
(org-table-current-column))
2129 (goto-char (org-table-begin))
2130 (unless (re-search-forward "^[ \t]*|[^-]" nil t
)
2131 (user-error "No table data"))
2132 (org-table-goto-column col
)
2134 (goto-char (org-table-end))
2135 (unless (re-search-backward "^[ \t]*|[^-]" nil t
)
2136 (user-error "No table data"))
2137 (org-table-goto-column col
)
2138 (setq end
(point))))
2139 (let* ((items (apply 'append
(org-table-copy-region beg end
)))
2140 (items1 (cond ((not nlast
) items
)
2141 ((>= nlast
(length items
)) items
)
2142 (t (setq items
(reverse items
))
2143 (setcdr (nthcdr (1- nlast
) items
) nil
)
2145 (numbers (delq nil
(mapcar 'org-table-get-number-for-summing
2147 (res (apply '+ numbers
))
2148 (sres (if (= org-timecnt
0)
2149 (number-to-string res
)
2150 (setq diff
(* 3600 res
)
2151 h
(floor (/ diff
3600)) diff
(mod diff
3600)
2152 m
(floor (/ diff
60)) diff
(mod diff
60)
2154 (format "%.0f:%02.0f:%02.0f" h m s
))))
2156 (when (called-interactively-p 'interactive
)
2157 (message "%s" (substitute-command-keys
2158 (format "Sum of %d items: %-20s \
2159 \(\\[yank] will insert result into buffer)" (length numbers
) sres
))))
2162 (defun org-table-get-number-for-summing (s)
2164 (if (string-match "^ *|? *" s
)
2165 (setq s
(replace-match "" nil nil s
)))
2166 (if (string-match " *|? *$" s
)
2167 (setq s
(replace-match "" nil nil s
)))
2168 (setq n
(string-to-number s
))
2170 ((and (string-match "0" s
)
2171 (string-match "\\`[-+ \t0.edED]+\\'" s
)) 0)
2172 ((string-match "\\`[ \t]+\\'" s
) nil
)
2173 ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s
)
2174 (let ((h (string-to-number (or (match-string 1 s
) "0")))
2175 (m (string-to-number (or (match-string 2 s
) "0")))
2176 (s (string-to-number (or (match-string 4 s
) "0"))))
2177 (if (boundp 'org-timecnt
) (setq org-timecnt
(1+ org-timecnt
)))
2178 (* 1.0 (+ h
(/ m
60.0) (/ s
3600.0)))))
2182 (defun org-table-current-field-formula (&optional key noerror
)
2183 "Return the formula active for the current field.
2185 Assumes that table is already analyzed. If KEY is given, return
2186 the key to this formula. Otherwise return the formula preceded
2187 with \"=\" or \":=\"."
2188 (let* ((line (count-lines org-table-current-begin-pos
2189 (line-beginning-position)))
2190 (row (org-table-line-to-dline line
)))
2193 (let* ((col (org-table-current-column))
2194 (name (car (rassoc (list line col
)
2195 org-table-named-field-locations
)))
2196 (scol (format "$%d" col
))
2197 (ref (format "@%d$%d" (org-table-current-dline) col
))
2198 (stored-list (org-table-get-stored-formulas noerror
))
2199 (ass (or (assoc name stored-list
)
2200 (assoc ref stored-list
)
2201 (assoc scol stored-list
))))
2202 (cond (key (car ass
))
2203 (ass (concat (if (string-match-p "^[0-9]+$" (car ass
)) "=" ":=")
2206 (t (error "No formula active for the current field")))))
2208 (defun org-table-get-formula (&optional equation named
)
2209 "Read a formula from the minibuffer, offer stored formula as default.
2210 When NAMED is non-nil, look for a named equation."
2211 (let* ((stored-list (org-table-get-stored-formulas))
2212 (name (car (rassoc (list (count-lines org-table-current-begin-pos
2213 (line-beginning-position))
2214 (org-table-current-column))
2215 org-table-named-field-locations
)))
2216 (ref (format "@%d$%d"
2217 (org-table-current-dline)
2218 (org-table-current-column)))
2220 ((not named
) (format "$%d" (org-table-current-column)))
2221 ((and name
(not (string-match "\\`LR[0-9]+\\'" name
))) name
)
2223 (name (or name ref
))
2224 (org-table-may-need-update nil
)
2225 (stored (cdr (assoc scol stored-list
)))
2227 ((and stored equation
(string-match-p "^ *=? *$" equation
))
2231 (t (org-table-formula-from-user
2233 (org-table-formula-to-user
2234 (format "%s formula %s="
2235 (if named
"Field" "Column")
2237 (if stored
(org-table-formula-to-user stored
) "")
2238 'org-table-formula-history
2241 (when (not (string-match "\\S-" eq
))
2243 (setq stored-list
(delq (assoc scol stored-list
) stored-list
))
2244 (org-table-store-formulas stored-list
)
2245 (user-error "Formula removed"))
2246 (if (string-match "^ *=?" eq
) (setq eq
(replace-match "" t t eq
)))
2247 (if (string-match " *$" eq
) (setq eq
(replace-match "" t t eq
)))
2248 (if (and name
(not named
))
2249 ;; We set the column equation, delete the named one.
2250 (setq stored-list
(delq (assoc name stored-list
) stored-list
)
2253 (setcdr (assoc scol stored-list
) eq
)
2254 (setq stored-list
(cons (cons scol eq
) stored-list
)))
2255 (if (or mustsave
(not (equal stored eq
)))
2256 (org-table-store-formulas stored-list
))
2259 (defun org-table-store-formulas (alist &optional location
)
2260 "Store the list of formulas below the current table.
2261 If optional argument LOCATION is a buffer position, insert it at
2265 (progn (goto-char location
) (beginning-of-line))
2266 (goto-char (org-table-end)))
2267 (let ((case-fold-search t
))
2268 (if (looking-at "\\([ \t]*\n\\)*[ \t]*\\(#\\+TBLFM:\\)\\(.*\n?\\)")
2270 ;; Don't overwrite TBLFM, we might use text properties to
2272 (goto-char (match-beginning 3))
2273 (delete-region (match-beginning 3) (match-end 0)))
2275 (insert (or (match-string 2) "#+TBLFM:")))
2277 (mapconcat (lambda (x) (concat (car x
) "=" (cdr x
)))
2278 (sort alist
#'org-table-formula-less-p
)
2282 (defsubst org-table-formula-make-cmp-string
(a)
2283 (when (string-match "\\`$[<>]" a
)
2284 (let ((arrow (string-to-char (substring a
1))))
2285 ;; Fake a high number to make sure this is sorted at the end.
2286 (setq a
(org-table-formula-handle-first/last-rc a
))
2287 (setq a
(format "$%d" (+ 10000
2288 (if (= arrow ?
<) -
1000 0)
2289 (string-to-number (substring a
1)))))))
2291 "^\\(@\\([0-9]+\\)\\)?\\(\\$?\\([0-9]+\\)\\)?\\(\\$?[a-zA-Z0-9]+\\)?"
2295 (format "@%05d" (string-to-number (match-string 2 a
))) "")
2297 (format "$%05d" (string-to-number (match-string 4 a
))) "")
2299 (concat "@@" (match-string 5 a
))))))
2301 (defun org-table-formula-less-p (a b
)
2302 "Compare two formulas for sorting."
2303 (let ((as (org-table-formula-make-cmp-string (car a
)))
2304 (bs (org-table-formula-make-cmp-string (car b
))))
2305 (and as bs
(string< as bs
))))
2308 (defun org-table-get-stored-formulas (&optional noerror location
)
2309 "Return an alist with the stored formulas directly after current table.
2310 By default, only return active formulas, i.e., formulas located
2311 on the first line after the table. However, if optional argument
2312 LOCATION is a buffer position, consider the formulas there."
2315 (progn (goto-char location
) (beginning-of-line))
2316 (goto-char (org-table-end)))
2317 (let ((case-fold-search t
))
2318 (when (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM: *\\(.*\\)")
2319 (let ((strings (org-split-string (match-string-no-properties 2)
2322 (dolist (string strings
(nreverse eq-alist
))
2323 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|\\$\\([_a-zA-Z0-9]+\\|\
2324 [<>]+\\)\\) *= *\\(.*[^ \t]\\)"
2327 (let ((m (match-string 1 string
)))
2329 ((not (match-end 2)) m
)
2330 ;; Is it a column reference?
2331 ((string-match-p "\\`$\\([0-9]+\\|[<>]+\\)\\'" m
) m
)
2332 ;; Since named columns are not possible in
2333 ;; LHS, assume this is a named field.
2334 (t (match-string 2 string
)))))
2335 (rhs (match-string 3 string
)))
2336 (push (cons lhs rhs
) eq-alist
)
2338 ((not (member lhs seen
)) (push lhs seen
))
2341 "Double definition `%s=' in TBLFM line, please fix by hand"
2347 "Double definition `%s=' in TBLFM line, please fix by hand"
2350 (defun org-table-fix-formulas (key replace
&optional limit delta remove
)
2351 "Modify the equations after the table structure has been edited.
2352 KEY is \"@\" or \"$\". REPLACE is an alist of numbers to replace.
2353 For all numbers larger than LIMIT, shift them by DELTA."
2355 (goto-char (org-table-end))
2356 (while (let ((case-fold-search t
)) (looking-at "[ \t]*#\\+tblfm:"))
2357 (let ((msg "The formulas in #+TBLFM have been updated")
2358 (re (concat key
"\\([0-9]+\\)"))
2361 (if (or (equal key
"$") (equal key
"$LR"))
2362 (format "\\(@[0-9]+\\)?%s%d=.*?\\(::\\|$\\)"
2363 (regexp-quote key
) remove
)
2364 (format "@%d\\$[0-9]+=.*?\\(::\\|$\\)" remove
))))
2367 (while (re-search-forward re2
(point-at-eol) t
)
2368 (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
2369 (if (equal (char-before (match-beginning 0)) ?.
)
2371 "Change makes TBLFM term %s invalid, use undo to recover"
2373 (replace-match "")))))
2374 (while (re-search-forward re
(point-at-eol) t
)
2375 (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
2376 (setq s
(match-string 1) n
(string-to-number s
))
2378 ((setq a
(assoc s replace
))
2379 (replace-match (concat key
(cdr a
)) t t
)
2381 ((and limit
(> n limit
))
2382 (replace-match (concat key
(int-to-string (+ n delta
))) t t
)
2387 (defun org-table-maybe-eval-formula ()
2388 "Check if the current field starts with \"=\" or \":=\".
2389 If yes, store the formula and apply it."
2390 ;; We already know we are in a table. Get field will only return a formula
2391 ;; when appropriate. It might return a separator line, but no problem.
2392 (when org-table-formula-evaluate-inline
2393 (let* ((field (org-trim (or (org-table-get-field) "")))
2395 (when (string-match "^:?=\\(.*[^=]\\)$" field
)
2396 (setq named
(equal (string-to-char field
) ?
:)
2397 eq
(match-string 1 field
))
2398 (org-table-eval-formula (and named
'(4))
2399 (org-table-formula-from-user eq
))))))
2401 (defvar org-recalc-commands nil
2402 "List of commands triggering the recalculation of a line.
2403 Will be filled automatically during use.")
2405 (defvar org-recalc-marks
2406 '((" " .
"Unmarked: no special line, no automatic recalculation")
2407 ("#" .
"Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
2408 ("*" .
"Recalculate only when entire table is recalculated with `C-u C-c *'")
2409 ("!" .
"Column name definition line. Reference in formula as $name.")
2410 ("$" .
"Parameter definition line name=value. Reference in formula as $name.")
2411 ("_" .
"Names for values in row below this one.")
2412 ("^" .
"Names for values in row above this one.")))
2415 (defun org-table-rotate-recalc-marks (&optional newchar
)
2416 "Rotate the recalculation mark in the first column.
2417 If in any row, the first field is not consistent with a mark,
2418 insert a new column for the markers.
2419 When there is an active region, change all the lines in the region,
2420 after prompting for the marking character.
2421 After each change, a message will be displayed indicating the meaning
2424 (unless (org-at-table-p) (user-error "Not at a table"))
2425 (let* ((region (org-region-active-p))
2427 (save-excursion (goto-char (region-beginning))
2428 (copy-marker (line-beginning-position)))))
2430 (save-excursion (goto-char (region-end))
2431 (copy-marker (line-beginning-position)))))
2432 (l (copy-marker (line-beginning-position)))
2433 (col (org-table-current-column))
2436 (read-char-exclusive
2437 "Change region to what mark? Type # * ! $ or SPC: "))
2441 (goto-char (org-table-begin))
2443 "^[ \t]*|[^-|][^|]*[^#!$*_^| \t][^|]*|" (org-table-end) t
))))
2444 (when (and newchar
(not (assoc newchar org-recalc-marks
)))
2445 (user-error "Invalid character `%s' in `org-table-rotate-recalc-marks'"
2447 (when l1
(goto-char l1
))
2450 (unless (looking-at org-table-dataline-regexp
)
2451 (user-error "Not at a table data line")))
2452 (when no-special-column
2453 (org-table-goto-column 1)
2454 (org-table-insert-column))
2455 (let ((previous-line-end (line-end-position))
2459 (cond ((not (looking-at "^[ \t]*| *\\([#!$*^_ ]\\) *|")) "#")
2461 (t (cadr (member (match-string 1)
2462 (append (mapcar #'car org-recalc-marks
)
2464 ;; Rotate mark in first row.
2465 (org-table-get-field 1 (format " %s " newchar
))
2466 ;; Rotate marks in additional rows if a region is active.
2470 (while (<= (point) l2
)
2471 (when (looking-at org-table-dataline-regexp
)
2472 (org-table-get-field 1 (format " %s " newchar
)))
2474 ;; Only align if rotation actually changed lines' length.
2475 (when (/= previous-line-end
(line-end-position)) (org-table-align)))
2477 (org-table-goto-column (if no-special-column
(1+ col
) col
))
2478 (when l1
(set-marker l1 nil
))
2479 (when l2
(set-marker l2 nil
))
2481 (when (called-interactively-p 'interactive
)
2482 (message "%s" (cdr (assoc newchar org-recalc-marks
))))))
2485 (defun org-table-analyze ()
2486 "Analyze table at point and store results.
2488 This function sets up the following dynamically scoped variables:
2490 `org-table-column-name-regexp',
2491 `org-table-column-names',
2492 `org-table-current-begin-pos',
2493 `org-table-current-line-types',
2494 `org-table-current-ncol',
2497 `org-table-local-parameters',
2498 `org-table-named-field-locations'."
2499 (let ((beg (org-table-begin))
2500 (end (org-table-end)))
2503 ;; Extract column names.
2504 (setq org-table-column-names nil
)
2505 (when (save-excursion
2506 (re-search-forward "^[ \t]*| *! *\\(|.*\\)" end t
))
2508 (dolist (name (org-split-string (match-string 1) " *| *"))
2510 (when (string-match "\\`[a-zA-Z][_a-zA-Z0-9]*\\'" name
)
2511 (push (cons name
(int-to-string c
)) org-table-column-names
)))))
2512 (setq org-table-column-names
(nreverse org-table-column-names
))
2513 (setq org-table-column-name-regexp
2514 (format "\\$\\(%s\\)\\>"
2515 (regexp-opt (mapcar #'car org-table-column-names
) t
)))
2516 ;; Extract local parameters.
2517 (setq org-table-local-parameters nil
)
2519 (while (re-search-forward "^[ \t]*| *\\$ *\\(|.*\\)" end t
)
2520 (dolist (field (org-split-string (match-string 1) " *| *"))
2522 "\\`\\([a-zA-Z][_a-zA-Z0-9]*\\|%\\) *= *\\(.*\\)" field
)
2523 (push (cons (match-string 1 field
) (match-string 2 field
))
2524 org-table-local-parameters
)))))
2525 ;; Update named fields locations. We minimize `count-lines'
2526 ;; processing by storing last known number of lines in LAST.
2527 (setq org-table-named-field-locations nil
)
2529 (let ((last (cons (point) 0)))
2530 (while (re-search-forward "^[ \t]*| *\\([_^]\\) *\\(|.*\\)" end t
)
2531 (let ((c (match-string 1))
2532 (fields (org-split-string (match-string 2) " *| *")))
2534 (forward-line (if (equal c
"_") 1 -
1))
2536 (and (looking-at "^[ \t]*|[^|]*\\(|.*\\)")
2537 (org-split-string (match-string 1) " *| *")))
2538 (line (cl-incf (cdr last
) (count-lines (car last
) (point))))
2540 (setcar last
(point)) ; Update last known position.
2541 (while (and fields fields1
)
2542 (let ((field (pop fields
))
2545 (when (and (stringp field
)
2547 (string-match "\\`[a-zA-Z][_a-zA-Z0-9]*\\'"
2549 (push (cons field v
) org-table-local-parameters
)
2550 (push (list field line col
)
2551 org-table-named-field-locations
))))))))))
2552 ;; Re-use existing markers when possible.
2553 (if (markerp org-table-current-begin-pos
)
2554 (move-marker org-table-current-begin-pos
(point))
2555 (setq org-table-current-begin-pos
(point-marker)))
2556 ;; Analyze the line types.
2557 (let ((l 0) hlines dlines types
)
2558 (while (looking-at "[ \t]*|\\(-\\)?")
2559 (push (if (match-end 1) 'hline
'dline
) types
)
2560 (if (match-end 1) (push l hlines
) (push l dlines
))
2563 (push 'hline types
) ; Add an imaginary extra hline to the end.
2564 (setq org-table-current-line-types
(apply #'vector
(nreverse types
)))
2565 (setq org-table-dlines
(apply #'vector
(cons nil
(nreverse dlines
))))
2566 (setq org-table-hlines
(apply #'vector
(cons nil
(nreverse hlines
)))))
2567 ;; Get the number of columns from the first data line in table.
2569 (forward-line (aref org-table-dlines
1))
2572 (buffer-substring (line-beginning-position) (line-end-position))
2574 (nfields (length fields
))
2576 (setq org-table-current-ncol nfields
)
2578 (aref org-table-dlines
(1- (length org-table-dlines
)))))
2579 (dotimes (i nfields
)
2580 (let ((column (1+ i
)))
2581 (push (list (format "LR%d" column
) last-dline column
) al
)
2582 (push (cons (format "LR%d" column
) (nth i fields
)) al2
))))
2583 (setq org-table-named-field-locations
2584 (append org-table-named-field-locations al
))
2585 (setq org-table-local-parameters
2586 (append org-table-local-parameters al2
))))))
2588 (defun org-table-goto-field (ref &optional create-column-p
)
2589 "Move point to a specific field in the current table.
2591 REF is either the name of a field its absolute reference, as
2592 a string. No column is created unless CREATE-COLUMN-P is
2593 non-nil. If it is a function, it is called with the column
2594 number as its argument as is used as a predicate to know if the
2595 column can be created.
2597 This function assumes the table is already analyzed (i.e., using
2598 `org-table-analyze')."
2601 ((cdr (assoc ref org-table-named-field-locations
)))
2602 ((string-match "\\`@\\([1-9][0-9]*\\)\\$\\([1-9][0-9]*\\)\\'" ref
)
2603 (list (condition-case nil
2604 (aref org-table-dlines
2605 (string-to-number (match-string 1 ref
)))
2606 (error (user-error "Invalid row number in %s" ref
)))
2607 (string-to-number (match-string 2 ref
))))
2608 (t (user-error "Unknown field: %s" ref
))))
2609 (line (car coordinates
))
2610 (column (nth 1 coordinates
))
2611 (create-new-column (if (functionp create-column-p
)
2612 (funcall create-column-p column
)
2615 (goto-char org-table-current-begin-pos
)
2617 (org-table-goto-column column nil create-new-column
))))
2620 (defun org-table-maybe-recalculate-line ()
2621 "Recompute the current line if marked for it, and if we haven't just done it."
2623 (and org-table-allow-automatic-line-recalculation
2624 (not (and (memq last-command org-recalc-commands
)
2625 (eq org-last-recalc-line
(line-beginning-position))))
2626 (save-excursion (beginning-of-line 1)
2627 (looking-at org-table-auto-recalculate-regexp
))
2628 (org-table-recalculate) t
))
2630 (defvar org-tbl-calc-modes
) ;; Dynamically bound in `org-table-eval-formula'
2631 (defsubst org-set-calc-mode
(var &optional value
)
2633 (setq var
(assoc var
'(("D" calc-angle-mode deg
)
2634 ("R" calc-angle-mode rad
)
2635 ("F" calc-prefer-frac t
)
2636 ("S" calc-symbolic-mode t
)))
2637 value
(nth 2 var
) var
(nth 1 var
)))
2638 (if (memq var org-tbl-calc-modes
)
2639 (setcar (cdr (memq var org-tbl-calc-modes
)) value
)
2640 (cons var
(cons value org-tbl-calc-modes
)))
2644 (defun org-table-eval-formula (&optional arg equation
2645 suppress-align suppress-const
2646 suppress-store suppress-analysis
)
2647 "Replace the table field value at the cursor by the result of a calculation.
2649 In a table, this command replaces the value in the current field with the
2650 result of a formula. It also installs the formula as the \"current\" column
2651 formula, by storing it in a special line below the table. When called
2652 with a `\\[universal-argument]' prefix the formula is installed as a \
2655 When called with a `\\[universal-argument] \\[universal-argument]' prefix, \
2656 insert the active equation for the field
2657 back into the current field, so that it can be edited there. This is \
2659 in order to use \\<org-table-fedit-map>`\\[org-table-show-reference]' to \
2660 check the referenced fields.
2662 When called, the command first prompts for a formula, which is read in
2663 the minibuffer. Previously entered formulas are available through the
2664 history list, and the last used formula is offered as a default.
2665 These stored formulas are adapted correctly when moving, inserting, or
2666 deleting columns with the corresponding commands.
2668 The formula can be any algebraic expression understood by the Calc package.
2669 For details, see the Org mode manual.
2671 This function can also be called from Lisp programs and offers
2672 additional arguments: EQUATION can be the formula to apply. If this
2673 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2674 used to speed-up recursive calls by by-passing unnecessary aligns.
2675 SUPPRESS-CONST suppresses the interpretation of constants in the
2676 formula, assuming that this has been done already outside the function.
2677 SUPPRESS-STORE means the formula should not be stored, either because
2678 it is already stored, or because it is a modified equation that should
2679 not overwrite the stored one. SUPPRESS-ANALYSIS prevents any call to
2680 `org-table-analyze'."
2682 (org-table-check-inside-data-field)
2683 (or suppress-analysis
(org-table-analyze))
2684 (if (equal arg
'(16))
2685 (let ((eq (org-table-current-field-formula)))
2686 (org-table-get-field nil eq
)
2688 (setq org-table-may-need-update t
))
2690 (ndown (if (integerp arg
) arg
1))
2691 (org-table-automatic-realign nil
)
2692 (case-fold-search nil
)
2694 (formula (if (and equation suppress-store
)
2696 (org-table-get-formula equation
(equal arg
'(4)))))
2697 (n0 (org-table-current-column))
2698 (org-tbl-calc-modes (copy-sequence org-calc-default-modes
))
2699 (numbers nil
) ; was a variable, now fixed default
2701 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2702 duration duration-output-format
)
2703 ;; Parse the format string. Since we have a lot of modes, this is
2704 ;; a lot of work. However, I think calc still uses most of the time.
2705 (if (string-match ";" formula
)
2706 (let ((tmp (org-split-string formula
";")))
2707 (setq formula
(car tmp
)
2708 fmt
(concat (cdr (assoc "%" org-table-local-parameters
))
2710 (while (string-match "\\([pnfse]\\)\\(-?[0-9]+\\)" fmt
)
2711 (setq c
(string-to-char (match-string 1 fmt
))
2712 n
(string-to-number (match-string 2 fmt
)))
2714 (setq org-tbl-calc-modes
(org-set-calc-mode 'calc-internal-prec n
))
2715 (setq org-tbl-calc-modes
2718 (list (cdr (assoc c
'((?n . float
) (?f . fix
)
2719 (?s . sci
) (?e . eng
))))
2721 (setq fmt
(replace-match "" t t fmt
)))
2722 (if (string-match "T" fmt
)
2723 (setq duration t numbers t
2724 duration-output-format nil
2725 fmt
(replace-match "" t t fmt
)))
2726 (if (string-match "t" fmt
)
2728 duration-output-format org-table-duration-custom-format
2730 fmt
(replace-match "" t t fmt
)))
2731 (if (string-match "N" fmt
)
2733 fmt
(replace-match "" t t fmt
)))
2734 (if (string-match "L" fmt
)
2736 fmt
(replace-match "" t t fmt
)))
2737 (if (string-match "E" fmt
)
2739 fmt
(replace-match "" t t fmt
)))
2740 (while (string-match "[DRFS]" fmt
)
2741 (setq org-tbl-calc-modes
(org-set-calc-mode (match-string 0 fmt
)))
2742 (setq fmt
(replace-match "" t t fmt
)))
2743 (unless (string-match "\\S-" fmt
)
2745 (when (and (not suppress-const
) org-table-formula-use-constants
)
2746 (setq formula
(org-table-formula-substitute-names formula
)))
2747 (setq orig
(or (get-text-property 1 :orig-formula formula
) "?"))
2748 (setq formula
(org-table-formula-handle-first/last-rc formula
))
2750 (setq fields
(org-split-string
2752 (buffer-substring-no-properties
2753 (line-beginning-position) (line-end-position)))
2755 ;; replace fields with duration values if relevant
2758 (mapcar (lambda (x) (org-table-time-string-to-seconds x
))
2761 (setq fields
(mapcar
2763 (if (string-match "\\S-" x
)
2764 (number-to-string (string-to-number x
))
2767 (setq ndown
(1- ndown
))
2768 (setq form
(copy-sequence formula
)
2769 lispp
(and (> (length form
) 2) (equal (substring form
0 2) "'(")))
2770 (if (and lispp literal
) (setq lispp
'literal
))
2772 ;; Insert row and column number of formula result field
2773 (while (string-match "[@$]#" form
)
2778 (if (equal (substring form
(match-beginning 0)
2779 (1+ (match-beginning 0)))
2781 (org-table-current-dline)
2782 (org-table-current-column))))
2785 ;; Check for old vertical references
2786 (org-table--error-on-old-row-references form
)
2787 ;; Insert remote references
2788 (setq form
(org-table-remote-reference-indirection form
))
2789 (while (string-match "\\<remote([ \t]*\\([^,)]+\\)[ \t]*,[ \t]*\\([^\n)]+\\))" form
)
2793 (org-table-make-reference
2794 (let ((rmtrng (org-table-get-remote-range
2795 (match-string 1 form
) (match-string 2 form
))))
2798 (mapcar (lambda(x) (org-table-time-string-to-seconds x
)) rmtrng
)
2799 (org-table-time-string-to-seconds rmtrng
))
2801 keep-empty numbers lispp
))
2803 ;; Insert complex ranges
2804 (while (and (string-match org-table-range-regexp form
)
2805 (> (length (match-string 0 form
)) 1))
2808 (org-table-get-range
2809 (match-string 0 form
) org-table-current-begin-pos n0
)))
2812 (org-table-make-reference
2813 ;; possibly handle durations
2816 (mapcar (lambda(x) (org-table-time-string-to-seconds x
)) formrg
)
2817 (org-table-time-string-to-seconds formrg
))
2819 keep-empty numbers lispp
)))
2820 (if (not (save-match-data
2821 (string-match (regexp-quote form
) formrpl
)))
2822 (setq form
(replace-match formrpl t t form
))
2823 (user-error "Spreadsheet error: invalid reference \"%s\"" form
)))
2824 ;; Insert simple ranges, i.e. included in the current row.
2825 (while (string-match
2826 "\\$\\(\\([-+]\\)?[0-9]+\\)\\.\\.\\$\\(\\([-+]\\)?[0-9]+\\)"
2831 (org-table-make-reference
2833 (+ (if (match-end 2) n0
0)
2834 (string-to-number (match-string 1 form
))
2836 (+ (if (match-end 4) n0
0)
2837 (string-to-number (match-string 3 form
))))
2838 keep-empty numbers lispp
))
2841 ;; Insert the references to fields in same row
2842 (while (string-match "\\$\\(\\([-+]\\)?[0-9]+\\)" form
)
2843 (setq n
(+ (string-to-number (match-string 1 form
))
2844 (if (match-end 2) n0
0))
2845 x
(nth (1- (if (= n
0) n0
(max n
1))) fields
)
2846 formrpl
(save-match-data
2847 (org-table-make-reference
2848 x keep-empty numbers lispp
)))
2851 (string-match (regexp-quote formula
) formrpl
)))
2852 (user-error "Invalid field specifier \"%s\""
2853 (match-string 0 form
)))
2854 (setq form
(replace-match formrpl t t form
)))
2857 (setq ev
(condition-case nil
2858 (eval (eval (read form
)))
2860 ev
(if (numberp ev
) (number-to-string ev
) ev
)
2861 ev
(if duration
(org-table-time-seconds-to-string
2862 (string-to-number ev
)
2863 duration-output-format
) ev
))
2865 ;; Use <...> time-stamps so that Calc can handle them.
2867 (replace-regexp-in-string org-ts-regexp-inactive
"<\\1>" form
))
2868 ;; Internationalize local time-stamps by setting locale to
2871 (replace-regexp-in-string
2874 (let ((system-time-locale "C"))
2876 (org-time-stamp-format
2877 (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts
))
2878 (apply #'encode-time
2879 (save-match-data (org-parse-time-string ts
))))))
2882 (setq ev
(if (and duration
(string-match "^[0-9]+:[0-9]+\\(?::[0-9]+\\)?$" form
))
2884 (calc-eval (cons form org-tbl-calc-modes
)
2885 (when (and (not keep-empty
) numbers
) 'num
)))
2886 ev
(if duration
(org-table-time-seconds-to-string
2887 (if (string-match "^[0-9]+:[0-9]+\\(?::[0-9]+\\)?$" ev
)
2888 (string-to-number (org-table-time-string-to-seconds ev
))
2889 (string-to-number ev
))
2890 duration-output-format
)
2893 (when org-table-formula-debug
2894 (with-output-to-temp-buffer "*Substitution History*"
2895 (princ (format "Substitution history of formula
2899 $1-> %s\n" orig formula form0 form
))
2901 (princ (format " %s^\nError: %s"
2902 (make-string (car ev
) ?\-
) (nth 1 ev
)))
2903 (princ (format "Result: %s\nFormat: %s\nFinal: %s"
2905 (if fmt
(format fmt
(string-to-number ev
)) ev
)))))
2906 (setq bw
(get-buffer-window "*Substitution History*"))
2907 (org-fit-window-to-buffer bw
)
2908 (unless (and (called-interactively-p 'any
) (not ndown
))
2909 (unless (let (inhibit-redisplay)
2910 (y-or-n-p "Debugging Formula. Continue to next? "))
2912 (user-error "Abort"))
2915 (when (consp ev
) (setq fmt nil ev
"#ERROR"))
2916 (org-table-justify-field-maybe
2917 (format org-table-formula-field-format
2918 (if fmt
(format fmt
(string-to-number ev
)) ev
)))
2919 (if (and down
(> ndown
0) (looking-at ".*\n[ \t]*|[^-]"))
2920 (call-interactively 'org-return
)
2922 (and down
(org-table-maybe-recalculate-line))
2923 (or suppress-align
(and org-table-may-need-update
2924 (org-table-align))))))
2926 (defun org-table-put-field-property (prop value
)
2928 (put-text-property (progn (skip-chars-backward "^|") (point))
2929 (progn (skip-chars-forward "^|") (point))
2932 (defun org-table-get-range (desc &optional tbeg col highlight corners-only
)
2933 "Get a calc vector from a column, according to descriptor DESC.
2935 Optional arguments TBEG and COL can give the beginning of the table and
2936 the current column, to avoid unnecessary parsing.
2938 HIGHLIGHT means just highlight the range.
2940 When CORNERS-ONLY is set, only return the corners of the range as
2941 a list (line1 column1 line2 column2) where line1 and line2 are
2942 line numbers relative to beginning of table, or TBEG, and column1
2943 and column2 are table column numbers."
2944 (let* ((desc (if (string-match-p "\\`\\$[0-9]+\\.\\.\\$[0-9]+\\'" desc
)
2945 (replace-regexp-in-string "\\$" "@0$" desc
)
2947 (col (or col
(org-table-current-column)))
2948 (tbeg (or tbeg
(org-table-begin)))
2949 (thisline (count-lines tbeg
(line-beginning-position))))
2950 (unless (string-match org-table-range-regexp desc
)
2951 (user-error "Invalid table range specifier `%s'" desc
))
2952 (let ((rangep (match-end 3))
2953 (r1 (let ((r (and (match-end 1) (match-string 1 desc
))))
2954 (or (save-match-data
2955 (and (org-string-nw-p r
)
2956 (org-table--descriptor-line r thisline
)))
2958 (r2 (let ((r (and (match-end 4) (match-string 4 desc
))))
2959 (or (save-match-data
2960 (and (org-string-nw-p r
)
2961 (org-table--descriptor-line r thisline
)))
2963 (c1 (let ((c (and (match-end 2) (substring (match-string 2 desc
) 1))))
2964 (if (or (not c
) (= (string-to-number c
) 0)) col
2965 (+ (string-to-number c
)
2966 (if (memq (string-to-char c
) '(?- ?
+)) col
0)))))
2967 (c2 (let ((c (and (match-end 5) (substring (match-string 5 desc
) 1))))
2968 (if (or (not c
) (= (string-to-number c
) 0)) col
2969 (+ (string-to-number c
)
2970 (if (memq (string-to-char c
) '(?- ?
+)) col
0))))))
2972 (if (and (not corners-only
)
2973 (or (not rangep
) (and (= r1 r2
) (= c1 c2
))))
2976 (forward-line (- r1 thisline
))
2977 (while (not (looking-at org-table-dataline-regexp
))
2979 (prog1 (org-trim (org-table-get-field c1
))
2980 (when highlight
(org-table-highlight-rectangle))))
2981 ;; A range, return a vector. First sort the numbers to get
2982 ;; a regular rectangle.
2983 (let ((first-row (min r1 r2
))
2984 (last-row (max r1 r2
))
2985 (first-column (min c1 c2
))
2986 (last-column (max c1 c2
)))
2987 (if corners-only
(list first-row first-column last-row last-column
)
2988 ;; Copy the range values into a list.
2989 (forward-line (- first-row thisline
))
2990 (while (not (looking-at org-table-dataline-regexp
))
2992 (cl-incf first-row
))
2993 (org-table-goto-column first-column
)
2994 (let ((beg (point)))
2995 (forward-line (- last-row first-row
))
2996 (while (not (looking-at org-table-dataline-regexp
))
2998 (org-table-goto-column last-column
)
2999 (let ((end (point)))
3001 (org-table-highlight-rectangle
3002 beg
(progn (skip-chars-forward "^|\n") (point))))
3003 ;; Return string representation of calc vector.
3006 (org-table-copy-region beg end
))))))))))))
3008 (defun org-table--descriptor-line (desc cline
)
3009 "Return relative line number corresponding to descriptor DESC.
3010 The cursor is currently in relative line number CLINE."
3011 (if (string-match "\\`[0-9]+\\'" desc
)
3012 (aref org-table-dlines
(string-to-number desc
))
3013 (when (or (not (string-match
3014 "^\\(\\([-+]\\)?\\(I+\\)\\)?\\(\\([-+]\\)?\\([0-9]+\\)\\)?"
3017 (and (not (match-end 3)) (not (match-end 6)))
3018 (and (match-end 3) (match-end 6) (not (match-end 5))))
3019 (user-error "Invalid row descriptor `%s'" desc
))
3020 (let* ((hn (and (match-end 3) (- (match-end 3) (match-beginning 3))))
3021 (hdir (match-string 2 desc
))
3022 (odir (match-string 5 desc
))
3023 (on (and (match-end 6) (string-to-number (match-string 6 desc
))))
3024 (rel (and (match-end 6)
3025 (or (and (match-end 1) (not (match-end 3)))
3027 (when (and hn
(not hdir
))
3030 (when (eq (aref org-table-current-line-types
0) 'hline
) (cl-decf hn
)))
3031 (when (and (not hn
) on
(not odir
)) (user-error "Should never happen"))
3034 (org-table--row-type 'hline hn cline
(equal hdir
"-") nil desc
)))
3037 (org-table--row-type 'dline on cline
(equal odir
"-") rel desc
)))
3040 (defun org-table--row-type (type n i backwards relative desc
)
3041 "Return relative line of Nth row with type TYPE.
3042 Search starts from relative line I. When BACKWARDS in non-nil,
3043 look before I. When RELATIVE is non-nil, the reference is
3044 relative. DESC is the original descriptor that started the
3045 search, as a string."
3046 (let ((l (length org-table-current-line-types
)))
3049 (while (and (cl-incf i
(if backwards -
1 1))
3052 (not (eq (aref org-table-current-line-types i
) type
))
3053 ;; We are going to cross a hline. Check if this is
3054 ;; an authorized move.
3057 ((not (eq (aref org-table-current-line-types i
) 'hline
)))
3058 ((eq org-table-relative-ref-may-cross-hline t
))
3059 ((eq org-table-relative-ref-may-cross-hline
'error
)
3060 (user-error "Row descriptor %s crosses hline" desc
))
3061 (t (cl-decf i
(if backwards -
1 1)) ; Step back.
3062 (throw :exit nil
)))))))
3063 (cond ((or (< i
0) (>= i l
))
3064 (user-error "Row descriptor %s leads outside table" desc
))
3065 ;; The last hline doesn't exist. Instead, point to last row
3067 ((= i
(1- l
)) (1- i
))
3070 (defun org-table--error-on-old-row-references (s)
3071 (when (string-match "&[-+0-9I]" s
)
3072 (user-error "Formula contains old &row reference, please rewrite using @-syntax")))
3074 (defun org-table-make-reference (elements keep-empty numbers lispp
)
3075 "Convert list ELEMENTS to something appropriate to insert into formula.
3076 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3077 NUMBERS indicates that everything should be converted to numbers.
3078 LISPP non-nil means to return something appropriate for a Lisp
3079 list, `literal' is for the format specifier L."
3080 ;; Calc nan (not a number) is used for the conversion of the empty
3081 ;; field to a reference for several reasons: (i) It is accepted in a
3082 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3083 ;; (ii) In a single field (not in range) it can be distinguished
3084 ;; from "(nan)" which is the reference made from a single field
3085 ;; containing "nan".
3086 (if (stringp elements
)
3089 (if (eq lispp
'literal
)
3091 (if (and (eq elements
"") (not keep-empty
))
3094 (if numbers
(string-to-number elements
) elements
))))
3095 (if (string-match "\\S-" elements
)
3097 (when numbers
(setq elements
(number-to-string
3098 (string-to-number elements
))))
3099 (concat "(" elements
")"))
3100 (if (or (not keep-empty
) numbers
) "(0)" "nan")))
3105 (mapcar (lambda (x) (if (string-match "\\S-" x
) x nil
))
3107 (setq elements
(or elements
'())) ; if delq returns nil then we need '()
3111 (if (eq lispp
'literal
)
3113 (prin1-to-string (if numbers
(string-to-number x
) x
))))
3115 (concat "[" (mapconcat
3117 (if (string-match "\\S-" x
)
3119 (number-to-string (string-to-number x
))
3121 (if (or (not keep-empty
) numbers
) "0" "nan")))
3125 (defun org-table-message-once-per-second (t1 &rest args
)
3126 "If there has been more than one second since T1, display message.
3127 ARGS are passed as arguments to the `message' function. Returns
3128 current time if a message is printed, otherwise returns T1. If
3129 T1 is nil, always messages."
3130 (let ((curtime (current-time)))
3131 (if (or (not t1
) (< 0 (nth 1 (time-subtract curtime t1
))))
3132 (progn (apply 'message args
)
3137 (defun org-table-recalculate (&optional all noalign
)
3138 "Recalculate the current table line by applying all stored formulas.
3140 With prefix arg ALL, do this for all lines in the table.
3142 When called with a `\\[universal-argument] \\[universal-argument]' prefix, or \
3143 if ALL is the symbol `iterate',
3144 recompute the table until it no longer changes.
3146 If NOALIGN is not nil, do not re-align the table after the computations
3147 are done. This is typically used internally to save time, if it is
3148 known that the table will be realigned a little later anyway."
3150 (unless (memq this-command org-recalc-commands
)
3151 (push this-command org-recalc-commands
))
3152 (unless (org-at-table-p) (user-error "Not at a table"))
3153 (if (or (eq all
'iterate
) (equal all
'(16)))
3156 (let* ((eqlist (sort (org-table-get-stored-formulas)
3157 (lambda (a b
) (string< (car a
) (car b
)))))
3158 (inhibit-redisplay (not debug-on-error
))
3159 (line-re org-table-dataline-regexp
)
3160 (log-first-time (current-time))
3161 (log-last-time log-first-time
)
3163 beg end eqlcol eqlfield
)
3164 ;; Insert constants in all formulas.
3166 (org-table-save-field
3167 ;; Expand equations, then split the equation list between
3168 ;; column formulas and field formulas.
3170 (let* ((rhs (org-table-formula-substitute-names
3171 (org-table-formula-handle-first/last-rc
(cdr eq
))))
3174 (org-table-formula-handle-first/last-rc
3176 ((string-match "\\`@-?I+" old-lhs
)
3177 (user-error "Can't assign to hline relative reference"))
3178 ((string-match "\\`$[<>]" old-lhs
)
3179 (let ((new (org-table-formula-handle-first/last-rc
3181 (when (assoc new eqlist
)
3182 (user-error "\"%s=\" formula tries to overwrite \
3183 existing formula for column %s"
3188 (if (string-match-p "\\`\\$[0-9]+\\'" lhs
)
3189 (push (cons lhs rhs
) eqlcol
)
3190 (push (cons lhs rhs
) eqlfield
))))
3191 (setq eqlcol
(nreverse eqlcol
))
3192 ;; Expand ranges in lhs of formulas
3193 (setq eqlfield
(org-table-expand-lhs-ranges (nreverse eqlfield
)))
3194 ;; Get the correct line range to process.
3197 (setq end
(copy-marker (org-table-end)))
3198 (goto-char (setq beg org-table-current-begin-pos
))
3200 ((re-search-forward org-table-calculate-mark-regexp end t
)
3201 ;; This is a table with marked lines, compute selected
3203 (setq line-re org-table-recalculate-regexp
))
3204 ;; Move forward to the first non-header line.
3205 ((and (re-search-forward org-table-dataline-regexp end t
)
3206 (re-search-forward org-table-hline-regexp end t
)
3207 (re-search-forward org-table-dataline-regexp end t
))
3208 (setq beg
(match-beginning 0)))
3209 ;; Just leave BEG at the start of the table.
3211 (setq beg
(line-beginning-position)
3212 end
(copy-marker (line-beginning-position 2))))
3214 ;; Mark named fields untouchable. Also check if several
3215 ;; field/range formulas try to set the same field.
3216 (remove-text-properties beg end
'(org-untouchable t
))
3217 (let ((current-line (count-lines org-table-current-begin-pos
3218 (line-beginning-position)))
3220 (dolist (eq eqlfield
)
3221 (let* ((name (car eq
))
3222 (location (assoc name org-table-named-field-locations
))
3223 (eq-line (or (nth 1 location
)
3224 (and (string-match "\\`@\\([0-9]+\\)" name
)
3225 (aref org-table-dlines
3227 (match-string 1 name
))))))
3230 ;; Turn field coordinates associated to NAME
3231 ;; into an absolute reference.
3233 (org-table-line-to-dline eq-line
)
3236 (when (member reference seen-fields
)
3237 (user-error "Several field/range formulas try to set %s"
3239 (push reference seen-fields
)
3240 (when (or all
(eq eq-line current-line
))
3241 (org-table-goto-field name
)
3242 (org-table-put-field-property :org-untouchable t
)))))
3243 ;; Evaluate the column formulas, but skip fields covered by
3246 (while (re-search-forward line-re end t
)
3247 (unless (string-match "\\` *[_^!$/] *\\'" (org-table-get-field 1))
3248 ;; Unprotected line, recalculate.
3252 (org-table-message-once-per-second
3254 "Re-applying formulas to full table...(line %d)" cnt
)))
3255 (if (markerp org-last-recalc-line
)
3256 (move-marker org-last-recalc-line
(line-beginning-position))
3257 (setq org-last-recalc-line
3258 (copy-marker (line-beginning-position))))
3259 (dolist (entry eqlcol
)
3260 (goto-char org-last-recalc-line
)
3261 (org-table-goto-column
3262 (string-to-number (substring (car entry
) 1)) nil
'force
)
3263 (unless (get-text-property (point) :org-untouchable
)
3264 (org-table-eval-formula
3265 nil
(cdr entry
) 'noalign
'nocst
'nostore
'noanalysis
)))))
3266 ;; Evaluate the field formulas.
3267 (dolist (eq eqlfield
)
3268 (let ((reference (car eq
))
3271 (org-table-message-once-per-second
3272 (and all log-last-time
)
3273 "Re-applying formula to field: %s" (car eq
)))
3274 (org-table-goto-field
3276 ;; Possibly create a new column, as long as
3277 ;; `org-table-formula-create-columns' allows it.
3278 (let ((column-count (progn (end-of-line)
3279 (1- (org-table-current-column)))))
3281 (when (> column
1000)
3282 (user-error "Formula column target too large"))
3283 (and (> column column-count
)
3284 (or (eq org-table-formula-create-columns t
)
3285 (and (eq org-table-formula-create-columns
'warn
)
3287 (org-display-warning
3288 "Out-of-bounds formula added columns")
3290 (and (eq org-table-formula-create-columns
'prompt
)
3292 "Out-of-bounds formula. Add columns? ")))))))
3293 (org-table-eval-formula nil formula t t t t
))))
3294 ;; Clean up markers and internal text property.
3295 (remove-text-properties (point-min) (point-max) '(org-untouchable t
))
3296 (set-marker end nil
)
3298 (when org-table-may-need-update
(org-table-align))
3300 (org-table-message-once-per-second
3301 log-first-time
"Re-applying formulas to %d lines... done" cnt
)))
3302 (org-table-message-once-per-second
3303 (and all log-first-time
) "Re-applying formulas... done")))))
3306 (defun org-table-iterate (&optional arg
)
3307 "Recalculate the table until it does not change anymore.
3308 The maximum number of iterations is 10, but you can choose a different value
3309 with the prefix ARG."
3311 (let ((imax (if arg
(prefix-numeric-value arg
) 10))
3313 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
3318 (org-table-recalculate 'all
)
3319 (setq thistbl
(buffer-substring (org-table-begin) (org-table-end)))
3320 (if (not (string= lasttbl thistbl
))
3321 (setq lasttbl thistbl
)
3323 (message "Convergence after %d iterations" i
)
3324 (message "Table was already stable"))
3326 (user-error "No convergence after %d iterations" i
))))
3329 (defun org-table-recalculate-buffer-tables ()
3330 "Recalculate all tables in the current buffer."
3332 (org-with-wide-buffer
3333 (org-table-map-tables
3335 ;; Reason for separate `org-table-align': When repeating
3336 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3338 (org-table-recalculate t t
)
3343 (defun org-table-iterate-buffer-tables ()
3344 "Iterate all tables in the buffer, to converge inter-table dependencies."
3348 (checksum (md5 (buffer-string)))
3350 (org-with-wide-buffer
3354 (org-table-map-tables (lambda () (org-table-recalculate t t
)) t
)
3355 (if (equal checksum
(setq c1
(md5 (buffer-string))))
3357 (org-table-map-tables #'org-table-align t
)
3358 (message "Convergence after %d iterations" (- imax i
))
3360 (setq checksum c1
)))
3361 (org-table-map-tables #'org-table-align t
)
3362 (user-error "No convergence after %d iterations" imax
)))))
3364 (defun org-table-calc-current-TBLFM (&optional arg
)
3365 "Apply the #+TBLFM in the line at point to the table."
3367 (unless (org-at-TBLFM-p) (user-error "Not at a #+TBLFM line"))
3368 (let ((formula (buffer-substring
3369 (line-beginning-position)
3370 (line-end-position))))
3372 ;; Insert a temporary formula at right after the table
3373 (goto-char (org-table-TBLFM-begin))
3374 (let ((s (point-marker)))
3375 (insert formula
"\n")
3376 (let ((e (point-marker)))
3377 ;; Recalculate the table.
3378 (beginning-of-line 0) ; move to the inserted line
3379 (skip-chars-backward " \r\n\t")
3381 (org-call-with-arg #'org-table-recalculate
(or arg t
))
3382 ;; Delete the formula inserted temporarily.
3385 (set-marker e nil
)))))))
3387 (defun org-table-TBLFM-begin ()
3388 "Find the beginning of the TBLFM lines and return its position.
3389 Return nil when the beginning of TBLFM line was not found."
3391 (when (progn (forward-line 1)
3392 (re-search-backward org-table-TBLFM-begin-regexp nil t
))
3393 (line-beginning-position 2))))
3395 (defun org-table-expand-lhs-ranges (equations)
3396 "Expand list of formulas.
3397 If some of the RHS in the formulas are ranges or a row reference,
3398 expand them to individual field equations for each field. This
3399 function assumes the table is already analyzed (i.e., using
3400 `org-table-analyze')."
3402 (dolist (e equations
(nreverse res
))
3406 ((string-match-p "\\`@-?[-+0-9]+\\$-?[0-9]+\\'" lhs
)
3407 ;; This just refers to one fixed field.
3409 ((string-match-p "\\`[a-zA-Z][_a-zA-Z0-9]*\\'" lhs
)
3410 ;; This just refers to one fixed named field.
3412 ((string-match-p "\\`\\$[0-9]+\\'" lhs
)
3413 ;; Column formulas are treated specially and are not
3416 ((string-match "\\`@[0-9]+\\'" lhs
)
3417 (dotimes (ic org-table-current-ncol
)
3418 (push (cons (propertize (format "%s$%d" lhs
(1+ ic
)) :orig-eqn e
)
3422 (let* ((range (org-table-get-range
3423 lhs org-table-current-begin-pos
1 nil
'corners
))
3424 (r1 (org-table-line-to-dline (nth 0 range
)))
3426 (r2 (org-table-line-to-dline (nth 2 range
) 'above
))
3428 (cl-loop for ir from r1 to r2 do
3429 (cl-loop for ic from c1 to c2 do
3430 (push (cons (propertize
3431 (format "@%d$%d" ir ic
) :orig-eqn e
)
3435 (defun org-table-formula-handle-first/last-rc
(s)
3436 "Replace @<, @>, $<, $> with first/last row/column of the table.
3437 So @< and $< will always be replaced with @1 and $1, respectively.
3438 The advantage of these special markers are that structure editing of
3439 the table will not change them, while @1 and $1 will be modified
3440 when a line/row is swapped out of that privileged position. So for
3441 formulas that use a range of rows or columns, it may often be better
3442 to anchor the formula with \"I\" row markers, or to offset from the
3443 borders of the table using the @< @> $< $> makers."
3444 (let (n nmax len char
(start 0))
3445 (while (string-match "\\([@$]\\)\\(<+\\|>+\\)\\|\\(remote([^)]+)\\)"
3448 (setq start
(match-end 3))
3449 (setq nmax
(if (equal (match-string 1 s
) "@")
3450 (1- (length org-table-dlines
))
3451 org-table-current-ncol
)
3452 len
(- (match-end 2) (match-beginning 2))
3453 char
(string-to-char (match-string 2 s
))
3457 (if (or (< n
1) (> n nmax
))
3458 (user-error "Reference \"%s\" in expression \"%s\" points outside table"
3459 (match-string 0 s
) s
))
3460 (setq start
(match-beginning 0))
3461 (setq s
(replace-match (format "%s%d" (match-string 1 s
) n
) t t s
)))))
3464 (defun org-table-formula-substitute-names (f)
3465 "Replace $const with values in string F."
3467 (pp (/= (string-to-char f
) ?
'))
3468 (duration (string-match-p ";.*[Tt].*\\'" f
))
3469 (new (replace-regexp-in-string ; Check for column names.
3470 org-table-column-name-regexp
3472 (concat "$" (cdr (assoc (match-string 1 m
)
3473 org-table-column-names
))))
3475 ;; Parameters and constants.
3478 "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)"
3480 (if (match-end 2) (setq start
(match-end 2))
3482 ;; When a duration is expected, convert value on the fly.
3485 (let ((v (org-table-get-constant (match-string 1 new
))))
3486 (if (and (org-string-nw-p v
) duration
)
3487 (org-table-time-string-to-seconds v
)
3490 (setq new
(replace-match
3491 (concat (and pp
"(") value
(and pp
")")) t t new
))))))
3492 (if org-table-formula-debug
(propertize new
:orig-formula f
) new
)))
3494 (defun org-table-get-constant (const)
3495 "Find the value for a parameter or constant in a formula.
3496 Parameters get priority."
3497 (or (cdr (assoc const org-table-local-parameters
))
3498 (cdr (assoc const org-table-formula-constants-local
))
3499 (cdr (assoc const org-table-formula-constants
))
3500 (and (fboundp 'constants-get
) (constants-get const
))
3501 (and (string= (substring const
0 (min 5 (length const
))) "PROP_")
3502 (org-entry-get nil
(substring const
5) 'inherit
))
3505 (defvar org-table-fedit-map
3506 (let ((map (make-sparse-keymap)))
3507 (org-defkey map
"\C-x\C-s" 'org-table-fedit-finish
)
3508 (org-defkey map
"\C-c\C-s" 'org-table-fedit-finish
)
3509 (org-defkey map
"\C-c\C-c" 'org-table-fedit-finish
)
3510 (org-defkey map
"\C-c'" 'org-table-fedit-finish
)
3511 (org-defkey map
"\C-c\C-q" 'org-table-fedit-abort
)
3512 (org-defkey map
"\C-c?" 'org-table-show-reference
)
3513 (org-defkey map
[(meta shift up
)] 'org-table-fedit-line-up
)
3514 (org-defkey map
[(meta shift down
)] 'org-table-fedit-line-down
)
3515 (org-defkey map
[(shift up
)] 'org-table-fedit-ref-up
)
3516 (org-defkey map
[(shift down
)] 'org-table-fedit-ref-down
)
3517 (org-defkey map
[(shift left
)] 'org-table-fedit-ref-left
)
3518 (org-defkey map
[(shift right
)] 'org-table-fedit-ref-right
)
3519 (org-defkey map
[(meta up
)] 'org-table-fedit-scroll-down
)
3520 (org-defkey map
[(meta down
)] 'org-table-fedit-scroll
)
3521 (org-defkey map
[(meta tab
)] 'lisp-complete-symbol
)
3522 (org-defkey map
"\M-\C-i" 'lisp-complete-symbol
)
3523 (org-defkey map
[(tab)] 'org-table-fedit-lisp-indent
)
3524 (org-defkey map
"\C-i" 'org-table-fedit-lisp-indent
)
3525 (org-defkey map
"\C-c\C-r" 'org-table-fedit-toggle-ref-type
)
3526 (org-defkey map
"\C-c}" 'org-table-fedit-toggle-coordinates
)
3529 (easy-menu-define org-table-fedit-menu org-table-fedit-map
"Org Edit Formulas Menu"
3531 ["Finish and Install" org-table-fedit-finish t
]
3532 ["Finish, Install, and Apply" (org-table-fedit-finish t
) :keys
"C-u C-c C-c"]
3533 ["Abort" org-table-fedit-abort t
]
3535 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t
]
3536 ["Complete Lisp Symbol" lisp-complete-symbol t
]
3538 "Shift Reference at Point"
3539 ["Up" org-table-fedit-ref-up t
]
3540 ["Down" org-table-fedit-ref-down t
]
3541 ["Left" org-table-fedit-ref-left t
]
3542 ["Right" org-table-fedit-ref-right t
]
3544 "Change Test Row for Column Formulas"
3545 ["Up" org-table-fedit-line-up t
]
3546 ["Down" org-table-fedit-line-down t
]
3548 ["Scroll Table Window" org-table-fedit-scroll t
]
3549 ["Scroll Table Window down" org-table-fedit-scroll-down t
]
3550 ["Show Table Grid" org-table-fedit-toggle-coordinates
3551 :style toggle
:selected
(with-current-buffer (marker-buffer org-pos
)
3552 org-table-overlay-coordinates
)]
3554 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
3555 :style toggle
:selected org-table-buffer-is-an
]))
3558 (defvar org-table--fedit-source nil
3559 "Position of the TBLFM line being edited.")
3562 (defun org-table-edit-formulas ()
3563 "Edit the formulas of the current table in a separate buffer."
3565 (let ((at-tblfm (org-at-TBLFM-p)))
3566 (unless (or at-tblfm
(org-at-table-p))
3567 (user-error "Not at a table"))
3569 ;; Move point within the table before analyzing it.
3570 (when at-tblfm
(re-search-backward "^[ \t]*|"))
3571 (org-table-analyze))
3572 (let ((key (org-table-current-field-formula 'key
'noerror
))
3573 (eql (sort (org-table-get-stored-formulas t
(and at-tblfm
(point)))
3574 #'org-table-formula-less-p
))
3575 (pos (point-marker))
3576 (source (copy-marker (line-beginning-position)))
3578 (wc (current-window-configuration))
3579 (sel-win (selected-window))
3580 (titles '((column .
"# Column Formulas\n")
3581 (field .
"# Field and Range Formulas\n")
3582 (named .
"# Named Field Formulas\n"))))
3583 (org-switch-to-buffer-other-window "*Edit Formulas*")
3585 ;; Keep global-font-lock-mode from turning on font-lock-mode
3586 (let ((font-lock-global-modes '(not fundamental-mode
)))
3588 (setq-local font-lock-global-modes
(list 'not major-mode
))
3589 (setq-local org-pos pos
)
3590 (setq-local org-table--fedit-source source
)
3591 (setq-local org-window-configuration wc
)
3592 (setq-local org-selected-window sel-win
)
3593 (use-local-map org-table-fedit-map
)
3594 (add-hook 'post-command-hook
#'org-table-fedit-post-command t t
)
3595 (easy-menu-add org-table-fedit-menu
)
3596 (setq startline
(org-current-line))
3599 ((string-match "\\`$\\([0-9]+\\|[<>]+\\)\\'" (car entry
))
3601 ((equal (string-to-char (car entry
)) ?
@) 'field
)
3603 (title (assq type titles
)))
3605 (unless (bobp) (insert "\n"))
3607 (org-add-props (cdr title
) nil
'face font-lock-comment-face
))
3608 (setq titles
(remove title titles
)))
3609 (when (equal key
(car entry
)) (setq startline
(org-current-line)))
3611 (if (memq (string-to-char (car entry
)) '(?
@ ?$
)) "" "$")
3612 (car entry
) " = " (cdr entry
) "\n")))
3613 (remove-text-properties 0 (length s
) '(face nil
) s
)
3615 (when (eq org-table-use-standard-references t
)
3616 (org-table-fedit-toggle-ref-type))
3617 (org-goto-line startline
)
3618 (message "%s" (substitute-command-keys "\\<org-mode-map>\
3619 Edit formulas, finish with `\\[org-ctrl-c-ctrl-c]' or `\\[org-edit-special]'. \
3620 See menu for more commands.")))))
3622 (defun org-table-fedit-post-command ()
3623 (when (not (memq this-command
'(lisp-complete-symbol)))
3624 (let ((win (selected-window)))
3626 (ignore-errors (org-table-show-reference))
3627 (select-window win
)))))
3629 (defun org-table-formula-to-user (s)
3630 "Convert a formula from internal to user representation."
3631 (if (eq org-table-use-standard-references t
)
3632 (org-table-convert-refs-to-an s
)
3635 (defun org-table-formula-from-user (s)
3636 "Convert a formula from user to internal representation."
3637 (if org-table-use-standard-references
3638 (org-table-convert-refs-to-rc s
)
3641 (defun org-table-convert-refs-to-rc (s)
3642 "Convert spreadsheet references from A7 to @7$28.
3643 Works for single references, but also for entire formulas and even the
3646 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start
)
3649 ;; format match, just advance
3650 (setq start
(match-end 0)))
3651 ((and (> (match-beginning 0) 0)
3652 (equal ?.
(aref s
(max (1- (match-beginning 0)) 0)))
3653 (not (equal ?.
(aref s
(max (- (match-beginning 0) 2) 0)))))
3654 ;; 3.e5 or something like this.
3655 (setq start
(match-end 0)))
3656 ((or (> (- (match-end 1) (match-beginning 1)) 2)
3657 ;; (member (match-string 1 s)
3658 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3660 ;; function name, just advance
3661 (setq start
(match-end 0)))
3663 (setq start
(match-beginning 0)
3665 (if (equal (match-string 2 s
) "&")
3666 (format "$%d" (org-letters-to-number (match-string 1 s
)))
3668 (string-to-number (match-string 2 s
))
3669 (org-letters-to-number (match-string 1 s
))))
3673 (defun org-table-convert-refs-to-an (s)
3674 "Convert spreadsheet references from to @7$28 to AB7.
3675 Works for single references, but also for entire formulas and even the
3677 (while (string-match "@\\([0-9]+\\)\\$\\([0-9]+\\)" s
)
3678 (setq s
(replace-match
3680 (org-number-to-letters
3681 (string-to-number (match-string 2 s
)))
3682 (string-to-number (match-string 1 s
)))
3684 (while (string-match "\\(^\\|[^0-9a-zA-Z]\\)\\$\\([0-9]+\\)" s
)
3685 (setq s
(replace-match (concat "\\1"
3686 (org-number-to-letters
3687 (string-to-number (match-string 2 s
))) "&")
3691 (defun org-letters-to-number (s)
3692 "Convert a base 26 number represented by letters into an integer.
3693 For example: AB -> 28."
3696 (while (> (length s
) 0)
3697 (setq n
(+ (* n
26) (string-to-char s
) (- ?A
) 1)
3701 (defun org-number-to-letters (n)
3702 "Convert an integer into a base 26 number represented by letters.
3703 For example: 28 -> AB."
3706 (setq s
(concat (char-to-string (+ (mod (1- n
) 26) ?A
)) s
)
3710 (defun org-table-time-string-to-seconds (s)
3711 "Convert a time string into numerical duration in seconds.
3712 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3713 If S is a string representing a number, keep this number."
3716 (let (hour minus min sec res
)
3718 ((and (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)" s
))
3719 (setq minus
(< 0 (length (match-string 1 s
)))
3720 hour
(string-to-number (match-string 2 s
))
3721 min
(string-to-number (match-string 3 s
))
3722 sec
(string-to-number (match-string 4 s
)))
3724 (setq res
(- (+ (* hour
3600) (* min
60) sec
)))
3725 (setq res
(+ (* hour
3600) (* min
60) sec
))))
3726 ((and (not (string-match org-ts-regexp-both s
))
3727 (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\)" s
))
3728 (setq minus
(< 0 (length (match-string 1 s
)))
3729 hour
(string-to-number (match-string 2 s
))
3730 min
(string-to-number (match-string 3 s
)))
3732 (setq res
(- (+ (* hour
3600) (* min
60))))
3733 (setq res
(+ (* hour
3600) (* min
60)))))
3734 (t (setq res
(string-to-number s
))))
3735 (number-to-string res
))))
3737 (defun org-table-time-seconds-to-string (secs &optional output-format
)
3738 "Convert a number of seconds to a time string.
3739 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3740 minutes or seconds."
3741 (let* ((secs0 (abs secs
))
3743 (cond ((eq output-format
'days
)
3744 (format "%.3f" (/ (float secs0
) 86400)))
3745 ((eq output-format
'hours
)
3746 (format "%.2f" (/ (float secs0
) 3600)))
3747 ((eq output-format
'minutes
)
3748 (format "%.1f" (/ (float secs0
) 60)))
3749 ((eq output-format
'seconds
)
3750 (format "%d" secs0
))
3751 (t (format-seconds "%.2h:%.2m:%.2s" secs0
)))))
3752 (if (< secs
0) (concat "-" res
) res
)))
3754 (defun org-table-fedit-convert-buffer (function)
3755 "Convert all references in this buffer, using FUNCTION."
3756 (let ((origin (copy-marker (line-beginning-position))))
3757 (goto-char (point-min))
3759 (insert (funcall function
(buffer-substring (point) (line-end-position))))
3760 (delete-region (point) (line-end-position))
3763 (set-marker origin nil
)))
3765 (defun org-table-fedit-toggle-ref-type ()
3766 "Convert all references in the buffer from B3 to @3$2 and back."
3768 (setq-local org-table-buffer-is-an
(not org-table-buffer-is-an
))
3769 (org-table-fedit-convert-buffer
3770 (if org-table-buffer-is-an
3771 'org-table-convert-refs-to-an
'org-table-convert-refs-to-rc
))
3772 (message "Reference type switched to %s"
3773 (if org-table-buffer-is-an
"A1 etc" "@row$column")))
3775 (defun org-table-fedit-ref-up ()
3776 "Shift the reference at point one row/hline up."
3778 (org-table-fedit-shift-reference 'up
))
3779 (defun org-table-fedit-ref-down ()
3780 "Shift the reference at point one row/hline down."
3782 (org-table-fedit-shift-reference 'down
))
3783 (defun org-table-fedit-ref-left ()
3784 "Shift the reference at point one field to the left."
3786 (org-table-fedit-shift-reference 'left
))
3787 (defun org-table-fedit-ref-right ()
3788 "Shift the reference at point one field to the right."
3790 (org-table-fedit-shift-reference 'right
))
3792 (defun org-table-fedit-shift-reference (dir)
3794 ((org-in-regexp "\\(\\<[a-zA-Z]\\)&")
3795 (if (memq dir
'(left right
))
3796 (org-rematch-and-replace 1 (eq dir
'left
))
3797 (user-error "Cannot shift reference in this direction")))
3798 ((org-in-regexp "\\(\\<[a-zA-Z]\\{1,2\\}\\)\\([0-9]+\\)")
3799 ;; A B3-like reference
3800 (if (memq dir
'(up down
))
3801 (org-rematch-and-replace 2 (eq dir
'up
))
3802 (org-rematch-and-replace 1 (eq dir
'left
))))
3804 "\\(@\\|\\.\\.\\)\\([-+]?\\(I+\\>\\|[0-9]+\\)\\)\\(\\$\\([-+]?[0-9]+\\)\\)?")
3805 ;; An internal reference
3806 (if (memq dir
'(up down
))
3807 (org-rematch-and-replace 2 (eq dir
'up
) (match-end 3))
3808 (org-rematch-and-replace 5 (eq dir
'left
))))))
3810 (defun org-rematch-and-replace (n &optional decr hline
)
3811 "Re-match the group N, and replace it with the shifted reference."
3812 (or (match-end n
) (user-error "Cannot shift reference in this direction"))
3813 (goto-char (match-beginning n
))
3814 (and (looking-at (regexp-quote (match-string n
)))
3815 (replace-match (org-table-shift-refpart (match-string 0) decr hline
)
3818 (defun org-table-shift-refpart (ref &optional decr hline
)
3819 "Shift a reference part REF.
3820 If DECR is set, decrease the references row/column, else increase.
3821 If HLINE is set, this may be a hline reference, it certainly is not
3822 a translation reference."
3824 (let* ((sign (string-match "^[-+]" ref
)) n
)
3826 (if sign
(setq sign
(substring ref
0 1) ref
(substring ref
1)))
3828 ((and hline
(string-match "^I+" ref
))
3829 (setq n
(string-to-number (concat sign
(number-to-string (length ref
)))))
3830 (setq n
(+ n
(if decr -
1 1)))
3831 (if (= n
0) (setq n
(+ n
(if decr -
1 1))))
3833 (setq sign
(if (< n
0) "-" "+") n
(abs n
))
3835 (concat sign
(make-string n ?I
)))
3837 ((string-match "^[0-9]+" ref
)
3838 (setq n
(string-to-number (concat sign ref
)))
3839 (setq n
(+ n
(if decr -
1 1)))
3841 (concat (if (< n
0) "-" "+") (number-to-string (abs n
)))
3842 (number-to-string (max 1 n
))))
3844 ((string-match "^[a-zA-Z]+" ref
)
3845 (org-number-to-letters
3846 (max 1 (+ (org-letters-to-number ref
) (if decr -
1 1)))))
3848 (t (user-error "Cannot shift reference"))))))
3850 (defun org-table-fedit-toggle-coordinates ()
3851 "Toggle the display of coordinates in the referenced table."
3853 (let ((pos (marker-position org-pos
)))
3854 (with-current-buffer (marker-buffer org-pos
)
3857 (org-table-toggle-coordinate-overlays)))))
3859 (defun org-table-fedit-finish (&optional arg
)
3860 "Parse the buffer for formula definitions and install them.
3861 With prefix ARG, apply the new formulas to the table."
3863 (org-table-remove-rectangle-highlight)
3864 (when org-table-use-standard-references
3865 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc
)
3866 (setq org-table-buffer-is-an nil
))
3868 (sel-win org-selected-window
)
3869 (source org-table--fedit-source
)
3871 (goto-char (point-min))
3872 (while (re-search-forward
3873 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3875 (let ((var (match-string 1))
3876 (form (org-trim (match-string 3))))
3877 (unless (equal form
"")
3878 (while (string-match "[ \t]*\n[ \t]*" form
)
3879 (setq form
(replace-match " " t t form
)))
3880 (when (assoc var eql
)
3881 (user-error "Double formulas for %s" var
))
3882 (push (cons var form
) eql
))))
3883 (set-window-configuration org-window-configuration
)
3884 (select-window sel-win
)
3886 (org-table-store-formulas eql
)
3887 (set-marker pos nil
)
3888 (set-marker source nil
)
3889 (kill-buffer "*Edit Formulas*")
3891 (org-table-recalculate 'all
)
3892 (message "New formulas installed - press C-u C-c C-c to apply."))))
3894 (defun org-table-fedit-abort ()
3895 "Abort editing formulas, without installing the changes."
3897 (org-table-remove-rectangle-highlight)
3898 (let ((pos org-pos
) (sel-win org-selected-window
))
3899 (set-window-configuration org-window-configuration
)
3900 (select-window sel-win
)
3902 (move-marker pos nil
)
3903 (message "Formula editing aborted without installing changes")))
3905 (defun org-table-fedit-lisp-indent ()
3906 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3908 (let ((pos (point)) beg end ind
)
3909 (beginning-of-line 1)
3911 ((looking-at "[ \t]")
3913 (call-interactively 'lisp-indent-line
))
3914 ((looking-at "[$&@0-9a-zA-Z]+ *= *[^ \t\n']") (goto-char pos
))
3915 ((not (fboundp 'pp-buffer
))
3916 (user-error "Cannot pretty-print. Command `pp-buffer' is not available"))
3917 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
3918 (goto-char (- (match-end 0) 2))
3920 (setq ind
(make-string (current-column) ?\
))
3921 (condition-case nil
(forward-sexp 1)
3923 (user-error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
3926 (narrow-to-region beg end
)
3927 (if (eq last-command this-command
)
3929 (goto-char (point-min))
3930 (setq this-command nil
)
3931 (while (re-search-forward "[ \t]*\n[ \t]*" nil t
)
3932 (replace-match " ")))
3934 (untabify (point-min) (point-max))
3935 (goto-char (1+ (point-min)))
3936 (while (re-search-forward "^." nil t
)
3937 (beginning-of-line 1)
3939 (goto-char (point-max))
3940 (org-delete-backward-char 1)))
3944 (defvar org-show-positions nil
)
3946 (defun org-table-show-reference (&optional local
)
3947 "Show the location/value of the $ expression at point.
3948 When LOCAL is non-nil, show references for the table at point."
3950 (org-table-remove-rectangle-highlight)
3951 (when local
(org-table-analyze))
3953 (let ((pos (if local
(point) org-pos
))
3955 (org-inhibit-highlight-removal t
)
3956 (win (selected-window))
3957 (org-show-positions nil
)
3958 var name e what match dest
)
3960 ((org-in-regexp "^@[0-9]+[ \t=]")
3961 (setq match
(concat (substring (match-string 0) 0 -
1)
3963 (substring (match-string 0) 0 -
1)
3966 ((or (org-in-regexp org-table-range-regexp2
)
3967 (org-in-regexp org-table-translate-regexp
)
3968 (org-in-regexp org-table-range-regexp
))
3971 (org-table-convert-refs-to-rc (match-string 0))))
3973 ((org-in-regexp "\\$[a-zA-Z][a-zA-Z0-9]*") 'name
)
3974 ((org-in-regexp "\\$[0-9]+") 'column
)
3976 (t (user-error "No reference at point")))
3977 match
(and what
(or match
(match-string 0))))
3978 (when (and match
(not (equal (match-beginning 0) (point-at-bol))))
3979 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
3980 'secondary-selection
))
3981 (add-hook 'before-change-functions
3982 #'org-table-remove-rectangle-highlight
)
3983 (when (eq what
'name
) (setq var
(substring match
1)))
3984 (when (eq what
'range
)
3985 (unless (eq (string-to-char match
) ?
@) (setq match
(concat "@" match
)))
3986 (setq match
(org-table-formula-substitute-names match
)))
3990 (re-search-backward "^\\S-" nil t
)
3992 (when (looking-at "\\(\\$[0-9a-zA-Z]+\\|@[0-9]+\\$[0-9]+\\|[a-zA-Z]+\
3993 \\([0-9]+\\|&\\)\\) *=")
3996 (org-table-convert-refs-to-rc (match-string 1))))
3997 (org-table-add-rectangle-overlay
3998 (match-beginning 1) (match-end 1) face2
))))
3999 (if (and (markerp pos
) (marker-buffer pos
))
4000 (if (get-buffer-window (marker-buffer pos
))
4001 (select-window (get-buffer-window (marker-buffer pos
)))
4002 (org-switch-to-buffer-other-window (get-buffer-window
4003 (marker-buffer pos
)))))
4005 (org-table-force-dataline)
4007 (if local org-table-current-begin-pos
(org-table-begin))))
4009 (setq name
(substring dest
1))
4011 ((string-match-p "\\`\\$[a-zA-Z][a-zA-Z0-9]*" dest
)
4012 (org-table-goto-field dest
))
4013 ((string-match-p "\\`@\\([1-9][0-9]*\\)\\$\\([1-9][0-9]*\\)\\'"
4015 (org-table-goto-field dest
))
4016 (t (org-table-goto-column (string-to-number name
))))
4017 (move-marker pos
(point))
4018 (org-table-highlight-rectangle nil nil face2
))
4020 ((equal dest match
))
4023 (ignore-errors (org-table-get-range match table-start nil
'highlight
)))
4024 ((setq e
(assoc var org-table-named-field-locations
))
4025 (org-table-goto-field var
)
4026 (org-table-highlight-rectangle)
4027 (message "Named field, column %d of line %d" (nth 2 e
) (nth 1 e
)))
4028 ((setq e
(assoc var org-table-column-names
))
4029 (org-table-goto-column (string-to-number (cdr e
)))
4030 (org-table-highlight-rectangle)
4031 (goto-char table-start
)
4032 (if (re-search-forward (concat "^[ \t]*| *! *.*?| *\\(" var
"\\) *|")
4035 (goto-char (match-beginning 1))
4036 (org-table-highlight-rectangle)
4037 (message "Named column (column %s)" (cdr e
)))
4038 (user-error "Column name not found")))
4041 (org-table-goto-column (string-to-number (substring match
1)))
4042 (org-table-highlight-rectangle)
4043 (message "Column %s" (substring match
1)))
4044 ((setq e
(assoc var org-table-local-parameters
))
4045 (goto-char table-start
)
4046 (if (re-search-forward (concat "^[ \t]*| *\\$ *.*?| *\\(" var
"=\\)") nil t
)
4048 (goto-char (match-beginning 1))
4049 (org-table-highlight-rectangle)
4050 (message "Local parameter."))
4051 (user-error "Parameter not found")))
4052 ((not var
) (user-error "No reference at point"))
4053 ((setq e
(assoc var org-table-formula-constants-local
))
4054 (message "Local Constant: $%s=%s in #+CONSTANTS line."
4056 ((setq e
(assoc var org-table-formula-constants
))
4057 (message "Constant: $%s=%s in `org-table-formula-constants'."
4059 ((setq e
(and (fboundp 'constants-get
) (constants-get var
)))
4060 (message "Constant: $%s=%s, from `constants.el'%s."
4061 var e
(format " (%s units)" constants-unit-system
)))
4062 (t (user-error "Undefined name $%s" var
)))
4064 (when (and org-show-positions
4065 (not (memq this-command
'(org-table-fedit-scroll
4066 org-table-fedit-scroll-down
))))
4067 (push pos org-show-positions
)
4068 (push table-start org-show-positions
)
4069 (let ((min (apply 'min org-show-positions
))
4070 (max (apply 'max org-show-positions
)))
4071 (set-window-start (selected-window) min
)
4073 (or (pos-visible-in-window-p max
)
4074 (set-window-start (selected-window) max
)))))
4075 (select-window win
))))
4077 (defun org-table-force-dataline ()
4078 "Make sure the cursor is in a dataline in a table."
4079 (unless (save-excursion
4080 (beginning-of-line 1)
4081 (looking-at org-table-dataline-regexp
))
4082 (let* ((re org-table-dataline-regexp
)
4083 (p1 (save-excursion (re-search-forward re nil
'move
)))
4084 (p2 (save-excursion (re-search-backward re nil
'move
))))
4086 (goto-char (if (< (abs (- p1
(point))) (abs (- p2
(point))))
4088 ((or p1 p2
) (goto-char (or p1 p2
)))
4089 (t (user-error "No table dataline around here"))))))
4091 (defun org-table-fedit-line-up ()
4092 "Move cursor one line up in the window showing the table."
4094 (org-table-fedit-move 'previous-line
))
4096 (defun org-table-fedit-line-down ()
4097 "Move cursor one line down in the window showing the table."
4099 (org-table-fedit-move 'next-line
))
4101 (defun org-table-fedit-move (command)
4102 "Move the cursor in the window showing the table.
4103 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4104 (let ((org-table-allow-automatic-line-recalculation nil
)
4105 (pos org-pos
) (win (selected-window)) p
)
4106 (select-window (get-buffer-window (marker-buffer org-pos
)))
4108 (call-interactively command
)
4109 (while (and (org-at-table-p)
4110 (org-at-table-hline-p))
4111 (call-interactively command
))
4112 (or (org-at-table-p) (goto-char p
))
4113 (move-marker pos
(point))
4114 (select-window win
)))
4116 (defun org-table-fedit-scroll (N)
4118 (let ((other-window-scroll-buffer (marker-buffer org-pos
)))
4119 (scroll-other-window N
)))
4121 (defun org-table-fedit-scroll-down (N)
4123 (org-table-fedit-scroll (- N
)))
4125 (defvar org-table-rectangle-overlays nil
)
4127 (defun org-table-add-rectangle-overlay (beg end
&optional face
)
4128 "Add a new overlay."
4129 (let ((ov (make-overlay beg end
)))
4130 (overlay-put ov
'face
(or face
'secondary-selection
))
4131 (push ov org-table-rectangle-overlays
)))
4133 (defun org-table-highlight-rectangle (&optional beg end face
)
4134 "Highlight rectangular region in a table.
4135 When buffer positions BEG and END are provided, use them to
4136 delimit the region to highlight. Otherwise, refer to point. Use
4137 FACE, when non-nil, for the highlight."
4138 (let* ((beg (or beg
(point)))
4139 (end (or end
(point)))
4145 (cons (line-beginning-position) (org-table-current-column))))
4149 (cons (line-beginning-position) (org-table-current-column)))))
4150 (when (boundp 'org-show-positions
)
4151 (setq org-show-positions
(cons b
(cons e org-show-positions
))))
4152 (goto-char (car start-coordinates
))
4153 (let ((column-start (min (cdr start-coordinates
) (cdr end-coordinates
)))
4154 (column-end (max (cdr start-coordinates
) (cdr end-coordinates
)))
4155 (last-row (car end-coordinates
)))
4156 (while (<= (point) last-row
)
4157 (when (looking-at org-table-dataline-regexp
)
4158 (org-table-goto-column column-start
)
4159 (skip-chars-backward "^|\n")
4161 (org-table-goto-column column-end
)
4162 (skip-chars-forward "^|\n")
4163 (org-table-add-rectangle-overlay p
(point) face
)))
4165 (goto-char (car start-coordinates
)))
4166 (add-hook 'before-change-functions
#'org-table-remove-rectangle-highlight
))
4168 (defun org-table-remove-rectangle-highlight (&rest _ignore
)
4169 "Remove the rectangle overlays."
4170 (unless org-inhibit-highlight-removal
4171 (remove-hook 'before-change-functions
'org-table-remove-rectangle-highlight
)
4172 (mapc 'delete-overlay org-table-rectangle-overlays
)
4173 (setq org-table-rectangle-overlays nil
)))
4175 (defvar-local org-table-coordinate-overlays nil
4176 "Collects the coordinate grid overlays, so that they can be removed.")
4178 (defun org-table-overlay-coordinates ()
4179 "Add overlays to the table at point, to show row/column coordinates."
4181 (mapc 'delete-overlay org-table-coordinate-overlays
)
4182 (setq org-table-coordinate-overlays nil
)
4184 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg
)
4185 (goto-char (org-table-begin))
4186 (while (org-at-table-p)
4187 (setq eol
(point-at-eol))
4188 (setq ov
(make-overlay (point-at-bol) (1+ (point-at-bol))))
4189 (push ov org-table-coordinate-overlays
)
4190 (setq hline
(looking-at org-table-hline-regexp
))
4191 (setq str
(if hline
(format "I*%-2d" (setq ih
(1+ ih
)))
4192 (format "%4d" (setq id
(1+ id
)))))
4193 (org-overlay-before-string ov str
'org-special-keyword
'evaporate
)
4196 (while (re-search-forward "[+|]\\(-+\\)" eol t
)
4197 (setq beg
(1+ (match-beginning 0))
4199 s1
(concat "$" (int-to-string ic
))
4200 s2
(org-number-to-letters ic
)
4201 str
(if (eq org-table-use-standard-references t
) s2 s1
))
4202 (setq ov
(make-overlay beg
(+ beg
(length str
))))
4203 (push ov org-table-coordinate-overlays
)
4204 (org-overlay-display ov str
'org-special-keyword
'evaporate
)))
4205 (beginning-of-line 2)))))
4208 (defun org-table-toggle-coordinate-overlays ()
4209 "Toggle the display of Row/Column numbers in tables."
4211 (setq org-table-overlay-coordinates
(not org-table-overlay-coordinates
))
4212 (message "Tables Row/Column numbers display turned %s"
4213 (if org-table-overlay-coordinates
"on" "off"))
4214 (if (and (org-at-table-p) org-table-overlay-coordinates
)
4216 (unless org-table-overlay-coordinates
4217 (mapc 'delete-overlay org-table-coordinate-overlays
)
4218 (setq org-table-coordinate-overlays nil
)))
4221 (defun org-table-toggle-formula-debugger ()
4222 "Toggle the formula debugger in tables."
4224 (setq org-table-formula-debug
(not org-table-formula-debug
))
4225 (message "Formula debugging has been turned %s"
4226 (if org-table-formula-debug
"on" "off")))
4228 ;;; The orgtbl minor mode
4230 ;; Define a minor mode which can be used in other modes in order to
4231 ;; integrate the Org table editor.
4233 ;; This is really a hack, because the Org table editor uses several
4234 ;; keys which normally belong to the major mode, for example the TAB
4235 ;; and RET keys. Here is how it works: The minor mode defines all the
4236 ;; keys necessary to operate the table editor, but wraps the commands
4237 ;; into a function which tests if the cursor is currently inside
4238 ;; a table. If that is the case, the table editor command is
4239 ;; executed. However, when any of those keys is used outside a table,
4240 ;; the function uses `key-binding' to look up if the key has an
4241 ;; associated command in another currently active keymap (minor modes,
4242 ;; major mode, global), and executes that command. There might be
4243 ;; problems if any of the keys used by the table editor is otherwise
4244 ;; used as a prefix key.
4246 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4247 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4248 ;; addresses this by checking explicitly for both bindings.
4250 ;; The optimized version (see variable `orgtbl-optimized') takes over
4251 ;; all keys which are bound to `self-insert-command' in the *global map*.
4252 ;; Some modes bind other commands to simple characters, for example
4253 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4254 ;; active, this binding is ignored inside tables and replaced with a
4255 ;; modified self-insert.
4258 (defvar orgtbl-mode-map
(make-keymap)
4259 "Keymap for `orgtbl-mode'.")
4261 (defvar org-old-auto-fill-inhibit-regexp nil
4262 "Local variable used by `orgtbl-mode'.")
4264 (defconst orgtbl-line-start-regexp
4265 "[ \t]*\\(|\\|#\\+\\(tblfm\\|orgtbl\\|tblname\\):\\)"
4266 "Matches a line belonging to an orgtbl.")
4268 (defconst orgtbl-extra-font-lock-keywords
4269 (list (list (concat "^" orgtbl-line-start-regexp
".*")
4270 0 (quote 'org-table
) 'prepend
))
4271 "Extra `font-lock-keywords' to be added when `orgtbl-mode' is active.")
4273 ;; Install it as a minor mode.
4274 (put 'orgtbl-mode
:included t
)
4275 (put 'orgtbl-mode
:menu-tag
"Org Table Mode")
4278 (define-minor-mode orgtbl-mode
4279 "The `org-mode' table editor as a minor mode for use in other modes."
4280 :lighter
" OrgTbl" :keymap orgtbl-mode-map
4281 (org-load-modules-maybe)
4283 ((derived-mode-p 'org-mode
)
4284 ;; Exit without error, in case some hook functions calls this
4285 ;; by accident in org-mode.
4286 (message "Orgtbl-mode is not useful in org-mode, command ignored"))
4288 (and (orgtbl-setup) (defun orgtbl-setup () nil
)) ;; FIXME: Yuck!?!
4289 ;; Make sure we are first in minor-mode-map-alist
4290 (let ((c (assq 'orgtbl-mode minor-mode-map-alist
)))
4291 ;; FIXME: maybe it should use emulation-mode-map-alists?
4292 (and c
(setq minor-mode-map-alist
4293 (cons c
(delq c minor-mode-map-alist
)))))
4294 (setq-local org-table-may-need-update t
)
4295 (add-hook 'before-change-functions
'org-before-change-function
4297 (setq-local org-old-auto-fill-inhibit-regexp
4298 auto-fill-inhibit-regexp
)
4299 (setq-local auto-fill-inhibit-regexp
4300 (if auto-fill-inhibit-regexp
4301 (concat orgtbl-line-start-regexp
"\\|"
4302 auto-fill-inhibit-regexp
)
4303 orgtbl-line-start-regexp
))
4304 (add-to-invisibility-spec '(org-cwidth))
4305 (when (fboundp 'font-lock-add-keywords
)
4306 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords
)
4307 (org-restart-font-lock))
4308 (easy-menu-add orgtbl-mode-menu
))
4310 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp
)
4311 (org-table-cleanup-narrow-column-properties)
4312 (org-remove-from-invisibility-spec '(org-cwidth))
4313 (remove-hook 'before-change-functions
'org-before-change-function t
)
4314 (when (fboundp 'font-lock-remove-keywords
)
4315 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords
)
4316 (org-restart-font-lock))
4317 (easy-menu-remove orgtbl-mode-menu
)
4318 (force-mode-line-update 'all
))))
4320 (defun org-table-cleanup-narrow-column-properties ()
4321 "Remove all properties related to narrow-column invisibility."
4322 (let ((s (point-min)))
4323 (while (setq s
(text-property-any s
(point-max)
4324 'display org-narrow-column-arrow
))
4325 (remove-text-properties s
(1+ s
) '(display t
)))
4326 (setq s
(point-min))
4327 (while (setq s
(text-property-any s
(point-max) 'org-cwidth
1))
4328 (remove-text-properties s
(1+ s
) '(org-cwidth t
)))
4329 (setq s
(point-min))
4330 (while (setq s
(text-property-any s
(point-max) 'invisible
'org-cwidth
))
4331 (remove-text-properties s
(1+ s
) '(invisible t
)))))
4333 (defun orgtbl-make-binding (fun n
&rest keys
)
4334 "Create a function for binding in the table minor mode.
4335 FUN is the command to call inside a table. N is used to create a unique
4336 command name. KEYS are keys that should be checked in for a command
4337 to execute outside of tables."
4340 (intern (concat "orgtbl-hijacker-command-" (int-to-string n
)))
4342 (concat "In tables, run `" (symbol-name fun
) "'.\n"
4343 "Outside of tables, run the binding of `"
4344 (mapconcat #'key-description keys
"' or `")
4349 (list 'call-interactively
(list 'quote fun
))
4350 (list 'let
'(orgtbl-mode)
4351 (list 'call-interactively
4354 (list 'key-binding k
))
4356 '('orgtbl-error
))))))))
4358 (defun orgtbl-error ()
4359 "Error when there is no default binding for a table key."
4361 (user-error "This key has no function outside tables"))
4363 (defun orgtbl-setup ()
4364 "Setup orgtbl keymaps."
4367 '(([(meta shift left
)] org-table-delete-column
)
4368 ([(meta left
)] org-table-move-column-left
)
4369 ([(meta right
)] org-table-move-column-right
)
4370 ([(meta shift right
)] org-table-insert-column
)
4371 ([(meta shift up
)] org-table-kill-row
)
4372 ([(meta shift down
)] org-table-insert-row
)
4373 ([(meta up
)] org-table-move-row-up
)
4374 ([(meta down
)] org-table-move-row-down
)
4375 ("\C-c\C-w" org-table-cut-region
)
4376 ("\C-c\M-w" org-table-copy-region
)
4377 ("\C-c\C-y" org-table-paste-rectangle
)
4378 ("\C-c\C-w" org-table-wrap-region
)
4379 ("\C-c-" org-table-insert-hline
)
4380 ("\C-c}" org-table-toggle-coordinate-overlays
)
4381 ("\C-c{" org-table-toggle-formula-debugger
)
4382 ("\C-m" org-table-next-row
)
4383 ([(shift return
)] org-table-copy-down
)
4384 ("\C-c?" org-table-field-info
)
4385 ("\C-c " org-table-blank-field
)
4386 ("\C-c+" org-table-sum
)
4387 ("\C-c=" org-table-eval-formula
)
4388 ("\C-c'" org-table-edit-formulas
)
4389 ("\C-c`" org-table-edit-field
)
4390 ("\C-c*" org-table-recalculate
)
4391 ("\C-c^" org-table-sort-lines
)
4392 ("\M-a" org-table-beginning-of-field
)
4393 ("\M-e" org-table-end-of-field
)
4394 ([(control ?
#)] org-table-rotate-recalc-marks
)))
4396 (while (setq elt
(pop bindings
))
4397 (setq nfunc
(1+ nfunc
))
4398 (setq key
(org-key (car elt
))
4400 cmd
(orgtbl-make-binding fun nfunc key
))
4401 (org-defkey orgtbl-mode-map key cmd
))
4403 ;; Special treatment needed for TAB, RET and DEL
4404 (org-defkey orgtbl-mode-map
[(return)]
4405 (orgtbl-make-binding 'orgtbl-ret
100 [(return)] "\C-m"))
4406 (org-defkey orgtbl-mode-map
"\C-m"
4407 (orgtbl-make-binding 'orgtbl-ret
101 "\C-m" [(return)]))
4408 (org-defkey orgtbl-mode-map
[(tab)]
4409 (orgtbl-make-binding 'orgtbl-tab
102 [(tab)] "\C-i"))
4410 (org-defkey orgtbl-mode-map
"\C-i"
4411 (orgtbl-make-binding 'orgtbl-tab
103 "\C-i" [(tab)]))
4412 (org-defkey orgtbl-mode-map
[(shift tab
)]
4413 (orgtbl-make-binding 'org-table-previous-field
104
4414 [(shift tab
)] [(tab)] "\C-i"))
4415 (org-defkey orgtbl-mode-map
[backspace]
4416 (orgtbl-make-binding 'org-delete-backward-char 109
4417 [backspace] (kbd "DEL")))
4419 (org-defkey orgtbl-mode-map
[S-iso-lefttab
]
4420 (orgtbl-make-binding 'org-table-previous-field
107
4421 [S-iso-lefttab
] [backtab] [(shift tab)]
4424 (org-defkey orgtbl-mode-map [backtab]
4425 (orgtbl-make-binding 'org-table-previous-field
108
4426 [backtab] [S-iso-lefttab] [(shift tab)]
4429 (org-defkey orgtbl-mode-map "\M-\C-m"
4430 (orgtbl-make-binding 'org-table-wrap-region 105
4431 "\M-\C-m" [(meta return)]))
4432 (org-defkey orgtbl-mode-map [(meta return)]
4433 (orgtbl-make-binding 'org-table-wrap-region 106
4434 [(meta return)] "\M-\C-m"))
4436 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4437 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4439 (when orgtbl-optimized
4440 ;; If the user wants maximum table support, we need to hijack
4441 ;; some standard editing functions
4442 (org-remap orgtbl-mode-map
4443 'self-insert-command 'orgtbl-self-insert-command
4444 'delete-char 'org-delete-char
4445 'delete-backward-char 'org-delete-backward-char)
4446 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4447 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4449 ["Create or convert" org-table-create-or-convert-from-region
4450 :active (not (org-at-table-p)) :keys "C-c |" ]
4452 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4453 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4454 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4455 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4457 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4458 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4459 ["Copy Field from Above"
4460 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4463 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4464 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4465 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4466 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4468 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4469 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4470 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4471 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4472 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4474 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4476 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4477 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4478 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4479 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4482 ["Insert table template" orgtbl-insert-radio-table
4483 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4484 ["Comment/uncomment table" orgtbl-toggle-comment t])
4486 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4487 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4488 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4489 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4490 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4491 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4492 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4493 ["Sum Column/Rectangle" org-table-sum
4494 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4495 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4497 org-table-toggle-formula-debugger :active (org-at-table-p)
4499 :style toggle :selected org-table-formula-debug]
4500 ["Show Col/Row Numbers"
4501 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4503 :style toggle :selected org-table-overlay-coordinates]
4506 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
4507 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
4510 (defun orgtbl-ctrl-c-ctrl-c (arg)
4511 "If the cursor is inside a table, realign the table.
4512 If it is a table to be sent away to a receiver, do it.
4513 With prefix arg, also recompute table."
4515 (let ((case-fold-search t) (pos (point)) action)
4517 (beginning-of-line 1)
4519 ((looking-at "[ \t]*#\\+ORGTBL:.*\n[ \t]*|") (match-end 0))
4520 ((looking-at "[ \t]*|") pos)
4521 ((looking-at "[ \t]*#\\+tblfm:") 'recalc))))
4525 (org-table-maybe-eval-formula)
4527 (call-interactively 'org-table-recalculate)
4528 (org-table-maybe-recalculate-line))
4529 (call-interactively 'org-table-align)
4530 (when (orgtbl-send-table 'maybe)
4531 (run-hooks 'orgtbl-after-send-table-hook)))
4532 ((eq action 'recalc)
4534 (beginning-of-line 1)
4535 (skip-chars-backward " \r\n\t")
4536 (if (org-at-table-p)
4537 (org-call-with-arg 'org-table-recalculate t))))
4538 (t (let (orgtbl-mode)
4539 (call-interactively (key-binding "\C-c\C-c")))))))
4541 (defun orgtbl-create-or-convert-from-region (_arg)
4542 "Create table or convert region to table, if no conflicting binding.
4543 This installs the table binding `C-c |', but only if there is no
4544 conflicting binding to this key outside orgtbl-mode."
4546 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4548 (call-interactively cmd)
4549 (call-interactively 'org-table-create-or-convert-from-region))))
4551 (defun orgtbl-tab (arg)
4552 "Justification and field motion for `orgtbl-mode'."
4554 (if arg (org-table-edit-field t)
4555 (org-table-justify-field-maybe)
4556 (org-table-next-field)))
4558 (defun orgtbl-ret ()
4559 "Justification and field motion for `orgtbl-mode'."
4563 (org-table-justify-field-maybe)
4564 (org-table-next-row)))
4566 (defun orgtbl-self-insert-command (N)
4567 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4568 If the cursor is in a table looking at whitespace, the whitespace is
4569 overwritten, and the table is not marked as requiring realignment."
4571 (if (and (org-at-table-p)
4573 (and org-table-auto-blank-field
4574 (member last-command
4575 '(orgtbl-hijacker-command-100
4576 orgtbl-hijacker-command-101
4577 orgtbl-hijacker-command-102
4578 orgtbl-hijacker-command-103
4579 orgtbl-hijacker-command-104
4580 orgtbl-hijacker-command-105
4582 (org-table-blank-field))
4585 (looking-at "[^|\n]* \\( \\)|"))
4586 (let (org-table-may-need-update)
4587 (delete-region (match-beginning 1) (match-end 1))
4588 (self-insert-command N))
4589 (setq org-table-may-need-update t)
4592 (cmd (or (key-binding
4593 (or (and (listp function-key-map)
4594 (setq a (assoc last-input-event function-key-map))
4596 (vector last-input-event)))
4597 'self-insert-command)))
4598 (call-interactively cmd)
4599 (if (and org-self-insert-cluster-for-undo
4600 (eq cmd 'self-insert-command))
4601 (if (not (eq last-command 'orgtbl-self-insert-command))
4602 (setq org-self-insert-command-undo-counter 1)
4603 (if (>= org-self-insert-command-undo-counter 20)
4604 (setq org-self-insert-command-undo-counter 1)
4605 (and (> org-self-insert-command-undo-counter 0)
4607 (not (cadr buffer-undo-list)) ; remove nil entry
4608 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4609 (setq org-self-insert-command-undo-counter
4610 (1+ org-self-insert-command-undo-counter))))))))
4613 (defvar orgtbl-exp-regexp "^\\([-+]?[0-9][0-9.]*\\)[eE]\\([-+]?[0-9]+\\)$"
4614 "Regular expression matching exponentials as produced by calc.")
4616 (defun orgtbl-gather-send-defs ()
4617 "Gather a plist of :name, :transform, :params for each destination before
4620 (goto-char (org-table-begin))
4622 (beginning-of-line 0)
4623 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4624 (let ((name (org-no-properties (match-string 1)))
4625 (transform (intern (match-string 2)))
4626 (params (if (match-end 3)
4627 (read (concat "(" (match-string 3) ")")))))
4628 (push (list :name name :transform transform :params params)
4630 (beginning-of-line 0)))
4633 (defun orgtbl-send-replace-tbl (name text)
4634 "Find and replace table NAME with TEXT."
4636 (goto-char (point-min))
4637 (let* ((location-flag nil)
4638 (name (regexp-quote name))
4639 (begin-re (format "BEGIN +RECEIVE +ORGTBL +%s\\([ \t]\\|$\\)" name))
4640 (end-re (format "END +RECEIVE +ORGTBL +%s\\([ \t]\\|$\\)" name)))
4641 (while (re-search-forward begin-re nil t)
4642 (unless location-flag (setq location-flag t))
4643 (let ((beg (line-beginning-position 2)))
4644 (unless (re-search-forward end-re nil t)
4645 (user-error "Cannot find end of receiver location at %d" beg))
4647 (delete-region beg (point))
4648 (insert text "\n")))
4649 (unless location-flag
4650 (user-error "No valid receiver location found in the buffer")))))
4653 (defun org-table-to-lisp (&optional txt)
4654 "Convert the table at point to a Lisp structure.
4655 The structure will be a list. Each item is either the symbol `hline'
4656 for a horizontal separator line, or a list of field values as strings.
4657 The table is taken from the parameter TXT, or from the buffer at point."
4658 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4660 (buffer-substring-no-properties (org-table-begin)
4663 (if (string-match org-table-hline-regexp x) 'hline
4664 (org-split-string (org-trim x) "\\s-*|\\s-*")))
4665 (org-split-string txt "[ \t]*\n[ \t]*"))))
4667 (defun orgtbl-send-table (&optional maybe)
4668 "Send a transformed version of table at point to the receiver position.
4669 With argument MAYBE, fail quietly if no transformation is defined
4673 (unless (org-at-table-p) (user-error "Not at a table"))
4674 ;; when non-interactive, we assume align has just happened.
4675 (when (called-interactively-p 'any) (org-table-align))
4676 (let ((dests (orgtbl-gather-send-defs))
4677 (table (org-table-to-lisp
4678 (buffer-substring-no-properties (org-table-begin)
4682 (if maybe (throw 'exit nil)
4683 (user-error "Don't know how to transform this table")))
4684 (dolist (dest dests)
4685 (let ((name (plist-get dest :name))
4686 (transform (plist-get dest :transform))
4687 (params (plist-get dest :params)))
4688 (unless (fboundp transform)
4689 (user-error "No such transformation function %s" transform))
4690 (orgtbl-send-replace-tbl name (funcall transform table params)))
4692 (message "Table converted and installed at %d receiver location%s"
4693 ntbl (if (> ntbl 1) "s" ""))
4694 (and (> ntbl 0) ntbl))))
4696 (defun org-remove-by-index (list indices &optional i0)
4697 "Remove the elements in LIST with indices in INDICES.
4698 First element has index 0, or I0 if given."
4701 (if (integerp indices) (setq indices (list indices)))
4702 (setq i0 (1- (or i0 0)))
4703 (delq :rm (mapcar (lambda (x)
4705 (if (memq i0 indices) :rm x))
4708 (defun orgtbl-toggle-comment ()
4709 "Comment or uncomment the orgtbl at point."
4711 (let* ((case-fold-search t)
4712 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4713 (re2 (concat "^" orgtbl-line-start-regexp))
4714 (commented (save-excursion (beginning-of-line 1)
4715 (cond ((looking-at re1) t)
4716 ((looking-at re2) nil)
4717 (t (user-error "Not at an org table")))))
4718 (re (if commented re1 re2))
4721 (beginning-of-line 1)
4722 (while (looking-at re) (beginning-of-line 0))
4723 (beginning-of-line 2)
4725 (while (looking-at re) (beginning-of-line 2))
4727 (comment-region beg end (if commented '(4) nil))))
4729 (defun orgtbl-insert-radio-table ()
4730 "Insert a radio table template appropriate for this major mode."
4732 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4735 (unless e (user-error "No radio table setup defined for %s" major-mode))
4736 (setq name (read-string "Table name: "))
4737 (while (string-match "%n" txt)
4738 (setq txt (replace-match name t t txt)))
4739 (or (bolp) (insert "\n"))
4745 (defun orgtbl-to-generic (table params)
4746 "Convert the orgtbl-mode TABLE to some other format.
4748 This generic routine can be used for many standard cases.
4750 TABLE is a list, each entry either the symbol `hline' for
4751 a horizontal separator line, or a list of fields for that
4752 line. PARAMS is a property list of parameters that can
4753 influence the conversion.
4755 Valid parameters are:
4759 Export back-end used as a basis to transcode elements of the
4760 table, when no specific parameter applies to it. It is also
4761 used to translate cells contents. You can prevent this by
4762 setting :raw property to a non-nil value.
4766 When non-nil, only convert rows, not the table itself. This is
4767 equivalent to setting to the empty string both :tstart
4768 and :tend, which see.
4772 When set to an integer N, skip the first N lines of the table.
4773 Horizontal separation lines do count for this parameter!
4777 List of columns that should be skipped. If the table has
4778 a column with calculation marks, that column is automatically
4779 discarded beforehand.
4783 String to be inserted on horizontal separation lines. May be
4784 nil to ignore these lines altogether.
4788 Separator between two fields, as a string.
4790 Each in the following group may be either a string or a function
4791 of no arguments returning a string:
4795 Strings to start and end the table. Ignored when :splice is t.
4799 Strings to start and end a new table line.
4803 Strings to start and end the last table line. Default,
4804 respectively, to :lstart and :lend.
4806 Each in the following group may be a string or a function of one
4807 argument (either the cells in the current row, as a list of
4808 strings, or the current cell) returning a string:
4812 Format string for an entire row, with enough %s to capture all
4813 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4817 Format for the entire last line, defaults to :lfmt.
4821 A format to be used to wrap the field, should contain %s for
4822 the original field value. For example, to wrap everything in
4823 dollars, you could use :fmt \"$%s$\". This may also be
4824 a property list with column numbers and format strings, or
4827 (:fmt (2 \"$%s$\" 4 (lambda (c) (format \"$%s$\" c))))
4829 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4831 Same as above, specific for the header lines in the table.
4832 All lines before the first hline are treated as header. If
4833 any of these is not present, the data line value is used.
4835 This may be either a string or a function of two arguments:
4839 Use this format to print numbers with exponential. The format
4840 should have %s twice for inserting mantissa and exponent, for
4841 example \"%s\\\\times10^{%s}\". This may also be a property
4842 list with column numbers and format strings or functions.
4843 :fmt will still be applied after :efmt."
4844 ;; Make sure `org-export-create-backend' is available.
4846 (let* ((backend (plist-get params :backend))
4848 ;; Build a custom back-end according to PARAMS. Before
4849 ;; defining a translator, check if there is anything to do.
4850 ;; When there isn't, let BACKEND handle the element.
4851 (org-export-create-backend
4852 :parent (or backend 'org)
4854 `((table . ,(org-table--to-generic-table params))
4855 (table-row . ,(org-table--to-generic-row params))
4856 (table-cell . ,(org-table--to-generic-cell params))
4857 ;; Macros are not going to be expanded. However, no
4858 ;; regular back-end has a transcoder for them. We
4859 ;; provide one so they are not ignored, but displayed
4861 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4863 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4864 ;; Initialize communication channel in INFO.
4866 (let ((org-inhibit-startup t)) (org-mode))
4867 (let ((standard-output (current-buffer)))
4869 (cond ((eq e 'hline) (princ "|--\n"))
4871 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4873 ;; Add back-end specific filters, but not user-defined ones. In
4874 ;; particular, make sure to call parse-tree filters on the
4877 (let ((org-export-filters-alist nil))
4878 (org-export-install-filters
4880 (org-export-get-environment backend nil params)
4881 `(:back-end ,(org-export-get-backend backend))))))
4883 (org-export-filter-apply-functions
4884 (plist-get info :filter-parse-tree)
4885 (org-element-map (org-element-parse-buffer) 'table
4888 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4889 (user-error "Unknown :backend value"))
4890 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4891 ;; Handle :skip parameter.
4892 (let ((skip (plist-get info :skip)))
4894 (unless (wholenump skip) (user-error "Wrong :skip value"))
4896 (org-element-map data 'table-row
4899 (org-element-extract-element row)
4903 ;; Handle :skipcols parameter.
4904 (let ((skipcols (plist-get info :skipcols)))
4906 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4907 (org-element-map data 'table
4909 (let ((specialp (org-export-table-has-special-column-p table)))
4910 (dolist (row (org-element-contents table))
4911 (when (eq (org-element-property :type row) 'standard)
4913 (dolist (cell (nthcdr (if specialp 1 0)
4914 (org-element-contents row)))
4915 (when (memq c skipcols)
4916 (org-element-extract-element cell))
4917 (cl-incf c))))))))))
4918 ;; Since we are going to export using a low-level mechanism,
4919 ;; ignore special column and special rows manually.
4920 (let ((special? (org-export-table-has-special-column-p data))
4922 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4924 (when (if (eq (org-element-type datum) 'table-row)
4925 (org-export-table-row-is-special-p datum nil)
4926 (org-export-first-sibling-p datum nil))
4927 (push datum ignore))))
4928 (setq info (plist-put info :ignore-list ignore)))
4929 ;; We use a low-level mechanism to export DATA so as to skip all
4930 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4931 ;; code evaluation, include keywords and macro expansion. Only
4932 ;; back-end specific filters are retained.
4933 (let ((output (org-export-data-with-backend data custom-backend info)))
4934 ;; Remove final newline.
4935 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4937 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4938 (cond ((null value) nil)
4939 ((functionp value) `(funcall ',value ,@args))
4941 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4942 (args `(format ,value ,@args))
4944 ((and with-cons (consp value))
4945 `(let ((val (cadr (memq column ',value))))
4946 (cond ((null val) contents)
4947 ((stringp val) (format val ,@args))
4948 ((functionp val) (funcall val ,@args))
4949 (t (user-error "Wrong %s value" ,name)))))
4950 (t (user-error "Wrong %s value" name))))
4952 (defun org-table--to-generic-table (params)
4953 "Return custom table transcoder according to PARAMS.
4954 PARAMS is a plist. See `orgtbl-to-generic' for more
4956 (let ((backend (plist-get params :backend))
4957 (splice (plist-get params :splice))
4958 (tstart (plist-get params :tstart))
4959 (tend (plist-get params :tend)))
4960 `(lambda (table contents info)
4962 ,(and tstart (not splice)
4963 `(concat ,(org-table--generic-apply tstart ":tstart") "\n"))
4964 ,(if (or (not backend) tstart tend splice) 'contents
4965 `(org-export-with-backend ',backend table contents info))
4966 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4968 (defun org-table--to-generic-row (params)
4969 "Return custom table row transcoder according to PARAMS.
4970 PARAMS is a plist. See `orgtbl-to-generic' for more
4972 (let* ((backend (plist-get params :backend))
4973 (lstart (plist-get params :lstart))
4974 (llstart (plist-get params :llstart))
4975 (hlstart (plist-get params :hlstart))
4976 (hllstart (plist-get params :hllstart))
4977 (lend (plist-get params :lend))
4978 (llend (plist-get params :llend))
4979 (hlend (plist-get params :hlend))
4980 (hllend (plist-get params :hllend))
4981 (lfmt (plist-get params :lfmt))
4982 (llfmt (plist-get params :llfmt))
4983 (hlfmt (plist-get params :hlfmt))
4984 (hllfmt (plist-get params :hllfmt)))
4985 `(lambda (row contents info)
4986 (if (eq (org-element-property :type row) 'rule)
4988 ((plist-member params :hline)
4989 (org-table--generic-apply (plist-get params :hline) ":hline"))
4990 (backend `(org-export-with-backend ',backend row nil info)))
4991 (let ((headerp (org-export-table-row-in-header-p row info))
4992 (lastp (not (org-export-get-next-element row info)))
4993 (last-header-p (org-export-table-row-ends-header-p row info)))
4995 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4996 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4997 ;; `:lstart', `:lend' and their relatives.
4999 '(org-element-map row 'table-cell
5001 ;; Export all cells, without separators.
5003 ;; Use `org-export-data-with-backend'
5004 ;; instead of `org-export-data' to eschew
5005 ;; cached values, which
5006 ;; ignore :orgtbl-ignore-sep parameter.
5007 (org-export-data-with-backend
5009 (plist-get info :back-end)
5010 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5014 `(last-header-p ,(org-table--generic-apply
5015 hllfmt ":hllfmt" nil cells)))
5017 `(headerp ,(org-table--generic-apply
5018 hlfmt ":hlfmt" nil cells)))
5020 `(lastp ,(org-table--generic-apply
5021 llfmt ":llfmt" nil cells)))
5023 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5027 (or hllstart hllend)
5030 ,(org-table--generic-apply hllstart ":hllstart")
5032 ,(org-table--generic-apply hllend ":hllend"))))
5037 ,(org-table--generic-apply hlstart ":hlstart")
5039 ,(org-table--generic-apply hlend ":hlend"))))
5044 ,(org-table--generic-apply llstart ":llstart")
5046 ,(org-table--generic-apply llend ":llend"))))
5051 ,(org-table--generic-apply lstart ":lstart")
5053 ,(org-table--generic-apply lend ":lend")))
5055 `(org-export-with-backend
5056 ',backend row contents info))
5057 (t 'contents)))))))))))))))
5059 (defun org-table--to-generic-cell (params)
5060 "Return custom table cell transcoder according to PARAMS.
5061 PARAMS is a plist. See `orgtbl-to-generic' for more
5063 (let* ((backend (plist-get params :backend))
5064 (efmt (plist-get params :efmt))
5065 (fmt (plist-get params :fmt))
5066 (hfmt (plist-get params :hfmt))
5067 (sep (plist-get params :sep))
5068 (hsep (plist-get params :hsep)))
5069 `(lambda (cell contents info)
5070 (let ((headerp (org-export-table-row-in-header-p
5071 (org-export-get-parent-element cell) info))
5072 (column (1+ (cdr (org-export-table-cell-address cell info)))))
5073 ;; Make sure that contents are exported as Org data when :raw
5074 ;; parameter is non-nil.
5075 ,(when (and backend (plist-get params :raw))
5077 ;; Since we don't know what are the pseudo object
5078 ;; types defined in backend, we cannot pass them to
5079 ;; `org-element-interpret-data'. As a consequence,
5080 ;; they will be treated as pseudo elements, and
5081 ;; will have newlines appended instead of spaces.
5082 ;; Therefore, we must make sure :post-blank value
5083 ;; is really turned into spaces.
5084 (replace-regexp-in-string
5087 (org-element-interpret-data
5088 (org-element-contents cell))))))
5090 ;; Check if we can apply `:efmt' on CONTENTS.
5092 `(when (string-match orgtbl-exp-regexp contents)
5093 (let ((mantissa (match-string 1 contents))
5094 (exponent (match-string 2 contents)))
5095 (setq contents ,(org-table--generic-apply
5096 efmt ":efmt" t 'mantissa 'exponent)))))
5097 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5099 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5100 hfmt ":hfmt" t 'contents))))
5101 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5102 fmt ":fmt" t 'contents))))))
5103 ;; If a separator is provided, use it instead of BACKEND's.
5104 ;; Separators are ignored when LFMT (or equivalent) is
5108 `(if (or ,(and (not sep) '(not headerp))
5109 (plist-get info :orgtbl-ignore-sep)
5110 (not (org-export-get-next-element cell info)))
5111 ,(if (not backend) 'contents
5112 `(org-export-with-backend ',backend cell contents info))
5114 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5116 (backend `(org-export-with-backend ',backend cell contents info))
5120 (defun orgtbl-to-tsv (table params)
5121 "Convert the orgtbl-mode table to TAB separated material."
5122 (orgtbl-to-generic table (org-combine-plists '(:sep "\t") params)))
5125 (defun orgtbl-to-csv (table params)
5126 "Convert the orgtbl-mode table to CSV material.
5127 This does take care of the proper quoting of fields with comma or quotes."
5128 (orgtbl-to-generic table
5129 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5133 (defun orgtbl-to-latex (table params)
5134 "Convert the orgtbl-mode TABLE to LaTeX.
5136 TABLE is a list, each entry either the symbol `hline' for
5137 a horizontal separator line, or a list of fields for that line.
5138 PARAMS is a property list of parameters that can influence the
5139 conversion. All parameters from `orgtbl-to-generic' are
5140 supported. It is also possible to use the following ones:
5144 When non-nil, use formal \"booktabs\" style.
5148 Specify environment to use, as a string. If you use
5149 \"longtable\", you may also want to specify :language property,
5150 as a string, to get proper continuation strings."
5155 ;; Provide sane default values.
5156 (list :backend 'latex
5157 :latex-default-table-mode 'table
5158 :latex-tables-centered nil
5159 :latex-tables-booktabs (plist-get params :booktabs)
5160 :latex-table-scientific-notation nil
5161 :latex-default-table-environment
5162 (or (plist-get params :environment) "tabular"))
5166 (defun orgtbl-to-html (table params)
5167 "Convert the orgtbl-mode TABLE to HTML.
5169 TABLE is a list, each entry either the symbol `hline' for
5170 a horizontal separator line, or a list of fields for that line.
5171 PARAMS is a property list of parameters that can influence the
5172 conversion. All parameters from `orgtbl-to-generic' are
5173 supported. It is also possible to use the following one:
5177 Attributes and values, as a plist, which will be used in
5183 ;; Provide sane default values.
5184 (list :backend 'html
5185 :html-table-data-tags '("<td%s>" . "</td>")
5186 :html-table-use-header-tags-for-first-column nil
5187 :html-table-align-individual-fields t
5188 :html-table-row-tags '("<tr>" . "</tr>")
5189 :html-table-attributes
5190 (if (plist-member params :attributes)
5191 (plist-get params :attributes)
5192 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5197 (defun orgtbl-to-texinfo (table params)
5198 "Convert the orgtbl-mode TABLE to Texinfo.
5200 TABLE is a list, each entry either the symbol `hline' for
5201 a horizontal separator line, or a list of fields for that line.
5202 PARAMS is a property list of parameters that can influence the
5203 conversion. All parameters from `orgtbl-to-generic' are
5204 supported. It is also possible to use the following one:
5208 Column widths, as a string. When providing column fractions,
5209 \"@columnfractions\" command can be omitted."
5210 (require 'ox-texinfo)
5215 (list :backend 'texinfo
5216 :texinfo-tables-verbatim nil
5217 :texinfo-table-scientific-notation nil)
5219 (columns (let ((w (plist-get params :columns)))
5221 ((string-match-p "{\\|@columnfractions " w) w)
5222 (t (concat "@columnfractions " w))))))
5223 (if (not columns) output
5224 (replace-regexp-in-string
5225 "@multitable \\(.*\\)" columns output t nil 1))))
5228 (defun orgtbl-to-orgtbl (table params)
5229 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5231 TABLE is a list, each entry either the symbol `hline' for
5232 a horizontal separator line, or a list of fields for that line.
5233 PARAMS is a property list of parameters that can influence the
5234 conversion. All parameters from `orgtbl-to-generic' are
5237 Useful when slicing one table into many. The :hline, :sep,
5238 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5239 be set to provide ORGTBL directives for the generated table."
5241 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5243 (defun orgtbl-to-table.el (table params)
5244 "Convert the orgtbl-mode TABLE into a table.el table.
5245 TABLE is a list, each entry either the symbol `hline' for
5246 a horizontal separator line, or a list of fields for that line.
5247 PARAMS is a property list of parameters that can influence the
5248 conversion. All parameters from `orgtbl-to-generic' are
5251 (insert (orgtbl-to-orgtbl table params))
5253 (replace-regexp-in-string
5255 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5257 (defun orgtbl-to-unicode (table params)
5258 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5260 TABLE is a list, each entry either the symbol `hline' for
5261 a horizontal separator line, or a list of fields for that line.
5262 PARAMS is a property list of parameters that can influence the
5263 conversion. All parameters from `orgtbl-to-generic' are
5264 supported. It is also possible to use the following ones:
5268 When non-nil, use \"ascii-art-to-unicode\" package to translate
5269 the table. You can download it here:
5270 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5274 When non-nil, narrow columns width than provided width cookie,
5275 using \"=>\" as an ellipsis, just like in an Org mode buffer."
5280 (list :backend 'ascii
5281 :ascii-charset 'utf-8
5282 :ascii-table-widen-columns (not (plist-get params :narrow))
5283 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5286 ;; Put the cursor in a column containing numerical values
5289 ;; A new column is added with a bar plot.
5290 ;; When the table is refreshed (C-u C-c *),
5291 ;; the plot is updated to reflect the new values.
5293 (defun orgtbl-ascii-draw (value min max &optional width characters)
5294 "Draw an ascii bar in a table.
5295 VALUE is the value to plot, it determines the width of the bar to draw.
5296 MIN is the value that will be displayed as empty (zero width bar).
5297 MAX is the value that will draw a bar filling all the WIDTH.
5298 WIDTH is the span in characters from MIN to MAX.
5299 CHARACTERS is a string that will compose the bar, with shades of grey
5300 from pure white to pure black. It defaults to a 10 characters string
5301 of regular ascii characters."
5302 (let* ((width (ceiling (or width 12)))
5303 (characters (or characters " .:;c!lhVHW"))
5304 (len (1- (length characters)))
5305 (value (float (if (numberp value)
5306 value (string-to-number value))))
5307 (relative (/ (- value min) (- max min)))
5308 (steps (round (* relative width len))))
5309 (cond ((< steps 0) "too small")
5310 ((> steps (* width len)) "too large")
5311 (t (let* ((int-division (/ steps len))
5312 (remainder (- steps (* int-division len))))
5313 (concat (make-string int-division (elt characters len))
5314 (string (elt characters remainder))))))))
5317 (defun orgtbl-ascii-plot (&optional ask)
5318 "Draw an ASCII bar plot in a column.
5320 With cursor in a column containing numerical values, this function
5321 will draw a plot in a new column.
5323 ASK, if given, is a numeric prefix to override the default 12
5324 characters width of the plot. ASK may also be the `\\[universal-argument]' \
5326 which will prompt for the width."
5328 (let ((col (org-table-current-column))
5329 (min 1e999) ; 1e999 will be converted to infinity
5330 (max -1e999) ; which is the desired result
5331 (table (org-table-to-lisp))
5334 (read-number "Length of column " 12))
5337 ;; Skip any hline a the top of table.
5338 (while (eq (car table) 'hline) (setq table (cdr table)))
5339 ;; Skip table header if any.
5340 (dolist (x (or (cdr (memq 'hline table)) table))
5342 (setq x (nth (1- col) x))
5344 "^[-+]?\\([0-9]*[.]\\)?[0-9]*\\([eE][+-]?[0-9]+\\)?$"
5346 (setq x (string-to-number x))
5347 (when (> min x) (setq min x))
5348 (when (< max x) (setq max x)))))
5349 (org-table-insert-column)
5350 (org-table-move-column-right)
5351 (org-table-store-formulas
5354 (concat "$" (number-to-string (1+ col)))
5355 (format "'(%s $%s %s %s %s)"
5356 "orgtbl-ascii-draw" col min max length))
5357 (org-table-get-stored-formulas)))
5358 (org-table-recalculate t)))
5360 ;; Example of extension: unicode characters
5361 ;; Here are two examples of different styles.
5363 ;; Unicode block characters are used to give a smooth effect.
5364 ;; See http://en.wikipedia.org/wiki/Block_Elements
5365 ;; Use one of those drawing functions
5366 ;; - orgtbl-ascii-draw (the default ascii)
5367 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5368 ;; - orgtbl-uc-draw-cont (smooth unicode)
5370 ;; This is best viewed with the "DejaVu Sans Mono" font
5371 ;; (use M-x set-default-font).
5373 (defun orgtbl-uc-draw-grid (value min max &optional width)
5374 "Draw a bar in a table using block unicode characters.
5375 It is a variant of orgtbl-ascii-draw with Unicode block
5376 characters, for a smooth display. Bars appear as grids (to the
5377 extent the font allows)."
5378 ;; http://en.wikipedia.org/wiki/Block_Elements
5379 ;; best viewed with the "DejaVu Sans Mono" font.
5380 (orgtbl-ascii-draw value min max width
5381 " \u258F\u258E\u258D\u258C\u258B\u258A\u2589"))
5383 (defun orgtbl-uc-draw-cont (value min max &optional width)
5384 "Draw a bar in a table using block unicode characters.
5385 It is a variant of orgtbl-ascii-draw with Unicode block
5386 characters, for a smooth display. Bars are solid (to the extent
5388 (orgtbl-ascii-draw value min max width
5389 " \u258F\u258E\u258D\u258C\u258B\u258A\u2589\u2588"))
5391 (defun org-table-get-remote-range (name-or-id form)
5392 "Get a field value or a list of values in a range from table at ID.
5394 NAME-OR-ID may be the name of a table in the current file as set
5395 by a \"#+NAME:\" directive. The first table following this line
5396 will then be used. Alternatively, it may be an ID referring to
5397 any entry, also in a different file. In this case, the first
5398 table in that entry will be referenced.
5399 FORM is a field or range descriptor like \"@2$3\" or \"B3\" or
5400 \"@I$2..@II$2\". All the references must be absolute, not relative.
5402 The return value is either a single string for a single field, or a
5403 list of the fields in the rectangle."
5405 (let ((case-fold-search t) (id-loc nil)
5406 ;; Protect a bunch of variables from being overwritten by
5407 ;; the context of the remote table.
5408 org-table-column-names org-table-column-name-regexp
5409 org-table-local-parameters org-table-named-field-locations
5410 org-table-current-line-types
5411 org-table-current-begin-pos org-table-dlines
5412 org-table-current-ncol
5413 org-table-hlines org-table-last-alignment
5414 org-table-last-column-widths org-table-last-alignment
5415 org-table-last-column-widths
5417 (setq form (org-table-convert-refs-to-rc form))
5418 (org-with-wide-buffer
5419 (goto-char (point-min))
5420 (if (re-search-forward
5421 (concat "^[ \t]*#\\+\\(tbl\\)?name:[ \t]*"
5422 (regexp-quote name-or-id) "[ \t]*$")
5424 (setq buffer (current-buffer) loc (match-beginning 0))
5425 (setq id-loc (org-id-find name-or-id 'marker))
5426 (unless (and id-loc (markerp id-loc))
5427 (user-error "Can't find remote table \"%s\"" name-or-id))
5428 (setq buffer (marker-buffer id-loc)
5429 loc (marker-position id-loc))
5430 (move-marker id-loc nil))
5431 (with-current-buffer buffer
5432 (org-with-wide-buffer
5435 (unless (and (re-search-forward "^\\(\\*+ \\)\\|^[ \t]*|" nil t)
5436 (not (match-beginning 1)))
5437 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5439 (setq form (org-table-formula-substitute-names
5440 (org-table-formula-handle-first/last-rc form)))
5441 (if (and (string-match org-table-range-regexp form)
5442 (> (length (match-string 0 form)) 1))
5443 (org-table-get-range
5444 (match-string 0 form) org-table-current-begin-pos 1)
5447 (defun org-table-remote-reference-indirection (form)
5448 "Return formula with table remote references substituted by indirection.
5449 For example \"remote($1, @>$2)\" => \"remote(year_2013, @>$1)\".
5450 This indirection works only with the format @ROW$COLUMN. The
5451 format \"B3\" is not supported because it can not be
5452 distinguished from a plain table name or ID."
5454 ;; Same as in `org-table-eval-formula'.
5455 (concat "\\<remote([ \t]*\\("
5456 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5458 "\\)[ \t]*,[ \t]*\\([^\n)]+\\))")))
5459 (replace-regexp-in-string
5463 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5464 (org-table-get-range
5465 (if (string-match-p "\\`\\$[0-9]+\\'" eq)
5470 (defmacro org-define-lookup-function (mode)
5471 (let ((mode-str (symbol-name mode))
5472 (first-p (eq mode 'first))
5473 (all-p (eq mode 'all)))
5474 (let ((plural-str (if all-p "s" "")))
5475 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5476 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5477 If R-LIST is nil, return matching element%s of S-LIST.
5478 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5479 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5480 This function is generated by a call to the macro `org-define-lookup-function'."
5481 mode-str plural-str plural-str plural-str)
5482 (let ,(let ((lvars '((p (or predicate 'equal))
5484 (rl (or r-list s-list))
5486 (if first-p (cons '(match-p nil) lvars) lvars))
5487 (while ,(if first-p '(and (not match-p) sl) 'sl)
5488 (when (funcall p val (car sl))
5489 ,(when first-p '(setq match-p t))
5490 (let ((rval (car rl)))
5491 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5492 (setq sl (cdr sl) rl (cdr rl)))
5495 (org-define-lookup-function first)
5496 (org-define-lookup-function last)
5497 (org-define-lookup-function all)
5499 (provide 'org-table)
5502 ;; generated-autoload-file: "org-loaddefs.el"
5505 ;;; org-table.el ends here