| blob | 9e57305c3b00203ffbadd6b9171bf9aa8d30192e |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2019 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: https://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
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 <https://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
50 (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion with-affiliated))
91 \f
92 ;;; Customizables
95 "Options concerning tables in Org mode."
100 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
102 In the optimized version, the table editor takes over all simple keys that
103 normally just insert a character. In tables, the characters are inserted
104 in a way to minimize disturbing the table structure (i.e. in overwrite mode
105 for empty fields). Outside tables, the correct binding of the keys is
106 restored.
108 Changing this variable requires a restart of Emacs to become
109 effective."
115 % END RECEIVE ORGTBL %n
117 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
118 | | |
121 @c END RECEIVE ORGTBL %n
122 @ignore
123 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
124 | | |
127 <!-- END RECEIVE ORGTBL %n -->
128 <!--
129 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
130 | | |
133 #+ END RECEIVE ORGTBL %n
135 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
136 | | |
138 "Templates for radio tables in different major modes.
139 Each template must define lines that will be treated as a comment and that
142 insertion of the template. The transformed table will later be inserted
143 between these lines.
145 The template should also contain a minimal table in a multiline comment.
146 If multiline comments are not possible in the buffer language,
147 you can pack it into a string that will not be used when the code
148 is compiled or executed. Above the table will you need a line with
150 convert the table into a data structure useful in the
151 language of the buffer. Check the manual for the section on
153 the Info node `(org)Tables in arbitrary syntax'.
155 All occurrences of %n in a template will be replaced with the name of the
156 table, obtained by prompting the user."
163 "Settings for tables in Org mode."
168 "The default size for newly created tables, Columns x Rows."
173 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
174 "Regular expression for recognizing numbers in table columns.
175 If a table column contains mostly numbers, it will be aligned to the
176 right. If not, it will be aligned to the left.
178 The default value of this option is a regular expression which allows
179 anything which looks remotely like a number as used in scientific
180 context. For example, all of the following will be considered a
181 number:
182 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
184 Other options offered by the customize interface are more restrictive."
198 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
199 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
200 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
204 "Fraction of numbers in a column required to make the column align right.
205 In a column all non-white fields are considered. If at least
206 this fraction of fields is matched by `org-table-number-regexp',
207 alignment to the right border applies."
212 "Format for fields which contain the result of a formula.
214 characters. Beware that modifying the display can prevent the
215 field from being used in another formula."
221 "Behavior of tables during editing in Org mode."
226 "Non-nil means automatically re-align table when pressing TAB or RETURN.
228 removal/insertion."
233 "Non-nil means automatically blank table field when starting to type into it.
234 This only happens when typing immediately after a field motion
235 command (TAB, S-TAB or RET)."
240 "Non-nil means automatically exit the follow mode.
241 When nil, the follow mode will stay on and be active in any table
242 the cursor enters. Since the table follow filed mode messes with the
243 window configuration, it is not recommended to set this variable to nil,
244 except maybe locally in a special file that has mostly tables with long
245 fields."
251 "Whether the user should confirm when Org fixes formulas."
260 "Non-nil means tab in the last column of a table with jump over a hline.
261 If a horizontal separator line is following the current line,
262 `org-table-next-field' can either create a new row before that line, or jump
263 over the line. When this option is nil, a new line will be created before
264 this line."
269 "String to be displayed in a shrunk column."
276 "Options concerning tables in Org mode."
281 "Non-nil means using table references like B3 instead of @3$2.
282 Possible values are:
283 nil never use them
284 from accept as input, do not present for editing
285 t accept as input and present for editing"
293 "Non-nil means increment when copying current field with \
306 calc-angle-mode deg
307 calc-prefer-frac nil
308 calc-symbolic-mode nil
310 calc-display-working-message t)
311 "List with Calc mode settings for use in `calc-eval' for table formulas.
312 The list must contain alternating symbols (Calc modes variables and values).
313 Don't remove any of the default settings, just change the values. Org mode
314 relies on the variables to be present in the list."
319 "Format for the output of calc computations like $1+$2;t.
320 The default value is `hours', and will output the results as a
321 number of hours. Other allowed values are `seconds', `minutes' and
322 `days', and the output will be a fraction of seconds, minutes or
323 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
324 The `U' flag in a table formula will select this specific format for
325 a single formula."
335 "Non-nil means hours in table duration computations should be zero-padded.
336 So this is about 08:32:34 versus 8:33:34."
344 "Non-nil means TAB and RET evaluate a formula in current table field.
345 If the current field starts with an equal sign, it is assumed to be a formula
346 which should be evaluated as described in the manual and in the documentation
347 string of the command `org-table-eval-formula'. This feature requires the
348 Emacs calc package.
349 When this variable is nil, formula calculation is only available through
355 "Non-nil means interpret constants in formulas in tables.
356 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
357 by the value given in `org-table-formula-constants', or by a value obtained
358 from the `constants.el' package."
363 "Alist with constant names and values, for use in table formulas.
364 The car of each element is a name of a constant, without the `$' before it.
365 The cdr is the value as a string. For example, if you'd like to use the
366 speed of light in a formula, you would configure
370 and then use it in an equation like `$1*$c'.
372 Constants can also be defined on a per-file basis using a line like
374 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
381 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
384 are pressed in the line."
389 "Non-nil means relative formula references may cross hlines.
390 Here are the allowed values:
392 nil Relative references may not cross hlines. They will reference the
393 field next to the hline instead. Coming from below, the reference
394 will be to the field below the hline. Coming from above, it will be
395 to the field above.
396 t Relative references may cross hlines.
397 error An attempt to cross a hline will throw an error.
399 It is probably good to never set this variable to nil, for the sake of
400 portability of tables."
408 "Non-nil means evaluation of formula can add new columns.
409 When non-nil, evaluating an out-of-bounds field can insert as
410 many columns as needed. When set to `warn', issue a warning when
411 doing so. When set to `prompt', ask user before creating a new
412 column. Otherwise, throw an error."
422 "Options concerning table import and export in Org mode."
427 "Default export parameters for `org-table-export'.
428 These can be overridden for a specific table by setting the
429 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
430 radio tables for the different export transformations and
431 available parameters."
436 "Max lines that `org-table-convert-region' will attempt to process.
438 The function can be slow on larger regions; this safety feature
439 prevents it from hanging Emacs."
444 \f
445 ;;; Regexps Constants
463 "Detect the first line outside a table when searching from within it.
484 "@\\([-+]?I*[-+]?[0-9]*\\)\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)\\(\\$[-+]?[0-9]+\\)?\\)?"
485 ;; 1 2 3 4 5
501 "Space used around fields when aligning the table.
502 This space serves as a segment separator for the purposes of the
505 \f
506 ;;; Internal Variables
519 "Indicates that a table might need an update.
520 This variable is set by `org-before-change-function'.
524 "Hook for functions attaching to `C-c C-c', if the table is sent.
525 This can be used to add additional functionality after the table is sent
526 to the receiver position, otherwise, if table is not sent, the functions
530 "Alist with column names, derived from the `!' line.
534 "Regular expression matching the current column names.
538 "Alist with parameter names, derived from the `$' line.
542 "Alist with locations of named fields.
543 Associations follow the pattern (NAME LINE COLUMN) where
544 NAME is the name of the field as a string,
545 LINE is the number of lines from the beginning of the table,
546 COLUMN is the column of the field, as an integer.
550 "Table row types in current table.
554 "Current table begin position, as a marker.
558 "Number of columns in current table.
562 "Vector of data line line numbers in the current table.
563 Line numbers are counted from the beginning of the table. This
567 "Vector of hline line numbers in the current table.
568 Line numbers are counted from the beginning of the table. This
572 "Marker at the beginning of the table last aligned.
576 "Marker at the end of the table last aligned.
580 "List of flags for flushright alignment, from the last re-alignment.
584 "List of max width of fields in each column.
588 "Non-nil means debug table formulas.
606 "List of commands triggering the recalculation of a line.
622 \f
623 ;;; Macros and Inlined Functions
626 "Expand all columns before executing BODY, then shrink them again."
640 "Save field shrunk state, execute BODY and restore state."
651 "Save current field; execute BODY; restore field.
652 Field is restored even in case of abnormal exit."
673 org-tbl-calc-modes)
675 \f
676 ;;; Predicates
679 "Non-nil when point (or POS) is in #+TBLFM line."
687 "Non-nil if the cursor is inside an Org table.
688 If TABLE-TYPE is non-nil, also check for table.el-type tables."
696 "Non-nil when point is at a table.el table."
703 "Non-nil when point is inside a hline in a table.
704 Assume point is already in a table."
708 "Non-nil when point is inside a table data field.
709 Raise an error otherwise, unless NOERROR is non-nil. In that
710 case, return nil if point is not inside a data field. When
711 optional argument ASSUME-TABLE is non-nil, assume point is within
712 a table."
720 \f
721 ;;; Create, Import, and Convert Tables
723 ;;;###autoload
725 "Use the table.el package to insert a new table.
726 If there is already a table at point, convert between Org tables
727 and table.el tables."
740 ;;;###autoload
742 "Convert region to table, or create an empty table.
743 If there is an active region, convert it to a table, using the function
744 `org-table-convert-region'. See the documentation of that function
745 to learn how the prefix argument is interpreted to determine the field
746 separator.
747 If there is no such region, create an empty table with `org-table-create'."
753 ;;;###autoload
755 "Query for a size and insert a table skeleton.
775 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
779 ;; Insert a hline after the first row.
785 ;;;###autoload
787 "Convert region to a table.
789 The region goes from BEG0 to END0, but these borders will be moved
790 slightly, to make sure a beginning of line in the first line is included.
792 SEPARATOR specifies the field separator in the lines. It can have the
793 following values:
795 (4) Use the comma as a field separator
796 (16) Use a TAB as field separator
797 (64) Prompt for a regular expression as field separator
798 integer When a number, use that many spaces, or a TAB, as field separator
799 regexp When a regular expression, use it to match the separator
800 nil When nil, the command tries to be smart and figure out the
801 separator in the following way:
802 - when each line contains a TAB, assume TAB-separated material
803 - when each line contains a comma, assume CSV material
804 - else, assume one or more SPACE characters as separator."
808 re)
810 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
811 org-table-convert-region-max-lines)
820 ;; Get the right field separator
831 ;; parse the csv stuff
856 ;;;###autoload
858 "Import FILE as a table.
860 The command tries to be smart and figure out the separator in the
861 following way:
863 - when each line contains a TAB, assume TAB-separated material
864 - when each line contains a comma, assume CSV material
865 - else, assume one or more SPACE characters as separator.
867 When non-nil, SEPARATOR specifies the field separator in the
868 lines. It can have the following values:
870 (4) Use the comma as a field separator
871 (16) Use a TAB as field separator
872 (64) Prompt for a regular expression as field separator
873 integer When a number, use that many spaces, or a TAB, as field separator
874 regexp When a regular expression, use it to match the separator."
883 "Convert from Org table to table.el and back.
884 Obviously, this only works within limits. When an Org table is converted
885 to table.el, all horizontal separator lines get lost, because table.el uses
886 these as cell boundaries and has no notion of horizontal lines. A table.el
887 table can be converted to an Org table only if it does not do row or column
888 spanning. Multiline cells will become multiple cells. Beware, Org mode
889 does not test if the table can be successfully converted - it blindly
890 applies a recipe that works for simple tables."
894 ;; convert to Org table
903 ;; convert to table.el table
906 ;; first, get rid of all horizontal lines
910 ;; insert a hline before first
914 ;; insert a hline after each line
919 ;; replace "+" at beginning and ending of hlines
927 \f
928 ;;; Navigation and Structure Editing
930 ;;;###autoload
932 "Find the beginning of the table and return its position.
933 With a non-nil optional argument TABLE-TYPE, return the beginning
934 of a table.el-type table. This function assumes point is on
935 a table."
943 ;;;###autoload
945 "Find the end of the table and return its position.
946 With a non-nil optional argument TABLE-TYPE, return the end of
947 a table.el-type table. This function assumes point is on
948 a table."
956 ;; When the line right after the table is the last line in
957 ;; the buffer with trailing spaces but no final newline
958 ;; character, be sure to catch the correct ending at its
959 ;; beginning. In any other case, ending is expected to be
960 ;; at point max.
965 ;;;###autoload
967 "Go to the next field in the current table, creating new lines as needed.
968 Before doing so, re-align the table if necessary."
973 org-table-may-need-update)
984 org-table-tab-jumps-over-hlines
995 ;;;###autoload
997 "Go to the previous field in the table.
998 Before doing so, re-align the table if necessary."
1003 org-table-may-need-update)
1021 "Move to the beginning of the current table field.
1022 If already at or before the beginning, move to the beginning of the
1023 previous field.
1024 With numeric argument N, move N-1 fields backward first."
1037 "Move to the end of the current table field.
1038 If already at or after the end, move to the end of the next table field.
1039 With numeric argument N, move N-1 fields forward first."
1052 ;;;###autoload
1054 "Go to the next row (same column) in the current table.
1055 Before doing so, re-align the table if necessary."
1060 org-table-may-need-update)
1073 "Get the field in table line LINE, column COLUMN.
1074 If LINE is larger than the number of data lines in the table, the function
1075 returns nil. However, if COLUMN is too large, we will simply return an
1076 empty string.
1077 If LINE is nil, use the current line.
1078 If COLUMN is nil, use the current column."
1085 "Put VALUE into line LINE, column COLUMN.
1086 When ALIGN is set, also realign the table."
1095 "Return the index of the current data line."
1102 cnt))
1105 "Return current column number."
1114 column)))))
1117 "Find out what table data line we are in.
1118 Only data lines count for this."
1126 c)))
1129 "Go to the Nth data line in the current table.
1130 Return t when the line exists, nil if it does not exist."
1137 ;;;###autoload
1139 "Blank the current table field or active region."
1156 "Return the value of the field in column N of current row.
1157 N defaults to current column. If REPLACE is a string, replace
1158 field with this value. The return value is always the old
1159 value."
1163 ;; Before first column or after last one.
1164 ""
1172 val)))
1174 ;;;###autoload
1176 "Show info about the current field, and highlight any reference at point."
1186 col)
1187 org-table-named-field-locations)))
1197 ;; Prioritize field formulas over column formulas.
1206 dline col
1208 dline col ref1
1210 ;; FIXME: formula info not correct if special table line
1217 ""
1223 "Move point to a specific field in the current table.
1225 REF is either the name of a field its absolute reference, as
1226 a string. No column is created unless CREATE-COLUMN-P is
1227 non-nil. If it is a function, it is called with the column
1228 number as its argument as is used as a predicate to know if the
1229 column can be created.
1231 This function assumes the table is already analyzed (i.e., using
1232 `org-table-analyze')."
1247 create-column-p)))
1253 ;;;###autoload
1255 "Move the cursor to the Nth column in the current table line.
1256 With optional argument ON-DELIM, stop with point before the left delimiter
1257 of the field.
1258 If there are less than N fields, just go to after the last delimiter.
1259 However, when FORCE is non-nil, create new columns if necessary."
1269 t)))))
1276 ;;;###autoload
1278 "Insert a new column into the table."
1293 ;; Add missing vertical bar at the end of the row.
1300 ;; Shift appropriately stored shrunk column numbers, then hide the
1301 ;; columns again.
1303 shrunk-columns)
1304 beg end)
1306 ;; Fix TBLFM formulas, if desirable.
1313 "Find a data line in the current table, which is needed for column commands.
1314 This function assumes point is in a table. Raise an error when
1315 there is no data row below."
1325 t)))
1328 "Turn a buffer line number into a data line number.
1330 If there is no data line in this line, return nil.
1332 If there is no matching dline (most likely the reference was
1333 a hline), the first dline below it is used. When ABOVE is
1334 non-nil, the one above is used."
1339 nil)
1354 "Swap two cells indicated by the coordinates provided.
1355 ROW1, COL1, ROW2, COL2 are integers indicating the row/column
1356 position of the two cells that will be swapped in the table."
1363 "Move the current cell in a cardinal direction.
1364 DIRECTION is a symbol among `up', `down', `left', and `right'.
1365 The contents the current cell are swapped with cell in the
1366 indicated direction. Raise an error if the move cannot be done."
1371 ;; Initialize `org-table-current-ncol' and `org-table-dlines'.
1387 ;;;###autoload
1389 "Move a single cell up in a table.
1390 Swap with anything in target cell."
1397 ;;;###autoload
1399 "Move a single cell down in a table.
1400 Swap with anything in target cell."
1407 ;;;###autoload
1409 "Move a single cell left in a table.
1410 Swap with anything in target cell."
1417 ;;;###autoload
1419 "Move a single cell right in a table.
1420 Swap with anything in target cell."
1427 ;;;###autoload
1429 "Delete a column from the table."
1443 nil
1450 ;; Shift appropriately stored shrunk column numbers, then hide the
1451 ;; columns again.
1453 shrunk-columns)
1454 beg end)
1456 ;; Fix TBLFM formulas, if desirable.
1464 ;;;###autoload
1466 "Move column to the right."
1470 ;;;###autoload
1472 "Move column to the left."
1476 ;;;###autoload
1478 "Move the current column to the right. With arg LEFT, move to the left."
1506 ;; Shift appropriately stored shrunk column numbers, then shrink
1507 ;; the columns again.
1515 shrunk-columns)
1516 beg end)
1518 ;; Fix TBLFM formulas, if desirable.
1529 ;;;###autoload
1531 "Move table row down."
1535 ;;;###autoload
1537 "Move table row up."
1541 ;;;###autoload
1543 "Move the current table line down. With arg UP, move it up."
1552 hline2p)
1579 ;;;###autoload
1581 "Insert a new row above the current line into the table.
1582 With prefix ARG, insert below the current line."
1588 ;; Fix the first field if necessary
1592 ;; Buffer may not end of a newline character, so ensure
1593 ;; (beginning-of-line 2) moves point to a new line.
1604 ;;;###autoload
1606 "Insert a horizontal-header-line below the current line into the table.
1607 With prefix ABOVE, insert above the current line."
1611 ;;;###autoload
1613 "Insert a horizontal-header-line below the current line into the table.
1614 With prefix ABOVE, insert above the current line."
1618 ;;;###autoload
1620 "Insert a horizontal-calc-line below the current line into the table.
1621 With prefix ABOVE, insert above the current line."
1626 "Insert a horizontal-line below the current line into the table.
1627 With prefix ABOVE, insert above the current line."
1648 ;;;###autoload
1650 "Insert a hline and move to the row below that line."
1664 In particular, this does handle wide and invisible characters."
1666 ;; It's a hline, just map the characters
1672 t t s)))
1673 s))
1675 ;;;###autoload
1677 "Delete the current row or horizontal line from the table."
1693 ;;;###autoload
1695 "Copy region in table to the clipboard and blank all relevant fields.
1696 If there is no active region, use just the field at point."
1702 ;;;###autoload
1704 "Copy the value of the current field one row below.
1706 If the field at the cursor is empty, copy the content of the
1707 nearest non-empty field above. With argument N, use the Nth
1708 non-empty field.
1710 If the current field is not empty, it is copied down to the next
1711 row, and the cursor is moved with it. Therefore, repeating this
1712 command causes the column to be filled row-by-row.
1714 If the variable `org-table-copy-increment' is non-nil and the
1715 field is an integer or a timestamp, it will be incremented while
1716 copying. By default, increment by the difference between the
1717 value in the current field and the one in the field above. To
1718 increment using a fixed integer, set `org-table-copy-increment'
1719 to a number. In the case of a timestamp, increment by days."
1731 txt txt-up inc)
1739 beg t))
1749 beg t))
1756 ;; Above field was not empty, go down to the next row. Skip
1757 ;; alignment since we do it at the end of the process anyway.
1789 ;;;###autoload
1791 "Copy rectangular region in table to clipboard.
1792 A special clipboard is used which can only be accessed with
1793 `org-table-paste-rectangle'. Return the region copied, as a list
1794 of lists of fields."
1798 current-prefix-arg))
1803 region)
1815 ;; Collect every cell between COLUMN-START and COLUMN-END.
1827 ;;;###autoload
1829 "Paste a rectangular region into a table.
1830 The upper right corner ends up in the current field. All involved fields
1831 will be overwritten. If the rectangle does not fit into the present table,
1832 the table is enlarged as needed. The process ignores horizontal separator
1833 lines."
1843 ;; If we left the table, create a new row.
1855 \f
1856 ;;; Follow Field minor mode
1859 "Minor mode to make the table field editor window follow the cursor.
1860 When this mode is active, the field editor window will always show the
1861 current field. The mode exits automatically when the cursor leaves the
1862 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1863 nil " TblFollow" nil
1876 ;;;###autoload
1878 "Edit table field in a different window.
1879 This is mainly useful for fields that contain hidden parts.
1882 visible so that it can be edited in place.
1885 toggle `org-table-follow-field-mode'."
1907 p)
1931 ;; We have left the table, exit the follow mode
1940 "Finish editing a table data field.
1941 Remove all newline characters, insert the result into the table, realign
1942 the table and kill the editing buffer."
1946 text)
1962 \f
1963 ;;; Formulas
1966 "Return the formula active for the current field.
1968 Assumes that table is already analyzed. If KEY is given, return
1969 the key to this formula. Otherwise return the formula preceded
1978 org-table-named-field-locations)))
1992 "Read a formula from the minibuffer, offer stored formula as default.
1993 When NAMED is non-nil, look for a named equation."
1998 org-table-named-field-locations)))
2011 stored)
2020 mustsave)
2022 ;; Remove formula.
2029 ;; We set the column equation, delete the named one.
2031 mustsave t))
2037 eq))
2040 "Store the list of formulas below the current table.
2041 If optional argument LOCATION is a buffer position, insert it at
2042 LOCATION instead."
2050 ;; Don't overwrite TBLFM, we might use text properties to
2051 ;; store stuff.
2065 ;; Fake a high number to make sure this is sorted at the end.
2072 a)
2082 "Compare two formulas for sorting."
2087 ;;;###autoload
2089 "Return an alist with the stored formulas directly after current table.
2090 By default, only return active formulas, i.e., formulas located
2091 on the first line after the table. However, if optional argument
2092 LOCATION is a buffer position, consider the formulas there."
2101 eq-alist seen)
2105 string)
2110 ;; Is it a column reference?
2112 ;; Since named columns are not possible in
2113 ;; LHS, assume this is a named field.
2121 "Double definition `%s=' in TBLFM line, please fix by hand"
2122 lhs)
2127 "Double definition `%s=' in TBLFM line, please fix by hand"
2128 lhs)))))))))))
2131 "Modify the equations after the table structure has been edited.
2133 For all numbers larger than LIMIT, shift them by DELTA."
2145 s n a)
2151 "Change makes TBLFM term %s invalid, use undo to recover"
2166 ;;;###autoload
2169 If yes, store the formula and apply it."
2170 ;; We already know we are in a table. Get field will only return a formula
2171 ;; when appropriate. It might return a separator line, but no problem.
2174 named eq)
2181 ;;;###autoload
2183 "Rotate the recalculation mark in the first column.
2184 If in any row, the first field is not consistent with a mark,
2185 insert a new column for the markers.
2186 When there is an active region, change all the lines in the region,
2187 after prompting for the marking character.
2188 After each change, a message will be displayed indicating the meaning
2189 of the new mark."
2205 newchar))
2213 newchar))
2231 ;; Rotate mark in first row.
2233 ;; Rotate marks in additional rows if a region is active.
2241 ;; Only align if rotation actually changed lines' length.
2251 ;;;###autoload
2253 "Recompute the current line if marked for it, and if we haven't just done it."
2262 ;;;###autoload
2264 suppress-align suppress-const
2265 suppress-store suppress-analysis)
2266 "Replace the table field value at the cursor by the result of a calculation.
2268 In a table, this command replaces the value in the current field with the
2270 formula, by storing it in a special line below the table. When called
2272 field formula.
2275 insert the active equation for the field
2276 back into the current field, so that it can be edited there. This is \
2277 useful
2279 check the referenced fields.
2281 When called, the command first prompts for a formula, which is read in
2282 the minibuffer. Previously entered formulas are available through the
2283 history list, and the last used formula is offered as a default.
2284 These stored formulas are adapted correctly when moving, inserting, or
2285 deleting columns with the corresponding commands.
2287 The formula can be any algebraic expression understood by the Calc package.
2288 For details, see the Org mode manual.
2290 This function can also be called from Lisp programs and offers
2291 additional arguments: EQUATION can be the formula to apply. If this
2292 argument is given, the user will not be prompted.
2294 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2295 unnecessary aligns.
2297 SUPPRESS-CONST suppresses the interpretation of constants in the
2298 formula, assuming that this has been done already outside the
2299 function.
2301 SUPPRESS-STORE means the formula should not be stored, either
2302 because it is already stored, or because it is a modified
2303 equation that should not overwrite the stored one.
2305 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2306 location of point."
2322 equation
2328 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2329 duration duration-output-format)
2330 ;; Parse the format string. Since we have a lot of modes, this is
2331 ;; a lot of work. However, I think calc still uses most of the time.
2345 'calc-float-format
2348 n))))
2353 duration-output-format
2383 ;; replace fields with duration values if relevant
2387 fields)))
2393 x))
2394 fields)))
2400 ;; Insert row and column number of formula result field
2411 t t form)))
2413 ;; Check for old vertical references
2415 ;; Insert remote references
2428 rmtrng))
2429 keep-empty numbers lispp))
2430 t t form)))
2431 ;; Insert complex ranges
2441 ;; possibly handle durations
2446 formrg)
2447 keep-empty numbers lispp)))
2452 ;; Insert simple ranges, i.e. included in the current row.
2455 form)
2466 keep-empty numbers lispp))
2467 t t form)))
2469 ;; Insert the references to fields in same row
2476 x keep-empty numbers lispp)))
2493 ;; Use <...> time-stamps so that Calc can handle them.
2496 ;; Internationalize local time-stamps by setting locale to
2497 ;; "C".
2500 org-ts-regexp
2508 form t t))
2511 form
2518 duration-output-format)
2519 ev)))
2524 Orig: %s
2525 $xyz-> %s
2526 @r$c-> %s
2549 ;; Replace any active time stamp in the result with
2550 ;; an inactive one. Dates in tables are likely
2551 ;; piece of regular data, not meant to appear in the
2552 ;; agenda.
2565 prop value)))
2568 "Get a calc vector from a column, according to descriptor DESC.
2570 Optional arguments TBEG and COL can give the beginning of the table and
2571 the current column, to avoid unnecessary parsing.
2573 HIGHLIGHT means just highlight the range.
2575 When CORNERS-ONLY is set, only return the corners of the range as
2576 a list (line1 column1 line2 column2) where line1 and line2 are
2577 line numbers relative to beginning of table, or TBEG, and column1
2578 and column2 are table column numbers."
2581 desc))
2592 thisline)))
2597 thisline)))
2609 ;; Just one field.
2616 ;; A range, return a vector. First sort the numbers to get
2617 ;; a regular rectangle.
2623 ;; Copy the range values into a list.
2638 ;; Return string representation of calc vector.
2644 "Return relative line number corresponding to descriptor DESC.
2645 The cursor is currently in relative line number CLINE."
2650 ;; 1 2 3 4 5 6
2651 desc))
2673 cline)))
2676 "Return relative line of Nth row with type TYPE.
2677 Search starts from relative line I. When BACKWARDS in non-nil,
2678 look before I. When RELATIVE is non-nil, the reference is
2679 relative. DESC is the original descriptor that started the
2680 search, as a string."
2688 ;; We are going to cross a hline. Check if this is
2689 ;; an authorized move.
2700 ;; The last hline doesn't exist. Instead, point to last row
2701 ;; in table.
2710 "Convert list ELEMENTS to something appropriate to insert into formula.
2711 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2712 NUMBERS indicates that everything should be converted to numbers.
2713 LISPP non-nil means to return something appropriate for a Lisp
2714 list, `literal' is for the format specifier L."
2715 ;; Calc nan (not a number) is used for the conversion of the empty
2716 ;; field to a reference for several reasons: (i) It is accepted in a
2717 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2718 ;; (ii) In a single field (not in range) it can be distinguished
2719 ;; from "(nan)" which is the reference made from a single field
2720 ;; containing "nan".
2722 ;; field reference
2725 elements
2727 ""
2736 ;; range reference
2741 elements))))
2747 x
2755 x)
2757 elements
2761 "If there has been more than one second since T1, display message.
2762 ARGS are passed as arguments to the `message' function. Returns
2763 current time if a message is printed, otherwise returns T1. If
2764 T1 is nil, always messages."
2768 curtime)
2769 t1)))
2771 ;;;###autoload
2773 "Recalculate the current table line by applying all stored formulas.
2775 With prefix arg ALL, do this for all lines in the table.
2778 if ALL is the symbol `iterate',
2779 recompute the table until it no longer changes.
2781 If NOALIGN is not nil, do not re-align the table after the computations
2782 are done. This is typically used internally to save time, if it is
2783 known that the table will be realigned a little later anyway."
2798 beg end eqlcol eqlfield)
2799 ;; Insert constants in all formulas.
2803 ;; Expand equations, then split the equation list between
2804 ;; column formulas and field formulas.
2816 old-lhs)))
2819 existing formula for column %s"
2820 old-lhs
2821 new))
2822 new))
2828 ;; Expand ranges in lhs of formulas
2830 ;; Get the correct line range to process.
2837 ;; This is a table with marked lines, compute selected
2838 ;; lines.
2840 ;; Move forward to the first non-header line.
2845 ;; Just leave BEG at the start of the table.
2850 ;; Mark named fields untouchable. Also check if several
2851 ;; field/range formulas try to set the same field.
2855 seen-fields)
2866 ;; Turn field coordinates associated to NAME
2867 ;; into an absolute reference.
2871 name)))
2874 reference))
2879 ;; Evaluate the column formulas, but skip fields covered by
2880 ;; field formulas.
2884 ;; Unprotected line, recalculate.
2889 log-last-time
2902 ;; Evaluate the field formulas.
2911 reference
2912 ;; Possibly create a new column, as long as
2913 ;; `org-table-formula-create-columns' allows it.
2925 t))
2932 ;; Clean up markers and internal text property.
2943 ;;;###autoload
2945 "Recalculate the table until it does not change anymore.
2946 The maximum number of iterations is 10, but you can choose a different value
2947 with the prefix ARG."
2952 thistbl)
2966 ;;;###autoload
2968 "Recalculate all tables in the current buffer."
2973 ;; Reason for separate `org-table-align': When repeating
2974 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
2975 ;; the way.
2978 t)))
2980 ;;;###autoload
2982 "Iterate all tables in the buffer, to converge inter-table dependencies."
2987 c1)
3003 "Apply the #+TBLFM in the line at point to the table."
3010 ;; Insert a temporary formula at right after the table
3015 ;; Recalculate the table.
3020 ;; Delete the formula inserted temporarily.
3026 "Find the beginning of the TBLFM lines and return its position.
3027 Return nil when the beginning of TBLFM line was not found."
3034 "Expand list of formulas.
3035 If some of the RHS in the formulas are ranges or a row reference,
3036 expand them to individual field equations for each field. This
3037 function assumes the table is already analyzed (i.e., using
3038 `org-table-analyze')."
3045 ;; This just refers to one fixed field.
3048 ;; This just refers to one fixed named field.
3051 ;; Column formulas are treated specially and are not
3052 ;; expanded.
3057 rhs)
3058 res)))
3070 rhs)
3071 res))))))))))
3074 "Replace @<, @>, $<, $> with first/last row/column of the table.
3075 So @< and $< will always be replaced with @1 and $1, respectively.
3076 The advantage of these special markers are that structure editing of
3077 the table will not change them, while @1 and $1 will be modified
3078 when a line/row is swapped out of that privileged position. So for
3079 formulas that use a range of rows or columns, it may often be better
3081 borders of the table using the @< @> $< $> makers."
3084 s start)
3089 org-table-current-ncol)
3093 len
3100 s)
3103 "Replace $const with values in string F."
3108 org-table-column-name-regexp
3111 org-table-column-names))))
3112 f t t)))
3113 ;; Parameters and constants.
3117 new start))
3120 ;; When a duration is expected, convert value on the fly.
3126 v)))))
3133 "Find the value for a parameter or constant in a formula.
3134 Parameters get priority."
3165 map))
3172 "--"
3175 "--"
3176 "Shift Reference at Point"
3181 "-"
3182 "Change Test Row for Column Formulas"
3185 "--"
3190 org-table-overlay-coordinates)]
3191 "--"
3198 ;;;###autoload
3200 "Edit the formulas of the current table in a separate buffer."
3206 ;; Move point within the table before analyzing it.
3222 ;; Keep global-font-lock-mode from turning on font-lock-mode
3268 "Convert a formula from internal to user representation."
3271 s))
3274 "Convert a formula from user to internal representation."
3277 s))
3280 "Convert spreadsheet references from A7 to @7$28.
3281 Works for single references, but also for entire formulas and even the
3282 full TBLFM line."
3284 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3287 ;; format match, just advance
3292 ;; 3.e5 or something like this.
3295 ;; (member (match-string 1 s)
3296 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3297 )
3298 ;; function name, just advance
3308 t t s)))))
3309 s))
3312 "Convert spreadsheet references from to @7$28 to AB7.
3313 Works for single references, but also for entire formulas and even the
3314 full TBLFM line."
3321 t t s)))
3326 t nil s)))
3327 s)
3330 "Convert a base 26 number represented by letters into an integer.
3331 For example: AB -> 28."
3337 n))
3340 "Convert an integer into a base 26 number represented by letters.
3341 For example: 28 -> AB."
3346 s))
3349 "Convert a time string into numerical duration in seconds.
3350 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3351 If S is a string representing a number, keep this number."
3353 s
3376 "Convert a number of seconds to a time string.
3377 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3378 minutes or seconds."
3390 ;; Ignore seconds
3394 secs0)
3399 secs0)))))
3403 "Convert all references in this buffer, using FUNCTION."
3414 "Convert all references in the buffer from B3 to @3$2 and back."
3424 "Shift the reference at point one row/hline up."
3429 "Shift the reference at point one row/hline down."
3434 "Shift the reference at point one field to the left."
3439 "Shift the reference at point one field to the right."
3444 "Re-match the group N, and replace it with the shifted reference."
3449 t t)))
3458 ;; A B3-like reference
3464 ;; An internal reference
3470 "Shift a reference part REF.
3471 If DECR is set, decrease the references row/column, else increase.
3472 If HLINE is set, this may be a hline reference, it certainly is not
3473 a translation reference."
3502 "Toggle the display of coordinates in the referenced table."
3511 "Parse the buffer for formula definitions and install them.
3512 With prefix ARG, apply the new formulas to the table."
3521 eql)
3524 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3525 nil t)
3546 "Abort editing formulas, without installing the changes."
3557 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3596 "Move cursor one line up in the window showing the table."
3601 "Move cursor one line down in the window showing the table."
3606 "Move the cursor in the window showing the table.
3607 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3630 "Add a new overlay."
3636 "Highlight rectangular region in a table.
3637 When buffer positions BEG and END are provided, use them to
3638 delimit the region to highlight. Otherwise, refer to point. Use
3639 FACE, when non-nil, for the highlight."
3671 "Remove the rectangle overlays."
3681 "Add overlays to the table at point, to show row/column coordinates."
3709 ;;;###autoload
3711 "Toggle the display of Row/Column numbers in tables."
3722 ;;;###autoload
3724 "Toggle the formula debugger in tables."
3730 \f
3731 ;;; Columns Shrinking
3734 "Non-nil if current field is narrowed.
3735 When non-nil, return the overlay narrowing the field."
3738 o))
3746 "List currently shrunk columns in table at point."
3748 ;; We really check shrunk columns in current row only. It could
3749 ;; be wrong if all rows do not contain the same number of columns
3750 ;; (i.e. the table is not properly aligned). As a consequence,
3751 ;; some columns may not be shrunk again upon aligning the table.
3752 ;;
3753 ;; For example, in the following table, cursor is on first row and
3754 ;; "<>" indicates a shrunk column.
3755 ;;
3756 ;; | |
3757 ;; | | <> |
3758 ;;
3759 ;; Aligning table from the first row will not shrink again the
3760 ;; second row, which was not visible initially.
3761 ;;
3762 ;; However, fixing it requires to check every row, which may be
3763 ;; slow on large tables. Moreover, the hindrance of this
3764 ;; pathological case is very limited.
3777 "Create an overlay to shrink text between START and END.
3779 Use string DISPLAY instead of the real text between the two
3780 buffer positions. FIELD is the real contents of the field, as
3781 a string, or nil. It is meant to be displayed upon moving the
3782 mouse onto the overlay.
3784 When optional argument PRE is non-nil, assume the overlay is
3785 located at the beginning of the field, and prepend
3786 `org-table-separator-space' to it. Otherwise, concatenate
3787 `org-table-shrunk-column-indicator' at its end.
3789 Return the overlay."
3792 ;; Removing one overlay removes all other overlays in the
3793 ;; same column.
3802 ;; Make sure overlays stays on top of table coordinates overlays.
3803 ;; See `org-table-overlay-coordinates'.
3808 o))
3811 "Shrink a table field to a specified width.
3813 WIDTH is an integer representing the number of characters to
3814 display, in addition to `org-table-shrunk-column-indicator'.
3817 and ending positions of the field. CONTENTS is its trimmed
3818 contents, as a string, or `hline' for table rules.
3820 Real field is hidden under one or two overlays. They have the
3821 following properties:
3823 `org-overlay-type'
3825 Set to `table-column-hide'. Used to identify overlays
3826 responsible for shrinking columns in a table.
3828 `org-table-column-overlays'
3830 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3831 where COLUMN-OVERLAYS is the list of all overlays hiding the
3832 same column.
3834 Whenever the text behind or next to the overlay is modified, all
3835 the overlays in the column are deleted, effectively displaying
3836 the column again.
3838 Return a list of overlays hiding the field, or nil if field is
3839 already hidden."
3852 ;; We really want WIDTH + 2 whitespace, to include blanks
3853 ;; around fields.
3860 ;; If the field is not empty, display exactly WIDTH characters.
3861 ;; It can mean to partly hide the field, or extend it with virtual
3862 ;; blanks. To that effect, we use one or two overlays. The
3863 ;; first, optional, one may add or hide white spaces before the
3864 ;; contents of the field. The other, mandatory, one cuts the
3865 ;; field or displays white spaces at the end of the field. It
3866 ;; also always displays `org-table-shrunk-column-indicator'.
3872 ;; Contents are too large to fit in WIDTH character. Limit, if
3873 ;; possible, blanks at the beginning of the field to a single
3874 ;; white space, and cut the field at an appropriate location.
3882 ;; Find cut location so that WIDTH characters are
3883 ;; visible using dichotomy.
3887 ;; Compensate the absence of leading space,
3888 ;; thus preserving alignment.
3899 upper))
3902 ;; Contents fit it WIDTH characters. First compute number of
3903 ;; white spaces needed on each side of contents, then expand or
3904 ;; compact blanks on each side of the field in order to
3905 ;; preserve width and obey to alignment constraints.
3910 ;; Compensate the absence of leading space, thus
3911 ;; preserving alignment.
3927 contents t))))
3939 contents)))))
3943 "Read column selection select as a list of numbers.
3945 SELECT is a string containing column ranges, separated by white
3946 space characters, see `org-table-hide-column' for details. MAX
3947 is the maximum column number.
3949 Return value is a sorted list of numbers. Ignore any number
3950 outside of the [1;MAX] range."
3967 max))))
3970 #'<)))
3973 "Shrink COLUMNS in a table.
3974 COLUMNS is a sorted list of column numbers. BEG and END are,
3975 respectively, the beginning position and the end position of the
3976 table."
3988 ;; Move to COLUMN.
3993 ;; Extract boundaries and contents from current field.
3994 ;; Also set the column's width if we encounter a width
3995 ;; cookie for the first time.
4006 contents))
4011 ;; Link overlays for current field to the other overlays in the
4012 ;; same column.
4020 ;;;###autoload
4022 "Shrink or expand current column in an Org table.
4024 If a width cookie specifies a width W for the column, the first
4025 W visible characters are displayed. Otherwise, the column is
4026 shrunk to a single character.
4028 When point is before the first column or after the last one, ask
4029 for the columns to shrink or expand, as a list of ranges.
4030 A column range can be one of the following patterns:
4032 N column N only
4033 N-M every column between N and M (both inclusive)
4034 N- every column between N (inclusive) and the last column
4035 -M every column between the first one and M (inclusive)
4036 - every column
4038 When optional argument ARG is a string, use it as white space
4039 separated list of column ranges.
4042 `org-table-shrink', i.e.,
4043 shrink columns with a width cookie and expand the others.
4046 prefix, expand all columns."
4051 ;; Compute an upper bound for the number of columns.
4052 ;; Nonexistent columns are ignored anyway.
4057 (`nil
4061 ;; Point is either before first column or past last
4062 ;; one. Ask for columns to operate on.
4065 max-columns)
4078 ;;;###autoload
4080 "Shrink all columns with a width cookie in the table at point.
4082 Columns without a width cookie are expanded.
4084 Optional arguments BEGIN and END, when non-nil, specify the
4085 beginning and end position of the current table."
4098 ;; Make sure invisible characters in the table are at the right
4099 ;; place since column widths take them into account.
4103 ;;;###autoload
4105 "Expand all columns in the table at point.
4106 Optional arguments BEGIN and END, when non-nil, specify the
4107 beginning and end position of the current table."
4115 \f
4116 ;;; Generic Tools
4118 ;;;###autoload
4120 "Apply function F to the start of all tables in the buffer."
4135 ;;;###autoload
4137 "Export table to a file, with configurable format.
4138 Such a file can be imported into usual spreadsheet programs.
4140 FILE can be the output file name. If not given, it will be taken
4141 from a TABLE_EXPORT_FILE property in the current entry or higher
4142 up in the hierarchy, or the user will be prompted for a file
4143 name. FORMAT can be an export format, of the same kind as it
4144 used when `-mode' sends a table in a different format.
4146 The command suggests a format depending on TABLE_EXPORT_FORMAT,
4147 whether it is set locally or up in the hierarchy, then on the
4148 extension of the given file name, and finally on the variable
4149 `org-table-export-default-format'."
4182 formats)))
4183 org-table-export-default-format)
4208 ;;;###autoload
4210 "Format FIELD according to column WIDTH and alignement ALIGN.
4220 prefix
4221 field
4222 suffix
4223 org-table-separator-space)))
4226 "Align the table at point by aligning all vertical bars."
4231 ;; Make sure invisible characters in the table are at the right
4232 ;; place since column widths take them into account.
4239 ;; Table's rows as lists of fields. Rules are replaced
4240 ;; by nil. Trailing spaces are removed.
4249 ;; Compute number of columns. If the table contains no
4250 ;; field, create a default table and bail out.
4254 0
4261 ;; Compute alignment and width for each column.
4285 alignments)))
4288 ;; Store alignment of this table, for later editing of single
4289 ;; fields.
4292 ;; Build new table rows. Only replace rows that actually
4293 ;; changed.
4298 indent
4302 widths
4306 widths
4310 widths
4320 cells
4321 widths
4322 alignments)
4332 ;;;###autoload
4334 "Justify the current field, text to left, number to right.
4335 Optional argument NEW may specify text to replace the current field content."
4344 ;; This is not the same table, force a full re-align.
4347 ;; Realign the current field, based on previous full realign.
4380 ;;;###autoload
4383 "Sort table lines according to the column at point.
4385 The position of point indicates the column to be used for
4386 sorting, and the range of lines is the range between the nearest
4387 horizontal separator lines, or the entire table of no such lines
4388 exist. If point is before the first column, you will be prompted
4389 for the sorting column. If there is an active region, the mark
4390 specifies the first line and the sorting column, while point
4391 should be in the last line to be included into the sorting.
4393 The command then prompts for the sorting type which can be
4394 alphabetically, numerically, or by time (as given in a time stamp
4395 in the field, or as a HH:MM value). Sorting in reverse order is
4396 also possible.
4398 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive
4399 if the locale allows for it.
4401 If SORTING-TYPE is specified when this function is called from a Lisp
4402 program, no prompting will take place. SORTING-TYPE must be a character,
4403 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
4404 sorting should be done in reverse order.
4406 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
4407 a function to be called to extract the key. It must return a value
4408 that is compatible with COMPARE-FUNC, the function used to compare
4409 entries.
4411 A non-nil value for INTERACTIVE? is used to signal that this
4412 function is being called interactively."
4415 ;; Point must be either within a field or before a data line.
4420 ;; Set appropriate case sensitivity and column used for sorting.
4433 ;; Narrow buffer to appropriate sorting area.
4444 start))
4447 end)))
4448 ;; Determine arguments for `sort-subr'. Also record original
4449 ;; position. `org-table-save-field' cannot help here since
4450 ;; sorting is too much destructive.
4455 ;; Function to be called on the contents of the field
4456 ;; used for sorting in the current row.
4484 "Function for comparing keys (empty for default \
4485 `sort-subr' predicate): "
4495 #'end-of-line
4499 nil
4500 predicate)
4501 ;; Hide all columns but the one being sorted.
4503 ;; Move back to initial field.
4508 "Transpose Org table at point and eliminate hlines.
4509 So a table like
4511 | 1 | 2 | 4 | 5 |
4512 |---+---+---+---|
4513 | a | b | c | d |
4514 | e | f | g | h |
4516 will be transposed as
4518 | 1 | a | e |
4519 | 2 | b | f |
4520 | 4 | c | g |
4521 | 5 | d | h |
4523 Note that horizontal lines disappear."
4535 table)))
4549 ;;;###autoload
4551 "Wrap several fields in a column like a paragraph.
4552 This is useful if you'd like to spread the contents of a field over several
4553 lines, in order to keep the table compact.
4555 If there is an active region, and both point and mark are in the same column,
4556 the text in the column is wrapped to minimum width for the given number of
4557 lines. Generally, this makes the table more compact. A prefix ARG may be
4558 used to change the number of desired lines. For example, \
4560 formats the selected text to two lines. If the region was longer than two
4561 lines, the remaining lines remain empty. A negative prefix argument reduces
4562 the current number of lines by that amount. The wrapped text is pasted back
4563 into the table. If you formatted it to more lines than it was before, fields
4564 further down in the table get overwritten - so you might need to make space in
4565 the table first.
4567 If there is no region, the current field is split at the cursor position and
4568 the text fragment to the right of the cursor is prepended to the field one
4569 line down.
4571 If there is no region, but you specify a prefix ARG, the current field gets
4572 blank, and the content is appended to the field above."
4576 ;; There is a region: fill as a paragraph.
4587 nil
4588 nlines))))
4591 ;; No region, split the current field at point.
4634 ;;;###autoload
4636 "Sum numbers in region of current table column.
4637 The result will be displayed in the echo area, and will be available
4640 If there is an active region, it is interpreted as a rectangle and all
4641 numbers in that rectangle will be summed. If there is no active
4642 region and point is located in a table column, sum all numbers in that
4643 column.
4645 If at least one number looks like a time HH:MM or HH:MM:SS, all other
4646 numbers are assumed to be times as well (in decimal hours) and the
4647 numbers are added as such.
4649 If NLAST is a number, only the NLAST fields will actually be summed."
4676 items1)))
4683 s diff)
4691 sres))))
4692 sres))))
4694 ;;;###autoload
4696 "Analyze table at point and store results.
4698 This function sets up the following dynamically scoped variables:
4700 `org-table-column-name-regexp',
4701 `org-table-column-names',
4702 `org-table-current-begin-pos',
4703 `org-table-current-line-types',
4704 `org-table-current-ncol',
4705 `org-table-dlines',
4706 `org-table-hlines',
4707 `org-table-local-parameters',
4708 `org-table-named-field-locations'."
4713 ;; Extract column names.
4726 ;; Extract local parameters.
4734 org-table-local-parameters)))))
4735 ;; Update named fields locations. We minimize `count-lines'
4736 ;; processing by storing last known number of lines in LAST.
4758 field))
4761 org-table-named-field-locations))))))))))
4762 ;; Re-use existing markers when possible.
4766 ;; Analyze the line types.
4777 ;; Get the number of columns from the first data line in table.
4785 al al2)
4799 "Move point to the closest data line in a table.
4800 Raise an error if the table contains no data line. Preserve
4801 column when moving point."
4809 p1
4810 p2)))
4816 "Show the location/value of the $ expression at point.
4817 When LOCAL is non-nil, show references for the table at point."
4827 var name e what match dest)
4831 "$1.."
4883 dest)
4909 ;; Column number.
4935 org-table-fedit-scroll-down))))
4946 \f
4947 ;;; The Orgtbl minor mode
4949 ;; Define a minor mode which can be used in other modes in order to
4950 ;; integrate the Org table editor.
4952 ;; This is really a hack, because the Org table editor uses several
4953 ;; keys which normally belong to the major mode, for example the TAB
4954 ;; and RET keys. Here is how it works: The minor mode defines all the
4955 ;; keys necessary to operate the table editor, but wraps the commands
4956 ;; into a function which tests if the cursor is currently inside
4957 ;; a table. If that is the case, the table editor command is
4958 ;; executed. However, when any of those keys is used outside a table,
4959 ;; the function uses `key-binding' to look up if the key has an
4960 ;; associated command in another currently active keymap (minor modes,
4961 ;; major mode, global), and executes that command. There might be
4962 ;; problems if any of the keys used by the table editor is otherwise
4963 ;; used as a prefix key.
4965 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4966 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4967 ;; addresses this by checking explicitly for both bindings.
4969 ;; The optimized version (see variable `orgtbl-optimized') takes over
4970 ;; all keys which are bound to `self-insert-command' in the *global map*.
4971 ;; Some modes bind other commands to simple characters, for example
4972 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4973 ;; active, this binding is ignored inside tables and replaced with a
4974 ;; modified self-insert.
4991 ;;;###autoload
4993 "Unconditionally turn on `orgtbl-mode'."
4997 ;; Install it as a minor mode.
5005 "--"
5010 "--"
5015 "--"
5027 "--"
5036 "--"
5041 "--"
5048 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
5060 "--"
5065 ;;;###autoload
5067 "The Org mode table editor as a minor mode for use in other modes."
5072 ;; Exit without error, in case some hook functions calls this by
5073 ;; accident in Org mode.
5077 ;; Make sure we are first in minor-mode-map-alist
5079 ;; FIXME: maybe it should use emulation-mode-map-alists?
5086 auto-fill-inhibit-regexp)
5090 auto-fill-inhibit-regexp)
5091 orgtbl-line-start-regexp))
5106 "Create a function for binding in the table minor mode.
5107 FUN is the command to call inside a table. N is used to create a unique
5108 command name. KEYS are keys that should be checked in for a command
5109 to execute outside of tables."
5115 "Outside of tables, run the binding of `"
5127 keys)
5131 "Error when there is no default binding for a table key."
5136 "Setup orgtbl keymaps."
5169 elt key fun cmd)
5177 ;; Special treatment needed for TAB, RET and DEL
5190 (orgtbl-make-binding 'org-delete-backward-char 109
5196 [(tab)] "\C-i"))
5198 (org-defkey orgtbl-mode-map [backtab]
5200 [backtab] [S-iso-lefttab] [(shift tab)]
5201 [(tab)] "\C-i"))
5203 (org-defkey orgtbl-mode-map "\M-\C-m"
5204 (orgtbl-make-binding 'org-table-wrap-region 105
5205 "\M-\C-m" [(meta return)]))
5206 (org-defkey orgtbl-mode-map [(meta return)]
5207 (orgtbl-make-binding 'org-table-wrap-region 106
5208 [(meta return)] "\M-\C-m"))
5210 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
5211 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
5213 (when orgtbl-optimized
5214 ;; If the user wants maximum table support, we need to hijack
5215 ;; some standard editing functions
5216 (org-remap orgtbl-mode-map
5217 'self-insert-command 'orgtbl-self-insert-command
5218 'delete-char 'org-delete-char
5219 'delete-backward-char 'org-delete-backward-char)
5220 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
5221 t))
5223 (defun orgtbl-ctrl-c-ctrl-c (arg)
5224 "If the cursor is inside a table, realign the table.
5225 If it is a table to be sent away to a receiver, do it.
5226 With prefix arg, also recompute table."
5227 (interactive "P")
5228 (let ((case-fold-search t) (pos (point)) action)
5229 (save-excursion
5230 (beginning-of-line 1)
5231 (setq action (cond
5235 (cond
5236 ((integerp action)
5237 (goto-char action)
5238 (org-table-maybe-eval-formula)
5239 (if arg
5240 (call-interactively 'org-table-recalculate)
5241 (org-table-maybe-recalculate-line))
5242 (call-interactively 'org-table-align)
5243 (when (orgtbl-send-table 'maybe)
5244 (run-hooks 'orgtbl-after-send-table-hook)))
5245 ((eq action 'recalc)
5246 (save-excursion
5247 (beginning-of-line 1)
5249 (if (org-at-table-p)
5250 (org-call-with-arg 'org-table-recalculate t))))
5251 (t (let (orgtbl-mode)
5252 (call-interactively (key-binding "\C-c\C-c")))))))
5254 (defun orgtbl-create-or-convert-from-region (_arg)
5255 "Create table or convert region to table, if no conflicting binding.
5256 This installs the table binding `C-c |', but only if there is no
5257 conflicting binding to this key outside orgtbl-mode."
5258 (interactive "P")
5259 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
5260 (if cmd
5261 (call-interactively cmd)
5262 (call-interactively 'org-table-create-or-convert-from-region))))
5264 (defun orgtbl-tab (arg)
5265 "Justification and field motion for `orgtbl-mode'."
5266 (interactive "P")
5267 (if arg (org-table-edit-field t)
5268 (org-table-justify-field-maybe)
5269 (org-table-next-field)))
5271 (defun orgtbl-ret ()
5272 "Justification and field motion for `orgtbl-mode'."
5273 (interactive)
5274 (if (bobp)
5275 (newline)
5276 (org-table-justify-field-maybe)
5277 (org-table-next-row)))
5279 (defun orgtbl-self-insert-command (N)
5280 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
5281 If the cursor is in a table looking at whitespace, the whitespace is
5282 overwritten, and the table is not marked as requiring realignment."
5283 (interactive "p")
5284 (if (and (org-at-table-p)
5285 (or
5286 (and org-table-auto-blank-field
5287 (member last-command
5288 '(orgtbl-hijacker-command-100
5289 orgtbl-hijacker-command-101
5290 orgtbl-hijacker-command-102
5291 orgtbl-hijacker-command-103
5292 orgtbl-hijacker-command-104
5293 orgtbl-hijacker-command-105
5294 yas/expand))
5295 (org-table-blank-field))
5296 t)
5297 (eq N 1)
5299 (let (org-table-may-need-update)
5300 (delete-region (match-beginning 1) (match-end 1))
5301 (self-insert-command N))
5302 (setq org-table-may-need-update t)
5303 (let* (orgtbl-mode
5304 a
5305 (cmd (or (key-binding
5306 (or (and (listp function-key-map)
5307 (setq a (assoc last-input-event function-key-map))
5308 (cdr a))
5309 (vector last-input-event)))
5310 'self-insert-command)))
5311 (call-interactively cmd)
5312 (if (and org-self-insert-cluster-for-undo
5313 (eq cmd 'self-insert-command))
5314 (if (not (eq last-command 'orgtbl-self-insert-command))
5315 (setq org-self-insert-command-undo-counter 1)
5316 (if (>= org-self-insert-command-undo-counter 20)
5317 (setq org-self-insert-command-undo-counter 1)
5318 (and (> org-self-insert-command-undo-counter 0)
5319 buffer-undo-list
5320 (not (cadr buffer-undo-list)) ; remove nil entry
5321 (setcdr buffer-undo-list (cddr buffer-undo-list)))
5322 (setq org-self-insert-command-undo-counter
5323 (1+ org-self-insert-command-undo-counter))))))))
5325 ;;;###autoload
5327 "Regular expression matching exponentials as produced by calc.")
5329 (defun orgtbl-gather-send-defs ()
5330 "Gather a plist of :name, :transform, :params for each destination before
5331 a radio table."
5332 (save-excursion
5333 (goto-char (org-table-begin))
5334 (let (rtn)
5335 (beginning-of-line 0)
5336 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
5337 (let ((name (org-no-properties (match-string 1)))
5338 (transform (intern (match-string 2)))
5339 (params (if (match-end 3)
5340 (read (concat "(" (match-string 3) ")")))))
5341 (push (list :name name :transform transform :params params)
5342 rtn)
5343 (beginning-of-line 0)))
5344 rtn)))
5346 (defun orgtbl-send-replace-tbl (name text)
5347 "Find and replace table NAME with TEXT."
5348 (save-excursion
5349 (goto-char (point-min))
5350 (let* ((location-flag nil)
5351 (name (regexp-quote name))
5354 (while (re-search-forward begin-re nil t)
5355 (unless location-flag (setq location-flag t))
5356 (let ((beg (line-beginning-position 2)))
5357 (unless (re-search-forward end-re nil t)
5358 (user-error "Cannot find end of receiver location at %d" beg))
5359 (beginning-of-line)
5360 (delete-region beg (point))
5362 (unless location-flag
5363 (user-error "No valid receiver location found in the buffer")))))
5365 ;;;###autoload
5366 (defun org-table-to-lisp (&optional txt)
5367 "Convert the table at point to a Lisp structure.
5368 The structure will be a list. Each item is either the symbol `hline'
5369 for a horizontal separator line, or a list of field values as strings.
5370 The table is taken from the parameter TXT, or from the buffer at point."
5371 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5372 (let ((txt (or txt
5373 (buffer-substring-no-properties (org-table-begin)
5374 (org-table-end)))))
5375 (mapcar (lambda (x)
5376 (if (string-match org-table-hline-regexp x) 'hline
5380 (defun orgtbl-send-table (&optional maybe)
5381 "Send a transformed version of table at point to the receiver position.
5382 With argument MAYBE, fail quietly if no transformation is defined
5383 for this table."
5384 (interactive)
5385 (catch 'exit
5386 (unless (org-at-table-p) (user-error "Not at a table"))
5387 ;; when non-interactive, we assume align has just happened.
5388 (when (called-interactively-p 'any) (org-table-align))
5389 (let ((dests (orgtbl-gather-send-defs))
5390 (table (org-table-to-lisp
5391 (buffer-substring-no-properties (org-table-begin)
5392 (org-table-end))))
5393 (ntbl 0))
5394 (unless dests
5395 (if maybe (throw 'exit nil)
5396 (user-error "Don't know how to transform this table")))
5397 (dolist (dest dests)
5398 (let ((name (plist-get dest :name))
5399 (transform (plist-get dest :transform))
5400 (params (plist-get dest :params)))
5401 (unless (fboundp transform)
5402 (user-error "No such transformation function %s" transform))
5403 (orgtbl-send-replace-tbl name (funcall transform table params)))
5404 (cl-incf ntbl))
5405 (message "Table converted and installed at %d receiver location%s"
5406 ntbl (if (> ntbl 1) "s" ""))
5407 (and (> ntbl 0) ntbl))))
5409 (defun org-remove-by-index (list indices &optional i0)
5410 "Remove the elements in LIST with indices in INDICES.
5411 First element has index 0, or I0 if given."
5412 (if (not indices)
5413 list
5414 (if (integerp indices) (setq indices (list indices)))
5415 (setq i0 (1- (or i0 0)))
5416 (delq :rm (mapcar (lambda (x)
5417 (setq i0 (1+ i0))
5418 (if (memq i0 indices) :rm x))
5419 list))))
5421 (defun orgtbl-toggle-comment ()
5422 "Comment or uncomment the orgtbl at point."
5423 (interactive)
5424 (let* ((case-fold-search t)
5425 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5426 (re2 (concat "^" orgtbl-line-start-regexp))
5427 (commented (save-excursion (beginning-of-line 1)
5428 (cond ((looking-at re1) t)
5429 ((looking-at re2) nil)
5430 (t (user-error "Not at an org table")))))
5431 (re (if commented re1 re2))
5432 beg end)
5433 (save-excursion
5434 (beginning-of-line 1)
5435 (while (looking-at re) (beginning-of-line 0))
5436 (beginning-of-line 2)
5437 (setq beg (point))
5438 (while (looking-at re) (beginning-of-line 2))
5439 (setq end (point)))
5440 (comment-region beg end (if commented '(4) nil))))
5442 (defun orgtbl-insert-radio-table ()
5443 "Insert a radio table template appropriate for this major mode."
5444 (interactive)
5445 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5446 (txt (nth 1 e))
5447 name pos)
5448 (unless e (user-error "No radio table setup defined for %s" major-mode))
5449 (setq name (read-string "Table name: "))
5450 (while (string-match "%n" txt)
5451 (setq txt (replace-match name t t txt)))
5453 (setq pos (point))
5454 (insert txt)
5455 (goto-char pos)))
5457 ;;;###autoload
5458 (defun orgtbl-to-generic (table params)
5459 "Convert the orgtbl-mode TABLE to some other format.
5461 This generic routine can be used for many standard cases.
5463 TABLE is a list, each entry either the symbol `hline' for
5464 a horizontal separator line, or a list of fields for that
5465 line. PARAMS is a property list of parameters that can
5466 influence the conversion.
5468 Valid parameters are:
5470 :backend, :raw
5472 Export back-end used as a basis to transcode elements of the
5473 table, when no specific parameter applies to it. It is also
5474 used to translate cells contents. You can prevent this by
5475 setting :raw property to a non-nil value.
5477 :splice
5479 When non-nil, only convert rows, not the table itself. This is
5480 equivalent to setting to the empty string both :tstart
5481 and :tend, which see.
5483 :skip
5485 When set to an integer N, skip the first N lines of the table.
5486 Horizontal separation lines do count for this parameter!
5488 :skipcols
5490 List of columns that should be skipped. If the table has
5491 a column with calculation marks, that column is automatically
5492 discarded beforehand.
5494 :hline
5496 String to be inserted on horizontal separation lines. May be
5497 nil to ignore these lines altogether.
5499 :sep
5501 Separator between two fields, as a string.
5503 Each in the following group may be either a string or a function
5504 of no arguments returning a string:
5506 :tstart, :tend
5508 Strings to start and end the table. Ignored when :splice is t.
5510 :lstart, :lend
5512 Strings to start and end a new table line.
5514 :llstart, :llend
5516 Strings to start and end the last table line. Default,
5517 respectively, to :lstart and :lend.
5519 Each in the following group may be a string or a function of one
5520 argument (either the cells in the current row, as a list of
5521 strings, or the current cell) returning a string:
5523 :lfmt
5525 Format string for an entire row, with enough %s to capture all
5526 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5528 :llfmt
5530 Format for the entire last line, defaults to :lfmt.
5532 :fmt
5534 A format to be used to wrap the field, should contain %s for
5535 the original field value. For example, to wrap everything in
5537 a property list with column numbers and format strings, or
5538 functions, e.g.,
5542 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5544 Same as above, specific for the header lines in the table.
5545 All lines before the first hline are treated as header. If
5546 any of these is not present, the data line value is used.
5548 This may be either a string or a function of two arguments:
5550 :efmt
5552 Use this format to print numbers with exponential. The format
5553 should have %s twice for inserting mantissa and exponent, for
5555 list with column numbers and format strings or functions.
5556 :fmt will still be applied after :efmt."
5557 ;; Make sure `org-export-create-backend' is available.
5558 (require 'ox)
5559 (let* ((backend (plist-get params :backend))
5560 (custom-backend
5561 ;; Build a custom back-end according to PARAMS. Before
5562 ;; defining a translator, check if there is anything to do.
5563 ;; When there isn't, let BACKEND handle the element.
5564 (org-export-create-backend
5565 :parent (or backend 'org)
5566 :transcoders
5567 `((table . ,(org-table--to-generic-table params))
5568 (table-row . ,(org-table--to-generic-row params))
5569 (table-cell . ,(org-table--to-generic-cell params))
5570 ;; Macros are not going to be expanded. However, no
5571 ;; regular back-end has a transcoder for them. We
5572 ;; provide one so they are not ignored, but displayed
5573 ;; as-is instead.
5574 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5575 data info)
5576 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5577 ;; Initialize communication channel in INFO.
5578 (with-temp-buffer
5579 (let ((org-inhibit-startup t)) (org-mode))
5580 (let ((standard-output (current-buffer))
5581 (org-element-use-cache nil))
5582 (dolist (e table)
5584 ((consp e)
5585 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5587 ;; Add back-end specific filters, but not user-defined ones. In
5588 ;; particular, make sure to call parse-tree filters on the
5589 ;; table.
5590 (setq info
5591 (let ((org-export-filters-alist nil))
5592 (org-export-install-filters
5593 (org-combine-plists
5594 (org-export-get-environment backend nil params)
5595 `(:back-end ,(org-export-get-backend backend))))))
5596 (setq data
5597 (org-export-filter-apply-functions
5598 (plist-get info :filter-parse-tree)
5599 (org-element-map (org-element-parse-buffer) 'table
5600 #'identity nil t)
5601 info)))
5602 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5603 (user-error "Unknown :backend value"))
5604 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5605 ;; Handle :skip parameter.
5606 (let ((skip (plist-get info :skip)))
5607 (when skip
5608 (unless (wholenump skip) (user-error "Wrong :skip value"))
5609 (let ((n 0))
5610 (org-element-map data 'table-row
5611 (lambda (row)
5612 (if (>= n skip) t
5613 (org-element-extract-element row)
5614 (cl-incf n)
5615 nil))
5616 nil t))))
5617 ;; Handle :skipcols parameter.
5618 (let ((skipcols (plist-get info :skipcols)))
5619 (when skipcols
5620 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5621 (org-element-map data 'table
5622 (lambda (table)
5623 (let ((specialp (org-export-table-has-special-column-p table)))
5624 (dolist (row (org-element-contents table))
5625 (when (eq (org-element-property :type row) 'standard)
5626 (let ((c 1))
5627 (dolist (cell (nthcdr (if specialp 1 0)
5628 (org-element-contents row)))
5629 (when (memq c skipcols)
5630 (org-element-extract-element cell))
5631 (cl-incf c))))))))))
5632 ;; Since we are going to export using a low-level mechanism,
5633 ;; ignore special column and special rows manually.
5634 (let ((special? (org-export-table-has-special-column-p data))
5635 ignore)
5636 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5637 (lambda (datum)
5638 (when (if (eq (org-element-type datum) 'table-row)
5639 (org-export-table-row-is-special-p datum nil)
5640 (org-export-first-sibling-p datum nil))
5641 (push datum ignore))))
5642 (setq info (plist-put info :ignore-list ignore)))
5643 ;; We use a low-level mechanism to export DATA so as to skip all
5644 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5645 ;; code evaluation, include keywords and macro expansion. Only
5646 ;; back-end specific filters are retained.
5647 (let ((output (org-export-data-with-backend data custom-backend info)))
5648 ;; Remove final newline.
5649 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5651 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5652 (cond ((null value) nil)
5653 ((functionp value) `(funcall ',value ,@args))
5654 ((stringp value)
5655 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5656 (args `(format ,value ,@args))
5657 (t value)))
5658 ((and with-cons (consp value))
5659 `(let ((val (cadr (memq column ',value))))
5660 (cond ((null val) contents)
5661 ((stringp val) (format val ,@args))
5662 ((functionp val) (funcall val ,@args))
5663 (t (user-error "Wrong %s value" ,name)))))
5664 (t (user-error "Wrong %s value" name))))
5666 (defun org-table--to-generic-table (params)
5667 "Return custom table transcoder according to PARAMS.
5668 PARAMS is a plist. See `orgtbl-to-generic' for more
5669 information."
5670 (let ((backend (plist-get params :backend))
5671 (splice (plist-get params :splice))
5672 (tstart (plist-get params :tstart))
5673 (tend (plist-get params :tend)))
5674 `(lambda (table contents info)
5675 (concat
5676 ,(and tstart (not splice)
5678 ,(if (or (not backend) tstart tend splice) 'contents
5679 `(org-export-with-backend ',backend table contents info))
5680 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5682 (defun org-table--to-generic-row (params)
5683 "Return custom table row transcoder according to PARAMS.
5684 PARAMS is a plist. See `orgtbl-to-generic' for more
5685 information."
5686 (let* ((backend (plist-get params :backend))
5687 (lstart (plist-get params :lstart))
5688 (llstart (plist-get params :llstart))
5689 (hlstart (plist-get params :hlstart))
5690 (hllstart (plist-get params :hllstart))
5691 (lend (plist-get params :lend))
5692 (llend (plist-get params :llend))
5693 (hlend (plist-get params :hlend))
5694 (hllend (plist-get params :hllend))
5695 (lfmt (plist-get params :lfmt))
5696 (llfmt (plist-get params :llfmt))
5697 (hlfmt (plist-get params :hlfmt))
5698 (hllfmt (plist-get params :hllfmt)))
5699 `(lambda (row contents info)
5700 (if (eq (org-element-property :type row) 'rule)
5701 ,(cond
5702 ((plist-member params :hline)
5703 (org-table--generic-apply (plist-get params :hline) ":hline"))
5704 (backend `(org-export-with-backend ',backend row nil info)))
5705 (let ((headerp ,(and (or hlfmt hlstart hlend)
5706 '(org-export-table-row-in-header-p row info)))
5707 (last-header-p
5708 ,(and (or hllfmt hllstart hllend)
5709 '(org-export-table-row-ends-header-p row info)))
5710 (lastp (not (org-export-get-next-element row info))))
5711 (when contents
5712 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5713 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5714 ;; `:lstart', `:lend' and their relatives.
5715 ,(let ((cells
5716 '(org-element-map row 'table-cell
5717 (lambda (cell)
5718 ;; Export all cells, without separators.
5719 ;;
5720 ;; Use `org-export-data-with-backend'
5721 ;; instead of `org-export-data' to eschew
5722 ;; cached values, which
5723 ;; ignore :orgtbl-ignore-sep parameter.
5724 (org-export-data-with-backend
5725 cell
5726 (plist-get info :back-end)
5727 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5728 info)))
5729 `(cond
5730 ,(and hllfmt
5731 `(last-header-p ,(org-table--generic-apply
5732 hllfmt ":hllfmt" nil cells)))
5733 ,(and hlfmt
5734 `(headerp ,(org-table--generic-apply
5735 hlfmt ":hlfmt" nil cells)))
5736 ,(and llfmt
5737 `(lastp ,(org-table--generic-apply
5738 llfmt ":llfmt" nil cells)))
5739 (t
5740 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5741 `(concat
5742 (cond
5743 ,(and
5744 (or hllstart hllend)
5745 `(last-header-p
5746 (concat
5747 ,(org-table--generic-apply hllstart ":hllstart")
5748 contents
5749 ,(org-table--generic-apply hllend ":hllend"))))
5750 ,(and
5751 (or hlstart hlend)
5752 `(headerp
5753 (concat
5754 ,(org-table--generic-apply hlstart ":hlstart")
5755 contents
5756 ,(org-table--generic-apply hlend ":hlend"))))
5757 ,(and
5758 (or llstart llend)
5759 `(lastp
5760 (concat
5761 ,(org-table--generic-apply llstart ":llstart")
5762 contents
5763 ,(org-table--generic-apply llend ":llend"))))
5764 (t
5765 ,(cond
5766 ((or lstart lend)
5767 `(concat
5768 ,(org-table--generic-apply lstart ":lstart")
5769 contents
5770 ,(org-table--generic-apply lend ":lend")))
5771 (backend
5772 `(org-export-with-backend
5773 ',backend row contents info))
5774 (t 'contents)))))))))))))))
5776 (defun org-table--to-generic-cell (params)
5777 "Return custom table cell transcoder according to PARAMS.
5778 PARAMS is a plist. See `orgtbl-to-generic' for more
5779 information."
5780 (let* ((backend (plist-get params :backend))
5781 (efmt (plist-get params :efmt))
5782 (fmt (plist-get params :fmt))
5783 (hfmt (plist-get params :hfmt))
5784 (sep (plist-get params :sep))
5785 (hsep (plist-get params :hsep)))
5786 `(lambda (cell contents info)
5787 ;; Make sure that contents are exported as Org data when :raw
5788 ;; parameter is non-nil.
5789 ,(when (and backend (plist-get params :raw))
5790 `(setq contents
5791 ;; Since we don't know what are the pseudo object
5792 ;; types defined in backend, we cannot pass them to
5793 ;; `org-element-interpret-data'. As a consequence,
5794 ;; they will be treated as pseudo elements, and will
5795 ;; have newlines appended instead of spaces.
5796 ;; Therefore, we must make sure :post-blank value is
5797 ;; really turned into spaces.
5798 (replace-regexp-in-string
5800 (org-trim
5801 (org-element-interpret-data
5802 (org-element-contents cell))))))
5804 (let ((headerp ,(and (or hfmt hsep)
5805 '(org-export-table-row-in-header-p
5806 (org-export-get-parent-element cell) info)))
5807 (column
5808 ;; Call costly `org-export-table-cell-address' only if
5809 ;; absolutely necessary, i.e., if one
5810 ;; of :fmt :efmt :hfmt has a "plist type" value.
5811 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5812 (list efmt hfmt fmt))
5813 '(1+ (cdr (org-export-table-cell-address cell info))))))
5814 (when contents
5815 ;; Check if we can apply `:efmt' on CONTENTS.
5816 ,(when efmt
5817 `(when (string-match orgtbl-exp-regexp contents)
5818 (let ((mantissa (match-string 1 contents))
5819 (exponent (match-string 2 contents)))
5820 (setq contents ,(org-table--generic-apply
5821 efmt ":efmt" t 'mantissa 'exponent)))))
5822 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5823 (cond
5824 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5825 hfmt ":hfmt" t 'contents))))
5826 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5827 fmt ":fmt" t 'contents))))))
5828 ;; If a separator is provided, use it instead of BACKEND's.
5829 ;; Separators are ignored when LFMT (or equivalent) is
5830 ;; provided.
5831 ,(cond
5832 ((or hsep sep)
5833 `(if (or ,(and (not sep) '(not headerp))
5834 (plist-get info :orgtbl-ignore-sep)
5835 (not (org-export-get-next-element cell info)))
5836 ,(if (not backend) 'contents
5837 `(org-export-with-backend ',backend cell contents info))
5838 (concat contents
5839 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5840 (or hsep sep)))))
5841 (backend `(org-export-with-backend ',backend cell contents info))
5842 (t 'contents))))))
5844 ;;;###autoload
5845 (defun orgtbl-to-tsv (table params)
5846 "Convert the orgtbl-mode table to TAB separated material."
5849 ;;;###autoload
5850 (defun orgtbl-to-csv (table params)
5851 "Convert the orgtbl-mode table to CSV material.
5852 This does take care of the proper quoting of fields with comma or quotes."
5853 (orgtbl-to-generic table
5854 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5855 params)))
5857 ;;;###autoload
5858 (defun orgtbl-to-latex (table params)
5859 "Convert the orgtbl-mode TABLE to LaTeX.
5861 TABLE is a list, each entry either the symbol `hline' for
5862 a horizontal separator line, or a list of fields for that line.
5863 PARAMS is a property list of parameters that can influence the
5864 conversion. All parameters from `orgtbl-to-generic' are
5865 supported. It is also possible to use the following ones:
5867 :booktabs
5871 :environment
5873 Specify environment to use, as a string. If you use
5875 as a string, to get proper continuation strings."
5876 (require 'ox-latex)
5877 (orgtbl-to-generic
5878 table
5879 (org-combine-plists
5880 ;; Provide sane default values.
5881 (list :backend 'latex
5882 :latex-default-table-mode 'table
5883 :latex-tables-centered nil
5884 :latex-tables-booktabs (plist-get params :booktabs)
5885 :latex-table-scientific-notation nil
5886 :latex-default-table-environment
5887 (or (plist-get params :environment) "tabular"))
5888 params)))
5890 ;;;###autoload
5891 (defun orgtbl-to-html (table params)
5892 "Convert the orgtbl-mode TABLE to HTML.
5894 TABLE is a list, each entry either the symbol `hline' for
5895 a horizontal separator line, or a list of fields for that line.
5896 PARAMS is a property list of parameters that can influence the
5897 conversion. All parameters from `orgtbl-to-generic' are
5898 supported. It is also possible to use the following one:
5900 :attributes
5902 Attributes and values, as a plist, which will be used in
5903 <table> tag."
5904 (require 'ox-html)
5905 (orgtbl-to-generic
5906 table
5907 (org-combine-plists
5908 ;; Provide sane default values.
5909 (list :backend 'html
5910 :html-table-data-tags '("<td%s>" . "</td>")
5911 :html-table-use-header-tags-for-first-column nil
5912 :html-table-align-individual-fields t
5913 :html-table-row-tags '("<tr>" . "</tr>")
5914 :html-table-attributes
5915 (if (plist-member params :attributes)
5916 (plist-get params :attributes)
5917 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5918 :frame "hsides")))
5919 params)))
5921 ;;;###autoload
5922 (defun orgtbl-to-texinfo (table params)
5923 "Convert the orgtbl-mode TABLE to Texinfo.
5925 TABLE is a list, each entry either the symbol `hline' for
5926 a horizontal separator line, or a list of fields for that line.
5927 PARAMS is a property list of parameters that can influence the
5928 conversion. All parameters from `orgtbl-to-generic' are
5929 supported. It is also possible to use the following one:
5931 :columns
5933 Column widths, as a string. When providing column fractions,
5935 (require 'ox-texinfo)
5936 (let ((output
5937 (orgtbl-to-generic
5938 table
5939 (org-combine-plists
5940 (list :backend 'texinfo
5941 :texinfo-tables-verbatim nil
5942 :texinfo-table-scientific-notation nil)
5943 params)))
5944 (columns (let ((w (plist-get params :columns)))
5945 (cond ((not w) nil)
5947 (t (concat "@columnfractions " w))))))
5948 (if (not columns) output
5949 (replace-regexp-in-string
5952 ;;;###autoload
5953 (defun orgtbl-to-orgtbl (table params)
5954 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5956 TABLE is a list, each entry either the symbol `hline' for
5957 a horizontal separator line, or a list of fields for that line.
5958 PARAMS is a property list of parameters that can influence the
5959 conversion. All parameters from `orgtbl-to-generic' are
5960 supported.
5962 Useful when slicing one table into many. The :hline, :sep,
5963 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5964 be set to provide ORGTBL directives for the generated table."
5965 (require 'ox-org)
5966 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5968 (defun orgtbl-to-table.el (table params)
5969 "Convert the orgtbl-mode TABLE into a table.el table.
5970 TABLE is a list, each entry either the symbol `hline' for
5971 a horizontal separator line, or a list of fields for that line.
5972 PARAMS is a property list of parameters that can influence the
5973 conversion. All parameters from `orgtbl-to-generic' are
5974 supported."
5975 (with-temp-buffer
5976 (insert (orgtbl-to-orgtbl table params))
5977 (org-table-align)
5978 (replace-regexp-in-string
5979 "-|" "-+"
5980 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5982 (defun orgtbl-to-unicode (table params)
5983 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5985 TABLE is a list, each entry either the symbol `hline' for
5986 a horizontal separator line, or a list of fields for that line.
5987 PARAMS is a property list of parameters that can influence the
5988 conversion. All parameters from `orgtbl-to-generic' are
5989 supported. It is also possible to use the following ones:
5991 :ascii-art
5994 the table. You can download it here:
5995 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5997 :narrow
5999 When non-nil, narrow columns width than provided width cookie,
6001 (require 'ox-ascii)
6002 (orgtbl-to-generic
6003 table
6004 (org-combine-plists
6005 (list :backend 'ascii
6006 :ascii-charset 'utf-8
6007 :ascii-table-widen-columns (not (plist-get params :narrow))
6008 :ascii-table-use-ascii-art (plist-get params :ascii-art))
6009 params)))
6011 ;; Put the cursor in a column containing numerical values
6012 ;; of an Org table,
6013 ;; type C-c " a
6014 ;; A new column is added with a bar plot.
6015 ;; When the table is refreshed (C-u C-c *),
6016 ;; the plot is updated to reflect the new values.
6018 (defun orgtbl-ascii-draw (value min max &optional width characters)
6019 "Draw an ascii bar in a table.
6020 VALUE is the value to plot, it determines the width of the bar to draw.
6021 MIN is the value that will be displayed as empty (zero width bar).
6022 MAX is the value that will draw a bar filling all the WIDTH.
6023 WIDTH is the span in characters from MIN to MAX.
6024 CHARACTERS is a string that will compose the bar, with shades of grey
6025 from pure white to pure black. It defaults to a 10 characters string
6026 of regular ascii characters."
6027 (let* ((width (ceiling (or width 12)))
6028 (characters (or characters " .:;c!lhVHW"))
6029 (len (1- (length characters)))
6030 (value (float (if (numberp value)
6031 value (string-to-number value))))
6032 (relative (/ (- value min) (- max min)))
6033 (steps (round (* relative width len))))
6034 (cond ((< steps 0) "too small")
6035 ((> steps (* width len)) "too large")
6036 (t (let* ((int-division (/ steps len))
6037 (remainder (- steps (* int-division len))))
6038 (concat (make-string int-division (elt characters len))
6039 (string (elt characters remainder))))))))
6041 ;;;###autoload
6042 (defun orgtbl-ascii-plot (&optional ask)
6043 "Draw an ASCII bar plot in a column.
6045 With cursor in a column containing numerical values, this function
6046 will draw a plot in a new column.
6048 ASK, if given, is a numeric prefix to override the default 12
6050 prefix,
6051 which will prompt for the width."
6052 (interactive "P")
6053 (let ((col (org-table-current-column))
6054 (min 1e999) ; 1e999 will be converted to infinity
6055 (max -1e999) ; which is the desired result
6056 (table (org-table-to-lisp))
6057 (length
6058 (cond ((consp ask)
6059 (read-number "Length of column " 12))
6060 ((numberp ask) ask)
6061 (t 12))))
6062 ;; Skip any hline a the top of table.
6063 (while (eq (car table) 'hline) (setq table (cdr table)))
6064 ;; Skip table header if any.
6065 (dolist (x (or (cdr (memq 'hline table)) table))
6066 (when (consp x)
6067 (setq x (nth (1- col) x))
6068 (when (string-match
6070 x)
6071 (setq x (string-to-number x))
6072 (when (> min x) (setq min x))
6073 (when (< max x) (setq max x)))))
6074 (org-table-insert-column)
6075 (org-table-move-column-right)
6076 (org-table-store-formulas
6077 (cons
6078 (cons
6079 (concat "$" (number-to-string (1+ col)))
6080 (format "'(%s $%s %s %s %s)"
6081 "orgtbl-ascii-draw" col min max length))
6082 (org-table-get-stored-formulas)))
6083 (org-table-recalculate t)))
6085 ;; Example of extension: unicode characters
6086 ;; Here are two examples of different styles.
6088 ;; Unicode block characters are used to give a smooth effect.
6089 ;; See http://en.wikipedia.org/wiki/Block_Elements
6090 ;; Use one of those drawing functions
6091 ;; - orgtbl-ascii-draw (the default ascii)
6092 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
6093 ;; - orgtbl-uc-draw-cont (smooth unicode)
6095 ;; This is best viewed with the "DejaVu Sans Mono" font
6096 ;; (use M-x set-frame-font).
6098 (defun orgtbl-uc-draw-grid (value min max &optional width)
6099 "Draw a bar in a table using block unicode characters.
6100 It is a variant of orgtbl-ascii-draw with Unicode block
6101 characters, for a smooth display. Bars appear as grids (to the
6102 extent the font allows)."
6103 ;; http://en.wikipedia.org/wiki/Block_Elements
6104 ;; best viewed with the "DejaVu Sans Mono" font.
6105 (orgtbl-ascii-draw value min max width
6108 (defun orgtbl-uc-draw-cont (value min max &optional width)
6109 "Draw a bar in a table using block unicode characters.
6110 It is a variant of orgtbl-ascii-draw with Unicode block
6111 characters, for a smooth display. Bars are solid (to the extent
6112 the font allows)."
6113 (orgtbl-ascii-draw value min max width
6116 (defun org-table-get-remote-range (name-or-id form)
6117 "Get a field value or a list of values in a range from table at ID.
6119 NAME-OR-ID may be the name of a table in the current file as set
6121 will then be used. Alternatively, it may be an ID referring to
6122 any entry, also in a different file. In this case, the first
6123 table in that entry will be referenced.
6127 The return value is either a single string for a single field, or a
6128 list of the fields in the rectangle."
6129 (save-match-data
6130 (let ((case-fold-search t) (id-loc nil)
6131 ;; Protect a bunch of variables from being overwritten by
6132 ;; the context of the remote table.
6133 org-table-column-names org-table-column-name-regexp
6134 org-table-local-parameters org-table-named-field-locations
6135 org-table-current-line-types
6136 org-table-current-begin-pos org-table-dlines
6137 org-table-current-ncol
6138 org-table-hlines
6139 org-table-last-column-widths
6140 org-table-last-alignment
6141 buffer loc)
6142 (setq form (org-table-convert-refs-to-rc form))
6143 (org-with-wide-buffer
6144 (goto-char (point-min))
6145 (if (re-search-forward
6148 nil t)
6149 (setq buffer (current-buffer) loc (match-beginning 0))
6150 (setq id-loc (org-id-find name-or-id 'marker))
6151 (unless (and id-loc (markerp id-loc))
6153 (setq buffer (marker-buffer id-loc)
6154 loc (marker-position id-loc))
6155 (move-marker id-loc nil))
6156 (with-current-buffer buffer
6157 (org-with-wide-buffer
6158 (goto-char loc)
6159 (forward-char 1)
6161 (not (match-beginning 1)))
6162 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
6163 (org-table-analyze)
6164 (setq form (org-table-formula-substitute-names
6165 (org-table-formula-handle-first/last-rc form)))
6166 (if (and (string-match org-table-range-regexp form)
6167 (> (length (match-string 0 form)) 1))
6168 (org-table-get-range
6169 (match-string 0 form) org-table-current-begin-pos 1)
6170 form)))))))
6172 (defun org-table-remote-reference-indirection (form)
6173 "Return formula with table remote references substituted by indirection.
6175 This indirection works only with the format @ROW$COLUMN. The
6177 distinguished from a plain table name or ID."
6178 (let ((regexp
6179 ;; Same as in `org-table-eval-formula'.
6181 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
6184 (replace-regexp-in-string
6185 regexp
6186 (lambda (m)
6187 (save-match-data
6188 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
6189 (org-table-get-range
6191 (concat "@0" eq)
6192 eq)))))
6193 form t t 1)))
6195 (defmacro org-define-lookup-function (mode)
6196 (let ((mode-str (symbol-name mode))
6197 (first-p (eq mode 'first))
6198 (all-p (eq mode 'all)))
6199 (let ((plural-str (if all-p "s" "")))
6200 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
6201 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
6202 If R-LIST is nil, return matching element%s of S-LIST.
6203 If PREDICATE is not nil, use it instead of `equal' to match VAL.
6204 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
6205 This function is generated by a call to the macro `org-define-lookup-function'."
6206 mode-str plural-str plural-str plural-str)
6207 (let ,(let ((lvars '((p (or predicate 'equal))
6208 (sl s-list)
6209 (rl (or r-list s-list))
6210 (ret nil))))
6211 (if first-p (cons '(match-p nil) lvars) lvars))
6212 (while ,(if first-p '(and (not match-p) sl) 'sl)
6213 (when (funcall p val (car sl))
6214 ,(when first-p '(setq match-p t))
6215 (let ((rval (car rl)))
6216 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
6217 (setq sl (cdr sl) rl (cdr rl)))
6218 ret)))))
6220 (org-define-lookup-function first)
6221 (org-define-lookup-function last)
6222 (org-define-lookup-function all)
6224 (provide 'org-table)
6226 ;; Local variables:
6227 ;; generated-autoload-file: "org-loaddefs.el"
6228 ;; End:
6230 ;;; org-table.el ends here