| blob | 6ebd6da9d0a8770943157de99d63121dd8a60340 |
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."
442 "Alist with column names, derived from the `!' line.
446 "Regular expression matching the current column names.
450 "Alist with parameter names, derived from the `$' line.
454 "Alist with locations of named fields.
455 Associations follow the pattern (NAME LINE COLUMN) where
456 NAME is the name of the field as a string,
457 LINE is the number of lines from the beginning of the table,
458 COLUMN is the column of the field, as an integer.
462 "Table row types in current table.
466 "Current table begin position, as a marker.
470 "Number of columns in current table.
474 "Vector of data line line numbers in the current table.
475 Line numbers are counted from the beginning of the table. This
479 "Vector of hline line numbers in the current table.
480 Line numbers are counted from the beginning of the table. This
484 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
485 ;; 1 2 3 4 5
500 "Save current field; execute BODY; restore field.
501 Field is restored even in case of abnormal exit."
512 ;;;###autoload
514 "Use the table.el package to insert a new table.
515 If there is already a table at point, convert between Org tables
516 and table.el tables."
529 ;;;###autoload
531 "Convert region to table, or create an empty table.
532 If there is an active region, convert it to a table, using the function
533 `org-table-convert-region'. See the documentation of that function
534 to learn how the prefix argument is interpreted to determine the field
535 separator.
536 If there is no such region, create an empty table with `org-table-create'."
542 ;;;###autoload
544 "Query for a size and insert a table skeleton.
564 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
568 ;; Insert a hline after the first row.
575 ;;;###autoload
577 "Convert region to a table.
579 The region goes from BEG0 to END0, but these borders will be moved
580 slightly, to make sure a beginning of line in the first line is included.
582 SEPARATOR specifies the field separator in the lines. It can have the
583 following values:
585 (4) Use the comma as a field separator
586 (16) Use a TAB as field separator
587 (64) Prompt for a regular expression as field separator
588 integer When a number, use that many spaces, or a TAB, as field separator
589 regexp When a regular expression, use it to match the separator
590 nil When nil, the command tries to be smart and figure out the
591 separator in the following way:
592 - when each line contains a TAB, assume TAB-separated material
593 - when each line contains a comma, assume CSV material
594 - else, assume one or more SPACE characters as separator."
598 re)
600 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
601 org-table-convert-region-max-lines)
610 ;; Get the right field separator
621 ;; parse the csv stuff
646 ;;;###autoload
648 "Import FILE as a table.
649 The file is assumed to be tab-separated. Such files can be produced by most
650 spreadsheet and database applications. If no tabs (at least one per line)
651 are found, lines will be split on whitespace into fields."
660 ;;;###autoload
662 "Export table to a file, with configurable format.
663 Such a file can be imported into usual spreadsheet programs.
665 FILE can be the output file name. If not given, it will be taken
666 from a TABLE_EXPORT_FILE property in the current entry or higher
667 up in the hierarchy, or the user will be prompted for a file
668 name. FORMAT can be an export format, of the same kind as it
669 used when `orgtbl-mode' sends a table in a different format.
671 The command suggests a format depending on TABLE_EXPORT_FORMAT,
672 whether it is set locally or up in the hierarchy, then on the
673 extension of the given file name, and finally on the variable
674 `org-table-export-default-format'."
707 formats)))
708 org-table-export-default-format)
734 "Marker at the beginning of the table last aligned.
737 "Marker at the end of the table last aligned.
740 "List of flags for flushright alignment, from the last re-alignment.
743 "List of max width of fields in each column.
746 "Non-nil means debug table formulas.
756 ;;;###autoload
758 "Align the table at point by aligning all vertical bars."
763 ;; Make sure invisible characters in the table are at the right
764 ;; place since column widths take them into account.
770 ;; Table's rows. Separators are replaced by nil. Trailing
771 ;; spaces are also removed.
777 l)))
779 ;; Get the data fields by splitting the lines.
782 ;; Compute number of fields in the longest line. If the
783 ;; table contains no field, create a default table.
788 ;; A list of empty strings to fill any short rows on output.
790 lengths typenums)
791 ;; Check for special formatting.
794 fmax falign)
795 ;; Look for an explicit width or alignment.
808 ;; Find fields that are wider than FMAX, and shorten them.
813 'help-echo
821 fmax)))
835 f2
837 x))))))
838 ;; Get the maximum width for each column
840 lengths)
841 ;; Get the fraction of numbers among non-empty cells to
842 ;; decide about alignment of the column.
851 1
857 ;; Store alignment of this table, for later editing of single
858 ;; fields.
861 ;; With invisible characters, `format' does not get the field
862 ;; width right So we need to make these fields wide by hand.
863 ;; Invisible characters may be introduced by fontified links,
864 ;; emphasis, macros or sub/superscripts.
882 ;; Compute the formats needed for output of the table.
891 ;; Replace modified lines only. Check not only contents, but
892 ;; also columns' width.
896 hfmt))
918 ;;;###autoload
920 "Find the beginning of the table and return its position.
921 With a non-nil optional argument TABLE-TYPE, return the beginning
922 of a table.el-type table. This function assumes point is on
923 a table."
931 ;;;###autoload
933 "Find the end of the table and return its position.
934 With a non-nil optional argument TABLE-TYPE, return the end of
935 a table.el-type table. This function assumes point is on
936 a table."
944 ;; When the line right after the table is the last line in
945 ;; the buffer with trailing spaces but no final newline
946 ;; character, be sure to catch the correct ending at its
947 ;; beginning. In any other case, ending is expected to be
948 ;; at point max.
953 ;;;###autoload
955 "Justify the current field, text to left, number to right.
956 Optional argument NEW may specify text to replace the current field content."
965 ;; This is not the same table, force a full re-align.
968 ;; Realign the current field, based on previous full realign.
981 len
996 ;;;###autoload
998 "Go to the next field in the current table, creating new lines as needed.
999 Before doing so, re-align the table if necessary."
1004 org-table-may-need-update)
1015 org-table-tab-jumps-over-hlines
1026 ;;;###autoload
1028 "Go to the previous field in the table.
1029 Before doing so, re-align the table if necessary."
1034 org-table-may-need-update)
1052 "Move to the beginning of the current table field.
1053 If already at or before the beginning, move to the beginning of the
1054 previous field.
1055 With numeric argument N, move N-1 fields backward first."
1068 "Move to the end of the current table field.
1069 If already at or after the end, move to the end of the next table field.
1070 With numeric argument N, move N-1 fields forward first."
1083 ;;;###autoload
1085 "Go to the next row (same column) in the current table.
1086 Before doing so, re-align the table if necessary."
1091 org-table-may-need-update)
1103 ;;;###autoload
1105 "Copy the value of the current field one row below.
1107 If the field at the cursor is empty, copy the content of the
1108 nearest non-empty field above. With argument N, use the Nth
1109 non-empty field.
1111 If the current field is not empty, it is copied down to the next
1112 row, and the cursor is moved with it. Therefore, repeating this
1113 command causes the column to be filled row-by-row.
1115 If the variable `org-table-copy-increment' is non-nil and the
1116 field is an integer or a timestamp, it will be incremented while
1117 copying. By default, increment by the difference between the
1118 value in the current field and the one in the field above. To
1119 increment using a fixed integer, set `org-table-copy-increment'
1120 to a number. In the case of a timestamp, increment by days."
1132 txt txt-up inc)
1140 beg t))
1150 beg t))
1157 ;; Above field was not empty, go down to the next row
1190 "Is point inside a table data field?
1191 I.e. not on a hline or before the first or after the last column?
1192 This actually throws an error, so it aborts the current command."
1204 "Get the field in table line LINE, column COLUMN.
1205 If LINE is larger than the number of data lines in the table, the function
1206 returns nil. However, if COLUMN is too large, we will simply return an
1207 empty string.
1208 If LINE is nil, use the current line.
1209 If COLUMN is nil, use the current column."
1216 "Put VALUE into line LINE, column COLUMN.
1217 When ALIGN is set, also realign the table."
1226 "Return the index of the current data line."
1233 cnt))
1236 "Go to the Nth data line in the current table.
1237 Return t when the line exists, nil if it does not exist."
1244 ;;;###autoload
1246 "Blank the current table field or active region."
1263 "Return the value of the field in column N of current row.
1264 N defaults to current column. If REPLACE is a string, replace
1265 field with this value. The return value is always the old
1266 value."
1270 ;; Before first column or after last one.
1271 ""
1278 val)))
1280 ;;;###autoload
1282 "Show info about the current field, and highlight any reference at point."
1292 col)
1293 org-table-named-field-locations)))
1303 ;; Prioritize field formulas over column formulas.
1312 dline col
1314 dline col ref1
1316 ;; FIXME: formula info not correct if special table line
1323 ""
1329 "Find out which column we are in."
1335 column)))
1338 "Find out what table data line we are in.
1339 Only data lines count for this."
1347 c)))
1349 ;;;###autoload
1351 "Move the cursor to the Nth column in the current table line.
1352 With optional argument ON-DELIM, stop with point before the left delimiter
1353 of the field.
1354 If there are less than N fields, just go to after the last delimiter.
1355 However, when FORCE is non-nil, create new columns if necessary."
1365 t)))))
1372 ;;;###autoload
1374 "Insert a new column into the table."
1396 "Find a data line in the current table, which is needed for column commands."
1399 t
1410 t
1415 "Turn a buffer line number into a data line number.
1417 If there is no data line in this line, return nil.
1419 If there is no matching dline (most likely the reference was
1420 a hline), the first dline below it is used. When ABOVE is
1421 non-nil, the one above is used."
1426 nil)
1437 ;;;###autoload
1439 "Delete a column from the table."
1451 nil
1466 ;;;###autoload
1468 "Move column to the right."
1471 ;;;###autoload
1473 "Move column to the left."
1477 ;;;###autoload
1479 "Move the current column to the right. With arg LEFT, move to the left."
1515 ;;;###autoload
1517 "Move table row down."
1520 ;;;###autoload
1522 "Move table row up."
1526 ;;;###autoload
1528 "Move the current table line down. With arg UP, move it up."
1537 hline2p)
1563 ;;;###autoload
1565 "Insert a new row above the current line into the table.
1566 With prefix ARG, insert below the current line."
1571 ;; Fix the first field if necessary
1575 ;; Buffer may not end of a newline character, so ensure
1576 ;; (beginning-of-line 2) moves point to a new line.
1587 ;;;###autoload
1589 "Insert a horizontal-line below the current line into the table.
1590 With prefix ABOVE, insert above the current line."
1611 ;;;###autoload
1613 "Insert a hline and move to the row below that line."
1627 In particular, this does handle wide and invisible characters."
1629 ;; It's a hline, just map the characters
1635 t t s)))
1636 s))
1638 ;;;###autoload
1640 "Delete the current row or horizontal line from the table."
1656 ;;;###autoload
1659 "Sort table lines according to the column at point.
1661 The position of point indicates the column to be used for
1662 sorting, and the range of lines is the range between the nearest
1663 horizontal separator lines, or the entire table of no such lines
1664 exist. If point is before the first column, you will be prompted
1665 for the sorting column. If there is an active region, the mark
1666 specifies the first line and the sorting column, while point
1667 should be in the last line to be included into the sorting.
1669 The command then prompts for the sorting type which can be
1670 alphabetically, numerically, or by time (as given in a time stamp
1671 in the field, or as a HH:MM value). Sorting in reverse order is
1672 also possible.
1674 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1676 If SORTING-TYPE is specified when this function is called from a Lisp
1677 program, no prompting will take place. SORTING-TYPE must be a character,
1678 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1679 sorting should be done in reverse order.
1681 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1682 a function to be called to extract the key. It must return a value
1683 that is compatible with COMPARE-FUNC, the function used to compare
1684 entries.
1686 A non-nil value for INTERACTIVE? is used to signal that this
1687 function is being called interactively."
1690 ;; Point must be either within a field or before a data line.
1695 ;; Set appropriate case sensitivity and column used for sorting.
1706 ;; Narrow buffer to appropriate sorting area.
1719 start))
1722 end))))
1723 ;; Determine arguments for `sort-subr'. Also record original
1724 ;; position. `org-table-save-field' cannot help here since
1725 ;; sorting is too much destructive.
1731 ;; Function to be called on the contents of the field
1732 ;; used for sorting in the current row.
1769 #'end-of-line
1773 nil
1774 predicate)
1775 ;; Move back to initial field.
1779 ;;;###autoload
1781 "Copy region in table to the clipboard and blank all relevant fields.
1782 If there is no active region, use just the field at point."
1788 ;;;###autoload
1790 "Copy rectangular region in table to clipboard.
1791 A special clipboard is used which can only be accessed
1792 with `org-table-paste-rectangle'."
1796 current-prefix-arg))
1801 region)
1813 ;; Collect every cell between COLUMN-START and COLUMN-END.
1823 ;;;###autoload
1825 "Paste a rectangular region into a table.
1826 The upper right corner ends up in the current field. All involved fields
1827 will be overwritten. If the rectangle does not fit into the present table,
1828 the table is enlarged as needed. The process ignores horizontal separator
1829 lines."
1839 ;; If we left the table, create a new row.
1851 ;;;###autoload
1853 "Convert from `org-mode' table to table.el and back.
1854 Obviously, this only works within limits. When an Org table is converted
1855 to table.el, all horizontal separator lines get lost, because table.el uses
1856 these as cell boundaries and has no notion of horizontal lines. A table.el
1857 table can be converted to an Org table only if it does not do row or column
1858 spanning. Multiline cells will become multiple cells. Beware, Org mode
1859 does not test if the table can be successfully converted - it blindly
1860 applies a recipe that works for simple tables."
1864 ;; convert to Org table
1873 ;; convert to table.el table
1876 ;; first, get rid of all horizontal lines
1880 ;; insert a hline before first
1884 ;; insert a hline after each line
1889 ;; replace "+" at beginning and ending of hlines
1898 "Transpose Org table at point and eliminate hlines.
1899 So a table like
1901 | 1 | 2 | 4 | 5 |
1902 |---+---+---+---|
1903 | a | b | c | d |
1904 | e | f | g | h |
1906 will be transposed as
1908 | 1 | a | e |
1909 | 2 | b | f |
1910 | 4 | c | g |
1911 | 5 | d | h |
1913 Note that horizontal lines disappear."
1925 table)))
1939 ;;;###autoload
1941 "Wrap several fields in a column like a paragraph.
1942 This is useful if you'd like to spread the contents of a field over several
1943 lines, in order to keep the table compact.
1945 If there is an active region, and both point and mark are in the same column,
1946 the text in the column is wrapped to minimum width for the given number of
1947 lines. Generally, this makes the table more compact. A prefix ARG may be
1948 used to change the number of desired lines. For example, \
1950 formats the selected text to two lines. If the region was longer than two
1951 lines, the remaining lines remain empty. A negative prefix argument reduces
1952 the current number of lines by that amount. The wrapped text is pasted back
1953 into the table. If you formatted it to more lines than it was before, fields
1954 further down in the table get overwritten - so you might need to make space in
1955 the table first.
1957 If there is no region, the current field is split at the cursor position and
1958 the text fragment to the right of the cursor is prepended to the field one
1959 line down.
1961 If there is no region, but you specify a prefix ARG, the current field gets
1962 blank, and the content is appended to the field above."
1966 ;; There is a region: fill as a paragraph.
1977 nil
1978 nlines))))
1981 ;; No region, split the current field at point.
2006 ;;;###autoload
2008 "Edit table field in a different window.
2009 This is mainly useful for fields that contain hidden parts.
2012 visible so that it can be edited in place.
2015 toggle `org-table-follow-field-mode'."
2025 display t intangible t))
2038 p)
2054 intangible t))
2062 "Finish editing a table data field.
2063 Remove all newline characters, insert the result into the table, realign
2064 the table and kill the editing buffer."
2068 text)
2085 "Minor mode to make the table field editor window follow the cursor.
2086 When this mode is active, the field editor window will always show the
2087 current field. The mode exits automatically when the cursor leaves the
2088 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2089 nil " TblFollow" nil
2105 ;; We have left the table, exit the follow mode
2115 ;;;###autoload
2117 "Sum numbers in region of current table column.
2118 The result will be displayed in the echo area, and will be available
2121 If there is an active region, it is interpreted as a rectangle and all
2122 numbers in that rectangle will be summed. If there is no active
2123 region and point is located in a table column, sum all numbers in that
2124 column.
2126 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2127 numbers are assumed to be times as well (in decimal hours) and the
2128 numbers are added as such.
2130 If NLAST is a number, only the NLAST fields will actually be summed."
2157 items1)))
2164 s diff)
2171 sres))))
2194 "Return the formula active for the current field.
2196 Assumes that table is already analyzed. If KEY is given, return
2197 the key to this formula. Otherwise return the formula preceded
2206 org-table-named-field-locations)))
2220 "Read a formula from the minibuffer, offer stored formula as default.
2221 When NAMED is non-nil, look for a named equation."
2226 org-table-named-field-locations)))
2239 stored)
2241 equation)
2247 scol))
2249 'org-table-formula-history
2250 )))))
2251 mustsave)
2253 ;; remove formula
2260 ;; We set the column equation, delete the named one.
2262 mustsave t))
2268 eq))
2271 "Store the list of formulas below the current table.
2272 If optional argument LOCATION is a buffer position, insert it at
2273 LOCATION instead."
2281 ;; Don't overwrite TBLFM, we might use text properties to
2282 ;; store stuff.
2296 ;; Fake a high number to make sure this is sorted at the end.
2303 a)
2313 "Compare two formulas for sorting."
2318 ;;;###autoload
2320 "Return an alist with the stored formulas directly after current table.
2321 By default, only return active formulas, i.e., formulas located
2322 on the first line after the table. However, if optional argument
2323 LOCATION is a buffer position, consider the formulas there."
2332 eq-alist seen)
2336 string)
2341 ;; Is it a column reference?
2343 ;; Since named columns are not possible in
2344 ;; LHS, assume this is a named field.
2352 "Double definition `%s=' in TBLFM line, please fix by hand"
2353 lhs)
2358 "Double definition `%s=' in TBLFM line, please fix by hand"
2359 lhs)))))))))))
2362 "Modify the equations after the table structure has been edited.
2364 For all numbers larger than LIMIT, shift them by DELTA."
2376 s n a)
2382 "Change makes TBLFM term %s invalid, use undo to recover"
2397 ;;;###autoload
2400 If yes, store the formula and apply it."
2401 ;; We already know we are in a table. Get field will only return a formula
2402 ;; when appropriate. It might return a separator line, but no problem.
2405 named eq)
2413 "List of commands triggering the recalculation of a line.
2425 ;;;###autoload
2427 "Rotate the recalculation mark in the first column.
2428 If in any row, the first field is not consistent with a mark,
2429 insert a new column for the markers.
2430 When there is an active region, change all the lines in the region,
2431 after prompting for the marking character.
2432 After each change, a message will be displayed indicating the meaning
2433 of the new mark."
2449 newchar))
2457 newchar))
2475 ;; Rotate mark in first row.
2477 ;; Rotate marks in additional rows if a region is active.
2485 ;; Only align if rotation actually changed lines' length.
2495 ;;;###autoload
2497 "Analyze table at point and store results.
2499 This function sets up the following dynamically scoped variables:
2501 `org-table-column-name-regexp',
2502 `org-table-column-names',
2503 `org-table-current-begin-pos',
2504 `org-table-current-line-types',
2505 `org-table-current-ncol',
2506 `org-table-dlines',
2507 `org-table-hlines',
2508 `org-table-local-parameters',
2509 `org-table-named-field-locations'."
2514 ;; Extract column names.
2527 ;; Extract local parameters.
2535 org-table-local-parameters)))))
2536 ;; Update named fields locations. We minimize `count-lines'
2537 ;; processing by storing last known number of lines in LAST.
2559 field))
2562 org-table-named-field-locations))))))))))
2563 ;; Re-use existing markers when possible.
2567 ;; Analyze the line types.
2578 ;; Get the number of columns from the first data line in table.
2586 al al2)
2600 "Move point to a specific field in the current table.
2602 REF is either the name of a field its absolute reference, as
2603 a string. No column is created unless CREATE-COLUMN-P is
2604 non-nil. If it is a function, it is called with the column
2605 number as its argument as is used as a predicate to know if the
2606 column can be created.
2608 This function assumes the table is already analyzed (i.e., using
2609 `org-table-analyze')."
2624 create-column-p)))
2630 ;;;###autoload
2632 "Recompute the current line if marked for it, and if we haven't just done it."
2652 org-tbl-calc-modes)
2654 ;;;###autoload
2656 suppress-align suppress-const
2657 suppress-store suppress-analysis)
2658 "Replace the table field value at the cursor by the result of a calculation.
2660 In a table, this command replaces the value in the current field with the
2662 formula, by storing it in a special line below the table. When called
2664 field formula.
2667 insert the active equation for the field
2668 back into the current field, so that it can be edited there. This is \
2669 useful
2671 check the referenced fields.
2673 When called, the command first prompts for a formula, which is read in
2674 the minibuffer. Previously entered formulas are available through the
2675 history list, and the last used formula is offered as a default.
2676 These stored formulas are adapted correctly when moving, inserting, or
2677 deleting columns with the corresponding commands.
2679 The formula can be any algebraic expression understood by the Calc package.
2680 For details, see the Org mode manual.
2682 This function can also be called from Lisp programs and offers
2683 additional arguments: EQUATION can be the formula to apply. If this
2684 argument is given, the user will not be prompted.
2686 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2687 unnecessary aligns.
2689 SUPPRESS-CONST suppresses the interpretation of constants in the
2690 formula, assuming that this has been done already outside the
2691 function.
2693 SUPPRESS-STORE means the formula should not be stored, either
2694 because it is already stored, or because it is a modified
2695 equation that should not overwrite the stored one.
2697 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2698 location of point."
2714 equation
2720 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2721 duration duration-output-format)
2722 ;; Parse the format string. Since we have a lot of modes, this is
2723 ;; a lot of work. However, I think calc still uses most of the time.
2736 'calc-float-format
2739 n))))
2744 duration-output-format
2773 ;; replace fields with duration values if relevant
2777 fields)))
2783 x))
2784 fields)))
2790 ;; Insert row and column number of formula result field
2801 t t form)))
2803 ;; Check for old vertical references
2805 ;; Insert remote references
2818 rmtrng))
2819 keep-empty numbers lispp))
2820 t t form)))
2821 ;; Insert complex ranges
2831 ;; possibly handle durations
2836 formrg)
2837 keep-empty numbers lispp)))
2842 ;; Insert simple ranges, i.e. included in the current row.
2845 form)
2856 keep-empty numbers lispp))
2857 t t form)))
2859 ;; Insert the references to fields in same row
2866 x keep-empty numbers lispp)))
2883 ;; Use <...> time-stamps so that Calc can handle them.
2886 ;; Internationalize local time-stamps by setting locale to
2887 ;; "C".
2890 org-ts-regexp
2898 form t t))
2901 form
2908 duration-output-format)
2909 ev)))
2914 Orig: %s
2915 $xyz-> %s
2916 @r$c-> %s
2939 ;; Replace any active time stamp in the result with
2940 ;; an inactive one. Dates in tables are likely
2941 ;; piece of regular data, not meant to appear in the
2942 ;; agenda.
2955 prop value)))
2958 "Get a calc vector from a column, according to descriptor DESC.
2960 Optional arguments TBEG and COL can give the beginning of the table and
2961 the current column, to avoid unnecessary parsing.
2963 HIGHLIGHT means just highlight the range.
2965 When CORNERS-ONLY is set, only return the corners of the range as
2966 a list (line1 column1 line2 column2) where line1 and line2 are
2967 line numbers relative to beginning of table, or TBEG, and column1
2968 and column2 are table column numbers."
2971 desc))
2982 thisline)))
2987 thisline)))
2999 ;; Just one field.
3006 ;; A range, return a vector. First sort the numbers to get
3007 ;; a regular rectangle.
3013 ;; Copy the range values into a list.
3028 ;; Return string representation of calc vector.
3034 "Return relative line number corresponding to descriptor DESC.
3035 The cursor is currently in relative line number CLINE."
3040 ;; 1 2 3 4 5 6
3041 desc))
3063 cline)))
3066 "Return relative line of Nth row with type TYPE.
3067 Search starts from relative line I. When BACKWARDS in non-nil,
3068 look before I. When RELATIVE is non-nil, the reference is
3069 relative. DESC is the original descriptor that started the
3070 search, as a string."
3078 ;; We are going to cross a hline. Check if this is
3079 ;; an authorized move.
3090 ;; The last hline doesn't exist. Instead, point to last row
3091 ;; in table.
3100 "Convert list ELEMENTS to something appropriate to insert into formula.
3101 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3102 NUMBERS indicates that everything should be converted to numbers.
3103 LISPP non-nil means to return something appropriate for a Lisp
3104 list, `literal' is for the format specifier L."
3105 ;; Calc nan (not a number) is used for the conversion of the empty
3106 ;; field to a reference for several reasons: (i) It is accepted in a
3107 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3108 ;; (ii) In a single field (not in range) it can be distinguished
3109 ;; from "(nan)" which is the reference made from a single field
3110 ;; containing "nan".
3112 ;; field reference
3115 elements
3117 ""
3126 ;; range reference
3131 elements))))
3137 x
3145 x)
3147 elements
3151 "If there has been more than one second since T1, display message.
3152 ARGS are passed as arguments to the `message' function. Returns
3153 current time if a message is printed, otherwise returns T1. If
3154 T1 is nil, always messages."
3158 curtime)
3159 t1)))
3161 ;;;###autoload
3163 "Recalculate the current table line by applying all stored formulas.
3165 With prefix arg ALL, do this for all lines in the table.
3168 if ALL is the symbol `iterate',
3169 recompute the table until it no longer changes.
3171 If NOALIGN is not nil, do not re-align the table after the computations
3172 are done. This is typically used internally to save time, if it is
3173 known that the table will be realigned a little later anyway."
3188 beg end eqlcol eqlfield)
3189 ;; Insert constants in all formulas.
3192 ;; Expand equations, then split the equation list between
3193 ;; column formulas and field formulas.
3205 old-lhs)))
3208 existing formula for column %s"
3209 old-lhs
3210 new))
3211 new))
3217 ;; Expand ranges in lhs of formulas
3219 ;; Get the correct line range to process.
3226 ;; This is a table with marked lines, compute selected
3227 ;; lines.
3229 ;; Move forward to the first non-header line.
3234 ;; Just leave BEG at the start of the table.
3239 ;; Mark named fields untouchable. Also check if several
3240 ;; field/range formulas try to set the same field.
3244 seen-fields)
3255 ;; Turn field coordinates associated to NAME
3256 ;; into an absolute reference.
3260 name)))
3263 reference))
3268 ;; Evaluate the column formulas, but skip fields covered by
3269 ;; field formulas.
3273 ;; Unprotected line, recalculate.
3278 log-last-time
3291 ;; Evaluate the field formulas.
3300 reference
3301 ;; Possibly create a new column, as long as
3302 ;; `org-table-formula-create-columns' allows it.
3314 t))
3319 ;; Clean up markers and internal text property.
3330 ;;;###autoload
3332 "Recalculate the table until it does not change anymore.
3333 The maximum number of iterations is 10, but you can choose a different value
3334 with the prefix ARG."
3339 thistbl)
3353 ;;;###autoload
3355 "Recalculate all tables in the current buffer."
3360 ;; Reason for separate `org-table-align': When repeating
3361 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3362 ;; the way.
3365 t)))
3367 ;;;###autoload
3369 "Iterate all tables in the buffer, to converge inter-table dependencies."
3374 c1)
3390 "Apply the #+TBLFM in the line at point to the table."
3397 ;; Insert a temporary formula at right after the table
3402 ;; Recalculate the table.
3407 ;; Delete the formula inserted temporarily.
3413 "Find the beginning of the TBLFM lines and return its position.
3414 Return nil when the beginning of TBLFM line was not found."
3421 "Expand list of formulas.
3422 If some of the RHS in the formulas are ranges or a row reference,
3423 expand them to individual field equations for each field. This
3424 function assumes the table is already analyzed (i.e., using
3425 `org-table-analyze')."
3432 ;; This just refers to one fixed field.
3435 ;; This just refers to one fixed named field.
3438 ;; Column formulas are treated specially and are not
3439 ;; expanded.
3444 rhs)
3445 res)))
3457 rhs)
3458 res))))))))))
3461 "Replace @<, @>, $<, $> with first/last row/column of the table.
3462 So @< and $< will always be replaced with @1 and $1, respectively.
3463 The advantage of these special markers are that structure editing of
3464 the table will not change them, while @1 and $1 will be modified
3465 when a line/row is swapped out of that privileged position. So for
3466 formulas that use a range of rows or columns, it may often be better
3468 borders of the table using the @< @> $< $> makers."
3471 s start)
3476 org-table-current-ncol)
3480 len
3487 s)
3490 "Replace $const with values in string F."
3495 org-table-column-name-regexp
3498 org-table-column-names))))
3499 f t t)))
3500 ;; Parameters and constants.
3504 new start))
3507 ;; When a duration is expected, convert value on the fly.
3513 v)))))
3520 "Find the value for a parameter or constant in a formula.
3521 Parameters get priority."
3552 map))
3559 "--"
3562 "--"
3563 "Shift Reference at Point"
3568 "-"
3569 "Change Test Row for Column Formulas"
3572 "--"
3577 org-table-overlay-coordinates)]
3578 "--"
3586 ;;;###autoload
3588 "Edit the formulas of the current table in a separate buffer."
3594 ;; Move point within the table before analyzing it.
3610 ;; Keep global-font-lock-mode from turning on font-lock-mode
3655 "Convert a formula from internal to user representation."
3658 s))
3661 "Convert a formula from user to internal representation."
3664 s))
3667 "Convert spreadsheet references from A7 to @7$28.
3668 Works for single references, but also for entire formulas and even the
3669 full TBLFM line."
3671 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3674 ;; format match, just advance
3679 ;; 3.e5 or something like this.
3682 ;; (member (match-string 1 s)
3683 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3684 )
3685 ;; function name, just advance
3695 t t s)))))
3696 s))
3699 "Convert spreadsheet references from to @7$28 to AB7.
3700 Works for single references, but also for entire formulas and even the
3701 full TBLFM line."
3708 t t s)))
3713 t nil s)))
3714 s)
3717 "Convert a base 26 number represented by letters into an integer.
3718 For example: AB -> 28."
3724 n))
3727 "Convert an integer into a base 26 number represented by letters.
3728 For example: 28 -> AB."
3733 s))
3736 "Convert a time string into numerical duration in seconds.
3737 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3738 If S is a string representing a number, keep this number."
3740 s
3763 "Convert a number of seconds to a time string.
3764 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3765 minutes or seconds."
3777 ;; Ignore seconds
3781 secs0)
3786 secs0)))))
3790 "Convert all references in this buffer, using FUNCTION."
3801 "Convert all references in the buffer from B3 to @3$2 and back."
3811 "Shift the reference at point one row/hline up."
3815 "Shift the reference at point one row/hline down."
3819 "Shift the reference at point one field to the left."
3823 "Shift the reference at point one field to the right."
3834 ;; A B3-like reference
3840 ;; An internal reference
3846 "Re-match the group N, and replace it with the shifted reference."
3851 t t)))
3854 "Shift a reference part REF.
3855 If DECR is set, decrease the references row/column, else increase.
3856 If HLINE is set, this may be a hline reference, it certainly is not
3857 a translation reference."
3886 "Toggle the display of coordinates in the referenced table."
3895 "Parse the buffer for formula definitions and install them.
3896 With prefix ARG, apply the new formulas to the table."
3905 eql)
3908 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3909 nil t)
3930 "Abort editing formulas, without installing the changes."
3941 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3982 "Show the location/value of the $ expression at point.
3983 When LOCAL is non-nil, show references for the table at point."
3993 var name e what match dest)
3997 "$1.."
4049 dest)
4075 ;; Column number.
4101 org-table-fedit-scroll-down))))
4113 "Make sure the cursor is in a dataline in a table."
4122 p1 p2)))
4127 "Move cursor one line up in the window showing the table."
4132 "Move cursor one line down in the window showing the table."
4137 "Move the cursor in the window showing the table.
4138 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4163 "Add a new overlay."
4169 "Highlight rectangular region in a table.
4170 When buffer positions BEG and END are provided, use them to
4171 delimit the region to highlight. Otherwise, refer to point. Use
4172 FACE, when non-nil, for the highlight."
4204 "Remove the rectangle overlays."
4214 "Add overlays to the table at point, to show row/column coordinates."
4242 ;;;###autoload
4244 "Toggle the display of Row/Column numbers in tables."
4255 ;;;###autoload
4257 "Toggle the formula debugger in tables."
4263 ;;; The orgtbl minor mode
4265 ;; Define a minor mode which can be used in other modes in order to
4266 ;; integrate the Org table editor.
4268 ;; This is really a hack, because the Org table editor uses several
4269 ;; keys which normally belong to the major mode, for example the TAB
4270 ;; and RET keys. Here is how it works: The minor mode defines all the
4271 ;; keys necessary to operate the table editor, but wraps the commands
4272 ;; into a function which tests if the cursor is currently inside
4273 ;; a table. If that is the case, the table editor command is
4274 ;; executed. However, when any of those keys is used outside a table,
4275 ;; the function uses `key-binding' to look up if the key has an
4276 ;; associated command in another currently active keymap (minor modes,
4277 ;; major mode, global), and executes that command. There might be
4278 ;; problems if any of the keys used by the table editor is otherwise
4279 ;; used as a prefix key.
4281 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4282 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4283 ;; addresses this by checking explicitly for both bindings.
4285 ;; The optimized version (see variable `orgtbl-optimized') takes over
4286 ;; all keys which are bound to `self-insert-command' in the *global map*.
4287 ;; Some modes bind other commands to simple characters, for example
4288 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4289 ;; active, this binding is ignored inside tables and replaced with a
4290 ;; modified self-insert.
4308 ;; Install it as a minor mode.
4312 ;;;###autoload
4314 "The `org-mode' table editor as a minor mode for use in other modes."
4319 ;; Exit without error, in case some hook functions calls this
4320 ;; by accident in org-mode.
4324 ;; Make sure we are first in minor-mode-map-alist
4326 ;; FIXME: maybe it should use emulation-mode-map-alists?
4333 auto-fill-inhibit-regexp)
4337 auto-fill-inhibit-regexp)
4338 orgtbl-line-start-regexp))
4356 "Remove all properties related to narrow-column invisibility."
4369 "Create a function for binding in the table minor mode.
4370 FUN is the command to call inside a table. N is used to create a unique
4371 command name. KEYS are keys that should be checked in for a command
4372 to execute outside of tables."
4378 "Outside of tables, run the binding of `"
4390 keys)
4394 "Error when there is no default binding for a table key."
4399 "Setup orgtbl keymaps."
4430 elt key fun cmd)
4438 ;; Special treatment needed for TAB, RET and DEL
4451 (orgtbl-make-binding 'org-delete-backward-char 109
4457 [(tab)] "\C-i"))
4459 (org-defkey orgtbl-mode-map [backtab]
4461 [backtab] [S-iso-lefttab] [(shift tab)]
4462 [(tab)] "\C-i"))
4464 (org-defkey orgtbl-mode-map "\M-\C-m"
4465 (orgtbl-make-binding 'org-table-wrap-region 105
4466 "\M-\C-m" [(meta return)]))
4467 (org-defkey orgtbl-mode-map [(meta return)]
4468 (orgtbl-make-binding 'org-table-wrap-region 106
4469 [(meta return)] "\M-\C-m"))
4471 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4472 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4474 (when orgtbl-optimized
4475 ;; If the user wants maximum table support, we need to hijack
4476 ;; some standard editing functions
4477 (org-remap orgtbl-mode-map
4478 'self-insert-command 'orgtbl-self-insert-command
4479 'delete-char 'org-delete-char
4480 'delete-backward-char 'org-delete-backward-char)
4481 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4482 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4483 '("OrgTbl"
4484 ["Create or convert" org-table-create-or-convert-from-region
4485 :active (not (org-at-table-p)) :keys "C-c |" ]
4486 "--"
4487 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4488 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4489 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4490 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4491 "--"
4492 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4493 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4494 ["Copy Field from Above"
4495 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4496 "--"
4497 ("Column"
4498 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4499 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4500 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4501 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4502 ("Row"
4503 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4504 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4505 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4506 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4507 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4508 "--"
4509 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4510 ("Rectangle"
4511 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4512 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4513 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4514 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4515 "--"
4516 ("Radio tables"
4517 ["Insert table template" orgtbl-insert-radio-table
4518 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4519 ["Comment/uncomment table" orgtbl-toggle-comment t])
4520 "--"
4521 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4522 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4523 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4524 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4525 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4526 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4527 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4528 ["Sum Column/Rectangle" org-table-sum
4529 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4530 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4531 ["Debug Formulas"
4532 org-table-toggle-formula-debugger :active (org-at-table-p)
4533 :keys "C-c {"
4534 :style toggle :selected org-table-formula-debug]
4535 ["Show Col/Row Numbers"
4536 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4537 :keys "C-c }"
4538 :style toggle :selected org-table-overlay-coordinates]
4539 "--"
4540 ("Plot"
4543 t))
4545 (defun orgtbl-ctrl-c-ctrl-c (arg)
4546 "If the cursor is inside a table, realign the table.
4547 If it is a table to be sent away to a receiver, do it.
4548 With prefix arg, also recompute table."
4549 (interactive "P")
4550 (let ((case-fold-search t) (pos (point)) action)
4551 (save-excursion
4552 (beginning-of-line 1)
4553 (setq action (cond
4557 (cond
4558 ((integerp action)
4559 (goto-char action)
4560 (org-table-maybe-eval-formula)
4561 (if arg
4562 (call-interactively 'org-table-recalculate)
4563 (org-table-maybe-recalculate-line))
4564 (call-interactively 'org-table-align)
4565 (when (orgtbl-send-table 'maybe)
4566 (run-hooks 'orgtbl-after-send-table-hook)))
4567 ((eq action 'recalc)
4568 (save-excursion
4569 (beginning-of-line 1)
4571 (if (org-at-table-p)
4572 (org-call-with-arg 'org-table-recalculate t))))
4573 (t (let (orgtbl-mode)
4574 (call-interactively (key-binding "\C-c\C-c")))))))
4576 (defun orgtbl-create-or-convert-from-region (_arg)
4577 "Create table or convert region to table, if no conflicting binding.
4578 This installs the table binding `C-c |', but only if there is no
4579 conflicting binding to this key outside orgtbl-mode."
4580 (interactive "P")
4581 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4582 (if cmd
4583 (call-interactively cmd)
4584 (call-interactively 'org-table-create-or-convert-from-region))))
4586 (defun orgtbl-tab (arg)
4587 "Justification and field motion for `orgtbl-mode'."
4588 (interactive "P")
4589 (if arg (org-table-edit-field t)
4590 (org-table-justify-field-maybe)
4591 (org-table-next-field)))
4593 (defun orgtbl-ret ()
4594 "Justification and field motion for `orgtbl-mode'."
4595 (interactive)
4596 (if (bobp)
4597 (newline)
4598 (org-table-justify-field-maybe)
4599 (org-table-next-row)))
4601 (defun orgtbl-self-insert-command (N)
4602 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4603 If the cursor is in a table looking at whitespace, the whitespace is
4604 overwritten, and the table is not marked as requiring realignment."
4605 (interactive "p")
4606 (if (and (org-at-table-p)
4607 (or
4608 (and org-table-auto-blank-field
4609 (member last-command
4610 '(orgtbl-hijacker-command-100
4611 orgtbl-hijacker-command-101
4612 orgtbl-hijacker-command-102
4613 orgtbl-hijacker-command-103
4614 orgtbl-hijacker-command-104
4615 orgtbl-hijacker-command-105
4616 yas/expand))
4617 (org-table-blank-field))
4618 t)
4619 (eq N 1)
4621 (let (org-table-may-need-update)
4622 (delete-region (match-beginning 1) (match-end 1))
4623 (self-insert-command N))
4624 (setq org-table-may-need-update t)
4625 (let* (orgtbl-mode
4626 a
4627 (cmd (or (key-binding
4628 (or (and (listp function-key-map)
4629 (setq a (assoc last-input-event function-key-map))
4630 (cdr a))
4631 (vector last-input-event)))
4632 'self-insert-command)))
4633 (call-interactively cmd)
4634 (if (and org-self-insert-cluster-for-undo
4635 (eq cmd 'self-insert-command))
4636 (if (not (eq last-command 'orgtbl-self-insert-command))
4637 (setq org-self-insert-command-undo-counter 1)
4638 (if (>= org-self-insert-command-undo-counter 20)
4639 (setq org-self-insert-command-undo-counter 1)
4640 (and (> org-self-insert-command-undo-counter 0)
4641 buffer-undo-list
4642 (not (cadr buffer-undo-list)) ; remove nil entry
4643 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4644 (setq org-self-insert-command-undo-counter
4645 (1+ org-self-insert-command-undo-counter))))))))
4647 ;;;###autoload
4649 "Regular expression matching exponentials as produced by calc.")
4651 (defun orgtbl-gather-send-defs ()
4652 "Gather a plist of :name, :transform, :params for each destination before
4653 a radio table."
4654 (save-excursion
4655 (goto-char (org-table-begin))
4656 (let (rtn)
4657 (beginning-of-line 0)
4658 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4659 (let ((name (org-no-properties (match-string 1)))
4660 (transform (intern (match-string 2)))
4661 (params (if (match-end 3)
4662 (read (concat "(" (match-string 3) ")")))))
4663 (push (list :name name :transform transform :params params)
4664 rtn)
4665 (beginning-of-line 0)))
4666 rtn)))
4668 (defun orgtbl-send-replace-tbl (name text)
4669 "Find and replace table NAME with TEXT."
4670 (save-excursion
4671 (goto-char (point-min))
4672 (let* ((location-flag nil)
4673 (name (regexp-quote name))
4676 (while (re-search-forward begin-re nil t)
4677 (unless location-flag (setq location-flag t))
4678 (let ((beg (line-beginning-position 2)))
4679 (unless (re-search-forward end-re nil t)
4680 (user-error "Cannot find end of receiver location at %d" beg))
4681 (beginning-of-line)
4682 (delete-region beg (point))
4684 (unless location-flag
4685 (user-error "No valid receiver location found in the buffer")))))
4687 ;;;###autoload
4688 (defun org-table-to-lisp (&optional txt)
4689 "Convert the table at point to a Lisp structure.
4690 The structure will be a list. Each item is either the symbol `hline'
4691 for a horizontal separator line, or a list of field values as strings.
4692 The table is taken from the parameter TXT, or from the buffer at point."
4693 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4694 (let ((txt (or txt
4695 (buffer-substring-no-properties (org-table-begin)
4696 (org-table-end)))))
4697 (mapcar (lambda (x)
4698 (if (string-match org-table-hline-regexp x) 'hline
4702 (defun orgtbl-send-table (&optional maybe)
4703 "Send a transformed version of table at point to the receiver position.
4704 With argument MAYBE, fail quietly if no transformation is defined
4705 for this table."
4706 (interactive)
4707 (catch 'exit
4708 (unless (org-at-table-p) (user-error "Not at a table"))
4709 ;; when non-interactive, we assume align has just happened.
4710 (when (called-interactively-p 'any) (org-table-align))
4711 (let ((dests (orgtbl-gather-send-defs))
4712 (table (org-table-to-lisp
4713 (buffer-substring-no-properties (org-table-begin)
4714 (org-table-end))))
4715 (ntbl 0))
4716 (unless dests
4717 (if maybe (throw 'exit nil)
4718 (user-error "Don't know how to transform this table")))
4719 (dolist (dest dests)
4720 (let ((name (plist-get dest :name))
4721 (transform (plist-get dest :transform))
4722 (params (plist-get dest :params)))
4723 (unless (fboundp transform)
4724 (user-error "No such transformation function %s" transform))
4725 (orgtbl-send-replace-tbl name (funcall transform table params)))
4726 (cl-incf ntbl))
4727 (message "Table converted and installed at %d receiver location%s"
4728 ntbl (if (> ntbl 1) "s" ""))
4729 (and (> ntbl 0) ntbl))))
4731 (defun org-remove-by-index (list indices &optional i0)
4732 "Remove the elements in LIST with indices in INDICES.
4733 First element has index 0, or I0 if given."
4734 (if (not indices)
4735 list
4736 (if (integerp indices) (setq indices (list indices)))
4737 (setq i0 (1- (or i0 0)))
4738 (delq :rm (mapcar (lambda (x)
4739 (setq i0 (1+ i0))
4740 (if (memq i0 indices) :rm x))
4741 list))))
4743 (defun orgtbl-toggle-comment ()
4744 "Comment or uncomment the orgtbl at point."
4745 (interactive)
4746 (let* ((case-fold-search t)
4747 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4748 (re2 (concat "^" orgtbl-line-start-regexp))
4749 (commented (save-excursion (beginning-of-line 1)
4750 (cond ((looking-at re1) t)
4751 ((looking-at re2) nil)
4752 (t (user-error "Not at an org table")))))
4753 (re (if commented re1 re2))
4754 beg end)
4755 (save-excursion
4756 (beginning-of-line 1)
4757 (while (looking-at re) (beginning-of-line 0))
4758 (beginning-of-line 2)
4759 (setq beg (point))
4760 (while (looking-at re) (beginning-of-line 2))
4761 (setq end (point)))
4762 (comment-region beg end (if commented '(4) nil))))
4764 (defun orgtbl-insert-radio-table ()
4765 "Insert a radio table template appropriate for this major mode."
4766 (interactive)
4767 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4768 (txt (nth 1 e))
4769 name pos)
4770 (unless e (user-error "No radio table setup defined for %s" major-mode))
4771 (setq name (read-string "Table name: "))
4772 (while (string-match "%n" txt)
4773 (setq txt (replace-match name t t txt)))
4775 (setq pos (point))
4776 (insert txt)
4777 (goto-char pos)))
4779 ;;;###autoload
4780 (defun orgtbl-to-generic (table params)
4781 "Convert the orgtbl-mode TABLE to some other format.
4783 This generic routine can be used for many standard cases.
4785 TABLE is a list, each entry either the symbol `hline' for
4786 a horizontal separator line, or a list of fields for that
4787 line. PARAMS is a property list of parameters that can
4788 influence the conversion.
4790 Valid parameters are:
4792 :backend, :raw
4794 Export back-end used as a basis to transcode elements of the
4795 table, when no specific parameter applies to it. It is also
4796 used to translate cells contents. You can prevent this by
4797 setting :raw property to a non-nil value.
4799 :splice
4801 When non-nil, only convert rows, not the table itself. This is
4802 equivalent to setting to the empty string both :tstart
4803 and :tend, which see.
4805 :skip
4807 When set to an integer N, skip the first N lines of the table.
4808 Horizontal separation lines do count for this parameter!
4810 :skipcols
4812 List of columns that should be skipped. If the table has
4813 a column with calculation marks, that column is automatically
4814 discarded beforehand.
4816 :hline
4818 String to be inserted on horizontal separation lines. May be
4819 nil to ignore these lines altogether.
4821 :sep
4823 Separator between two fields, as a string.
4825 Each in the following group may be either a string or a function
4826 of no arguments returning a string:
4828 :tstart, :tend
4830 Strings to start and end the table. Ignored when :splice is t.
4832 :lstart, :lend
4834 Strings to start and end a new table line.
4836 :llstart, :llend
4838 Strings to start and end the last table line. Default,
4839 respectively, to :lstart and :lend.
4841 Each in the following group may be a string or a function of one
4842 argument (either the cells in the current row, as a list of
4843 strings, or the current cell) returning a string:
4845 :lfmt
4847 Format string for an entire row, with enough %s to capture all
4848 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4850 :llfmt
4852 Format for the entire last line, defaults to :lfmt.
4854 :fmt
4856 A format to be used to wrap the field, should contain %s for
4857 the original field value. For example, to wrap everything in
4859 a property list with column numbers and format strings, or
4860 functions, e.g.,
4864 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4866 Same as above, specific for the header lines in the table.
4867 All lines before the first hline are treated as header. If
4868 any of these is not present, the data line value is used.
4870 This may be either a string or a function of two arguments:
4872 :efmt
4874 Use this format to print numbers with exponential. The format
4875 should have %s twice for inserting mantissa and exponent, for
4877 list with column numbers and format strings or functions.
4878 :fmt will still be applied after :efmt."
4879 ;; Make sure `org-export-create-backend' is available.
4880 (require 'ox)
4881 (let* ((backend (plist-get params :backend))
4882 (custom-backend
4883 ;; Build a custom back-end according to PARAMS. Before
4884 ;; defining a translator, check if there is anything to do.
4885 ;; When there isn't, let BACKEND handle the element.
4886 (org-export-create-backend
4887 :parent (or backend 'org)
4888 :transcoders
4889 `((table . ,(org-table--to-generic-table params))
4890 (table-row . ,(org-table--to-generic-row params))
4891 (table-cell . ,(org-table--to-generic-cell params))
4892 ;; Macros are not going to be expanded. However, no
4893 ;; regular back-end has a transcoder for them. We
4894 ;; provide one so they are not ignored, but displayed
4895 ;; as-is instead.
4896 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4897 data info)
4898 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4899 ;; Initialize communication channel in INFO.
4900 (with-temp-buffer
4901 (let ((org-inhibit-startup t)) (org-mode))
4902 (let ((standard-output (current-buffer))
4903 (org-element-use-cache nil))
4904 (dolist (e table)
4906 ((consp e)
4907 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4909 ;; Add back-end specific filters, but not user-defined ones. In
4910 ;; particular, make sure to call parse-tree filters on the
4911 ;; table.
4912 (setq info
4913 (let ((org-export-filters-alist nil))
4914 (org-export-install-filters
4915 (org-combine-plists
4916 (org-export-get-environment backend nil params)
4917 `(:back-end ,(org-export-get-backend backend))))))
4918 (setq data
4919 (org-export-filter-apply-functions
4920 (plist-get info :filter-parse-tree)
4921 (org-element-map (org-element-parse-buffer) 'table
4922 #'identity nil t)
4923 info)))
4924 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4925 (user-error "Unknown :backend value"))
4926 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4927 ;; Handle :skip parameter.
4928 (let ((skip (plist-get info :skip)))
4929 (when skip
4930 (unless (wholenump skip) (user-error "Wrong :skip value"))
4931 (let ((n 0))
4932 (org-element-map data 'table-row
4933 (lambda (row)
4934 (if (>= n skip) t
4935 (org-element-extract-element row)
4936 (cl-incf n)
4937 nil))
4938 nil t))))
4939 ;; Handle :skipcols parameter.
4940 (let ((skipcols (plist-get info :skipcols)))
4941 (when skipcols
4942 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4943 (org-element-map data 'table
4944 (lambda (table)
4945 (let ((specialp (org-export-table-has-special-column-p table)))
4946 (dolist (row (org-element-contents table))
4947 (when (eq (org-element-property :type row) 'standard)
4948 (let ((c 1))
4949 (dolist (cell (nthcdr (if specialp 1 0)
4950 (org-element-contents row)))
4951 (when (memq c skipcols)
4952 (org-element-extract-element cell))
4953 (cl-incf c))))))))))
4954 ;; Since we are going to export using a low-level mechanism,
4955 ;; ignore special column and special rows manually.
4956 (let ((special? (org-export-table-has-special-column-p data))
4957 ignore)
4958 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4959 (lambda (datum)
4960 (when (if (eq (org-element-type datum) 'table-row)
4961 (org-export-table-row-is-special-p datum nil)
4962 (org-export-first-sibling-p datum nil))
4963 (push datum ignore))))
4964 (setq info (plist-put info :ignore-list ignore)))
4965 ;; We use a low-level mechanism to export DATA so as to skip all
4966 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4967 ;; code evaluation, include keywords and macro expansion. Only
4968 ;; back-end specific filters are retained.
4969 (let ((output (org-export-data-with-backend data custom-backend info)))
4970 ;; Remove final newline.
4971 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4973 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4974 (cond ((null value) nil)
4975 ((functionp value) `(funcall ',value ,@args))
4976 ((stringp value)
4977 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4978 (args `(format ,value ,@args))
4979 (t value)))
4980 ((and with-cons (consp value))
4981 `(let ((val (cadr (memq column ',value))))
4982 (cond ((null val) contents)
4983 ((stringp val) (format val ,@args))
4984 ((functionp val) (funcall val ,@args))
4985 (t (user-error "Wrong %s value" ,name)))))
4986 (t (user-error "Wrong %s value" name))))
4988 (defun org-table--to-generic-table (params)
4989 "Return custom table transcoder according to PARAMS.
4990 PARAMS is a plist. See `orgtbl-to-generic' for more
4991 information."
4992 (let ((backend (plist-get params :backend))
4993 (splice (plist-get params :splice))
4994 (tstart (plist-get params :tstart))
4995 (tend (plist-get params :tend)))
4996 `(lambda (table contents info)
4997 (concat
4998 ,(and tstart (not splice)
5000 ,(if (or (not backend) tstart tend splice) 'contents
5001 `(org-export-with-backend ',backend table contents info))
5002 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5004 (defun org-table--to-generic-row (params)
5005 "Return custom table row transcoder according to PARAMS.
5006 PARAMS is a plist. See `orgtbl-to-generic' for more
5007 information."
5008 (let* ((backend (plist-get params :backend))
5009 (lstart (plist-get params :lstart))
5010 (llstart (plist-get params :llstart))
5011 (hlstart (plist-get params :hlstart))
5012 (hllstart (plist-get params :hllstart))
5013 (lend (plist-get params :lend))
5014 (llend (plist-get params :llend))
5015 (hlend (plist-get params :hlend))
5016 (hllend (plist-get params :hllend))
5017 (lfmt (plist-get params :lfmt))
5018 (llfmt (plist-get params :llfmt))
5019 (hlfmt (plist-get params :hlfmt))
5020 (hllfmt (plist-get params :hllfmt)))
5021 `(lambda (row contents info)
5022 (if (eq (org-element-property :type row) 'rule)
5023 ,(cond
5024 ((plist-member params :hline)
5025 (org-table--generic-apply (plist-get params :hline) ":hline"))
5026 (backend `(org-export-with-backend ',backend row nil info)))
5027 (let ((headerp ,(and (or hlfmt hlstart hlend)
5028 '(org-export-table-row-in-header-p row info)))
5029 (last-header-p
5030 ,(and (or hllfmt hllstart hllend)
5031 '(org-export-table-row-ends-header-p row info)))
5032 (lastp (not (org-export-get-next-element row info))))
5033 (when contents
5034 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5035 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5036 ;; `:lstart', `:lend' and their relatives.
5037 ,(let ((cells
5038 '(org-element-map row 'table-cell
5039 (lambda (cell)
5040 ;; Export all cells, without separators.
5041 ;;
5042 ;; Use `org-export-data-with-backend'
5043 ;; instead of `org-export-data' to eschew
5044 ;; cached values, which
5045 ;; ignore :orgtbl-ignore-sep parameter.
5046 (org-export-data-with-backend
5047 cell
5048 (plist-get info :back-end)
5049 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5050 info)))
5051 `(cond
5052 ,(and hllfmt
5053 `(last-header-p ,(org-table--generic-apply
5054 hllfmt ":hllfmt" nil cells)))
5055 ,(and hlfmt
5056 `(headerp ,(org-table--generic-apply
5057 hlfmt ":hlfmt" nil cells)))
5058 ,(and llfmt
5059 `(lastp ,(org-table--generic-apply
5060 llfmt ":llfmt" nil cells)))
5061 (t
5062 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5063 `(concat
5064 (cond
5065 ,(and
5066 (or hllstart hllend)
5067 `(last-header-p
5068 (concat
5069 ,(org-table--generic-apply hllstart ":hllstart")
5070 contents
5071 ,(org-table--generic-apply hllend ":hllend"))))
5072 ,(and
5073 (or hlstart hlend)
5074 `(headerp
5075 (concat
5076 ,(org-table--generic-apply hlstart ":hlstart")
5077 contents
5078 ,(org-table--generic-apply hlend ":hlend"))))
5079 ,(and
5080 (or llstart llend)
5081 `(lastp
5082 (concat
5083 ,(org-table--generic-apply llstart ":llstart")
5084 contents
5085 ,(org-table--generic-apply llend ":llend"))))
5086 (t
5087 ,(cond
5088 ((or lstart lend)
5089 `(concat
5090 ,(org-table--generic-apply lstart ":lstart")
5091 contents
5092 ,(org-table--generic-apply lend ":lend")))
5093 (backend
5094 `(org-export-with-backend
5095 ',backend row contents info))
5096 (t 'contents)))))))))))))))
5098 (defun org-table--to-generic-cell (params)
5099 "Return custom table cell transcoder according to PARAMS.
5100 PARAMS is a plist. See `orgtbl-to-generic' for more
5101 information."
5102 (let* ((backend (plist-get params :backend))
5103 (efmt (plist-get params :efmt))
5104 (fmt (plist-get params :fmt))
5105 (hfmt (plist-get params :hfmt))
5106 (sep (plist-get params :sep))
5107 (hsep (plist-get params :hsep)))
5108 `(lambda (cell contents info)
5109 ;; Make sure that contents are exported as Org data when :raw
5110 ;; parameter is non-nil.
5111 ,(when (and backend (plist-get params :raw))
5112 `(setq contents
5113 ;; Since we don't know what are the pseudo object
5114 ;; types defined in backend, we cannot pass them to
5115 ;; `org-element-interpret-data'. As a consequence,
5116 ;; they will be treated as pseudo elements, and will
5117 ;; have newlines appended instead of spaces.
5118 ;; Therefore, we must make sure :post-blank value is
5119 ;; really turned into spaces.
5120 (replace-regexp-in-string
5122 (org-trim
5123 (org-element-interpret-data
5124 (org-element-contents cell))))))
5126 (let ((headerp ,(and (or hfmt hsep)
5127 '(org-export-table-row-in-header-p
5128 (org-export-get-parent-element cell) info)))
5129 (column
5130 ;; Call costly `org-export-table-cell-address' only if
5131 ;; absolutely necessary, i.e., if one
5132 ;; of :fmt :efmt :hfmt has a "plist type" value.
5133 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5134 (list efmt hfmt fmt))
5135 '(1+ (cdr (org-export-table-cell-address cell info))))))
5136 (when contents
5137 ;; Check if we can apply `:efmt' on CONTENTS.
5138 ,(when efmt
5139 `(when (string-match orgtbl-exp-regexp contents)
5140 (let ((mantissa (match-string 1 contents))
5141 (exponent (match-string 2 contents)))
5142 (setq contents ,(org-table--generic-apply
5143 efmt ":efmt" t 'mantissa 'exponent)))))
5144 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5145 (cond
5146 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5147 hfmt ":hfmt" t 'contents))))
5148 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5149 fmt ":fmt" t 'contents))))))
5150 ;; If a separator is provided, use it instead of BACKEND's.
5151 ;; Separators are ignored when LFMT (or equivalent) is
5152 ;; provided.
5153 ,(cond
5154 ((or hsep sep)
5155 `(if (or ,(and (not sep) '(not headerp))
5156 (plist-get info :orgtbl-ignore-sep)
5157 (not (org-export-get-next-element cell info)))
5158 ,(if (not backend) 'contents
5159 `(org-export-with-backend ',backend cell contents info))
5160 (concat contents
5161 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5162 (or hsep sep)))))
5163 (backend `(org-export-with-backend ',backend cell contents info))
5164 (t 'contents))))))
5166 ;;;###autoload
5167 (defun orgtbl-to-tsv (table params)
5168 "Convert the orgtbl-mode table to TAB separated material."
5171 ;;;###autoload
5172 (defun orgtbl-to-csv (table params)
5173 "Convert the orgtbl-mode table to CSV material.
5174 This does take care of the proper quoting of fields with comma or quotes."
5175 (orgtbl-to-generic table
5176 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5177 params)))
5179 ;;;###autoload
5180 (defun orgtbl-to-latex (table params)
5181 "Convert the orgtbl-mode TABLE to LaTeX.
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 ones:
5189 :booktabs
5193 :environment
5195 Specify environment to use, as a string. If you use
5197 as a string, to get proper continuation strings."
5198 (require 'ox-latex)
5199 (orgtbl-to-generic
5200 table
5201 (org-combine-plists
5202 ;; Provide sane default values.
5203 (list :backend 'latex
5204 :latex-default-table-mode 'table
5205 :latex-tables-centered nil
5206 :latex-tables-booktabs (plist-get params :booktabs)
5207 :latex-table-scientific-notation nil
5208 :latex-default-table-environment
5209 (or (plist-get params :environment) "tabular"))
5210 params)))
5212 ;;;###autoload
5213 (defun orgtbl-to-html (table params)
5214 "Convert the orgtbl-mode TABLE to HTML.
5216 TABLE is a list, each entry either the symbol `hline' for
5217 a horizontal separator line, or a list of fields for that line.
5218 PARAMS is a property list of parameters that can influence the
5219 conversion. All parameters from `orgtbl-to-generic' are
5220 supported. It is also possible to use the following one:
5222 :attributes
5224 Attributes and values, as a plist, which will be used in
5225 <table> tag."
5226 (require 'ox-html)
5227 (orgtbl-to-generic
5228 table
5229 (org-combine-plists
5230 ;; Provide sane default values.
5231 (list :backend 'html
5232 :html-table-data-tags '("<td%s>" . "</td>")
5233 :html-table-use-header-tags-for-first-column nil
5234 :html-table-align-individual-fields t
5235 :html-table-row-tags '("<tr>" . "</tr>")
5236 :html-table-attributes
5237 (if (plist-member params :attributes)
5238 (plist-get params :attributes)
5239 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5240 :frame "hsides")))
5241 params)))
5243 ;;;###autoload
5244 (defun orgtbl-to-texinfo (table params)
5245 "Convert the orgtbl-mode TABLE to Texinfo.
5247 TABLE is a list, each entry either the symbol `hline' for
5248 a horizontal separator line, or a list of fields for that line.
5249 PARAMS is a property list of parameters that can influence the
5250 conversion. All parameters from `orgtbl-to-generic' are
5251 supported. It is also possible to use the following one:
5253 :columns
5255 Column widths, as a string. When providing column fractions,
5257 (require 'ox-texinfo)
5258 (let ((output
5259 (orgtbl-to-generic
5260 table
5261 (org-combine-plists
5262 (list :backend 'texinfo
5263 :texinfo-tables-verbatim nil
5264 :texinfo-table-scientific-notation nil)
5265 params)))
5266 (columns (let ((w (plist-get params :columns)))
5267 (cond ((not w) nil)
5269 (t (concat "@columnfractions " w))))))
5270 (if (not columns) output
5271 (replace-regexp-in-string
5274 ;;;###autoload
5275 (defun orgtbl-to-orgtbl (table params)
5276 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5278 TABLE is a list, each entry either the symbol `hline' for
5279 a horizontal separator line, or a list of fields for that line.
5280 PARAMS is a property list of parameters that can influence the
5281 conversion. All parameters from `orgtbl-to-generic' are
5282 supported.
5284 Useful when slicing one table into many. The :hline, :sep,
5285 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5286 be set to provide ORGTBL directives for the generated table."
5287 (require 'ox-org)
5288 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5290 (defun orgtbl-to-table.el (table params)
5291 "Convert the orgtbl-mode TABLE into a table.el table.
5292 TABLE is a list, each entry either the symbol `hline' for
5293 a horizontal separator line, or a list of fields for that line.
5294 PARAMS is a property list of parameters that can influence the
5295 conversion. All parameters from `orgtbl-to-generic' are
5296 supported."
5297 (with-temp-buffer
5298 (insert (orgtbl-to-orgtbl table params))
5299 (org-table-align)
5300 (replace-regexp-in-string
5301 "-|" "-+"
5302 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5304 (defun orgtbl-to-unicode (table params)
5305 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5307 TABLE is a list, each entry either the symbol `hline' for
5308 a horizontal separator line, or a list of fields for that line.
5309 PARAMS is a property list of parameters that can influence the
5310 conversion. All parameters from `orgtbl-to-generic' are
5311 supported. It is also possible to use the following ones:
5313 :ascii-art
5316 the table. You can download it here:
5317 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5319 :narrow
5321 When non-nil, narrow columns width than provided width cookie,
5323 (require 'ox-ascii)
5324 (orgtbl-to-generic
5325 table
5326 (org-combine-plists
5327 (list :backend 'ascii
5328 :ascii-charset 'utf-8
5329 :ascii-table-widen-columns (not (plist-get params :narrow))
5330 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5331 params)))
5333 ;; Put the cursor in a column containing numerical values
5334 ;; of an Org table,
5335 ;; type C-c " a
5336 ;; A new column is added with a bar plot.
5337 ;; When the table is refreshed (C-u C-c *),
5338 ;; the plot is updated to reflect the new values.
5340 (defun orgtbl-ascii-draw (value min max &optional width characters)
5341 "Draw an ascii bar in a table.
5342 VALUE is the value to plot, it determines the width of the bar to draw.
5343 MIN is the value that will be displayed as empty (zero width bar).
5344 MAX is the value that will draw a bar filling all the WIDTH.
5345 WIDTH is the span in characters from MIN to MAX.
5346 CHARACTERS is a string that will compose the bar, with shades of grey
5347 from pure white to pure black. It defaults to a 10 characters string
5348 of regular ascii characters."
5349 (let* ((width (ceiling (or width 12)))
5350 (characters (or characters " .:;c!lhVHW"))
5351 (len (1- (length characters)))
5352 (value (float (if (numberp value)
5353 value (string-to-number value))))
5354 (relative (/ (- value min) (- max min)))
5355 (steps (round (* relative width len))))
5356 (cond ((< steps 0) "too small")
5357 ((> steps (* width len)) "too large")
5358 (t (let* ((int-division (/ steps len))
5359 (remainder (- steps (* int-division len))))
5360 (concat (make-string int-division (elt characters len))
5361 (string (elt characters remainder))))))))
5363 ;;;###autoload
5364 (defun orgtbl-ascii-plot (&optional ask)
5365 "Draw an ASCII bar plot in a column.
5367 With cursor in a column containing numerical values, this function
5368 will draw a plot in a new column.
5370 ASK, if given, is a numeric prefix to override the default 12
5372 prefix,
5373 which will prompt for the width."
5374 (interactive "P")
5375 (let ((col (org-table-current-column))
5376 (min 1e999) ; 1e999 will be converted to infinity
5377 (max -1e999) ; which is the desired result
5378 (table (org-table-to-lisp))
5379 (length
5380 (cond ((consp ask)
5381 (read-number "Length of column " 12))
5382 ((numberp ask) ask)
5383 (t 12))))
5384 ;; Skip any hline a the top of table.
5385 (while (eq (car table) 'hline) (setq table (cdr table)))
5386 ;; Skip table header if any.
5387 (dolist (x (or (cdr (memq 'hline table)) table))
5388 (when (consp x)
5389 (setq x (nth (1- col) x))
5390 (when (string-match
5392 x)
5393 (setq x (string-to-number x))
5394 (when (> min x) (setq min x))
5395 (when (< max x) (setq max x)))))
5396 (org-table-insert-column)
5397 (org-table-move-column-right)
5398 (org-table-store-formulas
5399 (cons
5400 (cons
5401 (concat "$" (number-to-string (1+ col)))
5402 (format "'(%s $%s %s %s %s)"
5403 "orgtbl-ascii-draw" col min max length))
5404 (org-table-get-stored-formulas)))
5405 (org-table-recalculate t)))
5407 ;; Example of extension: unicode characters
5408 ;; Here are two examples of different styles.
5410 ;; Unicode block characters are used to give a smooth effect.
5411 ;; See http://en.wikipedia.org/wiki/Block_Elements
5412 ;; Use one of those drawing functions
5413 ;; - orgtbl-ascii-draw (the default ascii)
5414 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5415 ;; - orgtbl-uc-draw-cont (smooth unicode)
5417 ;; This is best viewed with the "DejaVu Sans Mono" font
5418 ;; (use M-x set-default-font).
5420 (defun orgtbl-uc-draw-grid (value min max &optional width)
5421 "Draw a bar in a table using block unicode characters.
5422 It is a variant of orgtbl-ascii-draw with Unicode block
5423 characters, for a smooth display. Bars appear as grids (to the
5424 extent the font allows)."
5425 ;; http://en.wikipedia.org/wiki/Block_Elements
5426 ;; best viewed with the "DejaVu Sans Mono" font.
5427 (orgtbl-ascii-draw value min max width
5430 (defun orgtbl-uc-draw-cont (value min max &optional width)
5431 "Draw a bar in a table using block unicode characters.
5432 It is a variant of orgtbl-ascii-draw with Unicode block
5433 characters, for a smooth display. Bars are solid (to the extent
5434 the font allows)."
5435 (orgtbl-ascii-draw value min max width
5438 (defun org-table-get-remote-range (name-or-id form)
5439 "Get a field value or a list of values in a range from table at ID.
5441 NAME-OR-ID may be the name of a table in the current file as set
5443 will then be used. Alternatively, it may be an ID referring to
5444 any entry, also in a different file. In this case, the first
5445 table in that entry will be referenced.
5449 The return value is either a single string for a single field, or a
5450 list of the fields in the rectangle."
5451 (save-match-data
5452 (let ((case-fold-search t) (id-loc nil)
5453 ;; Protect a bunch of variables from being overwritten by
5454 ;; the context of the remote table.
5455 org-table-column-names org-table-column-name-regexp
5456 org-table-local-parameters org-table-named-field-locations
5457 org-table-current-line-types
5458 org-table-current-begin-pos org-table-dlines
5459 org-table-current-ncol
5460 org-table-hlines org-table-last-alignment
5461 org-table-last-column-widths org-table-last-alignment
5462 org-table-last-column-widths
5463 buffer loc)
5464 (setq form (org-table-convert-refs-to-rc form))
5465 (org-with-wide-buffer
5466 (goto-char (point-min))
5467 (if (re-search-forward
5470 nil t)
5471 (setq buffer (current-buffer) loc (match-beginning 0))
5472 (setq id-loc (org-id-find name-or-id 'marker))
5473 (unless (and id-loc (markerp id-loc))
5475 (setq buffer (marker-buffer id-loc)
5476 loc (marker-position id-loc))
5477 (move-marker id-loc nil))
5478 (with-current-buffer buffer
5479 (org-with-wide-buffer
5480 (goto-char loc)
5481 (forward-char 1)
5483 (not (match-beginning 1)))
5484 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5485 (org-table-analyze)
5486 (setq form (org-table-formula-substitute-names
5487 (org-table-formula-handle-first/last-rc form)))
5488 (if (and (string-match org-table-range-regexp form)
5489 (> (length (match-string 0 form)) 1))
5490 (org-table-get-range
5491 (match-string 0 form) org-table-current-begin-pos 1)
5492 form)))))))
5494 (defun org-table-remote-reference-indirection (form)
5495 "Return formula with table remote references substituted by indirection.
5497 This indirection works only with the format @ROW$COLUMN. The
5499 distinguished from a plain table name or ID."
5500 (let ((regexp
5501 ;; Same as in `org-table-eval-formula'.
5503 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5506 (replace-regexp-in-string
5507 regexp
5508 (lambda (m)
5509 (save-match-data
5510 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5511 (org-table-get-range
5513 (concat "@0" eq)
5514 eq)))))
5515 form t t 1)))
5517 (defmacro org-define-lookup-function (mode)
5518 (let ((mode-str (symbol-name mode))
5519 (first-p (eq mode 'first))
5520 (all-p (eq mode 'all)))
5521 (let ((plural-str (if all-p "s" "")))
5522 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5523 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5524 If R-LIST is nil, return matching element%s of S-LIST.
5525 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5526 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5527 This function is generated by a call to the macro `org-define-lookup-function'."
5528 mode-str plural-str plural-str plural-str)
5529 (let ,(let ((lvars '((p (or predicate 'equal))
5530 (sl s-list)
5531 (rl (or r-list s-list))
5532 (ret nil))))
5533 (if first-p (cons '(match-p nil) lvars) lvars))
5534 (while ,(if first-p '(and (not match-p) sl) 'sl)
5535 (when (funcall p val (car sl))
5536 ,(when first-p '(setq match-p t))
5537 (let ((rval (car rl)))
5538 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5539 (setq sl (cdr sl) rl (cdr rl)))
5540 ret)))))
5542 (org-define-lookup-function first)
5543 (org-define-lookup-function last)
5544 (org-define-lookup-function all)
5546 (provide 'org-table)
5548 ;; Local variables:
5549 ;; generated-autoload-file: "org-loaddefs.el"
5550 ;; End:
5552 ;;; org-table.el ends here