| blob | 4d2f7bd319136575ea1f0746fc6fdea55c5daa15 |
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 <http://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'.
86 In the optimized version, the table editor takes over all simple keys that
87 normally just insert a character. In tables, the characters are inserted
88 in a way to minimize disturbing the table structure (i.e. in overwrite mode
89 for empty fields). Outside tables, the correct binding of the keys is
90 restored.
92 The default for this option is t if the optimized version is also used in
93 Org mode. See the variable `org-enable-table-editor' for details. Changing
94 this variable requires a restart of Emacs to become 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).
212 Only relevant when `org-enable-table-editor' is equal to `optimized'."
217 "Non-nil means automatically exit the follow mode.
218 When nil, the follow mode will stay on and be active in any table
219 the cursor enters. Since the table follow filed mode messes with the
220 window configuration, it is not recommended to set this variable to nil,
221 except maybe locally in a special file that has mostly tables with long
222 fields."
228 "Whether the user should confirm when Org fixes formulas."
236 'safe-local-variable
240 "Non-nil means tab in the last column of a table with jump over a hline.
241 If a horizontal separator line is following the current line,
242 `org-table-next-field' can either create a new row before that line, or jump
243 over the line. When this option is nil, a new line will be created before
244 this line."
249 "Options concerning tables in Org mode."
254 "Non-nil means using table references like B3 instead of @3$2.
255 Possible values are:
256 nil never use them
257 from accept as input, do not present for editing
258 t accept as input and present for editing"
266 "Non-nil means increment when copying current field with \
279 calc-angle-mode deg
280 calc-prefer-frac nil
281 calc-symbolic-mode nil
283 calc-display-working-message t
284 )
285 "List with Calc mode settings for use in `calc-eval' for table formulas.
286 The list must contain alternating symbols (Calc modes variables and values).
287 Don't remove any of the default settings, just change the values. Org mode
288 relies on the variables to be present in the list."
293 "Format for the output of calc computations like $1+$2;t.
294 The default value is `hours', and will output the results as a
295 number of hours. Other allowed values are `seconds', `minutes' and
296 `days', and the output will be a fraction of seconds, minutes or
297 days."
306 "Format for fields which contain the result of a formula.
308 characters. Beware that modifying the display can prevent the
309 field from being used in another formula."
315 "Non-nil means TAB and RET evaluate a formula in current table field.
316 If the current field starts with an equal sign, it is assumed to be a formula
317 which should be evaluated as described in the manual and in the documentation
318 string of the command `org-table-eval-formula'. This feature requires the
319 Emacs calc package.
320 When this variable is nil, formula calculation is only available through
326 "Non-nil means interpret constants in formulas in tables.
327 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
328 by the value given in `org-table-formula-constants', or by a value obtained
329 from the `constants.el' package."
334 "Alist with constant names and values, for use in table formulas.
335 The car of each element is a name of a constant, without the `$' before it.
336 The cdr is the value as a string. For example, if you'd like to use the
337 speed of light in a formula, you would configure
341 and then use it in an equation like `$1*$c'.
343 Constants can also be defined on a per-file basis using a line like
345 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
352 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
355 are pressed in the line."
360 "Non-nil means relative formula references may cross hlines.
361 Here are the allowed values:
363 nil Relative references may not cross hlines. They will reference the
364 field next to the hline instead. Coming from below, the reference
365 will be to the field below the hline. Coming from above, it will be
366 to the field above.
367 t Relative references may cross hlines.
368 error An attempt to cross a hline will throw an error.
370 It is probably good to never set this variable to nil, for the sake of
371 portability of tables."
379 "Non-nil means that evaluation of a field formula can add new
380 columns if an out-of-bounds field is being set."
387 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
391 "Options concerning table import and export in Org mode."
396 "Default export parameters for `org-table-export'.
397 These can be overridden for a specific table by setting the
398 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
399 radio tables for the different export transformations and
400 available parameters."
405 "Max lines that `org-table-convert-region' will attempt to process.
407 The function can be slow on larger regions; this safety feature
408 prevents it from hanging emacs."
431 "Alist with column names, derived from the `!' line.
435 "Regular expression matching the current column names.
439 "Alist with parameter names, derived from the `$' line.
443 "Alist with locations of named fields.
444 Associations follow the pattern (NAME LINE COLUMN) where
445 NAME is the name of the field as a string,
446 LINE is the number of lines from the beginning of the table,
447 COLUMN is the column of the field, as an integer.
451 "Table row types in current table.
455 "Current table begin position, as a marker.
459 "Number of columns in current table.
463 "Vector of data line line numbers in the current table.
464 Line numbers are counted from the beginning of the table. This
468 "Vector of hline line numbers in the current table.
469 Line numbers are counted from the beginning of the table. This
473 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
474 ;; 1 2 3 4 5
489 "Save current field; execute BODY; restore field.
490 Field is restored even in case of abnormal exit."
501 ;;;###autoload
503 "Use the table.el package to insert a new table.
504 If there is already a table at point, convert between Org tables
505 and table.el tables."
518 ;;;###autoload
520 "Convert region to table, or create an empty table.
521 If there is an active region, convert it to a table, using the function
522 `org-table-convert-region'. See the documentation of that function
523 to learn how the prefix argument is interpreted to determine the field
524 separator.
525 If there is no such region, create an empty table with `org-table-create'."
531 ;;;###autoload
533 "Query for a size and insert a table skeleton.
553 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
557 ;; Insert a hline after the first row.
564 ;;;###autoload
566 "Convert region to a table.
568 The region goes from BEG0 to END0, but these borders will be moved
569 slightly, to make sure a beginning of line in the first line is included.
571 SEPARATOR specifies the field separator in the lines. It can have the
572 following values:
574 (4) Use the comma as a field separator
575 (16) Use a TAB as field separator
576 (64) Prompt for a regular expression as field separator
577 integer When a number, use that many spaces, or a TAB, as field separator
578 regexp When a regular expression, use it to match the separator
579 nil When nil, the command tries to be smart and figure out the
580 separator in the following way:
581 - when each line contains a TAB, assume TAB-separated material
582 - when each line contains a comma, assume CSV material
583 - else, assume one or more SPACE characters as separator."
587 re)
589 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
590 org-table-convert-region-max-lines)
599 ;; Get the right field separator
610 ;; parse the csv stuff
635 ;;;###autoload
637 "Import FILE as a table.
638 The file is assumed to be tab-separated. Such files can be produced by most
639 spreadsheet and database applications. If no tabs (at least one per line)
640 are found, lines will be split on whitespace into fields."
649 ;;;###autoload
651 "Export table to a file, with configurable format.
652 Such a file can be imported into usual spreadsheet programs.
654 FILE can be the output file name. If not given, it will be taken
655 from a TABLE_EXPORT_FILE property in the current entry or higher
656 up in the hierarchy, or the user will be prompted for a file
657 name. FORMAT can be an export format, of the same kind as it
658 used when `orgtbl-mode' sends a table in a different format.
660 The command suggests a format depending on TABLE_EXPORT_FORMAT,
661 whether it is set locally or up in the hierarchy, then on the
662 extension of the given file name, and finally on the variable
663 `org-table-export-default-format'."
696 formats)))
697 org-table-export-default-format)
723 "Marker at the beginning of the table last aligned.
726 "Marker at the end of the table last aligned.
729 "List of flags for flushright alignment, from the last re-alignment.
732 "List of max width of fields in each column.
735 "Non-nil means debug table formulas.
745 ;;;###autoload
747 "Align the table at point by aligning all vertical bars."
752 ;; Make sure invisible characters in the table are at the right
753 ;; place since column widths take them into account.
759 ;; Table's rows. Separators are replaced by nil. Trailing
760 ;; spaces are also removed.
766 l)))
768 ;; Get the data fields by splitting the lines.
771 ;; Compute number of fields in the longest line. If the
772 ;; table contains no field, create a default table.
777 ;; A list of empty strings to fill any short rows on output.
779 lengths typenums)
780 ;; Check for special formatting.
783 fmax falign)
784 ;; Look for an explicit width or alignment.
797 ;; Find fields that are wider than FMAX, and shorten them.
802 'help-echo
810 fmax)))
824 f2
826 x))))))
827 ;; Get the maximum width for each column
829 lengths)
830 ;; Get the fraction of numbers among non-empty cells to
831 ;; decide about alignment of the column.
840 1
846 ;; Store alignment of this table, for later editing of single
847 ;; fields.
850 ;; With invisible characters, `format' does not get the field
851 ;; width right So we need to make these fields wide by hand.
852 ;; Invisible characters may be introduced by fontified links,
853 ;; emphasis, macros or sub/superscripts.
871 ;; Compute the formats needed for output of the table.
880 ;; Replace modified lines only. Check not only contents, but
881 ;; also columns' width.
885 hfmt))
907 ;;;###autoload
909 "Find the beginning of the table and return its position.
910 With a non-nil optional argument TABLE-TYPE, return the beginning
911 of a table.el-type table. This function assumes point is on
912 a table."
920 ;;;###autoload
922 "Find the end of the table and return its position.
923 With a non-nil optional argument TABLE-TYPE, return the end of
924 a table.el-type table. This function assumes point is on
925 a table."
933 ;; When the line right after the table is the last line in
934 ;; the buffer with trailing spaces but no final newline
935 ;; character, be sure to catch the correct ending at its
936 ;; beginning. In any other case, ending is expected to be
937 ;; at point max.
942 ;;;###autoload
944 "Justify the current field, text to left, number to right.
945 Optional argument NEW may specify text to replace the current field content."
954 ;; This is not the same table, force a full re-align.
957 ;; Realign the current field, based on previous full realign.
970 len
985 ;;;###autoload
987 "Go to the next field in the current table, creating new lines as needed.
988 Before doing so, re-align the table if necessary."
993 org-table-may-need-update)
1004 org-table-tab-jumps-over-hlines
1015 ;;;###autoload
1017 "Go to the previous field in the table.
1018 Before doing so, re-align the table if necessary."
1023 org-table-may-need-update)
1038 "Move to the beginning of the current table field.
1039 If already at or before the beginning, move to the beginning of the
1040 previous field.
1041 With numeric argument N, move N-1 fields backward first."
1054 "Move to the end of the current table field.
1055 If already at or after the end, move to the end of the next table field.
1056 With numeric argument N, move N-1 fields forward first."
1069 ;;;###autoload
1071 "Go to the next row (same column) in the current table.
1072 Before doing so, re-align the table if necessary."
1080 org-table-may-need-update)
1093 ;;;###autoload
1095 "Copy the value of the current field one row below.
1097 If the field at the cursor is empty, copy the content of the
1098 nearest non-empty field above. With argument N, use the Nth
1099 non-empty field.
1101 If the current field is not empty, it is copied down to the next
1102 row, and the cursor is moved with it. Therefore, repeating this
1103 command causes the column to be filled row-by-row.
1105 If the variable `org-table-copy-increment' is non-nil and the
1106 field is an integer or a timestamp, it will be incremented while
1107 copying. By default, increment by the difference between the
1108 value in the current field and the one in the field above. To
1109 increment using a fixed integer, set `org-table-copy-increment'
1110 to a number. In the case of a timestamp, increment by days."
1122 txt txt-up inc)
1130 beg t))
1140 beg t))
1147 ;; Above field was not empty, go down to the next row
1180 "Is point inside a table data field?
1181 I.e. not on a hline or before the first or after the last column?
1182 This actually throws an error, so it aborts the current command."
1194 "Get the field in table line LINE, column COLUMN.
1195 If LINE is larger than the number of data lines in the table, the function
1196 returns nil. However, if COLUMN is too large, we will simply return an
1197 empty string.
1198 If LINE is nil, use the current line.
1199 If COLUMN is nil, use the current column."
1206 "Put VALUE into line LINE, column COLUMN.
1207 When ALIGN is set, also realign the table."
1216 "Return the index of the current data line."
1223 cnt))
1226 "Go to the Nth data line in the current table.
1227 Return t when the line exists, nil if it does not exist."
1234 ;;;###autoload
1236 "Blank the current table field or active region."
1253 "Return the value of the field in column N of current row.
1254 N defaults to current field.
1255 If REPLACE is a string, replace field with this value. The return value
1256 is always the old value."
1265 t t))
1267 val)
1270 ;;;###autoload
1272 "Show info about the current field, and highlight any reference at point."
1282 col)
1283 org-table-named-field-locations)))
1293 ;; Prioritize field formulas over column formulas.
1302 dline col
1304 dline col ref1
1306 ;; FIXME: formula info not correct if special table line
1313 ""
1319 "Find out which column we are in."
1324 column)))
1327 "Find out what table data line we are in.
1328 Only data lines count for this."
1336 c)))
1338 ;;;###autoload
1340 "Move the cursor to the Nth column in the current table line.
1341 With optional argument ON-DELIM, stop with point before the left delimiter
1342 of the field.
1343 If there are less than N fields, just go to after the last delimiter.
1344 However, when FORCE is non-nil, create new columns if necessary."
1354 t)))))
1361 ;;;###autoload
1363 "Insert a new column into the table."
1385 "Find a data line in the current table, which is needed for column commands."
1388 t
1399 t
1404 "Turn a buffer line number into a data line number.
1406 If there is no data line in this line, return nil.
1408 If there is no matching dline (most likely the reference was
1409 a hline), the first dline below it is used. When ABOVE is
1410 non-nil, the one above is used."
1415 nil)
1426 ;;;###autoload
1428 "Delete a column from the table."
1440 nil
1455 ;;;###autoload
1457 "Move column to the right."
1460 ;;;###autoload
1462 "Move column to the left."
1466 ;;;###autoload
1468 "Move the current column to the right. With arg LEFT, move to the left."
1502 ;;;###autoload
1504 "Move table row down."
1507 ;;;###autoload
1509 "Move table row up."
1513 ;;;###autoload
1515 "Move the current table line down. With arg UP, move it up."
1524 txt hline2p)
1547 ;;;###autoload
1549 "Insert a new row above the current line into the table.
1550 With prefix ARG, insert below the current line."
1555 ;; Fix the first field if necessary
1559 ;; Buffer may not end of a newline character, so ensure
1560 ;; (beginning-of-line 2) moves point to a new line.
1571 ;;;###autoload
1573 "Insert a horizontal-line below the current line into the table.
1574 With prefix ABOVE, insert above the current line."
1595 ;;;###autoload
1597 "Insert a hline and move to the row below that line."
1611 In particular, this does handle wide and invisible characters."
1613 ;; It's a hline, just map the characters
1619 t t s)))
1620 s))
1622 ;;;###autoload
1624 "Delete the current row or horizontal line from the table."
1638 ;;;###autoload
1640 "Sort table lines according to the column at point.
1642 The position of point indicates the column to be used for
1643 sorting, and the range of lines is the range between the nearest
1644 horizontal separator lines, or the entire table of no such lines
1645 exist. If point is before the first column, you will be prompted
1646 for the sorting column. If there is an active region, the mark
1647 specifies the first line and the sorting column, while point
1648 should be in the last line to be included into the sorting.
1650 The command then prompts for the sorting type which can be
1651 alphabetically, numerically, or by time (as given in a time stamp
1652 in the field, or as a HH:MM value). Sorting in reverse order is
1653 also possible.
1655 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1657 If SORTING-TYPE is specified when this function is called from a Lisp
1658 program, no prompting will take place. SORTING-TYPE must be a character,
1659 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1660 sorting should be done in reverse order.
1662 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1663 a function to be called to extract the key. It must return either
1664 a string or a number that should serve as the sorting key for that
1665 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1666 is specified interactively, the comparison will be either a string or
1667 numeric compare based on the type of the first key in the table."
1670 ;; Point must be either within a field or before a data line.
1675 ;; Set appropriate case sensitivity and column used for sorting.
1686 ;; Narrow buffer to appropriate sorting area.
1699 start))
1702 end))))
1703 ;; Determine arguments for `sort-subr'. Also record original
1704 ;; position. `org-table-save-field' cannot help here since
1705 ;; sorting is too much destructive.
1711 ;; Function to be called on the contents of the field
1712 ;; used for sorting in the current row.
1744 #'end-of-line
1748 nil
1749 predicate)
1750 ;; Move back to initial field.
1754 ;;;###autoload
1756 "Copy region in table to the clipboard and blank all relevant fields.
1757 If there is no active region, use just the field at point."
1763 ;;;###autoload
1765 "Copy rectangular region in table to clipboard.
1766 A special clipboard is used which can only be accessed
1767 with `org-table-paste-rectangle'."
1771 current-prefix-arg))
1776 region)
1788 ;; Collect every cell between COLUMN-START and COLUMN-END.
1798 ;;;###autoload
1800 "Paste a rectangular region into a table.
1801 The upper right corner ends up in the current field. All involved fields
1802 will be overwritten. If the rectangle does not fit into the present table,
1803 the table is enlarged as needed. The process ignores horizontal separator
1804 lines."
1815 ;; If we left the table, create a new row.
1827 ;;;###autoload
1829 "Convert from `org-mode' table to table.el and back.
1830 Obviously, this only works within limits. When an Org table is converted
1831 to table.el, all horizontal separator lines get lost, because table.el uses
1832 these as cell boundaries and has no notion of horizontal lines. A table.el
1833 table can be converted to an Org table only if it does not do row or column
1834 spanning. Multiline cells will become multiple cells. Beware, Org mode
1835 does not test if the table can be successfully converted - it blindly
1836 applies a recipe that works for simple tables."
1840 ;; convert to Org table
1849 ;; convert to table.el table
1852 ;; first, get rid of all horizontal lines
1856 ;; insert a hline before first
1860 ;; insert a hline after each line
1865 ;; replace "+" at beginning and ending of hlines
1874 "Transpose Org table at point and eliminate hlines.
1875 So a table like
1877 | 1 | 2 | 4 | 5 |
1878 |---+---+---+---|
1879 | a | b | c | d |
1880 | e | f | g | h |
1882 will be transposed as
1884 | 1 | a | e |
1885 | 2 | b | f |
1886 | 4 | c | g |
1887 | 5 | d | h |
1889 Note that horizontal lines disappear."
1901 table)))
1915 ;;;###autoload
1917 "Wrap several fields in a column like a paragraph.
1918 This is useful if you'd like to spread the contents of a field over several
1919 lines, in order to keep the table compact.
1921 If there is an active region, and both point and mark are in the same column,
1922 the text in the column is wrapped to minimum width for the given number of
1923 lines. Generally, this makes the table more compact. A prefix ARG may be
1924 used to change the number of desired lines. For example, \
1926 formats the selected text to two lines. If the region was longer than two
1927 lines, the remaining lines remain empty. A negative prefix argument reduces
1928 the current number of lines by that amount. The wrapped text is pasted back
1929 into the table. If you formatted it to more lines than it was before, fields
1930 further down in the table get overwritten - so you might need to make space in
1931 the table first.
1933 If there is no region, the current field is split at the cursor position and
1934 the text fragment to the right of the cursor is prepended to the field one
1935 line down.
1937 If there is no region, but you specify a prefix ARG, the current field gets
1938 blank, and the content is appended to the field above."
1942 ;; There is a region: fill as a paragraph.
1953 nil
1954 nlines))))
1957 ;; No region, split the current field at point.
1982 ;;;###autoload
1984 "Edit table field in a different window.
1985 This is mainly useful for fields that contain hidden parts.
1988 visible so that it can be edited in place.
1991 toggle `org-table-follow-field-mode'."
2001 display t intangible t))
2014 p)
2030 intangible t))
2038 "Finish editing a table data field.
2039 Remove all newline characters, insert the result into the table, realign
2040 the table and kill the editing buffer."
2044 text)
2061 "Minor mode to make the table field editor window follow the cursor.
2062 When this mode is active, the field editor window will always show the
2063 current field. The mode exits automatically when the cursor leaves the
2064 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2065 nil " TblFollow" nil
2081 ;; We have left the table, exit the follow mode
2091 ;;;###autoload
2093 "Sum numbers in region of current table column.
2094 The result will be displayed in the echo area, and will be available
2097 If there is an active region, it is interpreted as a rectangle and all
2098 numbers in that rectangle will be summed. If there is no active
2099 region and point is located in a table column, sum all numbers in that
2100 column.
2102 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2103 numbers are assumed to be times as well (in decimal hours) and the
2104 numbers are added as such.
2106 If NLAST is a number, only the NLAST fields will actually be summed."
2133 items1)))
2140 s diff)
2147 sres))))
2170 "Return the formula active for the current field.
2172 Assumes that table is already analyzed. If KEY is given, return
2173 the key to this formula. Otherwise return the formula preceded
2182 org-table-named-field-locations)))
2196 "Read a formula from the minibuffer, offer stored formula as default.
2197 When NAMED is non-nil, look for a named equation."
2202 org-table-named-field-locations)))
2215 stored)
2217 equation)
2223 scol))
2225 'org-table-formula-history
2226 )))))
2227 mustsave)
2229 ;; remove formula
2236 ;; We set the column equation, delete the named one.
2238 mustsave t))
2244 eq))
2247 "Store the list of formulas below the current table.
2248 If optional argument LOCATION is a buffer position, insert it at
2249 LOCATION instead."
2257 ;; Don't overwrite TBLFM, we might use text properties to
2258 ;; store stuff.
2272 ;; Fake a high number to make sure this is sorted at the end.
2279 a)
2289 "Compare two formulas for sorting."
2294 ;;;###autoload
2296 "Return an alist with the stored formulas directly after current table.
2297 By default, only return active formulas, i.e., formulas located
2298 on the first line after the table. However, if optional argument
2299 LOCATION is a buffer position, consider the formulas there."
2308 eq-alist seen)
2312 string)
2317 ;; Is it a column reference?
2319 ;; Since named columns are not possible in
2320 ;; LHS, assume this is a named field.
2328 "Double definition `%s=' in TBLFM line, please fix by hand"
2329 lhs)
2334 "Double definition `%s=' in TBLFM line, please fix by hand"
2335 lhs)))))))))))
2338 "Modify the equations after the table structure has been edited.
2340 For all numbers larger than LIMIT, shift them by DELTA."
2352 s n a)
2358 "Change makes TBLFM term %s invalid, use undo to recover"
2373 ;;;###autoload
2376 If yes, store the formula and apply it."
2377 ;; We already know we are in a table. Get field will only return a formula
2378 ;; when appropriate. It might return a separator line, but no problem.
2381 named eq)
2389 "List of commands triggering the recalculation of a line.
2401 ;;;###autoload
2403 "Rotate the recalculation mark in the first column.
2404 If in any row, the first field is not consistent with a mark,
2405 insert a new column for the markers.
2406 When there is an active region, change all the lines in the region,
2407 after prompting for the marking character.
2408 After each change, a message will be displayed indicating the meaning
2409 of the new mark."
2425 newchar))
2433 newchar))
2451 ;; Rotate mark in first row.
2453 ;; Rotate marks in additional rows if a region is active.
2461 ;; Only align if rotation actually changed lines' length.
2471 ;;;###autoload
2473 "Analyze table at point and store results.
2475 This function sets up the following dynamically scoped variables:
2477 `org-table-column-name-regexp',
2478 `org-table-column-names',
2479 `org-table-current-begin-pos',
2480 `org-table-current-line-types',
2481 `org-table-current-ncol',
2482 `org-table-dlines',
2483 `org-table-hlines',
2484 `org-table-local-parameters',
2485 `org-table-named-field-locations'."
2490 ;; Extract column names.
2503 ;; Extract local parameters.
2511 org-table-local-parameters)))))
2512 ;; Update named fields locations. We minimize `count-lines'
2513 ;; processing by storing last known number of lines in LAST.
2535 field))
2538 org-table-named-field-locations))))))))))
2539 ;; Re-use existing markers when possible.
2543 ;; Analyze the line types.
2554 ;; Get the number of columns from the first data line in table.
2562 al al2)
2576 "Move point to a specific field in the current table.
2578 REF is either the name of a field its absolute reference, as
2579 a string. No column is created unless CREATE-COLUMN-P is
2580 non-nil. If it is a function, it is called with the column
2581 number as its argument as is used as a predicate to know if the
2582 column can be created.
2584 This function assumes the table is already analyzed (i.e., using
2585 `org-table-analyze')."
2600 create-column-p)))
2606 ;;;###autoload
2608 "Recompute the current line if marked for it, and if we haven't just done it."
2628 org-tbl-calc-modes)
2630 ;;;###autoload
2632 suppress-align suppress-const
2633 suppress-store suppress-analysis)
2634 "Replace the table field value at the cursor by the result of a calculation.
2636 In a table, this command replaces the value in the current field with the
2638 formula, by storing it in a special line below the table. When called
2640 field formula.
2643 insert the active equation for the field
2644 back into the current field, so that it can be edited there. This is \
2645 useful
2647 check the referenced fields.
2649 When called, the command first prompts for a formula, which is read in
2650 the minibuffer. Previously entered formulas are available through the
2651 history list, and the last used formula is offered as a default.
2652 These stored formulas are adapted correctly when moving, inserting, or
2653 deleting columns with the corresponding commands.
2655 The formula can be any algebraic expression understood by the Calc package.
2656 For details, see the Org mode manual.
2658 This function can also be called from Lisp programs and offers
2659 additional arguments: EQUATION can be the formula to apply. If this
2660 argument is given, the user will not be prompted.
2662 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2663 unnecessary aligns.
2665 SUPPRESS-CONST suppresses the interpretation of constants in the
2666 formula, assuming that this has been done already outside the
2667 function.
2669 SUPPRESS-STORE means the formula should not be stored, either
2670 because it is already stored, or because it is a modified
2671 equation that should not overwrite the stored one.
2673 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2674 location of point."
2690 equation
2696 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2697 duration duration-output-format)
2698 ;; Parse the format string. Since we have a lot of modes, this is
2699 ;; a lot of work. However, I think calc still uses most of the time.
2712 'calc-float-format
2715 n))))
2719 duration-output-format nil
2723 duration-output-format org-table-duration-custom-format
2724 numbers t
2750 ;; replace fields with duration values if relevant
2754 fields)))
2760 x))
2761 fields)))
2767 ;; Insert row and column number of formula result field
2778 t t form)))
2780 ;; Check for old vertical references
2782 ;; Insert remote references
2795 rmtrng))
2796 keep-empty numbers lispp))
2797 t t form)))
2798 ;; Insert complex ranges
2808 ;; possibly handle durations
2813 formrg)
2814 keep-empty numbers lispp)))
2819 ;; Insert simple ranges, i.e. included in the current row.
2822 form)
2833 keep-empty numbers lispp))
2834 t t form)))
2836 ;; Insert the references to fields in same row
2843 x keep-empty numbers lispp)))
2860 ;; Use <...> time-stamps so that Calc can handle them.
2863 ;; Internationalize local time-stamps by setting locale to
2864 ;; "C".
2867 org-ts-regexp
2875 form t t))
2878 form
2885 duration-output-format)
2886 ev)))
2891 Orig: %s
2892 $xyz-> %s
2893 @r$c-> %s
2916 ;; Replace any active time stamp in the result with
2917 ;; an inactive one. Dates in tables are likely
2918 ;; piece of regular data, not meant to appear in the
2919 ;; agenda.
2932 prop value)))
2935 "Get a calc vector from a column, according to descriptor DESC.
2937 Optional arguments TBEG and COL can give the beginning of the table and
2938 the current column, to avoid unnecessary parsing.
2940 HIGHLIGHT means just highlight the range.
2942 When CORNERS-ONLY is set, only return the corners of the range as
2943 a list (line1 column1 line2 column2) where line1 and line2 are
2944 line numbers relative to beginning of table, or TBEG, and column1
2945 and column2 are table column numbers."
2948 desc))
2959 thisline)))
2964 thisline)))
2976 ;; Just one field.
2983 ;; A range, return a vector. First sort the numbers to get
2984 ;; a regular rectangle.
2990 ;; Copy the range values into a list.
3005 ;; Return string representation of calc vector.
3011 "Return relative line number corresponding to descriptor DESC.
3012 The cursor is currently in relative line number CLINE."
3017 ;; 1 2 3 4 5 6
3018 desc))
3040 cline)))
3043 "Return relative line of Nth row with type TYPE.
3044 Search starts from relative line I. When BACKWARDS in non-nil,
3045 look before I. When RELATIVE is non-nil, the reference is
3046 relative. DESC is the original descriptor that started the
3047 search, as a string."
3055 ;; We are going to cross a hline. Check if this is
3056 ;; an authorized move.
3067 ;; The last hline doesn't exist. Instead, point to last row
3068 ;; in table.
3077 "Convert list ELEMENTS to something appropriate to insert into formula.
3078 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3079 NUMBERS indicates that everything should be converted to numbers.
3080 LISPP non-nil means to return something appropriate for a Lisp
3081 list, `literal' is for the format specifier L."
3082 ;; Calc nan (not a number) is used for the conversion of the empty
3083 ;; field to a reference for several reasons: (i) It is accepted in a
3084 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3085 ;; (ii) In a single field (not in range) it can be distinguished
3086 ;; from "(nan)" which is the reference made from a single field
3087 ;; containing "nan".
3089 ;; field reference
3092 elements
3094 ""
3103 ;; range reference
3108 elements))))
3114 x
3122 x)
3124 elements
3128 "If there has been more than one second since T1, display message.
3129 ARGS are passed as arguments to the `message' function. Returns
3130 current time if a message is printed, otherwise returns T1. If
3131 T1 is nil, always messages."
3135 curtime)
3136 t1)))
3138 ;;;###autoload
3140 "Recalculate the current table line by applying all stored formulas.
3142 With prefix arg ALL, do this for all lines in the table.
3145 if ALL is the symbol `iterate',
3146 recompute the table until it no longer changes.
3148 If NOALIGN is not nil, do not re-align the table after the computations
3149 are done. This is typically used internally to save time, if it is
3150 known that the table will be realigned a little later anyway."
3165 beg end eqlcol eqlfield)
3166 ;; Insert constants in all formulas.
3169 ;; Expand equations, then split the equation list between
3170 ;; column formulas and field formulas.
3182 old-lhs)))
3185 existing formula for column %s"
3186 old-lhs
3187 new))
3188 new))
3194 ;; Expand ranges in lhs of formulas
3196 ;; Get the correct line range to process.
3203 ;; This is a table with marked lines, compute selected
3204 ;; lines.
3206 ;; Move forward to the first non-header line.
3211 ;; Just leave BEG at the start of the table.
3216 ;; Mark named fields untouchable. Also check if several
3217 ;; field/range formulas try to set the same field.
3221 seen-fields)
3232 ;; Turn field coordinates associated to NAME
3233 ;; into an absolute reference.
3237 name)))
3240 reference))
3245 ;; Evaluate the column formulas, but skip fields covered by
3246 ;; field formulas.
3250 ;; Unprotected line, recalculate.
3255 log-last-time
3268 ;; Evaluate the field formulas.
3277 reference
3278 ;; Possibly create a new column, as long as
3279 ;; `org-table-formula-create-columns' allows it.
3291 t))
3296 ;; Clean up markers and internal text property.
3307 ;;;###autoload
3309 "Recalculate the table until it does not change anymore.
3310 The maximum number of iterations is 10, but you can choose a different value
3311 with the prefix ARG."
3316 thistbl)
3330 ;;;###autoload
3332 "Recalculate all tables in the current buffer."
3337 ;; Reason for separate `org-table-align': When repeating
3338 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3339 ;; the way.
3342 t)))
3344 ;;;###autoload
3346 "Iterate all tables in the buffer, to converge inter-table dependencies."
3351 c1)
3367 "Apply the #+TBLFM in the line at point to the table."
3374 ;; Insert a temporary formula at right after the table
3379 ;; Recalculate the table.
3384 ;; Delete the formula inserted temporarily.
3390 "Find the beginning of the TBLFM lines and return its position.
3391 Return nil when the beginning of TBLFM line was not found."
3398 "Expand list of formulas.
3399 If some of the RHS in the formulas are ranges or a row reference,
3400 expand them to individual field equations for each field. This
3401 function assumes the table is already analyzed (i.e., using
3402 `org-table-analyze')."
3409 ;; This just refers to one fixed field.
3412 ;; This just refers to one fixed named field.
3415 ;; Column formulas are treated specially and are not
3416 ;; expanded.
3421 rhs)
3422 res)))
3434 rhs)
3435 res))))))))))
3438 "Replace @<, @>, $<, $> with first/last row/column of the table.
3439 So @< and $< will always be replaced with @1 and $1, respectively.
3440 The advantage of these special markers are that structure editing of
3441 the table will not change them, while @1 and $1 will be modified
3442 when a line/row is swapped out of that privileged position. So for
3443 formulas that use a range of rows or columns, it may often be better
3445 borders of the table using the @< @> $< $> makers."
3448 s start)
3453 org-table-current-ncol)
3457 len
3464 s)
3467 "Replace $const with values in string F."
3472 org-table-column-name-regexp
3475 org-table-column-names))))
3476 f t t)))
3477 ;; Parameters and constants.
3481 new start))
3484 ;; When a duration is expected, convert value on the fly.
3490 v)))))
3497 "Find the value for a parameter or constant in a formula.
3498 Parameters get priority."
3529 map))
3536 "--"
3539 "--"
3540 "Shift Reference at Point"
3545 "-"
3546 "Change Test Row for Column Formulas"
3549 "--"
3554 org-table-overlay-coordinates)]
3555 "--"
3563 ;;;###autoload
3565 "Edit the formulas of the current table in a separate buffer."
3571 ;; Move point within the table before analyzing it.
3587 ;; Keep global-font-lock-mode from turning on font-lock-mode
3632 "Convert a formula from internal to user representation."
3635 s))
3638 "Convert a formula from user to internal representation."
3641 s))
3644 "Convert spreadsheet references from A7 to @7$28.
3645 Works for single references, but also for entire formulas and even the
3646 full TBLFM line."
3648 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3651 ;; format match, just advance
3656 ;; 3.e5 or something like this.
3659 ;; (member (match-string 1 s)
3660 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3661 )
3662 ;; function name, just advance
3672 t t s)))))
3673 s))
3676 "Convert spreadsheet references from to @7$28 to AB7.
3677 Works for single references, but also for entire formulas and even the
3678 full TBLFM line."
3685 t t s)))
3690 t nil s)))
3691 s)
3694 "Convert a base 26 number represented by letters into an integer.
3695 For example: AB -> 28."
3701 n))
3704 "Convert an integer into a base 26 number represented by letters.
3705 For example: 28 -> AB."
3710 s))
3713 "Convert a time string into numerical duration in seconds.
3714 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3715 If S is a string representing a number, keep this number."
3717 s
3740 "Convert a number of seconds to a time string.
3741 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3742 minutes or seconds."
3757 "Convert all references in this buffer, using FUNCTION."
3768 "Convert all references in the buffer from B3 to @3$2 and back."
3778 "Shift the reference at point one row/hline up."
3782 "Shift the reference at point one row/hline down."
3786 "Shift the reference at point one field to the left."
3790 "Shift the reference at point one field to the right."
3801 ;; A B3-like reference
3807 ;; An internal reference
3813 "Re-match the group N, and replace it with the shifted reference."
3818 t t)))
3821 "Shift a reference part REF.
3822 If DECR is set, decrease the references row/column, else increase.
3823 If HLINE is set, this may be a hline reference, it certainly is not
3824 a translation reference."
3853 "Toggle the display of coordinates in the referenced table."
3862 "Parse the buffer for formula definitions and install them.
3863 With prefix ARG, apply the new formulas to the table."
3872 eql)
3875 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3876 nil t)
3897 "Abort editing formulas, without installing the changes."
3908 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3949 "Show the location/value of the $ expression at point.
3950 When LOCAL is non-nil, show references for the table at point."
3960 var name e what match dest)
3964 "$1.."
4016 dest)
4042 ;; Column number.
4068 org-table-fedit-scroll-down))))
4080 "Make sure the cursor is in a dataline in a table."
4089 p1 p2)))
4094 "Move cursor one line up in the window showing the table."
4099 "Move cursor one line down in the window showing the table."
4104 "Move the cursor in the window showing the table.
4105 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4130 "Add a new overlay."
4136 "Highlight rectangular region in a table.
4137 When buffer positions BEG and END are provided, use them to
4138 delimit the region to highlight. Otherwise, refer to point. Use
4139 FACE, when non-nil, for the highlight."
4171 "Remove the rectangle overlays."
4181 "Add overlays to the table at point, to show row/column coordinates."
4209 ;;;###autoload
4211 "Toggle the display of Row/Column numbers in tables."
4222 ;;;###autoload
4224 "Toggle the formula debugger in tables."
4230 ;;; The orgtbl minor mode
4232 ;; Define a minor mode which can be used in other modes in order to
4233 ;; integrate the Org table editor.
4235 ;; This is really a hack, because the Org table editor uses several
4236 ;; keys which normally belong to the major mode, for example the TAB
4237 ;; and RET keys. Here is how it works: The minor mode defines all the
4238 ;; keys necessary to operate the table editor, but wraps the commands
4239 ;; into a function which tests if the cursor is currently inside
4240 ;; a table. If that is the case, the table editor command is
4241 ;; executed. However, when any of those keys is used outside a table,
4242 ;; the function uses `key-binding' to look up if the key has an
4243 ;; associated command in another currently active keymap (minor modes,
4244 ;; major mode, global), and executes that command. There might be
4245 ;; problems if any of the keys used by the table editor is otherwise
4246 ;; used as a prefix key.
4248 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4249 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4250 ;; addresses this by checking explicitly for both bindings.
4252 ;; The optimized version (see variable `orgtbl-optimized') takes over
4253 ;; all keys which are bound to `self-insert-command' in the *global map*.
4254 ;; Some modes bind other commands to simple characters, for example
4255 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4256 ;; active, this binding is ignored inside tables and replaced with a
4257 ;; modified self-insert.
4275 ;; Install it as a minor mode.
4279 ;;;###autoload
4281 "The `org-mode' table editor as a minor mode for use in other modes."
4286 ;; Exit without error, in case some hook functions calls this
4287 ;; by accident in org-mode.
4291 ;; Make sure we are first in minor-mode-map-alist
4293 ;; FIXME: maybe it should use emulation-mode-map-alists?
4300 auto-fill-inhibit-regexp)
4304 auto-fill-inhibit-regexp)
4305 orgtbl-line-start-regexp))
4323 "Remove all properties related to narrow-column invisibility."
4336 "Create a function for binding in the table minor mode.
4337 FUN is the command to call inside a table. N is used to create a unique
4338 command name. KEYS are keys that should be checked in for a command
4339 to execute outside of tables."
4345 "Outside of tables, run the binding of `"
4357 keys)
4361 "Error when there is no default binding for a table key."
4366 "Setup orgtbl keymaps."
4397 elt key fun cmd)
4405 ;; Special treatment needed for TAB, RET and DEL
4418 (orgtbl-make-binding 'org-delete-backward-char 109
4424 [(tab)] "\C-i"))
4426 (org-defkey orgtbl-mode-map [backtab]
4428 [backtab] [S-iso-lefttab] [(shift tab)]
4429 [(tab)] "\C-i"))
4431 (org-defkey orgtbl-mode-map "\M-\C-m"
4432 (orgtbl-make-binding 'org-table-wrap-region 105
4433 "\M-\C-m" [(meta return)]))
4434 (org-defkey orgtbl-mode-map [(meta return)]
4435 (orgtbl-make-binding 'org-table-wrap-region 106
4436 [(meta return)] "\M-\C-m"))
4438 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4439 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4441 (when orgtbl-optimized
4442 ;; If the user wants maximum table support, we need to hijack
4443 ;; some standard editing functions
4444 (org-remap orgtbl-mode-map
4445 'self-insert-command 'orgtbl-self-insert-command
4446 'delete-char 'org-delete-char
4447 'delete-backward-char 'org-delete-backward-char)
4448 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4449 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4450 '("OrgTbl"
4451 ["Create or convert" org-table-create-or-convert-from-region
4452 :active (not (org-at-table-p)) :keys "C-c |" ]
4453 "--"
4454 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4455 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4456 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4457 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4458 "--"
4459 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4460 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4461 ["Copy Field from Above"
4462 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4463 "--"
4464 ("Column"
4465 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4466 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4467 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4468 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4469 ("Row"
4470 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4471 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4472 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4473 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4474 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4475 "--"
4476 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4477 ("Rectangle"
4478 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4479 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4480 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4481 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4482 "--"
4483 ("Radio tables"
4484 ["Insert table template" orgtbl-insert-radio-table
4485 (assq major-mode orgtbl-radio-table-templates)]
4486 ["Comment/uncomment table" orgtbl-toggle-comment t])
4487 "--"
4488 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4489 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4490 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4491 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4492 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4493 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4494 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4495 ["Sum Column/Rectangle" org-table-sum
4496 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4497 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4498 ["Debug Formulas"
4499 org-table-toggle-formula-debugger :active (org-at-table-p)
4500 :keys "C-c {"
4501 :style toggle :selected org-table-formula-debug]
4502 ["Show Col/Row Numbers"
4503 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4504 :keys "C-c }"
4505 :style toggle :selected org-table-overlay-coordinates]
4506 "--"
4507 ("Plot"
4510 t))
4512 (defun orgtbl-ctrl-c-ctrl-c (arg)
4513 "If the cursor is inside a table, realign the table.
4514 If it is a table to be sent away to a receiver, do it.
4515 With prefix arg, also recompute table."
4516 (interactive "P")
4517 (let ((case-fold-search t) (pos (point)) action)
4518 (save-excursion
4519 (beginning-of-line 1)
4520 (setq action (cond
4524 (cond
4525 ((integerp action)
4526 (goto-char action)
4527 (org-table-maybe-eval-formula)
4528 (if arg
4529 (call-interactively 'org-table-recalculate)
4530 (org-table-maybe-recalculate-line))
4531 (call-interactively 'org-table-align)
4532 (when (orgtbl-send-table 'maybe)
4533 (run-hooks 'orgtbl-after-send-table-hook)))
4534 ((eq action 'recalc)
4535 (save-excursion
4536 (beginning-of-line 1)
4538 (if (org-at-table-p)
4539 (org-call-with-arg 'org-table-recalculate t))))
4540 (t (let (orgtbl-mode)
4541 (call-interactively (key-binding "\C-c\C-c")))))))
4543 (defun orgtbl-create-or-convert-from-region (_arg)
4544 "Create table or convert region to table, if no conflicting binding.
4545 This installs the table binding `C-c |', but only if there is no
4546 conflicting binding to this key outside orgtbl-mode."
4547 (interactive "P")
4548 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4549 (if cmd
4550 (call-interactively cmd)
4551 (call-interactively 'org-table-create-or-convert-from-region))))
4553 (defun orgtbl-tab (arg)
4554 "Justification and field motion for `orgtbl-mode'."
4555 (interactive "P")
4556 (if arg (org-table-edit-field t)
4557 (org-table-justify-field-maybe)
4558 (org-table-next-field)))
4560 (defun orgtbl-ret ()
4561 "Justification and field motion for `orgtbl-mode'."
4562 (interactive)
4563 (if (bobp)
4564 (newline)
4565 (org-table-justify-field-maybe)
4566 (org-table-next-row)))
4568 (defun orgtbl-self-insert-command (N)
4569 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4570 If the cursor is in a table looking at whitespace, the whitespace is
4571 overwritten, and the table is not marked as requiring realignment."
4572 (interactive "p")
4573 (if (and (org-at-table-p)
4574 (or
4575 (and org-table-auto-blank-field
4576 (member last-command
4577 '(orgtbl-hijacker-command-100
4578 orgtbl-hijacker-command-101
4579 orgtbl-hijacker-command-102
4580 orgtbl-hijacker-command-103
4581 orgtbl-hijacker-command-104
4582 orgtbl-hijacker-command-105
4583 yas/expand))
4584 (org-table-blank-field))
4585 t)
4586 (eq N 1)
4588 (let (org-table-may-need-update)
4589 (delete-region (match-beginning 1) (match-end 1))
4590 (self-insert-command N))
4591 (setq org-table-may-need-update t)
4592 (let* (orgtbl-mode
4593 a
4594 (cmd (or (key-binding
4595 (or (and (listp function-key-map)
4596 (setq a (assoc last-input-event function-key-map))
4597 (cdr a))
4598 (vector last-input-event)))
4599 'self-insert-command)))
4600 (call-interactively cmd)
4601 (if (and org-self-insert-cluster-for-undo
4602 (eq cmd 'self-insert-command))
4603 (if (not (eq last-command 'orgtbl-self-insert-command))
4604 (setq org-self-insert-command-undo-counter 1)
4605 (if (>= org-self-insert-command-undo-counter 20)
4606 (setq org-self-insert-command-undo-counter 1)
4607 (and (> org-self-insert-command-undo-counter 0)
4608 buffer-undo-list
4609 (not (cadr buffer-undo-list)) ; remove nil entry
4610 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4611 (setq org-self-insert-command-undo-counter
4612 (1+ org-self-insert-command-undo-counter))))))))
4614 ;;;###autoload
4616 "Regular expression matching exponentials as produced by calc.")
4618 (defun orgtbl-gather-send-defs ()
4619 "Gather a plist of :name, :transform, :params for each destination before
4620 a radio table."
4621 (save-excursion
4622 (goto-char (org-table-begin))
4623 (let (rtn)
4624 (beginning-of-line 0)
4625 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4626 (let ((name (org-no-properties (match-string 1)))
4627 (transform (intern (match-string 2)))
4628 (params (if (match-end 3)
4629 (read (concat "(" (match-string 3) ")")))))
4630 (push (list :name name :transform transform :params params)
4631 rtn)
4632 (beginning-of-line 0)))
4633 rtn)))
4635 (defun orgtbl-send-replace-tbl (name text)
4636 "Find and replace table NAME with TEXT."
4637 (save-excursion
4638 (goto-char (point-min))
4639 (let* ((location-flag nil)
4640 (name (regexp-quote name))
4643 (while (re-search-forward begin-re nil t)
4644 (unless location-flag (setq location-flag t))
4645 (let ((beg (line-beginning-position 2)))
4646 (unless (re-search-forward end-re nil t)
4647 (user-error "Cannot find end of receiver location at %d" beg))
4648 (beginning-of-line)
4649 (delete-region beg (point))
4651 (unless location-flag
4652 (user-error "No valid receiver location found in the buffer")))))
4654 ;;;###autoload
4655 (defun org-table-to-lisp (&optional txt)
4656 "Convert the table at point to a Lisp structure.
4657 The structure will be a list. Each item is either the symbol `hline'
4658 for a horizontal separator line, or a list of field values as strings.
4659 The table is taken from the parameter TXT, or from the buffer at point."
4660 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4661 (let ((txt (or txt
4662 (buffer-substring-no-properties (org-table-begin)
4663 (org-table-end)))))
4664 (mapcar (lambda (x)
4665 (if (string-match org-table-hline-regexp x) 'hline
4669 (defun orgtbl-send-table (&optional maybe)
4670 "Send a transformed version of table at point to the receiver position.
4671 With argument MAYBE, fail quietly if no transformation is defined
4672 for this table."
4673 (interactive)
4674 (catch 'exit
4675 (unless (org-at-table-p) (user-error "Not at a table"))
4676 ;; when non-interactive, we assume align has just happened.
4677 (when (called-interactively-p 'any) (org-table-align))
4678 (let ((dests (orgtbl-gather-send-defs))
4679 (table (org-table-to-lisp
4680 (buffer-substring-no-properties (org-table-begin)
4681 (org-table-end))))
4682 (ntbl 0))
4683 (unless dests
4684 (if maybe (throw 'exit nil)
4685 (user-error "Don't know how to transform this table")))
4686 (dolist (dest dests)
4687 (let ((name (plist-get dest :name))
4688 (transform (plist-get dest :transform))
4689 (params (plist-get dest :params)))
4690 (unless (fboundp transform)
4691 (user-error "No such transformation function %s" transform))
4692 (orgtbl-send-replace-tbl name (funcall transform table params)))
4693 (cl-incf ntbl))
4694 (message "Table converted and installed at %d receiver location%s"
4695 ntbl (if (> ntbl 1) "s" ""))
4696 (and (> ntbl 0) ntbl))))
4698 (defun org-remove-by-index (list indices &optional i0)
4699 "Remove the elements in LIST with indices in INDICES.
4700 First element has index 0, or I0 if given."
4701 (if (not indices)
4702 list
4703 (if (integerp indices) (setq indices (list indices)))
4704 (setq i0 (1- (or i0 0)))
4705 (delq :rm (mapcar (lambda (x)
4706 (setq i0 (1+ i0))
4707 (if (memq i0 indices) :rm x))
4708 list))))
4710 (defun orgtbl-toggle-comment ()
4711 "Comment or uncomment the orgtbl at point."
4712 (interactive)
4713 (let* ((case-fold-search t)
4714 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4715 (re2 (concat "^" orgtbl-line-start-regexp))
4716 (commented (save-excursion (beginning-of-line 1)
4717 (cond ((looking-at re1) t)
4718 ((looking-at re2) nil)
4719 (t (user-error "Not at an org table")))))
4720 (re (if commented re1 re2))
4721 beg end)
4722 (save-excursion
4723 (beginning-of-line 1)
4724 (while (looking-at re) (beginning-of-line 0))
4725 (beginning-of-line 2)
4726 (setq beg (point))
4727 (while (looking-at re) (beginning-of-line 2))
4728 (setq end (point)))
4729 (comment-region beg end (if commented '(4) nil))))
4731 (defun orgtbl-insert-radio-table ()
4732 "Insert a radio table template appropriate for this major mode."
4733 (interactive)
4734 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4735 (txt (nth 1 e))
4736 name pos)
4737 (unless e (user-error "No radio table setup defined for %s" major-mode))
4738 (setq name (read-string "Table name: "))
4739 (while (string-match "%n" txt)
4740 (setq txt (replace-match name t t txt)))
4742 (setq pos (point))
4743 (insert txt)
4744 (goto-char pos)))
4746 ;;;###autoload
4747 (defun orgtbl-to-generic (table params)
4748 "Convert the orgtbl-mode TABLE to some other format.
4750 This generic routine can be used for many standard cases.
4752 TABLE is a list, each entry either the symbol `hline' for
4753 a horizontal separator line, or a list of fields for that
4754 line. PARAMS is a property list of parameters that can
4755 influence the conversion.
4757 Valid parameters are:
4759 :backend, :raw
4761 Export back-end used as a basis to transcode elements of the
4762 table, when no specific parameter applies to it. It is also
4763 used to translate cells contents. You can prevent this by
4764 setting :raw property to a non-nil value.
4766 :splice
4768 When non-nil, only convert rows, not the table itself. This is
4769 equivalent to setting to the empty string both :tstart
4770 and :tend, which see.
4772 :skip
4774 When set to an integer N, skip the first N lines of the table.
4775 Horizontal separation lines do count for this parameter!
4777 :skipcols
4779 List of columns that should be skipped. If the table has
4780 a column with calculation marks, that column is automatically
4781 discarded beforehand.
4783 :hline
4785 String to be inserted on horizontal separation lines. May be
4786 nil to ignore these lines altogether.
4788 :sep
4790 Separator between two fields, as a string.
4792 Each in the following group may be either a string or a function
4793 of no arguments returning a string:
4795 :tstart, :tend
4797 Strings to start and end the table. Ignored when :splice is t.
4799 :lstart, :lend
4801 Strings to start and end a new table line.
4803 :llstart, :llend
4805 Strings to start and end the last table line. Default,
4806 respectively, to :lstart and :lend.
4808 Each in the following group may be a string or a function of one
4809 argument (either the cells in the current row, as a list of
4810 strings, or the current cell) returning a string:
4812 :lfmt
4814 Format string for an entire row, with enough %s to capture all
4815 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4817 :llfmt
4819 Format for the entire last line, defaults to :lfmt.
4821 :fmt
4823 A format to be used to wrap the field, should contain %s for
4824 the original field value. For example, to wrap everything in
4826 a property list with column numbers and format strings, or
4827 functions, e.g.,
4831 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4833 Same as above, specific for the header lines in the table.
4834 All lines before the first hline are treated as header. If
4835 any of these is not present, the data line value is used.
4837 This may be either a string or a function of two arguments:
4839 :efmt
4841 Use this format to print numbers with exponential. The format
4842 should have %s twice for inserting mantissa and exponent, for
4844 list with column numbers and format strings or functions.
4845 :fmt will still be applied after :efmt."
4846 ;; Make sure `org-export-create-backend' is available.
4847 (require 'ox)
4848 (let* ((backend (plist-get params :backend))
4849 (custom-backend
4850 ;; Build a custom back-end according to PARAMS. Before
4851 ;; defining a translator, check if there is anything to do.
4852 ;; When there isn't, let BACKEND handle the element.
4853 (org-export-create-backend
4854 :parent (or backend 'org)
4855 :transcoders
4856 `((table . ,(org-table--to-generic-table params))
4857 (table-row . ,(org-table--to-generic-row params))
4858 (table-cell . ,(org-table--to-generic-cell params))
4859 ;; Macros are not going to be expanded. However, no
4860 ;; regular back-end has a transcoder for them. We
4861 ;; provide one so they are not ignored, but displayed
4862 ;; as-is instead.
4863 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4864 data info)
4865 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4866 ;; Initialize communication channel in INFO.
4867 (with-temp-buffer
4868 (let ((org-inhibit-startup t)) (org-mode))
4869 (let ((standard-output (current-buffer))
4870 (org-element-use-cache nil))
4871 (dolist (e table)
4873 ((consp e)
4874 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4876 ;; Add back-end specific filters, but not user-defined ones. In
4877 ;; particular, make sure to call parse-tree filters on the
4878 ;; table.
4879 (setq info
4880 (let ((org-export-filters-alist nil))
4881 (org-export-install-filters
4882 (org-combine-plists
4883 (org-export-get-environment backend nil params)
4884 `(:back-end ,(org-export-get-backend backend))))))
4885 (setq data
4886 (org-export-filter-apply-functions
4887 (plist-get info :filter-parse-tree)
4888 (org-element-map (org-element-parse-buffer) 'table
4889 #'identity nil t)
4890 info)))
4891 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4892 (user-error "Unknown :backend value"))
4893 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4894 ;; Handle :skip parameter.
4895 (let ((skip (plist-get info :skip)))
4896 (when skip
4897 (unless (wholenump skip) (user-error "Wrong :skip value"))
4898 (let ((n 0))
4899 (org-element-map data 'table-row
4900 (lambda (row)
4901 (if (>= n skip) t
4902 (org-element-extract-element row)
4903 (cl-incf n)
4904 nil))
4905 nil t))))
4906 ;; Handle :skipcols parameter.
4907 (let ((skipcols (plist-get info :skipcols)))
4908 (when skipcols
4909 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4910 (org-element-map data 'table
4911 (lambda (table)
4912 (let ((specialp (org-export-table-has-special-column-p table)))
4913 (dolist (row (org-element-contents table))
4914 (when (eq (org-element-property :type row) 'standard)
4915 (let ((c 1))
4916 (dolist (cell (nthcdr (if specialp 1 0)
4917 (org-element-contents row)))
4918 (when (memq c skipcols)
4919 (org-element-extract-element cell))
4920 (cl-incf c))))))))))
4921 ;; Since we are going to export using a low-level mechanism,
4922 ;; ignore special column and special rows manually.
4923 (let ((special? (org-export-table-has-special-column-p data))
4924 ignore)
4925 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4926 (lambda (datum)
4927 (when (if (eq (org-element-type datum) 'table-row)
4928 (org-export-table-row-is-special-p datum nil)
4929 (org-export-first-sibling-p datum nil))
4930 (push datum ignore))))
4931 (setq info (plist-put info :ignore-list ignore)))
4932 ;; We use a low-level mechanism to export DATA so as to skip all
4933 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4934 ;; code evaluation, include keywords and macro expansion. Only
4935 ;; back-end specific filters are retained.
4936 (let ((output (org-export-data-with-backend data custom-backend info)))
4937 ;; Remove final newline.
4938 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4940 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4941 (cond ((null value) nil)
4942 ((functionp value) `(funcall ',value ,@args))
4943 ((stringp value)
4944 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4945 (args `(format ,value ,@args))
4946 (t value)))
4947 ((and with-cons (consp value))
4948 `(let ((val (cadr (memq column ',value))))
4949 (cond ((null val) contents)
4950 ((stringp val) (format val ,@args))
4951 ((functionp val) (funcall val ,@args))
4952 (t (user-error "Wrong %s value" ,name)))))
4953 (t (user-error "Wrong %s value" name))))
4955 (defun org-table--to-generic-table (params)
4956 "Return custom table transcoder according to PARAMS.
4957 PARAMS is a plist. See `orgtbl-to-generic' for more
4958 information."
4959 (let ((backend (plist-get params :backend))
4960 (splice (plist-get params :splice))
4961 (tstart (plist-get params :tstart))
4962 (tend (plist-get params :tend)))
4963 `(lambda (table contents info)
4964 (concat
4965 ,(and tstart (not splice)
4967 ,(if (or (not backend) tstart tend splice) 'contents
4968 `(org-export-with-backend ',backend table contents info))
4969 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4971 (defun org-table--to-generic-row (params)
4972 "Return custom table row transcoder according to PARAMS.
4973 PARAMS is a plist. See `orgtbl-to-generic' for more
4974 information."
4975 (let* ((backend (plist-get params :backend))
4976 (lstart (plist-get params :lstart))
4977 (llstart (plist-get params :llstart))
4978 (hlstart (plist-get params :hlstart))
4979 (hllstart (plist-get params :hllstart))
4980 (lend (plist-get params :lend))
4981 (llend (plist-get params :llend))
4982 (hlend (plist-get params :hlend))
4983 (hllend (plist-get params :hllend))
4984 (lfmt (plist-get params :lfmt))
4985 (llfmt (plist-get params :llfmt))
4986 (hlfmt (plist-get params :hlfmt))
4987 (hllfmt (plist-get params :hllfmt)))
4988 `(lambda (row contents info)
4989 (if (eq (org-element-property :type row) 'rule)
4990 ,(cond
4991 ((plist-member params :hline)
4992 (org-table--generic-apply (plist-get params :hline) ":hline"))
4993 (backend `(org-export-with-backend ',backend row nil info)))
4994 (let ((headerp ,(and (or hlfmt hlstart hlend)
4995 '(org-export-table-row-in-header-p row info)))
4996 (last-header-p
4997 ,(and (or hllfmt hllstart hllend)
4998 '(org-export-table-row-ends-header-p row info)))
4999 (lastp (not (org-export-get-next-element row info))))
5000 (when contents
5001 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5002 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5003 ;; `:lstart', `:lend' and their relatives.
5004 ,(let ((cells
5005 '(org-element-map row 'table-cell
5006 (lambda (cell)
5007 ;; Export all cells, without separators.
5008 ;;
5009 ;; Use `org-export-data-with-backend'
5010 ;; instead of `org-export-data' to eschew
5011 ;; cached values, which
5012 ;; ignore :orgtbl-ignore-sep parameter.
5013 (org-export-data-with-backend
5014 cell
5015 (plist-get info :back-end)
5016 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5017 info)))
5018 `(cond
5019 ,(and hllfmt
5020 `(last-header-p ,(org-table--generic-apply
5021 hllfmt ":hllfmt" nil cells)))
5022 ,(and hlfmt
5023 `(headerp ,(org-table--generic-apply
5024 hlfmt ":hlfmt" nil cells)))
5025 ,(and llfmt
5026 `(lastp ,(org-table--generic-apply
5027 llfmt ":llfmt" nil cells)))
5028 (t
5029 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5030 `(concat
5031 (cond
5032 ,(and
5033 (or hllstart hllend)
5034 `(last-header-p
5035 (concat
5036 ,(org-table--generic-apply hllstart ":hllstart")
5037 contents
5038 ,(org-table--generic-apply hllend ":hllend"))))
5039 ,(and
5040 (or hlstart hlend)
5041 `(headerp
5042 (concat
5043 ,(org-table--generic-apply hlstart ":hlstart")
5044 contents
5045 ,(org-table--generic-apply hlend ":hlend"))))
5046 ,(and
5047 (or llstart llend)
5048 `(lastp
5049 (concat
5050 ,(org-table--generic-apply llstart ":llstart")
5051 contents
5052 ,(org-table--generic-apply llend ":llend"))))
5053 (t
5054 ,(cond
5055 ((or lstart lend)
5056 `(concat
5057 ,(org-table--generic-apply lstart ":lstart")
5058 contents
5059 ,(org-table--generic-apply lend ":lend")))
5060 (backend
5061 `(org-export-with-backend
5062 ',backend row contents info))
5063 (t 'contents)))))))))))))))
5065 (defun org-table--to-generic-cell (params)
5066 "Return custom table cell transcoder according to PARAMS.
5067 PARAMS is a plist. See `orgtbl-to-generic' for more
5068 information."
5069 (let* ((backend (plist-get params :backend))
5070 (efmt (plist-get params :efmt))
5071 (fmt (plist-get params :fmt))
5072 (hfmt (plist-get params :hfmt))
5073 (sep (plist-get params :sep))
5074 (hsep (plist-get params :hsep)))
5075 `(lambda (cell contents info)
5076 ;; Make sure that contents are exported as Org data when :raw
5077 ;; parameter is non-nil.
5078 ,(when (and backend (plist-get params :raw))
5079 `(setq contents
5080 ;; Since we don't know what are the pseudo object
5081 ;; types defined in backend, we cannot pass them to
5082 ;; `org-element-interpret-data'. As a consequence,
5083 ;; they will be treated as pseudo elements, and will
5084 ;; have newlines appended instead of spaces.
5085 ;; Therefore, we must make sure :post-blank value is
5086 ;; really turned into spaces.
5087 (replace-regexp-in-string
5089 (org-trim
5090 (org-element-interpret-data
5091 (org-element-contents cell))))))
5093 (let ((headerp ,(and (or hfmt hsep)
5094 '(org-export-table-row-in-header-p
5095 (org-export-get-parent-element cell) info)))
5096 (column
5097 ;; Call costly `org-export-table-cell-address' only if
5098 ;; absolutely necessary, i.e., if one
5099 ;; of :fmt :efmt :hmft has a "plist type" value.
5100 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5101 (list efmt hfmt fmt))
5102 '(1+ (cdr (org-export-table-cell-address cell info))))))
5103 (when contents
5104 ;; Check if we can apply `:efmt' on CONTENTS.
5105 ,(when efmt
5106 `(when (string-match orgtbl-exp-regexp contents)
5107 (let ((mantissa (match-string 1 contents))
5108 (exponent (match-string 2 contents)))
5109 (setq contents ,(org-table--generic-apply
5110 efmt ":efmt" t 'mantissa 'exponent)))))
5111 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5112 (cond
5113 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5114 hfmt ":hfmt" t 'contents))))
5115 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5116 fmt ":fmt" t 'contents))))))
5117 ;; If a separator is provided, use it instead of BACKEND's.
5118 ;; Separators are ignored when LFMT (or equivalent) is
5119 ;; provided.
5120 ,(cond
5121 ((or hsep sep)
5122 `(if (or ,(and (not sep) '(not headerp))
5123 (plist-get info :orgtbl-ignore-sep)
5124 (not (org-export-get-next-element cell info)))
5125 ,(if (not backend) 'contents
5126 `(org-export-with-backend ',backend cell contents info))
5127 (concat contents
5128 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5129 (or hsep sep)))))
5130 (backend `(org-export-with-backend ',backend cell contents info))
5131 (t 'contents))))))
5133 ;;;###autoload
5134 (defun orgtbl-to-tsv (table params)
5135 "Convert the orgtbl-mode table to TAB separated material."
5138 ;;;###autoload
5139 (defun orgtbl-to-csv (table params)
5140 "Convert the orgtbl-mode table to CSV material.
5141 This does take care of the proper quoting of fields with comma or quotes."
5142 (orgtbl-to-generic table
5143 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5144 params)))
5146 ;;;###autoload
5147 (defun orgtbl-to-latex (table params)
5148 "Convert the orgtbl-mode TABLE to LaTeX.
5150 TABLE is a list, each entry either the symbol `hline' for
5151 a horizontal separator line, or a list of fields for that line.
5152 PARAMS is a property list of parameters that can influence the
5153 conversion. All parameters from `orgtbl-to-generic' are
5154 supported. It is also possible to use the following ones:
5156 :booktabs
5160 :environment
5162 Specify environment to use, as a string. If you use
5164 as a string, to get proper continuation strings."
5165 (require 'ox-latex)
5166 (orgtbl-to-generic
5167 table
5168 (org-combine-plists
5169 ;; Provide sane default values.
5170 (list :backend 'latex
5171 :latex-default-table-mode 'table
5172 :latex-tables-centered nil
5173 :latex-tables-booktabs (plist-get params :booktabs)
5174 :latex-table-scientific-notation nil
5175 :latex-default-table-environment
5176 (or (plist-get params :environment) "tabular"))
5177 params)))
5179 ;;;###autoload
5180 (defun orgtbl-to-html (table params)
5181 "Convert the orgtbl-mode TABLE to HTML.
5183 TABLE is a list, each entry either the symbol `hline' for
5184 a horizontal separator line, or a list of fields for that line.
5185 PARAMS is a property list of parameters that can influence the
5186 conversion. All parameters from `orgtbl-to-generic' are
5187 supported. It is also possible to use the following one:
5189 :attributes
5191 Attributes and values, as a plist, which will be used in
5192 <table> tag."
5193 (require 'ox-html)
5194 (orgtbl-to-generic
5195 table
5196 (org-combine-plists
5197 ;; Provide sane default values.
5198 (list :backend 'html
5199 :html-table-data-tags '("<td%s>" . "</td>")
5200 :html-table-use-header-tags-for-first-column nil
5201 :html-table-align-individual-fields t
5202 :html-table-row-tags '("<tr>" . "</tr>")
5203 :html-table-attributes
5204 (if (plist-member params :attributes)
5205 (plist-get params :attributes)
5206 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5207 :frame "hsides")))
5208 params)))
5210 ;;;###autoload
5211 (defun orgtbl-to-texinfo (table params)
5212 "Convert the orgtbl-mode TABLE to Texinfo.
5214 TABLE is a list, each entry either the symbol `hline' for
5215 a horizontal separator line, or a list of fields for that line.
5216 PARAMS is a property list of parameters that can influence the
5217 conversion. All parameters from `orgtbl-to-generic' are
5218 supported. It is also possible to use the following one:
5220 :columns
5222 Column widths, as a string. When providing column fractions,
5224 (require 'ox-texinfo)
5225 (let ((output
5226 (orgtbl-to-generic
5227 table
5228 (org-combine-plists
5229 (list :backend 'texinfo
5230 :texinfo-tables-verbatim nil
5231 :texinfo-table-scientific-notation nil)
5232 params)))
5233 (columns (let ((w (plist-get params :columns)))
5234 (cond ((not w) nil)
5236 (t (concat "@columnfractions " w))))))
5237 (if (not columns) output
5238 (replace-regexp-in-string
5241 ;;;###autoload
5242 (defun orgtbl-to-orgtbl (table params)
5243 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5245 TABLE is a list, each entry either the symbol `hline' for
5246 a horizontal separator line, or a list of fields for that line.
5247 PARAMS is a property list of parameters that can influence the
5248 conversion. All parameters from `orgtbl-to-generic' are
5249 supported.
5251 Useful when slicing one table into many. The :hline, :sep,
5252 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5253 be set to provide ORGTBL directives for the generated table."
5254 (require 'ox-org)
5255 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5257 (defun orgtbl-to-table.el (table params)
5258 "Convert the orgtbl-mode TABLE into a table.el table.
5259 TABLE is a list, each entry either the symbol `hline' for
5260 a horizontal separator line, or a list of fields for that line.
5261 PARAMS is a property list of parameters that can influence the
5262 conversion. All parameters from `orgtbl-to-generic' are
5263 supported."
5264 (with-temp-buffer
5265 (insert (orgtbl-to-orgtbl table params))
5266 (org-table-align)
5267 (replace-regexp-in-string
5268 "-|" "-+"
5269 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5271 (defun orgtbl-to-unicode (table params)
5272 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5274 TABLE is a list, each entry either the symbol `hline' for
5275 a horizontal separator line, or a list of fields for that line.
5276 PARAMS is a property list of parameters that can influence the
5277 conversion. All parameters from `orgtbl-to-generic' are
5278 supported. It is also possible to use the following ones:
5280 :ascii-art
5283 the table. You can download it here:
5284 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5286 :narrow
5288 When non-nil, narrow columns width than provided width cookie,
5290 (require 'ox-ascii)
5291 (orgtbl-to-generic
5292 table
5293 (org-combine-plists
5294 (list :backend 'ascii
5295 :ascii-charset 'utf-8
5296 :ascii-table-widen-columns (not (plist-get params :narrow))
5297 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5298 params)))
5300 ;; Put the cursor in a column containing numerical values
5301 ;; of an Org table,
5302 ;; type C-c " a
5303 ;; A new column is added with a bar plot.
5304 ;; When the table is refreshed (C-u C-c *),
5305 ;; the plot is updated to reflect the new values.
5307 (defun orgtbl-ascii-draw (value min max &optional width characters)
5308 "Draw an ascii bar in a table.
5309 VALUE is the value to plot, it determines the width of the bar to draw.
5310 MIN is the value that will be displayed as empty (zero width bar).
5311 MAX is the value that will draw a bar filling all the WIDTH.
5312 WIDTH is the span in characters from MIN to MAX.
5313 CHARACTERS is a string that will compose the bar, with shades of grey
5314 from pure white to pure black. It defaults to a 10 characters string
5315 of regular ascii characters."
5316 (let* ((width (ceiling (or width 12)))
5317 (characters (or characters " .:;c!lhVHW"))
5318 (len (1- (length characters)))
5319 (value (float (if (numberp value)
5320 value (string-to-number value))))
5321 (relative (/ (- value min) (- max min)))
5322 (steps (round (* relative width len))))
5323 (cond ((< steps 0) "too small")
5324 ((> steps (* width len)) "too large")
5325 (t (let* ((int-division (/ steps len))
5326 (remainder (- steps (* int-division len))))
5327 (concat (make-string int-division (elt characters len))
5328 (string (elt characters remainder))))))))
5330 ;;;###autoload
5331 (defun orgtbl-ascii-plot (&optional ask)
5332 "Draw an ASCII bar plot in a column.
5334 With cursor in a column containing numerical values, this function
5335 will draw a plot in a new column.
5337 ASK, if given, is a numeric prefix to override the default 12
5339 prefix,
5340 which will prompt for the width."
5341 (interactive "P")
5342 (let ((col (org-table-current-column))
5343 (min 1e999) ; 1e999 will be converted to infinity
5344 (max -1e999) ; which is the desired result
5345 (table (org-table-to-lisp))
5346 (length
5347 (cond ((consp ask)
5348 (read-number "Length of column " 12))
5349 ((numberp ask) ask)
5350 (t 12))))
5351 ;; Skip any hline a the top of table.
5352 (while (eq (car table) 'hline) (setq table (cdr table)))
5353 ;; Skip table header if any.
5354 (dolist (x (or (cdr (memq 'hline table)) table))
5355 (when (consp x)
5356 (setq x (nth (1- col) x))
5357 (when (string-match
5359 x)
5360 (setq x (string-to-number x))
5361 (when (> min x) (setq min x))
5362 (when (< max x) (setq max x)))))
5363 (org-table-insert-column)
5364 (org-table-move-column-right)
5365 (org-table-store-formulas
5366 (cons
5367 (cons
5368 (concat "$" (number-to-string (1+ col)))
5369 (format "'(%s $%s %s %s %s)"
5370 "orgtbl-ascii-draw" col min max length))
5371 (org-table-get-stored-formulas)))
5372 (org-table-recalculate t)))
5374 ;; Example of extension: unicode characters
5375 ;; Here are two examples of different styles.
5377 ;; Unicode block characters are used to give a smooth effect.
5378 ;; See http://en.wikipedia.org/wiki/Block_Elements
5379 ;; Use one of those drawing functions
5380 ;; - orgtbl-ascii-draw (the default ascii)
5381 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5382 ;; - orgtbl-uc-draw-cont (smooth unicode)
5384 ;; This is best viewed with the "DejaVu Sans Mono" font
5385 ;; (use M-x set-default-font).
5387 (defun orgtbl-uc-draw-grid (value min max &optional width)
5388 "Draw a bar in a table using block unicode characters.
5389 It is a variant of orgtbl-ascii-draw with Unicode block
5390 characters, for a smooth display. Bars appear as grids (to the
5391 extent the font allows)."
5392 ;; http://en.wikipedia.org/wiki/Block_Elements
5393 ;; best viewed with the "DejaVu Sans Mono" font.
5394 (orgtbl-ascii-draw value min max width
5397 (defun orgtbl-uc-draw-cont (value min max &optional width)
5398 "Draw a bar in a table using block unicode characters.
5399 It is a variant of orgtbl-ascii-draw with Unicode block
5400 characters, for a smooth display. Bars are solid (to the extent
5401 the font allows)."
5402 (orgtbl-ascii-draw value min max width
5405 (defun org-table-get-remote-range (name-or-id form)
5406 "Get a field value or a list of values in a range from table at ID.
5408 NAME-OR-ID may be the name of a table in the current file as set
5410 will then be used. Alternatively, it may be an ID referring to
5411 any entry, also in a different file. In this case, the first
5412 table in that entry will be referenced.
5416 The return value is either a single string for a single field, or a
5417 list of the fields in the rectangle."
5418 (save-match-data
5419 (let ((case-fold-search t) (id-loc nil)
5420 ;; Protect a bunch of variables from being overwritten by
5421 ;; the context of the remote table.
5422 org-table-column-names org-table-column-name-regexp
5423 org-table-local-parameters org-table-named-field-locations
5424 org-table-current-line-types
5425 org-table-current-begin-pos org-table-dlines
5426 org-table-current-ncol
5427 org-table-hlines org-table-last-alignment
5428 org-table-last-column-widths org-table-last-alignment
5429 org-table-last-column-widths
5430 buffer loc)
5431 (setq form (org-table-convert-refs-to-rc form))
5432 (org-with-wide-buffer
5433 (goto-char (point-min))
5434 (if (re-search-forward
5437 nil t)
5438 (setq buffer (current-buffer) loc (match-beginning 0))
5439 (setq id-loc (org-id-find name-or-id 'marker))
5440 (unless (and id-loc (markerp id-loc))
5442 (setq buffer (marker-buffer id-loc)
5443 loc (marker-position id-loc))
5444 (move-marker id-loc nil))
5445 (with-current-buffer buffer
5446 (org-with-wide-buffer
5447 (goto-char loc)
5448 (forward-char 1)
5450 (not (match-beginning 1)))
5451 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5452 (org-table-analyze)
5453 (setq form (org-table-formula-substitute-names
5454 (org-table-formula-handle-first/last-rc form)))
5455 (if (and (string-match org-table-range-regexp form)
5456 (> (length (match-string 0 form)) 1))
5457 (org-table-get-range
5458 (match-string 0 form) org-table-current-begin-pos 1)
5459 form)))))))
5461 (defun org-table-remote-reference-indirection (form)
5462 "Return formula with table remote references substituted by indirection.
5464 This indirection works only with the format @ROW$COLUMN. The
5466 distinguished from a plain table name or ID."
5467 (let ((regexp
5468 ;; Same as in `org-table-eval-formula'.
5470 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5473 (replace-regexp-in-string
5474 regexp
5475 (lambda (m)
5476 (save-match-data
5477 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5478 (org-table-get-range
5480 (concat "@0" eq)
5481 eq)))))
5482 form t t 1)))
5484 (defmacro org-define-lookup-function (mode)
5485 (let ((mode-str (symbol-name mode))
5486 (first-p (eq mode 'first))
5487 (all-p (eq mode 'all)))
5488 (let ((plural-str (if all-p "s" "")))
5489 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5490 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5491 If R-LIST is nil, return matching element%s of S-LIST.
5492 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5493 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5494 This function is generated by a call to the macro `org-define-lookup-function'."
5495 mode-str plural-str plural-str plural-str)
5496 (let ,(let ((lvars '((p (or predicate 'equal))
5497 (sl s-list)
5498 (rl (or r-list s-list))
5499 (ret nil))))
5500 (if first-p (cons '(match-p nil) lvars) lvars))
5501 (while ,(if first-p '(and (not match-p) sl) 'sl)
5502 (when (funcall p val (car sl))
5503 ,(when first-p '(setq match-p t))
5504 (let ((rval (car rl)))
5505 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5506 (setq sl (cdr sl) rl (cdr rl)))
5507 ret)))))
5509 (org-define-lookup-function first)
5510 (org-define-lookup-function last)
5511 (org-define-lookup-function all)
5513 (provide 'org-table)
5515 ;; Local variables:
5516 ;; generated-autoload-file: "org-loaddefs.el"
5517 ;; End:
5519 ;;; org-table.el ends here