| blob | 76b3717972f2c53f68a1e8894b1100973bab77e5 |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
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 http://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 that evaluation of a field formula can add new
391 columns if an out-of-bounds field is being set."
398 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
402 "Options concerning table import and export in Org mode."
407 "Default export parameters for `org-table-export'.
408 These can be overridden for a specific table by setting the
409 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
410 radio tables for the different export transformations and
411 available parameters."
416 "Max lines that `org-table-convert-region' will attempt to process.
418 The function can be slow on larger regions; this safety feature
419 prevents it from hanging emacs."
426 "String to be displayed in a shrunk column."
450 "Alist with column names, derived from the `!' line.
454 "Regular expression matching the current column names.
458 "Alist with parameter names, derived from the `$' line.
462 "Alist with locations of named fields.
463 Associations follow the pattern (NAME LINE COLUMN) where
464 NAME is the name of the field as a string,
465 LINE is the number of lines from the beginning of the table,
466 COLUMN is the column of the field, as an integer.
470 "Table row types in current table.
474 "Current table begin position, as a marker.
478 "Number of columns in current table.
482 "Vector of data line line numbers in the current table.
483 Line numbers are counted from the beginning of the table. This
487 "Vector of hline line numbers in the current table.
488 Line numbers are counted from the beginning of the table. This
492 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
493 ;; 1 2 3 4 5
508 "Save current field; execute BODY; restore field.
509 Field is restored even in case of abnormal exit."
521 "Expand all columns before executing BODY, then shrink them again."
534 ;;;###autoload
536 "Use the table.el package to insert a new table.
537 If there is already a table at point, convert between Org tables
538 and table.el tables."
551 ;;;###autoload
553 "Convert region to table, or create an empty table.
554 If there is an active region, convert it to a table, using the function
555 `org-table-convert-region'. See the documentation of that function
556 to learn how the prefix argument is interpreted to determine the field
557 separator.
558 If there is no such region, create an empty table with `org-table-create'."
564 ;;;###autoload
566 "Query for a size and insert a table skeleton.
586 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
590 ;; Insert a hline after the first row.
597 ;;;###autoload
599 "Convert region to a table.
601 The region goes from BEG0 to END0, but these borders will be moved
602 slightly, to make sure a beginning of line in the first line is included.
604 SEPARATOR specifies the field separator in the lines. It can have the
605 following values:
607 (4) Use the comma as a field separator
608 (16) Use a TAB as field separator
609 (64) Prompt for a regular expression as field separator
610 integer When a number, use that many spaces, or a TAB, as field separator
611 regexp When a regular expression, use it to match the separator
612 nil When nil, the command tries to be smart and figure out the
613 separator in the following way:
614 - when each line contains a TAB, assume TAB-separated material
615 - when each line contains a comma, assume CSV material
616 - else, assume one or more SPACE characters as separator."
620 re)
622 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
623 org-table-convert-region-max-lines)
632 ;; Get the right field separator
643 ;; parse the csv stuff
668 ;;;###autoload
670 "Import FILE as a table.
671 The file is assumed to be tab-separated. Such files can be produced by most
672 spreadsheet and database applications. If no tabs (at least one per line)
673 are found, lines will be split on whitespace into fields."
682 ;;;###autoload
684 "Export table to a file, with configurable format.
685 Such a file can be imported into usual spreadsheet programs.
687 FILE can be the output file name. If not given, it will be taken
688 from a TABLE_EXPORT_FILE property in the current entry or higher
689 up in the hierarchy, or the user will be prompted for a file
690 name. FORMAT can be an export format, of the same kind as it
691 used when `orgtbl-mode' sends a table in a different format.
693 The command suggests a format depending on TABLE_EXPORT_FORMAT,
694 whether it is set locally or up in the hierarchy, then on the
695 extension of the given file name, and finally on the variable
696 `org-table-export-default-format'."
729 formats)))
730 org-table-export-default-format)
756 "Marker at the beginning of the table last aligned.
759 "Marker at the end of the table last aligned.
762 "List of flags for flushright alignment, from the last re-alignment.
765 "List of max width of fields in each column.
768 "Non-nil means debug table formulas.
776 "Format FIELD according to column WIDTH and alignement ALIGN.
787 ;;;###autoload
789 "Align the table at point by aligning all vertical bars."
794 ;; Make sure invisible characters in the table are at the right
795 ;; place since column widths take them into account.
805 end t)))
806 ;; Table's rows as lists of fields. Rules are replaced
807 ;; by nil. Trailing spaces are removed.
813 ;; Compute number of columns. If the table contains no
814 ;; field, create a default table and bail out.
822 ;; Compute alignment and width for each column.
825 fields))
827 ;; Store the maximum width for the column.
829 ;; If there is no alignment cookie get the fraction of
830 ;; numbers among non-empty cells to decide about alignment
831 ;; of the column.
839 column)))
850 alignments)))
853 ;; Store alignment of this table, for later editing of single
854 ;; fields.
857 ;; Build new table rows. Only replace rows that actually
858 ;; changed.
863 indent
866 widths
875 cells
876 widths
877 alignments)
887 ;;;###autoload
889 "Find the beginning of the table and return its position.
890 With a non-nil optional argument TABLE-TYPE, return the beginning
891 of a table.el-type table. This function assumes point is on
892 a table."
900 ;;;###autoload
902 "Find the end of the table and return its position.
903 With a non-nil optional argument TABLE-TYPE, return the end of
904 a table.el-type table. This function assumes point is on
905 a table."
913 ;; When the line right after the table is the last line in
914 ;; the buffer with trailing spaces but no final newline
915 ;; character, be sure to catch the correct ending at its
916 ;; beginning. In any other case, ending is expected to be
917 ;; at point max.
922 ;;;###autoload
924 "Justify the current field, text to left, number to right.
925 Optional argument NEW may specify text to replace the current field content."
934 ;; This is not the same table, force a full re-align.
937 ;; Realign the current field, based on previous full realign.
970 ;;;###autoload
972 "Go to the next field in the current table, creating new lines as needed.
973 Before doing so, re-align the table if necessary."
978 org-table-may-need-update)
989 org-table-tab-jumps-over-hlines
1000 ;;;###autoload
1002 "Go to the previous field in the table.
1003 Before doing so, re-align the table if necessary."
1008 org-table-may-need-update)
1026 "Move to the beginning of the current table field.
1027 If already at or before the beginning, move to the beginning of the
1028 previous field.
1029 With numeric argument N, move N-1 fields backward first."
1042 "Move to the end of the current table field.
1043 If already at or after the end, move to the end of the next table field.
1044 With numeric argument N, move N-1 fields forward first."
1057 ;;;###autoload
1059 "Go to the next row (same column) in the current table.
1060 Before doing so, re-align the table if necessary."
1068 org-table-may-need-update)
1081 ;;;###autoload
1083 "Copy the value of the current field one row below.
1085 If the field at the cursor is empty, copy the content of the
1086 nearest non-empty field above. With argument N, use the Nth
1087 non-empty field.
1089 If the current field is not empty, it is copied down to the next
1090 row, and the cursor is moved with it. Therefore, repeating this
1091 command causes the column to be filled row-by-row.
1093 If the variable `org-table-copy-increment' is non-nil and the
1094 field is an integer or a timestamp, it will be incremented while
1095 copying. By default, increment by the difference between the
1096 value in the current field and the one in the field above. To
1097 increment using a fixed integer, set `org-table-copy-increment'
1098 to a number. In the case of a timestamp, increment by days."
1110 txt txt-up inc)
1118 beg t))
1128 beg t))
1135 ;; Above field was not empty, go down to the next row
1168 "Is point inside a table data field?
1169 I.e. not on a hline or before the first or after the last column?
1170 This actually throws an error, so it aborts the current command."
1182 "Get the field in table line LINE, column COLUMN.
1183 If LINE is larger than the number of data lines in the table, the function
1184 returns nil. However, if COLUMN is too large, we will simply return an
1185 empty string.
1186 If LINE is nil, use the current line.
1187 If COLUMN is nil, use the current column."
1194 "Put VALUE into line LINE, column COLUMN.
1195 When ALIGN is set, also realign the table."
1204 "Return the index of the current data line."
1211 cnt))
1214 "Go to the Nth data line in the current table.
1215 Return t when the line exists, nil if it does not exist."
1222 ;;;###autoload
1224 "Blank the current table field or active region."
1241 "Return the value of the field in column N of current row.
1242 N defaults to current column. If REPLACE is a string, replace
1243 field with this value. The return value is always the old
1244 value."
1248 ;; Before first column or after last one.
1249 ""
1254 ;; Since we are going to remove any hidden field, do not rely
1255 ;; on `org-table--hidden-field' as it could be GC'ed before
1256 ;; second check.
1265 val)))
1267 ;;;###autoload
1269 "Show info about the current field, and highlight any reference at point."
1279 col)
1280 org-table-named-field-locations)))
1290 ;; Prioritize field formulas over column formulas.
1299 dline col
1301 dline col ref1
1303 ;; FIXME: formula info not correct if special table line
1310 ""
1316 "Find out which column we are in."
1322 column)))
1325 "Find out what table data line we are in.
1326 Only data lines count for this."
1334 c)))
1336 ;;;###autoload
1338 "Move the cursor to the Nth column in the current table line.
1339 With optional argument ON-DELIM, stop with point before the left delimiter
1340 of the field.
1341 If there are less than N fields, just go to after the last delimiter.
1342 However, when FORCE is non-nil, create new columns if necessary."
1352 t)))))
1359 ;;;###autoload
1361 "Insert a new column into the table."
1378 ;; Shift appropriately stored shrunk column numbers, then hide the
1379 ;; columns again.
1381 shrunk-columns)
1382 beg end)
1384 ;; Fix TBLFM formulas, if desirable.
1391 "Find a data line in the current table, which is needed for column commands."
1394 t
1405 t
1410 "Turn a buffer line number into a data line number.
1412 If there is no data line in this line, return nil.
1414 If there is no matching dline (most likely the reference was
1415 a hline), the first dline below it is used. When ABOVE is
1416 non-nil, the one above is used."
1421 nil)
1432 ;;;###autoload
1434 "Delete a column from the table."
1448 nil
1455 ;; Shift appropriately stored shrunk column numbers, then hide the
1456 ;; columns again.
1458 shrunk-columns)
1459 beg end)
1461 ;; Fix TBLFM formulas, if desirable.
1469 ;;;###autoload
1471 "Move column to the right."
1475 ;;;###autoload
1477 "Move column to the left."
1481 ;;;###autoload
1483 "Move the current column to the right. With arg LEFT, move to the left."
1511 ;; Shift appropriately stored shrunk column numbers, then shrink
1512 ;; the columns again.
1520 shrunk-columns)
1521 beg end)
1523 ;; Fix TBLFM formulas, if desirable.
1534 ;;;###autoload
1536 "Move table row down."
1540 ;;;###autoload
1542 "Move table row up."
1546 ;;;###autoload
1548 "Move the current table line down. With arg UP, move it up."
1557 hline2p)
1584 ;;;###autoload
1586 "Insert a new row above the current line into the table.
1587 With prefix ARG, insert below the current line."
1593 ;; Fix the first field if necessary
1597 ;; Buffer may not end of a newline character, so ensure
1598 ;; (beginning-of-line 2) moves point to a new line.
1609 ;;;###autoload
1611 "Insert a horizontal-line below the current line into the table.
1612 With prefix ABOVE, insert above the current line."
1633 ;;;###autoload
1635 "Insert a hline and move to the row below that line."
1649 In particular, this does handle wide and invisible characters."
1651 ;; It's a hline, just map the characters
1657 t t s)))
1658 s))
1660 ;;;###autoload
1662 "Delete the current row or horizontal line from the table."
1678 ;;;###autoload
1681 "Sort table lines according to the column at point.
1683 The position of point indicates the column to be used for
1684 sorting, and the range of lines is the range between the nearest
1685 horizontal separator lines, or the entire table of no such lines
1686 exist. If point is before the first column, you will be prompted
1687 for the sorting column. If there is an active region, the mark
1688 specifies the first line and the sorting column, while point
1689 should be in the last line to be included into the sorting.
1691 The command then prompts for the sorting type which can be
1692 alphabetically, numerically, or by time (as given in a time stamp
1693 in the field, or as a HH:MM value). Sorting in reverse order is
1694 also possible.
1696 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1698 If SORTING-TYPE is specified when this function is called from a Lisp
1699 program, no prompting will take place. SORTING-TYPE must be a character,
1700 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1701 sorting should be done in reverse order.
1703 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1704 a function to be called to extract the key. It must return a value
1705 that is compatible with COMPARE-FUNC, the function used to compare
1706 entries.
1708 A non-nil value for INTERACTIVE? is used to signal that this
1709 function is being called interactively."
1712 ;; Point must be either within a field or before a data line.
1717 ;; Set appropriate case sensitivity and column used for sorting.
1730 ;; Narrow buffer to appropriate sorting area.
1741 start))
1744 end)))
1745 ;; Determine arguments for `sort-subr'. Also record original
1746 ;; position. `org-table-save-field' cannot help here since
1747 ;; sorting is too much destructive.
1753 ;; Function to be called on the contents of the field
1754 ;; used for sorting in the current row.
1781 "Function for comparing keys (empty for default \
1782 `sort-subr' predicate): "
1792 #'end-of-line
1796 nil
1797 predicate)
1798 ;; Hide all columns but the one being sorted.
1800 ;; Move back to initial field.
1804 ;;;###autoload
1806 "Copy region in table to the clipboard and blank all relevant fields.
1807 If there is no active region, use just the field at point."
1813 ;;;###autoload
1815 "Copy rectangular region in table to clipboard.
1816 A special clipboard is used which can only be accessed
1817 with `org-table-paste-rectangle'."
1821 current-prefix-arg))
1826 region)
1838 ;; Collect every cell between COLUMN-START and COLUMN-END.
1848 ;;;###autoload
1850 "Paste a rectangular region into a table.
1851 The upper right corner ends up in the current field. All involved fields
1852 will be overwritten. If the rectangle does not fit into the present table,
1853 the table is enlarged as needed. The process ignores horizontal separator
1854 lines."
1864 ;; If we left the table, create a new row.
1876 ;;;###autoload
1878 "Convert from `org-mode' table to table.el and back.
1879 Obviously, this only works within limits. When an Org table is converted
1880 to table.el, all horizontal separator lines get lost, because table.el uses
1881 these as cell boundaries and has no notion of horizontal lines. A table.el
1882 table can be converted to an Org table only if it does not do row or column
1883 spanning. Multiline cells will become multiple cells. Beware, Org mode
1884 does not test if the table can be successfully converted - it blindly
1885 applies a recipe that works for simple tables."
1889 ;; convert to Org table
1898 ;; convert to table.el table
1901 ;; first, get rid of all horizontal lines
1905 ;; insert a hline before first
1909 ;; insert a hline after each line
1914 ;; replace "+" at beginning and ending of hlines
1923 "Transpose Org table at point and eliminate hlines.
1924 So a table like
1926 | 1 | 2 | 4 | 5 |
1927 |---+---+---+---|
1928 | a | b | c | d |
1929 | e | f | g | h |
1931 will be transposed as
1933 | 1 | a | e |
1934 | 2 | b | f |
1935 | 4 | c | g |
1936 | 5 | d | h |
1938 Note that horizontal lines disappear."
1950 table)))
1964 ;;;###autoload
1966 "Wrap several fields in a column like a paragraph.
1967 This is useful if you'd like to spread the contents of a field over several
1968 lines, in order to keep the table compact.
1970 If there is an active region, and both point and mark are in the same column,
1971 the text in the column is wrapped to minimum width for the given number of
1972 lines. Generally, this makes the table more compact. A prefix ARG may be
1973 used to change the number of desired lines. For example, \
1975 formats the selected text to two lines. If the region was longer than two
1976 lines, the remaining lines remain empty. A negative prefix argument reduces
1977 the current number of lines by that amount. The wrapped text is pasted back
1978 into the table. If you formatted it to more lines than it was before, fields
1979 further down in the table get overwritten - so you might need to make space in
1980 the table first.
1982 If there is no region, the current field is split at the cursor position and
1983 the text fragment to the right of the cursor is prepended to the field one
1984 line down.
1986 If there is no region, but you specify a prefix ARG, the current field gets
1987 blank, and the content is appended to the field above."
1991 ;; There is a region: fill as a paragraph.
2002 nil
2003 nlines))))
2006 ;; No region, split the current field at point.
2031 ;;;###autoload
2033 "Edit table field in a different window.
2034 This is mainly useful for fields that contain hidden parts.
2037 visible so that it can be edited in place.
2040 toggle `org-table-follow-field-mode'."
2062 p)
2084 "Finish editing a table data field.
2085 Remove all newline characters, insert the result into the table, realign
2086 the table and kill the editing buffer."
2090 text)
2107 "Minor mode to make the table field editor window follow the cursor.
2108 When this mode is active, the field editor window will always show the
2109 current field. The mode exits automatically when the cursor leaves the
2110 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2111 nil " TblFollow" nil
2127 ;; We have left the table, exit the follow mode
2137 ;;;###autoload
2139 "Sum numbers in region of current table column.
2140 The result will be displayed in the echo area, and will be available
2143 If there is an active region, it is interpreted as a rectangle and all
2144 numbers in that rectangle will be summed. If there is no active
2145 region and point is located in a table column, sum all numbers in that
2146 column.
2148 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2149 numbers are assumed to be times as well (in decimal hours) and the
2150 numbers are added as such.
2152 If NLAST is a number, only the NLAST fields will actually be summed."
2179 items1)))
2186 s diff)
2193 sres))))
2216 "Return the formula active for the current field.
2218 Assumes that table is already analyzed. If KEY is given, return
2219 the key to this formula. Otherwise return the formula preceded
2228 org-table-named-field-locations)))
2242 "Read a formula from the minibuffer, offer stored formula as default.
2243 When NAMED is non-nil, look for a named equation."
2248 org-table-named-field-locations)))
2261 stored)
2263 equation)
2269 scol))
2271 'org-table-formula-history
2272 )))))
2273 mustsave)
2275 ;; remove formula
2282 ;; We set the column equation, delete the named one.
2284 mustsave t))
2290 eq))
2293 "Store the list of formulas below the current table.
2294 If optional argument LOCATION is a buffer position, insert it at
2295 LOCATION instead."
2303 ;; Don't overwrite TBLFM, we might use text properties to
2304 ;; store stuff.
2318 ;; Fake a high number to make sure this is sorted at the end.
2325 a)
2335 "Compare two formulas for sorting."
2340 ;;;###autoload
2342 "Return an alist with the stored formulas directly after current table.
2343 By default, only return active formulas, i.e., formulas located
2344 on the first line after the table. However, if optional argument
2345 LOCATION is a buffer position, consider the formulas there."
2354 eq-alist seen)
2358 string)
2363 ;; Is it a column reference?
2365 ;; Since named columns are not possible in
2366 ;; LHS, assume this is a named field.
2374 "Double definition `%s=' in TBLFM line, please fix by hand"
2375 lhs)
2380 "Double definition `%s=' in TBLFM line, please fix by hand"
2381 lhs)))))))))))
2384 "Modify the equations after the table structure has been edited.
2386 For all numbers larger than LIMIT, shift them by DELTA."
2398 s n a)
2404 "Change makes TBLFM term %s invalid, use undo to recover"
2419 ;;;###autoload
2422 If yes, store the formula and apply it."
2423 ;; We already know we are in a table. Get field will only return a formula
2424 ;; when appropriate. It might return a separator line, but no problem.
2427 named eq)
2435 "List of commands triggering the recalculation of a line.
2447 ;;;###autoload
2449 "Rotate the recalculation mark in the first column.
2450 If in any row, the first field is not consistent with a mark,
2451 insert a new column for the markers.
2452 When there is an active region, change all the lines in the region,
2453 after prompting for the marking character.
2454 After each change, a message will be displayed indicating the meaning
2455 of the new mark."
2471 newchar))
2479 newchar))
2497 ;; Rotate mark in first row.
2499 ;; Rotate marks in additional rows if a region is active.
2507 ;; Only align if rotation actually changed lines' length.
2517 ;;;###autoload
2519 "Analyze table at point and store results.
2521 This function sets up the following dynamically scoped variables:
2523 `org-table-column-name-regexp',
2524 `org-table-column-names',
2525 `org-table-current-begin-pos',
2526 `org-table-current-line-types',
2527 `org-table-current-ncol',
2528 `org-table-dlines',
2529 `org-table-hlines',
2530 `org-table-local-parameters',
2531 `org-table-named-field-locations'."
2536 ;; Extract column names.
2549 ;; Extract local parameters.
2557 org-table-local-parameters)))))
2558 ;; Update named fields locations. We minimize `count-lines'
2559 ;; processing by storing last known number of lines in LAST.
2581 field))
2584 org-table-named-field-locations))))))))))
2585 ;; Re-use existing markers when possible.
2589 ;; Analyze the line types.
2600 ;; Get the number of columns from the first data line in table.
2608 al al2)
2622 "Move point to a specific field in the current table.
2624 REF is either the name of a field its absolute reference, as
2625 a string. No column is created unless CREATE-COLUMN-P is
2626 non-nil. If it is a function, it is called with the column
2627 number as its argument as is used as a predicate to know if the
2628 column can be created.
2630 This function assumes the table is already analyzed (i.e., using
2631 `org-table-analyze')."
2646 create-column-p)))
2652 ;;;###autoload
2654 "Recompute the current line if marked for it, and if we haven't just done it."
2674 org-tbl-calc-modes)
2676 ;;;###autoload
2678 suppress-align suppress-const
2679 suppress-store suppress-analysis)
2680 "Replace the table field value at the cursor by the result of a calculation.
2682 In a table, this command replaces the value in the current field with the
2684 formula, by storing it in a special line below the table. When called
2686 field formula.
2689 insert the active equation for the field
2690 back into the current field, so that it can be edited there. This is \
2691 useful
2693 check the referenced fields.
2695 When called, the command first prompts for a formula, which is read in
2696 the minibuffer. Previously entered formulas are available through the
2697 history list, and the last used formula is offered as a default.
2698 These stored formulas are adapted correctly when moving, inserting, or
2699 deleting columns with the corresponding commands.
2701 The formula can be any algebraic expression understood by the Calc package.
2702 For details, see the Org mode manual.
2704 This function can also be called from Lisp programs and offers
2705 additional arguments: EQUATION can be the formula to apply. If this
2706 argument is given, the user will not be prompted.
2708 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2709 unnecessary aligns.
2711 SUPPRESS-CONST suppresses the interpretation of constants in the
2712 formula, assuming that this has been done already outside the
2713 function.
2715 SUPPRESS-STORE means the formula should not be stored, either
2716 because it is already stored, or because it is a modified
2717 equation that should not overwrite the stored one.
2719 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2720 location of point."
2736 equation
2742 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2743 duration duration-output-format)
2744 ;; Parse the format string. Since we have a lot of modes, this is
2745 ;; a lot of work. However, I think calc still uses most of the time.
2758 'calc-float-format
2761 n))))
2766 duration-output-format
2795 ;; replace fields with duration values if relevant
2799 fields)))
2805 x))
2806 fields)))
2812 ;; Insert row and column number of formula result field
2823 t t form)))
2825 ;; Check for old vertical references
2827 ;; Insert remote references
2840 rmtrng))
2841 keep-empty numbers lispp))
2842 t t form)))
2843 ;; Insert complex ranges
2853 ;; possibly handle durations
2858 formrg)
2859 keep-empty numbers lispp)))
2864 ;; Insert simple ranges, i.e. included in the current row.
2867 form)
2878 keep-empty numbers lispp))
2879 t t form)))
2881 ;; Insert the references to fields in same row
2888 x keep-empty numbers lispp)))
2905 ;; Use <...> time-stamps so that Calc can handle them.
2908 ;; Internationalize local time-stamps by setting locale to
2909 ;; "C".
2912 org-ts-regexp
2920 form t t))
2923 form
2930 duration-output-format)
2931 ev)))
2936 Orig: %s
2937 $xyz-> %s
2938 @r$c-> %s
2961 ;; Replace any active time stamp in the result with
2962 ;; an inactive one. Dates in tables are likely
2963 ;; piece of regular data, not meant to appear in the
2964 ;; agenda.
2977 prop value)))
2980 "Get a calc vector from a column, according to descriptor DESC.
2982 Optional arguments TBEG and COL can give the beginning of the table and
2983 the current column, to avoid unnecessary parsing.
2985 HIGHLIGHT means just highlight the range.
2987 When CORNERS-ONLY is set, only return the corners of the range as
2988 a list (line1 column1 line2 column2) where line1 and line2 are
2989 line numbers relative to beginning of table, or TBEG, and column1
2990 and column2 are table column numbers."
2993 desc))
3004 thisline)))
3009 thisline)))
3021 ;; Just one field.
3028 ;; A range, return a vector. First sort the numbers to get
3029 ;; a regular rectangle.
3035 ;; Copy the range values into a list.
3050 ;; Return string representation of calc vector.
3056 "Return relative line number corresponding to descriptor DESC.
3057 The cursor is currently in relative line number CLINE."
3062 ;; 1 2 3 4 5 6
3063 desc))
3085 cline)))
3088 "Return relative line of Nth row with type TYPE.
3089 Search starts from relative line I. When BACKWARDS in non-nil,
3090 look before I. When RELATIVE is non-nil, the reference is
3091 relative. DESC is the original descriptor that started the
3092 search, as a string."
3100 ;; We are going to cross a hline. Check if this is
3101 ;; an authorized move.
3112 ;; The last hline doesn't exist. Instead, point to last row
3113 ;; in table.
3122 "Convert list ELEMENTS to something appropriate to insert into formula.
3123 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3124 NUMBERS indicates that everything should be converted to numbers.
3125 LISPP non-nil means to return something appropriate for a Lisp
3126 list, `literal' is for the format specifier L."
3127 ;; Calc nan (not a number) is used for the conversion of the empty
3128 ;; field to a reference for several reasons: (i) It is accepted in a
3129 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3130 ;; (ii) In a single field (not in range) it can be distinguished
3131 ;; from "(nan)" which is the reference made from a single field
3132 ;; containing "nan".
3134 ;; field reference
3137 elements
3139 ""
3148 ;; range reference
3153 elements))))
3159 x
3167 x)
3169 elements
3173 "If there has been more than one second since T1, display message.
3174 ARGS are passed as arguments to the `message' function. Returns
3175 current time if a message is printed, otherwise returns T1. If
3176 T1 is nil, always messages."
3180 curtime)
3181 t1)))
3183 ;;;###autoload
3185 "Recalculate the current table line by applying all stored formulas.
3187 With prefix arg ALL, do this for all lines in the table.
3190 if ALL is the symbol `iterate',
3191 recompute the table until it no longer changes.
3193 If NOALIGN is not nil, do not re-align the table after the computations
3194 are done. This is typically used internally to save time, if it is
3195 known that the table will be realigned a little later anyway."
3210 beg end eqlcol eqlfield)
3211 ;; Insert constants in all formulas.
3214 ;; Expand equations, then split the equation list between
3215 ;; column formulas and field formulas.
3227 old-lhs)))
3230 existing formula for column %s"
3231 old-lhs
3232 new))
3233 new))
3239 ;; Expand ranges in lhs of formulas
3241 ;; Get the correct line range to process.
3248 ;; This is a table with marked lines, compute selected
3249 ;; lines.
3251 ;; Move forward to the first non-header line.
3256 ;; Just leave BEG at the start of the table.
3261 ;; Mark named fields untouchable. Also check if several
3262 ;; field/range formulas try to set the same field.
3266 seen-fields)
3277 ;; Turn field coordinates associated to NAME
3278 ;; into an absolute reference.
3282 name)))
3285 reference))
3290 ;; Evaluate the column formulas, but skip fields covered by
3291 ;; field formulas.
3295 ;; Unprotected line, recalculate.
3300 log-last-time
3313 ;; Evaluate the field formulas.
3322 reference
3323 ;; Possibly create a new column, as long as
3324 ;; `org-table-formula-create-columns' allows it.
3336 t))
3341 ;; Clean up markers and internal text property.
3352 ;;;###autoload
3354 "Recalculate the table until it does not change anymore.
3355 The maximum number of iterations is 10, but you can choose a different value
3356 with the prefix ARG."
3361 thistbl)
3375 ;;;###autoload
3377 "Recalculate all tables in the current buffer."
3382 ;; Reason for separate `org-table-align': When repeating
3383 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3384 ;; the way.
3387 t)))
3389 ;;;###autoload
3391 "Iterate all tables in the buffer, to converge inter-table dependencies."
3396 c1)
3412 "Apply the #+TBLFM in the line at point to the table."
3419 ;; Insert a temporary formula at right after the table
3424 ;; Recalculate the table.
3429 ;; Delete the formula inserted temporarily.
3435 "Find the beginning of the TBLFM lines and return its position.
3436 Return nil when the beginning of TBLFM line was not found."
3443 "Expand list of formulas.
3444 If some of the RHS in the formulas are ranges or a row reference,
3445 expand them to individual field equations for each field. This
3446 function assumes the table is already analyzed (i.e., using
3447 `org-table-analyze')."
3454 ;; This just refers to one fixed field.
3457 ;; This just refers to one fixed named field.
3460 ;; Column formulas are treated specially and are not
3461 ;; expanded.
3466 rhs)
3467 res)))
3479 rhs)
3480 res))))))))))
3483 "Replace @<, @>, $<, $> with first/last row/column of the table.
3484 So @< and $< will always be replaced with @1 and $1, respectively.
3485 The advantage of these special markers are that structure editing of
3486 the table will not change them, while @1 and $1 will be modified
3487 when a line/row is swapped out of that privileged position. So for
3488 formulas that use a range of rows or columns, it may often be better
3490 borders of the table using the @< @> $< $> makers."
3493 s start)
3498 org-table-current-ncol)
3502 len
3509 s)
3512 "Replace $const with values in string F."
3517 org-table-column-name-regexp
3520 org-table-column-names))))
3521 f t t)))
3522 ;; Parameters and constants.
3526 new start))
3529 ;; When a duration is expected, convert value on the fly.
3535 v)))))
3542 "Find the value for a parameter or constant in a formula.
3543 Parameters get priority."
3574 map))
3581 "--"
3584 "--"
3585 "Shift Reference at Point"
3590 "-"
3591 "Change Test Row for Column Formulas"
3594 "--"
3599 org-table-overlay-coordinates)]
3600 "--"
3608 ;;;###autoload
3610 "Edit the formulas of the current table in a separate buffer."
3616 ;; Move point within the table before analyzing it.
3632 ;; Keep global-font-lock-mode from turning on font-lock-mode
3677 "Convert a formula from internal to user representation."
3680 s))
3683 "Convert a formula from user to internal representation."
3686 s))
3689 "Convert spreadsheet references from A7 to @7$28.
3690 Works for single references, but also for entire formulas and even the
3691 full TBLFM line."
3693 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3696 ;; format match, just advance
3701 ;; 3.e5 or something like this.
3704 ;; (member (match-string 1 s)
3705 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3706 )
3707 ;; function name, just advance
3717 t t s)))))
3718 s))
3721 "Convert spreadsheet references from to @7$28 to AB7.
3722 Works for single references, but also for entire formulas and even the
3723 full TBLFM line."
3730 t t s)))
3735 t nil s)))
3736 s)
3739 "Convert a base 26 number represented by letters into an integer.
3740 For example: AB -> 28."
3746 n))
3749 "Convert an integer into a base 26 number represented by letters.
3750 For example: 28 -> AB."
3755 s))
3758 "Convert a time string into numerical duration in seconds.
3759 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3760 If S is a string representing a number, keep this number."
3762 s
3785 "Convert a number of seconds to a time string.
3786 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3787 minutes or seconds."
3799 ;; Ignore seconds
3803 secs0)
3808 secs0)))))
3812 \f
3813 ;;; Columns shrinking
3816 "Non-nil if current field is narrowed.
3817 When non-nil, return the overlay narrowing the field."
3820 o))
3824 "List currently shrunk columns in table at point."
3826 ;; We really check shrunk columns in current row only. It could
3827 ;; be wrong if all rows do not contain the same number of columns
3828 ;; (i.e. the table is not properly aligned). As a consequence,
3829 ;; some columns may not be shrunk again upon aligning the table.
3830 ;;
3831 ;; For example, in the following table, cursor is on first row and
3832 ;; "<>" indicates a shrunk column.
3833 ;;
3834 ;; | |
3835 ;; | | <> |
3836 ;;
3837 ;; Aligning table from the first row will not shrink again the
3838 ;; second row, which was not visible initially.
3839 ;;
3840 ;; However, fixing it requires to check every row, which may be
3841 ;; slow on large tables. Moreover, the hindrance of this
3842 ;; pathological case is very limited.
3855 "Shrink a table field to a specified width.
3857 WIDTH is an integer representing the number of characters to
3858 display, in addition to `org-table-shrunk-column-indicator'. START
3859 and END are, respectively, the beginning and ending positions of
3860 the field. CONTENTS is its trimmed contents, as a string, or
3861 `hline' for table rules.
3863 Real field is hidden under an overlay. The latter has the
3864 following properties:
3866 `org-overlay-type'
3868 Set to `table-column-hide'. Used to identify overlays
3869 responsible for the task.
3871 `org-table-column-overlays'
3873 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3874 where COLUMN-OVERLAYS is the list of all overlays hiding the
3875 same column.
3877 Whenever the text behind or next to the overlay is modified, all
3878 the overlays in the column are deleted, effectively displaying
3879 the column again.
3881 Return overlay used to hide the field."
3888 org-table-shrunk-column-indicator))
3890 ;; Remove invisible parts from links in CONTENTS. Since
3891 ;; shrinking could happen before first fontification
3892 ;; (e.g., using a #+STARTUP keyword), this cannot be done
3893 ;; using text properties.
3897 ;; Expand field.
3899 contents
3901 org-table-shrunk-column-indicator)
3902 ;; Truncate field.
3905 org-table-shrunk-column-indicator))))))
3908 ;; Removing one overlay removes all other overlays
3909 ;; in the same column.
3918 ;; Make sure overlays stays on top of table coordinates
3919 ;; overlays. See `org-table-overlay-coordinates'.
3922 o)))
3925 "Read column selection select as a list of numbers.
3927 SELECT is a string containing column ranges, separated by white
3928 space characters, see `org-table-hide-column' for details. MAX
3929 is the maximum column number.
3931 Return value is a sorted list of numbers. Ignore any number
3932 outside of the [1;MAX] range."
3949 max))))
3952 #'<)))
3955 "Shrink COLUMNS in an Org table.
3956 COLUMNS is a sorted list of column numbers. BEG and END are,
3957 respectively, the beginning position and the end position of the
3958 table."
3969 ;; Move to COLUMN.
3974 ;; Extract boundaries and contents from current field.
3975 ;; Also set the column's width if we encounter a width
3976 ;; cookie for the first time.
3990 ;; Link overlay to the other overlays in the same column.
3997 ;;;###autoload
3999 "Shrink or expand current column in an Org table.
4001 If a width cookie specifies a width W for the column, the first
4002 W visible characters are displayed. Otherwise, the column is
4003 shrunk to a single character.
4005 When point is before the first column or after the last one, ask
4006 for the columns to shrink or expand, as a list of ranges.
4007 A column range can be one of the following patterns:
4009 N column N only
4010 N-M every column between N and M (both inclusive)
4011 N- every column between N (inclusive) and the last column
4012 -M every column between the first one and M (inclusive)
4013 - every column
4015 When optional argument ARG is a string, use it as white space
4016 separated list of column ranges.
4019 `org-table-shrink', i.e.,
4020 shrink columns with a width cookie and expand the others.
4023 prefix, expand all columns."
4029 ;; Compute an upper bound for the number of columns.
4030 ;; Nonexistent columns are ignored anyway.
4035 (`nil
4039 ;; Point is either before first column or past last
4040 ;; one. Ask for columns to operate on.
4043 max-columns)
4044 ;; Find current column, even when on a hline.
4061 ;; Move before overlay if point is under it.
4065 ;;;###autoload
4067 "Shrink all columns with a width cookie in the table at point.
4069 Columns without a width cookie are expanded.
4071 Optional arguments BEGIN and END, when non-nil, specify the
4072 beginning and end position of the current table."
4085 ;; Make sure invisible characters in the table are at the right
4086 ;; place since column widths take them into account.
4090 ;;;###autoload
4092 "Expand all columns in the table at point.
4093 Optional arguments BEGIN and END, when non-nil, specify the
4094 beginning and end position of the current table."
4103 \f
4104 ;;; Formula editing
4107 "Convert all references in this buffer, using FUNCTION."
4118 "Convert all references in the buffer from B3 to @3$2 and back."
4128 "Shift the reference at point one row/hline up."
4132 "Shift the reference at point one row/hline down."
4136 "Shift the reference at point one field to the left."
4140 "Shift the reference at point one field to the right."
4151 ;; A B3-like reference
4157 ;; An internal reference
4163 "Re-match the group N, and replace it with the shifted reference."
4168 t t)))
4171 "Shift a reference part REF.
4172 If DECR is set, decrease the references row/column, else increase.
4173 If HLINE is set, this may be a hline reference, it certainly is not
4174 a translation reference."
4203 "Toggle the display of coordinates in the referenced table."
4212 "Parse the buffer for formula definitions and install them.
4213 With prefix ARG, apply the new formulas to the table."
4222 eql)
4225 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4226 nil t)
4247 "Abort editing formulas, without installing the changes."
4258 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4299 "Show the location/value of the $ expression at point.
4300 When LOCAL is non-nil, show references for the table at point."
4310 var name e what match dest)
4314 "$1.."
4366 dest)
4392 ;; Column number.
4418 org-table-fedit-scroll-down))))
4430 "Make sure the cursor is in a dataline in a table."
4439 p1 p2)))
4444 "Move cursor one line up in the window showing the table."
4449 "Move cursor one line down in the window showing the table."
4454 "Move the cursor in the window showing the table.
4455 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4480 "Add a new overlay."
4486 "Highlight rectangular region in a table.
4487 When buffer positions BEG and END are provided, use them to
4488 delimit the region to highlight. Otherwise, refer to point. Use
4489 FACE, when non-nil, for the highlight."
4521 "Remove the rectangle overlays."
4531 "Add overlays to the table at point, to show row/column coordinates."
4559 ;;;###autoload
4561 "Toggle the display of Row/Column numbers in tables."
4572 ;;;###autoload
4574 "Toggle the formula debugger in tables."
4580 ;;; The orgtbl minor mode
4582 ;; Define a minor mode which can be used in other modes in order to
4583 ;; integrate the Org table editor.
4585 ;; This is really a hack, because the Org table editor uses several
4586 ;; keys which normally belong to the major mode, for example the TAB
4587 ;; and RET keys. Here is how it works: The minor mode defines all the
4588 ;; keys necessary to operate the table editor, but wraps the commands
4589 ;; into a function which tests if the cursor is currently inside
4590 ;; a table. If that is the case, the table editor command is
4591 ;; executed. However, when any of those keys is used outside a table,
4592 ;; the function uses `key-binding' to look up if the key has an
4593 ;; associated command in another currently active keymap (minor modes,
4594 ;; major mode, global), and executes that command. There might be
4595 ;; problems if any of the keys used by the table editor is otherwise
4596 ;; used as a prefix key.
4598 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4599 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4600 ;; addresses this by checking explicitly for both bindings.
4602 ;; The optimized version (see variable `orgtbl-optimized') takes over
4603 ;; all keys which are bound to `self-insert-command' in the *global map*.
4604 ;; Some modes bind other commands to simple characters, for example
4605 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4606 ;; active, this binding is ignored inside tables and replaced with a
4607 ;; modified self-insert.
4625 ;; Install it as a minor mode.
4629 ;;;###autoload
4631 "The `org-mode' table editor as a minor mode for use in other modes."
4636 ;; Exit without error, in case some hook functions calls this
4637 ;; by accident in org-mode.
4641 ;; Make sure we are first in minor-mode-map-alist
4643 ;; FIXME: maybe it should use emulation-mode-map-alists?
4650 auto-fill-inhibit-regexp)
4654 auto-fill-inhibit-regexp)
4655 orgtbl-line-start-regexp))
4670 "Create a function for binding in the table minor mode.
4671 FUN is the command to call inside a table. N is used to create a unique
4672 command name. KEYS are keys that should be checked in for a command
4673 to execute outside of tables."
4679 "Outside of tables, run the binding of `"
4691 keys)
4695 "Error when there is no default binding for a table key."
4700 "Setup orgtbl keymaps."
4731 elt key fun cmd)
4739 ;; Special treatment needed for TAB, RET and DEL
4752 (orgtbl-make-binding 'org-delete-backward-char 109
4758 [(tab)] "\C-i"))
4760 (org-defkey orgtbl-mode-map [backtab]
4762 [backtab] [S-iso-lefttab] [(shift tab)]
4763 [(tab)] "\C-i"))
4765 (org-defkey orgtbl-mode-map "\M-\C-m"
4766 (orgtbl-make-binding 'org-table-wrap-region 105
4767 "\M-\C-m" [(meta return)]))
4768 (org-defkey orgtbl-mode-map [(meta return)]
4769 (orgtbl-make-binding 'org-table-wrap-region 106
4770 [(meta return)] "\M-\C-m"))
4772 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4773 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4775 (when orgtbl-optimized
4776 ;; If the user wants maximum table support, we need to hijack
4777 ;; some standard editing functions
4778 (org-remap orgtbl-mode-map
4779 'self-insert-command 'orgtbl-self-insert-command
4780 'delete-char 'org-delete-char
4781 'delete-backward-char 'org-delete-backward-char)
4782 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4783 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4784 '("OrgTbl"
4785 ["Create or convert" org-table-create-or-convert-from-region
4786 :active (not (org-at-table-p)) :keys "C-c |" ]
4787 "--"
4788 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4789 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4790 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4791 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4792 "--"
4793 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4794 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4795 ["Copy Field from Above"
4796 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4797 "--"
4798 ("Column"
4799 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4800 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4801 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4802 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4803 ("Row"
4804 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4805 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4806 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4807 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4808 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4809 "--"
4810 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4811 ("Rectangle"
4812 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4813 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4814 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4815 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4816 "--"
4817 ("Radio tables"
4818 ["Insert table template" orgtbl-insert-radio-table
4819 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4820 ["Comment/uncomment table" orgtbl-toggle-comment t])
4821 "--"
4822 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4823 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4824 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4825 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4826 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4827 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4828 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4829 ["Sum Column/Rectangle" org-table-sum
4830 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4831 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4832 ["Debug Formulas"
4833 org-table-toggle-formula-debugger :active (org-at-table-p)
4834 :keys "C-c {"
4835 :style toggle :selected org-table-formula-debug]
4836 ["Show Col/Row Numbers"
4837 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4838 :keys "C-c }"
4839 :style toggle :selected org-table-overlay-coordinates]
4840 "--"
4841 ("Plot"
4844 t))
4846 (defun orgtbl-ctrl-c-ctrl-c (arg)
4847 "If the cursor is inside a table, realign the table.
4848 If it is a table to be sent away to a receiver, do it.
4849 With prefix arg, also recompute table."
4850 (interactive "P")
4851 (let ((case-fold-search t) (pos (point)) action)
4852 (save-excursion
4853 (beginning-of-line 1)
4854 (setq action (cond
4858 (cond
4859 ((integerp action)
4860 (goto-char action)
4861 (org-table-maybe-eval-formula)
4862 (if arg
4863 (call-interactively 'org-table-recalculate)
4864 (org-table-maybe-recalculate-line))
4865 (call-interactively 'org-table-align)
4866 (when (orgtbl-send-table 'maybe)
4867 (run-hooks 'orgtbl-after-send-table-hook)))
4868 ((eq action 'recalc)
4869 (save-excursion
4870 (beginning-of-line 1)
4872 (if (org-at-table-p)
4873 (org-call-with-arg 'org-table-recalculate t))))
4874 (t (let (orgtbl-mode)
4875 (call-interactively (key-binding "\C-c\C-c")))))))
4877 (defun orgtbl-create-or-convert-from-region (_arg)
4878 "Create table or convert region to table, if no conflicting binding.
4879 This installs the table binding `C-c |', but only if there is no
4880 conflicting binding to this key outside orgtbl-mode."
4881 (interactive "P")
4882 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4883 (if cmd
4884 (call-interactively cmd)
4885 (call-interactively 'org-table-create-or-convert-from-region))))
4887 (defun orgtbl-tab (arg)
4888 "Justification and field motion for `orgtbl-mode'."
4889 (interactive "P")
4890 (if arg (org-table-edit-field t)
4891 (org-table-justify-field-maybe)
4892 (org-table-next-field)))
4894 (defun orgtbl-ret ()
4895 "Justification and field motion for `orgtbl-mode'."
4896 (interactive)
4897 (if (bobp)
4898 (newline)
4899 (org-table-justify-field-maybe)
4900 (org-table-next-row)))
4902 (defun orgtbl-self-insert-command (N)
4903 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4904 If the cursor is in a table looking at whitespace, the whitespace is
4905 overwritten, and the table is not marked as requiring realignment."
4906 (interactive "p")
4907 (if (and (org-at-table-p)
4908 (or
4909 (and org-table-auto-blank-field
4910 (member last-command
4911 '(orgtbl-hijacker-command-100
4912 orgtbl-hijacker-command-101
4913 orgtbl-hijacker-command-102
4914 orgtbl-hijacker-command-103
4915 orgtbl-hijacker-command-104
4916 orgtbl-hijacker-command-105
4917 yas/expand))
4918 (org-table-blank-field))
4919 t)
4920 (eq N 1)
4922 (let (org-table-may-need-update)
4923 (delete-region (match-beginning 1) (match-end 1))
4924 (self-insert-command N))
4925 (setq org-table-may-need-update t)
4926 (let* (orgtbl-mode
4927 a
4928 (cmd (or (key-binding
4929 (or (and (listp function-key-map)
4930 (setq a (assoc last-input-event function-key-map))
4931 (cdr a))
4932 (vector last-input-event)))
4933 'self-insert-command)))
4934 (call-interactively cmd)
4935 (if (and org-self-insert-cluster-for-undo
4936 (eq cmd 'self-insert-command))
4937 (if (not (eq last-command 'orgtbl-self-insert-command))
4938 (setq org-self-insert-command-undo-counter 1)
4939 (if (>= org-self-insert-command-undo-counter 20)
4940 (setq org-self-insert-command-undo-counter 1)
4941 (and (> org-self-insert-command-undo-counter 0)
4942 buffer-undo-list
4943 (not (cadr buffer-undo-list)) ; remove nil entry
4944 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4945 (setq org-self-insert-command-undo-counter
4946 (1+ org-self-insert-command-undo-counter))))))))
4948 ;;;###autoload
4950 "Regular expression matching exponentials as produced by calc.")
4952 (defun orgtbl-gather-send-defs ()
4953 "Gather a plist of :name, :transform, :params for each destination before
4954 a radio table."
4955 (save-excursion
4956 (goto-char (org-table-begin))
4957 (let (rtn)
4958 (beginning-of-line 0)
4959 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4960 (let ((name (org-no-properties (match-string 1)))
4961 (transform (intern (match-string 2)))
4962 (params (if (match-end 3)
4963 (read (concat "(" (match-string 3) ")")))))
4964 (push (list :name name :transform transform :params params)
4965 rtn)
4966 (beginning-of-line 0)))
4967 rtn)))
4969 (defun orgtbl-send-replace-tbl (name text)
4970 "Find and replace table NAME with TEXT."
4971 (save-excursion
4972 (goto-char (point-min))
4973 (let* ((location-flag nil)
4974 (name (regexp-quote name))
4977 (while (re-search-forward begin-re nil t)
4978 (unless location-flag (setq location-flag t))
4979 (let ((beg (line-beginning-position 2)))
4980 (unless (re-search-forward end-re nil t)
4981 (user-error "Cannot find end of receiver location at %d" beg))
4982 (beginning-of-line)
4983 (delete-region beg (point))
4985 (unless location-flag
4986 (user-error "No valid receiver location found in the buffer")))))
4988 ;;;###autoload
4989 (defun org-table-to-lisp (&optional txt)
4990 "Convert the table at point to a Lisp structure.
4991 The structure will be a list. Each item is either the symbol `hline'
4992 for a horizontal separator line, or a list of field values as strings.
4993 The table is taken from the parameter TXT, or from the buffer at point."
4994 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4995 (let ((txt (or txt
4996 (buffer-substring-no-properties (org-table-begin)
4997 (org-table-end)))))
4998 (mapcar (lambda (x)
4999 (if (string-match org-table-hline-regexp x) 'hline
5003 (defun orgtbl-send-table (&optional maybe)
5004 "Send a transformed version of table at point to the receiver position.
5005 With argument MAYBE, fail quietly if no transformation is defined
5006 for this table."
5007 (interactive)
5008 (catch 'exit
5009 (unless (org-at-table-p) (user-error "Not at a table"))
5010 ;; when non-interactive, we assume align has just happened.
5011 (when (called-interactively-p 'any) (org-table-align))
5012 (let ((dests (orgtbl-gather-send-defs))
5013 (table (org-table-to-lisp
5014 (buffer-substring-no-properties (org-table-begin)
5015 (org-table-end))))
5016 (ntbl 0))
5017 (unless dests
5018 (if maybe (throw 'exit nil)
5019 (user-error "Don't know how to transform this table")))
5020 (dolist (dest dests)
5021 (let ((name (plist-get dest :name))
5022 (transform (plist-get dest :transform))
5023 (params (plist-get dest :params)))
5024 (unless (fboundp transform)
5025 (user-error "No such transformation function %s" transform))
5026 (orgtbl-send-replace-tbl name (funcall transform table params)))
5027 (cl-incf ntbl))
5028 (message "Table converted and installed at %d receiver location%s"
5029 ntbl (if (> ntbl 1) "s" ""))
5030 (and (> ntbl 0) ntbl))))
5032 (defun org-remove-by-index (list indices &optional i0)
5033 "Remove the elements in LIST with indices in INDICES.
5034 First element has index 0, or I0 if given."
5035 (if (not indices)
5036 list
5037 (if (integerp indices) (setq indices (list indices)))
5038 (setq i0 (1- (or i0 0)))
5039 (delq :rm (mapcar (lambda (x)
5040 (setq i0 (1+ i0))
5041 (if (memq i0 indices) :rm x))
5042 list))))
5044 (defun orgtbl-toggle-comment ()
5045 "Comment or uncomment the orgtbl at point."
5046 (interactive)
5047 (let* ((case-fold-search t)
5048 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5049 (re2 (concat "^" orgtbl-line-start-regexp))
5050 (commented (save-excursion (beginning-of-line 1)
5051 (cond ((looking-at re1) t)
5052 ((looking-at re2) nil)
5053 (t (user-error "Not at an org table")))))
5054 (re (if commented re1 re2))
5055 beg end)
5056 (save-excursion
5057 (beginning-of-line 1)
5058 (while (looking-at re) (beginning-of-line 0))
5059 (beginning-of-line 2)
5060 (setq beg (point))
5061 (while (looking-at re) (beginning-of-line 2))
5062 (setq end (point)))
5063 (comment-region beg end (if commented '(4) nil))))
5065 (defun orgtbl-insert-radio-table ()
5066 "Insert a radio table template appropriate for this major mode."
5067 (interactive)
5068 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5069 (txt (nth 1 e))
5070 name pos)
5071 (unless e (user-error "No radio table setup defined for %s" major-mode))
5072 (setq name (read-string "Table name: "))
5073 (while (string-match "%n" txt)
5074 (setq txt (replace-match name t t txt)))
5076 (setq pos (point))
5077 (insert txt)
5078 (goto-char pos)))
5080 ;;;###autoload
5081 (defun orgtbl-to-generic (table params)
5082 "Convert the orgtbl-mode TABLE to some other format.
5084 This generic routine can be used for many standard cases.
5086 TABLE is a list, each entry either the symbol `hline' for
5087 a horizontal separator line, or a list of fields for that
5088 line. PARAMS is a property list of parameters that can
5089 influence the conversion.
5091 Valid parameters are:
5093 :backend, :raw
5095 Export back-end used as a basis to transcode elements of the
5096 table, when no specific parameter applies to it. It is also
5097 used to translate cells contents. You can prevent this by
5098 setting :raw property to a non-nil value.
5100 :splice
5102 When non-nil, only convert rows, not the table itself. This is
5103 equivalent to setting to the empty string both :tstart
5104 and :tend, which see.
5106 :skip
5108 When set to an integer N, skip the first N lines of the table.
5109 Horizontal separation lines do count for this parameter!
5111 :skipcols
5113 List of columns that should be skipped. If the table has
5114 a column with calculation marks, that column is automatically
5115 discarded beforehand.
5117 :hline
5119 String to be inserted on horizontal separation lines. May be
5120 nil to ignore these lines altogether.
5122 :sep
5124 Separator between two fields, as a string.
5126 Each in the following group may be either a string or a function
5127 of no arguments returning a string:
5129 :tstart, :tend
5131 Strings to start and end the table. Ignored when :splice is t.
5133 :lstart, :lend
5135 Strings to start and end a new table line.
5137 :llstart, :llend
5139 Strings to start and end the last table line. Default,
5140 respectively, to :lstart and :lend.
5142 Each in the following group may be a string or a function of one
5143 argument (either the cells in the current row, as a list of
5144 strings, or the current cell) returning a string:
5146 :lfmt
5148 Format string for an entire row, with enough %s to capture all
5149 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5151 :llfmt
5153 Format for the entire last line, defaults to :lfmt.
5155 :fmt
5157 A format to be used to wrap the field, should contain %s for
5158 the original field value. For example, to wrap everything in
5160 a property list with column numbers and format strings, or
5161 functions, e.g.,
5165 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5167 Same as above, specific for the header lines in the table.
5168 All lines before the first hline are treated as header. If
5169 any of these is not present, the data line value is used.
5171 This may be either a string or a function of two arguments:
5173 :efmt
5175 Use this format to print numbers with exponential. The format
5176 should have %s twice for inserting mantissa and exponent, for
5178 list with column numbers and format strings or functions.
5179 :fmt will still be applied after :efmt."
5180 ;; Make sure `org-export-create-backend' is available.
5181 (require 'ox)
5182 (let* ((backend (plist-get params :backend))
5183 (custom-backend
5184 ;; Build a custom back-end according to PARAMS. Before
5185 ;; defining a translator, check if there is anything to do.
5186 ;; When there isn't, let BACKEND handle the element.
5187 (org-export-create-backend
5188 :parent (or backend 'org)
5189 :transcoders
5190 `((table . ,(org-table--to-generic-table params))
5191 (table-row . ,(org-table--to-generic-row params))
5192 (table-cell . ,(org-table--to-generic-cell params))
5193 ;; Macros are not going to be expanded. However, no
5194 ;; regular back-end has a transcoder for them. We
5195 ;; provide one so they are not ignored, but displayed
5196 ;; as-is instead.
5197 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5198 data info)
5199 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5200 ;; Initialize communication channel in INFO.
5201 (with-temp-buffer
5202 (let ((org-inhibit-startup t)) (org-mode))
5203 (let ((standard-output (current-buffer))
5204 (org-element-use-cache nil))
5205 (dolist (e table)
5207 ((consp e)
5208 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5210 ;; Add back-end specific filters, but not user-defined ones. In
5211 ;; particular, make sure to call parse-tree filters on the
5212 ;; table.
5213 (setq info
5214 (let ((org-export-filters-alist nil))
5215 (org-export-install-filters
5216 (org-combine-plists
5217 (org-export-get-environment backend nil params)
5218 `(:back-end ,(org-export-get-backend backend))))))
5219 (setq data
5220 (org-export-filter-apply-functions
5221 (plist-get info :filter-parse-tree)
5222 (org-element-map (org-element-parse-buffer) 'table
5223 #'identity nil t)
5224 info)))
5225 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5226 (user-error "Unknown :backend value"))
5227 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5228 ;; Handle :skip parameter.
5229 (let ((skip (plist-get info :skip)))
5230 (when skip
5231 (unless (wholenump skip) (user-error "Wrong :skip value"))
5232 (let ((n 0))
5233 (org-element-map data 'table-row
5234 (lambda (row)
5235 (if (>= n skip) t
5236 (org-element-extract-element row)
5237 (cl-incf n)
5238 nil))
5239 nil t))))
5240 ;; Handle :skipcols parameter.
5241 (let ((skipcols (plist-get info :skipcols)))
5242 (when skipcols
5243 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5244 (org-element-map data 'table
5245 (lambda (table)
5246 (let ((specialp (org-export-table-has-special-column-p table)))
5247 (dolist (row (org-element-contents table))
5248 (when (eq (org-element-property :type row) 'standard)
5249 (let ((c 1))
5250 (dolist (cell (nthcdr (if specialp 1 0)
5251 (org-element-contents row)))
5252 (when (memq c skipcols)
5253 (org-element-extract-element cell))
5254 (cl-incf c))))))))))
5255 ;; Since we are going to export using a low-level mechanism,
5256 ;; ignore special column and special rows manually.
5257 (let ((special? (org-export-table-has-special-column-p data))
5258 ignore)
5259 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5260 (lambda (datum)
5261 (when (if (eq (org-element-type datum) 'table-row)
5262 (org-export-table-row-is-special-p datum nil)
5263 (org-export-first-sibling-p datum nil))
5264 (push datum ignore))))
5265 (setq info (plist-put info :ignore-list ignore)))
5266 ;; We use a low-level mechanism to export DATA so as to skip all
5267 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5268 ;; code evaluation, include keywords and macro expansion. Only
5269 ;; back-end specific filters are retained.
5270 (let ((output (org-export-data-with-backend data custom-backend info)))
5271 ;; Remove final newline.
5272 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5274 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5275 (cond ((null value) nil)
5276 ((functionp value) `(funcall ',value ,@args))
5277 ((stringp value)
5278 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5279 (args `(format ,value ,@args))
5280 (t value)))
5281 ((and with-cons (consp value))
5282 `(let ((val (cadr (memq column ',value))))
5283 (cond ((null val) contents)
5284 ((stringp val) (format val ,@args))
5285 ((functionp val) (funcall val ,@args))
5286 (t (user-error "Wrong %s value" ,name)))))
5287 (t (user-error "Wrong %s value" name))))
5289 (defun org-table--to-generic-table (params)
5290 "Return custom table transcoder according to PARAMS.
5291 PARAMS is a plist. See `orgtbl-to-generic' for more
5292 information."
5293 (let ((backend (plist-get params :backend))
5294 (splice (plist-get params :splice))
5295 (tstart (plist-get params :tstart))
5296 (tend (plist-get params :tend)))
5297 `(lambda (table contents info)
5298 (concat
5299 ,(and tstart (not splice)
5301 ,(if (or (not backend) tstart tend splice) 'contents
5302 `(org-export-with-backend ',backend table contents info))
5303 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5305 (defun org-table--to-generic-row (params)
5306 "Return custom table row transcoder according to PARAMS.
5307 PARAMS is a plist. See `orgtbl-to-generic' for more
5308 information."
5309 (let* ((backend (plist-get params :backend))
5310 (lstart (plist-get params :lstart))
5311 (llstart (plist-get params :llstart))
5312 (hlstart (plist-get params :hlstart))
5313 (hllstart (plist-get params :hllstart))
5314 (lend (plist-get params :lend))
5315 (llend (plist-get params :llend))
5316 (hlend (plist-get params :hlend))
5317 (hllend (plist-get params :hllend))
5318 (lfmt (plist-get params :lfmt))
5319 (llfmt (plist-get params :llfmt))
5320 (hlfmt (plist-get params :hlfmt))
5321 (hllfmt (plist-get params :hllfmt)))
5322 `(lambda (row contents info)
5323 (if (eq (org-element-property :type row) 'rule)
5324 ,(cond
5325 ((plist-member params :hline)
5326 (org-table--generic-apply (plist-get params :hline) ":hline"))
5327 (backend `(org-export-with-backend ',backend row nil info)))
5328 (let ((headerp ,(and (or hlfmt hlstart hlend)
5329 '(org-export-table-row-in-header-p row info)))
5330 (last-header-p
5331 ,(and (or hllfmt hllstart hllend)
5332 '(org-export-table-row-ends-header-p row info)))
5333 (lastp (not (org-export-get-next-element row info))))
5334 (when contents
5335 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5336 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5337 ;; `:lstart', `:lend' and their relatives.
5338 ,(let ((cells
5339 '(org-element-map row 'table-cell
5340 (lambda (cell)
5341 ;; Export all cells, without separators.
5342 ;;
5343 ;; Use `org-export-data-with-backend'
5344 ;; instead of `org-export-data' to eschew
5345 ;; cached values, which
5346 ;; ignore :orgtbl-ignore-sep parameter.
5347 (org-export-data-with-backend
5348 cell
5349 (plist-get info :back-end)
5350 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5351 info)))
5352 `(cond
5353 ,(and hllfmt
5354 `(last-header-p ,(org-table--generic-apply
5355 hllfmt ":hllfmt" nil cells)))
5356 ,(and hlfmt
5357 `(headerp ,(org-table--generic-apply
5358 hlfmt ":hlfmt" nil cells)))
5359 ,(and llfmt
5360 `(lastp ,(org-table--generic-apply
5361 llfmt ":llfmt" nil cells)))
5362 (t
5363 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5364 `(concat
5365 (cond
5366 ,(and
5367 (or hllstart hllend)
5368 `(last-header-p
5369 (concat
5370 ,(org-table--generic-apply hllstart ":hllstart")
5371 contents
5372 ,(org-table--generic-apply hllend ":hllend"))))
5373 ,(and
5374 (or hlstart hlend)
5375 `(headerp
5376 (concat
5377 ,(org-table--generic-apply hlstart ":hlstart")
5378 contents
5379 ,(org-table--generic-apply hlend ":hlend"))))
5380 ,(and
5381 (or llstart llend)
5382 `(lastp
5383 (concat
5384 ,(org-table--generic-apply llstart ":llstart")
5385 contents
5386 ,(org-table--generic-apply llend ":llend"))))
5387 (t
5388 ,(cond
5389 ((or lstart lend)
5390 `(concat
5391 ,(org-table--generic-apply lstart ":lstart")
5392 contents
5393 ,(org-table--generic-apply lend ":lend")))
5394 (backend
5395 `(org-export-with-backend
5396 ',backend row contents info))
5397 (t 'contents)))))))))))))))
5399 (defun org-table--to-generic-cell (params)
5400 "Return custom table cell transcoder according to PARAMS.
5401 PARAMS is a plist. See `orgtbl-to-generic' for more
5402 information."
5403 (let* ((backend (plist-get params :backend))
5404 (efmt (plist-get params :efmt))
5405 (fmt (plist-get params :fmt))
5406 (hfmt (plist-get params :hfmt))
5407 (sep (plist-get params :sep))
5408 (hsep (plist-get params :hsep)))
5409 `(lambda (cell contents info)
5410 ;; Make sure that contents are exported as Org data when :raw
5411 ;; parameter is non-nil.
5412 ,(when (and backend (plist-get params :raw))
5413 `(setq contents
5414 ;; Since we don't know what are the pseudo object
5415 ;; types defined in backend, we cannot pass them to
5416 ;; `org-element-interpret-data'. As a consequence,
5417 ;; they will be treated as pseudo elements, and will
5418 ;; have newlines appended instead of spaces.
5419 ;; Therefore, we must make sure :post-blank value is
5420 ;; really turned into spaces.
5421 (replace-regexp-in-string
5423 (org-trim
5424 (org-element-interpret-data
5425 (org-element-contents cell))))))
5427 (let ((headerp ,(and (or hfmt hsep)
5428 '(org-export-table-row-in-header-p
5429 (org-export-get-parent-element cell) info)))
5430 (column
5431 ;; Call costly `org-export-table-cell-address' only if
5432 ;; absolutely necessary, i.e., if one
5433 ;; of :fmt :efmt :hfmt has a "plist type" value.
5434 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5435 (list efmt hfmt fmt))
5436 '(1+ (cdr (org-export-table-cell-address cell info))))))
5437 (when contents
5438 ;; Check if we can apply `:efmt' on CONTENTS.
5439 ,(when efmt
5440 `(when (string-match orgtbl-exp-regexp contents)
5441 (let ((mantissa (match-string 1 contents))
5442 (exponent (match-string 2 contents)))
5443 (setq contents ,(org-table--generic-apply
5444 efmt ":efmt" t 'mantissa 'exponent)))))
5445 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5446 (cond
5447 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5448 hfmt ":hfmt" t 'contents))))
5449 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5450 fmt ":fmt" t 'contents))))))
5451 ;; If a separator is provided, use it instead of BACKEND's.
5452 ;; Separators are ignored when LFMT (or equivalent) is
5453 ;; provided.
5454 ,(cond
5455 ((or hsep sep)
5456 `(if (or ,(and (not sep) '(not headerp))
5457 (plist-get info :orgtbl-ignore-sep)
5458 (not (org-export-get-next-element cell info)))
5459 ,(if (not backend) 'contents
5460 `(org-export-with-backend ',backend cell contents info))
5461 (concat contents
5462 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5463 (or hsep sep)))))
5464 (backend `(org-export-with-backend ',backend cell contents info))
5465 (t 'contents))))))
5467 ;;;###autoload
5468 (defun orgtbl-to-tsv (table params)
5469 "Convert the orgtbl-mode table to TAB separated material."
5472 ;;;###autoload
5473 (defun orgtbl-to-csv (table params)
5474 "Convert the orgtbl-mode table to CSV material.
5475 This does take care of the proper quoting of fields with comma or quotes."
5476 (orgtbl-to-generic table
5477 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5478 params)))
5480 ;;;###autoload
5481 (defun orgtbl-to-latex (table params)
5482 "Convert the orgtbl-mode TABLE to LaTeX.
5484 TABLE is a list, each entry either the symbol `hline' for
5485 a horizontal separator line, or a list of fields for that line.
5486 PARAMS is a property list of parameters that can influence the
5487 conversion. All parameters from `orgtbl-to-generic' are
5488 supported. It is also possible to use the following ones:
5490 :booktabs
5494 :environment
5496 Specify environment to use, as a string. If you use
5498 as a string, to get proper continuation strings."
5499 (require 'ox-latex)
5500 (orgtbl-to-generic
5501 table
5502 (org-combine-plists
5503 ;; Provide sane default values.
5504 (list :backend 'latex
5505 :latex-default-table-mode 'table
5506 :latex-tables-centered nil
5507 :latex-tables-booktabs (plist-get params :booktabs)
5508 :latex-table-scientific-notation nil
5509 :latex-default-table-environment
5510 (or (plist-get params :environment) "tabular"))
5511 params)))
5513 ;;;###autoload
5514 (defun orgtbl-to-html (table params)
5515 "Convert the orgtbl-mode TABLE to HTML.
5517 TABLE is a list, each entry either the symbol `hline' for
5518 a horizontal separator line, or a list of fields for that line.
5519 PARAMS is a property list of parameters that can influence the
5520 conversion. All parameters from `orgtbl-to-generic' are
5521 supported. It is also possible to use the following one:
5523 :attributes
5525 Attributes and values, as a plist, which will be used in
5526 <table> tag."
5527 (require 'ox-html)
5528 (orgtbl-to-generic
5529 table
5530 (org-combine-plists
5531 ;; Provide sane default values.
5532 (list :backend 'html
5533 :html-table-data-tags '("<td%s>" . "</td>")
5534 :html-table-use-header-tags-for-first-column nil
5535 :html-table-align-individual-fields t
5536 :html-table-row-tags '("<tr>" . "</tr>")
5537 :html-table-attributes
5538 (if (plist-member params :attributes)
5539 (plist-get params :attributes)
5540 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5541 :frame "hsides")))
5542 params)))
5544 ;;;###autoload
5545 (defun orgtbl-to-texinfo (table params)
5546 "Convert the orgtbl-mode TABLE to Texinfo.
5548 TABLE is a list, each entry either the symbol `hline' for
5549 a horizontal separator line, or a list of fields for that line.
5550 PARAMS is a property list of parameters that can influence the
5551 conversion. All parameters from `orgtbl-to-generic' are
5552 supported. It is also possible to use the following one:
5554 :columns
5556 Column widths, as a string. When providing column fractions,
5558 (require 'ox-texinfo)
5559 (let ((output
5560 (orgtbl-to-generic
5561 table
5562 (org-combine-plists
5563 (list :backend 'texinfo
5564 :texinfo-tables-verbatim nil
5565 :texinfo-table-scientific-notation nil)
5566 params)))
5567 (columns (let ((w (plist-get params :columns)))
5568 (cond ((not w) nil)
5570 (t (concat "@columnfractions " w))))))
5571 (if (not columns) output
5572 (replace-regexp-in-string
5575 ;;;###autoload
5576 (defun orgtbl-to-orgtbl (table params)
5577 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5579 TABLE is a list, each entry either the symbol `hline' for
5580 a horizontal separator line, or a list of fields for that line.
5581 PARAMS is a property list of parameters that can influence the
5582 conversion. All parameters from `orgtbl-to-generic' are
5583 supported.
5585 Useful when slicing one table into many. The :hline, :sep,
5586 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5587 be set to provide ORGTBL directives for the generated table."
5588 (require 'ox-org)
5589 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5591 (defun orgtbl-to-table.el (table params)
5592 "Convert the orgtbl-mode TABLE into a table.el table.
5593 TABLE is a list, each entry either the symbol `hline' for
5594 a horizontal separator line, or a list of fields for that line.
5595 PARAMS is a property list of parameters that can influence the
5596 conversion. All parameters from `orgtbl-to-generic' are
5597 supported."
5598 (with-temp-buffer
5599 (insert (orgtbl-to-orgtbl table params))
5600 (org-table-align)
5601 (replace-regexp-in-string
5602 "-|" "-+"
5603 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5605 (defun orgtbl-to-unicode (table params)
5606 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5608 TABLE is a list, each entry either the symbol `hline' for
5609 a horizontal separator line, or a list of fields for that line.
5610 PARAMS is a property list of parameters that can influence the
5611 conversion. All parameters from `orgtbl-to-generic' are
5612 supported. It is also possible to use the following ones:
5614 :ascii-art
5617 the table. You can download it here:
5618 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5620 :narrow
5622 When non-nil, narrow columns width than provided width cookie,
5624 (require 'ox-ascii)
5625 (orgtbl-to-generic
5626 table
5627 (org-combine-plists
5628 (list :backend 'ascii
5629 :ascii-charset 'utf-8
5630 :ascii-table-widen-columns (not (plist-get params :narrow))
5631 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5632 params)))
5634 ;; Put the cursor in a column containing numerical values
5635 ;; of an Org table,
5636 ;; type C-c " a
5637 ;; A new column is added with a bar plot.
5638 ;; When the table is refreshed (C-u C-c *),
5639 ;; the plot is updated to reflect the new values.
5641 (defun orgtbl-ascii-draw (value min max &optional width characters)
5642 "Draw an ascii bar in a table.
5643 VALUE is the value to plot, it determines the width of the bar to draw.
5644 MIN is the value that will be displayed as empty (zero width bar).
5645 MAX is the value that will draw a bar filling all the WIDTH.
5646 WIDTH is the span in characters from MIN to MAX.
5647 CHARACTERS is a string that will compose the bar, with shades of grey
5648 from pure white to pure black. It defaults to a 10 characters string
5649 of regular ascii characters."
5650 (let* ((width (ceiling (or width 12)))
5651 (characters (or characters " .:;c!lhVHW"))
5652 (len (1- (length characters)))
5653 (value (float (if (numberp value)
5654 value (string-to-number value))))
5655 (relative (/ (- value min) (- max min)))
5656 (steps (round (* relative width len))))
5657 (cond ((< steps 0) "too small")
5658 ((> steps (* width len)) "too large")
5659 (t (let* ((int-division (/ steps len))
5660 (remainder (- steps (* int-division len))))
5661 (concat (make-string int-division (elt characters len))
5662 (string (elt characters remainder))))))))
5664 ;;;###autoload
5665 (defun orgtbl-ascii-plot (&optional ask)
5666 "Draw an ASCII bar plot in a column.
5668 With cursor in a column containing numerical values, this function
5669 will draw a plot in a new column.
5671 ASK, if given, is a numeric prefix to override the default 12
5673 prefix,
5674 which will prompt for the width."
5675 (interactive "P")
5676 (let ((col (org-table-current-column))
5677 (min 1e999) ; 1e999 will be converted to infinity
5678 (max -1e999) ; which is the desired result
5679 (table (org-table-to-lisp))
5680 (length
5681 (cond ((consp ask)
5682 (read-number "Length of column " 12))
5683 ((numberp ask) ask)
5684 (t 12))))
5685 ;; Skip any hline a the top of table.
5686 (while (eq (car table) 'hline) (setq table (cdr table)))
5687 ;; Skip table header if any.
5688 (dolist (x (or (cdr (memq 'hline table)) table))
5689 (when (consp x)
5690 (setq x (nth (1- col) x))
5691 (when (string-match
5693 x)
5694 (setq x (string-to-number x))
5695 (when (> min x) (setq min x))
5696 (when (< max x) (setq max x)))))
5697 (org-table-insert-column)
5698 (org-table-move-column-right)
5699 (org-table-store-formulas
5700 (cons
5701 (cons
5702 (concat "$" (number-to-string (1+ col)))
5703 (format "'(%s $%s %s %s %s)"
5704 "orgtbl-ascii-draw" col min max length))
5705 (org-table-get-stored-formulas)))
5706 (org-table-recalculate t)))
5708 ;; Example of extension: unicode characters
5709 ;; Here are two examples of different styles.
5711 ;; Unicode block characters are used to give a smooth effect.
5712 ;; See http://en.wikipedia.org/wiki/Block_Elements
5713 ;; Use one of those drawing functions
5714 ;; - orgtbl-ascii-draw (the default ascii)
5715 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5716 ;; - orgtbl-uc-draw-cont (smooth unicode)
5718 ;; This is best viewed with the "DejaVu Sans Mono" font
5719 ;; (use M-x set-default-font).
5721 (defun orgtbl-uc-draw-grid (value min max &optional width)
5722 "Draw a bar in a table using block unicode characters.
5723 It is a variant of orgtbl-ascii-draw with Unicode block
5724 characters, for a smooth display. Bars appear as grids (to the
5725 extent the font allows)."
5726 ;; http://en.wikipedia.org/wiki/Block_Elements
5727 ;; best viewed with the "DejaVu Sans Mono" font.
5728 (orgtbl-ascii-draw value min max width
5731 (defun orgtbl-uc-draw-cont (value min max &optional width)
5732 "Draw a bar in a table using block unicode characters.
5733 It is a variant of orgtbl-ascii-draw with Unicode block
5734 characters, for a smooth display. Bars are solid (to the extent
5735 the font allows)."
5736 (orgtbl-ascii-draw value min max width
5739 (defun org-table-get-remote-range (name-or-id form)
5740 "Get a field value or a list of values in a range from table at ID.
5742 NAME-OR-ID may be the name of a table in the current file as set
5744 will then be used. Alternatively, it may be an ID referring to
5745 any entry, also in a different file. In this case, the first
5746 table in that entry will be referenced.
5750 The return value is either a single string for a single field, or a
5751 list of the fields in the rectangle."
5752 (save-match-data
5753 (let ((case-fold-search t) (id-loc nil)
5754 ;; Protect a bunch of variables from being overwritten by
5755 ;; the context of the remote table.
5756 org-table-column-names org-table-column-name-regexp
5757 org-table-local-parameters org-table-named-field-locations
5758 org-table-current-line-types
5759 org-table-current-begin-pos org-table-dlines
5760 org-table-current-ncol
5761 org-table-hlines
5762 org-table-last-column-widths
5763 org-table-last-alignment
5764 buffer loc)
5765 (setq form (org-table-convert-refs-to-rc form))
5766 (org-with-wide-buffer
5767 (goto-char (point-min))
5768 (if (re-search-forward
5771 nil t)
5772 (setq buffer (current-buffer) loc (match-beginning 0))
5773 (setq id-loc (org-id-find name-or-id 'marker))
5774 (unless (and id-loc (markerp id-loc))
5776 (setq buffer (marker-buffer id-loc)
5777 loc (marker-position id-loc))
5778 (move-marker id-loc nil))
5779 (with-current-buffer buffer
5780 (org-with-wide-buffer
5781 (goto-char loc)
5782 (forward-char 1)
5784 (not (match-beginning 1)))
5785 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5786 (org-table-analyze)
5787 (setq form (org-table-formula-substitute-names
5788 (org-table-formula-handle-first/last-rc form)))
5789 (if (and (string-match org-table-range-regexp form)
5790 (> (length (match-string 0 form)) 1))
5791 (org-table-get-range
5792 (match-string 0 form) org-table-current-begin-pos 1)
5793 form)))))))
5795 (defun org-table-remote-reference-indirection (form)
5796 "Return formula with table remote references substituted by indirection.
5798 This indirection works only with the format @ROW$COLUMN. The
5800 distinguished from a plain table name or ID."
5801 (let ((regexp
5802 ;; Same as in `org-table-eval-formula'.
5804 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5807 (replace-regexp-in-string
5808 regexp
5809 (lambda (m)
5810 (save-match-data
5811 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5812 (org-table-get-range
5814 (concat "@0" eq)
5815 eq)))))
5816 form t t 1)))
5818 (defmacro org-define-lookup-function (mode)
5819 (let ((mode-str (symbol-name mode))
5820 (first-p (eq mode 'first))
5821 (all-p (eq mode 'all)))
5822 (let ((plural-str (if all-p "s" "")))
5823 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5824 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5825 If R-LIST is nil, return matching element%s of S-LIST.
5826 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5827 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5828 This function is generated by a call to the macro `org-define-lookup-function'."
5829 mode-str plural-str plural-str plural-str)
5830 (let ,(let ((lvars '((p (or predicate 'equal))
5831 (sl s-list)
5832 (rl (or r-list s-list))
5833 (ret nil))))
5834 (if first-p (cons '(match-p nil) lvars) lvars))
5835 (while ,(if first-p '(and (not match-p) sl) 'sl)
5836 (when (funcall p val (car sl))
5837 ,(when first-p '(setq match-p t))
5838 (let ((rval (car rl)))
5839 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5840 (setq sl (cdr sl) rl (cdr rl)))
5841 ret)))))
5843 (org-define-lookup-function first)
5844 (org-define-lookup-function last)
5845 (org-define-lookup-function all)
5847 (provide 'org-table)
5849 ;; Local variables:
5850 ;; generated-autoload-file: "org-loaddefs.el"
5851 ;; End:
5853 ;;; org-table.el ends here