| blob | 307a3f0e8c9e0b674299dceeac8662898447a0a7 |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
77 "Hook for functions attaching to `C-c C-c', if the table is sent.
78 This can be used to add additional functionality after the table is sent
79 to the receiver position, otherwise, if table is not sent, the functions
85 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
86 In the optimized version, the table editor takes over all simple keys that
87 normally just insert a character. In tables, the characters are inserted
88 in a way to minimize disturbing the table structure (i.e. in overwrite mode
89 for empty fields). Outside tables, the correct binding of the keys is
90 restored.
92 The default for this option is t if the optimized version is also used in
93 Org mode. See the variable `org-enable-table-editor' for details. Changing
94 this variable requires a restart of Emacs to become effective."
100 % END RECEIVE ORGTBL %n
102 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
103 | | |
106 @c END RECEIVE ORGTBL %n
107 @ignore
108 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
109 | | |
112 <!-- END RECEIVE ORGTBL %n -->
113 <!--
114 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
115 | | |
118 #+ END RECEIVE ORGTBL %n
120 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
121 | | |
123 "Templates for radio tables in different major modes.
124 Each template must define lines that will be treated as a comment and that
127 insertion of the template. The transformed table will later be inserted
128 between these lines.
130 The template should also contain a minimal table in a multiline comment.
131 If multiline comments are not possible in the buffer language,
132 you can pack it into a string that will not be used when the code
133 is compiled or executed. Above the table will you need a line with
135 convert the table into a data structure useful in the
136 language of the buffer. Check the manual for the section on
138 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
140 All occurrences of %n in a template will be replaced with the name of the
141 table, obtained by prompting the user."
148 "Settings for tables in Org mode."
153 "The default size for newly created tables, Columns x Rows."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
159 "Regular expression for recognizing numbers in table columns.
160 If a table column contains mostly numbers, it will be aligned to the
161 right. If not, it will be aligned to the left.
163 The default value of this option is a regular expression which allows
164 anything which looks remotely like a number as used in scientific
165 context. For example, all of the following will be considered a
166 number:
167 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
169 Other options offered by the customize interface are more restrictive."
183 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
184 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
185 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
189 "Fraction of numbers in a column required to make the column align right.
190 In a column all non-white fields are considered. If at least
191 this fraction of fields is matched by `org-table-number-regexp',
192 alignment to the right border applies."
197 "Behavior of tables during editing in Org mode."
202 "Non-nil means automatically re-align table when pressing TAB or RETURN.
204 removal/insertion."
209 "Non-nil means automatically blank table field when starting to type into it.
210 This only happens when typing immediately after a field motion
211 command (TAB, S-TAB or RET).
212 Only relevant when `org-enable-table-editor' is equal to `optimized'."
217 "Non-nil means automatically exit the follow mode.
218 When nil, the follow mode will stay on and be active in any table
219 the cursor enters. Since the table follow filed mode messes with the
220 window configuration, it is not recommended to set this variable to nil,
221 except maybe locally in a special file that has mostly tables with long
222 fields."
228 "Whether the user should confirm when Org fixes formulas."
236 'safe-local-variable
240 "Non-nil means tab in the last column of a table with jump over a hline.
241 If a horizontal separator line is following the current line,
242 `org-table-next-field' can either create a new row before that line, or jump
243 over the line. When this option is nil, a new line will be created before
244 this line."
249 "Options concerning tables in Org mode."
254 "Non-nil means using table references like B3 instead of @3$2.
255 Possible values are:
256 nil never use them
257 from accept as input, do not present for editing
258 t accept as input and present for editing"
266 "Non-nil means increment when copying current field with \
279 calc-angle-mode deg
280 calc-prefer-frac nil
281 calc-symbolic-mode nil
283 calc-display-working-message t
284 )
285 "List with Calc mode settings for use in `calc-eval' for table formulas.
286 The list must contain alternating symbols (Calc modes variables and values).
287 Don't remove any of the default settings, just change the values. Org mode
288 relies on the variables to be present in the list."
293 "Format for the output of calc computations like $1+$2;t.
294 The default value is `hours', and will output the results as a
295 number of hours. Other allowed values are `seconds', `minutes' and
296 `days', and the output will be a fraction of seconds, minutes or
297 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
298 The `U' flag in a table formula will select this specific format for
299 a single formula."
309 "Non-nil means hours in table duration computations should be zero-padded.
310 So this is about 08:32:34 versus 8:33:34."
318 "Format for fields which contain the result of a formula.
320 characters. Beware that modifying the display can prevent the
321 field from being used in another formula."
327 "Non-nil means TAB and RET evaluate a formula in current table field.
328 If the current field starts with an equal sign, it is assumed to be a formula
329 which should be evaluated as described in the manual and in the documentation
330 string of the command `org-table-eval-formula'. This feature requires the
331 Emacs calc package.
332 When this variable is nil, formula calculation is only available through
338 "Non-nil means interpret constants in formulas in tables.
339 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
340 by the value given in `org-table-formula-constants', or by a value obtained
341 from the `constants.el' package."
346 "Alist with constant names and values, for use in table formulas.
347 The car of each element is a name of a constant, without the `$' before it.
348 The cdr is the value as a string. For example, if you'd like to use the
349 speed of light in a formula, you would configure
353 and then use it in an equation like `$1*$c'.
355 Constants can also be defined on a per-file basis using a line like
357 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
364 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
367 are pressed in the line."
372 "Non-nil means relative formula references may cross hlines.
373 Here are the allowed values:
375 nil Relative references may not cross hlines. They will reference the
376 field next to the hline instead. Coming from below, the reference
377 will be to the field below the hline. Coming from above, it will be
378 to the field above.
379 t Relative references may cross hlines.
380 error An attempt to cross a hline will throw an error.
382 It is probably good to never set this variable to nil, for the sake of
383 portability of tables."
391 "Non-nil means that evaluation of a field formula can add new
392 columns if an out-of-bounds field is being set."
399 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
403 "Options concerning table import and export in Org mode."
408 "Default export parameters for `org-table-export'.
409 These can be overridden for a specific table by setting the
410 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
411 radio tables for the different export transformations and
412 available parameters."
417 "Max lines that `org-table-convert-region' will attempt to process.
419 The function can be slow on larger regions; this safety feature
420 prevents it from hanging emacs."
443 "Alist with column names, derived from the `!' line.
447 "Regular expression matching the current column names.
451 "Alist with parameter names, derived from the `$' line.
455 "Alist with locations of named fields.
456 Associations follow the pattern (NAME LINE COLUMN) where
457 NAME is the name of the field as a string,
458 LINE is the number of lines from the beginning of the table,
459 COLUMN is the column of the field, as an integer.
463 "Table row types in current table.
467 "Current table begin position, as a marker.
471 "Number of columns in current table.
475 "Vector of data line line numbers in the current table.
476 Line numbers are counted from the beginning of the table. This
480 "Vector of hline line numbers in the current table.
481 Line numbers are counted from the beginning of the table. This
485 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
486 ;; 1 2 3 4 5
501 "Save current field; execute BODY; restore field.
502 Field is restored even in case of abnormal exit."
513 ;;;###autoload
515 "Use the table.el package to insert a new table.
516 If there is already a table at point, convert between Org tables
517 and table.el tables."
530 ;;;###autoload
532 "Convert region to table, or create an empty table.
533 If there is an active region, convert it to a table, using the function
534 `org-table-convert-region'. See the documentation of that function
535 to learn how the prefix argument is interpreted to determine the field
536 separator.
537 If there is no such region, create an empty table with `org-table-create'."
543 ;;;###autoload
545 "Query for a size and insert a table skeleton.
565 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
569 ;; Insert a hline after the first row.
576 ;;;###autoload
578 "Convert region to a table.
580 The region goes from BEG0 to END0, but these borders will be moved
581 slightly, to make sure a beginning of line in the first line is included.
583 SEPARATOR specifies the field separator in the lines. It can have the
584 following values:
586 (4) Use the comma as a field separator
587 (16) Use a TAB as field separator
588 (64) Prompt for a regular expression as field separator
589 integer When a number, use that many spaces, or a TAB, as field separator
590 regexp When a regular expression, use it to match the separator
591 nil When nil, the command tries to be smart and figure out the
592 separator in the following way:
593 - when each line contains a TAB, assume TAB-separated material
594 - when each line contains a comma, assume CSV material
595 - else, assume one or more SPACE characters as separator."
599 re)
601 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
602 org-table-convert-region-max-lines)
611 ;; Get the right field separator
622 ;; parse the csv stuff
647 ;;;###autoload
649 "Import FILE as a table.
650 The file is assumed to be tab-separated. Such files can be produced by most
651 spreadsheet and database applications. If no tabs (at least one per line)
652 are found, lines will be split on whitespace into fields."
661 ;;;###autoload
663 "Export table to a file, with configurable format.
664 Such a file can be imported into usual spreadsheet programs.
666 FILE can be the output file name. If not given, it will be taken
667 from a TABLE_EXPORT_FILE property in the current entry or higher
668 up in the hierarchy, or the user will be prompted for a file
669 name. FORMAT can be an export format, of the same kind as it
670 used when `orgtbl-mode' sends a table in a different format.
672 The command suggests a format depending on TABLE_EXPORT_FORMAT,
673 whether it is set locally or up in the hierarchy, then on the
674 extension of the given file name, and finally on the variable
675 `org-table-export-default-format'."
708 formats)))
709 org-table-export-default-format)
735 "Marker at the beginning of the table last aligned.
738 "Marker at the end of the table last aligned.
741 "List of flags for flushright alignment, from the last re-alignment.
744 "List of max width of fields in each column.
747 "Non-nil means debug table formulas.
757 ;;;###autoload
759 "Align the table at point by aligning all vertical bars."
764 ;; Make sure invisible characters in the table are at the right
765 ;; place since column widths take them into account.
771 ;; Table's rows. Separators are replaced by nil. Trailing
772 ;; spaces are also removed.
778 l)))
780 ;; Get the data fields by splitting the lines.
783 ;; Compute number of fields in the longest line. If the
784 ;; table contains no field, create a default table.
789 ;; A list of empty strings to fill any short rows on output.
791 lengths typenums)
792 ;; Check for special formatting.
795 fmax falign)
796 ;; Look for an explicit width or alignment.
809 ;; Find fields that are wider than FMAX, and shorten them.
814 'help-echo
822 fmax)))
836 f2
838 x))))))
839 ;; Get the maximum width for each column
841 lengths)
842 ;; Get the fraction of numbers among non-empty cells to
843 ;; decide about alignment of the column.
852 1
858 ;; Store alignment of this table, for later editing of single
859 ;; fields.
862 ;; With invisible characters, `format' does not get the field
863 ;; width right So we need to make these fields wide by hand.
864 ;; Invisible characters may be introduced by fontified links,
865 ;; emphasis, macros or sub/superscripts.
883 ;; Compute the formats needed for output of the table.
892 ;; Replace modified lines only. Check not only contents, but
893 ;; also columns' width.
897 hfmt))
919 ;;;###autoload
921 "Find the beginning of the table and return its position.
922 With a non-nil optional argument TABLE-TYPE, return the beginning
923 of a table.el-type table. This function assumes point is on
924 a table."
932 ;;;###autoload
934 "Find the end of the table and return its position.
935 With a non-nil optional argument TABLE-TYPE, return the end of
936 a table.el-type table. This function assumes point is on
937 a table."
945 ;; When the line right after the table is the last line in
946 ;; the buffer with trailing spaces but no final newline
947 ;; character, be sure to catch the correct ending at its
948 ;; beginning. In any other case, ending is expected to be
949 ;; at point max.
954 ;;;###autoload
956 "Justify the current field, text to left, number to right.
957 Optional argument NEW may specify text to replace the current field content."
966 ;; This is not the same table, force a full re-align.
969 ;; Realign the current field, based on previous full realign.
982 len
997 ;;;###autoload
999 "Go to the next field in the current table, creating new lines as needed.
1000 Before doing so, re-align the table if necessary."
1005 org-table-may-need-update)
1016 org-table-tab-jumps-over-hlines
1027 ;;;###autoload
1029 "Go to the previous field in the table.
1030 Before doing so, re-align the table if necessary."
1035 org-table-may-need-update)
1053 "Move to the beginning of the current table field.
1054 If already at or before the beginning, move to the beginning of the
1055 previous field.
1056 With numeric argument N, move N-1 fields backward first."
1069 "Move to the end of the current table field.
1070 If already at or after the end, move to the end of the next table field.
1071 With numeric argument N, move N-1 fields forward first."
1084 ;;;###autoload
1086 "Go to the next row (same column) in the current table.
1087 Before doing so, re-align the table if necessary."
1095 org-table-may-need-update)
1108 ;;;###autoload
1110 "Copy the value of the current field one row below.
1112 If the field at the cursor is empty, copy the content of the
1113 nearest non-empty field above. With argument N, use the Nth
1114 non-empty field.
1116 If the current field is not empty, it is copied down to the next
1117 row, and the cursor is moved with it. Therefore, repeating this
1118 command causes the column to be filled row-by-row.
1120 If the variable `org-table-copy-increment' is non-nil and the
1121 field is an integer or a timestamp, it will be incremented while
1122 copying. By default, increment by the difference between the
1123 value in the current field and the one in the field above. To
1124 increment using a fixed integer, set `org-table-copy-increment'
1125 to a number. In the case of a timestamp, increment by days."
1137 txt txt-up inc)
1145 beg t))
1155 beg t))
1162 ;; Above field was not empty, go down to the next row
1195 "Is point inside a table data field?
1196 I.e. not on a hline or before the first or after the last column?
1197 This actually throws an error, so it aborts the current command."
1209 "Get the field in table line LINE, column COLUMN.
1210 If LINE is larger than the number of data lines in the table, the function
1211 returns nil. However, if COLUMN is too large, we will simply return an
1212 empty string.
1213 If LINE is nil, use the current line.
1214 If COLUMN is nil, use the current column."
1221 "Put VALUE into line LINE, column COLUMN.
1222 When ALIGN is set, also realign the table."
1231 "Return the index of the current data line."
1238 cnt))
1241 "Go to the Nth data line in the current table.
1242 Return t when the line exists, nil if it does not exist."
1249 ;;;###autoload
1251 "Blank the current table field or active region."
1268 "Return the value of the field in column N of current row.
1269 N defaults to current column. If REPLACE is a string, replace
1270 field with this value. The return value is always the old
1271 value."
1275 ;; Before first column or after last one.
1276 ""
1283 val)))
1285 ;;;###autoload
1287 "Show info about the current field, and highlight any reference at point."
1297 col)
1298 org-table-named-field-locations)))
1308 ;; Prioritize field formulas over column formulas.
1317 dline col
1319 dline col ref1
1321 ;; FIXME: formula info not correct if special table line
1328 ""
1334 "Find out which column we are in."
1340 column)))
1343 "Find out what table data line we are in.
1344 Only data lines count for this."
1352 c)))
1354 ;;;###autoload
1356 "Move the cursor to the Nth column in the current table line.
1357 With optional argument ON-DELIM, stop with point before the left delimiter
1358 of the field.
1359 If there are less than N fields, just go to after the last delimiter.
1360 However, when FORCE is non-nil, create new columns if necessary."
1370 t)))))
1377 ;;;###autoload
1379 "Insert a new column into the table."
1401 "Find a data line in the current table, which is needed for column commands."
1404 t
1415 t
1420 "Turn a buffer line number into a data line number.
1422 If there is no data line in this line, return nil.
1424 If there is no matching dline (most likely the reference was
1425 a hline), the first dline below it is used. When ABOVE is
1426 non-nil, the one above is used."
1431 nil)
1442 ;;;###autoload
1444 "Delete a column from the table."
1456 nil
1471 ;;;###autoload
1473 "Move column to the right."
1476 ;;;###autoload
1478 "Move column to the left."
1482 ;;;###autoload
1484 "Move the current column to the right. With arg LEFT, move to the left."
1520 ;;;###autoload
1522 "Move table row down."
1525 ;;;###autoload
1527 "Move table row up."
1531 ;;;###autoload
1533 "Move the current table line down. With arg UP, move it up."
1542 hline2p)
1568 ;;;###autoload
1570 "Insert a new row above the current line into the table.
1571 With prefix ARG, insert below the current line."
1576 ;; Fix the first field if necessary
1580 ;; Buffer may not end of a newline character, so ensure
1581 ;; (beginning-of-line 2) moves point to a new line.
1592 ;;;###autoload
1594 "Insert a horizontal-line below the current line into the table.
1595 With prefix ABOVE, insert above the current line."
1616 ;;;###autoload
1618 "Insert a hline and move to the row below that line."
1632 In particular, this does handle wide and invisible characters."
1634 ;; It's a hline, just map the characters
1640 t t s)))
1641 s))
1643 ;;;###autoload
1645 "Delete the current row or horizontal line from the table."
1659 ;;;###autoload
1662 "Sort table lines according to the column at point.
1664 The position of point indicates the column to be used for
1665 sorting, and the range of lines is the range between the nearest
1666 horizontal separator lines, or the entire table of no such lines
1667 exist. If point is before the first column, you will be prompted
1668 for the sorting column. If there is an active region, the mark
1669 specifies the first line and the sorting column, while point
1670 should be in the last line to be included into the sorting.
1672 The command then prompts for the sorting type which can be
1673 alphabetically, numerically, or by time (as given in a time stamp
1674 in the field, or as a HH:MM value). Sorting in reverse order is
1675 also possible.
1677 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1679 If SORTING-TYPE is specified when this function is called from a Lisp
1680 program, no prompting will take place. SORTING-TYPE must be a character,
1681 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1682 sorting should be done in reverse order.
1684 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1685 a function to be called to extract the key. It must return a value
1686 that is compatible with COMPARE-FUNC, the function used to compare
1687 entries.
1689 A non-nil value for INTERACTIVE? is used to signal that this
1690 function is being called interactively."
1693 ;; Point must be either within a field or before a data line.
1698 ;; Set appropriate case sensitivity and column used for sorting.
1709 ;; Narrow buffer to appropriate sorting area.
1722 start))
1725 end))))
1726 ;; Determine arguments for `sort-subr'. Also record original
1727 ;; position. `org-table-save-field' cannot help here since
1728 ;; sorting is too much destructive.
1734 ;; Function to be called on the contents of the field
1735 ;; used for sorting in the current row.
1771 #'end-of-line
1775 nil
1776 predicate)
1777 ;; Move back to initial field.
1781 ;;;###autoload
1783 "Copy region in table to the clipboard and blank all relevant fields.
1784 If there is no active region, use just the field at point."
1790 ;;;###autoload
1792 "Copy rectangular region in table to clipboard.
1793 A special clipboard is used which can only be accessed
1794 with `org-table-paste-rectangle'."
1798 current-prefix-arg))
1803 region)
1815 ;; Collect every cell between COLUMN-START and COLUMN-END.
1825 ;;;###autoload
1827 "Paste a rectangular region into a table.
1828 The upper right corner ends up in the current field. All involved fields
1829 will be overwritten. If the rectangle does not fit into the present table,
1830 the table is enlarged as needed. The process ignores horizontal separator
1831 lines."
1841 ;; If we left the table, create a new row.
1853 ;;;###autoload
1855 "Convert from `org-mode' table to table.el and back.
1856 Obviously, this only works within limits. When an Org table is converted
1857 to table.el, all horizontal separator lines get lost, because table.el uses
1858 these as cell boundaries and has no notion of horizontal lines. A table.el
1859 table can be converted to an Org table only if it does not do row or column
1860 spanning. Multiline cells will become multiple cells. Beware, Org mode
1861 does not test if the table can be successfully converted - it blindly
1862 applies a recipe that works for simple tables."
1866 ;; convert to Org table
1875 ;; convert to table.el table
1878 ;; first, get rid of all horizontal lines
1882 ;; insert a hline before first
1886 ;; insert a hline after each line
1891 ;; replace "+" at beginning and ending of hlines
1900 "Transpose Org table at point and eliminate hlines.
1901 So a table like
1903 | 1 | 2 | 4 | 5 |
1904 |---+---+---+---|
1905 | a | b | c | d |
1906 | e | f | g | h |
1908 will be transposed as
1910 | 1 | a | e |
1911 | 2 | b | f |
1912 | 4 | c | g |
1913 | 5 | d | h |
1915 Note that horizontal lines disappear."
1927 table)))
1941 ;;;###autoload
1943 "Wrap several fields in a column like a paragraph.
1944 This is useful if you'd like to spread the contents of a field over several
1945 lines, in order to keep the table compact.
1947 If there is an active region, and both point and mark are in the same column,
1948 the text in the column is wrapped to minimum width for the given number of
1949 lines. Generally, this makes the table more compact. A prefix ARG may be
1950 used to change the number of desired lines. For example, \
1952 formats the selected text to two lines. If the region was longer than two
1953 lines, the remaining lines remain empty. A negative prefix argument reduces
1954 the current number of lines by that amount. The wrapped text is pasted back
1955 into the table. If you formatted it to more lines than it was before, fields
1956 further down in the table get overwritten - so you might need to make space in
1957 the table first.
1959 If there is no region, the current field is split at the cursor position and
1960 the text fragment to the right of the cursor is prepended to the field one
1961 line down.
1963 If there is no region, but you specify a prefix ARG, the current field gets
1964 blank, and the content is appended to the field above."
1968 ;; There is a region: fill as a paragraph.
1979 nil
1980 nlines))))
1983 ;; No region, split the current field at point.
2008 ;;;###autoload
2010 "Edit table field in a different window.
2011 This is mainly useful for fields that contain hidden parts.
2014 visible so that it can be edited in place.
2017 toggle `org-table-follow-field-mode'."
2027 display t intangible t))
2040 p)
2056 intangible t))
2064 "Finish editing a table data field.
2065 Remove all newline characters, insert the result into the table, realign
2066 the table and kill the editing buffer."
2070 text)
2087 "Minor mode to make the table field editor window follow the cursor.
2088 When this mode is active, the field editor window will always show the
2089 current field. The mode exits automatically when the cursor leaves the
2090 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2091 nil " TblFollow" nil
2107 ;; We have left the table, exit the follow mode
2117 ;;;###autoload
2119 "Sum numbers in region of current table column.
2120 The result will be displayed in the echo area, and will be available
2123 If there is an active region, it is interpreted as a rectangle and all
2124 numbers in that rectangle will be summed. If there is no active
2125 region and point is located in a table column, sum all numbers in that
2126 column.
2128 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2129 numbers are assumed to be times as well (in decimal hours) and the
2130 numbers are added as such.
2132 If NLAST is a number, only the NLAST fields will actually be summed."
2159 items1)))
2166 s diff)
2173 sres))))
2196 "Return the formula active for the current field.
2198 Assumes that table is already analyzed. If KEY is given, return
2199 the key to this formula. Otherwise return the formula preceded
2208 org-table-named-field-locations)))
2222 "Read a formula from the minibuffer, offer stored formula as default.
2223 When NAMED is non-nil, look for a named equation."
2228 org-table-named-field-locations)))
2241 stored)
2243 equation)
2249 scol))
2251 'org-table-formula-history
2252 )))))
2253 mustsave)
2255 ;; remove formula
2262 ;; We set the column equation, delete the named one.
2264 mustsave t))
2270 eq))
2273 "Store the list of formulas below the current table.
2274 If optional argument LOCATION is a buffer position, insert it at
2275 LOCATION instead."
2283 ;; Don't overwrite TBLFM, we might use text properties to
2284 ;; store stuff.
2298 ;; Fake a high number to make sure this is sorted at the end.
2305 a)
2315 "Compare two formulas for sorting."
2320 ;;;###autoload
2322 "Return an alist with the stored formulas directly after current table.
2323 By default, only return active formulas, i.e., formulas located
2324 on the first line after the table. However, if optional argument
2325 LOCATION is a buffer position, consider the formulas there."
2334 eq-alist seen)
2338 string)
2343 ;; Is it a column reference?
2345 ;; Since named columns are not possible in
2346 ;; LHS, assume this is a named field.
2354 "Double definition `%s=' in TBLFM line, please fix by hand"
2355 lhs)
2360 "Double definition `%s=' in TBLFM line, please fix by hand"
2361 lhs)))))))))))
2364 "Modify the equations after the table structure has been edited.
2366 For all numbers larger than LIMIT, shift them by DELTA."
2378 s n a)
2384 "Change makes TBLFM term %s invalid, use undo to recover"
2399 ;;;###autoload
2402 If yes, store the formula and apply it."
2403 ;; We already know we are in a table. Get field will only return a formula
2404 ;; when appropriate. It might return a separator line, but no problem.
2407 named eq)
2415 "List of commands triggering the recalculation of a line.
2427 ;;;###autoload
2429 "Rotate the recalculation mark in the first column.
2430 If in any row, the first field is not consistent with a mark,
2431 insert a new column for the markers.
2432 When there is an active region, change all the lines in the region,
2433 after prompting for the marking character.
2434 After each change, a message will be displayed indicating the meaning
2435 of the new mark."
2451 newchar))
2459 newchar))
2477 ;; Rotate mark in first row.
2479 ;; Rotate marks in additional rows if a region is active.
2487 ;; Only align if rotation actually changed lines' length.
2497 ;;;###autoload
2499 "Analyze table at point and store results.
2501 This function sets up the following dynamically scoped variables:
2503 `org-table-column-name-regexp',
2504 `org-table-column-names',
2505 `org-table-current-begin-pos',
2506 `org-table-current-line-types',
2507 `org-table-current-ncol',
2508 `org-table-dlines',
2509 `org-table-hlines',
2510 `org-table-local-parameters',
2511 `org-table-named-field-locations'."
2516 ;; Extract column names.
2529 ;; Extract local parameters.
2537 org-table-local-parameters)))))
2538 ;; Update named fields locations. We minimize `count-lines'
2539 ;; processing by storing last known number of lines in LAST.
2561 field))
2564 org-table-named-field-locations))))))))))
2565 ;; Re-use existing markers when possible.
2569 ;; Analyze the line types.
2580 ;; Get the number of columns from the first data line in table.
2588 al al2)
2602 "Move point to a specific field in the current table.
2604 REF is either the name of a field its absolute reference, as
2605 a string. No column is created unless CREATE-COLUMN-P is
2606 non-nil. If it is a function, it is called with the column
2607 number as its argument as is used as a predicate to know if the
2608 column can be created.
2610 This function assumes the table is already analyzed (i.e., using
2611 `org-table-analyze')."
2626 create-column-p)))
2632 ;;;###autoload
2634 "Recompute the current line if marked for it, and if we haven't just done it."
2654 org-tbl-calc-modes)
2656 ;;;###autoload
2658 suppress-align suppress-const
2659 suppress-store suppress-analysis)
2660 "Replace the table field value at the cursor by the result of a calculation.
2662 In a table, this command replaces the value in the current field with the
2664 formula, by storing it in a special line below the table. When called
2666 field formula.
2669 insert the active equation for the field
2670 back into the current field, so that it can be edited there. This is \
2671 useful
2673 check the referenced fields.
2675 When called, the command first prompts for a formula, which is read in
2676 the minibuffer. Previously entered formulas are available through the
2677 history list, and the last used formula is offered as a default.
2678 These stored formulas are adapted correctly when moving, inserting, or
2679 deleting columns with the corresponding commands.
2681 The formula can be any algebraic expression understood by the Calc package.
2682 For details, see the Org mode manual.
2684 This function can also be called from Lisp programs and offers
2685 additional arguments: EQUATION can be the formula to apply. If this
2686 argument is given, the user will not be prompted.
2688 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2689 unnecessary aligns.
2691 SUPPRESS-CONST suppresses the interpretation of constants in the
2692 formula, assuming that this has been done already outside the
2693 function.
2695 SUPPRESS-STORE means the formula should not be stored, either
2696 because it is already stored, or because it is a modified
2697 equation that should not overwrite the stored one.
2699 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2700 location of point."
2716 equation
2722 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2723 duration duration-output-format)
2724 ;; Parse the format string. Since we have a lot of modes, this is
2725 ;; a lot of work. However, I think calc still uses most of the time.
2738 'calc-float-format
2741 n))))
2746 duration-output-format
2775 ;; replace fields with duration values if relevant
2779 fields)))
2785 x))
2786 fields)))
2792 ;; Insert row and column number of formula result field
2803 t t form)))
2805 ;; Check for old vertical references
2807 ;; Insert remote references
2820 rmtrng))
2821 keep-empty numbers lispp))
2822 t t form)))
2823 ;; Insert complex ranges
2833 ;; possibly handle durations
2838 formrg)
2839 keep-empty numbers lispp)))
2844 ;; Insert simple ranges, i.e. included in the current row.
2847 form)
2858 keep-empty numbers lispp))
2859 t t form)))
2861 ;; Insert the references to fields in same row
2868 x keep-empty numbers lispp)))
2885 ;; Use <...> time-stamps so that Calc can handle them.
2888 ;; Internationalize local time-stamps by setting locale to
2889 ;; "C".
2892 org-ts-regexp
2900 form t t))
2903 form
2910 duration-output-format)
2911 ev)))
2916 Orig: %s
2917 $xyz-> %s
2918 @r$c-> %s
2941 ;; Replace any active time stamp in the result with
2942 ;; an inactive one. Dates in tables are likely
2943 ;; piece of regular data, not meant to appear in the
2944 ;; agenda.
2957 prop value)))
2960 "Get a calc vector from a column, according to descriptor DESC.
2962 Optional arguments TBEG and COL can give the beginning of the table and
2963 the current column, to avoid unnecessary parsing.
2965 HIGHLIGHT means just highlight the range.
2967 When CORNERS-ONLY is set, only return the corners of the range as
2968 a list (line1 column1 line2 column2) where line1 and line2 are
2969 line numbers relative to beginning of table, or TBEG, and column1
2970 and column2 are table column numbers."
2973 desc))
2984 thisline)))
2989 thisline)))
3001 ;; Just one field.
3008 ;; A range, return a vector. First sort the numbers to get
3009 ;; a regular rectangle.
3015 ;; Copy the range values into a list.
3030 ;; Return string representation of calc vector.
3036 "Return relative line number corresponding to descriptor DESC.
3037 The cursor is currently in relative line number CLINE."
3042 ;; 1 2 3 4 5 6
3043 desc))
3065 cline)))
3068 "Return relative line of Nth row with type TYPE.
3069 Search starts from relative line I. When BACKWARDS in non-nil,
3070 look before I. When RELATIVE is non-nil, the reference is
3071 relative. DESC is the original descriptor that started the
3072 search, as a string."
3080 ;; We are going to cross a hline. Check if this is
3081 ;; an authorized move.
3092 ;; The last hline doesn't exist. Instead, point to last row
3093 ;; in table.
3102 "Convert list ELEMENTS to something appropriate to insert into formula.
3103 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3104 NUMBERS indicates that everything should be converted to numbers.
3105 LISPP non-nil means to return something appropriate for a Lisp
3106 list, `literal' is for the format specifier L."
3107 ;; Calc nan (not a number) is used for the conversion of the empty
3108 ;; field to a reference for several reasons: (i) It is accepted in a
3109 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3110 ;; (ii) In a single field (not in range) it can be distinguished
3111 ;; from "(nan)" which is the reference made from a single field
3112 ;; containing "nan".
3114 ;; field reference
3117 elements
3119 ""
3128 ;; range reference
3133 elements))))
3139 x
3147 x)
3149 elements
3153 "If there has been more than one second since T1, display message.
3154 ARGS are passed as arguments to the `message' function. Returns
3155 current time if a message is printed, otherwise returns T1. If
3156 T1 is nil, always messages."
3160 curtime)
3161 t1)))
3163 ;;;###autoload
3165 "Recalculate the current table line by applying all stored formulas.
3167 With prefix arg ALL, do this for all lines in the table.
3170 if ALL is the symbol `iterate',
3171 recompute the table until it no longer changes.
3173 If NOALIGN is not nil, do not re-align the table after the computations
3174 are done. This is typically used internally to save time, if it is
3175 known that the table will be realigned a little later anyway."
3190 beg end eqlcol eqlfield)
3191 ;; Insert constants in all formulas.
3194 ;; Expand equations, then split the equation list between
3195 ;; column formulas and field formulas.
3207 old-lhs)))
3210 existing formula for column %s"
3211 old-lhs
3212 new))
3213 new))
3219 ;; Expand ranges in lhs of formulas
3221 ;; Get the correct line range to process.
3228 ;; This is a table with marked lines, compute selected
3229 ;; lines.
3231 ;; Move forward to the first non-header line.
3236 ;; Just leave BEG at the start of the table.
3241 ;; Mark named fields untouchable. Also check if several
3242 ;; field/range formulas try to set the same field.
3246 seen-fields)
3257 ;; Turn field coordinates associated to NAME
3258 ;; into an absolute reference.
3262 name)))
3265 reference))
3270 ;; Evaluate the column formulas, but skip fields covered by
3271 ;; field formulas.
3275 ;; Unprotected line, recalculate.
3280 log-last-time
3293 ;; Evaluate the field formulas.
3302 reference
3303 ;; Possibly create a new column, as long as
3304 ;; `org-table-formula-create-columns' allows it.
3316 t))
3321 ;; Clean up markers and internal text property.
3332 ;;;###autoload
3334 "Recalculate the table until it does not change anymore.
3335 The maximum number of iterations is 10, but you can choose a different value
3336 with the prefix ARG."
3341 thistbl)
3355 ;;;###autoload
3357 "Recalculate all tables in the current buffer."
3362 ;; Reason for separate `org-table-align': When repeating
3363 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3364 ;; the way.
3367 t)))
3369 ;;;###autoload
3371 "Iterate all tables in the buffer, to converge inter-table dependencies."
3376 c1)
3392 "Apply the #+TBLFM in the line at point to the table."
3399 ;; Insert a temporary formula at right after the table
3404 ;; Recalculate the table.
3409 ;; Delete the formula inserted temporarily.
3415 "Find the beginning of the TBLFM lines and return its position.
3416 Return nil when the beginning of TBLFM line was not found."
3423 "Expand list of formulas.
3424 If some of the RHS in the formulas are ranges or a row reference,
3425 expand them to individual field equations for each field. This
3426 function assumes the table is already analyzed (i.e., using
3427 `org-table-analyze')."
3434 ;; This just refers to one fixed field.
3437 ;; This just refers to one fixed named field.
3440 ;; Column formulas are treated specially and are not
3441 ;; expanded.
3446 rhs)
3447 res)))
3459 rhs)
3460 res))))))))))
3463 "Replace @<, @>, $<, $> with first/last row/column of the table.
3464 So @< and $< will always be replaced with @1 and $1, respectively.
3465 The advantage of these special markers are that structure editing of
3466 the table will not change them, while @1 and $1 will be modified
3467 when a line/row is swapped out of that privileged position. So for
3468 formulas that use a range of rows or columns, it may often be better
3470 borders of the table using the @< @> $< $> makers."
3473 s start)
3478 org-table-current-ncol)
3482 len
3489 s)
3492 "Replace $const with values in string F."
3497 org-table-column-name-regexp
3500 org-table-column-names))))
3501 f t t)))
3502 ;; Parameters and constants.
3506 new start))
3509 ;; When a duration is expected, convert value on the fly.
3515 v)))))
3522 "Find the value for a parameter or constant in a formula.
3523 Parameters get priority."
3554 map))
3561 "--"
3564 "--"
3565 "Shift Reference at Point"
3570 "-"
3571 "Change Test Row for Column Formulas"
3574 "--"
3579 org-table-overlay-coordinates)]
3580 "--"
3588 ;;;###autoload
3590 "Edit the formulas of the current table in a separate buffer."
3596 ;; Move point within the table before analyzing it.
3612 ;; Keep global-font-lock-mode from turning on font-lock-mode
3657 "Convert a formula from internal to user representation."
3660 s))
3663 "Convert a formula from user to internal representation."
3666 s))
3669 "Convert spreadsheet references from A7 to @7$28.
3670 Works for single references, but also for entire formulas and even the
3671 full TBLFM line."
3673 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3676 ;; format match, just advance
3681 ;; 3.e5 or something like this.
3684 ;; (member (match-string 1 s)
3685 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3686 )
3687 ;; function name, just advance
3697 t t s)))))
3698 s))
3701 "Convert spreadsheet references from to @7$28 to AB7.
3702 Works for single references, but also for entire formulas and even the
3703 full TBLFM line."
3710 t t s)))
3715 t nil s)))
3716 s)
3719 "Convert a base 26 number represented by letters into an integer.
3720 For example: AB -> 28."
3726 n))
3729 "Convert an integer into a base 26 number represented by letters.
3730 For example: 28 -> AB."
3735 s))
3738 "Convert a time string into numerical duration in seconds.
3739 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3740 If S is a string representing a number, keep this number."
3742 s
3765 "Convert a number of seconds to a time string.
3766 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3767 minutes or seconds."
3779 ;; Ignore seconds
3783 secs0)
3788 secs0)))))
3792 "Convert all references in this buffer, using FUNCTION."
3803 "Convert all references in the buffer from B3 to @3$2 and back."
3813 "Shift the reference at point one row/hline up."
3817 "Shift the reference at point one row/hline down."
3821 "Shift the reference at point one field to the left."
3825 "Shift the reference at point one field to the right."
3836 ;; A B3-like reference
3842 ;; An internal reference
3848 "Re-match the group N, and replace it with the shifted reference."
3853 t t)))
3856 "Shift a reference part REF.
3857 If DECR is set, decrease the references row/column, else increase.
3858 If HLINE is set, this may be a hline reference, it certainly is not
3859 a translation reference."
3888 "Toggle the display of coordinates in the referenced table."
3897 "Parse the buffer for formula definitions and install them.
3898 With prefix ARG, apply the new formulas to the table."
3907 eql)
3910 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3911 nil t)
3932 "Abort editing formulas, without installing the changes."
3943 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3984 "Show the location/value of the $ expression at point.
3985 When LOCAL is non-nil, show references for the table at point."
3995 var name e what match dest)
3999 "$1.."
4051 dest)
4077 ;; Column number.
4103 org-table-fedit-scroll-down))))
4115 "Make sure the cursor is in a dataline in a table."
4124 p1 p2)))
4129 "Move cursor one line up in the window showing the table."
4134 "Move cursor one line down in the window showing the table."
4139 "Move the cursor in the window showing the table.
4140 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4165 "Add a new overlay."
4171 "Highlight rectangular region in a table.
4172 When buffer positions BEG and END are provided, use them to
4173 delimit the region to highlight. Otherwise, refer to point. Use
4174 FACE, when non-nil, for the highlight."
4206 "Remove the rectangle overlays."
4216 "Add overlays to the table at point, to show row/column coordinates."
4244 ;;;###autoload
4246 "Toggle the display of Row/Column numbers in tables."
4257 ;;;###autoload
4259 "Toggle the formula debugger in tables."
4265 ;;; The orgtbl minor mode
4267 ;; Define a minor mode which can be used in other modes in order to
4268 ;; integrate the Org table editor.
4270 ;; This is really a hack, because the Org table editor uses several
4271 ;; keys which normally belong to the major mode, for example the TAB
4272 ;; and RET keys. Here is how it works: The minor mode defines all the
4273 ;; keys necessary to operate the table editor, but wraps the commands
4274 ;; into a function which tests if the cursor is currently inside
4275 ;; a table. If that is the case, the table editor command is
4276 ;; executed. However, when any of those keys is used outside a table,
4277 ;; the function uses `key-binding' to look up if the key has an
4278 ;; associated command in another currently active keymap (minor modes,
4279 ;; major mode, global), and executes that command. There might be
4280 ;; problems if any of the keys used by the table editor is otherwise
4281 ;; used as a prefix key.
4283 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4284 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4285 ;; addresses this by checking explicitly for both bindings.
4287 ;; The optimized version (see variable `orgtbl-optimized') takes over
4288 ;; all keys which are bound to `self-insert-command' in the *global map*.
4289 ;; Some modes bind other commands to simple characters, for example
4290 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4291 ;; active, this binding is ignored inside tables and replaced with a
4292 ;; modified self-insert.
4310 ;; Install it as a minor mode.
4314 ;;;###autoload
4316 "The `org-mode' table editor as a minor mode for use in other modes."
4321 ;; Exit without error, in case some hook functions calls this
4322 ;; by accident in org-mode.
4326 ;; Make sure we are first in minor-mode-map-alist
4328 ;; FIXME: maybe it should use emulation-mode-map-alists?
4335 auto-fill-inhibit-regexp)
4339 auto-fill-inhibit-regexp)
4340 orgtbl-line-start-regexp))
4358 "Remove all properties related to narrow-column invisibility."
4371 "Create a function for binding in the table minor mode.
4372 FUN is the command to call inside a table. N is used to create a unique
4373 command name. KEYS are keys that should be checked in for a command
4374 to execute outside of tables."
4380 "Outside of tables, run the binding of `"
4392 keys)
4396 "Error when there is no default binding for a table key."
4401 "Setup orgtbl keymaps."
4432 elt key fun cmd)
4440 ;; Special treatment needed for TAB, RET and DEL
4453 (orgtbl-make-binding 'org-delete-backward-char 109
4459 [(tab)] "\C-i"))
4461 (org-defkey orgtbl-mode-map [backtab]
4463 [backtab] [S-iso-lefttab] [(shift tab)]
4464 [(tab)] "\C-i"))
4466 (org-defkey orgtbl-mode-map "\M-\C-m"
4467 (orgtbl-make-binding 'org-table-wrap-region 105
4468 "\M-\C-m" [(meta return)]))
4469 (org-defkey orgtbl-mode-map [(meta return)]
4470 (orgtbl-make-binding 'org-table-wrap-region 106
4471 [(meta return)] "\M-\C-m"))
4473 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4474 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4476 (when orgtbl-optimized
4477 ;; If the user wants maximum table support, we need to hijack
4478 ;; some standard editing functions
4479 (org-remap orgtbl-mode-map
4480 'self-insert-command 'orgtbl-self-insert-command
4481 'delete-char 'org-delete-char
4482 'delete-backward-char 'org-delete-backward-char)
4483 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4484 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4485 '("OrgTbl"
4486 ["Create or convert" org-table-create-or-convert-from-region
4487 :active (not (org-at-table-p)) :keys "C-c |" ]
4488 "--"
4489 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4490 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4491 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4492 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4493 "--"
4494 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4495 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4496 ["Copy Field from Above"
4497 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4498 "--"
4499 ("Column"
4500 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4501 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4502 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4503 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4504 ("Row"
4505 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4506 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4507 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4508 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4509 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4510 "--"
4511 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4512 ("Rectangle"
4513 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4514 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4515 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4516 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4517 "--"
4518 ("Radio tables"
4519 ["Insert table template" orgtbl-insert-radio-table
4520 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4521 ["Comment/uncomment table" orgtbl-toggle-comment t])
4522 "--"
4523 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4524 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4525 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4526 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4527 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4528 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4529 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4530 ["Sum Column/Rectangle" org-table-sum
4531 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4532 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4533 ["Debug Formulas"
4534 org-table-toggle-formula-debugger :active (org-at-table-p)
4535 :keys "C-c {"
4536 :style toggle :selected org-table-formula-debug]
4537 ["Show Col/Row Numbers"
4538 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4539 :keys "C-c }"
4540 :style toggle :selected org-table-overlay-coordinates]
4541 "--"
4542 ("Plot"
4545 t))
4547 (defun orgtbl-ctrl-c-ctrl-c (arg)
4548 "If the cursor is inside a table, realign the table.
4549 If it is a table to be sent away to a receiver, do it.
4550 With prefix arg, also recompute table."
4551 (interactive "P")
4552 (let ((case-fold-search t) (pos (point)) action)
4553 (save-excursion
4554 (beginning-of-line 1)
4555 (setq action (cond
4559 (cond
4560 ((integerp action)
4561 (goto-char action)
4562 (org-table-maybe-eval-formula)
4563 (if arg
4564 (call-interactively 'org-table-recalculate)
4565 (org-table-maybe-recalculate-line))
4566 (call-interactively 'org-table-align)
4567 (when (orgtbl-send-table 'maybe)
4568 (run-hooks 'orgtbl-after-send-table-hook)))
4569 ((eq action 'recalc)
4570 (save-excursion
4571 (beginning-of-line 1)
4573 (if (org-at-table-p)
4574 (org-call-with-arg 'org-table-recalculate t))))
4575 (t (let (orgtbl-mode)
4576 (call-interactively (key-binding "\C-c\C-c")))))))
4578 (defun orgtbl-create-or-convert-from-region (_arg)
4579 "Create table or convert region to table, if no conflicting binding.
4580 This installs the table binding `C-c |', but only if there is no
4581 conflicting binding to this key outside orgtbl-mode."
4582 (interactive "P")
4583 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4584 (if cmd
4585 (call-interactively cmd)
4586 (call-interactively 'org-table-create-or-convert-from-region))))
4588 (defun orgtbl-tab (arg)
4589 "Justification and field motion for `orgtbl-mode'."
4590 (interactive "P")
4591 (if arg (org-table-edit-field t)
4592 (org-table-justify-field-maybe)
4593 (org-table-next-field)))
4595 (defun orgtbl-ret ()
4596 "Justification and field motion for `orgtbl-mode'."
4597 (interactive)
4598 (if (bobp)
4599 (newline)
4600 (org-table-justify-field-maybe)
4601 (org-table-next-row)))
4603 (defun orgtbl-self-insert-command (N)
4604 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4605 If the cursor is in a table looking at whitespace, the whitespace is
4606 overwritten, and the table is not marked as requiring realignment."
4607 (interactive "p")
4608 (if (and (org-at-table-p)
4609 (or
4610 (and org-table-auto-blank-field
4611 (member last-command
4612 '(orgtbl-hijacker-command-100
4613 orgtbl-hijacker-command-101
4614 orgtbl-hijacker-command-102
4615 orgtbl-hijacker-command-103
4616 orgtbl-hijacker-command-104
4617 orgtbl-hijacker-command-105
4618 yas/expand))
4619 (org-table-blank-field))
4620 t)
4621 (eq N 1)
4623 (let (org-table-may-need-update)
4624 (delete-region (match-beginning 1) (match-end 1))
4625 (self-insert-command N))
4626 (setq org-table-may-need-update t)
4627 (let* (orgtbl-mode
4628 a
4629 (cmd (or (key-binding
4630 (or (and (listp function-key-map)
4631 (setq a (assoc last-input-event function-key-map))
4632 (cdr a))
4633 (vector last-input-event)))
4634 'self-insert-command)))
4635 (call-interactively cmd)
4636 (if (and org-self-insert-cluster-for-undo
4637 (eq cmd 'self-insert-command))
4638 (if (not (eq last-command 'orgtbl-self-insert-command))
4639 (setq org-self-insert-command-undo-counter 1)
4640 (if (>= org-self-insert-command-undo-counter 20)
4641 (setq org-self-insert-command-undo-counter 1)
4642 (and (> org-self-insert-command-undo-counter 0)
4643 buffer-undo-list
4644 (not (cadr buffer-undo-list)) ; remove nil entry
4645 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4646 (setq org-self-insert-command-undo-counter
4647 (1+ org-self-insert-command-undo-counter))))))))
4649 ;;;###autoload
4651 "Regular expression matching exponentials as produced by calc.")
4653 (defun orgtbl-gather-send-defs ()
4654 "Gather a plist of :name, :transform, :params for each destination before
4655 a radio table."
4656 (save-excursion
4657 (goto-char (org-table-begin))
4658 (let (rtn)
4659 (beginning-of-line 0)
4660 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4661 (let ((name (org-no-properties (match-string 1)))
4662 (transform (intern (match-string 2)))
4663 (params (if (match-end 3)
4664 (read (concat "(" (match-string 3) ")")))))
4665 (push (list :name name :transform transform :params params)
4666 rtn)
4667 (beginning-of-line 0)))
4668 rtn)))
4670 (defun orgtbl-send-replace-tbl (name text)
4671 "Find and replace table NAME with TEXT."
4672 (save-excursion
4673 (goto-char (point-min))
4674 (let* ((location-flag nil)
4675 (name (regexp-quote name))
4678 (while (re-search-forward begin-re nil t)
4679 (unless location-flag (setq location-flag t))
4680 (let ((beg (line-beginning-position 2)))
4681 (unless (re-search-forward end-re nil t)
4682 (user-error "Cannot find end of receiver location at %d" beg))
4683 (beginning-of-line)
4684 (delete-region beg (point))
4686 (unless location-flag
4687 (user-error "No valid receiver location found in the buffer")))))
4689 ;;;###autoload
4690 (defun org-table-to-lisp (&optional txt)
4691 "Convert the table at point to a Lisp structure.
4692 The structure will be a list. Each item is either the symbol `hline'
4693 for a horizontal separator line, or a list of field values as strings.
4694 The table is taken from the parameter TXT, or from the buffer at point."
4695 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4696 (let ((txt (or txt
4697 (buffer-substring-no-properties (org-table-begin)
4698 (org-table-end)))))
4699 (mapcar (lambda (x)
4700 (if (string-match org-table-hline-regexp x) 'hline
4704 (defun orgtbl-send-table (&optional maybe)
4705 "Send a transformed version of table at point to the receiver position.
4706 With argument MAYBE, fail quietly if no transformation is defined
4707 for this table."
4708 (interactive)
4709 (catch 'exit
4710 (unless (org-at-table-p) (user-error "Not at a table"))
4711 ;; when non-interactive, we assume align has just happened.
4712 (when (called-interactively-p 'any) (org-table-align))
4713 (let ((dests (orgtbl-gather-send-defs))
4714 (table (org-table-to-lisp
4715 (buffer-substring-no-properties (org-table-begin)
4716 (org-table-end))))
4717 (ntbl 0))
4718 (unless dests
4719 (if maybe (throw 'exit nil)
4720 (user-error "Don't know how to transform this table")))
4721 (dolist (dest dests)
4722 (let ((name (plist-get dest :name))
4723 (transform (plist-get dest :transform))
4724 (params (plist-get dest :params)))
4725 (unless (fboundp transform)
4726 (user-error "No such transformation function %s" transform))
4727 (orgtbl-send-replace-tbl name (funcall transform table params)))
4728 (cl-incf ntbl))
4729 (message "Table converted and installed at %d receiver location%s"
4730 ntbl (if (> ntbl 1) "s" ""))
4731 (and (> ntbl 0) ntbl))))
4733 (defun org-remove-by-index (list indices &optional i0)
4734 "Remove the elements in LIST with indices in INDICES.
4735 First element has index 0, or I0 if given."
4736 (if (not indices)
4737 list
4738 (if (integerp indices) (setq indices (list indices)))
4739 (setq i0 (1- (or i0 0)))
4740 (delq :rm (mapcar (lambda (x)
4741 (setq i0 (1+ i0))
4742 (if (memq i0 indices) :rm x))
4743 list))))
4745 (defun orgtbl-toggle-comment ()
4746 "Comment or uncomment the orgtbl at point."
4747 (interactive)
4748 (let* ((case-fold-search t)
4749 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4750 (re2 (concat "^" orgtbl-line-start-regexp))
4751 (commented (save-excursion (beginning-of-line 1)
4752 (cond ((looking-at re1) t)
4753 ((looking-at re2) nil)
4754 (t (user-error "Not at an org table")))))
4755 (re (if commented re1 re2))
4756 beg end)
4757 (save-excursion
4758 (beginning-of-line 1)
4759 (while (looking-at re) (beginning-of-line 0))
4760 (beginning-of-line 2)
4761 (setq beg (point))
4762 (while (looking-at re) (beginning-of-line 2))
4763 (setq end (point)))
4764 (comment-region beg end (if commented '(4) nil))))
4766 (defun orgtbl-insert-radio-table ()
4767 "Insert a radio table template appropriate for this major mode."
4768 (interactive)
4769 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4770 (txt (nth 1 e))
4771 name pos)
4772 (unless e (user-error "No radio table setup defined for %s" major-mode))
4773 (setq name (read-string "Table name: "))
4774 (while (string-match "%n" txt)
4775 (setq txt (replace-match name t t txt)))
4777 (setq pos (point))
4778 (insert txt)
4779 (goto-char pos)))
4781 ;;;###autoload
4782 (defun orgtbl-to-generic (table params)
4783 "Convert the orgtbl-mode TABLE to some other format.
4785 This generic routine can be used for many standard cases.
4787 TABLE is a list, each entry either the symbol `hline' for
4788 a horizontal separator line, or a list of fields for that
4789 line. PARAMS is a property list of parameters that can
4790 influence the conversion.
4792 Valid parameters are:
4794 :backend, :raw
4796 Export back-end used as a basis to transcode elements of the
4797 table, when no specific parameter applies to it. It is also
4798 used to translate cells contents. You can prevent this by
4799 setting :raw property to a non-nil value.
4801 :splice
4803 When non-nil, only convert rows, not the table itself. This is
4804 equivalent to setting to the empty string both :tstart
4805 and :tend, which see.
4807 :skip
4809 When set to an integer N, skip the first N lines of the table.
4810 Horizontal separation lines do count for this parameter!
4812 :skipcols
4814 List of columns that should be skipped. If the table has
4815 a column with calculation marks, that column is automatically
4816 discarded beforehand.
4818 :hline
4820 String to be inserted on horizontal separation lines. May be
4821 nil to ignore these lines altogether.
4823 :sep
4825 Separator between two fields, as a string.
4827 Each in the following group may be either a string or a function
4828 of no arguments returning a string:
4830 :tstart, :tend
4832 Strings to start and end the table. Ignored when :splice is t.
4834 :lstart, :lend
4836 Strings to start and end a new table line.
4838 :llstart, :llend
4840 Strings to start and end the last table line. Default,
4841 respectively, to :lstart and :lend.
4843 Each in the following group may be a string or a function of one
4844 argument (either the cells in the current row, as a list of
4845 strings, or the current cell) returning a string:
4847 :lfmt
4849 Format string for an entire row, with enough %s to capture all
4850 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4852 :llfmt
4854 Format for the entire last line, defaults to :lfmt.
4856 :fmt
4858 A format to be used to wrap the field, should contain %s for
4859 the original field value. For example, to wrap everything in
4861 a property list with column numbers and format strings, or
4862 functions, e.g.,
4866 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4868 Same as above, specific for the header lines in the table.
4869 All lines before the first hline are treated as header. If
4870 any of these is not present, the data line value is used.
4872 This may be either a string or a function of two arguments:
4874 :efmt
4876 Use this format to print numbers with exponential. The format
4877 should have %s twice for inserting mantissa and exponent, for
4879 list with column numbers and format strings or functions.
4880 :fmt will still be applied after :efmt."
4881 ;; Make sure `org-export-create-backend' is available.
4882 (require 'ox)
4883 (let* ((backend (plist-get params :backend))
4884 (custom-backend
4885 ;; Build a custom back-end according to PARAMS. Before
4886 ;; defining a translator, check if there is anything to do.
4887 ;; When there isn't, let BACKEND handle the element.
4888 (org-export-create-backend
4889 :parent (or backend 'org)
4890 :transcoders
4891 `((table . ,(org-table--to-generic-table params))
4892 (table-row . ,(org-table--to-generic-row params))
4893 (table-cell . ,(org-table--to-generic-cell params))
4894 ;; Macros are not going to be expanded. However, no
4895 ;; regular back-end has a transcoder for them. We
4896 ;; provide one so they are not ignored, but displayed
4897 ;; as-is instead.
4898 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4899 data info)
4900 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4901 ;; Initialize communication channel in INFO.
4902 (with-temp-buffer
4903 (let ((org-inhibit-startup t)) (org-mode))
4904 (let ((standard-output (current-buffer))
4905 (org-element-use-cache nil))
4906 (dolist (e table)
4908 ((consp e)
4909 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4911 ;; Add back-end specific filters, but not user-defined ones. In
4912 ;; particular, make sure to call parse-tree filters on the
4913 ;; table.
4914 (setq info
4915 (let ((org-export-filters-alist nil))
4916 (org-export-install-filters
4917 (org-combine-plists
4918 (org-export-get-environment backend nil params)
4919 `(:back-end ,(org-export-get-backend backend))))))
4920 (setq data
4921 (org-export-filter-apply-functions
4922 (plist-get info :filter-parse-tree)
4923 (org-element-map (org-element-parse-buffer) 'table
4924 #'identity nil t)
4925 info)))
4926 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4927 (user-error "Unknown :backend value"))
4928 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4929 ;; Handle :skip parameter.
4930 (let ((skip (plist-get info :skip)))
4931 (when skip
4932 (unless (wholenump skip) (user-error "Wrong :skip value"))
4933 (let ((n 0))
4934 (org-element-map data 'table-row
4935 (lambda (row)
4936 (if (>= n skip) t
4937 (org-element-extract-element row)
4938 (cl-incf n)
4939 nil))
4940 nil t))))
4941 ;; Handle :skipcols parameter.
4942 (let ((skipcols (plist-get info :skipcols)))
4943 (when skipcols
4944 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4945 (org-element-map data 'table
4946 (lambda (table)
4947 (let ((specialp (org-export-table-has-special-column-p table)))
4948 (dolist (row (org-element-contents table))
4949 (when (eq (org-element-property :type row) 'standard)
4950 (let ((c 1))
4951 (dolist (cell (nthcdr (if specialp 1 0)
4952 (org-element-contents row)))
4953 (when (memq c skipcols)
4954 (org-element-extract-element cell))
4955 (cl-incf c))))))))))
4956 ;; Since we are going to export using a low-level mechanism,
4957 ;; ignore special column and special rows manually.
4958 (let ((special? (org-export-table-has-special-column-p data))
4959 ignore)
4960 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4961 (lambda (datum)
4962 (when (if (eq (org-element-type datum) 'table-row)
4963 (org-export-table-row-is-special-p datum nil)
4964 (org-export-first-sibling-p datum nil))
4965 (push datum ignore))))
4966 (setq info (plist-put info :ignore-list ignore)))
4967 ;; We use a low-level mechanism to export DATA so as to skip all
4968 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4969 ;; code evaluation, include keywords and macro expansion. Only
4970 ;; back-end specific filters are retained.
4971 (let ((output (org-export-data-with-backend data custom-backend info)))
4972 ;; Remove final newline.
4973 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4975 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4976 (cond ((null value) nil)
4977 ((functionp value) `(funcall ',value ,@args))
4978 ((stringp value)
4979 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4980 (args `(format ,value ,@args))
4981 (t value)))
4982 ((and with-cons (consp value))
4983 `(let ((val (cadr (memq column ',value))))
4984 (cond ((null val) contents)
4985 ((stringp val) (format val ,@args))
4986 ((functionp val) (funcall val ,@args))
4987 (t (user-error "Wrong %s value" ,name)))))
4988 (t (user-error "Wrong %s value" name))))
4990 (defun org-table--to-generic-table (params)
4991 "Return custom table transcoder according to PARAMS.
4992 PARAMS is a plist. See `orgtbl-to-generic' for more
4993 information."
4994 (let ((backend (plist-get params :backend))
4995 (splice (plist-get params :splice))
4996 (tstart (plist-get params :tstart))
4997 (tend (plist-get params :tend)))
4998 `(lambda (table contents info)
4999 (concat
5000 ,(and tstart (not splice)
5002 ,(if (or (not backend) tstart tend splice) 'contents
5003 `(org-export-with-backend ',backend table contents info))
5004 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5006 (defun org-table--to-generic-row (params)
5007 "Return custom table row transcoder according to PARAMS.
5008 PARAMS is a plist. See `orgtbl-to-generic' for more
5009 information."
5010 (let* ((backend (plist-get params :backend))
5011 (lstart (plist-get params :lstart))
5012 (llstart (plist-get params :llstart))
5013 (hlstart (plist-get params :hlstart))
5014 (hllstart (plist-get params :hllstart))
5015 (lend (plist-get params :lend))
5016 (llend (plist-get params :llend))
5017 (hlend (plist-get params :hlend))
5018 (hllend (plist-get params :hllend))
5019 (lfmt (plist-get params :lfmt))
5020 (llfmt (plist-get params :llfmt))
5021 (hlfmt (plist-get params :hlfmt))
5022 (hllfmt (plist-get params :hllfmt)))
5023 `(lambda (row contents info)
5024 (if (eq (org-element-property :type row) 'rule)
5025 ,(cond
5026 ((plist-member params :hline)
5027 (org-table--generic-apply (plist-get params :hline) ":hline"))
5028 (backend `(org-export-with-backend ',backend row nil info)))
5029 (let ((headerp ,(and (or hlfmt hlstart hlend)
5030 '(org-export-table-row-in-header-p row info)))
5031 (last-header-p
5032 ,(and (or hllfmt hllstart hllend)
5033 '(org-export-table-row-ends-header-p row info)))
5034 (lastp (not (org-export-get-next-element row info))))
5035 (when contents
5036 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5037 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5038 ;; `:lstart', `:lend' and their relatives.
5039 ,(let ((cells
5040 '(org-element-map row 'table-cell
5041 (lambda (cell)
5042 ;; Export all cells, without separators.
5043 ;;
5044 ;; Use `org-export-data-with-backend'
5045 ;; instead of `org-export-data' to eschew
5046 ;; cached values, which
5047 ;; ignore :orgtbl-ignore-sep parameter.
5048 (org-export-data-with-backend
5049 cell
5050 (plist-get info :back-end)
5051 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5052 info)))
5053 `(cond
5054 ,(and hllfmt
5055 `(last-header-p ,(org-table--generic-apply
5056 hllfmt ":hllfmt" nil cells)))
5057 ,(and hlfmt
5058 `(headerp ,(org-table--generic-apply
5059 hlfmt ":hlfmt" nil cells)))
5060 ,(and llfmt
5061 `(lastp ,(org-table--generic-apply
5062 llfmt ":llfmt" nil cells)))
5063 (t
5064 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5065 `(concat
5066 (cond
5067 ,(and
5068 (or hllstart hllend)
5069 `(last-header-p
5070 (concat
5071 ,(org-table--generic-apply hllstart ":hllstart")
5072 contents
5073 ,(org-table--generic-apply hllend ":hllend"))))
5074 ,(and
5075 (or hlstart hlend)
5076 `(headerp
5077 (concat
5078 ,(org-table--generic-apply hlstart ":hlstart")
5079 contents
5080 ,(org-table--generic-apply hlend ":hlend"))))
5081 ,(and
5082 (or llstart llend)
5083 `(lastp
5084 (concat
5085 ,(org-table--generic-apply llstart ":llstart")
5086 contents
5087 ,(org-table--generic-apply llend ":llend"))))
5088 (t
5089 ,(cond
5090 ((or lstart lend)
5091 `(concat
5092 ,(org-table--generic-apply lstart ":lstart")
5093 contents
5094 ,(org-table--generic-apply lend ":lend")))
5095 (backend
5096 `(org-export-with-backend
5097 ',backend row contents info))
5098 (t 'contents)))))))))))))))
5100 (defun org-table--to-generic-cell (params)
5101 "Return custom table cell transcoder according to PARAMS.
5102 PARAMS is a plist. See `orgtbl-to-generic' for more
5103 information."
5104 (let* ((backend (plist-get params :backend))
5105 (efmt (plist-get params :efmt))
5106 (fmt (plist-get params :fmt))
5107 (hfmt (plist-get params :hfmt))
5108 (sep (plist-get params :sep))
5109 (hsep (plist-get params :hsep)))
5110 `(lambda (cell contents info)
5111 ;; Make sure that contents are exported as Org data when :raw
5112 ;; parameter is non-nil.
5113 ,(when (and backend (plist-get params :raw))
5114 `(setq contents
5115 ;; Since we don't know what are the pseudo object
5116 ;; types defined in backend, we cannot pass them to
5117 ;; `org-element-interpret-data'. As a consequence,
5118 ;; they will be treated as pseudo elements, and will
5119 ;; have newlines appended instead of spaces.
5120 ;; Therefore, we must make sure :post-blank value is
5121 ;; really turned into spaces.
5122 (replace-regexp-in-string
5124 (org-trim
5125 (org-element-interpret-data
5126 (org-element-contents cell))))))
5128 (let ((headerp ,(and (or hfmt hsep)
5129 '(org-export-table-row-in-header-p
5130 (org-export-get-parent-element cell) info)))
5131 (column
5132 ;; Call costly `org-export-table-cell-address' only if
5133 ;; absolutely necessary, i.e., if one
5134 ;; of :fmt :efmt :hmft has a "plist type" value.
5135 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5136 (list efmt hfmt fmt))
5137 '(1+ (cdr (org-export-table-cell-address cell info))))))
5138 (when contents
5139 ;; Check if we can apply `:efmt' on CONTENTS.
5140 ,(when efmt
5141 `(when (string-match orgtbl-exp-regexp contents)
5142 (let ((mantissa (match-string 1 contents))
5143 (exponent (match-string 2 contents)))
5144 (setq contents ,(org-table--generic-apply
5145 efmt ":efmt" t 'mantissa 'exponent)))))
5146 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5147 (cond
5148 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5149 hfmt ":hfmt" t 'contents))))
5150 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5151 fmt ":fmt" t 'contents))))))
5152 ;; If a separator is provided, use it instead of BACKEND's.
5153 ;; Separators are ignored when LFMT (or equivalent) is
5154 ;; provided.
5155 ,(cond
5156 ((or hsep sep)
5157 `(if (or ,(and (not sep) '(not headerp))
5158 (plist-get info :orgtbl-ignore-sep)
5159 (not (org-export-get-next-element cell info)))
5160 ,(if (not backend) 'contents
5161 `(org-export-with-backend ',backend cell contents info))
5162 (concat contents
5163 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5164 (or hsep sep)))))
5165 (backend `(org-export-with-backend ',backend cell contents info))
5166 (t 'contents))))))
5168 ;;;###autoload
5169 (defun orgtbl-to-tsv (table params)
5170 "Convert the orgtbl-mode table to TAB separated material."
5173 ;;;###autoload
5174 (defun orgtbl-to-csv (table params)
5175 "Convert the orgtbl-mode table to CSV material.
5176 This does take care of the proper quoting of fields with comma or quotes."
5177 (orgtbl-to-generic table
5178 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5179 params)))
5181 ;;;###autoload
5182 (defun orgtbl-to-latex (table params)
5183 "Convert the orgtbl-mode TABLE to LaTeX.
5185 TABLE is a list, each entry either the symbol `hline' for
5186 a horizontal separator line, or a list of fields for that line.
5187 PARAMS is a property list of parameters that can influence the
5188 conversion. All parameters from `orgtbl-to-generic' are
5189 supported. It is also possible to use the following ones:
5191 :booktabs
5195 :environment
5197 Specify environment to use, as a string. If you use
5199 as a string, to get proper continuation strings."
5200 (require 'ox-latex)
5201 (orgtbl-to-generic
5202 table
5203 (org-combine-plists
5204 ;; Provide sane default values.
5205 (list :backend 'latex
5206 :latex-default-table-mode 'table
5207 :latex-tables-centered nil
5208 :latex-tables-booktabs (plist-get params :booktabs)
5209 :latex-table-scientific-notation nil
5210 :latex-default-table-environment
5211 (or (plist-get params :environment) "tabular"))
5212 params)))
5214 ;;;###autoload
5215 (defun orgtbl-to-html (table params)
5216 "Convert the orgtbl-mode TABLE to HTML.
5218 TABLE is a list, each entry either the symbol `hline' for
5219 a horizontal separator line, or a list of fields for that line.
5220 PARAMS is a property list of parameters that can influence the
5221 conversion. All parameters from `orgtbl-to-generic' are
5222 supported. It is also possible to use the following one:
5224 :attributes
5226 Attributes and values, as a plist, which will be used in
5227 <table> tag."
5228 (require 'ox-html)
5229 (orgtbl-to-generic
5230 table
5231 (org-combine-plists
5232 ;; Provide sane default values.
5233 (list :backend 'html
5234 :html-table-data-tags '("<td%s>" . "</td>")
5235 :html-table-use-header-tags-for-first-column nil
5236 :html-table-align-individual-fields t
5237 :html-table-row-tags '("<tr>" . "</tr>")
5238 :html-table-attributes
5239 (if (plist-member params :attributes)
5240 (plist-get params :attributes)
5241 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5242 :frame "hsides")))
5243 params)))
5245 ;;;###autoload
5246 (defun orgtbl-to-texinfo (table params)
5247 "Convert the orgtbl-mode TABLE to Texinfo.
5249 TABLE is a list, each entry either the symbol `hline' for
5250 a horizontal separator line, or a list of fields for that line.
5251 PARAMS is a property list of parameters that can influence the
5252 conversion. All parameters from `orgtbl-to-generic' are
5253 supported. It is also possible to use the following one:
5255 :columns
5257 Column widths, as a string. When providing column fractions,
5259 (require 'ox-texinfo)
5260 (let ((output
5261 (orgtbl-to-generic
5262 table
5263 (org-combine-plists
5264 (list :backend 'texinfo
5265 :texinfo-tables-verbatim nil
5266 :texinfo-table-scientific-notation nil)
5267 params)))
5268 (columns (let ((w (plist-get params :columns)))
5269 (cond ((not w) nil)
5271 (t (concat "@columnfractions " w))))))
5272 (if (not columns) output
5273 (replace-regexp-in-string
5276 ;;;###autoload
5277 (defun orgtbl-to-orgtbl (table params)
5278 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5280 TABLE is a list, each entry either the symbol `hline' for
5281 a horizontal separator line, or a list of fields for that line.
5282 PARAMS is a property list of parameters that can influence the
5283 conversion. All parameters from `orgtbl-to-generic' are
5284 supported.
5286 Useful when slicing one table into many. The :hline, :sep,
5287 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5288 be set to provide ORGTBL directives for the generated table."
5289 (require 'ox-org)
5290 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5292 (defun orgtbl-to-table.el (table params)
5293 "Convert the orgtbl-mode TABLE into a table.el table.
5294 TABLE is a list, each entry either the symbol `hline' for
5295 a horizontal separator line, or a list of fields for that line.
5296 PARAMS is a property list of parameters that can influence the
5297 conversion. All parameters from `orgtbl-to-generic' are
5298 supported."
5299 (with-temp-buffer
5300 (insert (orgtbl-to-orgtbl table params))
5301 (org-table-align)
5302 (replace-regexp-in-string
5303 "-|" "-+"
5304 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5306 (defun orgtbl-to-unicode (table params)
5307 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5309 TABLE is a list, each entry either the symbol `hline' for
5310 a horizontal separator line, or a list of fields for that line.
5311 PARAMS is a property list of parameters that can influence the
5312 conversion. All parameters from `orgtbl-to-generic' are
5313 supported. It is also possible to use the following ones:
5315 :ascii-art
5318 the table. You can download it here:
5319 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5321 :narrow
5323 When non-nil, narrow columns width than provided width cookie,
5325 (require 'ox-ascii)
5326 (orgtbl-to-generic
5327 table
5328 (org-combine-plists
5329 (list :backend 'ascii
5330 :ascii-charset 'utf-8
5331 :ascii-table-widen-columns (not (plist-get params :narrow))
5332 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5333 params)))
5335 ;; Put the cursor in a column containing numerical values
5336 ;; of an Org table,
5337 ;; type C-c " a
5338 ;; A new column is added with a bar plot.
5339 ;; When the table is refreshed (C-u C-c *),
5340 ;; the plot is updated to reflect the new values.
5342 (defun orgtbl-ascii-draw (value min max &optional width characters)
5343 "Draw an ascii bar in a table.
5344 VALUE is the value to plot, it determines the width of the bar to draw.
5345 MIN is the value that will be displayed as empty (zero width bar).
5346 MAX is the value that will draw a bar filling all the WIDTH.
5347 WIDTH is the span in characters from MIN to MAX.
5348 CHARACTERS is a string that will compose the bar, with shades of grey
5349 from pure white to pure black. It defaults to a 10 characters string
5350 of regular ascii characters."
5351 (let* ((width (ceiling (or width 12)))
5352 (characters (or characters " .:;c!lhVHW"))
5353 (len (1- (length characters)))
5354 (value (float (if (numberp value)
5355 value (string-to-number value))))
5356 (relative (/ (- value min) (- max min)))
5357 (steps (round (* relative width len))))
5358 (cond ((< steps 0) "too small")
5359 ((> steps (* width len)) "too large")
5360 (t (let* ((int-division (/ steps len))
5361 (remainder (- steps (* int-division len))))
5362 (concat (make-string int-division (elt characters len))
5363 (string (elt characters remainder))))))))
5365 ;;;###autoload
5366 (defun orgtbl-ascii-plot (&optional ask)
5367 "Draw an ASCII bar plot in a column.
5369 With cursor in a column containing numerical values, this function
5370 will draw a plot in a new column.
5372 ASK, if given, is a numeric prefix to override the default 12
5374 prefix,
5375 which will prompt for the width."
5376 (interactive "P")
5377 (let ((col (org-table-current-column))
5378 (min 1e999) ; 1e999 will be converted to infinity
5379 (max -1e999) ; which is the desired result
5380 (table (org-table-to-lisp))
5381 (length
5382 (cond ((consp ask)
5383 (read-number "Length of column " 12))
5384 ((numberp ask) ask)
5385 (t 12))))
5386 ;; Skip any hline a the top of table.
5387 (while (eq (car table) 'hline) (setq table (cdr table)))
5388 ;; Skip table header if any.
5389 (dolist (x (or (cdr (memq 'hline table)) table))
5390 (when (consp x)
5391 (setq x (nth (1- col) x))
5392 (when (string-match
5394 x)
5395 (setq x (string-to-number x))
5396 (when (> min x) (setq min x))
5397 (when (< max x) (setq max x)))))
5398 (org-table-insert-column)
5399 (org-table-move-column-right)
5400 (org-table-store-formulas
5401 (cons
5402 (cons
5403 (concat "$" (number-to-string (1+ col)))
5404 (format "'(%s $%s %s %s %s)"
5405 "orgtbl-ascii-draw" col min max length))
5406 (org-table-get-stored-formulas)))
5407 (org-table-recalculate t)))
5409 ;; Example of extension: unicode characters
5410 ;; Here are two examples of different styles.
5412 ;; Unicode block characters are used to give a smooth effect.
5413 ;; See http://en.wikipedia.org/wiki/Block_Elements
5414 ;; Use one of those drawing functions
5415 ;; - orgtbl-ascii-draw (the default ascii)
5416 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5417 ;; - orgtbl-uc-draw-cont (smooth unicode)
5419 ;; This is best viewed with the "DejaVu Sans Mono" font
5420 ;; (use M-x set-default-font).
5422 (defun orgtbl-uc-draw-grid (value min max &optional width)
5423 "Draw a bar in a table using block unicode characters.
5424 It is a variant of orgtbl-ascii-draw with Unicode block
5425 characters, for a smooth display. Bars appear as grids (to the
5426 extent the font allows)."
5427 ;; http://en.wikipedia.org/wiki/Block_Elements
5428 ;; best viewed with the "DejaVu Sans Mono" font.
5429 (orgtbl-ascii-draw value min max width
5432 (defun orgtbl-uc-draw-cont (value min max &optional width)
5433 "Draw a bar in a table using block unicode characters.
5434 It is a variant of orgtbl-ascii-draw with Unicode block
5435 characters, for a smooth display. Bars are solid (to the extent
5436 the font allows)."
5437 (orgtbl-ascii-draw value min max width
5440 (defun org-table-get-remote-range (name-or-id form)
5441 "Get a field value or a list of values in a range from table at ID.
5443 NAME-OR-ID may be the name of a table in the current file as set
5445 will then be used. Alternatively, it may be an ID referring to
5446 any entry, also in a different file. In this case, the first
5447 table in that entry will be referenced.
5451 The return value is either a single string for a single field, or a
5452 list of the fields in the rectangle."
5453 (save-match-data
5454 (let ((case-fold-search t) (id-loc nil)
5455 ;; Protect a bunch of variables from being overwritten by
5456 ;; the context of the remote table.
5457 org-table-column-names org-table-column-name-regexp
5458 org-table-local-parameters org-table-named-field-locations
5459 org-table-current-line-types
5460 org-table-current-begin-pos org-table-dlines
5461 org-table-current-ncol
5462 org-table-hlines org-table-last-alignment
5463 org-table-last-column-widths org-table-last-alignment
5464 org-table-last-column-widths
5465 buffer loc)
5466 (setq form (org-table-convert-refs-to-rc form))
5467 (org-with-wide-buffer
5468 (goto-char (point-min))
5469 (if (re-search-forward
5472 nil t)
5473 (setq buffer (current-buffer) loc (match-beginning 0))
5474 (setq id-loc (org-id-find name-or-id 'marker))
5475 (unless (and id-loc (markerp id-loc))
5477 (setq buffer (marker-buffer id-loc)
5478 loc (marker-position id-loc))
5479 (move-marker id-loc nil))
5480 (with-current-buffer buffer
5481 (org-with-wide-buffer
5482 (goto-char loc)
5483 (forward-char 1)
5485 (not (match-beginning 1)))
5486 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5487 (org-table-analyze)
5488 (setq form (org-table-formula-substitute-names
5489 (org-table-formula-handle-first/last-rc form)))
5490 (if (and (string-match org-table-range-regexp form)
5491 (> (length (match-string 0 form)) 1))
5492 (org-table-get-range
5493 (match-string 0 form) org-table-current-begin-pos 1)
5494 form)))))))
5496 (defun org-table-remote-reference-indirection (form)
5497 "Return formula with table remote references substituted by indirection.
5499 This indirection works only with the format @ROW$COLUMN. The
5501 distinguished from a plain table name or ID."
5502 (let ((regexp
5503 ;; Same as in `org-table-eval-formula'.
5505 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5508 (replace-regexp-in-string
5509 regexp
5510 (lambda (m)
5511 (save-match-data
5512 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5513 (org-table-get-range
5515 (concat "@0" eq)
5516 eq)))))
5517 form t t 1)))
5519 (defmacro org-define-lookup-function (mode)
5520 (let ((mode-str (symbol-name mode))
5521 (first-p (eq mode 'first))
5522 (all-p (eq mode 'all)))
5523 (let ((plural-str (if all-p "s" "")))
5524 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5525 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5526 If R-LIST is nil, return matching element%s of S-LIST.
5527 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5528 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5529 This function is generated by a call to the macro `org-define-lookup-function'."
5530 mode-str plural-str plural-str plural-str)
5531 (let ,(let ((lvars '((p (or predicate 'equal))
5532 (sl s-list)
5533 (rl (or r-list s-list))
5534 (ret nil))))
5535 (if first-p (cons '(match-p nil) lvars) lvars))
5536 (while ,(if first-p '(and (not match-p) sl) 'sl)
5537 (when (funcall p val (car sl))
5538 ,(when first-p '(setq match-p t))
5539 (let ((rval (car rl)))
5540 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5541 (setq sl (cdr sl) rl (cdr rl)))
5542 ret)))))
5544 (org-define-lookup-function first)
5545 (org-define-lookup-function last)
5546 (org-define-lookup-function all)
5548 (provide 'org-table)
5550 ;; Local variables:
5551 ;; generated-autoload-file: "org-loaddefs.el"
5552 ;; End:
5554 ;;; org-table.el ends here