| blob | 0e035cb16d9299249d8db44639c6afc3042856aa |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2018 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:
77 "Hook for functions attaching to `C-c C-c', if the table is sent.
78 This can be used to add additional functionality after the table is sent
79 to the receiver position, otherwise, if table is not sent, the functions
85 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
87 In the optimized version, the table editor takes over all simple keys that
88 normally just insert a character. In tables, the characters are inserted
89 in a way to minimize disturbing the table structure (i.e. in overwrite mode
90 for empty fields). Outside tables, the correct binding of the keys is
91 restored.
93 Changing this variable requires a restart of Emacs to become
94 effective."
100 % END RECEIVE ORGTBL %n
102 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
103 | | |
106 @c END RECEIVE ORGTBL %n
107 @ignore
108 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
109 | | |
112 <!-- END RECEIVE ORGTBL %n -->
113 <!--
114 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
115 | | |
118 #+ END RECEIVE ORGTBL %n
120 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
121 | | |
123 "Templates for radio tables in different major modes.
124 Each template must define lines that will be treated as a comment and that
127 insertion of the template. The transformed table will later be inserted
128 between these lines.
130 The template should also contain a minimal table in a multiline comment.
131 If multiline comments are not possible in the buffer language,
132 you can pack it into a string that will not be used when the code
133 is compiled or executed. Above the table will you need a line with
135 convert the table into a data structure useful in the
136 language of the buffer. Check the manual for the section on
138 https://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
140 All occurrences of %n in a template will be replaced with the name of the
141 table, obtained by prompting the user."
148 "Settings for tables in Org mode."
153 "The default size for newly created tables, Columns x Rows."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
159 "Regular expression for recognizing numbers in table columns.
160 If a table column contains mostly numbers, it will be aligned to the
161 right. If not, it will be aligned to the left.
163 The default value of this option is a regular expression which allows
164 anything which looks remotely like a number as used in scientific
165 context. For example, all of the following will be considered a
166 number:
167 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
169 Other options offered by the customize interface are more restrictive."
183 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
184 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
185 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
189 "Fraction of numbers in a column required to make the column align right.
190 In a column all non-white fields are considered. If at least
191 this fraction of fields is matched by `org-table-number-regexp',
192 alignment to the right border applies."
197 "Behavior of tables during editing in Org mode."
202 "Non-nil means automatically re-align table when pressing TAB or RETURN.
204 removal/insertion."
209 "Non-nil means automatically blank table field when starting to type into it.
210 This only happens when typing immediately after a field motion
211 command (TAB, S-TAB or RET)."
216 "Non-nil means automatically exit the follow mode.
217 When nil, the follow mode will stay on and be active in any table
218 the cursor enters. Since the table follow filed mode messes with the
219 window configuration, it is not recommended to set this variable to nil,
220 except maybe locally in a special file that has mostly tables with long
221 fields."
227 "Whether the user should confirm when Org fixes formulas."
235 'safe-local-variable
239 "Non-nil means tab in the last column of a table with jump over a hline.
240 If a horizontal separator line is following the current line,
241 `org-table-next-field' can either create a new row before that line, or jump
242 over the line. When this option is nil, a new line will be created before
243 this line."
248 "Options concerning tables in Org mode."
253 "Non-nil means using table references like B3 instead of @3$2.
254 Possible values are:
255 nil never use them
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
265 "Non-nil means increment when copying current field with \
278 calc-angle-mode deg
279 calc-prefer-frac nil
280 calc-symbolic-mode nil
282 calc-display-working-message t
283 )
284 "List with Calc mode settings for use in `calc-eval' for table formulas.
285 The list must contain alternating symbols (Calc modes variables and values).
286 Don't remove any of the default settings, just change the values. Org mode
287 relies on the variables to be present in the list."
292 "Format for the output of calc computations like $1+$2;t.
293 The default value is `hours', and will output the results as a
294 number of hours. Other allowed values are `seconds', `minutes' and
295 `days', and the output will be a fraction of seconds, minutes or
296 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
297 The `U' flag in a table formula will select this specific format for
298 a single formula."
308 "Non-nil means hours in table duration computations should be zero-padded.
309 So this is about 08:32:34 versus 8:33:34."
317 "Format for fields which contain the result of a formula.
319 characters. Beware that modifying the display can prevent the
320 field from being used in another formula."
326 "Non-nil means TAB and RET evaluate a formula in current table field.
327 If the current field starts with an equal sign, it is assumed to be a formula
328 which should be evaluated as described in the manual and in the documentation
329 string of the command `org-table-eval-formula'. This feature requires the
330 Emacs calc package.
331 When this variable is nil, formula calculation is only available through
337 "Non-nil means interpret constants in formulas in tables.
338 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
339 by the value given in `org-table-formula-constants', or by a value obtained
340 from the `constants.el' package."
345 "Alist with constant names and values, for use in table formulas.
346 The car of each element is a name of a constant, without the `$' before it.
347 The cdr is the value as a string. For example, if you'd like to use the
348 speed of light in a formula, you would configure
352 and then use it in an equation like `$1*$c'.
354 Constants can also be defined on a per-file basis using a line like
356 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
363 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
366 are pressed in the line."
371 "Non-nil means relative formula references may cross hlines.
372 Here are the allowed values:
374 nil Relative references may not cross hlines. They will reference the
375 field next to the hline instead. Coming from below, the reference
376 will be to the field below the hline. Coming from above, it will be
377 to the field above.
378 t Relative references may cross hlines.
379 error An attempt to cross a hline will throw an error.
381 It is probably good to never set this variable to nil, for the sake of
382 portability of tables."
390 "Non-nil means evaluation of formula can add new columns.
391 When non-nil, evaluating an out-of-bounds field can insert as
392 many columns as needed. When set to `warn', issue a warning when
393 doing so. When set to `prompt', ask user before creating a new
394 column. Otherwise, throw an error."
405 "Options concerning table import and export in Org mode."
410 "Default export parameters for `org-table-export'.
411 These can be overridden for a specific table by setting the
412 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
413 radio tables for the different export transformations and
414 available parameters."
419 "Max lines that `org-table-convert-region' will attempt to process.
421 The function can be slow on larger regions; this safety feature
422 prevents it from hanging emacs."
429 "String to be displayed in a shrunk column."
453 "Alist with column names, derived from the `!' line.
457 "Regular expression matching the current column names.
461 "Alist with parameter names, derived from the `$' line.
465 "Alist with locations of named fields.
466 Associations follow the pattern (NAME LINE COLUMN) where
467 NAME is the name of the field as a string,
468 LINE is the number of lines from the beginning of the table,
469 COLUMN is the column of the field, as an integer.
473 "Table row types in current table.
477 "Current table begin position, as a marker.
481 "Number of columns in current table.
485 "Vector of data line line numbers in the current table.
486 Line numbers are counted from the beginning of the table. This
490 "Vector of hline line numbers in the current table.
491 Line numbers are counted from the beginning of the table. This
495 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
496 ;; 1 2 3 4 5
512 "Space used around fields when aligning the table.
513 This space serves as a segment separator for the purposes of the
517 "Save current field; execute BODY; restore field.
518 Field is restored even in case of abnormal exit."
530 "Expand all columns before executing BODY, then shrink them again."
543 ;;;###autoload
545 "Use the table.el package to insert a new table.
546 If there is already a table at point, convert between Org tables
547 and table.el tables."
560 ;;;###autoload
562 "Convert region to table, or create an empty table.
563 If there is an active region, convert it to a table, using the function
564 `org-table-convert-region'. See the documentation of that function
565 to learn how the prefix argument is interpreted to determine the field
566 separator.
567 If there is no such region, create an empty table with `org-table-create'."
573 ;;;###autoload
575 "Query for a size and insert a table skeleton.
595 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
599 ;; Insert a hline after the first row.
606 ;;;###autoload
608 "Convert region to a table.
610 The region goes from BEG0 to END0, but these borders will be moved
611 slightly, to make sure a beginning of line in the first line is included.
613 SEPARATOR specifies the field separator in the lines. It can have the
614 following values:
616 (4) Use the comma as a field separator
617 (16) Use a TAB as field separator
618 (64) Prompt for a regular expression as field separator
619 integer When a number, use that many spaces, or a TAB, as field separator
620 regexp When a regular expression, use it to match the separator
621 nil When nil, the command tries to be smart and figure out the
622 separator in the following way:
623 - when each line contains a TAB, assume TAB-separated material
624 - when each line contains a comma, assume CSV material
625 - else, assume one or more SPACE characters as separator."
629 re)
631 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
632 org-table-convert-region-max-lines)
641 ;; Get the right field separator
652 ;; parse the csv stuff
677 ;;;###autoload
679 "Import FILE as a table.
681 The command tries to be smart and figure out the separator in the
682 following way:
684 - when each line contains a TAB, assume TAB-separated material
685 - when each line contains a comma, assume CSV material
686 - else, assume one or more SPACE characters as separator.
688 When non-nil, SEPARATOR specifies the field separator in the
689 lines. It can have the following values:
691 (4) Use the comma as a field separator
692 (16) Use a TAB as field separator
693 (64) Prompt for a regular expression as field separator
694 integer When a number, use that many spaces, or a TAB, as field separator
695 regexp When a regular expression, use it to match the separator."
704 ;;;###autoload
706 "Export table to a file, with configurable format.
707 Such a file can be imported into usual spreadsheet programs.
709 FILE can be the output file name. If not given, it will be taken
710 from a TABLE_EXPORT_FILE property in the current entry or higher
711 up in the hierarchy, or the user will be prompted for a file
712 name. FORMAT can be an export format, of the same kind as it
713 used when `orgtbl-mode' sends a table in a different format.
715 The command suggests a format depending on TABLE_EXPORT_FORMAT,
716 whether it is set locally or up in the hierarchy, then on the
717 extension of the given file name, and finally on the variable
718 `org-table-export-default-format'."
751 formats)))
752 org-table-export-default-format)
778 "Marker at the beginning of the table last aligned.
781 "Marker at the end of the table last aligned.
784 "List of flags for flushright alignment, from the last re-alignment.
787 "List of max width of fields in each column.
790 "Non-nil means debug table formulas.
798 "Format FIELD according to column WIDTH and alignement ALIGN.
808 prefix
809 field
810 suffix
811 org-table-separator-space)))
813 ;;;###autoload
815 "Align the table at point by aligning all vertical bars."
820 ;; Make sure invisible characters in the table are at the right
821 ;; place since column widths take them into account.
828 ;; Table's rows as lists of fields. Rules are replaced
829 ;; by nil. Trailing spaces are removed.
835 ;; Compute number of columns. If the table contains no
836 ;; field, create a default table and bail out.
844 ;; Compute alignment and width for each column.
866 alignments)))
869 ;; Store alignment of this table, for later editing of single
870 ;; fields.
873 ;; Build new table rows. Only replace rows that actually
874 ;; changed.
879 indent
882 widths
891 cells
892 widths
893 alignments)
903 ;;;###autoload
905 "Find the beginning of the table and return its position.
906 With a non-nil optional argument TABLE-TYPE, return the beginning
907 of a table.el-type table. This function assumes point is on
908 a table."
916 ;;;###autoload
918 "Find the end of the table and return its position.
919 With a non-nil optional argument TABLE-TYPE, return the end of
920 a table.el-type table. This function assumes point is on
921 a table."
929 ;; When the line right after the table is the last line in
930 ;; the buffer with trailing spaces but no final newline
931 ;; character, be sure to catch the correct ending at its
932 ;; beginning. In any other case, ending is expected to be
933 ;; at point max.
938 ;;;###autoload
940 "Justify the current field, text to left, number to right.
941 Optional argument NEW may specify text to replace the current field content."
950 ;; This is not the same table, force a full re-align.
953 ;; Realign the current field, based on previous full realign.
986 ;;;###autoload
988 "Go to the next field in the current table, creating new lines as needed.
989 Before doing so, re-align the table if necessary."
994 org-table-may-need-update)
1005 org-table-tab-jumps-over-hlines
1016 ;;;###autoload
1018 "Go to the previous field in the table.
1019 Before doing so, re-align the table if necessary."
1024 org-table-may-need-update)
1042 "Move to the beginning of the current table field.
1043 If already at or before the beginning, move to the beginning of the
1044 previous field.
1045 With numeric argument N, move N-1 fields backward first."
1058 "Move to the end of the current table field.
1059 If already at or after the end, move to the end of the next table field.
1060 With numeric argument N, move N-1 fields forward first."
1073 ;;;###autoload
1075 "Go to the next row (same column) in the current table.
1076 Before doing so, re-align the table if necessary."
1081 org-table-may-need-update)
1093 ;;;###autoload
1095 "Copy the value of the current field one row below.
1097 If the field at the cursor is empty, copy the content of the
1098 nearest non-empty field above. With argument N, use the Nth
1099 non-empty field.
1101 If the current field is not empty, it is copied down to the next
1102 row, and the cursor is moved with it. Therefore, repeating this
1103 command causes the column to be filled row-by-row.
1105 If the variable `org-table-copy-increment' is non-nil and the
1106 field is an integer or a timestamp, it will be incremented while
1107 copying. By default, increment by the difference between the
1108 value in the current field and the one in the field above. To
1109 increment using a fixed integer, set `org-table-copy-increment'
1110 to a number. In the case of a timestamp, increment by days."
1122 txt txt-up inc)
1130 beg t))
1140 beg t))
1147 ;; Above field was not empty, go down to the next row
1180 "Non-nil when point is inside a table data field.
1181 Raise an error otherwise, unless NOERROR is non-nil. In that
1182 case, return nil if point is not inside a data field. When
1183 optional argument ASSUME-TABLE is non-nil, assume point is within
1184 a table."
1196 "Get the field in table line LINE, column COLUMN.
1197 If LINE is larger than the number of data lines in the table, the function
1198 returns nil. However, if COLUMN is too large, we will simply return an
1199 empty string.
1200 If LINE is nil, use the current line.
1201 If COLUMN is nil, use the current column."
1208 "Put VALUE into line LINE, column COLUMN.
1209 When ALIGN is set, also realign the table."
1218 "Return the index of the current data line."
1225 cnt))
1228 "Go to the Nth data line in the current table.
1229 Return t when the line exists, nil if it does not exist."
1236 ;;;###autoload
1238 "Blank the current table field or active region."
1255 "Return the value of the field in column N of current row.
1256 N defaults to current column. If REPLACE is a string, replace
1257 field with this value. The return value is always the old
1258 value."
1262 ;; Before first column or after last one.
1263 ""
1268 ;; Since we are going to remove any hidden field, do not rely
1269 ;; on `org-table--hidden-field' as it could be GC'ed before
1270 ;; second check.
1279 val)))
1281 ;;;###autoload
1283 "Show info about the current field, and highlight any reference at point."
1293 col)
1294 org-table-named-field-locations)))
1304 ;; Prioritize field formulas over column formulas.
1313 dline col
1315 dline col ref1
1317 ;; FIXME: formula info not correct if special table line
1324 ""
1330 "Find out which column we are in."
1336 column)))
1339 "Find out what table data line we are in.
1340 Only data lines count for this."
1348 c)))
1350 ;;;###autoload
1352 "Move the cursor to the Nth column in the current table line.
1353 With optional argument ON-DELIM, stop with point before the left delimiter
1354 of the field.
1355 If there are less than N fields, just go to after the last delimiter.
1356 However, when FORCE is non-nil, create new columns if necessary."
1366 t)))))
1373 ;;;###autoload
1375 "Insert a new column into the table."
1390 ;; Add missing vertical bar at the end of the row.
1397 ;; Shift appropriately stored shrunk column numbers, then hide the
1398 ;; columns again.
1400 shrunk-columns)
1401 beg end)
1403 ;; Fix TBLFM formulas, if desirable.
1410 "Find a data line in the current table, which is needed for column commands.
1411 This function assumes point is in a table. Raise an error when
1412 there is no data row below."
1422 t)))
1425 "Turn a buffer line number into a data line number.
1427 If there is no data line in this line, return nil.
1429 If there is no matching dline (most likely the reference was
1430 a hline), the first dline below it is used. When ABOVE is
1431 non-nil, the one above is used."
1436 nil)
1447 ;;;###autoload
1449 "Delete a column from the table."
1463 nil
1470 ;; Shift appropriately stored shrunk column numbers, then hide the
1471 ;; columns again.
1473 shrunk-columns)
1474 beg end)
1476 ;; Fix TBLFM formulas, if desirable.
1484 ;;;###autoload
1486 "Move column to the right."
1490 ;;;###autoload
1492 "Move column to the left."
1496 ;;;###autoload
1498 "Move the current column to the right. With arg LEFT, move to the left."
1526 ;; Shift appropriately stored shrunk column numbers, then shrink
1527 ;; the columns again.
1535 shrunk-columns)
1536 beg end)
1538 ;; Fix TBLFM formulas, if desirable.
1549 ;;;###autoload
1551 "Move table row down."
1555 ;;;###autoload
1557 "Move table row up."
1561 ;;;###autoload
1563 "Move the current table line down. With arg UP, move it up."
1572 hline2p)
1599 ;;;###autoload
1601 "Insert a new row above the current line into the table.
1602 With prefix ARG, insert below the current line."
1608 ;; Fix the first field if necessary
1612 ;; Buffer may not end of a newline character, so ensure
1613 ;; (beginning-of-line 2) moves point to a new line.
1624 ;;;###autoload
1626 "Insert a horizontal-line below the current line into the table.
1627 With prefix ABOVE, insert above the current line."
1648 ;;;###autoload
1650 "Insert a hline and move to the row below that line."
1664 In particular, this does handle wide and invisible characters."
1666 ;; It's a hline, just map the characters
1672 t t s)))
1673 s))
1675 ;;;###autoload
1677 "Delete the current row or horizontal line from the table."
1693 ;;;###autoload
1696 "Sort table lines according to the column at point.
1698 The position of point indicates the column to be used for
1699 sorting, and the range of lines is the range between the nearest
1700 horizontal separator lines, or the entire table of no such lines
1701 exist. If point is before the first column, you will be prompted
1702 for the sorting column. If there is an active region, the mark
1703 specifies the first line and the sorting column, while point
1704 should be in the last line to be included into the sorting.
1706 The command then prompts for the sorting type which can be
1707 alphabetically, numerically, or by time (as given in a time stamp
1708 in the field, or as a HH:MM value). Sorting in reverse order is
1709 also possible.
1711 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1713 If SORTING-TYPE is specified when this function is called from a Lisp
1714 program, no prompting will take place. SORTING-TYPE must be a character,
1715 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1716 sorting should be done in reverse order.
1718 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1719 a function to be called to extract the key. It must return a value
1720 that is compatible with COMPARE-FUNC, the function used to compare
1721 entries.
1723 A non-nil value for INTERACTIVE? is used to signal that this
1724 function is being called interactively."
1727 ;; Point must be either within a field or before a data line.
1732 ;; Set appropriate case sensitivity and column used for sorting.
1745 ;; Narrow buffer to appropriate sorting area.
1756 start))
1759 end)))
1760 ;; Determine arguments for `sort-subr'. Also record original
1761 ;; position. `org-table-save-field' cannot help here since
1762 ;; sorting is too much destructive.
1768 ;; Function to be called on the contents of the field
1769 ;; used for sorting in the current row.
1796 "Function for comparing keys (empty for default \
1797 `sort-subr' predicate): "
1807 #'end-of-line
1811 nil
1812 predicate)
1813 ;; Hide all columns but the one being sorted.
1815 ;; Move back to initial field.
1819 ;;;###autoload
1821 "Copy region in table to the clipboard and blank all relevant fields.
1822 If there is no active region, use just the field at point."
1828 ;;;###autoload
1830 "Copy rectangular region in table to clipboard.
1831 A special clipboard is used which can only be accessed
1832 with `org-table-paste-rectangle'."
1836 current-prefix-arg))
1841 region)
1853 ;; Collect every cell between COLUMN-START and COLUMN-END.
1863 ;;;###autoload
1865 "Paste a rectangular region into a table.
1866 The upper right corner ends up in the current field. All involved fields
1867 will be overwritten. If the rectangle does not fit into the present table,
1868 the table is enlarged as needed. The process ignores horizontal separator
1869 lines."
1879 ;; If we left the table, create a new row.
1891 ;;;###autoload
1893 "Convert from `org-mode' table to table.el and back.
1894 Obviously, this only works within limits. When an Org table is converted
1895 to table.el, all horizontal separator lines get lost, because table.el uses
1896 these as cell boundaries and has no notion of horizontal lines. A table.el
1897 table can be converted to an Org table only if it does not do row or column
1898 spanning. Multiline cells will become multiple cells. Beware, Org mode
1899 does not test if the table can be successfully converted - it blindly
1900 applies a recipe that works for simple tables."
1904 ;; convert to Org table
1913 ;; convert to table.el table
1916 ;; first, get rid of all horizontal lines
1920 ;; insert a hline before first
1924 ;; insert a hline after each line
1929 ;; replace "+" at beginning and ending of hlines
1938 "Transpose Org table at point and eliminate hlines.
1939 So a table like
1941 | 1 | 2 | 4 | 5 |
1942 |---+---+---+---|
1943 | a | b | c | d |
1944 | e | f | g | h |
1946 will be transposed as
1948 | 1 | a | e |
1949 | 2 | b | f |
1950 | 4 | c | g |
1951 | 5 | d | h |
1953 Note that horizontal lines disappear."
1965 table)))
1979 ;;;###autoload
1981 "Wrap several fields in a column like a paragraph.
1982 This is useful if you'd like to spread the contents of a field over several
1983 lines, in order to keep the table compact.
1985 If there is an active region, and both point and mark are in the same column,
1986 the text in the column is wrapped to minimum width for the given number of
1987 lines. Generally, this makes the table more compact. A prefix ARG may be
1988 used to change the number of desired lines. For example, \
1990 formats the selected text to two lines. If the region was longer than two
1991 lines, the remaining lines remain empty. A negative prefix argument reduces
1992 the current number of lines by that amount. The wrapped text is pasted back
1993 into the table. If you formatted it to more lines than it was before, fields
1994 further down in the table get overwritten - so you might need to make space in
1995 the table first.
1997 If there is no region, the current field is split at the cursor position and
1998 the text fragment to the right of the cursor is prepended to the field one
1999 line down.
2001 If there is no region, but you specify a prefix ARG, the current field gets
2002 blank, and the content is appended to the field above."
2006 ;; There is a region: fill as a paragraph.
2017 nil
2018 nlines))))
2021 ;; No region, split the current field at point.
2046 ;;;###autoload
2048 "Edit table field in a different window.
2049 This is mainly useful for fields that contain hidden parts.
2052 visible so that it can be edited in place.
2055 toggle `org-table-follow-field-mode'."
2077 p)
2099 "Finish editing a table data field.
2100 Remove all newline characters, insert the result into the table, realign
2101 the table and kill the editing buffer."
2105 text)
2122 "Minor mode to make the table field editor window follow the cursor.
2123 When this mode is active, the field editor window will always show the
2124 current field. The mode exits automatically when the cursor leaves the
2125 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2126 nil " TblFollow" nil
2142 ;; We have left the table, exit the follow mode
2152 ;;;###autoload
2154 "Sum numbers in region of current table column.
2155 The result will be displayed in the echo area, and will be available
2158 If there is an active region, it is interpreted as a rectangle and all
2159 numbers in that rectangle will be summed. If there is no active
2160 region and point is located in a table column, sum all numbers in that
2161 column.
2163 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2164 numbers are assumed to be times as well (in decimal hours) and the
2165 numbers are added as such.
2167 If NLAST is a number, only the NLAST fields will actually be summed."
2194 items1)))
2201 s diff)
2208 sres))))
2231 "Return the formula active for the current field.
2233 Assumes that table is already analyzed. If KEY is given, return
2234 the key to this formula. Otherwise return the formula preceded
2243 org-table-named-field-locations)))
2257 "Read a formula from the minibuffer, offer stored formula as default.
2258 When NAMED is non-nil, look for a named equation."
2263 org-table-named-field-locations)))
2276 stored)
2278 equation)
2284 scol))
2286 'org-table-formula-history
2287 )))))
2288 mustsave)
2290 ;; remove formula
2297 ;; We set the column equation, delete the named one.
2299 mustsave t))
2305 eq))
2308 "Store the list of formulas below the current table.
2309 If optional argument LOCATION is a buffer position, insert it at
2310 LOCATION instead."
2318 ;; Don't overwrite TBLFM, we might use text properties to
2319 ;; store stuff.
2333 ;; Fake a high number to make sure this is sorted at the end.
2340 a)
2350 "Compare two formulas for sorting."
2355 ;;;###autoload
2357 "Return an alist with the stored formulas directly after current table.
2358 By default, only return active formulas, i.e., formulas located
2359 on the first line after the table. However, if optional argument
2360 LOCATION is a buffer position, consider the formulas there."
2369 eq-alist seen)
2373 string)
2378 ;; Is it a column reference?
2380 ;; Since named columns are not possible in
2381 ;; LHS, assume this is a named field.
2389 "Double definition `%s=' in TBLFM line, please fix by hand"
2390 lhs)
2395 "Double definition `%s=' in TBLFM line, please fix by hand"
2396 lhs)))))))))))
2399 "Modify the equations after the table structure has been edited.
2401 For all numbers larger than LIMIT, shift them by DELTA."
2413 s n a)
2419 "Change makes TBLFM term %s invalid, use undo to recover"
2434 ;;;###autoload
2437 If yes, store the formula and apply it."
2438 ;; We already know we are in a table. Get field will only return a formula
2439 ;; when appropriate. It might return a separator line, but no problem.
2442 named eq)
2450 "List of commands triggering the recalculation of a line.
2462 ;;;###autoload
2464 "Rotate the recalculation mark in the first column.
2465 If in any row, the first field is not consistent with a mark,
2466 insert a new column for the markers.
2467 When there is an active region, change all the lines in the region,
2468 after prompting for the marking character.
2469 After each change, a message will be displayed indicating the meaning
2470 of the new mark."
2486 newchar))
2494 newchar))
2512 ;; Rotate mark in first row.
2514 ;; Rotate marks in additional rows if a region is active.
2522 ;; Only align if rotation actually changed lines' length.
2532 ;;;###autoload
2534 "Analyze table at point and store results.
2536 This function sets up the following dynamically scoped variables:
2538 `org-table-column-name-regexp',
2539 `org-table-column-names',
2540 `org-table-current-begin-pos',
2541 `org-table-current-line-types',
2542 `org-table-current-ncol',
2543 `org-table-dlines',
2544 `org-table-hlines',
2545 `org-table-local-parameters',
2546 `org-table-named-field-locations'."
2551 ;; Extract column names.
2564 ;; Extract local parameters.
2572 org-table-local-parameters)))))
2573 ;; Update named fields locations. We minimize `count-lines'
2574 ;; processing by storing last known number of lines in LAST.
2596 field))
2599 org-table-named-field-locations))))))))))
2600 ;; Re-use existing markers when possible.
2604 ;; Analyze the line types.
2615 ;; Get the number of columns from the first data line in table.
2623 al al2)
2637 "Move point to a specific field in the current table.
2639 REF is either the name of a field its absolute reference, as
2640 a string. No column is created unless CREATE-COLUMN-P is
2641 non-nil. If it is a function, it is called with the column
2642 number as its argument as is used as a predicate to know if the
2643 column can be created.
2645 This function assumes the table is already analyzed (i.e., using
2646 `org-table-analyze')."
2661 create-column-p)))
2667 ;;;###autoload
2669 "Recompute the current line if marked for it, and if we haven't just done it."
2689 org-tbl-calc-modes)
2691 ;;;###autoload
2693 suppress-align suppress-const
2694 suppress-store suppress-analysis)
2695 "Replace the table field value at the cursor by the result of a calculation.
2697 In a table, this command replaces the value in the current field with the
2699 formula, by storing it in a special line below the table. When called
2701 field formula.
2704 insert the active equation for the field
2705 back into the current field, so that it can be edited there. This is \
2706 useful
2708 check the referenced fields.
2710 When called, the command first prompts for a formula, which is read in
2711 the minibuffer. Previously entered formulas are available through the
2712 history list, and the last used formula is offered as a default.
2713 These stored formulas are adapted correctly when moving, inserting, or
2714 deleting columns with the corresponding commands.
2716 The formula can be any algebraic expression understood by the Calc package.
2717 For details, see the Org mode manual.
2719 This function can also be called from Lisp programs and offers
2720 additional arguments: EQUATION can be the formula to apply. If this
2721 argument is given, the user will not be prompted.
2723 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2724 unnecessary aligns.
2726 SUPPRESS-CONST suppresses the interpretation of constants in the
2727 formula, assuming that this has been done already outside the
2728 function.
2730 SUPPRESS-STORE means the formula should not be stored, either
2731 because it is already stored, or because it is a modified
2732 equation that should not overwrite the stored one.
2734 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2735 location of point."
2751 equation
2757 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2758 duration duration-output-format)
2759 ;; Parse the format string. Since we have a lot of modes, this is
2760 ;; a lot of work. However, I think calc still uses most of the time.
2773 'calc-float-format
2776 n))))
2781 duration-output-format
2810 ;; replace fields with duration values if relevant
2814 fields)))
2820 x))
2821 fields)))
2827 ;; Insert row and column number of formula result field
2838 t t form)))
2840 ;; Check for old vertical references
2842 ;; Insert remote references
2855 rmtrng))
2856 keep-empty numbers lispp))
2857 t t form)))
2858 ;; Insert complex ranges
2868 ;; possibly handle durations
2873 formrg)
2874 keep-empty numbers lispp)))
2879 ;; Insert simple ranges, i.e. included in the current row.
2882 form)
2893 keep-empty numbers lispp))
2894 t t form)))
2896 ;; Insert the references to fields in same row
2903 x keep-empty numbers lispp)))
2920 ;; Use <...> time-stamps so that Calc can handle them.
2923 ;; Internationalize local time-stamps by setting locale to
2924 ;; "C".
2927 org-ts-regexp
2935 form t t))
2938 form
2945 duration-output-format)
2946 ev)))
2951 Orig: %s
2952 $xyz-> %s
2953 @r$c-> %s
2976 ;; Replace any active time stamp in the result with
2977 ;; an inactive one. Dates in tables are likely
2978 ;; piece of regular data, not meant to appear in the
2979 ;; agenda.
2992 prop value)))
2995 "Get a calc vector from a column, according to descriptor DESC.
2997 Optional arguments TBEG and COL can give the beginning of the table and
2998 the current column, to avoid unnecessary parsing.
3000 HIGHLIGHT means just highlight the range.
3002 When CORNERS-ONLY is set, only return the corners of the range as
3003 a list (line1 column1 line2 column2) where line1 and line2 are
3004 line numbers relative to beginning of table, or TBEG, and column1
3005 and column2 are table column numbers."
3008 desc))
3019 thisline)))
3024 thisline)))
3036 ;; Just one field.
3043 ;; A range, return a vector. First sort the numbers to get
3044 ;; a regular rectangle.
3050 ;; Copy the range values into a list.
3065 ;; Return string representation of calc vector.
3071 "Return relative line number corresponding to descriptor DESC.
3072 The cursor is currently in relative line number CLINE."
3077 ;; 1 2 3 4 5 6
3078 desc))
3100 cline)))
3103 "Return relative line of Nth row with type TYPE.
3104 Search starts from relative line I. When BACKWARDS in non-nil,
3105 look before I. When RELATIVE is non-nil, the reference is
3106 relative. DESC is the original descriptor that started the
3107 search, as a string."
3115 ;; We are going to cross a hline. Check if this is
3116 ;; an authorized move.
3127 ;; The last hline doesn't exist. Instead, point to last row
3128 ;; in table.
3137 "Convert list ELEMENTS to something appropriate to insert into formula.
3138 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3139 NUMBERS indicates that everything should be converted to numbers.
3140 LISPP non-nil means to return something appropriate for a Lisp
3141 list, `literal' is for the format specifier L."
3142 ;; Calc nan (not a number) is used for the conversion of the empty
3143 ;; field to a reference for several reasons: (i) It is accepted in a
3144 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3145 ;; (ii) In a single field (not in range) it can be distinguished
3146 ;; from "(nan)" which is the reference made from a single field
3147 ;; containing "nan".
3149 ;; field reference
3152 elements
3154 ""
3163 ;; range reference
3168 elements))))
3174 x
3182 x)
3184 elements
3188 "If there has been more than one second since T1, display message.
3189 ARGS are passed as arguments to the `message' function. Returns
3190 current time if a message is printed, otherwise returns T1. If
3191 T1 is nil, always messages."
3195 curtime)
3196 t1)))
3198 ;;;###autoload
3200 "Recalculate the current table line by applying all stored formulas.
3202 With prefix arg ALL, do this for all lines in the table.
3205 if ALL is the symbol `iterate',
3206 recompute the table until it no longer changes.
3208 If NOALIGN is not nil, do not re-align the table after the computations
3209 are done. This is typically used internally to save time, if it is
3210 known that the table will be realigned a little later anyway."
3225 beg end eqlcol eqlfield)
3226 ;; Insert constants in all formulas.
3229 ;; Expand equations, then split the equation list between
3230 ;; column formulas and field formulas.
3242 old-lhs)))
3245 existing formula for column %s"
3246 old-lhs
3247 new))
3248 new))
3254 ;; Expand ranges in lhs of formulas
3256 ;; Get the correct line range to process.
3263 ;; This is a table with marked lines, compute selected
3264 ;; lines.
3266 ;; Move forward to the first non-header line.
3271 ;; Just leave BEG at the start of the table.
3276 ;; Mark named fields untouchable. Also check if several
3277 ;; field/range formulas try to set the same field.
3281 seen-fields)
3292 ;; Turn field coordinates associated to NAME
3293 ;; into an absolute reference.
3297 name)))
3300 reference))
3305 ;; Evaluate the column formulas, but skip fields covered by
3306 ;; field formulas.
3310 ;; Unprotected line, recalculate.
3315 log-last-time
3328 ;; Evaluate the field formulas.
3337 reference
3338 ;; Possibly create a new column, as long as
3339 ;; `org-table-formula-create-columns' allows it.
3351 t))
3358 ;; Clean up markers and internal text property.
3369 ;;;###autoload
3371 "Recalculate the table until it does not change anymore.
3372 The maximum number of iterations is 10, but you can choose a different value
3373 with the prefix ARG."
3378 thistbl)
3392 ;;;###autoload
3394 "Recalculate all tables in the current buffer."
3399 ;; Reason for separate `org-table-align': When repeating
3400 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3401 ;; the way.
3404 t)))
3406 ;;;###autoload
3408 "Iterate all tables in the buffer, to converge inter-table dependencies."
3413 c1)
3429 "Apply the #+TBLFM in the line at point to the table."
3436 ;; Insert a temporary formula at right after the table
3441 ;; Recalculate the table.
3446 ;; Delete the formula inserted temporarily.
3452 "Find the beginning of the TBLFM lines and return its position.
3453 Return nil when the beginning of TBLFM line was not found."
3460 "Expand list of formulas.
3461 If some of the RHS in the formulas are ranges or a row reference,
3462 expand them to individual field equations for each field. This
3463 function assumes the table is already analyzed (i.e., using
3464 `org-table-analyze')."
3471 ;; This just refers to one fixed field.
3474 ;; This just refers to one fixed named field.
3477 ;; Column formulas are treated specially and are not
3478 ;; expanded.
3483 rhs)
3484 res)))
3496 rhs)
3497 res))))))))))
3500 "Replace @<, @>, $<, $> with first/last row/column of the table.
3501 So @< and $< will always be replaced with @1 and $1, respectively.
3502 The advantage of these special markers are that structure editing of
3503 the table will not change them, while @1 and $1 will be modified
3504 when a line/row is swapped out of that privileged position. So for
3505 formulas that use a range of rows or columns, it may often be better
3507 borders of the table using the @< @> $< $> makers."
3510 s start)
3515 org-table-current-ncol)
3519 len
3526 s)
3529 "Replace $const with values in string F."
3534 org-table-column-name-regexp
3537 org-table-column-names))))
3538 f t t)))
3539 ;; Parameters and constants.
3543 new start))
3546 ;; When a duration is expected, convert value on the fly.
3552 v)))))
3559 "Find the value for a parameter or constant in a formula.
3560 Parameters get priority."
3591 map))
3598 "--"
3601 "--"
3602 "Shift Reference at Point"
3607 "-"
3608 "Change Test Row for Column Formulas"
3611 "--"
3616 org-table-overlay-coordinates)]
3617 "--"
3625 ;;;###autoload
3627 "Edit the formulas of the current table in a separate buffer."
3633 ;; Move point within the table before analyzing it.
3649 ;; Keep global-font-lock-mode from turning on font-lock-mode
3694 "Convert a formula from internal to user representation."
3697 s))
3700 "Convert a formula from user to internal representation."
3703 s))
3706 "Convert spreadsheet references from A7 to @7$28.
3707 Works for single references, but also for entire formulas and even the
3708 full TBLFM line."
3710 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3713 ;; format match, just advance
3718 ;; 3.e5 or something like this.
3721 ;; (member (match-string 1 s)
3722 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3723 )
3724 ;; function name, just advance
3734 t t s)))))
3735 s))
3738 "Convert spreadsheet references from to @7$28 to AB7.
3739 Works for single references, but also for entire formulas and even the
3740 full TBLFM line."
3747 t t s)))
3752 t nil s)))
3753 s)
3756 "Convert a base 26 number represented by letters into an integer.
3757 For example: AB -> 28."
3763 n))
3766 "Convert an integer into a base 26 number represented by letters.
3767 For example: 28 -> AB."
3772 s))
3775 "Convert a time string into numerical duration in seconds.
3776 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3777 If S is a string representing a number, keep this number."
3779 s
3802 "Convert a number of seconds to a time string.
3803 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3804 minutes or seconds."
3816 ;; Ignore seconds
3820 secs0)
3825 secs0)))))
3829 \f
3830 ;;; Columns shrinking
3833 "Non-nil if current field is narrowed.
3834 When non-nil, return the overlay narrowing the field."
3837 o))
3841 "List currently shrunk columns in table at point."
3843 ;; We really check shrunk columns in current row only. It could
3844 ;; be wrong if all rows do not contain the same number of columns
3845 ;; (i.e. the table is not properly aligned). As a consequence,
3846 ;; some columns may not be shrunk again upon aligning the table.
3847 ;;
3848 ;; For example, in the following table, cursor is on first row and
3849 ;; "<>" indicates a shrunk column.
3850 ;;
3851 ;; | |
3852 ;; | | <> |
3853 ;;
3854 ;; Aligning table from the first row will not shrink again the
3855 ;; second row, which was not visible initially.
3856 ;;
3857 ;; However, fixing it requires to check every row, which may be
3858 ;; slow on large tables. Moreover, the hindrance of this
3859 ;; pathological case is very limited.
3872 "Shrink a table field to a specified width.
3874 WIDTH is an integer representing the number of characters to
3875 display, in addition to `org-table-shrunk-column-indicator'. START
3876 and END are, respectively, the beginning and ending positions of
3877 the field. CONTENTS is its trimmed contents, as a string, or
3878 `hline' for table rules.
3880 Real field is hidden under an overlay. The latter has the
3881 following properties:
3883 `org-overlay-type'
3885 Set to `table-column-hide'. Used to identify overlays
3886 responsible for the task.
3888 `org-table-column-overlays'
3890 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3891 where COLUMN-OVERLAYS is the list of all overlays hiding the
3892 same column.
3894 Whenever the text behind or next to the overlay is modified, all
3895 the overlays in the column are deleted, effectively displaying
3896 the column again.
3898 Return overlay used to hide the field."
3905 org-table-shrunk-column-indicator))
3907 ;; Remove invisible parts from links in CONTENTS. Since
3908 ;; shrinking could happen before first fontification
3909 ;; (e.g., using a #+STARTUP keyword), this cannot be done
3910 ;; using text properties.
3914 ;; Expand field.
3916 contents
3918 org-table-shrunk-column-indicator)
3919 ;; Truncate field.
3922 org-table-shrunk-column-indicator))))))
3925 ;; Removing one overlay removes all other overlays
3926 ;; in the same column.
3935 ;; Make sure overlays stays on top of table coordinates
3936 ;; overlays. See `org-table-overlay-coordinates'.
3939 o)))
3942 "Read column selection select as a list of numbers.
3944 SELECT is a string containing column ranges, separated by white
3945 space characters, see `org-table-hide-column' for details. MAX
3946 is the maximum column number.
3948 Return value is a sorted list of numbers. Ignore any number
3949 outside of the [1;MAX] range."
3966 max))))
3969 #'<)))
3972 "Shrink COLUMNS in an Org table.
3973 COLUMNS is a sorted list of column numbers. BEG and END are,
3974 respectively, the beginning position and the end position of the
3975 table."
3986 ;; Move to COLUMN.
3991 ;; Extract boundaries and contents from current field.
3992 ;; Also set the column's width if we encounter a width
3993 ;; cookie for the first time.
4007 ;; Link overlay to the other overlays in the same column.
4014 ;;;###autoload
4016 "Shrink or expand current column in an Org table.
4018 If a width cookie specifies a width W for the column, the first
4019 W visible characters are displayed. Otherwise, the column is
4020 shrunk to a single character.
4022 When point is before the first column or after the last one, ask
4023 for the columns to shrink or expand, as a list of ranges.
4024 A column range can be one of the following patterns:
4026 N column N only
4027 N-M every column between N and M (both inclusive)
4028 N- every column between N (inclusive) and the last column
4029 -M every column between the first one and M (inclusive)
4030 - every column
4032 When optional argument ARG is a string, use it as white space
4033 separated list of column ranges.
4036 `org-table-shrink', i.e.,
4037 shrink columns with a width cookie and expand the others.
4040 prefix, expand all columns."
4046 ;; Compute an upper bound for the number of columns.
4047 ;; Nonexistent columns are ignored anyway.
4052 (`nil
4056 ;; Point is either before first column or past last
4057 ;; one. Ask for columns to operate on.
4060 max-columns)
4061 ;; Find current column, even when on a hline.
4078 ;; Move before overlay if point is under it.
4082 ;;;###autoload
4084 "Shrink all columns with a width cookie in the table at point.
4086 Columns without a width cookie are expanded.
4088 Optional arguments BEGIN and END, when non-nil, specify the
4089 beginning and end position of the current table."
4102 ;; Make sure invisible characters in the table are at the right
4103 ;; place since column widths take them into account.
4107 ;;;###autoload
4109 "Expand all columns in the table at point.
4110 Optional arguments BEGIN and END, when non-nil, specify the
4111 beginning and end position of the current table."
4120 \f
4121 ;;; Formula editing
4124 "Convert all references in this buffer, using FUNCTION."
4135 "Convert all references in the buffer from B3 to @3$2 and back."
4145 "Shift the reference at point one row/hline up."
4149 "Shift the reference at point one row/hline down."
4153 "Shift the reference at point one field to the left."
4157 "Shift the reference at point one field to the right."
4168 ;; A B3-like reference
4174 ;; An internal reference
4180 "Re-match the group N, and replace it with the shifted reference."
4185 t t)))
4188 "Shift a reference part REF.
4189 If DECR is set, decrease the references row/column, else increase.
4190 If HLINE is set, this may be a hline reference, it certainly is not
4191 a translation reference."
4220 "Toggle the display of coordinates in the referenced table."
4229 "Parse the buffer for formula definitions and install them.
4230 With prefix ARG, apply the new formulas to the table."
4239 eql)
4242 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4243 nil t)
4264 "Abort editing formulas, without installing the changes."
4275 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4316 "Show the location/value of the $ expression at point.
4317 When LOCAL is non-nil, show references for the table at point."
4327 var name e what match dest)
4331 "$1.."
4383 dest)
4409 ;; Column number.
4435 org-table-fedit-scroll-down))))
4447 "Move point to the closest data line in a table.
4448 Raise an error if the table contains no data line. Preserve
4449 column when moving point."
4457 p1
4458 p2)))
4464 "Move cursor one line up in the window showing the table."
4469 "Move cursor one line down in the window showing the table."
4474 "Move the cursor in the window showing the table.
4475 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4500 "Add a new overlay."
4506 "Highlight rectangular region in a table.
4507 When buffer positions BEG and END are provided, use them to
4508 delimit the region to highlight. Otherwise, refer to point. Use
4509 FACE, when non-nil, for the highlight."
4541 "Remove the rectangle overlays."
4551 "Add overlays to the table at point, to show row/column coordinates."
4579 ;;;###autoload
4581 "Toggle the display of Row/Column numbers in tables."
4592 ;;;###autoload
4594 "Toggle the formula debugger in tables."
4600 ;;; The orgtbl minor mode
4602 ;; Define a minor mode which can be used in other modes in order to
4603 ;; integrate the Org table editor.
4605 ;; This is really a hack, because the Org table editor uses several
4606 ;; keys which normally belong to the major mode, for example the TAB
4607 ;; and RET keys. Here is how it works: The minor mode defines all the
4608 ;; keys necessary to operate the table editor, but wraps the commands
4609 ;; into a function which tests if the cursor is currently inside
4610 ;; a table. If that is the case, the table editor command is
4611 ;; executed. However, when any of those keys is used outside a table,
4612 ;; the function uses `key-binding' to look up if the key has an
4613 ;; associated command in another currently active keymap (minor modes,
4614 ;; major mode, global), and executes that command. There might be
4615 ;; problems if any of the keys used by the table editor is otherwise
4616 ;; used as a prefix key.
4618 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4619 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4620 ;; addresses this by checking explicitly for both bindings.
4622 ;; The optimized version (see variable `orgtbl-optimized') takes over
4623 ;; all keys which are bound to `self-insert-command' in the *global map*.
4624 ;; Some modes bind other commands to simple characters, for example
4625 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4626 ;; active, this binding is ignored inside tables and replaced with a
4627 ;; modified self-insert.
4645 ;; Install it as a minor mode.
4649 ;;;###autoload
4651 "The Org mode table editor as a minor mode for use in other modes."
4656 ;; Exit without error, in case some hook functions calls this by
4657 ;; accident in Org mode.
4661 ;; Make sure we are first in minor-mode-map-alist
4663 ;; FIXME: maybe it should use emulation-mode-map-alists?
4670 auto-fill-inhibit-regexp)
4674 auto-fill-inhibit-regexp)
4675 orgtbl-line-start-regexp))
4690 "Create a function for binding in the table minor mode.
4691 FUN is the command to call inside a table. N is used to create a unique
4692 command name. KEYS are keys that should be checked in for a command
4693 to execute outside of tables."
4699 "Outside of tables, run the binding of `"
4711 keys)
4715 "Error when there is no default binding for a table key."
4720 "Setup orgtbl keymaps."
4751 elt key fun cmd)
4759 ;; Special treatment needed for TAB, RET and DEL
4772 (orgtbl-make-binding 'org-delete-backward-char 109
4778 [(tab)] "\C-i"))
4780 (org-defkey orgtbl-mode-map [backtab]
4782 [backtab] [S-iso-lefttab] [(shift tab)]
4783 [(tab)] "\C-i"))
4785 (org-defkey orgtbl-mode-map "\M-\C-m"
4786 (orgtbl-make-binding 'org-table-wrap-region 105
4787 "\M-\C-m" [(meta return)]))
4788 (org-defkey orgtbl-mode-map [(meta return)]
4789 (orgtbl-make-binding 'org-table-wrap-region 106
4790 [(meta return)] "\M-\C-m"))
4792 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4793 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4795 (when orgtbl-optimized
4796 ;; If the user wants maximum table support, we need to hijack
4797 ;; some standard editing functions
4798 (org-remap orgtbl-mode-map
4799 'self-insert-command 'orgtbl-self-insert-command
4800 'delete-char 'org-delete-char
4801 'delete-backward-char 'org-delete-backward-char)
4802 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4803 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4804 '("OrgTbl"
4805 ["Create or convert" org-table-create-or-convert-from-region
4806 :active (not (org-at-table-p)) :keys "C-c |" ]
4807 "--"
4808 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4809 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4810 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4811 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4812 "--"
4813 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4814 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4815 ["Copy Field from Above"
4816 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4817 "--"
4818 ("Column"
4819 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4820 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4821 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4822 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4823 ("Row"
4824 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4825 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4826 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4827 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4828 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4829 "--"
4830 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4831 ("Rectangle"
4832 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4833 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4834 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4835 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4836 "--"
4837 ("Radio tables"
4838 ["Insert table template" orgtbl-insert-radio-table
4839 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4840 ["Comment/uncomment table" orgtbl-toggle-comment t])
4841 "--"
4842 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4843 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4844 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4845 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4846 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4847 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4848 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4849 ["Sum Column/Rectangle" org-table-sum
4850 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4851 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4852 ["Debug Formulas"
4853 org-table-toggle-formula-debugger :active (org-at-table-p)
4854 :keys "C-c {"
4855 :style toggle :selected org-table-formula-debug]
4856 ["Show Col/Row Numbers"
4857 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4858 :keys "C-c }"
4859 :style toggle :selected org-table-overlay-coordinates]
4860 "--"
4861 ("Plot"
4864 t))
4866 (defun orgtbl-ctrl-c-ctrl-c (arg)
4867 "If the cursor is inside a table, realign the table.
4868 If it is a table to be sent away to a receiver, do it.
4869 With prefix arg, also recompute table."
4870 (interactive "P")
4871 (let ((case-fold-search t) (pos (point)) action)
4872 (save-excursion
4873 (beginning-of-line 1)
4874 (setq action (cond
4878 (cond
4879 ((integerp action)
4880 (goto-char action)
4881 (org-table-maybe-eval-formula)
4882 (if arg
4883 (call-interactively 'org-table-recalculate)
4884 (org-table-maybe-recalculate-line))
4885 (call-interactively 'org-table-align)
4886 (when (orgtbl-send-table 'maybe)
4887 (run-hooks 'orgtbl-after-send-table-hook)))
4888 ((eq action 'recalc)
4889 (save-excursion
4890 (beginning-of-line 1)
4892 (if (org-at-table-p)
4893 (org-call-with-arg 'org-table-recalculate t))))
4894 (t (let (orgtbl-mode)
4895 (call-interactively (key-binding "\C-c\C-c")))))))
4897 (defun orgtbl-create-or-convert-from-region (_arg)
4898 "Create table or convert region to table, if no conflicting binding.
4899 This installs the table binding `C-c |', but only if there is no
4900 conflicting binding to this key outside orgtbl-mode."
4901 (interactive "P")
4902 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4903 (if cmd
4904 (call-interactively cmd)
4905 (call-interactively 'org-table-create-or-convert-from-region))))
4907 (defun orgtbl-tab (arg)
4908 "Justification and field motion for `orgtbl-mode'."
4909 (interactive "P")
4910 (if arg (org-table-edit-field t)
4911 (org-table-justify-field-maybe)
4912 (org-table-next-field)))
4914 (defun orgtbl-ret ()
4915 "Justification and field motion for `orgtbl-mode'."
4916 (interactive)
4917 (if (bobp)
4918 (newline)
4919 (org-table-justify-field-maybe)
4920 (org-table-next-row)))
4922 (defun orgtbl-self-insert-command (N)
4923 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4924 If the cursor is in a table looking at whitespace, the whitespace is
4925 overwritten, and the table is not marked as requiring realignment."
4926 (interactive "p")
4927 (if (and (org-at-table-p)
4928 (or
4929 (and org-table-auto-blank-field
4930 (member last-command
4931 '(orgtbl-hijacker-command-100
4932 orgtbl-hijacker-command-101
4933 orgtbl-hijacker-command-102
4934 orgtbl-hijacker-command-103
4935 orgtbl-hijacker-command-104
4936 orgtbl-hijacker-command-105
4937 yas/expand))
4938 (org-table-blank-field))
4939 t)
4940 (eq N 1)
4942 (let (org-table-may-need-update)
4943 (delete-region (match-beginning 1) (match-end 1))
4944 (self-insert-command N))
4945 (setq org-table-may-need-update t)
4946 (let* (orgtbl-mode
4947 a
4948 (cmd (or (key-binding
4949 (or (and (listp function-key-map)
4950 (setq a (assoc last-input-event function-key-map))
4951 (cdr a))
4952 (vector last-input-event)))
4953 'self-insert-command)))
4954 (call-interactively cmd)
4955 (if (and org-self-insert-cluster-for-undo
4956 (eq cmd 'self-insert-command))
4957 (if (not (eq last-command 'orgtbl-self-insert-command))
4958 (setq org-self-insert-command-undo-counter 1)
4959 (if (>= org-self-insert-command-undo-counter 20)
4960 (setq org-self-insert-command-undo-counter 1)
4961 (and (> org-self-insert-command-undo-counter 0)
4962 buffer-undo-list
4963 (not (cadr buffer-undo-list)) ; remove nil entry
4964 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4965 (setq org-self-insert-command-undo-counter
4966 (1+ org-self-insert-command-undo-counter))))))))
4968 ;;;###autoload
4970 "Regular expression matching exponentials as produced by calc.")
4972 (defun orgtbl-gather-send-defs ()
4973 "Gather a plist of :name, :transform, :params for each destination before
4974 a radio table."
4975 (save-excursion
4976 (goto-char (org-table-begin))
4977 (let (rtn)
4978 (beginning-of-line 0)
4979 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4980 (let ((name (org-no-properties (match-string 1)))
4981 (transform (intern (match-string 2)))
4982 (params (if (match-end 3)
4983 (read (concat "(" (match-string 3) ")")))))
4984 (push (list :name name :transform transform :params params)
4985 rtn)
4986 (beginning-of-line 0)))
4987 rtn)))
4989 (defun orgtbl-send-replace-tbl (name text)
4990 "Find and replace table NAME with TEXT."
4991 (save-excursion
4992 (goto-char (point-min))
4993 (let* ((location-flag nil)
4994 (name (regexp-quote name))
4997 (while (re-search-forward begin-re nil t)
4998 (unless location-flag (setq location-flag t))
4999 (let ((beg (line-beginning-position 2)))
5000 (unless (re-search-forward end-re nil t)
5001 (user-error "Cannot find end of receiver location at %d" beg))
5002 (beginning-of-line)
5003 (delete-region beg (point))
5005 (unless location-flag
5006 (user-error "No valid receiver location found in the buffer")))))
5008 ;;;###autoload
5009 (defun org-table-to-lisp (&optional txt)
5010 "Convert the table at point to a Lisp structure.
5011 The structure will be a list. Each item is either the symbol `hline'
5012 for a horizontal separator line, or a list of field values as strings.
5013 The table is taken from the parameter TXT, or from the buffer at point."
5014 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5015 (let ((txt (or txt
5016 (buffer-substring-no-properties (org-table-begin)
5017 (org-table-end)))))
5018 (mapcar (lambda (x)
5019 (if (string-match org-table-hline-regexp x) 'hline
5023 (defun orgtbl-send-table (&optional maybe)
5024 "Send a transformed version of table at point to the receiver position.
5025 With argument MAYBE, fail quietly if no transformation is defined
5026 for this table."
5027 (interactive)
5028 (catch 'exit
5029 (unless (org-at-table-p) (user-error "Not at a table"))
5030 ;; when non-interactive, we assume align has just happened.
5031 (when (called-interactively-p 'any) (org-table-align))
5032 (let ((dests (orgtbl-gather-send-defs))
5033 (table (org-table-to-lisp
5034 (buffer-substring-no-properties (org-table-begin)
5035 (org-table-end))))
5036 (ntbl 0))
5037 (unless dests
5038 (if maybe (throw 'exit nil)
5039 (user-error "Don't know how to transform this table")))
5040 (dolist (dest dests)
5041 (let ((name (plist-get dest :name))
5042 (transform (plist-get dest :transform))
5043 (params (plist-get dest :params)))
5044 (unless (fboundp transform)
5045 (user-error "No such transformation function %s" transform))
5046 (orgtbl-send-replace-tbl name (funcall transform table params)))
5047 (cl-incf ntbl))
5048 (message "Table converted and installed at %d receiver location%s"
5049 ntbl (if (> ntbl 1) "s" ""))
5050 (and (> ntbl 0) ntbl))))
5052 (defun org-remove-by-index (list indices &optional i0)
5053 "Remove the elements in LIST with indices in INDICES.
5054 First element has index 0, or I0 if given."
5055 (if (not indices)
5056 list
5057 (if (integerp indices) (setq indices (list indices)))
5058 (setq i0 (1- (or i0 0)))
5059 (delq :rm (mapcar (lambda (x)
5060 (setq i0 (1+ i0))
5061 (if (memq i0 indices) :rm x))
5062 list))))
5064 (defun orgtbl-toggle-comment ()
5065 "Comment or uncomment the orgtbl at point."
5066 (interactive)
5067 (let* ((case-fold-search t)
5068 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5069 (re2 (concat "^" orgtbl-line-start-regexp))
5070 (commented (save-excursion (beginning-of-line 1)
5071 (cond ((looking-at re1) t)
5072 ((looking-at re2) nil)
5073 (t (user-error "Not at an org table")))))
5074 (re (if commented re1 re2))
5075 beg end)
5076 (save-excursion
5077 (beginning-of-line 1)
5078 (while (looking-at re) (beginning-of-line 0))
5079 (beginning-of-line 2)
5080 (setq beg (point))
5081 (while (looking-at re) (beginning-of-line 2))
5082 (setq end (point)))
5083 (comment-region beg end (if commented '(4) nil))))
5085 (defun orgtbl-insert-radio-table ()
5086 "Insert a radio table template appropriate for this major mode."
5087 (interactive)
5088 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5089 (txt (nth 1 e))
5090 name pos)
5091 (unless e (user-error "No radio table setup defined for %s" major-mode))
5092 (setq name (read-string "Table name: "))
5093 (while (string-match "%n" txt)
5094 (setq txt (replace-match name t t txt)))
5096 (setq pos (point))
5097 (insert txt)
5098 (goto-char pos)))
5100 ;;;###autoload
5101 (defun orgtbl-to-generic (table params)
5102 "Convert the orgtbl-mode TABLE to some other format.
5104 This generic routine can be used for many standard cases.
5106 TABLE is a list, each entry either the symbol `hline' for
5107 a horizontal separator line, or a list of fields for that
5108 line. PARAMS is a property list of parameters that can
5109 influence the conversion.
5111 Valid parameters are:
5113 :backend, :raw
5115 Export back-end used as a basis to transcode elements of the
5116 table, when no specific parameter applies to it. It is also
5117 used to translate cells contents. You can prevent this by
5118 setting :raw property to a non-nil value.
5120 :splice
5122 When non-nil, only convert rows, not the table itself. This is
5123 equivalent to setting to the empty string both :tstart
5124 and :tend, which see.
5126 :skip
5128 When set to an integer N, skip the first N lines of the table.
5129 Horizontal separation lines do count for this parameter!
5131 :skipcols
5133 List of columns that should be skipped. If the table has
5134 a column with calculation marks, that column is automatically
5135 discarded beforehand.
5137 :hline
5139 String to be inserted on horizontal separation lines. May be
5140 nil to ignore these lines altogether.
5142 :sep
5144 Separator between two fields, as a string.
5146 Each in the following group may be either a string or a function
5147 of no arguments returning a string:
5149 :tstart, :tend
5151 Strings to start and end the table. Ignored when :splice is t.
5153 :lstart, :lend
5155 Strings to start and end a new table line.
5157 :llstart, :llend
5159 Strings to start and end the last table line. Default,
5160 respectively, to :lstart and :lend.
5162 Each in the following group may be a string or a function of one
5163 argument (either the cells in the current row, as a list of
5164 strings, or the current cell) returning a string:
5166 :lfmt
5168 Format string for an entire row, with enough %s to capture all
5169 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5171 :llfmt
5173 Format for the entire last line, defaults to :lfmt.
5175 :fmt
5177 A format to be used to wrap the field, should contain %s for
5178 the original field value. For example, to wrap everything in
5180 a property list with column numbers and format strings, or
5181 functions, e.g.,
5185 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5187 Same as above, specific for the header lines in the table.
5188 All lines before the first hline are treated as header. If
5189 any of these is not present, the data line value is used.
5191 This may be either a string or a function of two arguments:
5193 :efmt
5195 Use this format to print numbers with exponential. The format
5196 should have %s twice for inserting mantissa and exponent, for
5198 list with column numbers and format strings or functions.
5199 :fmt will still be applied after :efmt."
5200 ;; Make sure `org-export-create-backend' is available.
5201 (require 'ox)
5202 (let* ((backend (plist-get params :backend))
5203 (custom-backend
5204 ;; Build a custom back-end according to PARAMS. Before
5205 ;; defining a translator, check if there is anything to do.
5206 ;; When there isn't, let BACKEND handle the element.
5207 (org-export-create-backend
5208 :parent (or backend 'org)
5209 :transcoders
5210 `((table . ,(org-table--to-generic-table params))
5211 (table-row . ,(org-table--to-generic-row params))
5212 (table-cell . ,(org-table--to-generic-cell params))
5213 ;; Macros are not going to be expanded. However, no
5214 ;; regular back-end has a transcoder for them. We
5215 ;; provide one so they are not ignored, but displayed
5216 ;; as-is instead.
5217 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5218 data info)
5219 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5220 ;; Initialize communication channel in INFO.
5221 (with-temp-buffer
5222 (let ((org-inhibit-startup t)) (org-mode))
5223 (let ((standard-output (current-buffer))
5224 (org-element-use-cache nil))
5225 (dolist (e table)
5227 ((consp e)
5228 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5230 ;; Add back-end specific filters, but not user-defined ones. In
5231 ;; particular, make sure to call parse-tree filters on the
5232 ;; table.
5233 (setq info
5234 (let ((org-export-filters-alist nil))
5235 (org-export-install-filters
5236 (org-combine-plists
5237 (org-export-get-environment backend nil params)
5238 `(:back-end ,(org-export-get-backend backend))))))
5239 (setq data
5240 (org-export-filter-apply-functions
5241 (plist-get info :filter-parse-tree)
5242 (org-element-map (org-element-parse-buffer) 'table
5243 #'identity nil t)
5244 info)))
5245 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5246 (user-error "Unknown :backend value"))
5247 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5248 ;; Handle :skip parameter.
5249 (let ((skip (plist-get info :skip)))
5250 (when skip
5251 (unless (wholenump skip) (user-error "Wrong :skip value"))
5252 (let ((n 0))
5253 (org-element-map data 'table-row
5254 (lambda (row)
5255 (if (>= n skip) t
5256 (org-element-extract-element row)
5257 (cl-incf n)
5258 nil))
5259 nil t))))
5260 ;; Handle :skipcols parameter.
5261 (let ((skipcols (plist-get info :skipcols)))
5262 (when skipcols
5263 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5264 (org-element-map data 'table
5265 (lambda (table)
5266 (let ((specialp (org-export-table-has-special-column-p table)))
5267 (dolist (row (org-element-contents table))
5268 (when (eq (org-element-property :type row) 'standard)
5269 (let ((c 1))
5270 (dolist (cell (nthcdr (if specialp 1 0)
5271 (org-element-contents row)))
5272 (when (memq c skipcols)
5273 (org-element-extract-element cell))
5274 (cl-incf c))))))))))
5275 ;; Since we are going to export using a low-level mechanism,
5276 ;; ignore special column and special rows manually.
5277 (let ((special? (org-export-table-has-special-column-p data))
5278 ignore)
5279 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5280 (lambda (datum)
5281 (when (if (eq (org-element-type datum) 'table-row)
5282 (org-export-table-row-is-special-p datum nil)
5283 (org-export-first-sibling-p datum nil))
5284 (push datum ignore))))
5285 (setq info (plist-put info :ignore-list ignore)))
5286 ;; We use a low-level mechanism to export DATA so as to skip all
5287 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5288 ;; code evaluation, include keywords and macro expansion. Only
5289 ;; back-end specific filters are retained.
5290 (let ((output (org-export-data-with-backend data custom-backend info)))
5291 ;; Remove final newline.
5292 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5294 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5295 (cond ((null value) nil)
5296 ((functionp value) `(funcall ',value ,@args))
5297 ((stringp value)
5298 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5299 (args `(format ,value ,@args))
5300 (t value)))
5301 ((and with-cons (consp value))
5302 `(let ((val (cadr (memq column ',value))))
5303 (cond ((null val) contents)
5304 ((stringp val) (format val ,@args))
5305 ((functionp val) (funcall val ,@args))
5306 (t (user-error "Wrong %s value" ,name)))))
5307 (t (user-error "Wrong %s value" name))))
5309 (defun org-table--to-generic-table (params)
5310 "Return custom table transcoder according to PARAMS.
5311 PARAMS is a plist. See `orgtbl-to-generic' for more
5312 information."
5313 (let ((backend (plist-get params :backend))
5314 (splice (plist-get params :splice))
5315 (tstart (plist-get params :tstart))
5316 (tend (plist-get params :tend)))
5317 `(lambda (table contents info)
5318 (concat
5319 ,(and tstart (not splice)
5321 ,(if (or (not backend) tstart tend splice) 'contents
5322 `(org-export-with-backend ',backend table contents info))
5323 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5325 (defun org-table--to-generic-row (params)
5326 "Return custom table row transcoder according to PARAMS.
5327 PARAMS is a plist. See `orgtbl-to-generic' for more
5328 information."
5329 (let* ((backend (plist-get params :backend))
5330 (lstart (plist-get params :lstart))
5331 (llstart (plist-get params :llstart))
5332 (hlstart (plist-get params :hlstart))
5333 (hllstart (plist-get params :hllstart))
5334 (lend (plist-get params :lend))
5335 (llend (plist-get params :llend))
5336 (hlend (plist-get params :hlend))
5337 (hllend (plist-get params :hllend))
5338 (lfmt (plist-get params :lfmt))
5339 (llfmt (plist-get params :llfmt))
5340 (hlfmt (plist-get params :hlfmt))
5341 (hllfmt (plist-get params :hllfmt)))
5342 `(lambda (row contents info)
5343 (if (eq (org-element-property :type row) 'rule)
5344 ,(cond
5345 ((plist-member params :hline)
5346 (org-table--generic-apply (plist-get params :hline) ":hline"))
5347 (backend `(org-export-with-backend ',backend row nil info)))
5348 (let ((headerp ,(and (or hlfmt hlstart hlend)
5349 '(org-export-table-row-in-header-p row info)))
5350 (last-header-p
5351 ,(and (or hllfmt hllstart hllend)
5352 '(org-export-table-row-ends-header-p row info)))
5353 (lastp (not (org-export-get-next-element row info))))
5354 (when contents
5355 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5356 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5357 ;; `:lstart', `:lend' and their relatives.
5358 ,(let ((cells
5359 '(org-element-map row 'table-cell
5360 (lambda (cell)
5361 ;; Export all cells, without separators.
5362 ;;
5363 ;; Use `org-export-data-with-backend'
5364 ;; instead of `org-export-data' to eschew
5365 ;; cached values, which
5366 ;; ignore :orgtbl-ignore-sep parameter.
5367 (org-export-data-with-backend
5368 cell
5369 (plist-get info :back-end)
5370 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5371 info)))
5372 `(cond
5373 ,(and hllfmt
5374 `(last-header-p ,(org-table--generic-apply
5375 hllfmt ":hllfmt" nil cells)))
5376 ,(and hlfmt
5377 `(headerp ,(org-table--generic-apply
5378 hlfmt ":hlfmt" nil cells)))
5379 ,(and llfmt
5380 `(lastp ,(org-table--generic-apply
5381 llfmt ":llfmt" nil cells)))
5382 (t
5383 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5384 `(concat
5385 (cond
5386 ,(and
5387 (or hllstart hllend)
5388 `(last-header-p
5389 (concat
5390 ,(org-table--generic-apply hllstart ":hllstart")
5391 contents
5392 ,(org-table--generic-apply hllend ":hllend"))))
5393 ,(and
5394 (or hlstart hlend)
5395 `(headerp
5396 (concat
5397 ,(org-table--generic-apply hlstart ":hlstart")
5398 contents
5399 ,(org-table--generic-apply hlend ":hlend"))))
5400 ,(and
5401 (or llstart llend)
5402 `(lastp
5403 (concat
5404 ,(org-table--generic-apply llstart ":llstart")
5405 contents
5406 ,(org-table--generic-apply llend ":llend"))))
5407 (t
5408 ,(cond
5409 ((or lstart lend)
5410 `(concat
5411 ,(org-table--generic-apply lstart ":lstart")
5412 contents
5413 ,(org-table--generic-apply lend ":lend")))
5414 (backend
5415 `(org-export-with-backend
5416 ',backend row contents info))
5417 (t 'contents)))))))))))))))
5419 (defun org-table--to-generic-cell (params)
5420 "Return custom table cell transcoder according to PARAMS.
5421 PARAMS is a plist. See `orgtbl-to-generic' for more
5422 information."
5423 (let* ((backend (plist-get params :backend))
5424 (efmt (plist-get params :efmt))
5425 (fmt (plist-get params :fmt))
5426 (hfmt (plist-get params :hfmt))
5427 (sep (plist-get params :sep))
5428 (hsep (plist-get params :hsep)))
5429 `(lambda (cell contents info)
5430 ;; Make sure that contents are exported as Org data when :raw
5431 ;; parameter is non-nil.
5432 ,(when (and backend (plist-get params :raw))
5433 `(setq contents
5434 ;; Since we don't know what are the pseudo object
5435 ;; types defined in backend, we cannot pass them to
5436 ;; `org-element-interpret-data'. As a consequence,
5437 ;; they will be treated as pseudo elements, and will
5438 ;; have newlines appended instead of spaces.
5439 ;; Therefore, we must make sure :post-blank value is
5440 ;; really turned into spaces.
5441 (replace-regexp-in-string
5443 (org-trim
5444 (org-element-interpret-data
5445 (org-element-contents cell))))))
5447 (let ((headerp ,(and (or hfmt hsep)
5448 '(org-export-table-row-in-header-p
5449 (org-export-get-parent-element cell) info)))
5450 (column
5451 ;; Call costly `org-export-table-cell-address' only if
5452 ;; absolutely necessary, i.e., if one
5453 ;; of :fmt :efmt :hfmt has a "plist type" value.
5454 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5455 (list efmt hfmt fmt))
5456 '(1+ (cdr (org-export-table-cell-address cell info))))))
5457 (when contents
5458 ;; Check if we can apply `:efmt' on CONTENTS.
5459 ,(when efmt
5460 `(when (string-match orgtbl-exp-regexp contents)
5461 (let ((mantissa (match-string 1 contents))
5462 (exponent (match-string 2 contents)))
5463 (setq contents ,(org-table--generic-apply
5464 efmt ":efmt" t 'mantissa 'exponent)))))
5465 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5466 (cond
5467 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5468 hfmt ":hfmt" t 'contents))))
5469 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5470 fmt ":fmt" t 'contents))))))
5471 ;; If a separator is provided, use it instead of BACKEND's.
5472 ;; Separators are ignored when LFMT (or equivalent) is
5473 ;; provided.
5474 ,(cond
5475 ((or hsep sep)
5476 `(if (or ,(and (not sep) '(not headerp))
5477 (plist-get info :orgtbl-ignore-sep)
5478 (not (org-export-get-next-element cell info)))
5479 ,(if (not backend) 'contents
5480 `(org-export-with-backend ',backend cell contents info))
5481 (concat contents
5482 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5483 (or hsep sep)))))
5484 (backend `(org-export-with-backend ',backend cell contents info))
5485 (t 'contents))))))
5487 ;;;###autoload
5488 (defun orgtbl-to-tsv (table params)
5489 "Convert the orgtbl-mode table to TAB separated material."
5492 ;;;###autoload
5493 (defun orgtbl-to-csv (table params)
5494 "Convert the orgtbl-mode table to CSV material.
5495 This does take care of the proper quoting of fields with comma or quotes."
5496 (orgtbl-to-generic table
5497 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5498 params)))
5500 ;;;###autoload
5501 (defun orgtbl-to-latex (table params)
5502 "Convert the orgtbl-mode TABLE to LaTeX.
5504 TABLE is a list, each entry either the symbol `hline' for
5505 a horizontal separator line, or a list of fields for that line.
5506 PARAMS is a property list of parameters that can influence the
5507 conversion. All parameters from `orgtbl-to-generic' are
5508 supported. It is also possible to use the following ones:
5510 :booktabs
5514 :environment
5516 Specify environment to use, as a string. If you use
5518 as a string, to get proper continuation strings."
5519 (require 'ox-latex)
5520 (orgtbl-to-generic
5521 table
5522 (org-combine-plists
5523 ;; Provide sane default values.
5524 (list :backend 'latex
5525 :latex-default-table-mode 'table
5526 :latex-tables-centered nil
5527 :latex-tables-booktabs (plist-get params :booktabs)
5528 :latex-table-scientific-notation nil
5529 :latex-default-table-environment
5530 (or (plist-get params :environment) "tabular"))
5531 params)))
5533 ;;;###autoload
5534 (defun orgtbl-to-html (table params)
5535 "Convert the orgtbl-mode TABLE to HTML.
5537 TABLE is a list, each entry either the symbol `hline' for
5538 a horizontal separator line, or a list of fields for that line.
5539 PARAMS is a property list of parameters that can influence the
5540 conversion. All parameters from `orgtbl-to-generic' are
5541 supported. It is also possible to use the following one:
5543 :attributes
5545 Attributes and values, as a plist, which will be used in
5546 <table> tag."
5547 (require 'ox-html)
5548 (orgtbl-to-generic
5549 table
5550 (org-combine-plists
5551 ;; Provide sane default values.
5552 (list :backend 'html
5553 :html-table-data-tags '("<td%s>" . "</td>")
5554 :html-table-use-header-tags-for-first-column nil
5555 :html-table-align-individual-fields t
5556 :html-table-row-tags '("<tr>" . "</tr>")
5557 :html-table-attributes
5558 (if (plist-member params :attributes)
5559 (plist-get params :attributes)
5560 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5561 :frame "hsides")))
5562 params)))
5564 ;;;###autoload
5565 (defun orgtbl-to-texinfo (table params)
5566 "Convert the orgtbl-mode TABLE to Texinfo.
5568 TABLE is a list, each entry either the symbol `hline' for
5569 a horizontal separator line, or a list of fields for that line.
5570 PARAMS is a property list of parameters that can influence the
5571 conversion. All parameters from `orgtbl-to-generic' are
5572 supported. It is also possible to use the following one:
5574 :columns
5576 Column widths, as a string. When providing column fractions,
5578 (require 'ox-texinfo)
5579 (let ((output
5580 (orgtbl-to-generic
5581 table
5582 (org-combine-plists
5583 (list :backend 'texinfo
5584 :texinfo-tables-verbatim nil
5585 :texinfo-table-scientific-notation nil)
5586 params)))
5587 (columns (let ((w (plist-get params :columns)))
5588 (cond ((not w) nil)
5590 (t (concat "@columnfractions " w))))))
5591 (if (not columns) output
5592 (replace-regexp-in-string
5595 ;;;###autoload
5596 (defun orgtbl-to-orgtbl (table params)
5597 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5599 TABLE is a list, each entry either the symbol `hline' for
5600 a horizontal separator line, or a list of fields for that line.
5601 PARAMS is a property list of parameters that can influence the
5602 conversion. All parameters from `orgtbl-to-generic' are
5603 supported.
5605 Useful when slicing one table into many. The :hline, :sep,
5606 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5607 be set to provide ORGTBL directives for the generated table."
5608 (require 'ox-org)
5609 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5611 (defun orgtbl-to-table.el (table params)
5612 "Convert the orgtbl-mode TABLE into a table.el table.
5613 TABLE is a list, each entry either the symbol `hline' for
5614 a horizontal separator line, or a list of fields for that line.
5615 PARAMS is a property list of parameters that can influence the
5616 conversion. All parameters from `orgtbl-to-generic' are
5617 supported."
5618 (with-temp-buffer
5619 (insert (orgtbl-to-orgtbl table params))
5620 (org-table-align)
5621 (replace-regexp-in-string
5622 "-|" "-+"
5623 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5625 (defun orgtbl-to-unicode (table params)
5626 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5628 TABLE is a list, each entry either the symbol `hline' for
5629 a horizontal separator line, or a list of fields for that line.
5630 PARAMS is a property list of parameters that can influence the
5631 conversion. All parameters from `orgtbl-to-generic' are
5632 supported. It is also possible to use the following ones:
5634 :ascii-art
5637 the table. You can download it here:
5638 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5640 :narrow
5642 When non-nil, narrow columns width than provided width cookie,
5644 (require 'ox-ascii)
5645 (orgtbl-to-generic
5646 table
5647 (org-combine-plists
5648 (list :backend 'ascii
5649 :ascii-charset 'utf-8
5650 :ascii-table-widen-columns (not (plist-get params :narrow))
5651 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5652 params)))
5654 ;; Put the cursor in a column containing numerical values
5655 ;; of an Org table,
5656 ;; type C-c " a
5657 ;; A new column is added with a bar plot.
5658 ;; When the table is refreshed (C-u C-c *),
5659 ;; the plot is updated to reflect the new values.
5661 (defun orgtbl-ascii-draw (value min max &optional width characters)
5662 "Draw an ascii bar in a table.
5663 VALUE is the value to plot, it determines the width of the bar to draw.
5664 MIN is the value that will be displayed as empty (zero width bar).
5665 MAX is the value that will draw a bar filling all the WIDTH.
5666 WIDTH is the span in characters from MIN to MAX.
5667 CHARACTERS is a string that will compose the bar, with shades of grey
5668 from pure white to pure black. It defaults to a 10 characters string
5669 of regular ascii characters."
5670 (let* ((width (ceiling (or width 12)))
5671 (characters (or characters " .:;c!lhVHW"))
5672 (len (1- (length characters)))
5673 (value (float (if (numberp value)
5674 value (string-to-number value))))
5675 (relative (/ (- value min) (- max min)))
5676 (steps (round (* relative width len))))
5677 (cond ((< steps 0) "too small")
5678 ((> steps (* width len)) "too large")
5679 (t (let* ((int-division (/ steps len))
5680 (remainder (- steps (* int-division len))))
5681 (concat (make-string int-division (elt characters len))
5682 (string (elt characters remainder))))))))
5684 ;;;###autoload
5685 (defun orgtbl-ascii-plot (&optional ask)
5686 "Draw an ASCII bar plot in a column.
5688 With cursor in a column containing numerical values, this function
5689 will draw a plot in a new column.
5691 ASK, if given, is a numeric prefix to override the default 12
5693 prefix,
5694 which will prompt for the width."
5695 (interactive "P")
5696 (let ((col (org-table-current-column))
5697 (min 1e999) ; 1e999 will be converted to infinity
5698 (max -1e999) ; which is the desired result
5699 (table (org-table-to-lisp))
5700 (length
5701 (cond ((consp ask)
5702 (read-number "Length of column " 12))
5703 ((numberp ask) ask)
5704 (t 12))))
5705 ;; Skip any hline a the top of table.
5706 (while (eq (car table) 'hline) (setq table (cdr table)))
5707 ;; Skip table header if any.
5708 (dolist (x (or (cdr (memq 'hline table)) table))
5709 (when (consp x)
5710 (setq x (nth (1- col) x))
5711 (when (string-match
5713 x)
5714 (setq x (string-to-number x))
5715 (when (> min x) (setq min x))
5716 (when (< max x) (setq max x)))))
5717 (org-table-insert-column)
5718 (org-table-move-column-right)
5719 (org-table-store-formulas
5720 (cons
5721 (cons
5722 (concat "$" (number-to-string (1+ col)))
5723 (format "'(%s $%s %s %s %s)"
5724 "orgtbl-ascii-draw" col min max length))
5725 (org-table-get-stored-formulas)))
5726 (org-table-recalculate t)))
5728 ;; Example of extension: unicode characters
5729 ;; Here are two examples of different styles.
5731 ;; Unicode block characters are used to give a smooth effect.
5732 ;; See http://en.wikipedia.org/wiki/Block_Elements
5733 ;; Use one of those drawing functions
5734 ;; - orgtbl-ascii-draw (the default ascii)
5735 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5736 ;; - orgtbl-uc-draw-cont (smooth unicode)
5738 ;; This is best viewed with the "DejaVu Sans Mono" font
5739 ;; (use M-x set-default-font).
5741 (defun orgtbl-uc-draw-grid (value min max &optional width)
5742 "Draw a bar in a table using block unicode characters.
5743 It is a variant of orgtbl-ascii-draw with Unicode block
5744 characters, for a smooth display. Bars appear as grids (to the
5745 extent the font allows)."
5746 ;; http://en.wikipedia.org/wiki/Block_Elements
5747 ;; best viewed with the "DejaVu Sans Mono" font.
5748 (orgtbl-ascii-draw value min max width
5751 (defun orgtbl-uc-draw-cont (value min max &optional width)
5752 "Draw a bar in a table using block unicode characters.
5753 It is a variant of orgtbl-ascii-draw with Unicode block
5754 characters, for a smooth display. Bars are solid (to the extent
5755 the font allows)."
5756 (orgtbl-ascii-draw value min max width
5759 (defun org-table-get-remote-range (name-or-id form)
5760 "Get a field value or a list of values in a range from table at ID.
5762 NAME-OR-ID may be the name of a table in the current file as set
5764 will then be used. Alternatively, it may be an ID referring to
5765 any entry, also in a different file. In this case, the first
5766 table in that entry will be referenced.
5770 The return value is either a single string for a single field, or a
5771 list of the fields in the rectangle."
5772 (save-match-data
5773 (let ((case-fold-search t) (id-loc nil)
5774 ;; Protect a bunch of variables from being overwritten by
5775 ;; the context of the remote table.
5776 org-table-column-names org-table-column-name-regexp
5777 org-table-local-parameters org-table-named-field-locations
5778 org-table-current-line-types
5779 org-table-current-begin-pos org-table-dlines
5780 org-table-current-ncol
5781 org-table-hlines
5782 org-table-last-column-widths
5783 org-table-last-alignment
5784 buffer loc)
5785 (setq form (org-table-convert-refs-to-rc form))
5786 (org-with-wide-buffer
5787 (goto-char (point-min))
5788 (if (re-search-forward
5791 nil t)
5792 (setq buffer (current-buffer) loc (match-beginning 0))
5793 (setq id-loc (org-id-find name-or-id 'marker))
5794 (unless (and id-loc (markerp id-loc))
5796 (setq buffer (marker-buffer id-loc)
5797 loc (marker-position id-loc))
5798 (move-marker id-loc nil))
5799 (with-current-buffer buffer
5800 (org-with-wide-buffer
5801 (goto-char loc)
5802 (forward-char 1)
5804 (not (match-beginning 1)))
5805 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5806 (org-table-analyze)
5807 (setq form (org-table-formula-substitute-names
5808 (org-table-formula-handle-first/last-rc form)))
5809 (if (and (string-match org-table-range-regexp form)
5810 (> (length (match-string 0 form)) 1))
5811 (org-table-get-range
5812 (match-string 0 form) org-table-current-begin-pos 1)
5813 form)))))))
5815 (defun org-table-remote-reference-indirection (form)
5816 "Return formula with table remote references substituted by indirection.
5818 This indirection works only with the format @ROW$COLUMN. The
5820 distinguished from a plain table name or ID."
5821 (let ((regexp
5822 ;; Same as in `org-table-eval-formula'.
5824 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5827 (replace-regexp-in-string
5828 regexp
5829 (lambda (m)
5830 (save-match-data
5831 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5832 (org-table-get-range
5834 (concat "@0" eq)
5835 eq)))))
5836 form t t 1)))
5838 (defmacro org-define-lookup-function (mode)
5839 (let ((mode-str (symbol-name mode))
5840 (first-p (eq mode 'first))
5841 (all-p (eq mode 'all)))
5842 (let ((plural-str (if all-p "s" "")))
5843 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5844 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5845 If R-LIST is nil, return matching element%s of S-LIST.
5846 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5847 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5848 This function is generated by a call to the macro `org-define-lookup-function'."
5849 mode-str plural-str plural-str plural-str)
5850 (let ,(let ((lvars '((p (or predicate 'equal))
5851 (sl s-list)
5852 (rl (or r-list s-list))
5853 (ret nil))))
5854 (if first-p (cons '(match-p nil) lvars) lvars))
5855 (while ,(if first-p '(and (not match-p) sl) 'sl)
5856 (when (funcall p val (car sl))
5857 ,(when first-p '(setq match-p t))
5858 (let ((rval (car rl)))
5859 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5860 (setq sl (cdr sl) rl (cdr rl)))
5861 ret)))))
5863 (org-define-lookup-function first)
5864 (org-define-lookup-function last)
5865 (org-define-lookup-function all)
5867 (provide 'org-table)
5869 ;; Local variables:
5870 ;; generated-autoload-file: "org-loaddefs.el"
5871 ;; End:
5873 ;;; org-table.el ends here