| blob | bd396e35f22209b49137dad140b839960f3da8b7 |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
77 "Hook for functions attaching to `C-c C-c', if the table is sent.
78 This can be used to add additional functionality after the table is sent
79 to the receiver position, otherwise, if table is not sent, the functions
85 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
87 In the optimized version, the table editor takes over all simple keys that
88 normally just insert a character. In tables, the characters are inserted
89 in a way to minimize disturbing the table structure (i.e. in overwrite mode
90 for empty fields). Outside tables, the correct binding of the keys is
91 restored.
93 Changing this variable requires a restart of Emacs to become
94 effective."
100 % END RECEIVE ORGTBL %n
102 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
103 | | |
106 @c END RECEIVE ORGTBL %n
107 @ignore
108 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
109 | | |
112 <!-- END RECEIVE ORGTBL %n -->
113 <!--
114 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
115 | | |
118 #+ END RECEIVE ORGTBL %n
120 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
121 | | |
123 "Templates for radio tables in different major modes.
124 Each template must define lines that will be treated as a comment and that
127 insertion of the template. The transformed table will later be inserted
128 between these lines.
130 The template should also contain a minimal table in a multiline comment.
131 If multiline comments are not possible in the buffer language,
132 you can pack it into a string that will not be used when the code
133 is compiled or executed. Above the table will you need a line with
135 convert the table into a data structure useful in the
136 language of the buffer. Check the manual for the section on
138 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
140 All occurrences of %n in a template will be replaced with the name of the
141 table, obtained by prompting the user."
148 "Settings for tables in Org mode."
153 "The default size for newly created tables, Columns x Rows."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
159 "Regular expression for recognizing numbers in table columns.
160 If a table column contains mostly numbers, it will be aligned to the
161 right. If not, it will be aligned to the left.
163 The default value of this option is a regular expression which allows
164 anything which looks remotely like a number as used in scientific
165 context. For example, all of the following will be considered a
166 number:
167 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
169 Other options offered by the customize interface are more restrictive."
183 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
184 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
185 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
189 "Fraction of numbers in a column required to make the column align right.
190 In a column all non-white fields are considered. If at least
191 this fraction of fields is matched by `org-table-number-regexp',
192 alignment to the right border applies."
197 "Behavior of tables during editing in Org mode."
202 "Non-nil means automatically re-align table when pressing TAB or RETURN.
204 removal/insertion."
209 "Non-nil means automatically blank table field when starting to type into it.
210 This only happens when typing immediately after a field motion
211 command (TAB, S-TAB or RET)."
216 "Non-nil means automatically exit the follow mode.
217 When nil, the follow mode will stay on and be active in any table
218 the cursor enters. Since the table follow filed mode messes with the
219 window configuration, it is not recommended to set this variable to nil,
220 except maybe locally in a special file that has mostly tables with long
221 fields."
227 "Whether the user should confirm when Org fixes formulas."
235 'safe-local-variable
239 "Non-nil means tab in the last column of a table with jump over a hline.
240 If a horizontal separator line is following the current line,
241 `org-table-next-field' can either create a new row before that line, or jump
242 over the line. When this option is nil, a new line will be created before
243 this line."
248 "Options concerning tables in Org mode."
253 "Non-nil means using table references like B3 instead of @3$2.
254 Possible values are:
255 nil never use them
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
265 "Non-nil means increment when copying current field with \
278 calc-angle-mode deg
279 calc-prefer-frac nil
280 calc-symbolic-mode nil
282 calc-display-working-message t
283 )
284 "List with Calc mode settings for use in `calc-eval' for table formulas.
285 The list must contain alternating symbols (Calc modes variables and values).
286 Don't remove any of the default settings, just change the values. Org mode
287 relies on the variables to be present in the list."
292 "Format for the output of calc computations like $1+$2;t.
293 The default value is `hours', and will output the results as a
294 number of hours. Other allowed values are `seconds', `minutes' and
295 `days', and the output will be a fraction of seconds, minutes or
296 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
297 The `U' flag in a table formula will select this specific format for
298 a single formula."
308 "Non-nil means hours in table duration computations should be zero-padded.
309 So this is about 08:32:34 versus 8:33:34."
317 "Format for fields which contain the result of a formula.
319 characters. Beware that modifying the display can prevent the
320 field from being used in another formula."
326 "Non-nil means TAB and RET evaluate a formula in current table field.
327 If the current field starts with an equal sign, it is assumed to be a formula
328 which should be evaluated as described in the manual and in the documentation
329 string of the command `org-table-eval-formula'. This feature requires the
330 Emacs calc package.
331 When this variable is nil, formula calculation is only available through
337 "Non-nil means interpret constants in formulas in tables.
338 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
339 by the value given in `org-table-formula-constants', or by a value obtained
340 from the `constants.el' package."
345 "Alist with constant names and values, for use in table formulas.
346 The car of each element is a name of a constant, without the `$' before it.
347 The cdr is the value as a string. For example, if you'd like to use the
348 speed of light in a formula, you would configure
352 and then use it in an equation like `$1*$c'.
354 Constants can also be defined on a per-file basis using a line like
356 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
363 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
366 are pressed in the line."
371 "Non-nil means relative formula references may cross hlines.
372 Here are the allowed values:
374 nil Relative references may not cross hlines. They will reference the
375 field next to the hline instead. Coming from below, the reference
376 will be to the field below the hline. Coming from above, it will be
377 to the field above.
378 t Relative references may cross hlines.
379 error An attempt to cross a hline will throw an error.
381 It is probably good to never set this variable to nil, for the sake of
382 portability of tables."
390 "Non-nil means that evaluation of a field formula can add new
391 columns if an out-of-bounds field is being set."
398 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
402 "Options concerning table import and export in Org mode."
407 "Default export parameters for `org-table-export'.
408 These can be overridden for a specific table by setting the
409 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
410 radio tables for the different export transformations and
411 available parameters."
416 "Max lines that `org-table-convert-region' will attempt to process.
418 The function can be slow on larger regions; this safety feature
419 prevents it from hanging emacs."
442 "Alist with column names, derived from the `!' line.
446 "Regular expression matching the current column names.
450 "Alist with parameter names, derived from the `$' line.
454 "Alist with locations of named fields.
455 Associations follow the pattern (NAME LINE COLUMN) where
456 NAME is the name of the field as a string,
457 LINE is the number of lines from the beginning of the table,
458 COLUMN is the column of the field, as an integer.
462 "Table row types in current table.
466 "Current table begin position, as a marker.
470 "Number of columns in current table.
474 "Vector of data line line numbers in the current table.
475 Line numbers are counted from the beginning of the table. This
479 "Vector of hline line numbers in the current table.
480 Line numbers are counted from the beginning of the table. This
484 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
485 ;; 1 2 3 4 5
500 "Save current field; execute BODY; restore field.
501 Field is restored even in case of abnormal exit."
512 ;;;###autoload
514 "Use the table.el package to insert a new table.
515 If there is already a table at point, convert between Org tables
516 and table.el tables."
529 ;;;###autoload
531 "Convert region to table, or create an empty table.
532 If there is an active region, convert it to a table, using the function
533 `org-table-convert-region'. See the documentation of that function
534 to learn how the prefix argument is interpreted to determine the field
535 separator.
536 If there is no such region, create an empty table with `org-table-create'."
542 ;;;###autoload
544 "Query for a size and insert a table skeleton.
564 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
568 ;; Insert a hline after the first row.
575 ;;;###autoload
577 "Convert region to a table.
579 The region goes from BEG0 to END0, but these borders will be moved
580 slightly, to make sure a beginning of line in the first line is included.
582 SEPARATOR specifies the field separator in the lines. It can have the
583 following values:
585 (4) Use the comma as a field separator
586 (16) Use a TAB as field separator
587 (64) Prompt for a regular expression as field separator
588 integer When a number, use that many spaces, or a TAB, as field separator
589 regexp When a regular expression, use it to match the separator
590 nil When nil, the command tries to be smart and figure out the
591 separator in the following way:
592 - when each line contains a TAB, assume TAB-separated material
593 - when each line contains a comma, assume CSV material
594 - else, assume one or more SPACE characters as separator."
598 re)
600 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
601 org-table-convert-region-max-lines)
610 ;; Get the right field separator
621 ;; parse the csv stuff
646 ;;;###autoload
648 "Import FILE as a table.
649 The file is assumed to be tab-separated. Such files can be produced by most
650 spreadsheet and database applications. If no tabs (at least one per line)
651 are found, lines will be split on whitespace into fields."
660 ;;;###autoload
662 "Export table to a file, with configurable format.
663 Such a file can be imported into usual spreadsheet programs.
665 FILE can be the output file name. If not given, it will be taken
666 from a TABLE_EXPORT_FILE property in the current entry or higher
667 up in the hierarchy, or the user will be prompted for a file
668 name. FORMAT can be an export format, of the same kind as it
669 used when `orgtbl-mode' sends a table in a different format.
671 The command suggests a format depending on TABLE_EXPORT_FORMAT,
672 whether it is set locally or up in the hierarchy, then on the
673 extension of the given file name, and finally on the variable
674 `org-table-export-default-format'."
707 formats)))
708 org-table-export-default-format)
734 "Marker at the beginning of the table last aligned.
737 "Marker at the end of the table last aligned.
740 "List of flags for flushright alignment, from the last re-alignment.
743 "List of max width of fields in each column.
746 "Non-nil means debug table formulas.
756 ;;;###autoload
758 "Align the table at point by aligning all vertical bars."
763 ;; Make sure invisible characters in the table are at the right
764 ;; place since column widths take them into account.
770 ;; Table's rows. Separators are replaced by nil. Trailing
771 ;; spaces are also removed.
777 l)))
779 ;; Get the data fields by splitting the lines.
782 ;; Compute number of fields in the longest line. If the
783 ;; table contains no field, create a default table.
788 ;; A list of empty strings to fill any short rows on output.
790 lengths typenums)
791 ;; Check for special formatting.
794 fmax falign)
795 ;; Look for an explicit width or alignment.
808 ;; Find fields that are wider than FMAX, and shorten them.
813 'help-echo
821 fmax)))
835 f2
837 x))))))
838 ;; Get the maximum width for each column
840 lengths)
841 ;; Get the fraction of numbers among non-empty cells to
842 ;; decide about alignment of the column.
851 1
857 ;; Store alignment of this table, for later editing of single
858 ;; fields.
861 ;; With invisible characters, `format' does not get the field
862 ;; width right So we need to make these fields wide by hand.
863 ;; Invisible characters may be introduced by fontified links,
864 ;; emphasis, macros or sub/superscripts.
882 ;; Compute the formats needed for output of the table.
891 ;; Replace modified lines only. Check not only contents, but
892 ;; also columns' width.
896 hfmt))
918 ;;;###autoload
920 "Find the beginning of the table and return its position.
921 With a non-nil optional argument TABLE-TYPE, return the beginning
922 of a table.el-type table. This function assumes point is on
923 a table."
931 ;;;###autoload
933 "Find the end of the table and return its position.
934 With a non-nil optional argument TABLE-TYPE, return the end of
935 a table.el-type table. This function assumes point is on
936 a table."
944 ;; When the line right after the table is the last line in
945 ;; the buffer with trailing spaces but no final newline
946 ;; character, be sure to catch the correct ending at its
947 ;; beginning. In any other case, ending is expected to be
948 ;; at point max.
953 ;;;###autoload
955 "Justify the current field, text to left, number to right.
956 Optional argument NEW may specify text to replace the current field content."
965 ;; This is not the same table, force a full re-align.
968 ;; Realign the current field, based on previous full realign.
981 len
996 ;;;###autoload
998 "Go to the next field in the current table, creating new lines as needed.
999 Before doing so, re-align the table if necessary."
1004 org-table-may-need-update)
1015 org-table-tab-jumps-over-hlines
1026 ;;;###autoload
1028 "Go to the previous field in the table.
1029 Before doing so, re-align the table if necessary."
1034 org-table-may-need-update)
1052 "Move to the beginning of the current table field.
1053 If already at or before the beginning, move to the beginning of the
1054 previous field.
1055 With numeric argument N, move N-1 fields backward first."
1068 "Move to the end of the current table field.
1069 If already at or after the end, move to the end of the next table field.
1070 With numeric argument N, move N-1 fields forward first."
1083 ;;;###autoload
1085 "Go to the next row (same column) in the current table.
1086 Before doing so, re-align the table if necessary."
1094 org-table-may-need-update)
1107 ;;;###autoload
1109 "Copy the value of the current field one row below.
1111 If the field at the cursor is empty, copy the content of the
1112 nearest non-empty field above. With argument N, use the Nth
1113 non-empty field.
1115 If the current field is not empty, it is copied down to the next
1116 row, and the cursor is moved with it. Therefore, repeating this
1117 command causes the column to be filled row-by-row.
1119 If the variable `org-table-copy-increment' is non-nil and the
1120 field is an integer or a timestamp, it will be incremented while
1121 copying. By default, increment by the difference between the
1122 value in the current field and the one in the field above. To
1123 increment using a fixed integer, set `org-table-copy-increment'
1124 to a number. In the case of a timestamp, increment by days."
1136 txt txt-up inc)
1144 beg t))
1154 beg t))
1161 ;; Above field was not empty, go down to the next row
1194 "Is point inside a table data field?
1195 I.e. not on a hline or before the first or after the last column?
1196 This actually throws an error, so it aborts the current command."
1208 "Get the field in table line LINE, column COLUMN.
1209 If LINE is larger than the number of data lines in the table, the function
1210 returns nil. However, if COLUMN is too large, we will simply return an
1211 empty string.
1212 If LINE is nil, use the current line.
1213 If COLUMN is nil, use the current column."
1220 "Put VALUE into line LINE, column COLUMN.
1221 When ALIGN is set, also realign the table."
1230 "Return the index of the current data line."
1237 cnt))
1240 "Go to the Nth data line in the current table.
1241 Return t when the line exists, nil if it does not exist."
1248 ;;;###autoload
1250 "Blank the current table field or active region."
1267 "Return the value of the field in column N of current row.
1268 N defaults to current column. If REPLACE is a string, replace
1269 field with this value. The return value is always the old
1270 value."
1274 ;; Before first column or after last one.
1275 ""
1282 val)))
1284 ;;;###autoload
1286 "Show info about the current field, and highlight any reference at point."
1296 col)
1297 org-table-named-field-locations)))
1307 ;; Prioritize field formulas over column formulas.
1316 dline col
1318 dline col ref1
1320 ;; FIXME: formula info not correct if special table line
1327 ""
1333 "Find out which column we are in."
1339 column)))
1342 "Find out what table data line we are in.
1343 Only data lines count for this."
1351 c)))
1353 ;;;###autoload
1355 "Move the cursor to the Nth column in the current table line.
1356 With optional argument ON-DELIM, stop with point before the left delimiter
1357 of the field.
1358 If there are less than N fields, just go to after the last delimiter.
1359 However, when FORCE is non-nil, create new columns if necessary."
1369 t)))))
1376 ;;;###autoload
1378 "Insert a new column into the table."
1400 "Find a data line in the current table, which is needed for column commands."
1403 t
1414 t
1419 "Turn a buffer line number into a data line number.
1421 If there is no data line in this line, return nil.
1423 If there is no matching dline (most likely the reference was
1424 a hline), the first dline below it is used. When ABOVE is
1425 non-nil, the one above is used."
1430 nil)
1441 ;;;###autoload
1443 "Delete a column from the table."
1455 nil
1470 ;;;###autoload
1472 "Move column to the right."
1475 ;;;###autoload
1477 "Move column to the left."
1481 ;;;###autoload
1483 "Move the current column to the right. With arg LEFT, move to the left."
1519 ;;;###autoload
1521 "Move table row down."
1524 ;;;###autoload
1526 "Move table row up."
1530 ;;;###autoload
1532 "Move the current table line down. With arg UP, move it up."
1541 hline2p)
1567 ;;;###autoload
1569 "Insert a new row above the current line into the table.
1570 With prefix ARG, insert below the current line."
1575 ;; Fix the first field if necessary
1579 ;; Buffer may not end of a newline character, so ensure
1580 ;; (beginning-of-line 2) moves point to a new line.
1591 ;;;###autoload
1593 "Insert a horizontal-line below the current line into the table.
1594 With prefix ABOVE, insert above the current line."
1615 ;;;###autoload
1617 "Insert a hline and move to the row below that line."
1631 In particular, this does handle wide and invisible characters."
1633 ;; It's a hline, just map the characters
1639 t t s)))
1640 s))
1642 ;;;###autoload
1644 "Delete the current row or horizontal line from the table."
1658 ;;;###autoload
1661 "Sort table lines according to the column at point.
1663 The position of point indicates the column to be used for
1664 sorting, and the range of lines is the range between the nearest
1665 horizontal separator lines, or the entire table of no such lines
1666 exist. If point is before the first column, you will be prompted
1667 for the sorting column. If there is an active region, the mark
1668 specifies the first line and the sorting column, while point
1669 should be in the last line to be included into the sorting.
1671 The command then prompts for the sorting type which can be
1672 alphabetically, numerically, or by time (as given in a time stamp
1673 in the field, or as a HH:MM value). Sorting in reverse order is
1674 also possible.
1676 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1678 If SORTING-TYPE is specified when this function is called from a Lisp
1679 program, no prompting will take place. SORTING-TYPE must be a character,
1680 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1681 sorting should be done in reverse order.
1683 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1684 a function to be called to extract the key. It must return a value
1685 that is compatible with COMPARE-FUNC, the function used to compare
1686 entries.
1688 A non-nil value for INTERACTIVE? is used to signal that this
1689 function is being called interactively."
1692 ;; Point must be either within a field or before a data line.
1697 ;; Set appropriate case sensitivity and column used for sorting.
1708 ;; Narrow buffer to appropriate sorting area.
1721 start))
1724 end))))
1725 ;; Determine arguments for `sort-subr'. Also record original
1726 ;; position. `org-table-save-field' cannot help here since
1727 ;; sorting is too much destructive.
1733 ;; Function to be called on the contents of the field
1734 ;; used for sorting in the current row.
1770 #'end-of-line
1774 nil
1775 predicate)
1776 ;; Move back to initial field.
1780 ;;;###autoload
1782 "Copy region in table to the clipboard and blank all relevant fields.
1783 If there is no active region, use just the field at point."
1789 ;;;###autoload
1791 "Copy rectangular region in table to clipboard.
1792 A special clipboard is used which can only be accessed
1793 with `org-table-paste-rectangle'."
1797 current-prefix-arg))
1802 region)
1814 ;; Collect every cell between COLUMN-START and COLUMN-END.
1824 ;;;###autoload
1826 "Paste a rectangular region into a table.
1827 The upper right corner ends up in the current field. All involved fields
1828 will be overwritten. If the rectangle does not fit into the present table,
1829 the table is enlarged as needed. The process ignores horizontal separator
1830 lines."
1840 ;; If we left the table, create a new row.
1852 ;;;###autoload
1854 "Convert from `org-mode' table to table.el and back.
1855 Obviously, this only works within limits. When an Org table is converted
1856 to table.el, all horizontal separator lines get lost, because table.el uses
1857 these as cell boundaries and has no notion of horizontal lines. A table.el
1858 table can be converted to an Org table only if it does not do row or column
1859 spanning. Multiline cells will become multiple cells. Beware, Org mode
1860 does not test if the table can be successfully converted - it blindly
1861 applies a recipe that works for simple tables."
1865 ;; convert to Org table
1874 ;; convert to table.el table
1877 ;; first, get rid of all horizontal lines
1881 ;; insert a hline before first
1885 ;; insert a hline after each line
1890 ;; replace "+" at beginning and ending of hlines
1899 "Transpose Org table at point and eliminate hlines.
1900 So a table like
1902 | 1 | 2 | 4 | 5 |
1903 |---+---+---+---|
1904 | a | b | c | d |
1905 | e | f | g | h |
1907 will be transposed as
1909 | 1 | a | e |
1910 | 2 | b | f |
1911 | 4 | c | g |
1912 | 5 | d | h |
1914 Note that horizontal lines disappear."
1926 table)))
1940 ;;;###autoload
1942 "Wrap several fields in a column like a paragraph.
1943 This is useful if you'd like to spread the contents of a field over several
1944 lines, in order to keep the table compact.
1946 If there is an active region, and both point and mark are in the same column,
1947 the text in the column is wrapped to minimum width for the given number of
1948 lines. Generally, this makes the table more compact. A prefix ARG may be
1949 used to change the number of desired lines. For example, \
1951 formats the selected text to two lines. If the region was longer than two
1952 lines, the remaining lines remain empty. A negative prefix argument reduces
1953 the current number of lines by that amount. The wrapped text is pasted back
1954 into the table. If you formatted it to more lines than it was before, fields
1955 further down in the table get overwritten - so you might need to make space in
1956 the table first.
1958 If there is no region, the current field is split at the cursor position and
1959 the text fragment to the right of the cursor is prepended to the field one
1960 line down.
1962 If there is no region, but you specify a prefix ARG, the current field gets
1963 blank, and the content is appended to the field above."
1967 ;; There is a region: fill as a paragraph.
1978 nil
1979 nlines))))
1982 ;; No region, split the current field at point.
2007 ;;;###autoload
2009 "Edit table field in a different window.
2010 This is mainly useful for fields that contain hidden parts.
2013 visible so that it can be edited in place.
2016 toggle `org-table-follow-field-mode'."
2026 display t intangible t))
2039 p)
2055 intangible t))
2063 "Finish editing a table data field.
2064 Remove all newline characters, insert the result into the table, realign
2065 the table and kill the editing buffer."
2069 text)
2086 "Minor mode to make the table field editor window follow the cursor.
2087 When this mode is active, the field editor window will always show the
2088 current field. The mode exits automatically when the cursor leaves the
2089 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2090 nil " TblFollow" nil
2106 ;; We have left the table, exit the follow mode
2116 ;;;###autoload
2118 "Sum numbers in region of current table column.
2119 The result will be displayed in the echo area, and will be available
2122 If there is an active region, it is interpreted as a rectangle and all
2123 numbers in that rectangle will be summed. If there is no active
2124 region and point is located in a table column, sum all numbers in that
2125 column.
2127 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2128 numbers are assumed to be times as well (in decimal hours) and the
2129 numbers are added as such.
2131 If NLAST is a number, only the NLAST fields will actually be summed."
2158 items1)))
2165 s diff)
2172 sres))))
2195 "Return the formula active for the current field.
2197 Assumes that table is already analyzed. If KEY is given, return
2198 the key to this formula. Otherwise return the formula preceded
2207 org-table-named-field-locations)))
2221 "Read a formula from the minibuffer, offer stored formula as default.
2222 When NAMED is non-nil, look for a named equation."
2227 org-table-named-field-locations)))
2240 stored)
2242 equation)
2248 scol))
2250 'org-table-formula-history
2251 )))))
2252 mustsave)
2254 ;; remove formula
2261 ;; We set the column equation, delete the named one.
2263 mustsave t))
2269 eq))
2272 "Store the list of formulas below the current table.
2273 If optional argument LOCATION is a buffer position, insert it at
2274 LOCATION instead."
2282 ;; Don't overwrite TBLFM, we might use text properties to
2283 ;; store stuff.
2297 ;; Fake a high number to make sure this is sorted at the end.
2304 a)
2314 "Compare two formulas for sorting."
2319 ;;;###autoload
2321 "Return an alist with the stored formulas directly after current table.
2322 By default, only return active formulas, i.e., formulas located
2323 on the first line after the table. However, if optional argument
2324 LOCATION is a buffer position, consider the formulas there."
2333 eq-alist seen)
2337 string)
2342 ;; Is it a column reference?
2344 ;; Since named columns are not possible in
2345 ;; LHS, assume this is a named field.
2353 "Double definition `%s=' in TBLFM line, please fix by hand"
2354 lhs)
2359 "Double definition `%s=' in TBLFM line, please fix by hand"
2360 lhs)))))))))))
2363 "Modify the equations after the table structure has been edited.
2365 For all numbers larger than LIMIT, shift them by DELTA."
2377 s n a)
2383 "Change makes TBLFM term %s invalid, use undo to recover"
2398 ;;;###autoload
2401 If yes, store the formula and apply it."
2402 ;; We already know we are in a table. Get field will only return a formula
2403 ;; when appropriate. It might return a separator line, but no problem.
2406 named eq)
2414 "List of commands triggering the recalculation of a line.
2426 ;;;###autoload
2428 "Rotate the recalculation mark in the first column.
2429 If in any row, the first field is not consistent with a mark,
2430 insert a new column for the markers.
2431 When there is an active region, change all the lines in the region,
2432 after prompting for the marking character.
2433 After each change, a message will be displayed indicating the meaning
2434 of the new mark."
2450 newchar))
2458 newchar))
2476 ;; Rotate mark in first row.
2478 ;; Rotate marks in additional rows if a region is active.
2486 ;; Only align if rotation actually changed lines' length.
2496 ;;;###autoload
2498 "Analyze table at point and store results.
2500 This function sets up the following dynamically scoped variables:
2502 `org-table-column-name-regexp',
2503 `org-table-column-names',
2504 `org-table-current-begin-pos',
2505 `org-table-current-line-types',
2506 `org-table-current-ncol',
2507 `org-table-dlines',
2508 `org-table-hlines',
2509 `org-table-local-parameters',
2510 `org-table-named-field-locations'."
2515 ;; Extract column names.
2528 ;; Extract local parameters.
2536 org-table-local-parameters)))))
2537 ;; Update named fields locations. We minimize `count-lines'
2538 ;; processing by storing last known number of lines in LAST.
2560 field))
2563 org-table-named-field-locations))))))))))
2564 ;; Re-use existing markers when possible.
2568 ;; Analyze the line types.
2579 ;; Get the number of columns from the first data line in table.
2587 al al2)
2601 "Move point to a specific field in the current table.
2603 REF is either the name of a field its absolute reference, as
2604 a string. No column is created unless CREATE-COLUMN-P is
2605 non-nil. If it is a function, it is called with the column
2606 number as its argument as is used as a predicate to know if the
2607 column can be created.
2609 This function assumes the table is already analyzed (i.e., using
2610 `org-table-analyze')."
2625 create-column-p)))
2631 ;;;###autoload
2633 "Recompute the current line if marked for it, and if we haven't just done it."
2653 org-tbl-calc-modes)
2655 ;;;###autoload
2657 suppress-align suppress-const
2658 suppress-store suppress-analysis)
2659 "Replace the table field value at the cursor by the result of a calculation.
2661 In a table, this command replaces the value in the current field with the
2663 formula, by storing it in a special line below the table. When called
2665 field formula.
2668 insert the active equation for the field
2669 back into the current field, so that it can be edited there. This is \
2670 useful
2672 check the referenced fields.
2674 When called, the command first prompts for a formula, which is read in
2675 the minibuffer. Previously entered formulas are available through the
2676 history list, and the last used formula is offered as a default.
2677 These stored formulas are adapted correctly when moving, inserting, or
2678 deleting columns with the corresponding commands.
2680 The formula can be any algebraic expression understood by the Calc package.
2681 For details, see the Org mode manual.
2683 This function can also be called from Lisp programs and offers
2684 additional arguments: EQUATION can be the formula to apply. If this
2685 argument is given, the user will not be prompted.
2687 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2688 unnecessary aligns.
2690 SUPPRESS-CONST suppresses the interpretation of constants in the
2691 formula, assuming that this has been done already outside the
2692 function.
2694 SUPPRESS-STORE means the formula should not be stored, either
2695 because it is already stored, or because it is a modified
2696 equation that should not overwrite the stored one.
2698 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2699 location of point."
2715 equation
2721 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2722 duration duration-output-format)
2723 ;; Parse the format string. Since we have a lot of modes, this is
2724 ;; a lot of work. However, I think calc still uses most of the time.
2737 'calc-float-format
2740 n))))
2745 duration-output-format
2774 ;; replace fields with duration values if relevant
2778 fields)))
2784 x))
2785 fields)))
2791 ;; Insert row and column number of formula result field
2802 t t form)))
2804 ;; Check for old vertical references
2806 ;; Insert remote references
2819 rmtrng))
2820 keep-empty numbers lispp))
2821 t t form)))
2822 ;; Insert complex ranges
2832 ;; possibly handle durations
2837 formrg)
2838 keep-empty numbers lispp)))
2843 ;; Insert simple ranges, i.e. included in the current row.
2846 form)
2857 keep-empty numbers lispp))
2858 t t form)))
2860 ;; Insert the references to fields in same row
2867 x keep-empty numbers lispp)))
2884 ;; Use <...> time-stamps so that Calc can handle them.
2887 ;; Internationalize local time-stamps by setting locale to
2888 ;; "C".
2891 org-ts-regexp
2899 form t t))
2902 form
2909 duration-output-format)
2910 ev)))
2915 Orig: %s
2916 $xyz-> %s
2917 @r$c-> %s
2940 ;; Replace any active time stamp in the result with
2941 ;; an inactive one. Dates in tables are likely
2942 ;; piece of regular data, not meant to appear in the
2943 ;; agenda.
2956 prop value)))
2959 "Get a calc vector from a column, according to descriptor DESC.
2961 Optional arguments TBEG and COL can give the beginning of the table and
2962 the current column, to avoid unnecessary parsing.
2964 HIGHLIGHT means just highlight the range.
2966 When CORNERS-ONLY is set, only return the corners of the range as
2967 a list (line1 column1 line2 column2) where line1 and line2 are
2968 line numbers relative to beginning of table, or TBEG, and column1
2969 and column2 are table column numbers."
2972 desc))
2983 thisline)))
2988 thisline)))
3000 ;; Just one field.
3007 ;; A range, return a vector. First sort the numbers to get
3008 ;; a regular rectangle.
3014 ;; Copy the range values into a list.
3029 ;; Return string representation of calc vector.
3035 "Return relative line number corresponding to descriptor DESC.
3036 The cursor is currently in relative line number CLINE."
3041 ;; 1 2 3 4 5 6
3042 desc))
3064 cline)))
3067 "Return relative line of Nth row with type TYPE.
3068 Search starts from relative line I. When BACKWARDS in non-nil,
3069 look before I. When RELATIVE is non-nil, the reference is
3070 relative. DESC is the original descriptor that started the
3071 search, as a string."
3079 ;; We are going to cross a hline. Check if this is
3080 ;; an authorized move.
3091 ;; The last hline doesn't exist. Instead, point to last row
3092 ;; in table.
3101 "Convert list ELEMENTS to something appropriate to insert into formula.
3102 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3103 NUMBERS indicates that everything should be converted to numbers.
3104 LISPP non-nil means to return something appropriate for a Lisp
3105 list, `literal' is for the format specifier L."
3106 ;; Calc nan (not a number) is used for the conversion of the empty
3107 ;; field to a reference for several reasons: (i) It is accepted in a
3108 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3109 ;; (ii) In a single field (not in range) it can be distinguished
3110 ;; from "(nan)" which is the reference made from a single field
3111 ;; containing "nan".
3113 ;; field reference
3116 elements
3118 ""
3127 ;; range reference
3132 elements))))
3138 x
3146 x)
3148 elements
3152 "If there has been more than one second since T1, display message.
3153 ARGS are passed as arguments to the `message' function. Returns
3154 current time if a message is printed, otherwise returns T1. If
3155 T1 is nil, always messages."
3159 curtime)
3160 t1)))
3162 ;;;###autoload
3164 "Recalculate the current table line by applying all stored formulas.
3166 With prefix arg ALL, do this for all lines in the table.
3169 if ALL is the symbol `iterate',
3170 recompute the table until it no longer changes.
3172 If NOALIGN is not nil, do not re-align the table after the computations
3173 are done. This is typically used internally to save time, if it is
3174 known that the table will be realigned a little later anyway."
3189 beg end eqlcol eqlfield)
3190 ;; Insert constants in all formulas.
3193 ;; Expand equations, then split the equation list between
3194 ;; column formulas and field formulas.
3206 old-lhs)))
3209 existing formula for column %s"
3210 old-lhs
3211 new))
3212 new))
3218 ;; Expand ranges in lhs of formulas
3220 ;; Get the correct line range to process.
3227 ;; This is a table with marked lines, compute selected
3228 ;; lines.
3230 ;; Move forward to the first non-header line.
3235 ;; Just leave BEG at the start of the table.
3240 ;; Mark named fields untouchable. Also check if several
3241 ;; field/range formulas try to set the same field.
3245 seen-fields)
3256 ;; Turn field coordinates associated to NAME
3257 ;; into an absolute reference.
3261 name)))
3264 reference))
3269 ;; Evaluate the column formulas, but skip fields covered by
3270 ;; field formulas.
3274 ;; Unprotected line, recalculate.
3279 log-last-time
3292 ;; Evaluate the field formulas.
3301 reference
3302 ;; Possibly create a new column, as long as
3303 ;; `org-table-formula-create-columns' allows it.
3315 t))
3320 ;; Clean up markers and internal text property.
3331 ;;;###autoload
3333 "Recalculate the table until it does not change anymore.
3334 The maximum number of iterations is 10, but you can choose a different value
3335 with the prefix ARG."
3340 thistbl)
3354 ;;;###autoload
3356 "Recalculate all tables in the current buffer."
3361 ;; Reason for separate `org-table-align': When repeating
3362 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3363 ;; the way.
3366 t)))
3368 ;;;###autoload
3370 "Iterate all tables in the buffer, to converge inter-table dependencies."
3375 c1)
3391 "Apply the #+TBLFM in the line at point to the table."
3398 ;; Insert a temporary formula at right after the table
3403 ;; Recalculate the table.
3408 ;; Delete the formula inserted temporarily.
3414 "Find the beginning of the TBLFM lines and return its position.
3415 Return nil when the beginning of TBLFM line was not found."
3422 "Expand list of formulas.
3423 If some of the RHS in the formulas are ranges or a row reference,
3424 expand them to individual field equations for each field. This
3425 function assumes the table is already analyzed (i.e., using
3426 `org-table-analyze')."
3433 ;; This just refers to one fixed field.
3436 ;; This just refers to one fixed named field.
3439 ;; Column formulas are treated specially and are not
3440 ;; expanded.
3445 rhs)
3446 res)))
3458 rhs)
3459 res))))))))))
3462 "Replace @<, @>, $<, $> with first/last row/column of the table.
3463 So @< and $< will always be replaced with @1 and $1, respectively.
3464 The advantage of these special markers are that structure editing of
3465 the table will not change them, while @1 and $1 will be modified
3466 when a line/row is swapped out of that privileged position. So for
3467 formulas that use a range of rows or columns, it may often be better
3469 borders of the table using the @< @> $< $> makers."
3472 s start)
3477 org-table-current-ncol)
3481 len
3488 s)
3491 "Replace $const with values in string F."
3496 org-table-column-name-regexp
3499 org-table-column-names))))
3500 f t t)))
3501 ;; Parameters and constants.
3505 new start))
3508 ;; When a duration is expected, convert value on the fly.
3514 v)))))
3521 "Find the value for a parameter or constant in a formula.
3522 Parameters get priority."
3553 map))
3560 "--"
3563 "--"
3564 "Shift Reference at Point"
3569 "-"
3570 "Change Test Row for Column Formulas"
3573 "--"
3578 org-table-overlay-coordinates)]
3579 "--"
3587 ;;;###autoload
3589 "Edit the formulas of the current table in a separate buffer."
3595 ;; Move point within the table before analyzing it.
3611 ;; Keep global-font-lock-mode from turning on font-lock-mode
3656 "Convert a formula from internal to user representation."
3659 s))
3662 "Convert a formula from user to internal representation."
3665 s))
3668 "Convert spreadsheet references from A7 to @7$28.
3669 Works for single references, but also for entire formulas and even the
3670 full TBLFM line."
3672 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3675 ;; format match, just advance
3680 ;; 3.e5 or something like this.
3683 ;; (member (match-string 1 s)
3684 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3685 )
3686 ;; function name, just advance
3696 t t s)))))
3697 s))
3700 "Convert spreadsheet references from to @7$28 to AB7.
3701 Works for single references, but also for entire formulas and even the
3702 full TBLFM line."
3709 t t s)))
3714 t nil s)))
3715 s)
3718 "Convert a base 26 number represented by letters into an integer.
3719 For example: AB -> 28."
3725 n))
3728 "Convert an integer into a base 26 number represented by letters.
3729 For example: 28 -> AB."
3734 s))
3737 "Convert a time string into numerical duration in seconds.
3738 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3739 If S is a string representing a number, keep this number."
3741 s
3764 "Convert a number of seconds to a time string.
3765 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3766 minutes or seconds."
3778 ;; Ignore seconds
3782 secs0)
3787 secs0)))))
3791 "Convert all references in this buffer, using FUNCTION."
3802 "Convert all references in the buffer from B3 to @3$2 and back."
3812 "Shift the reference at point one row/hline up."
3816 "Shift the reference at point one row/hline down."
3820 "Shift the reference at point one field to the left."
3824 "Shift the reference at point one field to the right."
3835 ;; A B3-like reference
3841 ;; An internal reference
3847 "Re-match the group N, and replace it with the shifted reference."
3852 t t)))
3855 "Shift a reference part REF.
3856 If DECR is set, decrease the references row/column, else increase.
3857 If HLINE is set, this may be a hline reference, it certainly is not
3858 a translation reference."
3887 "Toggle the display of coordinates in the referenced table."
3896 "Parse the buffer for formula definitions and install them.
3897 With prefix ARG, apply the new formulas to the table."
3906 eql)
3909 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3910 nil t)
3931 "Abort editing formulas, without installing the changes."
3942 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3983 "Show the location/value of the $ expression at point.
3984 When LOCAL is non-nil, show references for the table at point."
3994 var name e what match dest)
3998 "$1.."
4050 dest)
4076 ;; Column number.
4102 org-table-fedit-scroll-down))))
4114 "Make sure the cursor is in a dataline in a table."
4123 p1 p2)))
4128 "Move cursor one line up in the window showing the table."
4133 "Move cursor one line down in the window showing the table."
4138 "Move the cursor in the window showing the table.
4139 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4164 "Add a new overlay."
4170 "Highlight rectangular region in a table.
4171 When buffer positions BEG and END are provided, use them to
4172 delimit the region to highlight. Otherwise, refer to point. Use
4173 FACE, when non-nil, for the highlight."
4205 "Remove the rectangle overlays."
4215 "Add overlays to the table at point, to show row/column coordinates."
4243 ;;;###autoload
4245 "Toggle the display of Row/Column numbers in tables."
4256 ;;;###autoload
4258 "Toggle the formula debugger in tables."
4264 ;;; The orgtbl minor mode
4266 ;; Define a minor mode which can be used in other modes in order to
4267 ;; integrate the Org table editor.
4269 ;; This is really a hack, because the Org table editor uses several
4270 ;; keys which normally belong to the major mode, for example the TAB
4271 ;; and RET keys. Here is how it works: The minor mode defines all the
4272 ;; keys necessary to operate the table editor, but wraps the commands
4273 ;; into a function which tests if the cursor is currently inside
4274 ;; a table. If that is the case, the table editor command is
4275 ;; executed. However, when any of those keys is used outside a table,
4276 ;; the function uses `key-binding' to look up if the key has an
4277 ;; associated command in another currently active keymap (minor modes,
4278 ;; major mode, global), and executes that command. There might be
4279 ;; problems if any of the keys used by the table editor is otherwise
4280 ;; used as a prefix key.
4282 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4283 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4284 ;; addresses this by checking explicitly for both bindings.
4286 ;; The optimized version (see variable `orgtbl-optimized') takes over
4287 ;; all keys which are bound to `self-insert-command' in the *global map*.
4288 ;; Some modes bind other commands to simple characters, for example
4289 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4290 ;; active, this binding is ignored inside tables and replaced with a
4291 ;; modified self-insert.
4309 ;; Install it as a minor mode.
4313 ;;;###autoload
4315 "The `org-mode' table editor as a minor mode for use in other modes."
4320 ;; Exit without error, in case some hook functions calls this
4321 ;; by accident in org-mode.
4325 ;; Make sure we are first in minor-mode-map-alist
4327 ;; FIXME: maybe it should use emulation-mode-map-alists?
4334 auto-fill-inhibit-regexp)
4338 auto-fill-inhibit-regexp)
4339 orgtbl-line-start-regexp))
4357 "Remove all properties related to narrow-column invisibility."
4370 "Create a function for binding in the table minor mode.
4371 FUN is the command to call inside a table. N is used to create a unique
4372 command name. KEYS are keys that should be checked in for a command
4373 to execute outside of tables."
4379 "Outside of tables, run the binding of `"
4391 keys)
4395 "Error when there is no default binding for a table key."
4400 "Setup orgtbl keymaps."
4431 elt key fun cmd)
4439 ;; Special treatment needed for TAB, RET and DEL
4452 (orgtbl-make-binding 'org-delete-backward-char 109
4458 [(tab)] "\C-i"))
4460 (org-defkey orgtbl-mode-map [backtab]
4462 [backtab] [S-iso-lefttab] [(shift tab)]
4463 [(tab)] "\C-i"))
4465 (org-defkey orgtbl-mode-map "\M-\C-m"
4466 (orgtbl-make-binding 'org-table-wrap-region 105
4467 "\M-\C-m" [(meta return)]))
4468 (org-defkey orgtbl-mode-map [(meta return)]
4469 (orgtbl-make-binding 'org-table-wrap-region 106
4470 [(meta return)] "\M-\C-m"))
4472 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4473 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4475 (when orgtbl-optimized
4476 ;; If the user wants maximum table support, we need to hijack
4477 ;; some standard editing functions
4478 (org-remap orgtbl-mode-map
4479 'self-insert-command 'orgtbl-self-insert-command
4480 'delete-char 'org-delete-char
4481 'delete-backward-char 'org-delete-backward-char)
4482 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4483 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4484 '("OrgTbl"
4485 ["Create or convert" org-table-create-or-convert-from-region
4486 :active (not (org-at-table-p)) :keys "C-c |" ]
4487 "--"
4488 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4489 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4490 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4491 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4492 "--"
4493 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4494 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4495 ["Copy Field from Above"
4496 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4497 "--"
4498 ("Column"
4499 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4500 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4501 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4502 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4503 ("Row"
4504 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4505 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4506 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4507 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4508 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4509 "--"
4510 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4511 ("Rectangle"
4512 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4513 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4514 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4515 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4516 "--"
4517 ("Radio tables"
4518 ["Insert table template" orgtbl-insert-radio-table
4519 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4520 ["Comment/uncomment table" orgtbl-toggle-comment t])
4521 "--"
4522 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4523 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4524 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4525 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4526 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4527 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4528 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4529 ["Sum Column/Rectangle" org-table-sum
4530 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4531 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4532 ["Debug Formulas"
4533 org-table-toggle-formula-debugger :active (org-at-table-p)
4534 :keys "C-c {"
4535 :style toggle :selected org-table-formula-debug]
4536 ["Show Col/Row Numbers"
4537 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4538 :keys "C-c }"
4539 :style toggle :selected org-table-overlay-coordinates]
4540 "--"
4541 ("Plot"
4544 t))
4546 (defun orgtbl-ctrl-c-ctrl-c (arg)
4547 "If the cursor is inside a table, realign the table.
4548 If it is a table to be sent away to a receiver, do it.
4549 With prefix arg, also recompute table."
4550 (interactive "P")
4551 (let ((case-fold-search t) (pos (point)) action)
4552 (save-excursion
4553 (beginning-of-line 1)
4554 (setq action (cond
4558 (cond
4559 ((integerp action)
4560 (goto-char action)
4561 (org-table-maybe-eval-formula)
4562 (if arg
4563 (call-interactively 'org-table-recalculate)
4564 (org-table-maybe-recalculate-line))
4565 (call-interactively 'org-table-align)
4566 (when (orgtbl-send-table 'maybe)
4567 (run-hooks 'orgtbl-after-send-table-hook)))
4568 ((eq action 'recalc)
4569 (save-excursion
4570 (beginning-of-line 1)
4572 (if (org-at-table-p)
4573 (org-call-with-arg 'org-table-recalculate t))))
4574 (t (let (orgtbl-mode)
4575 (call-interactively (key-binding "\C-c\C-c")))))))
4577 (defun orgtbl-create-or-convert-from-region (_arg)
4578 "Create table or convert region to table, if no conflicting binding.
4579 This installs the table binding `C-c |', but only if there is no
4580 conflicting binding to this key outside orgtbl-mode."
4581 (interactive "P")
4582 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4583 (if cmd
4584 (call-interactively cmd)
4585 (call-interactively 'org-table-create-or-convert-from-region))))
4587 (defun orgtbl-tab (arg)
4588 "Justification and field motion for `orgtbl-mode'."
4589 (interactive "P")
4590 (if arg (org-table-edit-field t)
4591 (org-table-justify-field-maybe)
4592 (org-table-next-field)))
4594 (defun orgtbl-ret ()
4595 "Justification and field motion for `orgtbl-mode'."
4596 (interactive)
4597 (if (bobp)
4598 (newline)
4599 (org-table-justify-field-maybe)
4600 (org-table-next-row)))
4602 (defun orgtbl-self-insert-command (N)
4603 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4604 If the cursor is in a table looking at whitespace, the whitespace is
4605 overwritten, and the table is not marked as requiring realignment."
4606 (interactive "p")
4607 (if (and (org-at-table-p)
4608 (or
4609 (and org-table-auto-blank-field
4610 (member last-command
4611 '(orgtbl-hijacker-command-100
4612 orgtbl-hijacker-command-101
4613 orgtbl-hijacker-command-102
4614 orgtbl-hijacker-command-103
4615 orgtbl-hijacker-command-104
4616 orgtbl-hijacker-command-105
4617 yas/expand))
4618 (org-table-blank-field))
4619 t)
4620 (eq N 1)
4622 (let (org-table-may-need-update)
4623 (delete-region (match-beginning 1) (match-end 1))
4624 (self-insert-command N))
4625 (setq org-table-may-need-update t)
4626 (let* (orgtbl-mode
4627 a
4628 (cmd (or (key-binding
4629 (or (and (listp function-key-map)
4630 (setq a (assoc last-input-event function-key-map))
4631 (cdr a))
4632 (vector last-input-event)))
4633 'self-insert-command)))
4634 (call-interactively cmd)
4635 (if (and org-self-insert-cluster-for-undo
4636 (eq cmd 'self-insert-command))
4637 (if (not (eq last-command 'orgtbl-self-insert-command))
4638 (setq org-self-insert-command-undo-counter 1)
4639 (if (>= org-self-insert-command-undo-counter 20)
4640 (setq org-self-insert-command-undo-counter 1)
4641 (and (> org-self-insert-command-undo-counter 0)
4642 buffer-undo-list
4643 (not (cadr buffer-undo-list)) ; remove nil entry
4644 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4645 (setq org-self-insert-command-undo-counter
4646 (1+ org-self-insert-command-undo-counter))))))))
4648 ;;;###autoload
4650 "Regular expression matching exponentials as produced by calc.")
4652 (defun orgtbl-gather-send-defs ()
4653 "Gather a plist of :name, :transform, :params for each destination before
4654 a radio table."
4655 (save-excursion
4656 (goto-char (org-table-begin))
4657 (let (rtn)
4658 (beginning-of-line 0)
4659 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4660 (let ((name (org-no-properties (match-string 1)))
4661 (transform (intern (match-string 2)))
4662 (params (if (match-end 3)
4663 (read (concat "(" (match-string 3) ")")))))
4664 (push (list :name name :transform transform :params params)
4665 rtn)
4666 (beginning-of-line 0)))
4667 rtn)))
4669 (defun orgtbl-send-replace-tbl (name text)
4670 "Find and replace table NAME with TEXT."
4671 (save-excursion
4672 (goto-char (point-min))
4673 (let* ((location-flag nil)
4674 (name (regexp-quote name))
4677 (while (re-search-forward begin-re nil t)
4678 (unless location-flag (setq location-flag t))
4679 (let ((beg (line-beginning-position 2)))
4680 (unless (re-search-forward end-re nil t)
4681 (user-error "Cannot find end of receiver location at %d" beg))
4682 (beginning-of-line)
4683 (delete-region beg (point))
4685 (unless location-flag
4686 (user-error "No valid receiver location found in the buffer")))))
4688 ;;;###autoload
4689 (defun org-table-to-lisp (&optional txt)
4690 "Convert the table at point to a Lisp structure.
4691 The structure will be a list. Each item is either the symbol `hline'
4692 for a horizontal separator line, or a list of field values as strings.
4693 The table is taken from the parameter TXT, or from the buffer at point."
4694 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4695 (let ((txt (or txt
4696 (buffer-substring-no-properties (org-table-begin)
4697 (org-table-end)))))
4698 (mapcar (lambda (x)
4699 (if (string-match org-table-hline-regexp x) 'hline
4703 (defun orgtbl-send-table (&optional maybe)
4704 "Send a transformed version of table at point to the receiver position.
4705 With argument MAYBE, fail quietly if no transformation is defined
4706 for this table."
4707 (interactive)
4708 (catch 'exit
4709 (unless (org-at-table-p) (user-error "Not at a table"))
4710 ;; when non-interactive, we assume align has just happened.
4711 (when (called-interactively-p 'any) (org-table-align))
4712 (let ((dests (orgtbl-gather-send-defs))
4713 (table (org-table-to-lisp
4714 (buffer-substring-no-properties (org-table-begin)
4715 (org-table-end))))
4716 (ntbl 0))
4717 (unless dests
4718 (if maybe (throw 'exit nil)
4719 (user-error "Don't know how to transform this table")))
4720 (dolist (dest dests)
4721 (let ((name (plist-get dest :name))
4722 (transform (plist-get dest :transform))
4723 (params (plist-get dest :params)))
4724 (unless (fboundp transform)
4725 (user-error "No such transformation function %s" transform))
4726 (orgtbl-send-replace-tbl name (funcall transform table params)))
4727 (cl-incf ntbl))
4728 (message "Table converted and installed at %d receiver location%s"
4729 ntbl (if (> ntbl 1) "s" ""))
4730 (and (> ntbl 0) ntbl))))
4732 (defun org-remove-by-index (list indices &optional i0)
4733 "Remove the elements in LIST with indices in INDICES.
4734 First element has index 0, or I0 if given."
4735 (if (not indices)
4736 list
4737 (if (integerp indices) (setq indices (list indices)))
4738 (setq i0 (1- (or i0 0)))
4739 (delq :rm (mapcar (lambda (x)
4740 (setq i0 (1+ i0))
4741 (if (memq i0 indices) :rm x))
4742 list))))
4744 (defun orgtbl-toggle-comment ()
4745 "Comment or uncomment the orgtbl at point."
4746 (interactive)
4747 (let* ((case-fold-search t)
4748 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4749 (re2 (concat "^" orgtbl-line-start-regexp))
4750 (commented (save-excursion (beginning-of-line 1)
4751 (cond ((looking-at re1) t)
4752 ((looking-at re2) nil)
4753 (t (user-error "Not at an org table")))))
4754 (re (if commented re1 re2))
4755 beg end)
4756 (save-excursion
4757 (beginning-of-line 1)
4758 (while (looking-at re) (beginning-of-line 0))
4759 (beginning-of-line 2)
4760 (setq beg (point))
4761 (while (looking-at re) (beginning-of-line 2))
4762 (setq end (point)))
4763 (comment-region beg end (if commented '(4) nil))))
4765 (defun orgtbl-insert-radio-table ()
4766 "Insert a radio table template appropriate for this major mode."
4767 (interactive)
4768 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4769 (txt (nth 1 e))
4770 name pos)
4771 (unless e (user-error "No radio table setup defined for %s" major-mode))
4772 (setq name (read-string "Table name: "))
4773 (while (string-match "%n" txt)
4774 (setq txt (replace-match name t t txt)))
4776 (setq pos (point))
4777 (insert txt)
4778 (goto-char pos)))
4780 ;;;###autoload
4781 (defun orgtbl-to-generic (table params)
4782 "Convert the orgtbl-mode TABLE to some other format.
4784 This generic routine can be used for many standard cases.
4786 TABLE is a list, each entry either the symbol `hline' for
4787 a horizontal separator line, or a list of fields for that
4788 line. PARAMS is a property list of parameters that can
4789 influence the conversion.
4791 Valid parameters are:
4793 :backend, :raw
4795 Export back-end used as a basis to transcode elements of the
4796 table, when no specific parameter applies to it. It is also
4797 used to translate cells contents. You can prevent this by
4798 setting :raw property to a non-nil value.
4800 :splice
4802 When non-nil, only convert rows, not the table itself. This is
4803 equivalent to setting to the empty string both :tstart
4804 and :tend, which see.
4806 :skip
4808 When set to an integer N, skip the first N lines of the table.
4809 Horizontal separation lines do count for this parameter!
4811 :skipcols
4813 List of columns that should be skipped. If the table has
4814 a column with calculation marks, that column is automatically
4815 discarded beforehand.
4817 :hline
4819 String to be inserted on horizontal separation lines. May be
4820 nil to ignore these lines altogether.
4822 :sep
4824 Separator between two fields, as a string.
4826 Each in the following group may be either a string or a function
4827 of no arguments returning a string:
4829 :tstart, :tend
4831 Strings to start and end the table. Ignored when :splice is t.
4833 :lstart, :lend
4835 Strings to start and end a new table line.
4837 :llstart, :llend
4839 Strings to start and end the last table line. Default,
4840 respectively, to :lstart and :lend.
4842 Each in the following group may be a string or a function of one
4843 argument (either the cells in the current row, as a list of
4844 strings, or the current cell) returning a string:
4846 :lfmt
4848 Format string for an entire row, with enough %s to capture all
4849 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4851 :llfmt
4853 Format for the entire last line, defaults to :lfmt.
4855 :fmt
4857 A format to be used to wrap the field, should contain %s for
4858 the original field value. For example, to wrap everything in
4860 a property list with column numbers and format strings, or
4861 functions, e.g.,
4865 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4867 Same as above, specific for the header lines in the table.
4868 All lines before the first hline are treated as header. If
4869 any of these is not present, the data line value is used.
4871 This may be either a string or a function of two arguments:
4873 :efmt
4875 Use this format to print numbers with exponential. The format
4876 should have %s twice for inserting mantissa and exponent, for
4878 list with column numbers and format strings or functions.
4879 :fmt will still be applied after :efmt."
4880 ;; Make sure `org-export-create-backend' is available.
4881 (require 'ox)
4882 (let* ((backend (plist-get params :backend))
4883 (custom-backend
4884 ;; Build a custom back-end according to PARAMS. Before
4885 ;; defining a translator, check if there is anything to do.
4886 ;; When there isn't, let BACKEND handle the element.
4887 (org-export-create-backend
4888 :parent (or backend 'org)
4889 :transcoders
4890 `((table . ,(org-table--to-generic-table params))
4891 (table-row . ,(org-table--to-generic-row params))
4892 (table-cell . ,(org-table--to-generic-cell params))
4893 ;; Macros are not going to be expanded. However, no
4894 ;; regular back-end has a transcoder for them. We
4895 ;; provide one so they are not ignored, but displayed
4896 ;; as-is instead.
4897 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4898 data info)
4899 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4900 ;; Initialize communication channel in INFO.
4901 (with-temp-buffer
4902 (let ((org-inhibit-startup t)) (org-mode))
4903 (let ((standard-output (current-buffer))
4904 (org-element-use-cache nil))
4905 (dolist (e table)
4907 ((consp e)
4908 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4910 ;; Add back-end specific filters, but not user-defined ones. In
4911 ;; particular, make sure to call parse-tree filters on the
4912 ;; table.
4913 (setq info
4914 (let ((org-export-filters-alist nil))
4915 (org-export-install-filters
4916 (org-combine-plists
4917 (org-export-get-environment backend nil params)
4918 `(:back-end ,(org-export-get-backend backend))))))
4919 (setq data
4920 (org-export-filter-apply-functions
4921 (plist-get info :filter-parse-tree)
4922 (org-element-map (org-element-parse-buffer) 'table
4923 #'identity nil t)
4924 info)))
4925 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4926 (user-error "Unknown :backend value"))
4927 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4928 ;; Handle :skip parameter.
4929 (let ((skip (plist-get info :skip)))
4930 (when skip
4931 (unless (wholenump skip) (user-error "Wrong :skip value"))
4932 (let ((n 0))
4933 (org-element-map data 'table-row
4934 (lambda (row)
4935 (if (>= n skip) t
4936 (org-element-extract-element row)
4937 (cl-incf n)
4938 nil))
4939 nil t))))
4940 ;; Handle :skipcols parameter.
4941 (let ((skipcols (plist-get info :skipcols)))
4942 (when skipcols
4943 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4944 (org-element-map data 'table
4945 (lambda (table)
4946 (let ((specialp (org-export-table-has-special-column-p table)))
4947 (dolist (row (org-element-contents table))
4948 (when (eq (org-element-property :type row) 'standard)
4949 (let ((c 1))
4950 (dolist (cell (nthcdr (if specialp 1 0)
4951 (org-element-contents row)))
4952 (when (memq c skipcols)
4953 (org-element-extract-element cell))
4954 (cl-incf c))))))))))
4955 ;; Since we are going to export using a low-level mechanism,
4956 ;; ignore special column and special rows manually.
4957 (let ((special? (org-export-table-has-special-column-p data))
4958 ignore)
4959 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4960 (lambda (datum)
4961 (when (if (eq (org-element-type datum) 'table-row)
4962 (org-export-table-row-is-special-p datum nil)
4963 (org-export-first-sibling-p datum nil))
4964 (push datum ignore))))
4965 (setq info (plist-put info :ignore-list ignore)))
4966 ;; We use a low-level mechanism to export DATA so as to skip all
4967 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4968 ;; code evaluation, include keywords and macro expansion. Only
4969 ;; back-end specific filters are retained.
4970 (let ((output (org-export-data-with-backend data custom-backend info)))
4971 ;; Remove final newline.
4972 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4974 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4975 (cond ((null value) nil)
4976 ((functionp value) `(funcall ',value ,@args))
4977 ((stringp value)
4978 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4979 (args `(format ,value ,@args))
4980 (t value)))
4981 ((and with-cons (consp value))
4982 `(let ((val (cadr (memq column ',value))))
4983 (cond ((null val) contents)
4984 ((stringp val) (format val ,@args))
4985 ((functionp val) (funcall val ,@args))
4986 (t (user-error "Wrong %s value" ,name)))))
4987 (t (user-error "Wrong %s value" name))))
4989 (defun org-table--to-generic-table (params)
4990 "Return custom table transcoder according to PARAMS.
4991 PARAMS is a plist. See `orgtbl-to-generic' for more
4992 information."
4993 (let ((backend (plist-get params :backend))
4994 (splice (plist-get params :splice))
4995 (tstart (plist-get params :tstart))
4996 (tend (plist-get params :tend)))
4997 `(lambda (table contents info)
4998 (concat
4999 ,(and tstart (not splice)
5001 ,(if (or (not backend) tstart tend splice) 'contents
5002 `(org-export-with-backend ',backend table contents info))
5003 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5005 (defun org-table--to-generic-row (params)
5006 "Return custom table row transcoder according to PARAMS.
5007 PARAMS is a plist. See `orgtbl-to-generic' for more
5008 information."
5009 (let* ((backend (plist-get params :backend))
5010 (lstart (plist-get params :lstart))
5011 (llstart (plist-get params :llstart))
5012 (hlstart (plist-get params :hlstart))
5013 (hllstart (plist-get params :hllstart))
5014 (lend (plist-get params :lend))
5015 (llend (plist-get params :llend))
5016 (hlend (plist-get params :hlend))
5017 (hllend (plist-get params :hllend))
5018 (lfmt (plist-get params :lfmt))
5019 (llfmt (plist-get params :llfmt))
5020 (hlfmt (plist-get params :hlfmt))
5021 (hllfmt (plist-get params :hllfmt)))
5022 `(lambda (row contents info)
5023 (if (eq (org-element-property :type row) 'rule)
5024 ,(cond
5025 ((plist-member params :hline)
5026 (org-table--generic-apply (plist-get params :hline) ":hline"))
5027 (backend `(org-export-with-backend ',backend row nil info)))
5028 (let ((headerp ,(and (or hlfmt hlstart hlend)
5029 '(org-export-table-row-in-header-p row info)))
5030 (last-header-p
5031 ,(and (or hllfmt hllstart hllend)
5032 '(org-export-table-row-ends-header-p row info)))
5033 (lastp (not (org-export-get-next-element row info))))
5034 (when contents
5035 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5036 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5037 ;; `:lstart', `:lend' and their relatives.
5038 ,(let ((cells
5039 '(org-element-map row 'table-cell
5040 (lambda (cell)
5041 ;; Export all cells, without separators.
5042 ;;
5043 ;; Use `org-export-data-with-backend'
5044 ;; instead of `org-export-data' to eschew
5045 ;; cached values, which
5046 ;; ignore :orgtbl-ignore-sep parameter.
5047 (org-export-data-with-backend
5048 cell
5049 (plist-get info :back-end)
5050 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5051 info)))
5052 `(cond
5053 ,(and hllfmt
5054 `(last-header-p ,(org-table--generic-apply
5055 hllfmt ":hllfmt" nil cells)))
5056 ,(and hlfmt
5057 `(headerp ,(org-table--generic-apply
5058 hlfmt ":hlfmt" nil cells)))
5059 ,(and llfmt
5060 `(lastp ,(org-table--generic-apply
5061 llfmt ":llfmt" nil cells)))
5062 (t
5063 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5064 `(concat
5065 (cond
5066 ,(and
5067 (or hllstart hllend)
5068 `(last-header-p
5069 (concat
5070 ,(org-table--generic-apply hllstart ":hllstart")
5071 contents
5072 ,(org-table--generic-apply hllend ":hllend"))))
5073 ,(and
5074 (or hlstart hlend)
5075 `(headerp
5076 (concat
5077 ,(org-table--generic-apply hlstart ":hlstart")
5078 contents
5079 ,(org-table--generic-apply hlend ":hlend"))))
5080 ,(and
5081 (or llstart llend)
5082 `(lastp
5083 (concat
5084 ,(org-table--generic-apply llstart ":llstart")
5085 contents
5086 ,(org-table--generic-apply llend ":llend"))))
5087 (t
5088 ,(cond
5089 ((or lstart lend)
5090 `(concat
5091 ,(org-table--generic-apply lstart ":lstart")
5092 contents
5093 ,(org-table--generic-apply lend ":lend")))
5094 (backend
5095 `(org-export-with-backend
5096 ',backend row contents info))
5097 (t 'contents)))))))))))))))
5099 (defun org-table--to-generic-cell (params)
5100 "Return custom table cell transcoder according to PARAMS.
5101 PARAMS is a plist. See `orgtbl-to-generic' for more
5102 information."
5103 (let* ((backend (plist-get params :backend))
5104 (efmt (plist-get params :efmt))
5105 (fmt (plist-get params :fmt))
5106 (hfmt (plist-get params :hfmt))
5107 (sep (plist-get params :sep))
5108 (hsep (plist-get params :hsep)))
5109 `(lambda (cell contents info)
5110 ;; Make sure that contents are exported as Org data when :raw
5111 ;; parameter is non-nil.
5112 ,(when (and backend (plist-get params :raw))
5113 `(setq contents
5114 ;; Since we don't know what are the pseudo object
5115 ;; types defined in backend, we cannot pass them to
5116 ;; `org-element-interpret-data'. As a consequence,
5117 ;; they will be treated as pseudo elements, and will
5118 ;; have newlines appended instead of spaces.
5119 ;; Therefore, we must make sure :post-blank value is
5120 ;; really turned into spaces.
5121 (replace-regexp-in-string
5123 (org-trim
5124 (org-element-interpret-data
5125 (org-element-contents cell))))))
5127 (let ((headerp ,(and (or hfmt hsep)
5128 '(org-export-table-row-in-header-p
5129 (org-export-get-parent-element cell) info)))
5130 (column
5131 ;; Call costly `org-export-table-cell-address' only if
5132 ;; absolutely necessary, i.e., if one
5133 ;; of :fmt :efmt :hmft has a "plist type" value.
5134 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5135 (list efmt hfmt fmt))
5136 '(1+ (cdr (org-export-table-cell-address cell info))))))
5137 (when contents
5138 ;; Check if we can apply `:efmt' on CONTENTS.
5139 ,(when efmt
5140 `(when (string-match orgtbl-exp-regexp contents)
5141 (let ((mantissa (match-string 1 contents))
5142 (exponent (match-string 2 contents)))
5143 (setq contents ,(org-table--generic-apply
5144 efmt ":efmt" t 'mantissa 'exponent)))))
5145 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5146 (cond
5147 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5148 hfmt ":hfmt" t 'contents))))
5149 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5150 fmt ":fmt" t 'contents))))))
5151 ;; If a separator is provided, use it instead of BACKEND's.
5152 ;; Separators are ignored when LFMT (or equivalent) is
5153 ;; provided.
5154 ,(cond
5155 ((or hsep sep)
5156 `(if (or ,(and (not sep) '(not headerp))
5157 (plist-get info :orgtbl-ignore-sep)
5158 (not (org-export-get-next-element cell info)))
5159 ,(if (not backend) 'contents
5160 `(org-export-with-backend ',backend cell contents info))
5161 (concat contents
5162 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5163 (or hsep sep)))))
5164 (backend `(org-export-with-backend ',backend cell contents info))
5165 (t 'contents))))))
5167 ;;;###autoload
5168 (defun orgtbl-to-tsv (table params)
5169 "Convert the orgtbl-mode table to TAB separated material."
5172 ;;;###autoload
5173 (defun orgtbl-to-csv (table params)
5174 "Convert the orgtbl-mode table to CSV material.
5175 This does take care of the proper quoting of fields with comma or quotes."
5176 (orgtbl-to-generic table
5177 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5178 params)))
5180 ;;;###autoload
5181 (defun orgtbl-to-latex (table params)
5182 "Convert the orgtbl-mode TABLE to LaTeX.
5184 TABLE is a list, each entry either the symbol `hline' for
5185 a horizontal separator line, or a list of fields for that line.
5186 PARAMS is a property list of parameters that can influence the
5187 conversion. All parameters from `orgtbl-to-generic' are
5188 supported. It is also possible to use the following ones:
5190 :booktabs
5194 :environment
5196 Specify environment to use, as a string. If you use
5198 as a string, to get proper continuation strings."
5199 (require 'ox-latex)
5200 (orgtbl-to-generic
5201 table
5202 (org-combine-plists
5203 ;; Provide sane default values.
5204 (list :backend 'latex
5205 :latex-default-table-mode 'table
5206 :latex-tables-centered nil
5207 :latex-tables-booktabs (plist-get params :booktabs)
5208 :latex-table-scientific-notation nil
5209 :latex-default-table-environment
5210 (or (plist-get params :environment) "tabular"))
5211 params)))
5213 ;;;###autoload
5214 (defun orgtbl-to-html (table params)
5215 "Convert the orgtbl-mode TABLE to HTML.
5217 TABLE is a list, each entry either the symbol `hline' for
5218 a horizontal separator line, or a list of fields for that line.
5219 PARAMS is a property list of parameters that can influence the
5220 conversion. All parameters from `orgtbl-to-generic' are
5221 supported. It is also possible to use the following one:
5223 :attributes
5225 Attributes and values, as a plist, which will be used in
5226 <table> tag."
5227 (require 'ox-html)
5228 (orgtbl-to-generic
5229 table
5230 (org-combine-plists
5231 ;; Provide sane default values.
5232 (list :backend 'html
5233 :html-table-data-tags '("<td%s>" . "</td>")
5234 :html-table-use-header-tags-for-first-column nil
5235 :html-table-align-individual-fields t
5236 :html-table-row-tags '("<tr>" . "</tr>")
5237 :html-table-attributes
5238 (if (plist-member params :attributes)
5239 (plist-get params :attributes)
5240 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5241 :frame "hsides")))
5242 params)))
5244 ;;;###autoload
5245 (defun orgtbl-to-texinfo (table params)
5246 "Convert the orgtbl-mode TABLE to Texinfo.
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. It is also possible to use the following one:
5254 :columns
5256 Column widths, as a string. When providing column fractions,
5258 (require 'ox-texinfo)
5259 (let ((output
5260 (orgtbl-to-generic
5261 table
5262 (org-combine-plists
5263 (list :backend 'texinfo
5264 :texinfo-tables-verbatim nil
5265 :texinfo-table-scientific-notation nil)
5266 params)))
5267 (columns (let ((w (plist-get params :columns)))
5268 (cond ((not w) nil)
5270 (t (concat "@columnfractions " w))))))
5271 (if (not columns) output
5272 (replace-regexp-in-string
5275 ;;;###autoload
5276 (defun orgtbl-to-orgtbl (table params)
5277 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5279 TABLE is a list, each entry either the symbol `hline' for
5280 a horizontal separator line, or a list of fields for that line.
5281 PARAMS is a property list of parameters that can influence the
5282 conversion. All parameters from `orgtbl-to-generic' are
5283 supported.
5285 Useful when slicing one table into many. The :hline, :sep,
5286 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5287 be set to provide ORGTBL directives for the generated table."
5288 (require 'ox-org)
5289 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5291 (defun orgtbl-to-table.el (table params)
5292 "Convert the orgtbl-mode TABLE into a table.el table.
5293 TABLE is a list, each entry either the symbol `hline' for
5294 a horizontal separator line, or a list of fields for that line.
5295 PARAMS is a property list of parameters that can influence the
5296 conversion. All parameters from `orgtbl-to-generic' are
5297 supported."
5298 (with-temp-buffer
5299 (insert (orgtbl-to-orgtbl table params))
5300 (org-table-align)
5301 (replace-regexp-in-string
5302 "-|" "-+"
5303 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5305 (defun orgtbl-to-unicode (table params)
5306 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5308 TABLE is a list, each entry either the symbol `hline' for
5309 a horizontal separator line, or a list of fields for that line.
5310 PARAMS is a property list of parameters that can influence the
5311 conversion. All parameters from `orgtbl-to-generic' are
5312 supported. It is also possible to use the following ones:
5314 :ascii-art
5317 the table. You can download it here:
5318 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5320 :narrow
5322 When non-nil, narrow columns width than provided width cookie,
5324 (require 'ox-ascii)
5325 (orgtbl-to-generic
5326 table
5327 (org-combine-plists
5328 (list :backend 'ascii
5329 :ascii-charset 'utf-8
5330 :ascii-table-widen-columns (not (plist-get params :narrow))
5331 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5332 params)))
5334 ;; Put the cursor in a column containing numerical values
5335 ;; of an Org table,
5336 ;; type C-c " a
5337 ;; A new column is added with a bar plot.
5338 ;; When the table is refreshed (C-u C-c *),
5339 ;; the plot is updated to reflect the new values.
5341 (defun orgtbl-ascii-draw (value min max &optional width characters)
5342 "Draw an ascii bar in a table.
5343 VALUE is the value to plot, it determines the width of the bar to draw.
5344 MIN is the value that will be displayed as empty (zero width bar).
5345 MAX is the value that will draw a bar filling all the WIDTH.
5346 WIDTH is the span in characters from MIN to MAX.
5347 CHARACTERS is a string that will compose the bar, with shades of grey
5348 from pure white to pure black. It defaults to a 10 characters string
5349 of regular ascii characters."
5350 (let* ((width (ceiling (or width 12)))
5351 (characters (or characters " .:;c!lhVHW"))
5352 (len (1- (length characters)))
5353 (value (float (if (numberp value)
5354 value (string-to-number value))))
5355 (relative (/ (- value min) (- max min)))
5356 (steps (round (* relative width len))))
5357 (cond ((< steps 0) "too small")
5358 ((> steps (* width len)) "too large")
5359 (t (let* ((int-division (/ steps len))
5360 (remainder (- steps (* int-division len))))
5361 (concat (make-string int-division (elt characters len))
5362 (string (elt characters remainder))))))))
5364 ;;;###autoload
5365 (defun orgtbl-ascii-plot (&optional ask)
5366 "Draw an ASCII bar plot in a column.
5368 With cursor in a column containing numerical values, this function
5369 will draw a plot in a new column.
5371 ASK, if given, is a numeric prefix to override the default 12
5373 prefix,
5374 which will prompt for the width."
5375 (interactive "P")
5376 (let ((col (org-table-current-column))
5377 (min 1e999) ; 1e999 will be converted to infinity
5378 (max -1e999) ; which is the desired result
5379 (table (org-table-to-lisp))
5380 (length
5381 (cond ((consp ask)
5382 (read-number "Length of column " 12))
5383 ((numberp ask) ask)
5384 (t 12))))
5385 ;; Skip any hline a the top of table.
5386 (while (eq (car table) 'hline) (setq table (cdr table)))
5387 ;; Skip table header if any.
5388 (dolist (x (or (cdr (memq 'hline table)) table))
5389 (when (consp x)
5390 (setq x (nth (1- col) x))
5391 (when (string-match
5393 x)
5394 (setq x (string-to-number x))
5395 (when (> min x) (setq min x))
5396 (when (< max x) (setq max x)))))
5397 (org-table-insert-column)
5398 (org-table-move-column-right)
5399 (org-table-store-formulas
5400 (cons
5401 (cons
5402 (concat "$" (number-to-string (1+ col)))
5403 (format "'(%s $%s %s %s %s)"
5404 "orgtbl-ascii-draw" col min max length))
5405 (org-table-get-stored-formulas)))
5406 (org-table-recalculate t)))
5408 ;; Example of extension: unicode characters
5409 ;; Here are two examples of different styles.
5411 ;; Unicode block characters are used to give a smooth effect.
5412 ;; See http://en.wikipedia.org/wiki/Block_Elements
5413 ;; Use one of those drawing functions
5414 ;; - orgtbl-ascii-draw (the default ascii)
5415 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5416 ;; - orgtbl-uc-draw-cont (smooth unicode)
5418 ;; This is best viewed with the "DejaVu Sans Mono" font
5419 ;; (use M-x set-default-font).
5421 (defun orgtbl-uc-draw-grid (value min max &optional width)
5422 "Draw a bar in a table using block unicode characters.
5423 It is a variant of orgtbl-ascii-draw with Unicode block
5424 characters, for a smooth display. Bars appear as grids (to the
5425 extent the font allows)."
5426 ;; http://en.wikipedia.org/wiki/Block_Elements
5427 ;; best viewed with the "DejaVu Sans Mono" font.
5428 (orgtbl-ascii-draw value min max width
5431 (defun orgtbl-uc-draw-cont (value min max &optional width)
5432 "Draw a bar in a table using block unicode characters.
5433 It is a variant of orgtbl-ascii-draw with Unicode block
5434 characters, for a smooth display. Bars are solid (to the extent
5435 the font allows)."
5436 (orgtbl-ascii-draw value min max width
5439 (defun org-table-get-remote-range (name-or-id form)
5440 "Get a field value or a list of values in a range from table at ID.
5442 NAME-OR-ID may be the name of a table in the current file as set
5444 will then be used. Alternatively, it may be an ID referring to
5445 any entry, also in a different file. In this case, the first
5446 table in that entry will be referenced.
5450 The return value is either a single string for a single field, or a
5451 list of the fields in the rectangle."
5452 (save-match-data
5453 (let ((case-fold-search t) (id-loc nil)
5454 ;; Protect a bunch of variables from being overwritten by
5455 ;; the context of the remote table.
5456 org-table-column-names org-table-column-name-regexp
5457 org-table-local-parameters org-table-named-field-locations
5458 org-table-current-line-types
5459 org-table-current-begin-pos org-table-dlines
5460 org-table-current-ncol
5461 org-table-hlines org-table-last-alignment
5462 org-table-last-column-widths org-table-last-alignment
5463 org-table-last-column-widths
5464 buffer loc)
5465 (setq form (org-table-convert-refs-to-rc form))
5466 (org-with-wide-buffer
5467 (goto-char (point-min))
5468 (if (re-search-forward
5471 nil t)
5472 (setq buffer (current-buffer) loc (match-beginning 0))
5473 (setq id-loc (org-id-find name-or-id 'marker))
5474 (unless (and id-loc (markerp id-loc))
5476 (setq buffer (marker-buffer id-loc)
5477 loc (marker-position id-loc))
5478 (move-marker id-loc nil))
5479 (with-current-buffer buffer
5480 (org-with-wide-buffer
5481 (goto-char loc)
5482 (forward-char 1)
5484 (not (match-beginning 1)))
5485 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5486 (org-table-analyze)
5487 (setq form (org-table-formula-substitute-names
5488 (org-table-formula-handle-first/last-rc form)))
5489 (if (and (string-match org-table-range-regexp form)
5490 (> (length (match-string 0 form)) 1))
5491 (org-table-get-range
5492 (match-string 0 form) org-table-current-begin-pos 1)
5493 form)))))))
5495 (defun org-table-remote-reference-indirection (form)
5496 "Return formula with table remote references substituted by indirection.
5498 This indirection works only with the format @ROW$COLUMN. The
5500 distinguished from a plain table name or ID."
5501 (let ((regexp
5502 ;; Same as in `org-table-eval-formula'.
5504 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5507 (replace-regexp-in-string
5508 regexp
5509 (lambda (m)
5510 (save-match-data
5511 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5512 (org-table-get-range
5514 (concat "@0" eq)
5515 eq)))))
5516 form t t 1)))
5518 (defmacro org-define-lookup-function (mode)
5519 (let ((mode-str (symbol-name mode))
5520 (first-p (eq mode 'first))
5521 (all-p (eq mode 'all)))
5522 (let ((plural-str (if all-p "s" "")))
5523 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5524 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5525 If R-LIST is nil, return matching element%s of S-LIST.
5526 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5527 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5528 This function is generated by a call to the macro `org-define-lookup-function'."
5529 mode-str plural-str plural-str plural-str)
5530 (let ,(let ((lvars '((p (or predicate 'equal))
5531 (sl s-list)
5532 (rl (or r-list s-list))
5533 (ret nil))))
5534 (if first-p (cons '(match-p nil) lvars) lvars))
5535 (while ,(if first-p '(and (not match-p) sl) 'sl)
5536 (when (funcall p val (car sl))
5537 ,(when first-p '(setq match-p t))
5538 (let ((rval (car rl)))
5539 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5540 (setq sl (cdr sl) rl (cdr rl)))
5541 ret)))))
5543 (org-define-lookup-function first)
5544 (org-define-lookup-function last)
5545 (org-define-lookup-function all)
5547 (provide 'org-table)
5549 ;; Local variables:
5550 ;; generated-autoload-file: "org-loaddefs.el"
5551 ;; End:
5553 ;;; org-table.el ends here