| blob | fe6e0eda5894757d3257a73461f6a57c8bbe5597 |
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-line below the current line into the table.
1607 With prefix ABOVE, insert above the current line."
1628 ;;;###autoload
1630 "Insert a hline and move to the row below that line."
1644 In particular, this does handle wide and invisible characters."
1646 ;; It's a hline, just map the characters
1652 t t s)))
1653 s))
1655 ;;;###autoload
1657 "Delete the current row or horizontal line from the table."
1673 ;;;###autoload
1675 "Copy region in table to the clipboard and blank all relevant fields.
1676 If there is no active region, use just the field at point."
1682 ;;;###autoload
1684 "Copy the value of the current field one row below.
1686 If the field at the cursor is empty, copy the content of the
1687 nearest non-empty field above. With argument N, use the Nth
1688 non-empty field.
1690 If the current field is not empty, it is copied down to the next
1691 row, and the cursor is moved with it. Therefore, repeating this
1692 command causes the column to be filled row-by-row.
1694 If the variable `org-table-copy-increment' is non-nil and the
1695 field is an integer or a timestamp, it will be incremented while
1696 copying. By default, increment by the difference between the
1697 value in the current field and the one in the field above. To
1698 increment using a fixed integer, set `org-table-copy-increment'
1699 to a number. In the case of a timestamp, increment by days."
1711 txt txt-up inc)
1719 beg t))
1729 beg t))
1736 ;; Above field was not empty, go down to the next row. Skip
1737 ;; alignment since we do it at the end of the process anyway.
1769 ;;;###autoload
1771 "Copy rectangular region in table to clipboard.
1772 A special clipboard is used which can only be accessed with
1773 `org-table-paste-rectangle'. Return the region copied, as a list
1774 of lists of fields."
1778 current-prefix-arg))
1783 region)
1795 ;; Collect every cell between COLUMN-START and COLUMN-END.
1807 ;;;###autoload
1809 "Paste a rectangular region into a table.
1810 The upper right corner ends up in the current field. All involved fields
1811 will be overwritten. If the rectangle does not fit into the present table,
1812 the table is enlarged as needed. The process ignores horizontal separator
1813 lines."
1823 ;; If we left the table, create a new row.
1835 \f
1836 ;;; Follow Field minor mode
1839 "Minor mode to make the table field editor window follow the cursor.
1840 When this mode is active, the field editor window will always show the
1841 current field. The mode exits automatically when the cursor leaves the
1842 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1843 nil " TblFollow" nil
1856 ;;;###autoload
1858 "Edit table field in a different window.
1859 This is mainly useful for fields that contain hidden parts.
1862 visible so that it can be edited in place.
1865 toggle `org-table-follow-field-mode'."
1887 p)
1911 ;; We have left the table, exit the follow mode
1920 "Finish editing a table data field.
1921 Remove all newline characters, insert the result into the table, realign
1922 the table and kill the editing buffer."
1926 text)
1942 \f
1943 ;;; Formulas
1946 "Return the formula active for the current field.
1948 Assumes that table is already analyzed. If KEY is given, return
1949 the key to this formula. Otherwise return the formula preceded
1958 org-table-named-field-locations)))
1972 "Read a formula from the minibuffer, offer stored formula as default.
1973 When NAMED is non-nil, look for a named equation."
1978 org-table-named-field-locations)))
1991 stored)
2000 mustsave)
2002 ;; Remove formula.
2009 ;; We set the column equation, delete the named one.
2011 mustsave t))
2017 eq))
2020 "Store the list of formulas below the current table.
2021 If optional argument LOCATION is a buffer position, insert it at
2022 LOCATION instead."
2030 ;; Don't overwrite TBLFM, we might use text properties to
2031 ;; store stuff.
2045 ;; Fake a high number to make sure this is sorted at the end.
2052 a)
2062 "Compare two formulas for sorting."
2067 ;;;###autoload
2069 "Return an alist with the stored formulas directly after current table.
2070 By default, only return active formulas, i.e., formulas located
2071 on the first line after the table. However, if optional argument
2072 LOCATION is a buffer position, consider the formulas there."
2081 eq-alist seen)
2085 string)
2090 ;; Is it a column reference?
2092 ;; Since named columns are not possible in
2093 ;; LHS, assume this is a named field.
2101 "Double definition `%s=' in TBLFM line, please fix by hand"
2102 lhs)
2107 "Double definition `%s=' in TBLFM line, please fix by hand"
2108 lhs)))))))))))
2111 "Modify the equations after the table structure has been edited.
2113 For all numbers larger than LIMIT, shift them by DELTA."
2125 s n a)
2131 "Change makes TBLFM term %s invalid, use undo to recover"
2146 ;;;###autoload
2149 If yes, store the formula and apply it."
2150 ;; We already know we are in a table. Get field will only return a formula
2151 ;; when appropriate. It might return a separator line, but no problem.
2154 named eq)
2161 ;;;###autoload
2163 "Rotate the recalculation mark in the first column.
2164 If in any row, the first field is not consistent with a mark,
2165 insert a new column for the markers.
2166 When there is an active region, change all the lines in the region,
2167 after prompting for the marking character.
2168 After each change, a message will be displayed indicating the meaning
2169 of the new mark."
2185 newchar))
2193 newchar))
2211 ;; Rotate mark in first row.
2213 ;; Rotate marks in additional rows if a region is active.
2221 ;; Only align if rotation actually changed lines' length.
2231 ;;;###autoload
2233 "Recompute the current line if marked for it, and if we haven't just done it."
2242 ;;;###autoload
2244 suppress-align suppress-const
2245 suppress-store suppress-analysis)
2246 "Replace the table field value at the cursor by the result of a calculation.
2248 In a table, this command replaces the value in the current field with the
2250 formula, by storing it in a special line below the table. When called
2252 field formula.
2255 insert the active equation for the field
2256 back into the current field, so that it can be edited there. This is \
2257 useful
2259 check the referenced fields.
2261 When called, the command first prompts for a formula, which is read in
2262 the minibuffer. Previously entered formulas are available through the
2263 history list, and the last used formula is offered as a default.
2264 These stored formulas are adapted correctly when moving, inserting, or
2265 deleting columns with the corresponding commands.
2267 The formula can be any algebraic expression understood by the Calc package.
2268 For details, see the Org mode manual.
2270 This function can also be called from Lisp programs and offers
2271 additional arguments: EQUATION can be the formula to apply. If this
2272 argument is given, the user will not be prompted.
2274 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2275 unnecessary aligns.
2277 SUPPRESS-CONST suppresses the interpretation of constants in the
2278 formula, assuming that this has been done already outside the
2279 function.
2281 SUPPRESS-STORE means the formula should not be stored, either
2282 because it is already stored, or because it is a modified
2283 equation that should not overwrite the stored one.
2285 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2286 location of point."
2302 equation
2308 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2309 duration duration-output-format)
2310 ;; Parse the format string. Since we have a lot of modes, this is
2311 ;; a lot of work. However, I think calc still uses most of the time.
2325 'calc-float-format
2328 n))))
2333 duration-output-format
2363 ;; replace fields with duration values if relevant
2367 fields)))
2373 x))
2374 fields)))
2380 ;; Insert row and column number of formula result field
2391 t t form)))
2393 ;; Check for old vertical references
2395 ;; Insert remote references
2408 rmtrng))
2409 keep-empty numbers lispp))
2410 t t form)))
2411 ;; Insert complex ranges
2421 ;; possibly handle durations
2426 formrg)
2427 keep-empty numbers lispp)))
2432 ;; Insert simple ranges, i.e. included in the current row.
2435 form)
2446 keep-empty numbers lispp))
2447 t t form)))
2449 ;; Insert the references to fields in same row
2456 x keep-empty numbers lispp)))
2473 ;; Use <...> time-stamps so that Calc can handle them.
2476 ;; Internationalize local time-stamps by setting locale to
2477 ;; "C".
2480 org-ts-regexp
2488 form t t))
2491 form
2498 duration-output-format)
2499 ev)))
2504 Orig: %s
2505 $xyz-> %s
2506 @r$c-> %s
2529 ;; Replace any active time stamp in the result with
2530 ;; an inactive one. Dates in tables are likely
2531 ;; piece of regular data, not meant to appear in the
2532 ;; agenda.
2545 prop value)))
2548 "Get a calc vector from a column, according to descriptor DESC.
2550 Optional arguments TBEG and COL can give the beginning of the table and
2551 the current column, to avoid unnecessary parsing.
2553 HIGHLIGHT means just highlight the range.
2555 When CORNERS-ONLY is set, only return the corners of the range as
2556 a list (line1 column1 line2 column2) where line1 and line2 are
2557 line numbers relative to beginning of table, or TBEG, and column1
2558 and column2 are table column numbers."
2561 desc))
2572 thisline)))
2577 thisline)))
2589 ;; Just one field.
2596 ;; A range, return a vector. First sort the numbers to get
2597 ;; a regular rectangle.
2603 ;; Copy the range values into a list.
2618 ;; Return string representation of calc vector.
2624 "Return relative line number corresponding to descriptor DESC.
2625 The cursor is currently in relative line number CLINE."
2630 ;; 1 2 3 4 5 6
2631 desc))
2653 cline)))
2656 "Return relative line of Nth row with type TYPE.
2657 Search starts from relative line I. When BACKWARDS in non-nil,
2658 look before I. When RELATIVE is non-nil, the reference is
2659 relative. DESC is the original descriptor that started the
2660 search, as a string."
2668 ;; We are going to cross a hline. Check if this is
2669 ;; an authorized move.
2680 ;; The last hline doesn't exist. Instead, point to last row
2681 ;; in table.
2690 "Convert list ELEMENTS to something appropriate to insert into formula.
2691 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2692 NUMBERS indicates that everything should be converted to numbers.
2693 LISPP non-nil means to return something appropriate for a Lisp
2694 list, `literal' is for the format specifier L."
2695 ;; Calc nan (not a number) is used for the conversion of the empty
2696 ;; field to a reference for several reasons: (i) It is accepted in a
2697 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2698 ;; (ii) In a single field (not in range) it can be distinguished
2699 ;; from "(nan)" which is the reference made from a single field
2700 ;; containing "nan".
2702 ;; field reference
2705 elements
2707 ""
2716 ;; range reference
2721 elements))))
2727 x
2735 x)
2737 elements
2741 "If there has been more than one second since T1, display message.
2742 ARGS are passed as arguments to the `message' function. Returns
2743 current time if a message is printed, otherwise returns T1. If
2744 T1 is nil, always messages."
2748 curtime)
2749 t1)))
2751 ;;;###autoload
2753 "Recalculate the current table line by applying all stored formulas.
2755 With prefix arg ALL, do this for all lines in the table.
2758 if ALL is the symbol `iterate',
2759 recompute the table until it no longer changes.
2761 If NOALIGN is not nil, do not re-align the table after the computations
2762 are done. This is typically used internally to save time, if it is
2763 known that the table will be realigned a little later anyway."
2778 beg end eqlcol eqlfield)
2779 ;; Insert constants in all formulas.
2782 ;; Expand equations, then split the equation list between
2783 ;; column formulas and field formulas.
2795 old-lhs)))
2798 existing formula for column %s"
2799 old-lhs
2800 new))
2801 new))
2807 ;; Expand ranges in lhs of formulas
2809 ;; Get the correct line range to process.
2816 ;; This is a table with marked lines, compute selected
2817 ;; lines.
2819 ;; Move forward to the first non-header line.
2824 ;; Just leave BEG at the start of the table.
2829 ;; Mark named fields untouchable. Also check if several
2830 ;; field/range formulas try to set the same field.
2834 seen-fields)
2845 ;; Turn field coordinates associated to NAME
2846 ;; into an absolute reference.
2850 name)))
2853 reference))
2858 ;; Evaluate the column formulas, but skip fields covered by
2859 ;; field formulas.
2863 ;; Unprotected line, recalculate.
2868 log-last-time
2881 ;; Evaluate the field formulas.
2890 reference
2891 ;; Possibly create a new column, as long as
2892 ;; `org-table-formula-create-columns' allows it.
2904 t))
2911 ;; Clean up markers and internal text property.
2922 ;;;###autoload
2924 "Recalculate the table until it does not change anymore.
2925 The maximum number of iterations is 10, but you can choose a different value
2926 with the prefix ARG."
2931 thistbl)
2945 ;;;###autoload
2947 "Recalculate all tables in the current buffer."
2952 ;; Reason for separate `org-table-align': When repeating
2953 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
2954 ;; the way.
2957 t)))
2959 ;;;###autoload
2961 "Iterate all tables in the buffer, to converge inter-table dependencies."
2966 c1)
2982 "Apply the #+TBLFM in the line at point to the table."
2989 ;; Insert a temporary formula at right after the table
2994 ;; Recalculate the table.
2999 ;; Delete the formula inserted temporarily.
3005 "Find the beginning of the TBLFM lines and return its position.
3006 Return nil when the beginning of TBLFM line was not found."
3013 "Expand list of formulas.
3014 If some of the RHS in the formulas are ranges or a row reference,
3015 expand them to individual field equations for each field. This
3016 function assumes the table is already analyzed (i.e., using
3017 `org-table-analyze')."
3024 ;; This just refers to one fixed field.
3027 ;; This just refers to one fixed named field.
3030 ;; Column formulas are treated specially and are not
3031 ;; expanded.
3036 rhs)
3037 res)))
3049 rhs)
3050 res))))))))))
3053 "Replace @<, @>, $<, $> with first/last row/column of the table.
3054 So @< and $< will always be replaced with @1 and $1, respectively.
3055 The advantage of these special markers are that structure editing of
3056 the table will not change them, while @1 and $1 will be modified
3057 when a line/row is swapped out of that privileged position. So for
3058 formulas that use a range of rows or columns, it may often be better
3060 borders of the table using the @< @> $< $> makers."
3063 s start)
3068 org-table-current-ncol)
3072 len
3079 s)
3082 "Replace $const with values in string F."
3087 org-table-column-name-regexp
3090 org-table-column-names))))
3091 f t t)))
3092 ;; Parameters and constants.
3096 new start))
3099 ;; When a duration is expected, convert value on the fly.
3105 v)))))
3112 "Find the value for a parameter or constant in a formula.
3113 Parameters get priority."
3144 map))
3151 "--"
3154 "--"
3155 "Shift Reference at Point"
3160 "-"
3161 "Change Test Row for Column Formulas"
3164 "--"
3169 org-table-overlay-coordinates)]
3170 "--"
3177 ;;;###autoload
3179 "Edit the formulas of the current table in a separate buffer."
3185 ;; Move point within the table before analyzing it.
3201 ;; Keep global-font-lock-mode from turning on font-lock-mode
3247 "Convert a formula from internal to user representation."
3250 s))
3253 "Convert a formula from user to internal representation."
3256 s))
3259 "Convert spreadsheet references from A7 to @7$28.
3260 Works for single references, but also for entire formulas and even the
3261 full TBLFM line."
3263 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3266 ;; format match, just advance
3271 ;; 3.e5 or something like this.
3274 ;; (member (match-string 1 s)
3275 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3276 )
3277 ;; function name, just advance
3287 t t s)))))
3288 s))
3291 "Convert spreadsheet references from to @7$28 to AB7.
3292 Works for single references, but also for entire formulas and even the
3293 full TBLFM line."
3300 t t s)))
3305 t nil s)))
3306 s)
3309 "Convert a base 26 number represented by letters into an integer.
3310 For example: AB -> 28."
3316 n))
3319 "Convert an integer into a base 26 number represented by letters.
3320 For example: 28 -> AB."
3325 s))
3328 "Convert a time string into numerical duration in seconds.
3329 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3330 If S is a string representing a number, keep this number."
3332 s
3355 "Convert a number of seconds to a time string.
3356 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3357 minutes or seconds."
3369 ;; Ignore seconds
3373 secs0)
3378 secs0)))))
3382 "Convert all references in this buffer, using FUNCTION."
3393 "Convert all references in the buffer from B3 to @3$2 and back."
3403 "Shift the reference at point one row/hline up."
3408 "Shift the reference at point one row/hline down."
3413 "Shift the reference at point one field to the left."
3418 "Shift the reference at point one field to the right."
3423 "Re-match the group N, and replace it with the shifted reference."
3428 t t)))
3437 ;; A B3-like reference
3443 ;; An internal reference
3449 "Shift a reference part REF.
3450 If DECR is set, decrease the references row/column, else increase.
3451 If HLINE is set, this may be a hline reference, it certainly is not
3452 a translation reference."
3481 "Toggle the display of coordinates in the referenced table."
3490 "Parse the buffer for formula definitions and install them.
3491 With prefix ARG, apply the new formulas to the table."
3500 eql)
3503 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3504 nil t)
3525 "Abort editing formulas, without installing the changes."
3536 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3575 "Move cursor one line up in the window showing the table."
3580 "Move cursor one line down in the window showing the table."
3585 "Move the cursor in the window showing the table.
3586 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3609 "Add a new overlay."
3615 "Highlight rectangular region in a table.
3616 When buffer positions BEG and END are provided, use them to
3617 delimit the region to highlight. Otherwise, refer to point. Use
3618 FACE, when non-nil, for the highlight."
3650 "Remove the rectangle overlays."
3660 "Add overlays to the table at point, to show row/column coordinates."
3688 ;;;###autoload
3690 "Toggle the display of Row/Column numbers in tables."
3701 ;;;###autoload
3703 "Toggle the formula debugger in tables."
3709 \f
3710 ;;; Columns Shrinking
3713 "Non-nil if current field is narrowed.
3714 When non-nil, return the overlay narrowing the field."
3717 o))
3725 "List currently shrunk columns in table at point."
3727 ;; We really check shrunk columns in current row only. It could
3728 ;; be wrong if all rows do not contain the same number of columns
3729 ;; (i.e. the table is not properly aligned). As a consequence,
3730 ;; some columns may not be shrunk again upon aligning the table.
3731 ;;
3732 ;; For example, in the following table, cursor is on first row and
3733 ;; "<>" indicates a shrunk column.
3734 ;;
3735 ;; | |
3736 ;; | | <> |
3737 ;;
3738 ;; Aligning table from the first row will not shrink again the
3739 ;; second row, which was not visible initially.
3740 ;;
3741 ;; However, fixing it requires to check every row, which may be
3742 ;; slow on large tables. Moreover, the hindrance of this
3743 ;; pathological case is very limited.
3756 "Create an overlay to shrink text between START and END.
3758 Use string DISPLAY instead of the real text between the two
3759 buffer positions. FIELD is the real contents of the field, as
3760 a string, or nil. It is meant to be displayed upon moving the
3761 mouse onto the overlay.
3763 When optional argument PRE is non-nil, assume the overlay is
3764 located at the beginning of the field, and prepend
3765 `org-table-separator-space' to it. Otherwise, concatenate
3766 `org-table-shrunk-column-indicator' at its end.
3768 Return the overlay."
3771 ;; Removing one overlay removes all other overlays in the
3772 ;; same column.
3781 ;; Make sure overlays stays on top of table coordinates overlays.
3782 ;; See `org-table-overlay-coordinates'.
3787 o))
3790 "Shrink a table field to a specified width.
3792 WIDTH is an integer representing the number of characters to
3793 display, in addition to `org-table-shrunk-column-indicator'.
3796 and ending positions of the field. CONTENTS is its trimmed
3797 contents, as a string, or `hline' for table rules.
3799 Real field is hidden under one or two overlays. They have the
3800 following properties:
3802 `org-overlay-type'
3804 Set to `table-column-hide'. Used to identify overlays
3805 responsible for shrinking columns in a table.
3807 `org-table-column-overlays'
3809 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3810 where COLUMN-OVERLAYS is the list of all overlays hiding the
3811 same column.
3813 Whenever the text behind or next to the overlay is modified, all
3814 the overlays in the column are deleted, effectively displaying
3815 the column again.
3817 Return a list of overlays hiding the field, or nil if field is
3818 already hidden."
3831 ;; We really want WIDTH + 2 whitespace, to include blanks
3832 ;; around fields.
3839 ;; If the field is not empty, display exactly WIDTH characters.
3840 ;; It can mean to partly hide the field, or extend it with virtual
3841 ;; blanks. To that effect, we use one or two overlays. The
3842 ;; first, optional, one may add or hide white spaces before the
3843 ;; contents of the field. The other, mandatory, one cuts the
3844 ;; field or displays white spaces at the end of the field. It
3845 ;; also always displays `org-table-shrunk-column-indicator'.
3851 ;; Contents are too large to fit in WIDTH character. Limit, if
3852 ;; possible, blanks at the beginning of the field to a single
3853 ;; white space, and cut the field at an appropriate location.
3861 ;; Find cut location so that WIDTH characters are
3862 ;; visible using dichotomy.
3866 ;; Compensate the absence of leading space,
3867 ;; thus preserving alignment.
3878 upper))
3881 ;; Contents fit it WIDTH characters. First compute number of
3882 ;; white spaces needed on each side of contents, then expand or
3883 ;; compact blanks on each side of the field in order to
3884 ;; preserve width and obey to alignment constraints.
3889 ;; Compensate the absence of leading space, thus
3890 ;; preserving alignment.
3906 contents t))))
3918 contents)))))
3922 "Read column selection select as a list of numbers.
3924 SELECT is a string containing column ranges, separated by white
3925 space characters, see `org-table-hide-column' for details. MAX
3926 is the maximum column number.
3928 Return value is a sorted list of numbers. Ignore any number
3929 outside of the [1;MAX] range."
3946 max))))
3949 #'<)))
3952 "Shrink COLUMNS in a table.
3953 COLUMNS is a sorted list of column numbers. BEG and END are,
3954 respectively, the beginning position and the end position of the
3955 table."
3967 ;; Move to COLUMN.
3972 ;; Extract boundaries and contents from current field.
3973 ;; Also set the column's width if we encounter a width
3974 ;; cookie for the first time.
3985 contents))
3990 ;; Link overlays for current field to the other overlays in the
3991 ;; same column.
3999 ;;;###autoload
4001 "Shrink or expand current column in an Org table.
4003 If a width cookie specifies a width W for the column, the first
4004 W visible characters are displayed. Otherwise, the column is
4005 shrunk to a single character.
4007 When point is before the first column or after the last one, ask
4008 for the columns to shrink or expand, as a list of ranges.
4009 A column range can be one of the following patterns:
4011 N column N only
4012 N-M every column between N and M (both inclusive)
4013 N- every column between N (inclusive) and the last column
4014 -M every column between the first one and M (inclusive)
4015 - every column
4017 When optional argument ARG is a string, use it as white space
4018 separated list of column ranges.
4021 `org-table-shrink', i.e.,
4022 shrink columns with a width cookie and expand the others.
4025 prefix, expand all columns."
4030 ;; Compute an upper bound for the number of columns.
4031 ;; Nonexistent columns are ignored anyway.
4036 (`nil
4040 ;; Point is either before first column or past last
4041 ;; one. Ask for columns to operate on.
4044 max-columns)
4057 ;;;###autoload
4059 "Shrink all columns with a width cookie in the table at point.
4061 Columns without a width cookie are expanded.
4063 Optional arguments BEGIN and END, when non-nil, specify the
4064 beginning and end position of the current table."
4077 ;; Make sure invisible characters in the table are at the right
4078 ;; place since column widths take them into account.
4082 ;;;###autoload
4084 "Expand all columns in the table at point.
4085 Optional arguments BEGIN and END, when non-nil, specify the
4086 beginning and end position of the current table."
4094 \f
4095 ;;; Generic Tools
4097 ;;;###autoload
4099 "Apply function F to the start of all tables in the buffer."
4114 ;;;###autoload
4116 "Export table to a file, with configurable format.
4117 Such a file can be imported into usual spreadsheet programs.
4119 FILE can be the output file name. If not given, it will be taken
4120 from a TABLE_EXPORT_FILE property in the current entry or higher
4121 up in the hierarchy, or the user will be prompted for a file
4122 name. FORMAT can be an export format, of the same kind as it
4123 used when `-mode' sends a table in a different format.
4125 The command suggests a format depending on TABLE_EXPORT_FORMAT,
4126 whether it is set locally or up in the hierarchy, then on the
4127 extension of the given file name, and finally on the variable
4128 `org-table-export-default-format'."
4161 formats)))
4162 org-table-export-default-format)
4187 ;;;###autoload
4189 "Format FIELD according to column WIDTH and alignement ALIGN.
4199 prefix
4200 field
4201 suffix
4202 org-table-separator-space)))
4205 "Align the table at point by aligning all vertical bars."
4210 ;; Make sure invisible characters in the table are at the right
4211 ;; place since column widths take them into account.
4218 ;; Table's rows as lists of fields. Rules are replaced
4219 ;; by nil. Trailing spaces are removed.
4225 ;; Compute number of columns. If the table contains no
4226 ;; field, create a default table and bail out.
4234 ;; Compute alignment and width for each column.
4256 alignments)))
4259 ;; Store alignment of this table, for later editing of single
4260 ;; fields.
4263 ;; Build new table rows. Only replace rows that actually
4264 ;; changed.
4269 indent
4272 widths
4281 cells
4282 widths
4283 alignments)
4293 ;;;###autoload
4295 "Justify the current field, text to left, number to right.
4296 Optional argument NEW may specify text to replace the current field content."
4305 ;; This is not the same table, force a full re-align.
4308 ;; Realign the current field, based on previous full realign.
4341 ;;;###autoload
4344 "Sort table lines according to the column at point.
4346 The position of point indicates the column to be used for
4347 sorting, and the range of lines is the range between the nearest
4348 horizontal separator lines, or the entire table of no such lines
4349 exist. If point is before the first column, you will be prompted
4350 for the sorting column. If there is an active region, the mark
4351 specifies the first line and the sorting column, while point
4352 should be in the last line to be included into the sorting.
4354 The command then prompts for the sorting type which can be
4355 alphabetically, numerically, or by time (as given in a time stamp
4356 in the field, or as a HH:MM value). Sorting in reverse order is
4357 also possible.
4359 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive
4360 if the locale allows for it.
4362 If SORTING-TYPE is specified when this function is called from a Lisp
4363 program, no prompting will take place. SORTING-TYPE must be a character,
4364 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
4365 sorting should be done in reverse order.
4367 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
4368 a function to be called to extract the key. It must return a value
4369 that is compatible with COMPARE-FUNC, the function used to compare
4370 entries.
4372 A non-nil value for INTERACTIVE? is used to signal that this
4373 function is being called interactively."
4376 ;; Point must be either within a field or before a data line.
4381 ;; Set appropriate case sensitivity and column used for sorting.
4394 ;; Narrow buffer to appropriate sorting area.
4405 start))
4408 end)))
4409 ;; Determine arguments for `sort-subr'. Also record original
4410 ;; position. `org-table-save-field' cannot help here since
4411 ;; sorting is too much destructive.
4416 ;; Function to be called on the contents of the field
4417 ;; used for sorting in the current row.
4445 "Function for comparing keys (empty for default \
4446 `sort-subr' predicate): "
4456 #'end-of-line
4460 nil
4461 predicate)
4462 ;; Hide all columns but the one being sorted.
4464 ;; Move back to initial field.
4469 "Transpose Org table at point and eliminate hlines.
4470 So a table like
4472 | 1 | 2 | 4 | 5 |
4473 |---+---+---+---|
4474 | a | b | c | d |
4475 | e | f | g | h |
4477 will be transposed as
4479 | 1 | a | e |
4480 | 2 | b | f |
4481 | 4 | c | g |
4482 | 5 | d | h |
4484 Note that horizontal lines disappear."
4496 table)))
4510 ;;;###autoload
4512 "Wrap several fields in a column like a paragraph.
4513 This is useful if you'd like to spread the contents of a field over several
4514 lines, in order to keep the table compact.
4516 If there is an active region, and both point and mark are in the same column,
4517 the text in the column is wrapped to minimum width for the given number of
4518 lines. Generally, this makes the table more compact. A prefix ARG may be
4519 used to change the number of desired lines. For example, \
4521 formats the selected text to two lines. If the region was longer than two
4522 lines, the remaining lines remain empty. A negative prefix argument reduces
4523 the current number of lines by that amount. The wrapped text is pasted back
4524 into the table. If you formatted it to more lines than it was before, fields
4525 further down in the table get overwritten - so you might need to make space in
4526 the table first.
4528 If there is no region, the current field is split at the cursor position and
4529 the text fragment to the right of the cursor is prepended to the field one
4530 line down.
4532 If there is no region, but you specify a prefix ARG, the current field gets
4533 blank, and the content is appended to the field above."
4537 ;; There is a region: fill as a paragraph.
4548 nil
4549 nlines))))
4552 ;; No region, split the current field at point.
4595 ;;;###autoload
4597 "Sum numbers in region of current table column.
4598 The result will be displayed in the echo area, and will be available
4601 If there is an active region, it is interpreted as a rectangle and all
4602 numbers in that rectangle will be summed. If there is no active
4603 region and point is located in a table column, sum all numbers in that
4604 column.
4606 If at least one number looks like a time HH:MM or HH:MM:SS, all other
4607 numbers are assumed to be times as well (in decimal hours) and the
4608 numbers are added as such.
4610 If NLAST is a number, only the NLAST fields will actually be summed."
4637 items1)))
4644 s diff)
4652 sres))))
4653 sres))))
4655 ;;;###autoload
4657 "Analyze table at point and store results.
4659 This function sets up the following dynamically scoped variables:
4661 `org-table-column-name-regexp',
4662 `org-table-column-names',
4663 `org-table-current-begin-pos',
4664 `org-table-current-line-types',
4665 `org-table-current-ncol',
4666 `org-table-dlines',
4667 `org-table-hlines',
4668 `org-table-local-parameters',
4669 `org-table-named-field-locations'."
4674 ;; Extract column names.
4687 ;; Extract local parameters.
4695 org-table-local-parameters)))))
4696 ;; Update named fields locations. We minimize `count-lines'
4697 ;; processing by storing last known number of lines in LAST.
4719 field))
4722 org-table-named-field-locations))))))))))
4723 ;; Re-use existing markers when possible.
4727 ;; Analyze the line types.
4738 ;; Get the number of columns from the first data line in table.
4746 al al2)
4760 "Move point to the closest data line in a table.
4761 Raise an error if the table contains no data line. Preserve
4762 column when moving point."
4770 p1
4771 p2)))
4777 "Show the location/value of the $ expression at point.
4778 When LOCAL is non-nil, show references for the table at point."
4788 var name e what match dest)
4792 "$1.."
4844 dest)
4870 ;; Column number.
4896 org-table-fedit-scroll-down))))
4907 \f
4908 ;;; The Orgtbl minor mode
4910 ;; Define a minor mode which can be used in other modes in order to
4911 ;; integrate the Org table editor.
4913 ;; This is really a hack, because the Org table editor uses several
4914 ;; keys which normally belong to the major mode, for example the TAB
4915 ;; and RET keys. Here is how it works: The minor mode defines all the
4916 ;; keys necessary to operate the table editor, but wraps the commands
4917 ;; into a function which tests if the cursor is currently inside
4918 ;; a table. If that is the case, the table editor command is
4919 ;; executed. However, when any of those keys is used outside a table,
4920 ;; the function uses `key-binding' to look up if the key has an
4921 ;; associated command in another currently active keymap (minor modes,
4922 ;; major mode, global), and executes that command. There might be
4923 ;; problems if any of the keys used by the table editor is otherwise
4924 ;; used as a prefix key.
4926 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4927 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4928 ;; addresses this by checking explicitly for both bindings.
4930 ;; The optimized version (see variable `orgtbl-optimized') takes over
4931 ;; all keys which are bound to `self-insert-command' in the *global map*.
4932 ;; Some modes bind other commands to simple characters, for example
4933 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4934 ;; active, this binding is ignored inside tables and replaced with a
4935 ;; modified self-insert.
4952 ;;;###autoload
4954 "Unconditionally turn on `orgtbl-mode'."
4958 ;; Install it as a minor mode.
4966 "--"
4971 "--"
4976 "--"
4988 "--"
4995 "--"
5000 "--"
5007 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
5019 "--"
5024 ;;;###autoload
5026 "The Org mode table editor as a minor mode for use in other modes."
5031 ;; Exit without error, in case some hook functions calls this by
5032 ;; accident in Org mode.
5036 ;; Make sure we are first in minor-mode-map-alist
5038 ;; FIXME: maybe it should use emulation-mode-map-alists?
5045 auto-fill-inhibit-regexp)
5049 auto-fill-inhibit-regexp)
5050 orgtbl-line-start-regexp))
5065 "Create a function for binding in the table minor mode.
5066 FUN is the command to call inside a table. N is used to create a unique
5067 command name. KEYS are keys that should be checked in for a command
5068 to execute outside of tables."
5074 "Outside of tables, run the binding of `"
5086 keys)
5090 "Error when there is no default binding for a table key."
5095 "Setup orgtbl keymaps."
5126 elt key fun cmd)
5134 ;; Special treatment needed for TAB, RET and DEL
5147 (orgtbl-make-binding 'org-delete-backward-char 109
5153 [(tab)] "\C-i"))
5155 (org-defkey orgtbl-mode-map [backtab]
5157 [backtab] [S-iso-lefttab] [(shift tab)]
5158 [(tab)] "\C-i"))
5160 (org-defkey orgtbl-mode-map "\M-\C-m"
5161 (orgtbl-make-binding 'org-table-wrap-region 105
5162 "\M-\C-m" [(meta return)]))
5163 (org-defkey orgtbl-mode-map [(meta return)]
5164 (orgtbl-make-binding 'org-table-wrap-region 106
5165 [(meta return)] "\M-\C-m"))
5167 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
5168 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
5170 (when orgtbl-optimized
5171 ;; If the user wants maximum table support, we need to hijack
5172 ;; some standard editing functions
5173 (org-remap orgtbl-mode-map
5174 'self-insert-command 'orgtbl-self-insert-command
5175 'delete-char 'org-delete-char
5176 'delete-backward-char 'org-delete-backward-char)
5177 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
5178 t))
5180 (defun orgtbl-ctrl-c-ctrl-c (arg)
5181 "If the cursor is inside a table, realign the table.
5182 If it is a table to be sent away to a receiver, do it.
5183 With prefix arg, also recompute table."
5184 (interactive "P")
5185 (let ((case-fold-search t) (pos (point)) action)
5186 (save-excursion
5187 (beginning-of-line 1)
5188 (setq action (cond
5192 (cond
5193 ((integerp action)
5194 (goto-char action)
5195 (org-table-maybe-eval-formula)
5196 (if arg
5197 (call-interactively 'org-table-recalculate)
5198 (org-table-maybe-recalculate-line))
5199 (call-interactively 'org-table-align)
5200 (when (orgtbl-send-table 'maybe)
5201 (run-hooks 'orgtbl-after-send-table-hook)))
5202 ((eq action 'recalc)
5203 (save-excursion
5204 (beginning-of-line 1)
5206 (if (org-at-table-p)
5207 (org-call-with-arg 'org-table-recalculate t))))
5208 (t (let (orgtbl-mode)
5209 (call-interactively (key-binding "\C-c\C-c")))))))
5211 (defun orgtbl-create-or-convert-from-region (_arg)
5212 "Create table or convert region to table, if no conflicting binding.
5213 This installs the table binding `C-c |', but only if there is no
5214 conflicting binding to this key outside orgtbl-mode."
5215 (interactive "P")
5216 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
5217 (if cmd
5218 (call-interactively cmd)
5219 (call-interactively 'org-table-create-or-convert-from-region))))
5221 (defun orgtbl-tab (arg)
5222 "Justification and field motion for `orgtbl-mode'."
5223 (interactive "P")
5224 (if arg (org-table-edit-field t)
5225 (org-table-justify-field-maybe)
5226 (org-table-next-field)))
5228 (defun orgtbl-ret ()
5229 "Justification and field motion for `orgtbl-mode'."
5230 (interactive)
5231 (if (bobp)
5232 (newline)
5233 (org-table-justify-field-maybe)
5234 (org-table-next-row)))
5236 (defun orgtbl-self-insert-command (N)
5237 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
5238 If the cursor is in a table looking at whitespace, the whitespace is
5239 overwritten, and the table is not marked as requiring realignment."
5240 (interactive "p")
5241 (if (and (org-at-table-p)
5242 (or
5243 (and org-table-auto-blank-field
5244 (member last-command
5245 '(orgtbl-hijacker-command-100
5246 orgtbl-hijacker-command-101
5247 orgtbl-hijacker-command-102
5248 orgtbl-hijacker-command-103
5249 orgtbl-hijacker-command-104
5250 orgtbl-hijacker-command-105
5251 yas/expand))
5252 (org-table-blank-field))
5253 t)
5254 (eq N 1)
5256 (let (org-table-may-need-update)
5257 (delete-region (match-beginning 1) (match-end 1))
5258 (self-insert-command N))
5259 (setq org-table-may-need-update t)
5260 (let* (orgtbl-mode
5261 a
5262 (cmd (or (key-binding
5263 (or (and (listp function-key-map)
5264 (setq a (assoc last-input-event function-key-map))
5265 (cdr a))
5266 (vector last-input-event)))
5267 'self-insert-command)))
5268 (call-interactively cmd)
5269 (if (and org-self-insert-cluster-for-undo
5270 (eq cmd 'self-insert-command))
5271 (if (not (eq last-command 'orgtbl-self-insert-command))
5272 (setq org-self-insert-command-undo-counter 1)
5273 (if (>= org-self-insert-command-undo-counter 20)
5274 (setq org-self-insert-command-undo-counter 1)
5275 (and (> org-self-insert-command-undo-counter 0)
5276 buffer-undo-list
5277 (not (cadr buffer-undo-list)) ; remove nil entry
5278 (setcdr buffer-undo-list (cddr buffer-undo-list)))
5279 (setq org-self-insert-command-undo-counter
5280 (1+ org-self-insert-command-undo-counter))))))))
5282 ;;;###autoload
5284 "Regular expression matching exponentials as produced by calc.")
5286 (defun orgtbl-gather-send-defs ()
5287 "Gather a plist of :name, :transform, :params for each destination before
5288 a radio table."
5289 (save-excursion
5290 (goto-char (org-table-begin))
5291 (let (rtn)
5292 (beginning-of-line 0)
5293 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
5294 (let ((name (org-no-properties (match-string 1)))
5295 (transform (intern (match-string 2)))
5296 (params (if (match-end 3)
5297 (read (concat "(" (match-string 3) ")")))))
5298 (push (list :name name :transform transform :params params)
5299 rtn)
5300 (beginning-of-line 0)))
5301 rtn)))
5303 (defun orgtbl-send-replace-tbl (name text)
5304 "Find and replace table NAME with TEXT."
5305 (save-excursion
5306 (goto-char (point-min))
5307 (let* ((location-flag nil)
5308 (name (regexp-quote name))
5311 (while (re-search-forward begin-re nil t)
5312 (unless location-flag (setq location-flag t))
5313 (let ((beg (line-beginning-position 2)))
5314 (unless (re-search-forward end-re nil t)
5315 (user-error "Cannot find end of receiver location at %d" beg))
5316 (beginning-of-line)
5317 (delete-region beg (point))
5319 (unless location-flag
5320 (user-error "No valid receiver location found in the buffer")))))
5322 ;;;###autoload
5323 (defun org-table-to-lisp (&optional txt)
5324 "Convert the table at point to a Lisp structure.
5325 The structure will be a list. Each item is either the symbol `hline'
5326 for a horizontal separator line, or a list of field values as strings.
5327 The table is taken from the parameter TXT, or from the buffer at point."
5328 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5329 (let ((txt (or txt
5330 (buffer-substring-no-properties (org-table-begin)
5331 (org-table-end)))))
5332 (mapcar (lambda (x)
5333 (if (string-match org-table-hline-regexp x) 'hline
5337 (defun orgtbl-send-table (&optional maybe)
5338 "Send a transformed version of table at point to the receiver position.
5339 With argument MAYBE, fail quietly if no transformation is defined
5340 for this table."
5341 (interactive)
5342 (catch 'exit
5343 (unless (org-at-table-p) (user-error "Not at a table"))
5344 ;; when non-interactive, we assume align has just happened.
5345 (when (called-interactively-p 'any) (org-table-align))
5346 (let ((dests (orgtbl-gather-send-defs))
5347 (table (org-table-to-lisp
5348 (buffer-substring-no-properties (org-table-begin)
5349 (org-table-end))))
5350 (ntbl 0))
5351 (unless dests
5352 (if maybe (throw 'exit nil)
5353 (user-error "Don't know how to transform this table")))
5354 (dolist (dest dests)
5355 (let ((name (plist-get dest :name))
5356 (transform (plist-get dest :transform))
5357 (params (plist-get dest :params)))
5358 (unless (fboundp transform)
5359 (user-error "No such transformation function %s" transform))
5360 (orgtbl-send-replace-tbl name (funcall transform table params)))
5361 (cl-incf ntbl))
5362 (message "Table converted and installed at %d receiver location%s"
5363 ntbl (if (> ntbl 1) "s" ""))
5364 (and (> ntbl 0) ntbl))))
5366 (defun org-remove-by-index (list indices &optional i0)
5367 "Remove the elements in LIST with indices in INDICES.
5368 First element has index 0, or I0 if given."
5369 (if (not indices)
5370 list
5371 (if (integerp indices) (setq indices (list indices)))
5372 (setq i0 (1- (or i0 0)))
5373 (delq :rm (mapcar (lambda (x)
5374 (setq i0 (1+ i0))
5375 (if (memq i0 indices) :rm x))
5376 list))))
5378 (defun orgtbl-toggle-comment ()
5379 "Comment or uncomment the orgtbl at point."
5380 (interactive)
5381 (let* ((case-fold-search t)
5382 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5383 (re2 (concat "^" orgtbl-line-start-regexp))
5384 (commented (save-excursion (beginning-of-line 1)
5385 (cond ((looking-at re1) t)
5386 ((looking-at re2) nil)
5387 (t (user-error "Not at an org table")))))
5388 (re (if commented re1 re2))
5389 beg end)
5390 (save-excursion
5391 (beginning-of-line 1)
5392 (while (looking-at re) (beginning-of-line 0))
5393 (beginning-of-line 2)
5394 (setq beg (point))
5395 (while (looking-at re) (beginning-of-line 2))
5396 (setq end (point)))
5397 (comment-region beg end (if commented '(4) nil))))
5399 (defun orgtbl-insert-radio-table ()
5400 "Insert a radio table template appropriate for this major mode."
5401 (interactive)
5402 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5403 (txt (nth 1 e))
5404 name pos)
5405 (unless e (user-error "No radio table setup defined for %s" major-mode))
5406 (setq name (read-string "Table name: "))
5407 (while (string-match "%n" txt)
5408 (setq txt (replace-match name t t txt)))
5410 (setq pos (point))
5411 (insert txt)
5412 (goto-char pos)))
5414 ;;;###autoload
5415 (defun orgtbl-to-generic (table params)
5416 "Convert the orgtbl-mode TABLE to some other format.
5418 This generic routine can be used for many standard cases.
5420 TABLE is a list, each entry either the symbol `hline' for
5421 a horizontal separator line, or a list of fields for that
5422 line. PARAMS is a property list of parameters that can
5423 influence the conversion.
5425 Valid parameters are:
5427 :backend, :raw
5429 Export back-end used as a basis to transcode elements of the
5430 table, when no specific parameter applies to it. It is also
5431 used to translate cells contents. You can prevent this by
5432 setting :raw property to a non-nil value.
5434 :splice
5436 When non-nil, only convert rows, not the table itself. This is
5437 equivalent to setting to the empty string both :tstart
5438 and :tend, which see.
5440 :skip
5442 When set to an integer N, skip the first N lines of the table.
5443 Horizontal separation lines do count for this parameter!
5445 :skipcols
5447 List of columns that should be skipped. If the table has
5448 a column with calculation marks, that column is automatically
5449 discarded beforehand.
5451 :hline
5453 String to be inserted on horizontal separation lines. May be
5454 nil to ignore these lines altogether.
5456 :sep
5458 Separator between two fields, as a string.
5460 Each in the following group may be either a string or a function
5461 of no arguments returning a string:
5463 :tstart, :tend
5465 Strings to start and end the table. Ignored when :splice is t.
5467 :lstart, :lend
5469 Strings to start and end a new table line.
5471 :llstart, :llend
5473 Strings to start and end the last table line. Default,
5474 respectively, to :lstart and :lend.
5476 Each in the following group may be a string or a function of one
5477 argument (either the cells in the current row, as a list of
5478 strings, or the current cell) returning a string:
5480 :lfmt
5482 Format string for an entire row, with enough %s to capture all
5483 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5485 :llfmt
5487 Format for the entire last line, defaults to :lfmt.
5489 :fmt
5491 A format to be used to wrap the field, should contain %s for
5492 the original field value. For example, to wrap everything in
5494 a property list with column numbers and format strings, or
5495 functions, e.g.,
5499 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5501 Same as above, specific for the header lines in the table.
5502 All lines before the first hline are treated as header. If
5503 any of these is not present, the data line value is used.
5505 This may be either a string or a function of two arguments:
5507 :efmt
5509 Use this format to print numbers with exponential. The format
5510 should have %s twice for inserting mantissa and exponent, for
5512 list with column numbers and format strings or functions.
5513 :fmt will still be applied after :efmt."
5514 ;; Make sure `org-export-create-backend' is available.
5515 (require 'ox)
5516 (let* ((backend (plist-get params :backend))
5517 (custom-backend
5518 ;; Build a custom back-end according to PARAMS. Before
5519 ;; defining a translator, check if there is anything to do.
5520 ;; When there isn't, let BACKEND handle the element.
5521 (org-export-create-backend
5522 :parent (or backend 'org)
5523 :transcoders
5524 `((table . ,(org-table--to-generic-table params))
5525 (table-row . ,(org-table--to-generic-row params))
5526 (table-cell . ,(org-table--to-generic-cell params))
5527 ;; Macros are not going to be expanded. However, no
5528 ;; regular back-end has a transcoder for them. We
5529 ;; provide one so they are not ignored, but displayed
5530 ;; as-is instead.
5531 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5532 data info)
5533 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5534 ;; Initialize communication channel in INFO.
5535 (with-temp-buffer
5536 (let ((org-inhibit-startup t)) (org-mode))
5537 (let ((standard-output (current-buffer))
5538 (org-element-use-cache nil))
5539 (dolist (e table)
5541 ((consp e)
5542 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5544 ;; Add back-end specific filters, but not user-defined ones. In
5545 ;; particular, make sure to call parse-tree filters on the
5546 ;; table.
5547 (setq info
5548 (let ((org-export-filters-alist nil))
5549 (org-export-install-filters
5550 (org-combine-plists
5551 (org-export-get-environment backend nil params)
5552 `(:back-end ,(org-export-get-backend backend))))))
5553 (setq data
5554 (org-export-filter-apply-functions
5555 (plist-get info :filter-parse-tree)
5556 (org-element-map (org-element-parse-buffer) 'table
5557 #'identity nil t)
5558 info)))
5559 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5560 (user-error "Unknown :backend value"))
5561 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5562 ;; Handle :skip parameter.
5563 (let ((skip (plist-get info :skip)))
5564 (when skip
5565 (unless (wholenump skip) (user-error "Wrong :skip value"))
5566 (let ((n 0))
5567 (org-element-map data 'table-row
5568 (lambda (row)
5569 (if (>= n skip) t
5570 (org-element-extract-element row)
5571 (cl-incf n)
5572 nil))
5573 nil t))))
5574 ;; Handle :skipcols parameter.
5575 (let ((skipcols (plist-get info :skipcols)))
5576 (when skipcols
5577 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5578 (org-element-map data 'table
5579 (lambda (table)
5580 (let ((specialp (org-export-table-has-special-column-p table)))
5581 (dolist (row (org-element-contents table))
5582 (when (eq (org-element-property :type row) 'standard)
5583 (let ((c 1))
5584 (dolist (cell (nthcdr (if specialp 1 0)
5585 (org-element-contents row)))
5586 (when (memq c skipcols)
5587 (org-element-extract-element cell))
5588 (cl-incf c))))))))))
5589 ;; Since we are going to export using a low-level mechanism,
5590 ;; ignore special column and special rows manually.
5591 (let ((special? (org-export-table-has-special-column-p data))
5592 ignore)
5593 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5594 (lambda (datum)
5595 (when (if (eq (org-element-type datum) 'table-row)
5596 (org-export-table-row-is-special-p datum nil)
5597 (org-export-first-sibling-p datum nil))
5598 (push datum ignore))))
5599 (setq info (plist-put info :ignore-list ignore)))
5600 ;; We use a low-level mechanism to export DATA so as to skip all
5601 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5602 ;; code evaluation, include keywords and macro expansion. Only
5603 ;; back-end specific filters are retained.
5604 (let ((output (org-export-data-with-backend data custom-backend info)))
5605 ;; Remove final newline.
5606 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5608 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5609 (cond ((null value) nil)
5610 ((functionp value) `(funcall ',value ,@args))
5611 ((stringp value)
5612 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5613 (args `(format ,value ,@args))
5614 (t value)))
5615 ((and with-cons (consp value))
5616 `(let ((val (cadr (memq column ',value))))
5617 (cond ((null val) contents)
5618 ((stringp val) (format val ,@args))
5619 ((functionp val) (funcall val ,@args))
5620 (t (user-error "Wrong %s value" ,name)))))
5621 (t (user-error "Wrong %s value" name))))
5623 (defun org-table--to-generic-table (params)
5624 "Return custom table transcoder according to PARAMS.
5625 PARAMS is a plist. See `orgtbl-to-generic' for more
5626 information."
5627 (let ((backend (plist-get params :backend))
5628 (splice (plist-get params :splice))
5629 (tstart (plist-get params :tstart))
5630 (tend (plist-get params :tend)))
5631 `(lambda (table contents info)
5632 (concat
5633 ,(and tstart (not splice)
5635 ,(if (or (not backend) tstart tend splice) 'contents
5636 `(org-export-with-backend ',backend table contents info))
5637 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5639 (defun org-table--to-generic-row (params)
5640 "Return custom table row transcoder according to PARAMS.
5641 PARAMS is a plist. See `orgtbl-to-generic' for more
5642 information."
5643 (let* ((backend (plist-get params :backend))
5644 (lstart (plist-get params :lstart))
5645 (llstart (plist-get params :llstart))
5646 (hlstart (plist-get params :hlstart))
5647 (hllstart (plist-get params :hllstart))
5648 (lend (plist-get params :lend))
5649 (llend (plist-get params :llend))
5650 (hlend (plist-get params :hlend))
5651 (hllend (plist-get params :hllend))
5652 (lfmt (plist-get params :lfmt))
5653 (llfmt (plist-get params :llfmt))
5654 (hlfmt (plist-get params :hlfmt))
5655 (hllfmt (plist-get params :hllfmt)))
5656 `(lambda (row contents info)
5657 (if (eq (org-element-property :type row) 'rule)
5658 ,(cond
5659 ((plist-member params :hline)
5660 (org-table--generic-apply (plist-get params :hline) ":hline"))
5661 (backend `(org-export-with-backend ',backend row nil info)))
5662 (let ((headerp ,(and (or hlfmt hlstart hlend)
5663 '(org-export-table-row-in-header-p row info)))
5664 (last-header-p
5665 ,(and (or hllfmt hllstart hllend)
5666 '(org-export-table-row-ends-header-p row info)))
5667 (lastp (not (org-export-get-next-element row info))))
5668 (when contents
5669 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5670 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5671 ;; `:lstart', `:lend' and their relatives.
5672 ,(let ((cells
5673 '(org-element-map row 'table-cell
5674 (lambda (cell)
5675 ;; Export all cells, without separators.
5676 ;;
5677 ;; Use `org-export-data-with-backend'
5678 ;; instead of `org-export-data' to eschew
5679 ;; cached values, which
5680 ;; ignore :orgtbl-ignore-sep parameter.
5681 (org-export-data-with-backend
5682 cell
5683 (plist-get info :back-end)
5684 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5685 info)))
5686 `(cond
5687 ,(and hllfmt
5688 `(last-header-p ,(org-table--generic-apply
5689 hllfmt ":hllfmt" nil cells)))
5690 ,(and hlfmt
5691 `(headerp ,(org-table--generic-apply
5692 hlfmt ":hlfmt" nil cells)))
5693 ,(and llfmt
5694 `(lastp ,(org-table--generic-apply
5695 llfmt ":llfmt" nil cells)))
5696 (t
5697 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5698 `(concat
5699 (cond
5700 ,(and
5701 (or hllstart hllend)
5702 `(last-header-p
5703 (concat
5704 ,(org-table--generic-apply hllstart ":hllstart")
5705 contents
5706 ,(org-table--generic-apply hllend ":hllend"))))
5707 ,(and
5708 (or hlstart hlend)
5709 `(headerp
5710 (concat
5711 ,(org-table--generic-apply hlstart ":hlstart")
5712 contents
5713 ,(org-table--generic-apply hlend ":hlend"))))
5714 ,(and
5715 (or llstart llend)
5716 `(lastp
5717 (concat
5718 ,(org-table--generic-apply llstart ":llstart")
5719 contents
5720 ,(org-table--generic-apply llend ":llend"))))
5721 (t
5722 ,(cond
5723 ((or lstart lend)
5724 `(concat
5725 ,(org-table--generic-apply lstart ":lstart")
5726 contents
5727 ,(org-table--generic-apply lend ":lend")))
5728 (backend
5729 `(org-export-with-backend
5730 ',backend row contents info))
5731 (t 'contents)))))))))))))))
5733 (defun org-table--to-generic-cell (params)
5734 "Return custom table cell transcoder according to PARAMS.
5735 PARAMS is a plist. See `orgtbl-to-generic' for more
5736 information."
5737 (let* ((backend (plist-get params :backend))
5738 (efmt (plist-get params :efmt))
5739 (fmt (plist-get params :fmt))
5740 (hfmt (plist-get params :hfmt))
5741 (sep (plist-get params :sep))
5742 (hsep (plist-get params :hsep)))
5743 `(lambda (cell contents info)
5744 ;; Make sure that contents are exported as Org data when :raw
5745 ;; parameter is non-nil.
5746 ,(when (and backend (plist-get params :raw))
5747 `(setq contents
5748 ;; Since we don't know what are the pseudo object
5749 ;; types defined in backend, we cannot pass them to
5750 ;; `org-element-interpret-data'. As a consequence,
5751 ;; they will be treated as pseudo elements, and will
5752 ;; have newlines appended instead of spaces.
5753 ;; Therefore, we must make sure :post-blank value is
5754 ;; really turned into spaces.
5755 (replace-regexp-in-string
5757 (org-trim
5758 (org-element-interpret-data
5759 (org-element-contents cell))))))
5761 (let ((headerp ,(and (or hfmt hsep)
5762 '(org-export-table-row-in-header-p
5763 (org-export-get-parent-element cell) info)))
5764 (column
5765 ;; Call costly `org-export-table-cell-address' only if
5766 ;; absolutely necessary, i.e., if one
5767 ;; of :fmt :efmt :hfmt has a "plist type" value.
5768 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5769 (list efmt hfmt fmt))
5770 '(1+ (cdr (org-export-table-cell-address cell info))))))
5771 (when contents
5772 ;; Check if we can apply `:efmt' on CONTENTS.
5773 ,(when efmt
5774 `(when (string-match orgtbl-exp-regexp contents)
5775 (let ((mantissa (match-string 1 contents))
5776 (exponent (match-string 2 contents)))
5777 (setq contents ,(org-table--generic-apply
5778 efmt ":efmt" t 'mantissa 'exponent)))))
5779 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5780 (cond
5781 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5782 hfmt ":hfmt" t 'contents))))
5783 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5784 fmt ":fmt" t 'contents))))))
5785 ;; If a separator is provided, use it instead of BACKEND's.
5786 ;; Separators are ignored when LFMT (or equivalent) is
5787 ;; provided.
5788 ,(cond
5789 ((or hsep sep)
5790 `(if (or ,(and (not sep) '(not headerp))
5791 (plist-get info :orgtbl-ignore-sep)
5792 (not (org-export-get-next-element cell info)))
5793 ,(if (not backend) 'contents
5794 `(org-export-with-backend ',backend cell contents info))
5795 (concat contents
5796 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5797 (or hsep sep)))))
5798 (backend `(org-export-with-backend ',backend cell contents info))
5799 (t 'contents))))))
5801 ;;;###autoload
5802 (defun orgtbl-to-tsv (table params)
5803 "Convert the orgtbl-mode table to TAB separated material."
5806 ;;;###autoload
5807 (defun orgtbl-to-csv (table params)
5808 "Convert the orgtbl-mode table to CSV material.
5809 This does take care of the proper quoting of fields with comma or quotes."
5810 (orgtbl-to-generic table
5811 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5812 params)))
5814 ;;;###autoload
5815 (defun orgtbl-to-latex (table params)
5816 "Convert the orgtbl-mode TABLE to LaTeX.
5818 TABLE is a list, each entry either the symbol `hline' for
5819 a horizontal separator line, or a list of fields for that line.
5820 PARAMS is a property list of parameters that can influence the
5821 conversion. All parameters from `orgtbl-to-generic' are
5822 supported. It is also possible to use the following ones:
5824 :booktabs
5828 :environment
5830 Specify environment to use, as a string. If you use
5832 as a string, to get proper continuation strings."
5833 (require 'ox-latex)
5834 (orgtbl-to-generic
5835 table
5836 (org-combine-plists
5837 ;; Provide sane default values.
5838 (list :backend 'latex
5839 :latex-default-table-mode 'table
5840 :latex-tables-centered nil
5841 :latex-tables-booktabs (plist-get params :booktabs)
5842 :latex-table-scientific-notation nil
5843 :latex-default-table-environment
5844 (or (plist-get params :environment) "tabular"))
5845 params)))
5847 ;;;###autoload
5848 (defun orgtbl-to-html (table params)
5849 "Convert the orgtbl-mode TABLE to HTML.
5851 TABLE is a list, each entry either the symbol `hline' for
5852 a horizontal separator line, or a list of fields for that line.
5853 PARAMS is a property list of parameters that can influence the
5854 conversion. All parameters from `orgtbl-to-generic' are
5855 supported. It is also possible to use the following one:
5857 :attributes
5859 Attributes and values, as a plist, which will be used in
5860 <table> tag."
5861 (require 'ox-html)
5862 (orgtbl-to-generic
5863 table
5864 (org-combine-plists
5865 ;; Provide sane default values.
5866 (list :backend 'html
5867 :html-table-data-tags '("<td%s>" . "</td>")
5868 :html-table-use-header-tags-for-first-column nil
5869 :html-table-align-individual-fields t
5870 :html-table-row-tags '("<tr>" . "</tr>")
5871 :html-table-attributes
5872 (if (plist-member params :attributes)
5873 (plist-get params :attributes)
5874 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5875 :frame "hsides")))
5876 params)))
5878 ;;;###autoload
5879 (defun orgtbl-to-texinfo (table params)
5880 "Convert the orgtbl-mode TABLE to Texinfo.
5882 TABLE is a list, each entry either the symbol `hline' for
5883 a horizontal separator line, or a list of fields for that line.
5884 PARAMS is a property list of parameters that can influence the
5885 conversion. All parameters from `orgtbl-to-generic' are
5886 supported. It is also possible to use the following one:
5888 :columns
5890 Column widths, as a string. When providing column fractions,
5892 (require 'ox-texinfo)
5893 (let ((output
5894 (orgtbl-to-generic
5895 table
5896 (org-combine-plists
5897 (list :backend 'texinfo
5898 :texinfo-tables-verbatim nil
5899 :texinfo-table-scientific-notation nil)
5900 params)))
5901 (columns (let ((w (plist-get params :columns)))
5902 (cond ((not w) nil)
5904 (t (concat "@columnfractions " w))))))
5905 (if (not columns) output
5906 (replace-regexp-in-string
5909 ;;;###autoload
5910 (defun orgtbl-to-orgtbl (table params)
5911 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5913 TABLE is a list, each entry either the symbol `hline' for
5914 a horizontal separator line, or a list of fields for that line.
5915 PARAMS is a property list of parameters that can influence the
5916 conversion. All parameters from `orgtbl-to-generic' are
5917 supported.
5919 Useful when slicing one table into many. The :hline, :sep,
5920 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5921 be set to provide ORGTBL directives for the generated table."
5922 (require 'ox-org)
5923 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5925 (defun orgtbl-to-table.el (table params)
5926 "Convert the orgtbl-mode TABLE into a table.el table.
5927 TABLE is a list, each entry either the symbol `hline' for
5928 a horizontal separator line, or a list of fields for that line.
5929 PARAMS is a property list of parameters that can influence the
5930 conversion. All parameters from `orgtbl-to-generic' are
5931 supported."
5932 (with-temp-buffer
5933 (insert (orgtbl-to-orgtbl table params))
5934 (org-table-align)
5935 (replace-regexp-in-string
5936 "-|" "-+"
5937 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5939 (defun orgtbl-to-unicode (table params)
5940 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5942 TABLE is a list, each entry either the symbol `hline' for
5943 a horizontal separator line, or a list of fields for that line.
5944 PARAMS is a property list of parameters that can influence the
5945 conversion. All parameters from `orgtbl-to-generic' are
5946 supported. It is also possible to use the following ones:
5948 :ascii-art
5951 the table. You can download it here:
5952 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5954 :narrow
5956 When non-nil, narrow columns width than provided width cookie,
5958 (require 'ox-ascii)
5959 (orgtbl-to-generic
5960 table
5961 (org-combine-plists
5962 (list :backend 'ascii
5963 :ascii-charset 'utf-8
5964 :ascii-table-widen-columns (not (plist-get params :narrow))
5965 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5966 params)))
5968 ;; Put the cursor in a column containing numerical values
5969 ;; of an Org table,
5970 ;; type C-c " a
5971 ;; A new column is added with a bar plot.
5972 ;; When the table is refreshed (C-u C-c *),
5973 ;; the plot is updated to reflect the new values.
5975 (defun orgtbl-ascii-draw (value min max &optional width characters)
5976 "Draw an ascii bar in a table.
5977 VALUE is the value to plot, it determines the width of the bar to draw.
5978 MIN is the value that will be displayed as empty (zero width bar).
5979 MAX is the value that will draw a bar filling all the WIDTH.
5980 WIDTH is the span in characters from MIN to MAX.
5981 CHARACTERS is a string that will compose the bar, with shades of grey
5982 from pure white to pure black. It defaults to a 10 characters string
5983 of regular ascii characters."
5984 (let* ((width (ceiling (or width 12)))
5985 (characters (or characters " .:;c!lhVHW"))
5986 (len (1- (length characters)))
5987 (value (float (if (numberp value)
5988 value (string-to-number value))))
5989 (relative (/ (- value min) (- max min)))
5990 (steps (round (* relative width len))))
5991 (cond ((< steps 0) "too small")
5992 ((> steps (* width len)) "too large")
5993 (t (let* ((int-division (/ steps len))
5994 (remainder (- steps (* int-division len))))
5995 (concat (make-string int-division (elt characters len))
5996 (string (elt characters remainder))))))))
5998 ;;;###autoload
5999 (defun orgtbl-ascii-plot (&optional ask)
6000 "Draw an ASCII bar plot in a column.
6002 With cursor in a column containing numerical values, this function
6003 will draw a plot in a new column.
6005 ASK, if given, is a numeric prefix to override the default 12
6007 prefix,
6008 which will prompt for the width."
6009 (interactive "P")
6010 (let ((col (org-table-current-column))
6011 (min 1e999) ; 1e999 will be converted to infinity
6012 (max -1e999) ; which is the desired result
6013 (table (org-table-to-lisp))
6014 (length
6015 (cond ((consp ask)
6016 (read-number "Length of column " 12))
6017 ((numberp ask) ask)
6018 (t 12))))
6019 ;; Skip any hline a the top of table.
6020 (while (eq (car table) 'hline) (setq table (cdr table)))
6021 ;; Skip table header if any.
6022 (dolist (x (or (cdr (memq 'hline table)) table))
6023 (when (consp x)
6024 (setq x (nth (1- col) x))
6025 (when (string-match
6027 x)
6028 (setq x (string-to-number x))
6029 (when (> min x) (setq min x))
6030 (when (< max x) (setq max x)))))
6031 (org-table-insert-column)
6032 (org-table-move-column-right)
6033 (org-table-store-formulas
6034 (cons
6035 (cons
6036 (concat "$" (number-to-string (1+ col)))
6037 (format "'(%s $%s %s %s %s)"
6038 "orgtbl-ascii-draw" col min max length))
6039 (org-table-get-stored-formulas)))
6040 (org-table-recalculate t)))
6042 ;; Example of extension: unicode characters
6043 ;; Here are two examples of different styles.
6045 ;; Unicode block characters are used to give a smooth effect.
6046 ;; See http://en.wikipedia.org/wiki/Block_Elements
6047 ;; Use one of those drawing functions
6048 ;; - orgtbl-ascii-draw (the default ascii)
6049 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
6050 ;; - orgtbl-uc-draw-cont (smooth unicode)
6052 ;; This is best viewed with the "DejaVu Sans Mono" font
6053 ;; (use M-x set-frame-font).
6055 (defun orgtbl-uc-draw-grid (value min max &optional width)
6056 "Draw a bar in a table using block unicode characters.
6057 It is a variant of orgtbl-ascii-draw with Unicode block
6058 characters, for a smooth display. Bars appear as grids (to the
6059 extent the font allows)."
6060 ;; http://en.wikipedia.org/wiki/Block_Elements
6061 ;; best viewed with the "DejaVu Sans Mono" font.
6062 (orgtbl-ascii-draw value min max width
6065 (defun orgtbl-uc-draw-cont (value min max &optional width)
6066 "Draw a bar in a table using block unicode characters.
6067 It is a variant of orgtbl-ascii-draw with Unicode block
6068 characters, for a smooth display. Bars are solid (to the extent
6069 the font allows)."
6070 (orgtbl-ascii-draw value min max width
6073 (defun org-table-get-remote-range (name-or-id form)
6074 "Get a field value or a list of values in a range from table at ID.
6076 NAME-OR-ID may be the name of a table in the current file as set
6078 will then be used. Alternatively, it may be an ID referring to
6079 any entry, also in a different file. In this case, the first
6080 table in that entry will be referenced.
6084 The return value is either a single string for a single field, or a
6085 list of the fields in the rectangle."
6086 (save-match-data
6087 (let ((case-fold-search t) (id-loc nil)
6088 ;; Protect a bunch of variables from being overwritten by
6089 ;; the context of the remote table.
6090 org-table-column-names org-table-column-name-regexp
6091 org-table-local-parameters org-table-named-field-locations
6092 org-table-current-line-types
6093 org-table-current-begin-pos org-table-dlines
6094 org-table-current-ncol
6095 org-table-hlines
6096 org-table-last-column-widths
6097 org-table-last-alignment
6098 buffer loc)
6099 (setq form (org-table-convert-refs-to-rc form))
6100 (org-with-wide-buffer
6101 (goto-char (point-min))
6102 (if (re-search-forward
6105 nil t)
6106 (setq buffer (current-buffer) loc (match-beginning 0))
6107 (setq id-loc (org-id-find name-or-id 'marker))
6108 (unless (and id-loc (markerp id-loc))
6110 (setq buffer (marker-buffer id-loc)
6111 loc (marker-position id-loc))
6112 (move-marker id-loc nil))
6113 (with-current-buffer buffer
6114 (org-with-wide-buffer
6115 (goto-char loc)
6116 (forward-char 1)
6118 (not (match-beginning 1)))
6119 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
6120 (org-table-analyze)
6121 (setq form (org-table-formula-substitute-names
6122 (org-table-formula-handle-first/last-rc form)))
6123 (if (and (string-match org-table-range-regexp form)
6124 (> (length (match-string 0 form)) 1))
6125 (org-table-get-range
6126 (match-string 0 form) org-table-current-begin-pos 1)
6127 form)))))))
6129 (defun org-table-remote-reference-indirection (form)
6130 "Return formula with table remote references substituted by indirection.
6132 This indirection works only with the format @ROW$COLUMN. The
6134 distinguished from a plain table name or ID."
6135 (let ((regexp
6136 ;; Same as in `org-table-eval-formula'.
6138 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
6141 (replace-regexp-in-string
6142 regexp
6143 (lambda (m)
6144 (save-match-data
6145 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
6146 (org-table-get-range
6148 (concat "@0" eq)
6149 eq)))))
6150 form t t 1)))
6152 (defmacro org-define-lookup-function (mode)
6153 (let ((mode-str (symbol-name mode))
6154 (first-p (eq mode 'first))
6155 (all-p (eq mode 'all)))
6156 (let ((plural-str (if all-p "s" "")))
6157 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
6158 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
6159 If R-LIST is nil, return matching element%s of S-LIST.
6160 If PREDICATE is not nil, use it instead of `equal' to match VAL.
6161 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
6162 This function is generated by a call to the macro `org-define-lookup-function'."
6163 mode-str plural-str plural-str plural-str)
6164 (let ,(let ((lvars '((p (or predicate 'equal))
6165 (sl s-list)
6166 (rl (or r-list s-list))
6167 (ret nil))))
6168 (if first-p (cons '(match-p nil) lvars) lvars))
6169 (while ,(if first-p '(and (not match-p) sl) 'sl)
6170 (when (funcall p val (car sl))
6171 ,(when first-p '(setq match-p t))
6172 (let ((rval (car rl)))
6173 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
6174 (setq sl (cdr sl) rl (cdr rl)))
6175 ret)))))
6177 (org-define-lookup-function first)
6178 (org-define-lookup-function last)
6179 (org-define-lookup-function all)
6181 (provide 'org-table)
6183 ;; Local variables:
6184 ;; generated-autoload-file: "org-loaddefs.el"
6185 ;; End:
6187 ;;; org-table.el ends here