| blob | 357fdcfa441910676917218960f14b49a122f088 |
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 txt hline2p)
1558 ;;;###autoload
1560 "Insert a new row above the current line into the table.
1561 With prefix ARG, insert below the current line."
1566 ;; Fix the first field if necessary
1570 ;; Buffer may not end of a newline character, so ensure
1571 ;; (beginning-of-line 2) moves point to a new line.
1582 ;;;###autoload
1584 "Insert a horizontal-line below the current line into the table.
1585 With prefix ABOVE, insert above the current line."
1606 ;;;###autoload
1608 "Insert a hline and move to the row below that line."
1622 In particular, this does handle wide and invisible characters."
1624 ;; It's a hline, just map the characters
1630 t t s)))
1631 s))
1633 ;;;###autoload
1635 "Delete the current row or horizontal line from the table."
1649 ;;;###autoload
1652 "Sort table lines according to the column at point.
1654 The position of point indicates the column to be used for
1655 sorting, and the range of lines is the range between the nearest
1656 horizontal separator lines, or the entire table of no such lines
1657 exist. If point is before the first column, you will be prompted
1658 for the sorting column. If there is an active region, the mark
1659 specifies the first line and the sorting column, while point
1660 should be in the last line to be included into the sorting.
1662 The command then prompts for the sorting type which can be
1663 alphabetically, numerically, or by time (as given in a time stamp
1664 in the field, or as a HH:MM value). Sorting in reverse order is
1665 also possible.
1667 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1669 If SORTING-TYPE is specified when this function is called from a Lisp
1670 program, no prompting will take place. SORTING-TYPE must be a character,
1671 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1672 sorting should be done in reverse order.
1674 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1675 a function to be called to extract the key. It must return a value
1676 that is compatible with COMPARE-FUNC, the function used to compare
1677 entries.
1679 A non-nil value for INTERACTIVE? is used to signal that this
1680 function is being called interactively."
1683 ;; Point must be either within a field or before a data line.
1688 ;; Set appropriate case sensitivity and column used for sorting.
1699 ;; Narrow buffer to appropriate sorting area.
1712 start))
1715 end))))
1716 ;; Determine arguments for `sort-subr'. Also record original
1717 ;; position. `org-table-save-field' cannot help here since
1718 ;; sorting is too much destructive.
1724 ;; Function to be called on the contents of the field
1725 ;; used for sorting in the current row.
1761 #'end-of-line
1765 nil
1766 predicate)
1767 ;; Move back to initial field.
1771 ;;;###autoload
1773 "Copy region in table to the clipboard and blank all relevant fields.
1774 If there is no active region, use just the field at point."
1780 ;;;###autoload
1782 "Copy rectangular region in table to clipboard.
1783 A special clipboard is used which can only be accessed
1784 with `org-table-paste-rectangle'."
1788 current-prefix-arg))
1793 region)
1805 ;; Collect every cell between COLUMN-START and COLUMN-END.
1815 ;;;###autoload
1817 "Paste a rectangular region into a table.
1818 The upper right corner ends up in the current field. All involved fields
1819 will be overwritten. If the rectangle does not fit into the present table,
1820 the table is enlarged as needed. The process ignores horizontal separator
1821 lines."
1832 ;; If we left the table, create a new row.
1844 ;;;###autoload
1846 "Convert from `org-mode' table to table.el and back.
1847 Obviously, this only works within limits. When an Org table is converted
1848 to table.el, all horizontal separator lines get lost, because table.el uses
1849 these as cell boundaries and has no notion of horizontal lines. A table.el
1850 table can be converted to an Org table only if it does not do row or column
1851 spanning. Multiline cells will become multiple cells. Beware, Org mode
1852 does not test if the table can be successfully converted - it blindly
1853 applies a recipe that works for simple tables."
1857 ;; convert to Org table
1866 ;; convert to table.el table
1869 ;; first, get rid of all horizontal lines
1873 ;; insert a hline before first
1877 ;; insert a hline after each line
1882 ;; replace "+" at beginning and ending of hlines
1891 "Transpose Org table at point and eliminate hlines.
1892 So a table like
1894 | 1 | 2 | 4 | 5 |
1895 |---+---+---+---|
1896 | a | b | c | d |
1897 | e | f | g | h |
1899 will be transposed as
1901 | 1 | a | e |
1902 | 2 | b | f |
1903 | 4 | c | g |
1904 | 5 | d | h |
1906 Note that horizontal lines disappear."
1918 table)))
1932 ;;;###autoload
1934 "Wrap several fields in a column like a paragraph.
1935 This is useful if you'd like to spread the contents of a field over several
1936 lines, in order to keep the table compact.
1938 If there is an active region, and both point and mark are in the same column,
1939 the text in the column is wrapped to minimum width for the given number of
1940 lines. Generally, this makes the table more compact. A prefix ARG may be
1941 used to change the number of desired lines. For example, \
1943 formats the selected text to two lines. If the region was longer than two
1944 lines, the remaining lines remain empty. A negative prefix argument reduces
1945 the current number of lines by that amount. The wrapped text is pasted back
1946 into the table. If you formatted it to more lines than it was before, fields
1947 further down in the table get overwritten - so you might need to make space in
1948 the table first.
1950 If there is no region, the current field is split at the cursor position and
1951 the text fragment to the right of the cursor is prepended to the field one
1952 line down.
1954 If there is no region, but you specify a prefix ARG, the current field gets
1955 blank, and the content is appended to the field above."
1959 ;; There is a region: fill as a paragraph.
1970 nil
1971 nlines))))
1974 ;; No region, split the current field at point.
1999 ;;;###autoload
2001 "Edit table field in a different window.
2002 This is mainly useful for fields that contain hidden parts. When called
2004 visible so that it can be
2005 edited in place."
2014 display t intangible t))
2027 p)
2043 intangible t))
2051 "Finish editing a table data field.
2052 Remove all newline characters, insert the result into the table, realign
2053 the table and kill the editing buffer."
2057 text)
2074 "Minor mode to make the table field editor window follow the cursor.
2075 When this mode is active, the field editor window will always show the
2076 current field. The mode exits automatically when the cursor leaves the
2077 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2078 nil " TblFollow" nil
2094 ;; We have left the table, exit the follow mode
2104 ;;;###autoload
2106 "Sum numbers in region of current table column.
2107 The result will be displayed in the echo area, and will be available
2110 If there is an active region, it is interpreted as a rectangle and all
2111 numbers in that rectangle will be summed. If there is no active
2112 region and point is located in a table column, sum all numbers in that
2113 column.
2115 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2116 numbers are assumed to be times as well (in decimal hours) and the
2117 numbers are added as such.
2119 If NLAST is a number, only the NLAST fields will actually be summed."
2146 items1)))
2153 s diff)
2160 sres))))
2183 "Return the formula active for the current field.
2185 Assumes that table is already analyzed. If KEY is given, return
2186 the key to this formula. Otherwise return the formula preceded
2195 org-table-named-field-locations)))
2209 "Read a formula from the minibuffer, offer stored formula as default.
2210 When NAMED is non-nil, look for a named equation."
2215 org-table-named-field-locations)))
2228 stored)
2230 equation)
2236 scol))
2238 'org-table-formula-history
2239 )))))
2240 mustsave)
2242 ;; remove formula
2249 ;; We set the column equation, delete the named one.
2251 mustsave t))
2257 eq))
2260 "Store the list of formulas below the current table.
2261 If optional argument LOCATION is a buffer position, insert it at
2262 LOCATION instead."
2270 ;; Don't overwrite TBLFM, we might use text properties to
2271 ;; store stuff.
2285 ;; Fake a high number to make sure this is sorted at the end.
2292 a)
2302 "Compare two formulas for sorting."
2307 ;;;###autoload
2309 "Return an alist with the stored formulas directly after current table.
2310 By default, only return active formulas, i.e., formulas located
2311 on the first line after the table. However, if optional argument
2312 LOCATION is a buffer position, consider the formulas there."
2321 eq-alist seen)
2325 string)
2330 ;; Is it a column reference?
2332 ;; Since named columns are not possible in
2333 ;; LHS, assume this is a named field.
2341 "Double definition `%s=' in TBLFM line, please fix by hand"
2342 lhs)
2347 "Double definition `%s=' in TBLFM line, please fix by hand"
2348 lhs)))))))))))
2351 "Modify the equations after the table structure has been edited.
2353 For all numbers larger than LIMIT, shift them by DELTA."
2365 s n a)
2371 "Change makes TBLFM term %s invalid, use undo to recover"
2386 ;;;###autoload
2389 If yes, store the formula and apply it."
2390 ;; We already know we are in a table. Get field will only return a formula
2391 ;; when appropriate. It might return a separator line, but no problem.
2394 named eq)
2402 "List of commands triggering the recalculation of a line.
2414 ;;;###autoload
2416 "Rotate the recalculation mark in the first column.
2417 If in any row, the first field is not consistent with a mark,
2418 insert a new column for the markers.
2419 When there is an active region, change all the lines in the region,
2420 after prompting for the marking character.
2421 After each change, a message will be displayed indicating the meaning
2422 of the new mark."
2438 newchar))
2446 newchar))
2464 ;; Rotate mark in first row.
2466 ;; Rotate marks in additional rows if a region is active.
2474 ;; Only align if rotation actually changed lines' length.
2484 ;;;###autoload
2486 "Analyze table at point and store results.
2488 This function sets up the following dynamically scoped variables:
2490 `org-table-column-name-regexp',
2491 `org-table-column-names',
2492 `org-table-current-begin-pos',
2493 `org-table-current-line-types',
2494 `org-table-current-ncol',
2495 `org-table-dlines',
2496 `org-table-hlines',
2497 `org-table-local-parameters',
2498 `org-table-named-field-locations'."
2503 ;; Extract column names.
2516 ;; Extract local parameters.
2524 org-table-local-parameters)))))
2525 ;; Update named fields locations. We minimize `count-lines'
2526 ;; processing by storing last known number of lines in LAST.
2548 field))
2551 org-table-named-field-locations))))))))))
2552 ;; Re-use existing markers when possible.
2556 ;; Analyze the line types.
2567 ;; Get the number of columns from the first data line in table.
2575 al al2)
2589 "Move point to a specific field in the current table.
2591 REF is either the name of a field its absolute reference, as
2592 a string. No column is created unless CREATE-COLUMN-P is
2593 non-nil. If it is a function, it is called with the column
2594 number as its argument as is used as a predicate to know if the
2595 column can be created.
2597 This function assumes the table is already analyzed (i.e., using
2598 `org-table-analyze')."
2613 create-column-p)))
2619 ;;;###autoload
2621 "Recompute the current line if marked for it, and if we haven't just done it."
2641 org-tbl-calc-modes)
2643 ;;;###autoload
2645 suppress-align suppress-const
2646 suppress-store suppress-analysis)
2647 "Replace the table field value at the cursor by the result of a calculation.
2649 In a table, this command replaces the value in the current field with the
2651 formula, by storing it in a special line below the table. When called
2653 field formula.
2656 insert the active equation for the field
2657 back into the current field, so that it can be edited there. This is \
2658 useful
2660 check the referenced fields.
2662 When called, the command first prompts for a formula, which is read in
2663 the minibuffer. Previously entered formulas are available through the
2664 history list, and the last used formula is offered as a default.
2665 These stored formulas are adapted correctly when moving, inserting, or
2666 deleting columns with the corresponding commands.
2668 The formula can be any algebraic expression understood by the Calc package.
2669 For details, see the Org mode manual.
2671 This function can also be called from Lisp programs and offers
2672 additional arguments: EQUATION can be the formula to apply. If this
2673 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2674 used to speed-up recursive calls by by-passing unnecessary aligns.
2675 SUPPRESS-CONST suppresses the interpretation of constants in the
2676 formula, assuming that this has been done already outside the function.
2677 SUPPRESS-STORE means the formula should not be stored, either because
2678 it is already stored, or because it is a modified equation that should
2679 not overwrite the stored one. SUPPRESS-ANALYSIS prevents any call to
2680 `org-table-analyze'."
2695 equation
2701 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2702 duration duration-output-format)
2703 ;; Parse the format string. Since we have a lot of modes, this is
2704 ;; a lot of work. However, I think calc still uses most of the time.
2717 'calc-float-format
2720 n))))
2724 duration-output-format nil
2728 duration-output-format org-table-duration-custom-format
2729 numbers t
2755 ;; replace fields with duration values if relevant
2759 fields)))
2765 x))
2766 fields)))
2772 ;; Insert row and column number of formula result field
2783 t t form)))
2785 ;; Check for old vertical references
2787 ;; Insert remote references
2800 rmtrng))
2801 keep-empty numbers lispp))
2802 t t form)))
2803 ;; Insert complex ranges
2813 ;; possibly handle durations
2818 formrg)
2819 keep-empty numbers lispp)))
2824 ;; Insert simple ranges, i.e. included in the current row.
2827 form)
2838 keep-empty numbers lispp))
2839 t t form)))
2841 ;; Insert the references to fields in same row
2848 x keep-empty numbers lispp)))
2865 ;; Use <...> time-stamps so that Calc can handle them.
2868 ;; Internationalize local time-stamps by setting locale to
2869 ;; "C".
2872 org-ts-regexp
2880 form t t))
2883 form
2890 duration-output-format)
2891 ev)))
2896 Orig: %s
2897 $xyz-> %s
2898 @r$c-> %s
2930 prop value)))
2933 "Get a calc vector from a column, according to descriptor DESC.
2935 Optional arguments TBEG and COL can give the beginning of the table and
2936 the current column, to avoid unnecessary parsing.
2938 HIGHLIGHT means just highlight the range.
2940 When CORNERS-ONLY is set, only return the corners of the range as
2941 a list (line1 column1 line2 column2) where line1 and line2 are
2942 line numbers relative to beginning of table, or TBEG, and column1
2943 and column2 are table column numbers."
2946 desc))
2957 thisline)))
2962 thisline)))
2974 ;; Just one field.
2981 ;; A range, return a vector. First sort the numbers to get
2982 ;; a regular rectangle.
2988 ;; Copy the range values into a list.
3003 ;; Return string representation of calc vector.
3009 "Return relative line number corresponding to descriptor DESC.
3010 The cursor is currently in relative line number CLINE."
3015 ;; 1 2 3 4 5 6
3016 desc))
3038 cline)))
3041 "Return relative line of Nth row with type TYPE.
3042 Search starts from relative line I. When BACKWARDS in non-nil,
3043 look before I. When RELATIVE is non-nil, the reference is
3044 relative. DESC is the original descriptor that started the
3045 search, as a string."
3053 ;; We are going to cross a hline. Check if this is
3054 ;; an authorized move.
3065 ;; The last hline doesn't exist. Instead, point to last row
3066 ;; in table.
3075 "Convert list ELEMENTS to something appropriate to insert into formula.
3076 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3077 NUMBERS indicates that everything should be converted to numbers.
3078 LISPP non-nil means to return something appropriate for a Lisp
3079 list, `literal' is for the format specifier L."
3080 ;; Calc nan (not a number) is used for the conversion of the empty
3081 ;; field to a reference for several reasons: (i) It is accepted in a
3082 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3083 ;; (ii) In a single field (not in range) it can be distinguished
3084 ;; from "(nan)" which is the reference made from a single field
3085 ;; containing "nan".
3087 ;; field reference
3090 elements
3092 ""
3101 ;; range reference
3106 elements))))
3112 x
3120 x)
3122 elements
3126 "If there has been more than one second since T1, display message.
3127 ARGS are passed as arguments to the `message' function. Returns
3128 current time if a message is printed, otherwise returns T1. If
3129 T1 is nil, always messages."
3133 curtime)
3134 t1)))
3136 ;;;###autoload
3138 "Recalculate the current table line by applying all stored formulas.
3140 With prefix arg ALL, do this for all lines in the table.
3143 if ALL is the symbol `iterate',
3144 recompute the table until it no longer changes.
3146 If NOALIGN is not nil, do not re-align the table after the computations
3147 are done. This is typically used internally to save time, if it is
3148 known that the table will be realigned a little later anyway."
3163 beg end eqlcol eqlfield)
3164 ;; Insert constants in all formulas.
3167 ;; Expand equations, then split the equation list between
3168 ;; column formulas and field formulas.
3180 old-lhs)))
3183 existing formula for column %s"
3184 old-lhs
3185 new))
3186 new))
3192 ;; Expand ranges in lhs of formulas
3194 ;; Get the correct line range to process.
3201 ;; This is a table with marked lines, compute selected
3202 ;; lines.
3204 ;; Move forward to the first non-header line.
3209 ;; Just leave BEG at the start of the table.
3214 ;; Mark named fields untouchable. Also check if several
3215 ;; field/range formulas try to set the same field.
3219 seen-fields)
3230 ;; Turn field coordinates associated to NAME
3231 ;; into an absolute reference.
3235 name)))
3238 reference))
3243 ;; Evaluate the column formulas, but skip fields covered by
3244 ;; field formulas.
3248 ;; Unprotected line, recalculate.
3253 log-last-time
3266 ;; Evaluate the field formulas.
3275 reference
3276 ;; Possibly create a new column, as long as
3277 ;; `org-table-formula-create-columns' allows it.
3289 t))
3294 ;; Clean up markers and internal text property.
3305 ;;;###autoload
3307 "Recalculate the table until it does not change anymore.
3308 The maximum number of iterations is 10, but you can choose a different value
3309 with the prefix ARG."
3314 thistbl)
3328 ;;;###autoload
3330 "Recalculate all tables in the current buffer."
3335 ;; Reason for separate `org-table-align': When repeating
3336 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3337 ;; the way.
3340 t)))
3342 ;;;###autoload
3344 "Iterate all tables in the buffer, to converge inter-table dependencies."
3349 c1)
3365 "Apply the #+TBLFM in the line at point to the table."
3372 ;; Insert a temporary formula at right after the table
3377 ;; Recalculate the table.
3382 ;; Delete the formula inserted temporarily.
3388 "Find the beginning of the TBLFM lines and return its position.
3389 Return nil when the beginning of TBLFM line was not found."
3396 "Expand list of formulas.
3397 If some of the RHS in the formulas are ranges or a row reference,
3398 expand them to individual field equations for each field. This
3399 function assumes the table is already analyzed (i.e., using
3400 `org-table-analyze')."
3407 ;; This just refers to one fixed field.
3410 ;; This just refers to one fixed named field.
3413 ;; Column formulas are treated specially and are not
3414 ;; expanded.
3419 rhs)
3420 res)))
3432 rhs)
3433 res))))))))))
3436 "Replace @<, @>, $<, $> with first/last row/column of the table.
3437 So @< and $< will always be replaced with @1 and $1, respectively.
3438 The advantage of these special markers are that structure editing of
3439 the table will not change them, while @1 and $1 will be modified
3440 when a line/row is swapped out of that privileged position. So for
3441 formulas that use a range of rows or columns, it may often be better
3443 borders of the table using the @< @> $< $> makers."
3446 s start)
3451 org-table-current-ncol)
3455 len
3462 s)
3465 "Replace $const with values in string F."
3470 org-table-column-name-regexp
3473 org-table-column-names))))
3474 f t t)))
3475 ;; Parameters and constants.
3479 new start))
3482 ;; When a duration is expected, convert value on the fly.
3488 v)))))
3495 "Find the value for a parameter or constant in a formula.
3496 Parameters get priority."
3527 map))
3534 "--"
3537 "--"
3538 "Shift Reference at Point"
3543 "-"
3544 "Change Test Row for Column Formulas"
3547 "--"
3552 org-table-overlay-coordinates)]
3553 "--"
3561 ;;;###autoload
3563 "Edit the formulas of the current table in a separate buffer."
3569 ;; Move point within the table before analyzing it.
3585 ;; Keep global-font-lock-mode from turning on font-lock-mode
3630 "Convert a formula from internal to user representation."
3633 s))
3636 "Convert a formula from user to internal representation."
3639 s))
3642 "Convert spreadsheet references from A7 to @7$28.
3643 Works for single references, but also for entire formulas and even the
3644 full TBLFM line."
3646 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3649 ;; format match, just advance
3654 ;; 3.e5 or something like this.
3657 ;; (member (match-string 1 s)
3658 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3659 )
3660 ;; function name, just advance
3670 t t s)))))
3671 s))
3674 "Convert spreadsheet references from to @7$28 to AB7.
3675 Works for single references, but also for entire formulas and even the
3676 full TBLFM line."
3683 t t s)))
3688 t nil s)))
3689 s)
3692 "Convert a base 26 number represented by letters into an integer.
3693 For example: AB -> 28."
3699 n))
3702 "Convert an integer into a base 26 number represented by letters.
3703 For example: 28 -> AB."
3708 s))
3711 "Convert a time string into numerical duration in seconds.
3712 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3713 If S is a string representing a number, keep this number."
3715 s
3738 "Convert a number of seconds to a time string.
3739 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3740 minutes or seconds."
3755 "Convert all references in this buffer, using FUNCTION."
3766 "Convert all references in the buffer from B3 to @3$2 and back."
3776 "Shift the reference at point one row/hline up."
3780 "Shift the reference at point one row/hline down."
3784 "Shift the reference at point one field to the left."
3788 "Shift the reference at point one field to the right."
3799 ;; A B3-like reference
3805 ;; An internal reference
3811 "Re-match the group N, and replace it with the shifted reference."
3816 t t)))
3819 "Shift a reference part REF.
3820 If DECR is set, decrease the references row/column, else increase.
3821 If HLINE is set, this may be a hline reference, it certainly is not
3822 a translation reference."
3851 "Toggle the display of coordinates in the referenced table."
3860 "Parse the buffer for formula definitions and install them.
3861 With prefix ARG, apply the new formulas to the table."
3870 eql)
3873 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3874 nil t)
3895 "Abort editing formulas, without installing the changes."
3906 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3947 "Show the location/value of the $ expression at point.
3948 When LOCAL is non-nil, show references for the table at point."
3958 var name e what match dest)
3962 "$1.."
4014 dest)
4040 ;; Column number.
4066 org-table-fedit-scroll-down))))
4078 "Make sure the cursor is in a dataline in a table."
4087 p1 p2)))
4092 "Move cursor one line up in the window showing the table."
4097 "Move cursor one line down in the window showing the table."
4102 "Move the cursor in the window showing the table.
4103 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4128 "Add a new overlay."
4134 "Highlight rectangular region in a table.
4135 When buffer positions BEG and END are provided, use them to
4136 delimit the region to highlight. Otherwise, refer to point. Use
4137 FACE, when non-nil, for the highlight."
4169 "Remove the rectangle overlays."
4179 "Add overlays to the table at point, to show row/column coordinates."
4207 ;;;###autoload
4209 "Toggle the display of Row/Column numbers in tables."
4220 ;;;###autoload
4222 "Toggle the formula debugger in tables."
4228 ;;; The orgtbl minor mode
4230 ;; Define a minor mode which can be used in other modes in order to
4231 ;; integrate the Org table editor.
4233 ;; This is really a hack, because the Org table editor uses several
4234 ;; keys which normally belong to the major mode, for example the TAB
4235 ;; and RET keys. Here is how it works: The minor mode defines all the
4236 ;; keys necessary to operate the table editor, but wraps the commands
4237 ;; into a function which tests if the cursor is currently inside
4238 ;; a table. If that is the case, the table editor command is
4239 ;; executed. However, when any of those keys is used outside a table,
4240 ;; the function uses `key-binding' to look up if the key has an
4241 ;; associated command in another currently active keymap (minor modes,
4242 ;; major mode, global), and executes that command. There might be
4243 ;; problems if any of the keys used by the table editor is otherwise
4244 ;; used as a prefix key.
4246 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4247 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4248 ;; addresses this by checking explicitly for both bindings.
4250 ;; The optimized version (see variable `orgtbl-optimized') takes over
4251 ;; all keys which are bound to `self-insert-command' in the *global map*.
4252 ;; Some modes bind other commands to simple characters, for example
4253 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4254 ;; active, this binding is ignored inside tables and replaced with a
4255 ;; modified self-insert.
4273 ;; Install it as a minor mode.
4277 ;;;###autoload
4279 "The `org-mode' table editor as a minor mode for use in other modes."
4284 ;; Exit without error, in case some hook functions calls this
4285 ;; by accident in org-mode.
4289 ;; Make sure we are first in minor-mode-map-alist
4291 ;; FIXME: maybe it should use emulation-mode-map-alists?
4298 auto-fill-inhibit-regexp)
4302 auto-fill-inhibit-regexp)
4303 orgtbl-line-start-regexp))
4321 "Remove all properties related to narrow-column invisibility."
4334 "Create a function for binding in the table minor mode.
4335 FUN is the command to call inside a table. N is used to create a unique
4336 command name. KEYS are keys that should be checked in for a command
4337 to execute outside of tables."
4343 "Outside of tables, run the binding of `"
4355 keys)
4359 "Error when there is no default binding for a table key."
4364 "Setup orgtbl keymaps."
4395 elt key fun cmd)
4403 ;; Special treatment needed for TAB, RET and DEL
4416 (orgtbl-make-binding 'org-delete-backward-char 109
4422 [(tab)] "\C-i"))
4424 (org-defkey orgtbl-mode-map [backtab]
4426 [backtab] [S-iso-lefttab] [(shift tab)]
4427 [(tab)] "\C-i"))
4429 (org-defkey orgtbl-mode-map "\M-\C-m"
4430 (orgtbl-make-binding 'org-table-wrap-region 105
4431 "\M-\C-m" [(meta return)]))
4432 (org-defkey orgtbl-mode-map [(meta return)]
4433 (orgtbl-make-binding 'org-table-wrap-region 106
4434 [(meta return)] "\M-\C-m"))
4436 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4437 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4439 (when orgtbl-optimized
4440 ;; If the user wants maximum table support, we need to hijack
4441 ;; some standard editing functions
4442 (org-remap orgtbl-mode-map
4443 'self-insert-command 'orgtbl-self-insert-command
4444 'delete-char 'org-delete-char
4445 'delete-backward-char 'org-delete-backward-char)
4446 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4447 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4448 '("OrgTbl"
4449 ["Create or convert" org-table-create-or-convert-from-region
4450 :active (not (org-at-table-p)) :keys "C-c |" ]
4451 "--"
4452 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4453 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4454 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4455 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4456 "--"
4457 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4458 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4459 ["Copy Field from Above"
4460 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4461 "--"
4462 ("Column"
4463 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4464 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4465 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4466 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4467 ("Row"
4468 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4469 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4470 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4471 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4472 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4473 "--"
4474 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4475 ("Rectangle"
4476 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4477 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4478 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4479 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4480 "--"
4481 ("Radio tables"
4482 ["Insert table template" orgtbl-insert-radio-table
4483 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4484 ["Comment/uncomment table" orgtbl-toggle-comment t])
4485 "--"
4486 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4487 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4488 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4489 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4490 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4491 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4492 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4493 ["Sum Column/Rectangle" org-table-sum
4494 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4495 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4496 ["Debug Formulas"
4497 org-table-toggle-formula-debugger :active (org-at-table-p)
4498 :keys "C-c {"
4499 :style toggle :selected org-table-formula-debug]
4500 ["Show Col/Row Numbers"
4501 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4502 :keys "C-c }"
4503 :style toggle :selected org-table-overlay-coordinates]
4504 "--"
4505 ("Plot"
4508 t))
4510 (defun orgtbl-ctrl-c-ctrl-c (arg)
4511 "If the cursor is inside a table, realign the table.
4512 If it is a table to be sent away to a receiver, do it.
4513 With prefix arg, also recompute table."
4514 (interactive "P")
4515 (let ((case-fold-search t) (pos (point)) action)
4516 (save-excursion
4517 (beginning-of-line 1)
4518 (setq action (cond
4522 (cond
4523 ((integerp action)
4524 (goto-char action)
4525 (org-table-maybe-eval-formula)
4526 (if arg
4527 (call-interactively 'org-table-recalculate)
4528 (org-table-maybe-recalculate-line))
4529 (call-interactively 'org-table-align)
4530 (when (orgtbl-send-table 'maybe)
4531 (run-hooks 'orgtbl-after-send-table-hook)))
4532 ((eq action 'recalc)
4533 (save-excursion
4534 (beginning-of-line 1)
4536 (if (org-at-table-p)
4537 (org-call-with-arg 'org-table-recalculate t))))
4538 (t (let (orgtbl-mode)
4539 (call-interactively (key-binding "\C-c\C-c")))))))
4541 (defun orgtbl-create-or-convert-from-region (_arg)
4542 "Create table or convert region to table, if no conflicting binding.
4543 This installs the table binding `C-c |', but only if there is no
4544 conflicting binding to this key outside orgtbl-mode."
4545 (interactive "P")
4546 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4547 (if cmd
4548 (call-interactively cmd)
4549 (call-interactively 'org-table-create-or-convert-from-region))))
4551 (defun orgtbl-tab (arg)
4552 "Justification and field motion for `orgtbl-mode'."
4553 (interactive "P")
4554 (if arg (org-table-edit-field t)
4555 (org-table-justify-field-maybe)
4556 (org-table-next-field)))
4558 (defun orgtbl-ret ()
4559 "Justification and field motion for `orgtbl-mode'."
4560 (interactive)
4561 (if (bobp)
4562 (newline)
4563 (org-table-justify-field-maybe)
4564 (org-table-next-row)))
4566 (defun orgtbl-self-insert-command (N)
4567 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4568 If the cursor is in a table looking at whitespace, the whitespace is
4569 overwritten, and the table is not marked as requiring realignment."
4570 (interactive "p")
4571 (if (and (org-at-table-p)
4572 (or
4573 (and org-table-auto-blank-field
4574 (member last-command
4575 '(orgtbl-hijacker-command-100
4576 orgtbl-hijacker-command-101
4577 orgtbl-hijacker-command-102
4578 orgtbl-hijacker-command-103
4579 orgtbl-hijacker-command-104
4580 orgtbl-hijacker-command-105
4581 yas/expand))
4582 (org-table-blank-field))
4583 t)
4584 (eq N 1)
4586 (let (org-table-may-need-update)
4587 (delete-region (match-beginning 1) (match-end 1))
4588 (self-insert-command N))
4589 (setq org-table-may-need-update t)
4590 (let* (orgtbl-mode
4591 a
4592 (cmd (or (key-binding
4593 (or (and (listp function-key-map)
4594 (setq a (assoc last-input-event function-key-map))
4595 (cdr a))
4596 (vector last-input-event)))
4597 'self-insert-command)))
4598 (call-interactively cmd)
4599 (if (and org-self-insert-cluster-for-undo
4600 (eq cmd 'self-insert-command))
4601 (if (not (eq last-command 'orgtbl-self-insert-command))
4602 (setq org-self-insert-command-undo-counter 1)
4603 (if (>= org-self-insert-command-undo-counter 20)
4604 (setq org-self-insert-command-undo-counter 1)
4605 (and (> org-self-insert-command-undo-counter 0)
4606 buffer-undo-list
4607 (not (cadr buffer-undo-list)) ; remove nil entry
4608 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4609 (setq org-self-insert-command-undo-counter
4610 (1+ org-self-insert-command-undo-counter))))))))
4612 ;;;###autoload
4614 "Regular expression matching exponentials as produced by calc.")
4616 (defun orgtbl-gather-send-defs ()
4617 "Gather a plist of :name, :transform, :params for each destination before
4618 a radio table."
4619 (save-excursion
4620 (goto-char (org-table-begin))
4621 (let (rtn)
4622 (beginning-of-line 0)
4623 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4624 (let ((name (org-no-properties (match-string 1)))
4625 (transform (intern (match-string 2)))
4626 (params (if (match-end 3)
4627 (read (concat "(" (match-string 3) ")")))))
4628 (push (list :name name :transform transform :params params)
4629 rtn)
4630 (beginning-of-line 0)))
4631 rtn)))
4633 (defun orgtbl-send-replace-tbl (name text)
4634 "Find and replace table NAME with TEXT."
4635 (save-excursion
4636 (goto-char (point-min))
4637 (let* ((location-flag nil)
4638 (name (regexp-quote name))
4641 (while (re-search-forward begin-re nil t)
4642 (unless location-flag (setq location-flag t))
4643 (let ((beg (line-beginning-position 2)))
4644 (unless (re-search-forward end-re nil t)
4645 (user-error "Cannot find end of receiver location at %d" beg))
4646 (beginning-of-line)
4647 (delete-region beg (point))
4649 (unless location-flag
4650 (user-error "No valid receiver location found in the buffer")))))
4652 ;;;###autoload
4653 (defun org-table-to-lisp (&optional txt)
4654 "Convert the table at point to a Lisp structure.
4655 The structure will be a list. Each item is either the symbol `hline'
4656 for a horizontal separator line, or a list of field values as strings.
4657 The table is taken from the parameter TXT, or from the buffer at point."
4658 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4659 (let ((txt (or txt
4660 (buffer-substring-no-properties (org-table-begin)
4661 (org-table-end)))))
4662 (mapcar (lambda (x)
4663 (if (string-match org-table-hline-regexp x) 'hline
4667 (defun orgtbl-send-table (&optional maybe)
4668 "Send a transformed version of table at point to the receiver position.
4669 With argument MAYBE, fail quietly if no transformation is defined
4670 for this table."
4671 (interactive)
4672 (catch 'exit
4673 (unless (org-at-table-p) (user-error "Not at a table"))
4674 ;; when non-interactive, we assume align has just happened.
4675 (when (called-interactively-p 'any) (org-table-align))
4676 (let ((dests (orgtbl-gather-send-defs))
4677 (table (org-table-to-lisp
4678 (buffer-substring-no-properties (org-table-begin)
4679 (org-table-end))))
4680 (ntbl 0))
4681 (unless dests
4682 (if maybe (throw 'exit nil)
4683 (user-error "Don't know how to transform this table")))
4684 (dolist (dest dests)
4685 (let ((name (plist-get dest :name))
4686 (transform (plist-get dest :transform))
4687 (params (plist-get dest :params)))
4688 (unless (fboundp transform)
4689 (user-error "No such transformation function %s" transform))
4690 (orgtbl-send-replace-tbl name (funcall transform table params)))
4691 (cl-incf ntbl))
4692 (message "Table converted and installed at %d receiver location%s"
4693 ntbl (if (> ntbl 1) "s" ""))
4694 (and (> ntbl 0) ntbl))))
4696 (defun org-remove-by-index (list indices &optional i0)
4697 "Remove the elements in LIST with indices in INDICES.
4698 First element has index 0, or I0 if given."
4699 (if (not indices)
4700 list
4701 (if (integerp indices) (setq indices (list indices)))
4702 (setq i0 (1- (or i0 0)))
4703 (delq :rm (mapcar (lambda (x)
4704 (setq i0 (1+ i0))
4705 (if (memq i0 indices) :rm x))
4706 list))))
4708 (defun orgtbl-toggle-comment ()
4709 "Comment or uncomment the orgtbl at point."
4710 (interactive)
4711 (let* ((case-fold-search t)
4712 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4713 (re2 (concat "^" orgtbl-line-start-regexp))
4714 (commented (save-excursion (beginning-of-line 1)
4715 (cond ((looking-at re1) t)
4716 ((looking-at re2) nil)
4717 (t (user-error "Not at an org table")))))
4718 (re (if commented re1 re2))
4719 beg end)
4720 (save-excursion
4721 (beginning-of-line 1)
4722 (while (looking-at re) (beginning-of-line 0))
4723 (beginning-of-line 2)
4724 (setq beg (point))
4725 (while (looking-at re) (beginning-of-line 2))
4726 (setq end (point)))
4727 (comment-region beg end (if commented '(4) nil))))
4729 (defun orgtbl-insert-radio-table ()
4730 "Insert a radio table template appropriate for this major mode."
4731 (interactive)
4732 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4733 (txt (nth 1 e))
4734 name pos)
4735 (unless e (user-error "No radio table setup defined for %s" major-mode))
4736 (setq name (read-string "Table name: "))
4737 (while (string-match "%n" txt)
4738 (setq txt (replace-match name t t txt)))
4740 (setq pos (point))
4741 (insert txt)
4742 (goto-char pos)))
4744 ;;;###autoload
4745 (defun orgtbl-to-generic (table params)
4746 "Convert the orgtbl-mode TABLE to some other format.
4748 This generic routine can be used for many standard cases.
4750 TABLE is a list, each entry either the symbol `hline' for
4751 a horizontal separator line, or a list of fields for that
4752 line. PARAMS is a property list of parameters that can
4753 influence the conversion.
4755 Valid parameters are:
4757 :backend, :raw
4759 Export back-end used as a basis to transcode elements of the
4760 table, when no specific parameter applies to it. It is also
4761 used to translate cells contents. You can prevent this by
4762 setting :raw property to a non-nil value.
4764 :splice
4766 When non-nil, only convert rows, not the table itself. This is
4767 equivalent to setting to the empty string both :tstart
4768 and :tend, which see.
4770 :skip
4772 When set to an integer N, skip the first N lines of the table.
4773 Horizontal separation lines do count for this parameter!
4775 :skipcols
4777 List of columns that should be skipped. If the table has
4778 a column with calculation marks, that column is automatically
4779 discarded beforehand.
4781 :hline
4783 String to be inserted on horizontal separation lines. May be
4784 nil to ignore these lines altogether.
4786 :sep
4788 Separator between two fields, as a string.
4790 Each in the following group may be either a string or a function
4791 of no arguments returning a string:
4793 :tstart, :tend
4795 Strings to start and end the table. Ignored when :splice is t.
4797 :lstart, :lend
4799 Strings to start and end a new table line.
4801 :llstart, :llend
4803 Strings to start and end the last table line. Default,
4804 respectively, to :lstart and :lend.
4806 Each in the following group may be a string or a function of one
4807 argument (either the cells in the current row, as a list of
4808 strings, or the current cell) returning a string:
4810 :lfmt
4812 Format string for an entire row, with enough %s to capture all
4813 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4815 :llfmt
4817 Format for the entire last line, defaults to :lfmt.
4819 :fmt
4821 A format to be used to wrap the field, should contain %s for
4822 the original field value. For example, to wrap everything in
4824 a property list with column numbers and format strings, or
4825 functions, e.g.,
4829 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4831 Same as above, specific for the header lines in the table.
4832 All lines before the first hline are treated as header. If
4833 any of these is not present, the data line value is used.
4835 This may be either a string or a function of two arguments:
4837 :efmt
4839 Use this format to print numbers with exponential. The format
4840 should have %s twice for inserting mantissa and exponent, for
4842 list with column numbers and format strings or functions.
4843 :fmt will still be applied after :efmt."
4844 ;; Make sure `org-export-create-backend' is available.
4845 (require 'ox)
4846 (let* ((backend (plist-get params :backend))
4847 (custom-backend
4848 ;; Build a custom back-end according to PARAMS. Before
4849 ;; defining a translator, check if there is anything to do.
4850 ;; When there isn't, let BACKEND handle the element.
4851 (org-export-create-backend
4852 :parent (or backend 'org)
4853 :transcoders
4854 `((table . ,(org-table--to-generic-table params))
4855 (table-row . ,(org-table--to-generic-row params))
4856 (table-cell . ,(org-table--to-generic-cell params))
4857 ;; Macros are not going to be expanded. However, no
4858 ;; regular back-end has a transcoder for them. We
4859 ;; provide one so they are not ignored, but displayed
4860 ;; as-is instead.
4861 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4862 data info)
4863 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4864 ;; Initialize communication channel in INFO.
4865 (with-temp-buffer
4866 (let ((org-inhibit-startup t)) (org-mode))
4867 (let ((standard-output (current-buffer)))
4868 (dolist (e table)
4870 ((consp e)
4871 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4873 ;; Add back-end specific filters, but not user-defined ones. In
4874 ;; particular, make sure to call parse-tree filters on the
4875 ;; table.
4876 (setq info
4877 (let ((org-export-filters-alist nil))
4878 (org-export-install-filters
4879 (org-combine-plists
4880 (org-export-get-environment backend nil params)
4881 `(:back-end ,(org-export-get-backend backend))))))
4882 (setq data
4883 (org-export-filter-apply-functions
4884 (plist-get info :filter-parse-tree)
4885 (org-element-map (org-element-parse-buffer) 'table
4886 #'identity nil t)
4887 info)))
4888 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4889 (user-error "Unknown :backend value"))
4890 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4891 ;; Handle :skip parameter.
4892 (let ((skip (plist-get info :skip)))
4893 (when skip
4894 (unless (wholenump skip) (user-error "Wrong :skip value"))
4895 (let ((n 0))
4896 (org-element-map data 'table-row
4897 (lambda (row)
4898 (if (>= n skip) t
4899 (org-element-extract-element row)
4900 (cl-incf n)
4901 nil))
4902 nil t))))
4903 ;; Handle :skipcols parameter.
4904 (let ((skipcols (plist-get info :skipcols)))
4905 (when skipcols
4906 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4907 (org-element-map data 'table
4908 (lambda (table)
4909 (let ((specialp (org-export-table-has-special-column-p table)))
4910 (dolist (row (org-element-contents table))
4911 (when (eq (org-element-property :type row) 'standard)
4912 (let ((c 1))
4913 (dolist (cell (nthcdr (if specialp 1 0)
4914 (org-element-contents row)))
4915 (when (memq c skipcols)
4916 (org-element-extract-element cell))
4917 (cl-incf c))))))))))
4918 ;; Since we are going to export using a low-level mechanism,
4919 ;; ignore special column and special rows manually.
4920 (let ((special? (org-export-table-has-special-column-p data))
4921 ignore)
4922 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4923 (lambda (datum)
4924 (when (if (eq (org-element-type datum) 'table-row)
4925 (org-export-table-row-is-special-p datum nil)
4926 (org-export-first-sibling-p datum nil))
4927 (push datum ignore))))
4928 (setq info (plist-put info :ignore-list ignore)))
4929 ;; We use a low-level mechanism to export DATA so as to skip all
4930 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4931 ;; code evaluation, include keywords and macro expansion. Only
4932 ;; back-end specific filters are retained.
4933 (let ((output (org-export-data-with-backend data custom-backend info)))
4934 ;; Remove final newline.
4935 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4937 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4938 (cond ((null value) nil)
4939 ((functionp value) `(funcall ',value ,@args))
4940 ((stringp value)
4941 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4942 (args `(format ,value ,@args))
4943 (t value)))
4944 ((and with-cons (consp value))
4945 `(let ((val (cadr (memq column ',value))))
4946 (cond ((null val) contents)
4947 ((stringp val) (format val ,@args))
4948 ((functionp val) (funcall val ,@args))
4949 (t (user-error "Wrong %s value" ,name)))))
4950 (t (user-error "Wrong %s value" name))))
4952 (defun org-table--to-generic-table (params)
4953 "Return custom table transcoder according to PARAMS.
4954 PARAMS is a plist. See `orgtbl-to-generic' for more
4955 information."
4956 (let ((backend (plist-get params :backend))
4957 (splice (plist-get params :splice))
4958 (tstart (plist-get params :tstart))
4959 (tend (plist-get params :tend)))
4960 `(lambda (table contents info)
4961 (concat
4962 ,(and tstart (not splice)
4964 ,(if (or (not backend) tstart tend splice) 'contents
4965 `(org-export-with-backend ',backend table contents info))
4966 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4968 (defun org-table--to-generic-row (params)
4969 "Return custom table row transcoder according to PARAMS.
4970 PARAMS is a plist. See `orgtbl-to-generic' for more
4971 information."
4972 (let* ((backend (plist-get params :backend))
4973 (lstart (plist-get params :lstart))
4974 (llstart (plist-get params :llstart))
4975 (hlstart (plist-get params :hlstart))
4976 (hllstart (plist-get params :hllstart))
4977 (lend (plist-get params :lend))
4978 (llend (plist-get params :llend))
4979 (hlend (plist-get params :hlend))
4980 (hllend (plist-get params :hllend))
4981 (lfmt (plist-get params :lfmt))
4982 (llfmt (plist-get params :llfmt))
4983 (hlfmt (plist-get params :hlfmt))
4984 (hllfmt (plist-get params :hllfmt)))
4985 `(lambda (row contents info)
4986 (if (eq (org-element-property :type row) 'rule)
4987 ,(cond
4988 ((plist-member params :hline)
4989 (org-table--generic-apply (plist-get params :hline) ":hline"))
4990 (backend `(org-export-with-backend ',backend row nil info)))
4991 (let ((headerp (org-export-table-row-in-header-p row info))
4992 (lastp (not (org-export-get-next-element row info)))
4993 (last-header-p (org-export-table-row-ends-header-p row info)))
4994 (when contents
4995 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4996 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4997 ;; `:lstart', `:lend' and their relatives.
4998 ,(let ((cells
4999 '(org-element-map row 'table-cell
5000 (lambda (cell)
5001 ;; Export all cells, without separators.
5002 ;;
5003 ;; Use `org-export-data-with-backend'
5004 ;; instead of `org-export-data' to eschew
5005 ;; cached values, which
5006 ;; ignore :orgtbl-ignore-sep parameter.
5007 (org-export-data-with-backend
5008 cell
5009 (plist-get info :back-end)
5010 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5011 info)))
5012 `(cond
5013 ,(and hllfmt
5014 `(last-header-p ,(org-table--generic-apply
5015 hllfmt ":hllfmt" nil cells)))
5016 ,(and hlfmt
5017 `(headerp ,(org-table--generic-apply
5018 hlfmt ":hlfmt" nil cells)))
5019 ,(and llfmt
5020 `(lastp ,(org-table--generic-apply
5021 llfmt ":llfmt" nil cells)))
5022 (t
5023 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5024 `(concat
5025 (cond
5026 ,(and
5027 (or hllstart hllend)
5028 `(last-header-p
5029 (concat
5030 ,(org-table--generic-apply hllstart ":hllstart")
5031 contents
5032 ,(org-table--generic-apply hllend ":hllend"))))
5033 ,(and
5034 (or hlstart hlend)
5035 `(headerp
5036 (concat
5037 ,(org-table--generic-apply hlstart ":hlstart")
5038 contents
5039 ,(org-table--generic-apply hlend ":hlend"))))
5040 ,(and
5041 (or llstart llend)
5042 `(lastp
5043 (concat
5044 ,(org-table--generic-apply llstart ":llstart")
5045 contents
5046 ,(org-table--generic-apply llend ":llend"))))
5047 (t
5048 ,(cond
5049 ((or lstart lend)
5050 `(concat
5051 ,(org-table--generic-apply lstart ":lstart")
5052 contents
5053 ,(org-table--generic-apply lend ":lend")))
5054 (backend
5055 `(org-export-with-backend
5056 ',backend row contents info))
5057 (t 'contents)))))))))))))))
5059 (defun org-table--to-generic-cell (params)
5060 "Return custom table cell transcoder according to PARAMS.
5061 PARAMS is a plist. See `orgtbl-to-generic' for more
5062 information."
5063 (let* ((backend (plist-get params :backend))
5064 (efmt (plist-get params :efmt))
5065 (fmt (plist-get params :fmt))
5066 (hfmt (plist-get params :hfmt))
5067 (sep (plist-get params :sep))
5068 (hsep (plist-get params :hsep)))
5069 `(lambda (cell contents info)
5070 (let ((headerp (org-export-table-row-in-header-p
5071 (org-export-get-parent-element cell) info))
5072 (column (1+ (cdr (org-export-table-cell-address cell info)))))
5073 ;; Make sure that contents are exported as Org data when :raw
5074 ;; parameter is non-nil.
5075 ,(when (and backend (plist-get params :raw))
5076 `(setq contents
5077 ;; Since we don't know what are the pseudo object
5078 ;; types defined in backend, we cannot pass them to
5079 ;; `org-element-interpret-data'. As a consequence,
5080 ;; they will be treated as pseudo elements, and
5081 ;; will have newlines appended instead of spaces.
5082 ;; Therefore, we must make sure :post-blank value
5083 ;; is really turned into spaces.
5084 (replace-regexp-in-string
5086 (org-trim
5087 (org-element-interpret-data
5088 (org-element-contents cell))))))
5089 (when contents
5090 ;; Check if we can apply `:efmt' on CONTENTS.
5091 ,(when efmt
5092 `(when (string-match orgtbl-exp-regexp contents)
5093 (let ((mantissa (match-string 1 contents))
5094 (exponent (match-string 2 contents)))
5095 (setq contents ,(org-table--generic-apply
5096 efmt ":efmt" t 'mantissa 'exponent)))))
5097 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5098 (cond
5099 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5100 hfmt ":hfmt" t 'contents))))
5101 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5102 fmt ":fmt" t 'contents))))))
5103 ;; If a separator is provided, use it instead of BACKEND's.
5104 ;; Separators are ignored when LFMT (or equivalent) is
5105 ;; provided.
5106 ,(cond
5107 ((or hsep sep)
5108 `(if (or ,(and (not sep) '(not headerp))
5109 (plist-get info :orgtbl-ignore-sep)
5110 (not (org-export-get-next-element cell info)))
5111 ,(if (not backend) 'contents
5112 `(org-export-with-backend ',backend cell contents info))
5113 (concat contents
5114 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5115 (or hsep sep)))))
5116 (backend `(org-export-with-backend ',backend cell contents info))
5117 (t 'contents))))))
5119 ;;;###autoload
5120 (defun orgtbl-to-tsv (table params)
5121 "Convert the orgtbl-mode table to TAB separated material."
5124 ;;;###autoload
5125 (defun orgtbl-to-csv (table params)
5126 "Convert the orgtbl-mode table to CSV material.
5127 This does take care of the proper quoting of fields with comma or quotes."
5128 (orgtbl-to-generic table
5129 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5130 params)))
5132 ;;;###autoload
5133 (defun orgtbl-to-latex (table params)
5134 "Convert the orgtbl-mode TABLE to LaTeX.
5136 TABLE is a list, each entry either the symbol `hline' for
5137 a horizontal separator line, or a list of fields for that line.
5138 PARAMS is a property list of parameters that can influence the
5139 conversion. All parameters from `orgtbl-to-generic' are
5140 supported. It is also possible to use the following ones:
5142 :booktabs
5146 :environment
5148 Specify environment to use, as a string. If you use
5150 as a string, to get proper continuation strings."
5151 (require 'ox-latex)
5152 (orgtbl-to-generic
5153 table
5154 (org-combine-plists
5155 ;; Provide sane default values.
5156 (list :backend 'latex
5157 :latex-default-table-mode 'table
5158 :latex-tables-centered nil
5159 :latex-tables-booktabs (plist-get params :booktabs)
5160 :latex-table-scientific-notation nil
5161 :latex-default-table-environment
5162 (or (plist-get params :environment) "tabular"))
5163 params)))
5165 ;;;###autoload
5166 (defun orgtbl-to-html (table params)
5167 "Convert the orgtbl-mode TABLE to HTML.
5169 TABLE is a list, each entry either the symbol `hline' for
5170 a horizontal separator line, or a list of fields for that line.
5171 PARAMS is a property list of parameters that can influence the
5172 conversion. All parameters from `orgtbl-to-generic' are
5173 supported. It is also possible to use the following one:
5175 :attributes
5177 Attributes and values, as a plist, which will be used in
5178 <table> tag."
5179 (require 'ox-html)
5180 (orgtbl-to-generic
5181 table
5182 (org-combine-plists
5183 ;; Provide sane default values.
5184 (list :backend 'html
5185 :html-table-data-tags '("<td%s>" . "</td>")
5186 :html-table-use-header-tags-for-first-column nil
5187 :html-table-align-individual-fields t
5188 :html-table-row-tags '("<tr>" . "</tr>")
5189 :html-table-attributes
5190 (if (plist-member params :attributes)
5191 (plist-get params :attributes)
5192 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5193 :frame "hsides")))
5194 params)))
5196 ;;;###autoload
5197 (defun orgtbl-to-texinfo (table params)
5198 "Convert the orgtbl-mode TABLE to Texinfo.
5200 TABLE is a list, each entry either the symbol `hline' for
5201 a horizontal separator line, or a list of fields for that line.
5202 PARAMS is a property list of parameters that can influence the
5203 conversion. All parameters from `orgtbl-to-generic' are
5204 supported. It is also possible to use the following one:
5206 :columns
5208 Column widths, as a string. When providing column fractions,
5210 (require 'ox-texinfo)
5211 (let ((output
5212 (orgtbl-to-generic
5213 table
5214 (org-combine-plists
5215 (list :backend 'texinfo
5216 :texinfo-tables-verbatim nil
5217 :texinfo-table-scientific-notation nil)
5218 params)))
5219 (columns (let ((w (plist-get params :columns)))
5220 (cond ((not w) nil)
5222 (t (concat "@columnfractions " w))))))
5223 (if (not columns) output
5224 (replace-regexp-in-string
5227 ;;;###autoload
5228 (defun orgtbl-to-orgtbl (table params)
5229 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5231 TABLE is a list, each entry either the symbol `hline' for
5232 a horizontal separator line, or a list of fields for that line.
5233 PARAMS is a property list of parameters that can influence the
5234 conversion. All parameters from `orgtbl-to-generic' are
5235 supported.
5237 Useful when slicing one table into many. The :hline, :sep,
5238 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5239 be set to provide ORGTBL directives for the generated table."
5240 (require 'ox-org)
5241 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5243 (defun orgtbl-to-table.el (table params)
5244 "Convert the orgtbl-mode TABLE into a table.el table.
5245 TABLE is a list, each entry either the symbol `hline' for
5246 a horizontal separator line, or a list of fields for that line.
5247 PARAMS is a property list of parameters that can influence the
5248 conversion. All parameters from `orgtbl-to-generic' are
5249 supported."
5250 (with-temp-buffer
5251 (insert (orgtbl-to-orgtbl table params))
5252 (org-table-align)
5253 (replace-regexp-in-string
5254 "-|" "-+"
5255 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5257 (defun orgtbl-to-unicode (table params)
5258 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5260 TABLE is a list, each entry either the symbol `hline' for
5261 a horizontal separator line, or a list of fields for that line.
5262 PARAMS is a property list of parameters that can influence the
5263 conversion. All parameters from `orgtbl-to-generic' are
5264 supported. It is also possible to use the following ones:
5266 :ascii-art
5269 the table. You can download it here:
5270 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5272 :narrow
5274 When non-nil, narrow columns width than provided width cookie,
5276 (require 'ox-ascii)
5277 (orgtbl-to-generic
5278 table
5279 (org-combine-plists
5280 (list :backend 'ascii
5281 :ascii-charset 'utf-8
5282 :ascii-table-widen-columns (not (plist-get params :narrow))
5283 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5284 params)))
5286 ;; Put the cursor in a column containing numerical values
5287 ;; of an Org table,
5288 ;; type C-c " a
5289 ;; A new column is added with a bar plot.
5290 ;; When the table is refreshed (C-u C-c *),
5291 ;; the plot is updated to reflect the new values.
5293 (defun orgtbl-ascii-draw (value min max &optional width characters)
5294 "Draw an ascii bar in a table.
5295 VALUE is the value to plot, it determines the width of the bar to draw.
5296 MIN is the value that will be displayed as empty (zero width bar).
5297 MAX is the value that will draw a bar filling all the WIDTH.
5298 WIDTH is the span in characters from MIN to MAX.
5299 CHARACTERS is a string that will compose the bar, with shades of grey
5300 from pure white to pure black. It defaults to a 10 characters string
5301 of regular ascii characters."
5302 (let* ((width (ceiling (or width 12)))
5303 (characters (or characters " .:;c!lhVHW"))
5304 (len (1- (length characters)))
5305 (value (float (if (numberp value)
5306 value (string-to-number value))))
5307 (relative (/ (- value min) (- max min)))
5308 (steps (round (* relative width len))))
5309 (cond ((< steps 0) "too small")
5310 ((> steps (* width len)) "too large")
5311 (t (let* ((int-division (/ steps len))
5312 (remainder (- steps (* int-division len))))
5313 (concat (make-string int-division (elt characters len))
5314 (string (elt characters remainder))))))))
5316 ;;;###autoload
5317 (defun orgtbl-ascii-plot (&optional ask)
5318 "Draw an ASCII bar plot in a column.
5320 With cursor in a column containing numerical values, this function
5321 will draw a plot in a new column.
5323 ASK, if given, is a numeric prefix to override the default 12
5325 prefix,
5326 which will prompt for the width."
5327 (interactive "P")
5328 (let ((col (org-table-current-column))
5329 (min 1e999) ; 1e999 will be converted to infinity
5330 (max -1e999) ; which is the desired result
5331 (table (org-table-to-lisp))
5332 (length
5333 (cond ((consp ask)
5334 (read-number "Length of column " 12))
5335 ((numberp ask) ask)
5336 (t 12))))
5337 ;; Skip any hline a the top of table.
5338 (while (eq (car table) 'hline) (setq table (cdr table)))
5339 ;; Skip table header if any.
5340 (dolist (x (or (cdr (memq 'hline table)) table))
5341 (when (consp x)
5342 (setq x (nth (1- col) x))
5343 (when (string-match
5345 x)
5346 (setq x (string-to-number x))
5347 (when (> min x) (setq min x))
5348 (when (< max x) (setq max x)))))
5349 (org-table-insert-column)
5350 (org-table-move-column-right)
5351 (org-table-store-formulas
5352 (cons
5353 (cons
5354 (concat "$" (number-to-string (1+ col)))
5355 (format "'(%s $%s %s %s %s)"
5356 "orgtbl-ascii-draw" col min max length))
5357 (org-table-get-stored-formulas)))
5358 (org-table-recalculate t)))
5360 ;; Example of extension: unicode characters
5361 ;; Here are two examples of different styles.
5363 ;; Unicode block characters are used to give a smooth effect.
5364 ;; See http://en.wikipedia.org/wiki/Block_Elements
5365 ;; Use one of those drawing functions
5366 ;; - orgtbl-ascii-draw (the default ascii)
5367 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5368 ;; - orgtbl-uc-draw-cont (smooth unicode)
5370 ;; This is best viewed with the "DejaVu Sans Mono" font
5371 ;; (use M-x set-default-font).
5373 (defun orgtbl-uc-draw-grid (value min max &optional width)
5374 "Draw a bar in a table using block unicode characters.
5375 It is a variant of orgtbl-ascii-draw with Unicode block
5376 characters, for a smooth display. Bars appear as grids (to the
5377 extent the font allows)."
5378 ;; http://en.wikipedia.org/wiki/Block_Elements
5379 ;; best viewed with the "DejaVu Sans Mono" font.
5380 (orgtbl-ascii-draw value min max width
5383 (defun orgtbl-uc-draw-cont (value min max &optional width)
5384 "Draw a bar in a table using block unicode characters.
5385 It is a variant of orgtbl-ascii-draw with Unicode block
5386 characters, for a smooth display. Bars are solid (to the extent
5387 the font allows)."
5388 (orgtbl-ascii-draw value min max width
5391 (defun org-table-get-remote-range (name-or-id form)
5392 "Get a field value or a list of values in a range from table at ID.
5394 NAME-OR-ID may be the name of a table in the current file as set
5396 will then be used. Alternatively, it may be an ID referring to
5397 any entry, also in a different file. In this case, the first
5398 table in that entry will be referenced.
5402 The return value is either a single string for a single field, or a
5403 list of the fields in the rectangle."
5404 (save-match-data
5405 (let ((case-fold-search t) (id-loc nil)
5406 ;; Protect a bunch of variables from being overwritten by
5407 ;; the context of the remote table.
5408 org-table-column-names org-table-column-name-regexp
5409 org-table-local-parameters org-table-named-field-locations
5410 org-table-current-line-types
5411 org-table-current-begin-pos org-table-dlines
5412 org-table-current-ncol
5413 org-table-hlines org-table-last-alignment
5414 org-table-last-column-widths org-table-last-alignment
5415 org-table-last-column-widths
5416 buffer loc)
5417 (setq form (org-table-convert-refs-to-rc form))
5418 (org-with-wide-buffer
5419 (goto-char (point-min))
5420 (if (re-search-forward
5423 nil t)
5424 (setq buffer (current-buffer) loc (match-beginning 0))
5425 (setq id-loc (org-id-find name-or-id 'marker))
5426 (unless (and id-loc (markerp id-loc))
5428 (setq buffer (marker-buffer id-loc)
5429 loc (marker-position id-loc))
5430 (move-marker id-loc nil))
5431 (with-current-buffer buffer
5432 (org-with-wide-buffer
5433 (goto-char loc)
5434 (forward-char 1)
5436 (not (match-beginning 1)))
5437 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5438 (org-table-analyze)
5439 (setq form (org-table-formula-substitute-names
5440 (org-table-formula-handle-first/last-rc form)))
5441 (if (and (string-match org-table-range-regexp form)
5442 (> (length (match-string 0 form)) 1))
5443 (org-table-get-range
5444 (match-string 0 form) org-table-current-begin-pos 1)
5445 form)))))))
5447 (defun org-table-remote-reference-indirection (form)
5448 "Return formula with table remote references substituted by indirection.
5450 This indirection works only with the format @ROW$COLUMN. The
5452 distinguished from a plain table name or ID."
5453 (let ((regexp
5454 ;; Same as in `org-table-eval-formula'.
5456 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5459 (replace-regexp-in-string
5460 regexp
5461 (lambda (m)
5462 (save-match-data
5463 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5464 (org-table-get-range
5466 (concat "@0" eq)
5467 eq)))))
5468 form t t 1)))
5470 (defmacro org-define-lookup-function (mode)
5471 (let ((mode-str (symbol-name mode))
5472 (first-p (eq mode 'first))
5473 (all-p (eq mode 'all)))
5474 (let ((plural-str (if all-p "s" "")))
5475 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5476 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5477 If R-LIST is nil, return matching element%s of S-LIST.
5478 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5479 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5480 This function is generated by a call to the macro `org-define-lookup-function'."
5481 mode-str plural-str plural-str plural-str)
5482 (let ,(let ((lvars '((p (or predicate 'equal))
5483 (sl s-list)
5484 (rl (or r-list s-list))
5485 (ret nil))))
5486 (if first-p (cons '(match-p nil) lvars) lvars))
5487 (while ,(if first-p '(and (not match-p) sl) 'sl)
5488 (when (funcall p val (car sl))
5489 ,(when first-p '(setq match-p t))
5490 (let ((rval (car rl)))
5491 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5492 (setq sl (cdr sl) rl (cdr rl)))
5493 ret)))))
5495 (org-define-lookup-function first)
5496 (org-define-lookup-function last)
5497 (org-define-lookup-function all)
5499 (provide 'org-table)
5501 ;; Local variables:
5502 ;; generated-autoload-file: "org-loaddefs.el"
5503 ;; End:
5505 ;;; org-table.el ends here