| blob | 6b4e21b646808a61379ac55bbb80560d715fe2e0 |
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:
76 "Hook for functions attaching to `C-c C-c', if the table is sent.
77 This can be used to add additional functionality after the table is sent
78 to the receiver position, otherwise, if table is not sent, the functions
84 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
85 In the optimized version, the table editor takes over all simple keys that
86 normally just insert a character. In tables, the characters are inserted
87 in a way to minimize disturbing the table structure (i.e. in overwrite mode
88 for empty fields). Outside tables, the correct binding of the keys is
89 restored.
91 The default for this option is t if the optimized version is also used in
92 Org mode. See the variable `org-enable-table-editor' for details. Changing
93 this variable requires a restart of Emacs to become effective."
99 % END RECEIVE ORGTBL %n
101 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
102 | | |
105 @c END RECEIVE ORGTBL %n
106 @ignore
107 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
108 | | |
111 <!-- END RECEIVE ORGTBL %n -->
112 <!--
113 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
114 | | |
117 #+ END RECEIVE ORGTBL %n
119 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
120 | | |
122 "Templates for radio tables in different major modes.
123 Each template must define lines that will be treated as a comment and that
126 insertion of the template. The transformed table will later be inserted
127 between these lines.
129 The template should also contain a minimal table in a multiline comment.
130 If multiline comments are not possible in the buffer language,
131 you can pack it into a string that will not be used when the code
132 is compiled or executed. Above the table will you need a line with
134 convert the table into a data structure useful in the
135 language of the buffer. Check the manual for the section on
137 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
139 All occurrences of %n in a template will be replaced with the name of the
140 table, obtained by prompting the user."
147 "Settings for tables in Org mode."
152 "The default size for newly created tables, Columns x Rows."
157 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
158 "Regular expression for recognizing numbers in table columns.
159 If a table column contains mostly numbers, it will be aligned to the
160 right. If not, it will be aligned to the left.
162 The default value of this option is a regular expression which allows
163 anything which looks remotely like a number as used in scientific
164 context. For example, all of the following will be considered a
165 number:
166 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
168 Other options offered by the customize interface are more restrictive."
182 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
183 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
184 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
188 "Fraction of numbers in a column required to make the column align right.
189 In a column all non-white fields are considered. If at least
190 this fraction of fields is matched by `org-table-number-regexp',
191 alignment to the right border applies."
196 "Behavior of tables during editing in Org mode."
201 "Non-nil means automatically re-align table when pressing TAB or RETURN.
203 removal/insertion."
208 "Non-nil means automatically blank table field when starting to type into it.
209 This only happens when typing immediately after a field motion
210 command (TAB, S-TAB or RET).
211 Only relevant when `org-enable-table-editor' is equal to `optimized'."
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."
305 "Format for fields which contain the result of a formula.
307 characters. Beware that modifying the display can prevent the
308 field from being used in another formula."
314 "Non-nil means TAB and RET evaluate a formula in current table field.
315 If the current field starts with an equal sign, it is assumed to be a formula
316 which should be evaluated as described in the manual and in the documentation
317 string of the command `org-table-eval-formula'. This feature requires the
318 Emacs calc package.
319 When this variable is nil, formula calculation is only available through
325 "Non-nil means interpret constants in formulas in tables.
326 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
327 by the value given in `org-table-formula-constants', or by a value obtained
328 from the `constants.el' package."
333 "Alist with constant names and values, for use in table formulas.
334 The car of each element is a name of a constant, without the `$' before it.
335 The cdr is the value as a string. For example, if you'd like to use the
336 speed of light in a formula, you would configure
340 and then use it in an equation like `$1*$c'.
342 Constants can also be defined on a per-file basis using a line like
344 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
351 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
354 are pressed in the line."
359 "Non-nil means relative formula references may cross hlines.
360 Here are the allowed values:
362 nil Relative references may not cross hlines. They will reference the
363 field next to the hline instead. Coming from below, the reference
364 will be to the field below the hline. Coming from above, it will be
365 to the field above.
366 t Relative references may cross hlines.
367 error An attempt to cross a hline will throw an error.
369 It is probably good to never set this variable to nil, for the sake of
370 portability of tables."
378 "Non-nil means that evaluation of a field formula can add new
379 columns if an out-of-bounds field is being set."
386 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
390 "Options concerning table import and export in Org mode."
395 "Default export parameters for `org-table-export'.
396 These can be overridden for a specific table by setting the
397 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
398 radio tables for the different export transformations and
399 available parameters."
404 "Max lines that `org-table-convert-region' will attempt to process.
406 The function can be slow on larger regions; this safety feature
407 prevents it from hanging emacs."
430 "Alist with column names, derived from the `!' line.
434 "Regular expression matching the current column names.
438 "Alist with parameter names, derived from the `$' line.
442 "Alist with locations of named fields.
443 Associations follow the pattern (NAME LINE COLUMN) where
444 NAME is the name of the field as a string,
445 LINE is the number of lines from the beginning of the table,
446 COLUMN is the column of the field, as an integer.
450 "Table row types in current table.
454 "Current table begin position, as a marker.
458 "Number of columns in current table.
462 "Vector of data line line numbers in the current table.
463 Line numbers are counted from the beginning of the table. This
467 "Vector of hline line numbers in the current table.
468 Line numbers are counted from the beginning of the table. This
472 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
473 ;; 1 2 3 4 5
488 "Save current field; execute BODY; restore field.
489 Field is restored even in case of abnormal exit."
500 ;;;###autoload
502 "Use the table.el package to insert a new table.
503 If there is already a table at point, convert between Org tables
504 and table.el tables."
517 ;;;###autoload
519 "Convert region to table, or create an empty table.
520 If there is an active region, convert it to a table, using the function
521 `org-table-convert-region'. See the documentation of that function
522 to learn how the prefix argument is interpreted to determine the field
523 separator.
524 If there is no such region, create an empty table with `org-table-create'."
530 ;;;###autoload
532 "Query for a size and insert a table skeleton.
552 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
556 ;; Insert a hline after the first row.
563 ;;;###autoload
565 "Convert region to a table.
567 The region goes from BEG0 to END0, but these borders will be moved
568 slightly, to make sure a beginning of line in the first line is included.
570 SEPARATOR specifies the field separator in the lines. It can have the
571 following values:
573 (4) Use the comma as a field separator
574 (16) Use a TAB as field separator
575 (64) Prompt for a regular expression as field separator
576 integer When a number, use that many spaces, or a TAB, as field separator
577 regexp When a regular expression, use it to match the separator
578 nil When nil, the command tries to be smart and figure out the
579 separator in the following way:
580 - when each line contains a TAB, assume TAB-separated material
581 - when each line contains a comma, assume CSV material
582 - else, assume one or more SPACE characters as separator."
586 re)
588 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
589 org-table-convert-region-max-lines)
598 ;; Get the right field separator
609 ;; parse the csv stuff
634 ;;;###autoload
636 "Import FILE as a table.
637 The file is assumed to be tab-separated. Such files can be produced by most
638 spreadsheet and database applications. If no tabs (at least one per line)
639 are found, lines will be split on whitespace into fields."
648 ;;;###autoload
650 "Export table to a file, with configurable format.
651 Such a file can be imported into usual spreadsheet programs.
653 FILE can be the output file name. If not given, it will be taken
654 from a TABLE_EXPORT_FILE property in the current entry or higher
655 up in the hierarchy, or the user will be prompted for a file
656 name. FORMAT can be an export format, of the same kind as it
657 used when `orgtbl-mode' sends a table in a different format.
659 The command suggests a format depending on TABLE_EXPORT_FORMAT,
660 whether it is set locally or up in the hierarchy, then on the
661 extension of the given file name, and finally on the variable
662 `org-table-export-default-format'."
695 formats)))
696 org-table-export-default-format)
722 "Marker at the beginning of the table last aligned.
725 "Marker at the end of the table last aligned.
728 "List of flags for flushright alignment, from the last re-alignment.
731 "List of max width of fields in each column.
734 "Non-nil means debug table formulas.
744 ;;;###autoload
746 "Align the table at point by aligning all vertical bars."
751 ;; Make sure invisible characters in the table are at the right
752 ;; place since column widths take them into account.
758 ;; Table's rows. Separators are replaced by nil. Trailing
759 ;; spaces are also removed.
765 l)))
767 ;; Get the data fields by splitting the lines.
770 ;; Compute number of fields in the longest line. If the
771 ;; table contains no field, create a default table.
776 ;; A list of empty strings to fill any short rows on output.
778 lengths typenums)
779 ;; Check for special formatting.
782 fmax falign)
783 ;; Look for an explicit width or alignment.
796 ;; Find fields that are wider than FMAX, and shorten them.
801 'help-echo
809 fmax)))
823 f2
825 x))))))
826 ;; Get the maximum width for each column
828 lengths)
829 ;; Get the fraction of numbers among non-empty cells to
830 ;; decide about alignment of the column.
839 1
845 ;; Store alignment of this table, for later editing of single
846 ;; fields.
849 ;; With invisible characters, `format' does not get the field
850 ;; width right So we need to make these fields wide by hand.
851 ;; Invisible characters may be introduced by fontified links,
852 ;; emphasis, macros or sub/superscripts.
870 ;; Compute the formats needed for output of the table.
879 ;; Replace modified lines only. Check not only contents, but
880 ;; also columns' width.
884 hfmt))
906 ;;;###autoload
908 "Find the beginning of the table and return its position.
909 With a non-nil optional argument TABLE-TYPE, return the beginning
910 of a table.el-type table. This function assumes point is on
911 a table."
919 ;;;###autoload
921 "Find the end of the table and return its position.
922 With a non-nil optional argument TABLE-TYPE, return the end of
923 a table.el-type table. This function assumes point is on
924 a table."
932 ;; When the line right after the table is the last line in
933 ;; the buffer with trailing spaces but no final newline
934 ;; character, be sure to catch the correct ending at its
935 ;; beginning. In any other case, ending is expected to be
936 ;; at point max.
941 ;;;###autoload
943 "Justify the current field, text to left, number to right.
944 Optional argument NEW may specify text to replace the current field content."
953 ;; This is not the same table, force a full re-align.
956 ;; Realign the current field, based on previous full realign.
969 len
984 ;;;###autoload
986 "Go to the next field in the current table, creating new lines as needed.
987 Before doing so, re-align the table if necessary."
992 org-table-may-need-update)
1003 org-table-tab-jumps-over-hlines
1014 ;;;###autoload
1016 "Go to the previous field in the table.
1017 Before doing so, re-align the table if necessary."
1022 org-table-may-need-update)
1037 "Move to the beginning of the current table field.
1038 If already at or before the beginning, move to the beginning of the
1039 previous field.
1040 With numeric argument N, move N-1 fields backward first."
1053 "Move to the end of the current table field.
1054 If already at or after the end, move to the end of the next table field.
1055 With numeric argument N, move N-1 fields forward first."
1068 ;;;###autoload
1070 "Go to the next row (same column) in the current table.
1071 Before doing so, re-align the table if necessary."
1079 org-table-may-need-update)
1092 ;;;###autoload
1094 "Copy the value of the current field one row below.
1096 If the field at the cursor is empty, copy the content of the
1097 nearest non-empty field above. With argument N, use the Nth
1098 non-empty field.
1100 If the current field is not empty, it is copied down to the next
1101 row, and the cursor is moved with it. Therefore, repeating this
1102 command causes the column to be filled row-by-row.
1104 If the variable `org-table-copy-increment' is non-nil and the
1105 field is an integer or a timestamp, it will be incremented while
1106 copying. By default, increment by the difference between the
1107 value in the current field and the one in the field above. To
1108 increment using a fixed integer, set `org-table-copy-increment'
1109 to a number. In the case of a timestamp, increment by days."
1121 txt txt-up inc)
1129 beg t))
1139 beg t))
1146 ;; Above field was not empty, go down to the next row
1179 "Is point inside a table data field?
1180 I.e. not on a hline or before the first or after the last column?
1181 This actually throws an error, so it aborts the current command."
1193 "Get the field in table line LINE, column COLUMN.
1194 If LINE is larger than the number of data lines in the table, the function
1195 returns nil. However, if COLUMN is too large, we will simply return an
1196 empty string.
1197 If LINE is nil, use the current line.
1198 If COLUMN is nil, use the current column."
1205 "Put VALUE into line LINE, column COLUMN.
1206 When ALIGN is set, also realign the table."
1215 "Return the index of the current data line."
1222 cnt))
1225 "Go to the Nth data line in the current table.
1226 Return t when the line exists, nil if it does not exist."
1233 ;;;###autoload
1235 "Blank the current table field or active region."
1252 "Return the value of the field in column N of current row.
1253 N defaults to current column. If REPLACE is a string, replace
1254 field with this value. The return value is always the old
1255 value."
1259 ;; Before first column or after last one.
1260 ""
1267 val)))
1269 ;;;###autoload
1271 "Show info about the current field, and highlight any reference at point."
1281 col)
1282 org-table-named-field-locations)))
1292 ;; Prioritize field formulas over column formulas.
1301 dline col
1303 dline col ref1
1305 ;; FIXME: formula info not correct if special table line
1312 ""
1318 "Find out which column we are in."
1327 column)))
1329 ;;;###autoload
1331 "Find out what table data line we are in.
1332 Only data lines count for this."
1345 c)))
1347 ;;;###autoload
1349 "Move the cursor to the Nth column in the current table line.
1350 With optional argument ON-DELIM, stop with point before the left delimiter
1351 of the field.
1352 If there are less than N fields, just go to after the last delimiter.
1353 However, when FORCE is non-nil, create new columns if necessary."
1363 t)))))
1370 ;;;###autoload
1372 "Insert a new column into the table."
1394 "Find a data line in the current table, which is needed for column commands."
1397 t
1408 t
1413 "Turn a buffer line number into a data line number.
1415 If there is no data line in this line, return nil.
1417 If there is no matching dline (most likely the reference was
1418 a hline), the first dline below it is used. When ABOVE is
1419 non-nil, the one above is used."
1424 nil)
1435 ;;;###autoload
1437 "Delete a column from the table."
1449 nil
1464 ;;;###autoload
1466 "Move column to the right."
1469 ;;;###autoload
1471 "Move column to the left."
1475 ;;;###autoload
1477 "Move the current column to the right. With arg LEFT, move to the left."
1513 ;;;###autoload
1515 "Move table row down."
1518 ;;;###autoload
1520 "Move table row up."
1524 ;;;###autoload
1526 "Move the current table line down. With arg UP, move it up."
1535 hline2p)
1561 ;;;###autoload
1563 "Insert a new row above the current line into the table.
1564 With prefix ARG, insert below the current line."
1569 ;; Fix the first field if necessary
1573 ;; Buffer may not end of a newline character, so ensure
1574 ;; (beginning-of-line 2) moves point to a new line.
1585 ;;;###autoload
1587 "Insert a horizontal-line below the current line into the table.
1588 With prefix ABOVE, insert above the current line."
1609 ;;;###autoload
1611 "Insert a hline and move to the row below that line."
1625 In particular, this does handle wide and invisible characters."
1627 ;; It's a hline, just map the characters
1633 t t s)))
1634 s))
1636 ;;;###autoload
1638 "Delete the current row or horizontal line from the table."
1652 ;;;###autoload
1655 "Sort table lines according to the column at point.
1657 The position of point indicates the column to be used for
1658 sorting, and the range of lines is the range between the nearest
1659 horizontal separator lines, or the entire table of no such lines
1660 exist. If point is before the first column, you will be prompted
1661 for the sorting column. If there is an active region, the mark
1662 specifies the first line and the sorting column, while point
1663 should be in the last line to be included into the sorting.
1665 The command then prompts for the sorting type which can be
1666 alphabetically, numerically, or by time (as given in a time stamp
1667 in the field, or as a HH:MM value). Sorting in reverse order is
1668 also possible.
1670 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1672 If SORTING-TYPE is specified when this function is called from a Lisp
1673 program, no prompting will take place. SORTING-TYPE must be a character,
1674 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1675 sorting should be done in reverse order.
1677 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1678 a function to be called to extract the key. It must return a value
1679 that is compatible with COMPARE-FUNC, the function used to compare
1680 entries.
1682 A non-nil value for INTERACTIVE? is used to signal that this
1683 function is being called interactively."
1686 ;; Point must be either within a field or before a data line.
1691 ;; Set appropriate case sensitivity and column used for sorting.
1702 ;; Narrow buffer to appropriate sorting area.
1715 start))
1718 end))))
1719 ;; Determine arguments for `sort-subr'. Also record original
1720 ;; position. `org-table-save-field' cannot help here since
1721 ;; sorting is too much destructive.
1727 ;; Function to be called on the contents of the field
1728 ;; used for sorting in the current row.
1764 #'end-of-line
1768 nil
1769 predicate)
1770 ;; Move back to initial field.
1774 ;;;###autoload
1776 "Copy region in table to the clipboard and blank all relevant fields.
1777 If there is no active region, use just the field at point."
1783 ;;;###autoload
1785 "Copy rectangular region in table to clipboard.
1786 A special clipboard is used which can only be accessed
1787 with `org-table-paste-rectangle'."
1791 current-prefix-arg))
1796 region)
1808 ;; Collect every cell between COLUMN-START and COLUMN-END.
1818 ;;;###autoload
1820 "Paste a rectangular region into a table.
1821 The upper right corner ends up in the current field. All involved fields
1822 will be overwritten. If the rectangle does not fit into the present table,
1823 the table is enlarged as needed. The process ignores horizontal separator
1824 lines."
1835 ;; If we left the table, create a new row.
1847 ;;;###autoload
1849 "Convert from `org-mode' table to table.el and back.
1850 Obviously, this only works within limits. When an Org table is converted
1851 to table.el, all horizontal separator lines get lost, because table.el uses
1852 these as cell boundaries and has no notion of horizontal lines. A table.el
1853 table can be converted to an Org table only if it does not do row or column
1854 spanning. Multiline cells will become multiple cells. Beware, Org mode
1855 does not test if the table can be successfully converted - it blindly
1856 applies a recipe that works for simple tables."
1860 ;; convert to Org table
1869 ;; convert to table.el table
1872 ;; first, get rid of all horizontal lines
1876 ;; insert a hline before first
1880 ;; insert a hline after each line
1885 ;; replace "+" at beginning and ending of hlines
1894 "Transpose Org table at point and eliminate hlines.
1895 So a table like
1897 | 1 | 2 | 4 | 5 |
1898 |---+---+---+---|
1899 | a | b | c | d |
1900 | e | f | g | h |
1902 will be transposed as
1904 | 1 | a | e |
1905 | 2 | b | f |
1906 | 4 | c | g |
1907 | 5 | d | h |
1909 Note that horizontal lines disappear."
1921 table)))
1935 ;;;###autoload
1937 "Wrap several fields in a column like a paragraph.
1938 This is useful if you'd like to spread the contents of a field over several
1939 lines, in order to keep the table compact.
1941 If there is an active region, and both point and mark are in the same column,
1942 the text in the column is wrapped to minimum width for the given number of
1943 lines. Generally, this makes the table more compact. A prefix ARG may be
1944 used to change the number of desired lines. For example, \
1946 formats the selected text to two lines. If the region was longer than two
1947 lines, the remaining lines remain empty. A negative prefix argument reduces
1948 the current number of lines by that amount. The wrapped text is pasted back
1949 into the table. If you formatted it to more lines than it was before, fields
1950 further down in the table get overwritten - so you might need to make space in
1951 the table first.
1953 If there is no region, the current field is split at the cursor position and
1954 the text fragment to the right of the cursor is prepended to the field one
1955 line down.
1957 If there is no region, but you specify a prefix ARG, the current field gets
1958 blank, and the content is appended to the field above."
1962 ;; There is a region: fill as a paragraph.
1973 nil
1974 nlines))))
1977 ;; No region, split the current field at point.
2002 ;;;###autoload
2004 "Edit table field in a different window.
2005 This is mainly useful for fields that contain hidden parts. When called
2007 visible so that it can be
2008 edited in place."
2017 display t intangible t))
2030 p)
2046 intangible t))
2054 "Finish editing a table data field.
2055 Remove all newline characters, insert the result into the table, realign
2056 the table and kill the editing buffer."
2060 text)
2077 "Minor mode to make the table field editor window follow the cursor.
2078 When this mode is active, the field editor window will always show the
2079 current field. The mode exits automatically when the cursor leaves the
2080 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2081 nil " TblFollow" nil
2097 ;; We have left the table, exit the follow mode
2107 ;;;###autoload
2109 "Sum numbers in region of current table column.
2110 The result will be displayed in the echo area, and will be available
2113 If there is an active region, it is interpreted as a rectangle and all
2114 numbers in that rectangle will be summed. If there is no active
2115 region and point is located in a table column, sum all numbers in that
2116 column.
2118 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2119 numbers are assumed to be times as well (in decimal hours) and the
2120 numbers are added as such.
2122 If NLAST is a number, only the NLAST fields will actually be summed."
2149 items1)))
2156 s diff)
2163 sres))))
2186 "Return the formula active for the current field.
2188 Assumes that table is already analyzed. If KEY is given, return
2189 the key to this formula. Otherwise return the formula preceded
2198 org-table-named-field-locations)))
2212 "Read a formula from the minibuffer, offer stored formula as default.
2213 When NAMED is non-nil, look for a named equation."
2218 org-table-named-field-locations)))
2231 stored)
2233 equation)
2239 scol))
2241 'org-table-formula-history
2242 )))))
2243 mustsave)
2245 ;; remove formula
2252 ;; We set the column equation, delete the named one.
2254 mustsave t))
2260 eq))
2263 "Store the list of formulas below the current table.
2264 If optional argument LOCATION is a buffer position, insert it at
2265 LOCATION instead."
2273 ;; Don't overwrite TBLFM, we might use text properties to
2274 ;; store stuff.
2288 ;; Fake a high number to make sure this is sorted at the end.
2295 a)
2305 "Compare two formulas for sorting."
2310 ;;;###autoload
2312 "Return an alist with the stored formulas directly after current table.
2313 By default, only return active formulas, i.e., formulas located
2314 on the first line after the table. However, if optional argument
2315 LOCATION is a buffer position, consider the formulas there."
2324 eq-alist seen)
2328 string)
2333 ;; Is it a column reference?
2335 ;; Since named columns are not possible in
2336 ;; LHS, assume this is a named field.
2344 "Double definition `%s=' in TBLFM line, please fix by hand"
2345 lhs)
2350 "Double definition `%s=' in TBLFM line, please fix by hand"
2351 lhs)))))))))))
2354 "Modify the equations after the table structure has been edited.
2356 For all numbers larger than LIMIT, shift them by DELTA."
2368 s n a)
2374 "Change makes TBLFM term %s invalid, use undo to recover"
2389 ;;;###autoload
2392 If yes, store the formula and apply it."
2393 ;; We already know we are in a table. Get field will only return a formula
2394 ;; when appropriate. It might return a separator line, but no problem.
2397 named eq)
2405 "List of commands triggering the recalculation of a line.
2417 ;;;###autoload
2419 "Rotate the recalculation mark in the first column.
2420 If in any row, the first field is not consistent with a mark,
2421 insert a new column for the markers.
2422 When there is an active region, change all the lines in the region,
2423 after prompting for the marking character.
2424 After each change, a message will be displayed indicating the meaning
2425 of the new mark."
2441 newchar))
2449 newchar))
2467 ;; Rotate mark in first row.
2469 ;; Rotate marks in additional rows if a region is active.
2477 ;; Only align if rotation actually changed lines' length.
2487 ;;;###autoload
2489 "Analyze table at point and store results.
2491 This function sets up the following dynamically scoped variables:
2493 `org-table-column-name-regexp',
2494 `org-table-column-names',
2495 `org-table-current-begin-pos',
2496 `org-table-current-line-types',
2497 `org-table-current-ncol',
2498 `org-table-dlines',
2499 `org-table-hlines',
2500 `org-table-local-parameters',
2501 `org-table-named-field-locations'."
2506 ;; Extract column names.
2519 ;; Extract local parameters.
2527 org-table-local-parameters)))))
2528 ;; Update named fields locations. We minimize `count-lines'
2529 ;; processing by storing last known number of lines in LAST.
2551 field))
2554 org-table-named-field-locations))))))))))
2555 ;; Re-use existing markers when possible.
2559 ;; Analyze the line types.
2570 ;; Get the number of columns from the first data line in table.
2578 al al2)
2592 "Move point to a specific field in the current table.
2594 REF is either the name of a field its absolute reference, as
2595 a string. No column is created unless CREATE-COLUMN-P is
2596 non-nil. If it is a function, it is called with the column
2597 number as its argument as is used as a predicate to know if the
2598 column can be created.
2600 This function assumes the table is already analyzed (i.e., using
2601 `org-table-analyze')."
2616 create-column-p)))
2622 ;;;###autoload
2624 "Recompute the current line if marked for it, and if we haven't just done it."
2644 org-tbl-calc-modes)
2646 ;;;###autoload
2648 suppress-align suppress-const
2649 suppress-store suppress-analysis)
2650 "Replace the table field value at the cursor by the result of a calculation.
2652 In a table, this command replaces the value in the current field with the
2654 formula, by storing it in a special line below the table. When called
2656 field formula.
2659 insert the active equation for the field
2660 back into the current field, so that it can be edited there. This is \
2661 useful
2663 check the referenced fields.
2665 When called, the command first prompts for a formula, which is read in
2666 the minibuffer. Previously entered formulas are available through the
2667 history list, and the last used formula is offered as a default.
2668 These stored formulas are adapted correctly when moving, inserting, or
2669 deleting columns with the corresponding commands.
2671 The formula can be any algebraic expression understood by the Calc package.
2672 For details, see the Org mode manual.
2674 This function can also be called from Lisp programs and offers
2675 additional arguments: EQUATION can be the formula to apply. If this
2676 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2677 used to speed-up recursive calls by by-passing unnecessary aligns.
2678 SUPPRESS-CONST suppresses the interpretation of constants in the
2679 formula, assuming that this has been done already outside the function.
2680 SUPPRESS-STORE means the formula should not be stored, either because
2681 it is already stored, or because it is a modified equation that should
2682 not overwrite the stored one. SUPPRESS-ANALYSIS prevents any call to
2683 `org-table-analyze'."
2698 equation
2704 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2705 duration duration-output-format)
2706 ;; Parse the format string. Since we have a lot of modes, this is
2707 ;; a lot of work. However, I think calc still uses most of the time.
2720 'calc-float-format
2723 n))))
2727 duration-output-format nil
2731 duration-output-format org-table-duration-custom-format
2732 numbers t
2758 ;; replace fields with duration values if relevant
2762 fields)))
2768 x))
2769 fields)))
2775 ;; Insert row and column number of formula result field
2786 t t form)))
2788 ;; Check for old vertical references
2790 ;; Insert remote references
2803 rmtrng))
2804 keep-empty numbers lispp))
2805 t t form)))
2806 ;; Insert complex ranges
2816 ;; possibly handle durations
2821 formrg)
2822 keep-empty numbers lispp)))
2827 ;; Insert simple ranges, i.e. included in the current row.
2830 form)
2841 keep-empty numbers lispp))
2842 t t form)))
2844 ;; Insert the references to fields in same row
2851 x keep-empty numbers lispp)))
2868 ;; Use <...> time-stamps so that Calc can handle them.
2871 ;; Internationalize local time-stamps by setting locale to
2872 ;; "C".
2875 org-ts-regexp
2883 form t t))
2886 form
2893 duration-output-format)
2894 ev)))
2899 Orig: %s
2900 $xyz-> %s
2901 @r$c-> %s
2933 prop value)))
2936 "Get a calc vector from a column, according to descriptor DESC.
2938 Optional arguments TBEG and COL can give the beginning of the table and
2939 the current column, to avoid unnecessary parsing.
2941 HIGHLIGHT means just highlight the range.
2943 When CORNERS-ONLY is set, only return the corners of the range as
2944 a list (line1 column1 line2 column2) where line1 and line2 are
2945 line numbers relative to beginning of table, or TBEG, and column1
2946 and column2 are table column numbers."
2949 desc))
2960 thisline)))
2965 thisline)))
2977 ;; Just one field.
2984 ;; A range, return a vector. First sort the numbers to get
2985 ;; a regular rectangle.
2991 ;; Copy the range values into a list.
3006 ;; Return string representation of calc vector.
3012 "Return relative line number corresponding to descriptor DESC.
3013 The cursor is currently in relative line number CLINE."
3018 ;; 1 2 3 4 5 6
3019 desc))
3041 cline)))
3044 "Return relative line of Nth row with type TYPE.
3045 Search starts from relative line I. When BACKWARDS in non-nil,
3046 look before I. When RELATIVE is non-nil, the reference is
3047 relative. DESC is the original descriptor that started the
3048 search, as a string."
3056 ;; We are going to cross a hline. Check if this is
3057 ;; an authorized move.
3068 ;; The last hline doesn't exist. Instead, point to last row
3069 ;; in table.
3078 "Convert list ELEMENTS to something appropriate to insert into formula.
3079 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3080 NUMBERS indicates that everything should be converted to numbers.
3081 LISPP non-nil means to return something appropriate for a Lisp
3082 list, `literal' is for the format specifier L."
3083 ;; Calc nan (not a number) is used for the conversion of the empty
3084 ;; field to a reference for several reasons: (i) It is accepted in a
3085 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3086 ;; (ii) In a single field (not in range) it can be distinguished
3087 ;; from "(nan)" which is the reference made from a single field
3088 ;; containing "nan".
3090 ;; field reference
3093 elements
3095 ""
3104 ;; range reference
3109 elements))))
3115 x
3123 x)
3125 elements
3129 "If there has been more than one second since T1, display message.
3130 ARGS are passed as arguments to the `message' function. Returns
3131 current time if a message is printed, otherwise returns T1. If
3132 T1 is nil, always messages."
3136 curtime)
3137 t1)))
3139 ;;;###autoload
3141 "Recalculate the current table line by applying all stored formulas.
3143 With prefix arg ALL, do this for all lines in the table.
3146 if ALL is the symbol `iterate',
3147 recompute the table until it no longer changes.
3149 If NOALIGN is not nil, do not re-align the table after the computations
3150 are done. This is typically used internally to save time, if it is
3151 known that the table will be realigned a little later anyway."
3166 beg end eqlcol eqlfield)
3167 ;; Insert constants in all formulas.
3170 ;; Expand equations, then split the equation list between
3171 ;; column formulas and field formulas.
3183 old-lhs)))
3186 existing formula for column %s"
3187 old-lhs
3188 new))
3189 new))
3195 ;; Expand ranges in lhs of formulas
3197 ;; Get the correct line range to process.
3204 ;; This is a table with marked lines, compute selected
3205 ;; lines.
3207 ;; Move forward to the first non-header line.
3212 ;; Just leave BEG at the start of the table.
3217 ;; Mark named fields untouchable. Also check if several
3218 ;; field/range formulas try to set the same field.
3222 seen-fields)
3233 ;; Turn field coordinates associated to NAME
3234 ;; into an absolute reference.
3238 name)))
3241 reference))
3246 ;; Evaluate the column formulas, but skip fields covered by
3247 ;; field formulas.
3251 ;; Unprotected line, recalculate.
3256 log-last-time
3269 ;; Evaluate the field formulas.
3278 reference
3279 ;; Possibly create a new column, as long as
3280 ;; `org-table-formula-create-columns' allows it.
3292 t))
3297 ;; Clean up markers and internal text property.
3308 ;;;###autoload
3310 "Recalculate the table until it does not change anymore.
3311 The maximum number of iterations is 10, but you can choose a different value
3312 with the prefix ARG."
3317 thistbl)
3331 ;;;###autoload
3333 "Recalculate all tables in the current buffer."
3338 ;; Reason for separate `org-table-align': When repeating
3339 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3340 ;; the way.
3343 t)))
3345 ;;;###autoload
3347 "Iterate all tables in the buffer, to converge inter-table dependencies."
3352 c1)
3368 "Apply the #+TBLFM in the line at point to the table."
3375 ;; Insert a temporary formula at right after the table
3380 ;; Recalculate the table.
3385 ;; Delete the formula inserted temporarily.
3391 "Find the beginning of the TBLFM lines and return its position.
3392 Return nil when the beginning of TBLFM line was not found."
3399 "Expand list of formulas.
3400 If some of the RHS in the formulas are ranges or a row reference,
3401 expand them to individual field equations for each field. This
3402 function assumes the table is already analyzed (i.e., using
3403 `org-table-analyze')."
3410 ;; This just refers to one fixed field.
3413 ;; This just refers to one fixed named field.
3416 ;; Column formulas are treated specially and are not
3417 ;; expanded.
3422 rhs)
3423 res)))
3435 rhs)
3436 res))))))))))
3439 "Replace @<, @>, $<, $> with first/last row/column of the table.
3440 So @< and $< will always be replaced with @1 and $1, respectively.
3441 The advantage of these special markers are that structure editing of
3442 the table will not change them, while @1 and $1 will be modified
3443 when a line/row is swapped out of that privileged position. So for
3444 formulas that use a range of rows or columns, it may often be better
3446 borders of the table using the @< @> $< $> makers."
3449 s start)
3454 org-table-current-ncol)
3458 len
3465 s)
3468 "Replace $const with values in string F."
3473 org-table-column-name-regexp
3476 org-table-column-names))))
3477 f t t)))
3478 ;; Parameters and constants.
3482 new start))
3485 ;; When a duration is expected, convert value on the fly.
3491 v)))))
3498 "Find the value for a parameter or constant in a formula.
3499 Parameters get priority."
3530 map))
3537 "--"
3540 "--"
3541 "Shift Reference at Point"
3546 "-"
3547 "Change Test Row for Column Formulas"
3550 "--"
3555 org-table-overlay-coordinates)]
3556 "--"
3564 ;;;###autoload
3566 "Edit the formulas of the current table in a separate buffer."
3572 ;; Move point within the table before analyzing it.
3588 ;; Keep global-font-lock-mode from turning on font-lock-mode
3633 "Convert a formula from internal to user representation."
3636 s))
3639 "Convert a formula from user to internal representation."
3642 s))
3645 "Convert spreadsheet references from A7 to @7$28.
3646 Works for single references, but also for entire formulas and even the
3647 full TBLFM line."
3649 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3652 ;; format match, just advance
3657 ;; 3.e5 or something like this.
3660 ;; (member (match-string 1 s)
3661 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3662 )
3663 ;; function name, just advance
3673 t t s)))))
3674 s))
3677 "Convert spreadsheet references from to @7$28 to AB7.
3678 Works for single references, but also for entire formulas and even the
3679 full TBLFM line."
3686 t t s)))
3691 t nil s)))
3692 s)
3695 "Convert a base 26 number represented by letters into an integer.
3696 For example: AB -> 28."
3702 n))
3705 "Convert an integer into a base 26 number represented by letters.
3706 For example: 28 -> AB."
3711 s))
3714 "Convert a time string into numerical duration in seconds.
3715 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3716 If S is a string representing a number, keep this number."
3718 s
3741 "Convert a number of seconds to a time string.
3742 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3743 minutes or seconds."
3758 "Convert all references in this buffer, using FUNCTION."
3769 "Convert all references in the buffer from B3 to @3$2 and back."
3779 "Shift the reference at point one row/hline up."
3783 "Shift the reference at point one row/hline down."
3787 "Shift the reference at point one field to the left."
3791 "Shift the reference at point one field to the right."
3802 ;; A B3-like reference
3808 ;; An internal reference
3814 "Re-match the group N, and replace it with the shifted reference."
3819 t t)))
3822 "Shift a reference part REF.
3823 If DECR is set, decrease the references row/column, else increase.
3824 If HLINE is set, this may be a hline reference, it certainly is not
3825 a translation reference."
3854 "Toggle the display of coordinates in the referenced table."
3863 "Parse the buffer for formula definitions and install them.
3864 With prefix ARG, apply the new formulas to the table."
3873 eql)
3876 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3877 nil t)
3898 "Abort editing formulas, without installing the changes."
3909 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3950 "Show the location/value of the $ expression at point.
3951 When LOCAL is non-nil, show references for the table at point."
3961 var name e what match dest)
3965 "$1.."
4017 dest)
4043 ;; Column number.
4069 org-table-fedit-scroll-down))))
4081 "Make sure the cursor is in a dataline in a table."
4090 p1 p2)))
4095 "Move cursor one line up in the window showing the table."
4100 "Move cursor one line down in the window showing the table."
4105 "Move the cursor in the window showing the table.
4106 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4131 "Add a new overlay."
4137 "Highlight rectangular region in a table.
4138 When buffer positions BEG and END are provided, use them to
4139 delimit the region to highlight. Otherwise, refer to point. Use
4140 FACE, when non-nil, for the highlight."
4172 "Remove the rectangle overlays."
4182 "Add overlays to the table at point, to show row/column coordinates."
4210 ;;;###autoload
4212 "Toggle the display of Row/Column numbers in tables."
4223 ;;;###autoload
4225 "Toggle the formula debugger in tables."
4231 ;;; The orgtbl minor mode
4233 ;; Define a minor mode which can be used in other modes in order to
4234 ;; integrate the Org table editor.
4236 ;; This is really a hack, because the Org table editor uses several
4237 ;; keys which normally belong to the major mode, for example the TAB
4238 ;; and RET keys. Here is how it works: The minor mode defines all the
4239 ;; keys necessary to operate the table editor, but wraps the commands
4240 ;; into a function which tests if the cursor is currently inside
4241 ;; a table. If that is the case, the table editor command is
4242 ;; executed. However, when any of those keys is used outside a table,
4243 ;; the function uses `key-binding' to look up if the key has an
4244 ;; associated command in another currently active keymap (minor modes,
4245 ;; major mode, global), and executes that command. There might be
4246 ;; problems if any of the keys used by the table editor is otherwise
4247 ;; used as a prefix key.
4249 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4250 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4251 ;; addresses this by checking explicitly for both bindings.
4253 ;; The optimized version (see variable `orgtbl-optimized') takes over
4254 ;; all keys which are bound to `self-insert-command' in the *global map*.
4255 ;; Some modes bind other commands to simple characters, for example
4256 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4257 ;; active, this binding is ignored inside tables and replaced with a
4258 ;; modified self-insert.
4276 ;; Install it as a minor mode.
4280 ;;;###autoload
4282 "The `org-mode' table editor as a minor mode for use in other modes."
4287 ;; Exit without error, in case some hook functions calls this
4288 ;; by accident in org-mode.
4292 ;; Make sure we are first in minor-mode-map-alist
4294 ;; FIXME: maybe it should use emulation-mode-map-alists?
4301 auto-fill-inhibit-regexp)
4305 auto-fill-inhibit-regexp)
4306 orgtbl-line-start-regexp))
4324 "Remove all properties related to narrow-column invisibility."
4337 "Create a function for binding in the table minor mode.
4338 FUN is the command to call inside a table. N is used to create a unique
4339 command name. KEYS are keys that should be checked in for a command
4340 to execute outside of tables."
4346 "Outside of tables, run the binding of `"
4358 keys)
4362 "Error when there is no default binding for a table key."
4367 "Setup orgtbl keymaps."
4398 elt key fun cmd)
4406 ;; Special treatment needed for TAB, RET and DEL
4419 (orgtbl-make-binding 'org-delete-backward-char 109
4425 [(tab)] "\C-i"))
4427 (org-defkey orgtbl-mode-map [backtab]
4429 [backtab] [S-iso-lefttab] [(shift tab)]
4430 [(tab)] "\C-i"))
4432 (org-defkey orgtbl-mode-map "\M-\C-m"
4433 (orgtbl-make-binding 'org-table-wrap-region 105
4434 "\M-\C-m" [(meta return)]))
4435 (org-defkey orgtbl-mode-map [(meta return)]
4436 (orgtbl-make-binding 'org-table-wrap-region 106
4437 [(meta return)] "\M-\C-m"))
4439 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4440 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4442 (when orgtbl-optimized
4443 ;; If the user wants maximum table support, we need to hijack
4444 ;; some standard editing functions
4445 (org-remap orgtbl-mode-map
4446 'self-insert-command 'orgtbl-self-insert-command
4447 'delete-char 'org-delete-char
4448 'delete-backward-char 'org-delete-backward-char)
4449 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4450 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4451 '("OrgTbl"
4452 ["Create or convert" org-table-create-or-convert-from-region
4453 :active (not (org-at-table-p)) :keys "C-c |" ]
4454 "--"
4455 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4456 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4457 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4458 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4459 "--"
4460 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4461 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4462 ["Copy Field from Above"
4463 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4464 "--"
4465 ("Column"
4466 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4467 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4468 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4469 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4470 ("Row"
4471 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4472 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4473 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4474 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4475 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4476 "--"
4477 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4478 ("Rectangle"
4479 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4480 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4481 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4482 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4483 "--"
4484 ("Radio tables"
4485 ["Insert table template" orgtbl-insert-radio-table
4486 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4487 ["Comment/uncomment table" orgtbl-toggle-comment t])
4488 "--"
4489 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4490 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4491 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4492 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4493 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4494 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4495 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4496 ["Sum Column/Rectangle" org-table-sum
4497 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4498 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4499 ["Debug Formulas"
4500 org-table-toggle-formula-debugger :active (org-at-table-p)
4501 :keys "C-c {"
4502 :style toggle :selected org-table-formula-debug]
4503 ["Show Col/Row Numbers"
4504 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4505 :keys "C-c }"
4506 :style toggle :selected org-table-overlay-coordinates]
4507 "--"
4508 ("Plot"
4511 t))
4513 (defun orgtbl-ctrl-c-ctrl-c (arg)
4514 "If the cursor is inside a table, realign the table.
4515 If it is a table to be sent away to a receiver, do it.
4516 With prefix arg, also recompute table."
4517 (interactive "P")
4518 (let ((case-fold-search t) (pos (point)) action)
4519 (save-excursion
4520 (beginning-of-line 1)
4521 (setq action (cond
4525 (cond
4526 ((integerp action)
4527 (goto-char action)
4528 (org-table-maybe-eval-formula)
4529 (if arg
4530 (call-interactively 'org-table-recalculate)
4531 (org-table-maybe-recalculate-line))
4532 (call-interactively 'org-table-align)
4533 (when (orgtbl-send-table 'maybe)
4534 (run-hooks 'orgtbl-after-send-table-hook)))
4535 ((eq action 'recalc)
4536 (save-excursion
4537 (beginning-of-line 1)
4539 (if (org-at-table-p)
4540 (org-call-with-arg 'org-table-recalculate t))))
4541 (t (let (orgtbl-mode)
4542 (call-interactively (key-binding "\C-c\C-c")))))))
4544 (defun orgtbl-create-or-convert-from-region (_arg)
4545 "Create table or convert region to table, if no conflicting binding.
4546 This installs the table binding `C-c |', but only if there is no
4547 conflicting binding to this key outside orgtbl-mode."
4548 (interactive "P")
4549 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4550 (if cmd
4551 (call-interactively cmd)
4552 (call-interactively 'org-table-create-or-convert-from-region))))
4554 (defun orgtbl-tab (arg)
4555 "Justification and field motion for `orgtbl-mode'."
4556 (interactive "P")
4557 (if arg (org-table-edit-field t)
4558 (org-table-justify-field-maybe)
4559 (org-table-next-field)))
4561 (defun orgtbl-ret ()
4562 "Justification and field motion for `orgtbl-mode'."
4563 (interactive)
4564 (if (bobp)
4565 (newline)
4566 (org-table-justify-field-maybe)
4567 (org-table-next-row)))
4569 (defun orgtbl-self-insert-command (N)
4570 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4571 If the cursor is in a table looking at whitespace, the whitespace is
4572 overwritten, and the table is not marked as requiring realignment."
4573 (interactive "p")
4574 (if (and (org-at-table-p)
4575 (or
4576 (and org-table-auto-blank-field
4577 (member last-command
4578 '(orgtbl-hijacker-command-100
4579 orgtbl-hijacker-command-101
4580 orgtbl-hijacker-command-102
4581 orgtbl-hijacker-command-103
4582 orgtbl-hijacker-command-104
4583 orgtbl-hijacker-command-105
4584 yas/expand))
4585 (org-table-blank-field))
4586 t)
4587 (eq N 1)
4589 (let (org-table-may-need-update)
4590 (delete-region (match-beginning 1) (match-end 1))
4591 (self-insert-command N))
4592 (setq org-table-may-need-update t)
4593 (let* (orgtbl-mode
4594 a
4595 (cmd (or (key-binding
4596 (or (and (listp function-key-map)
4597 (setq a (assoc last-input-event function-key-map))
4598 (cdr a))
4599 (vector last-input-event)))
4600 'self-insert-command)))
4601 (call-interactively cmd)
4602 (if (and org-self-insert-cluster-for-undo
4603 (eq cmd 'self-insert-command))
4604 (if (not (eq last-command 'orgtbl-self-insert-command))
4605 (setq org-self-insert-command-undo-counter 1)
4606 (if (>= org-self-insert-command-undo-counter 20)
4607 (setq org-self-insert-command-undo-counter 1)
4608 (and (> org-self-insert-command-undo-counter 0)
4609 buffer-undo-list
4610 (not (cadr buffer-undo-list)) ; remove nil entry
4611 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4612 (setq org-self-insert-command-undo-counter
4613 (1+ org-self-insert-command-undo-counter))))))))
4615 ;;;###autoload
4617 "Regular expression matching exponentials as produced by calc.")
4619 (defun orgtbl-gather-send-defs ()
4620 "Gather a plist of :name, :transform, :params for each destination before
4621 a radio table."
4622 (save-excursion
4623 (goto-char (org-table-begin))
4624 (let (rtn)
4625 (beginning-of-line 0)
4626 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4627 (let ((name (org-no-properties (match-string 1)))
4628 (transform (intern (match-string 2)))
4629 (params (if (match-end 3)
4630 (read (concat "(" (match-string 3) ")")))))
4631 (push (list :name name :transform transform :params params)
4632 rtn)
4633 (beginning-of-line 0)))
4634 rtn)))
4636 (defun orgtbl-send-replace-tbl (name text)
4637 "Find and replace table NAME with TEXT."
4638 (save-excursion
4639 (goto-char (point-min))
4640 (let* ((location-flag nil)
4641 (name (regexp-quote name))
4644 (while (re-search-forward begin-re nil t)
4645 (unless location-flag (setq location-flag t))
4646 (let ((beg (line-beginning-position 2)))
4647 (unless (re-search-forward end-re nil t)
4648 (user-error "Cannot find end of receiver location at %d" beg))
4649 (beginning-of-line)
4650 (delete-region beg (point))
4652 (unless location-flag
4653 (user-error "No valid receiver location found in the buffer")))))
4655 ;;;###autoload
4656 (defun org-table-to-lisp (&optional txt)
4657 "Convert the table at point to a Lisp structure.
4658 The structure will be a list. Each item is either the symbol `hline'
4659 for a horizontal separator line, or a list of field values as strings.
4660 The table is taken from the parameter TXT, or from the buffer at point."
4661 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4662 (let ((txt (or txt
4663 (buffer-substring-no-properties (org-table-begin)
4664 (org-table-end)))))
4665 (mapcar (lambda (x)
4666 (if (string-match org-table-hline-regexp x) 'hline
4670 (defun orgtbl-send-table (&optional maybe)
4671 "Send a transformed version of table at point to the receiver position.
4672 With argument MAYBE, fail quietly if no transformation is defined
4673 for this table."
4674 (interactive)
4675 (catch 'exit
4676 (unless (org-at-table-p) (user-error "Not at a table"))
4677 ;; when non-interactive, we assume align has just happened.
4678 (when (called-interactively-p 'any) (org-table-align))
4679 (let ((dests (orgtbl-gather-send-defs))
4680 (table (org-table-to-lisp
4681 (buffer-substring-no-properties (org-table-begin)
4682 (org-table-end))))
4683 (ntbl 0))
4684 (unless dests
4685 (if maybe (throw 'exit nil)
4686 (user-error "Don't know how to transform this table")))
4687 (dolist (dest dests)
4688 (let ((name (plist-get dest :name))
4689 (transform (plist-get dest :transform))
4690 (params (plist-get dest :params)))
4691 (unless (fboundp transform)
4692 (user-error "No such transformation function %s" transform))
4693 (orgtbl-send-replace-tbl name (funcall transform table params)))
4694 (cl-incf ntbl))
4695 (message "Table converted and installed at %d receiver location%s"
4696 ntbl (if (> ntbl 1) "s" ""))
4697 (and (> ntbl 0) ntbl))))
4699 (defun org-remove-by-index (list indices &optional i0)
4700 "Remove the elements in LIST with indices in INDICES.
4701 First element has index 0, or I0 if given."
4702 (if (not indices)
4703 list
4704 (if (integerp indices) (setq indices (list indices)))
4705 (setq i0 (1- (or i0 0)))
4706 (delq :rm (mapcar (lambda (x)
4707 (setq i0 (1+ i0))
4708 (if (memq i0 indices) :rm x))
4709 list))))
4711 (defun orgtbl-toggle-comment ()
4712 "Comment or uncomment the orgtbl at point."
4713 (interactive)
4714 (let* ((case-fold-search t)
4715 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4716 (re2 (concat "^" orgtbl-line-start-regexp))
4717 (commented (save-excursion (beginning-of-line 1)
4718 (cond ((looking-at re1) t)
4719 ((looking-at re2) nil)
4720 (t (user-error "Not at an org table")))))
4721 (re (if commented re1 re2))
4722 beg end)
4723 (save-excursion
4724 (beginning-of-line 1)
4725 (while (looking-at re) (beginning-of-line 0))
4726 (beginning-of-line 2)
4727 (setq beg (point))
4728 (while (looking-at re) (beginning-of-line 2))
4729 (setq end (point)))
4730 (comment-region beg end (if commented '(4) nil))))
4732 (defun orgtbl-insert-radio-table ()
4733 "Insert a radio table template appropriate for this major mode."
4734 (interactive)
4735 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4736 (txt (nth 1 e))
4737 name pos)
4738 (unless e (user-error "No radio table setup defined for %s" major-mode))
4739 (setq name (read-string "Table name: "))
4740 (while (string-match "%n" txt)
4741 (setq txt (replace-match name t t txt)))
4743 (setq pos (point))
4744 (insert txt)
4745 (goto-char pos)))
4747 ;;;###autoload
4748 (defun orgtbl-to-generic (table params)
4749 "Convert the orgtbl-mode TABLE to some other format.
4751 This generic routine can be used for many standard cases.
4753 TABLE is a list, each entry either the symbol `hline' for
4754 a horizontal separator line, or a list of fields for that
4755 line. PARAMS is a property list of parameters that can
4756 influence the conversion.
4758 Valid parameters are:
4760 :backend, :raw
4762 Export back-end used as a basis to transcode elements of the
4763 table, when no specific parameter applies to it. It is also
4764 used to translate cells contents. You can prevent this by
4765 setting :raw property to a non-nil value.
4767 :splice
4769 When non-nil, only convert rows, not the table itself. This is
4770 equivalent to setting to the empty string both :tstart
4771 and :tend, which see.
4773 :skip
4775 When set to an integer N, skip the first N lines of the table.
4776 Horizontal separation lines do count for this parameter!
4778 :skipcols
4780 List of columns that should be skipped. If the table has
4781 a column with calculation marks, that column is automatically
4782 discarded beforehand.
4784 :hline
4786 String to be inserted on horizontal separation lines. May be
4787 nil to ignore these lines altogether.
4789 :sep
4791 Separator between two fields, as a string.
4793 Each in the following group may be either a string or a function
4794 of no arguments returning a string:
4796 :tstart, :tend
4798 Strings to start and end the table. Ignored when :splice is t.
4800 :lstart, :lend
4802 Strings to start and end a new table line.
4804 :llstart, :llend
4806 Strings to start and end the last table line. Default,
4807 respectively, to :lstart and :lend.
4809 Each in the following group may be a string or a function of one
4810 argument (either the cells in the current row, as a list of
4811 strings, or the current cell) returning a string:
4813 :lfmt
4815 Format string for an entire row, with enough %s to capture all
4816 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4818 :llfmt
4820 Format for the entire last line, defaults to :lfmt.
4822 :fmt
4824 A format to be used to wrap the field, should contain %s for
4825 the original field value. For example, to wrap everything in
4827 a property list with column numbers and format strings, or
4828 functions, e.g.,
4832 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4834 Same as above, specific for the header lines in the table.
4835 All lines before the first hline are treated as header. If
4836 any of these is not present, the data line value is used.
4838 This may be either a string or a function of two arguments:
4840 :efmt
4842 Use this format to print numbers with exponential. The format
4843 should have %s twice for inserting mantissa and exponent, for
4845 list with column numbers and format strings or functions.
4846 :fmt will still be applied after :efmt."
4847 ;; Make sure `org-export-create-backend' is available.
4848 (require 'ox)
4849 (let* ((backend (plist-get params :backend))
4850 (custom-backend
4851 ;; Build a custom back-end according to PARAMS. Before
4852 ;; defining a translator, check if there is anything to do.
4853 ;; When there isn't, let BACKEND handle the element.
4854 (org-export-create-backend
4855 :parent (or backend 'org)
4856 :transcoders
4857 `((table . ,(org-table--to-generic-table params))
4858 (table-row . ,(org-table--to-generic-row params))
4859 (table-cell . ,(org-table--to-generic-cell params))
4860 ;; Macros are not going to be expanded. However, no
4861 ;; regular back-end has a transcoder for them. We
4862 ;; provide one so they are not ignored, but displayed
4863 ;; as-is instead.
4864 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4865 data info)
4866 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4867 ;; Initialize communication channel in INFO.
4868 (with-temp-buffer
4869 (let ((org-inhibit-startup t)) (org-mode))
4870 (let ((standard-output (current-buffer)))
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 (org-export-table-row-in-header-p row info))
4995 (lastp (not (org-export-get-next-element row info)))
4996 (last-header-p (org-export-table-row-ends-header-p row info)))
4997 (when contents
4998 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4999 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5000 ;; `:lstart', `:lend' and their relatives.
5001 ,(let ((cells
5002 '(org-element-map row 'table-cell
5003 (lambda (cell)
5004 ;; Export all cells, without separators.
5005 ;;
5006 ;; Use `org-export-data-with-backend'
5007 ;; instead of `org-export-data' to eschew
5008 ;; cached values, which
5009 ;; ignore :orgtbl-ignore-sep parameter.
5010 (org-export-data-with-backend
5011 cell
5012 (plist-get info :back-end)
5013 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5014 info)))
5015 `(cond
5016 ,(and hllfmt
5017 `(last-header-p ,(org-table--generic-apply
5018 hllfmt ":hllfmt" nil cells)))
5019 ,(and hlfmt
5020 `(headerp ,(org-table--generic-apply
5021 hlfmt ":hlfmt" nil cells)))
5022 ,(and llfmt
5023 `(lastp ,(org-table--generic-apply
5024 llfmt ":llfmt" nil cells)))
5025 (t
5026 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5027 `(concat
5028 (cond
5029 ,(and
5030 (or hllstart hllend)
5031 `(last-header-p
5032 (concat
5033 ,(org-table--generic-apply hllstart ":hllstart")
5034 contents
5035 ,(org-table--generic-apply hllend ":hllend"))))
5036 ,(and
5037 (or hlstart hlend)
5038 `(headerp
5039 (concat
5040 ,(org-table--generic-apply hlstart ":hlstart")
5041 contents
5042 ,(org-table--generic-apply hlend ":hlend"))))
5043 ,(and
5044 (or llstart llend)
5045 `(lastp
5046 (concat
5047 ,(org-table--generic-apply llstart ":llstart")
5048 contents
5049 ,(org-table--generic-apply llend ":llend"))))
5050 (t
5051 ,(cond
5052 ((or lstart lend)
5053 `(concat
5054 ,(org-table--generic-apply lstart ":lstart")
5055 contents
5056 ,(org-table--generic-apply lend ":lend")))
5057 (backend
5058 `(org-export-with-backend
5059 ',backend row contents info))
5060 (t 'contents)))))))))))))))
5062 (defun org-table--to-generic-cell (params)
5063 "Return custom table cell transcoder according to PARAMS.
5064 PARAMS is a plist. See `orgtbl-to-generic' for more
5065 information."
5066 (let* ((backend (plist-get params :backend))
5067 (efmt (plist-get params :efmt))
5068 (fmt (plist-get params :fmt))
5069 (hfmt (plist-get params :hfmt))
5070 (sep (plist-get params :sep))
5071 (hsep (plist-get params :hsep)))
5072 `(lambda (cell contents info)
5073 (let ((headerp (org-export-table-row-in-header-p
5074 (org-export-get-parent-element cell) info))
5075 (column (1+ (cdr (org-export-table-cell-address cell 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
5084 ;; will have newlines appended instead of spaces.
5085 ;; Therefore, we must make sure :post-blank value
5086 ;; is really turned into spaces.
5087 (replace-regexp-in-string
5089 (org-trim
5090 (org-element-interpret-data
5091 (org-element-contents cell))))))
5092 (when contents
5093 ;; Check if we can apply `:efmt' on CONTENTS.
5094 ,(when efmt
5095 `(when (string-match orgtbl-exp-regexp contents)
5096 (let ((mantissa (match-string 1 contents))
5097 (exponent (match-string 2 contents)))
5098 (setq contents ,(org-table--generic-apply
5099 efmt ":efmt" t 'mantissa 'exponent)))))
5100 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5101 (cond
5102 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5103 hfmt ":hfmt" t 'contents))))
5104 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5105 fmt ":fmt" t 'contents))))))
5106 ;; If a separator is provided, use it instead of BACKEND's.
5107 ;; Separators are ignored when LFMT (or equivalent) is
5108 ;; provided.
5109 ,(cond
5110 ((or hsep sep)
5111 `(if (or ,(and (not sep) '(not headerp))
5112 (plist-get info :orgtbl-ignore-sep)
5113 (not (org-export-get-next-element cell info)))
5114 ,(if (not backend) 'contents
5115 `(org-export-with-backend ',backend cell contents info))
5116 (concat contents
5117 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5118 (or hsep sep)))))
5119 (backend `(org-export-with-backend ',backend cell contents info))
5120 (t 'contents))))))
5122 ;;;###autoload
5123 (defun orgtbl-to-tsv (table params)
5124 "Convert the orgtbl-mode table to TAB separated material."
5127 ;;;###autoload
5128 (defun orgtbl-to-csv (table params)
5129 "Convert the orgtbl-mode table to CSV material.
5130 This does take care of the proper quoting of fields with comma or quotes."
5131 (orgtbl-to-generic table
5132 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5133 params)))
5135 ;;;###autoload
5136 (defun orgtbl-to-latex (table params)
5137 "Convert the orgtbl-mode TABLE to LaTeX.
5139 TABLE is a list, each entry either the symbol `hline' for
5140 a horizontal separator line, or a list of fields for that line.
5141 PARAMS is a property list of parameters that can influence the
5142 conversion. All parameters from `orgtbl-to-generic' are
5143 supported. It is also possible to use the following ones:
5145 :booktabs
5149 :environment
5151 Specify environment to use, as a string. If you use
5153 as a string, to get proper continuation strings."
5154 (require 'ox-latex)
5155 (orgtbl-to-generic
5156 table
5157 (org-combine-plists
5158 ;; Provide sane default values.
5159 (list :backend 'latex
5160 :latex-default-table-mode 'table
5161 :latex-tables-centered nil
5162 :latex-tables-booktabs (plist-get params :booktabs)
5163 :latex-table-scientific-notation nil
5164 :latex-default-table-environment
5165 (or (plist-get params :environment) "tabular"))
5166 params)))
5168 ;;;###autoload
5169 (defun orgtbl-to-html (table params)
5170 "Convert the orgtbl-mode TABLE to HTML.
5172 TABLE is a list, each entry either the symbol `hline' for
5173 a horizontal separator line, or a list of fields for that line.
5174 PARAMS is a property list of parameters that can influence the
5175 conversion. All parameters from `orgtbl-to-generic' are
5176 supported. It is also possible to use the following one:
5178 :attributes
5180 Attributes and values, as a plist, which will be used in
5181 <table> tag."
5182 (require 'ox-html)
5183 (orgtbl-to-generic
5184 table
5185 (org-combine-plists
5186 ;; Provide sane default values.
5187 (list :backend 'html
5188 :html-table-data-tags '("<td%s>" . "</td>")
5189 :html-table-use-header-tags-for-first-column nil
5190 :html-table-align-individual-fields t
5191 :html-table-row-tags '("<tr>" . "</tr>")
5192 :html-table-attributes
5193 (if (plist-member params :attributes)
5194 (plist-get params :attributes)
5195 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5196 :frame "hsides")))
5197 params)))
5199 ;;;###autoload
5200 (defun orgtbl-to-texinfo (table params)
5201 "Convert the orgtbl-mode TABLE to Texinfo.
5203 TABLE is a list, each entry either the symbol `hline' for
5204 a horizontal separator line, or a list of fields for that line.
5205 PARAMS is a property list of parameters that can influence the
5206 conversion. All parameters from `orgtbl-to-generic' are
5207 supported. It is also possible to use the following one:
5209 :columns
5211 Column widths, as a string. When providing column fractions,
5213 (require 'ox-texinfo)
5214 (let ((output
5215 (orgtbl-to-generic
5216 table
5217 (org-combine-plists
5218 (list :backend 'texinfo
5219 :texinfo-tables-verbatim nil
5220 :texinfo-table-scientific-notation nil)
5221 params)))
5222 (columns (let ((w (plist-get params :columns)))
5223 (cond ((not w) nil)
5225 (t (concat "@columnfractions " w))))))
5226 (if (not columns) output
5227 (replace-regexp-in-string
5230 ;;;###autoload
5231 (defun orgtbl-to-orgtbl (table params)
5232 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5234 TABLE is a list, each entry either the symbol `hline' for
5235 a horizontal separator line, or a list of fields for that line.
5236 PARAMS is a property list of parameters that can influence the
5237 conversion. All parameters from `orgtbl-to-generic' are
5238 supported.
5240 Useful when slicing one table into many. The :hline, :sep,
5241 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5242 be set to provide ORGTBL directives for the generated table."
5243 (require 'ox-org)
5244 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5246 (defun orgtbl-to-table.el (table params)
5247 "Convert the orgtbl-mode TABLE into a table.el table.
5248 TABLE is a list, each entry either the symbol `hline' for
5249 a horizontal separator line, or a list of fields for that line.
5250 PARAMS is a property list of parameters that can influence the
5251 conversion. All parameters from `orgtbl-to-generic' are
5252 supported."
5253 (with-temp-buffer
5254 (insert (orgtbl-to-orgtbl table params))
5255 (org-table-align)
5256 (replace-regexp-in-string
5257 "-|" "-+"
5258 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5260 (defun orgtbl-to-unicode (table params)
5261 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5263 TABLE is a list, each entry either the symbol `hline' for
5264 a horizontal separator line, or a list of fields for that line.
5265 PARAMS is a property list of parameters that can influence the
5266 conversion. All parameters from `orgtbl-to-generic' are
5267 supported. It is also possible to use the following ones:
5269 :ascii-art
5272 the table. You can download it here:
5273 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5275 :narrow
5277 When non-nil, narrow columns width than provided width cookie,
5279 (require 'ox-ascii)
5280 (orgtbl-to-generic
5281 table
5282 (org-combine-plists
5283 (list :backend 'ascii
5284 :ascii-charset 'utf-8
5285 :ascii-table-widen-columns (not (plist-get params :narrow))
5286 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5287 params)))
5289 ;; Put the cursor in a column containing numerical values
5290 ;; of an Org table,
5291 ;; type C-c " a
5292 ;; A new column is added with a bar plot.
5293 ;; When the table is refreshed (C-u C-c *),
5294 ;; the plot is updated to reflect the new values.
5296 (defun orgtbl-ascii-draw (value min max &optional width characters)
5297 "Draw an ascii bar in a table.
5298 VALUE is the value to plot, it determines the width of the bar to draw.
5299 MIN is the value that will be displayed as empty (zero width bar).
5300 MAX is the value that will draw a bar filling all the WIDTH.
5301 WIDTH is the span in characters from MIN to MAX.
5302 CHARACTERS is a string that will compose the bar, with shades of grey
5303 from pure white to pure black. It defaults to a 10 characters string
5304 of regular ascii characters."
5305 (let* ((width (ceiling (or width 12)))
5306 (characters (or characters " .:;c!lhVHW"))
5307 (len (1- (length characters)))
5308 (value (float (if (numberp value)
5309 value (string-to-number value))))
5310 (relative (/ (- value min) (- max min)))
5311 (steps (round (* relative width len))))
5312 (cond ((< steps 0) "too small")
5313 ((> steps (* width len)) "too large")
5314 (t (let* ((int-division (/ steps len))
5315 (remainder (- steps (* int-division len))))
5316 (concat (make-string int-division (elt characters len))
5317 (string (elt characters remainder))))))))
5319 ;;;###autoload
5320 (defun orgtbl-ascii-plot (&optional ask)
5321 "Draw an ASCII bar plot in a column.
5323 With cursor in a column containing numerical values, this function
5324 will draw a plot in a new column.
5326 ASK, if given, is a numeric prefix to override the default 12
5328 prefix,
5329 which will prompt for the width."
5330 (interactive "P")
5331 (let ((col (org-table-current-column))
5332 (min 1e999) ; 1e999 will be converted to infinity
5333 (max -1e999) ; which is the desired result
5334 (table (org-table-to-lisp))
5335 (length
5336 (cond ((consp ask)
5337 (read-number "Length of column " 12))
5338 ((numberp ask) ask)
5339 (t 12))))
5340 ;; Skip any hline a the top of table.
5341 (while (eq (car table) 'hline) (setq table (cdr table)))
5342 ;; Skip table header if any.
5343 (dolist (x (or (cdr (memq 'hline table)) table))
5344 (when (consp x)
5345 (setq x (nth (1- col) x))
5346 (when (string-match
5348 x)
5349 (setq x (string-to-number x))
5350 (when (> min x) (setq min x))
5351 (when (< max x) (setq max x)))))
5352 (org-table-insert-column)
5353 (org-table-move-column-right)
5354 (org-table-store-formulas
5355 (cons
5356 (cons
5357 (concat "$" (number-to-string (1+ col)))
5358 (format "'(%s $%s %s %s %s)"
5359 "orgtbl-ascii-draw" col min max length))
5360 (org-table-get-stored-formulas)))
5361 (org-table-recalculate t)))
5363 ;; Example of extension: unicode characters
5364 ;; Here are two examples of different styles.
5366 ;; Unicode block characters are used to give a smooth effect.
5367 ;; See http://en.wikipedia.org/wiki/Block_Elements
5368 ;; Use one of those drawing functions
5369 ;; - orgtbl-ascii-draw (the default ascii)
5370 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5371 ;; - orgtbl-uc-draw-cont (smooth unicode)
5373 ;; This is best viewed with the "DejaVu Sans Mono" font
5374 ;; (use M-x set-default-font).
5376 (defun orgtbl-uc-draw-grid (value min max &optional width)
5377 "Draw a bar in a table using block unicode characters.
5378 It is a variant of orgtbl-ascii-draw with Unicode block
5379 characters, for a smooth display. Bars appear as grids (to the
5380 extent the font allows)."
5381 ;; http://en.wikipedia.org/wiki/Block_Elements
5382 ;; best viewed with the "DejaVu Sans Mono" font.
5383 (orgtbl-ascii-draw value min max width
5386 (defun orgtbl-uc-draw-cont (value min max &optional width)
5387 "Draw a bar in a table using block unicode characters.
5388 It is a variant of orgtbl-ascii-draw with Unicode block
5389 characters, for a smooth display. Bars are solid (to the extent
5390 the font allows)."
5391 (orgtbl-ascii-draw value min max width
5394 (defun org-table-get-remote-range (name-or-id form)
5395 "Get a field value or a list of values in a range from table at ID.
5397 NAME-OR-ID may be the name of a table in the current file as set
5399 will then be used. Alternatively, it may be an ID referring to
5400 any entry, also in a different file. In this case, the first
5401 table in that entry will be referenced.
5405 The return value is either a single string for a single field, or a
5406 list of the fields in the rectangle."
5407 (save-match-data
5408 (let ((case-fold-search t) (id-loc nil)
5409 ;; Protect a bunch of variables from being overwritten by
5410 ;; the context of the remote table.
5411 org-table-column-names org-table-column-name-regexp
5412 org-table-local-parameters org-table-named-field-locations
5413 org-table-current-line-types
5414 org-table-current-begin-pos org-table-dlines
5415 org-table-current-ncol
5416 org-table-hlines org-table-last-alignment
5417 org-table-last-column-widths org-table-last-alignment
5418 org-table-last-column-widths
5419 buffer loc)
5420 (setq form (org-table-convert-refs-to-rc form))
5421 (org-with-wide-buffer
5422 (goto-char (point-min))
5423 (if (re-search-forward
5426 nil t)
5427 (setq buffer (current-buffer) loc (match-beginning 0))
5428 (setq id-loc (org-id-find name-or-id 'marker))
5429 (unless (and id-loc (markerp id-loc))
5431 (setq buffer (marker-buffer id-loc)
5432 loc (marker-position id-loc))
5433 (move-marker id-loc nil))
5434 (with-current-buffer buffer
5435 (org-with-wide-buffer
5436 (goto-char loc)
5437 (forward-char 1)
5439 (not (match-beginning 1)))
5440 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5441 (org-table-analyze)
5442 (setq form (org-table-formula-substitute-names
5443 (org-table-formula-handle-first/last-rc form)))
5444 (if (and (string-match org-table-range-regexp form)
5445 (> (length (match-string 0 form)) 1))
5446 (org-table-get-range
5447 (match-string 0 form) org-table-current-begin-pos 1)
5448 form)))))))
5450 (defun org-table-remote-reference-indirection (form)
5451 "Return formula with table remote references substituted by indirection.
5453 This indirection works only with the format @ROW$COLUMN. The
5455 distinguished from a plain table name or ID."
5456 (let ((regexp
5457 ;; Same as in `org-table-eval-formula'.
5459 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5462 (replace-regexp-in-string
5463 regexp
5464 (lambda (m)
5465 (save-match-data
5466 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5467 (org-table-get-range
5469 (concat "@0" eq)
5470 eq)))))
5471 form t t 1)))
5473 (defmacro org-define-lookup-function (mode)
5474 (let ((mode-str (symbol-name mode))
5475 (first-p (eq mode 'first))
5476 (all-p (eq mode 'all)))
5477 (let ((plural-str (if all-p "s" "")))
5478 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5479 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5480 If R-LIST is nil, return matching element%s of S-LIST.
5481 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5482 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5483 This function is generated by a call to the macro `org-define-lookup-function'."
5484 mode-str plural-str plural-str plural-str)
5485 (let ,(let ((lvars '((p (or predicate 'equal))
5486 (sl s-list)
5487 (rl (or r-list s-list))
5488 (ret nil))))
5489 (if first-p (cons '(match-p nil) lvars) lvars))
5490 (while ,(if first-p '(and (not match-p) sl) 'sl)
5491 (when (funcall p val (car sl))
5492 ,(when first-p '(setq match-p t))
5493 (let ((rval (car rl)))
5494 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5495 (setq sl (cdr sl) rl (cdr rl)))
5496 ret)))))
5498 (org-define-lookup-function first)
5499 (org-define-lookup-function last)
5500 (org-define-lookup-function all)
5502 (provide 'org-table)
5504 ;; Local variables:
5505 ;; generated-autoload-file: "org-loaddefs.el"
5506 ;; End:
5508 ;;; org-table.el ends here