| blob | 8dc648eaecdb5886d09f97c01ab59194b0fc4d77 |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
77 "Hook for functions attaching to `C-c C-c', if the table is sent.
78 This can be used to add additional functionality after the table is sent
79 to the receiver position, otherwise, if table is not sent, the functions
85 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
87 In the optimized version, the table editor takes over all simple keys that
88 normally just insert a character. In tables, the characters are inserted
89 in a way to minimize disturbing the table structure (i.e. in overwrite mode
90 for empty fields). Outside tables, the correct binding of the keys is
91 restored.
93 Changing this variable requires a restart of Emacs to become
94 effective."
100 % END RECEIVE ORGTBL %n
102 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
103 | | |
106 @c END RECEIVE ORGTBL %n
107 @ignore
108 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
109 | | |
112 <!-- END RECEIVE ORGTBL %n -->
113 <!--
114 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
115 | | |
118 #+ END RECEIVE ORGTBL %n
120 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
121 | | |
123 "Templates for radio tables in different major modes.
124 Each template must define lines that will be treated as a comment and that
127 insertion of the template. The transformed table will later be inserted
128 between these lines.
130 The template should also contain a minimal table in a multiline comment.
131 If multiline comments are not possible in the buffer language,
132 you can pack it into a string that will not be used when the code
133 is compiled or executed. Above the table will you need a line with
135 convert the table into a data structure useful in the
136 language of the buffer. Check the manual for the section on
138 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
140 All occurrences of %n in a template will be replaced with the name of the
141 table, obtained by prompting the user."
148 "Settings for tables in Org mode."
153 "The default size for newly created tables, Columns x Rows."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
159 "Regular expression for recognizing numbers in table columns.
160 If a table column contains mostly numbers, it will be aligned to the
161 right. If not, it will be aligned to the left.
163 The default value of this option is a regular expression which allows
164 anything which looks remotely like a number as used in scientific
165 context. For example, all of the following will be considered a
166 number:
167 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
169 Other options offered by the customize interface are more restrictive."
183 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
184 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
185 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
189 "Fraction of numbers in a column required to make the column align right.
190 In a column all non-white fields are considered. If at least
191 this fraction of fields is matched by `org-table-number-regexp',
192 alignment to the right border applies."
197 "Behavior of tables during editing in Org mode."
202 "Non-nil means automatically re-align table when pressing TAB or RETURN.
204 removal/insertion."
209 "Non-nil means automatically blank table field when starting to type into it.
210 This only happens when typing immediately after a field motion
211 command (TAB, S-TAB or RET)."
216 "Non-nil means automatically exit the follow mode.
217 When nil, the follow mode will stay on and be active in any table
218 the cursor enters. Since the table follow filed mode messes with the
219 window configuration, it is not recommended to set this variable to nil,
220 except maybe locally in a special file that has mostly tables with long
221 fields."
227 "Whether the user should confirm when Org fixes formulas."
235 'safe-local-variable
239 "Non-nil means tab in the last column of a table with jump over a hline.
240 If a horizontal separator line is following the current line,
241 `org-table-next-field' can either create a new row before that line, or jump
242 over the line. When this option is nil, a new line will be created before
243 this line."
248 "Options concerning tables in Org mode."
253 "Non-nil means using table references like B3 instead of @3$2.
254 Possible values are:
255 nil never use them
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
265 "Non-nil means increment when copying current field with \
278 calc-angle-mode deg
279 calc-prefer-frac nil
280 calc-symbolic-mode nil
282 calc-display-working-message t
283 )
284 "List with Calc mode settings for use in `calc-eval' for table formulas.
285 The list must contain alternating symbols (Calc modes variables and values).
286 Don't remove any of the default settings, just change the values. Org mode
287 relies on the variables to be present in the list."
292 "Format for the output of calc computations like $1+$2;t.
293 The default value is `hours', and will output the results as a
294 number of hours. Other allowed values are `seconds', `minutes' and
295 `days', and the output will be a fraction of seconds, minutes or
296 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
297 The `U' flag in a table formula will select this specific format for
298 a single formula."
308 "Non-nil means hours in table duration computations should be zero-padded.
309 So this is about 08:32:34 versus 8:33:34."
317 "Format for fields which contain the result of a formula.
319 characters. Beware that modifying the display can prevent the
320 field from being used in another formula."
326 "Non-nil means TAB and RET evaluate a formula in current table field.
327 If the current field starts with an equal sign, it is assumed to be a formula
328 which should be evaluated as described in the manual and in the documentation
329 string of the command `org-table-eval-formula'. This feature requires the
330 Emacs calc package.
331 When this variable is nil, formula calculation is only available through
337 "Non-nil means interpret constants in formulas in tables.
338 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
339 by the value given in `org-table-formula-constants', or by a value obtained
340 from the `constants.el' package."
345 "Alist with constant names and values, for use in table formulas.
346 The car of each element is a name of a constant, without the `$' before it.
347 The cdr is the value as a string. For example, if you'd like to use the
348 speed of light in a formula, you would configure
352 and then use it in an equation like `$1*$c'.
354 Constants can also be defined on a per-file basis using a line like
356 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
363 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
366 are pressed in the line."
371 "Non-nil means relative formula references may cross hlines.
372 Here are the allowed values:
374 nil Relative references may not cross hlines. They will reference the
375 field next to the hline instead. Coming from below, the reference
376 will be to the field below the hline. Coming from above, it will be
377 to the field above.
378 t Relative references may cross hlines.
379 error An attempt to cross a hline will throw an error.
381 It is probably good to never set this variable to nil, for the sake of
382 portability of tables."
390 "Non-nil means that evaluation of a field formula can add new
391 columns if an out-of-bounds field is being set."
398 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
402 "Options concerning table import and export in Org mode."
407 "Default export parameters for `org-table-export'.
408 These can be overridden for a specific table by setting the
409 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
410 radio tables for the different export transformations and
411 available parameters."
416 "Max lines that `org-table-convert-region' will attempt to process.
418 The function can be slow on larger regions; this safety feature
419 prevents it from hanging emacs."
442 "Alist with column names, derived from the `!' line.
446 "Regular expression matching the current column names.
450 "Alist with parameter names, derived from the `$' line.
454 "Alist with locations of named fields.
455 Associations follow the pattern (NAME LINE COLUMN) where
456 NAME is the name of the field as a string,
457 LINE is the number of lines from the beginning of the table,
458 COLUMN is the column of the field, as an integer.
462 "Table row types in current table.
466 "Current table begin position, as a marker.
470 "Number of columns in current table.
474 "Vector of data line line numbers in the current table.
475 Line numbers are counted from the beginning of the table. This
479 "Vector of hline line numbers in the current table.
480 Line numbers are counted from the beginning of the table. This
484 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
485 ;; 1 2 3 4 5
500 "Save current field; execute BODY; restore field.
501 Field is restored even in case of abnormal exit."
512 ;;;###autoload
514 "Use the table.el package to insert a new table.
515 If there is already a table at point, convert between Org tables
516 and table.el tables."
529 ;;;###autoload
531 "Convert region to table, or create an empty table.
532 If there is an active region, convert it to a table, using the function
533 `org-table-convert-region'. See the documentation of that function
534 to learn how the prefix argument is interpreted to determine the field
535 separator.
536 If there is no such region, create an empty table with `org-table-create'."
542 ;;;###autoload
544 "Query for a size and insert a table skeleton.
564 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
568 ;; Insert a hline after the first row.
575 ;;;###autoload
577 "Convert region to a table.
579 The region goes from BEG0 to END0, but these borders will be moved
580 slightly, to make sure a beginning of line in the first line is included.
582 SEPARATOR specifies the field separator in the lines. It can have the
583 following values:
585 (4) Use the comma as a field separator
586 (16) Use a TAB as field separator
587 (64) Prompt for a regular expression as field separator
588 integer When a number, use that many spaces, or a TAB, as field separator
589 regexp When a regular expression, use it to match the separator
590 nil When nil, the command tries to be smart and figure out the
591 separator in the following way:
592 - when each line contains a TAB, assume TAB-separated material
593 - when each line contains a comma, assume CSV material
594 - else, assume one or more SPACE characters as separator."
598 re)
600 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
601 org-table-convert-region-max-lines)
610 ;; Get the right field separator
621 ;; parse the csv stuff
646 ;;;###autoload
648 "Import FILE as a table.
649 The file is assumed to be tab-separated. Such files can be produced by most
650 spreadsheet and database applications. If no tabs (at least one per line)
651 are found, lines will be split on whitespace into fields."
660 ;;;###autoload
662 "Export table to a file, with configurable format.
663 Such a file can be imported into usual spreadsheet programs.
665 FILE can be the output file name. If not given, it will be taken
666 from a TABLE_EXPORT_FILE property in the current entry or higher
667 up in the hierarchy, or the user will be prompted for a file
668 name. FORMAT can be an export format, of the same kind as it
669 used when `orgtbl-mode' sends a table in a different format.
671 The command suggests a format depending on TABLE_EXPORT_FORMAT,
672 whether it is set locally or up in the hierarchy, then on the
673 extension of the given file name, and finally on the variable
674 `org-table-export-default-format'."
707 formats)))
708 org-table-export-default-format)
734 "Marker at the beginning of the table last aligned.
737 "Marker at the end of the table last aligned.
740 "List of flags for flushright alignment, from the last re-alignment.
743 "List of max width of fields in each column.
746 "Non-nil means debug table formulas.
756 ;;;###autoload
758 "Align the table at point by aligning all vertical bars."
763 ;; Make sure invisible characters in the table are at the right
764 ;; place since column widths take them into account.
770 ;; Table's rows. Separators are replaced by nil. Trailing
771 ;; spaces are also removed.
777 l)))
779 ;; Get the data fields by splitting the lines.
782 ;; Compute number of fields in the longest line. If the
783 ;; table contains no field, create a default table.
788 ;; A list of empty strings to fill any short rows on output.
790 lengths typenums)
791 ;; Check for special formatting.
794 fmax falign)
795 ;; Look for an explicit width or alignment.
808 ;; Find fields that are wider than FMAX, and shorten them.
813 'help-echo
821 fmax)))
835 f2
837 x))))))
838 ;; Get the maximum width for each column
840 lengths)
841 ;; Get the fraction of numbers among non-empty cells to
842 ;; decide about alignment of the column.
851 1
857 ;; Store alignment of this table, for later editing of single
858 ;; fields.
861 ;; With invisible characters, `format' does not get the field
862 ;; width right So we need to make these fields wide by hand.
863 ;; Invisible characters may be introduced by fontified links,
864 ;; emphasis, macros or sub/superscripts.
882 ;; Compute the formats needed for output of the table.
891 ;; Replace modified lines only. Check not only contents, but
892 ;; also columns' width.
896 hfmt))
918 ;;;###autoload
920 "Find the beginning of the table and return its position.
921 With a non-nil optional argument TABLE-TYPE, return the beginning
922 of a table.el-type table. This function assumes point is on
923 a table."
931 ;;;###autoload
933 "Find the end of the table and return its position.
934 With a non-nil optional argument TABLE-TYPE, return the end of
935 a table.el-type table. This function assumes point is on
936 a table."
944 ;; When the line right after the table is the last line in
945 ;; the buffer with trailing spaces but no final newline
946 ;; character, be sure to catch the correct ending at its
947 ;; beginning. In any other case, ending is expected to be
948 ;; at point max.
953 ;;;###autoload
955 "Justify the current field, text to left, number to right.
956 Optional argument NEW may specify text to replace the current field content."
965 ;; This is not the same table, force a full re-align.
968 ;; Realign the current field, based on previous full realign.
981 len
996 ;;;###autoload
998 "Go to the next field in the current table, creating new lines as needed.
999 Before doing so, re-align the table if necessary."
1004 org-table-may-need-update)
1015 org-table-tab-jumps-over-hlines
1026 ;;;###autoload
1028 "Go to the previous field in the table.
1029 Before doing so, re-align the table if necessary."
1034 org-table-may-need-update)
1052 "Move to the beginning of the current table field.
1053 If already at or before the beginning, move to the beginning of the
1054 previous field.
1055 With numeric argument N, move N-1 fields backward first."
1068 "Move to the end of the current table field.
1069 If already at or after the end, move to the end of the next table field.
1070 With numeric argument N, move N-1 fields forward first."
1083 ;;;###autoload
1085 "Go to the next row (same column) in the current table.
1086 Before doing so, re-align the table if necessary."
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."
1660 ;;;###autoload
1663 "Sort table lines according to the column at point.
1665 The position of point indicates the column to be used for
1666 sorting, and the range of lines is the range between the nearest
1667 horizontal separator lines, or the entire table of no such lines
1668 exist. If point is before the first column, you will be prompted
1669 for the sorting column. If there is an active region, the mark
1670 specifies the first line and the sorting column, while point
1671 should be in the last line to be included into the sorting.
1673 The command then prompts for the sorting type which can be
1674 alphabetically, numerically, or by time (as given in a time stamp
1675 in the field, or as a HH:MM value). Sorting in reverse order is
1676 also possible.
1678 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1680 If SORTING-TYPE is specified when this function is called from a Lisp
1681 program, no prompting will take place. SORTING-TYPE must be a character,
1682 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1683 sorting should be done in reverse order.
1685 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1686 a function to be called to extract the key. It must return a value
1687 that is compatible with COMPARE-FUNC, the function used to compare
1688 entries.
1690 A non-nil value for INTERACTIVE? is used to signal that this
1691 function is being called interactively."
1694 ;; Point must be either within a field or before a data line.
1699 ;; Set appropriate case sensitivity and column used for sorting.
1710 ;; Narrow buffer to appropriate sorting area.
1723 start))
1726 end))))
1727 ;; Determine arguments for `sort-subr'. Also record original
1728 ;; position. `org-table-save-field' cannot help here since
1729 ;; sorting is too much destructive.
1735 ;; Function to be called on the contents of the field
1736 ;; used for sorting in the current row.
1773 #'end-of-line
1777 nil
1778 predicate)
1779 ;; Move back to initial field.
1783 ;;;###autoload
1785 "Copy region in table to the clipboard and blank all relevant fields.
1786 If there is no active region, use just the field at point."
1792 ;;;###autoload
1794 "Copy rectangular region in table to clipboard.
1795 A special clipboard is used which can only be accessed
1796 with `org-table-paste-rectangle'."
1800 current-prefix-arg))
1805 region)
1817 ;; Collect every cell between COLUMN-START and COLUMN-END.
1827 ;;;###autoload
1829 "Paste a rectangular region into a table.
1830 The upper right corner ends up in the current field. All involved fields
1831 will be overwritten. If the rectangle does not fit into the present table,
1832 the table is enlarged as needed. The process ignores horizontal separator
1833 lines."
1843 ;; If we left the table, create a new row.
1855 ;;;###autoload
1857 "Convert from `org-mode' table to table.el and back.
1858 Obviously, this only works within limits. When an Org table is converted
1859 to table.el, all horizontal separator lines get lost, because table.el uses
1860 these as cell boundaries and has no notion of horizontal lines. A table.el
1861 table can be converted to an Org table only if it does not do row or column
1862 spanning. Multiline cells will become multiple cells. Beware, Org mode
1863 does not test if the table can be successfully converted - it blindly
1864 applies a recipe that works for simple tables."
1868 ;; convert to Org table
1877 ;; convert to table.el table
1880 ;; first, get rid of all horizontal lines
1884 ;; insert a hline before first
1888 ;; insert a hline after each line
1893 ;; replace "+" at beginning and ending of hlines
1902 "Transpose Org table at point and eliminate hlines.
1903 So a table like
1905 | 1 | 2 | 4 | 5 |
1906 |---+---+---+---|
1907 | a | b | c | d |
1908 | e | f | g | h |
1910 will be transposed as
1912 | 1 | a | e |
1913 | 2 | b | f |
1914 | 4 | c | g |
1915 | 5 | d | h |
1917 Note that horizontal lines disappear."
1929 table)))
1943 ;;;###autoload
1945 "Wrap several fields in a column like a paragraph.
1946 This is useful if you'd like to spread the contents of a field over several
1947 lines, in order to keep the table compact.
1949 If there is an active region, and both point and mark are in the same column,
1950 the text in the column is wrapped to minimum width for the given number of
1951 lines. Generally, this makes the table more compact. A prefix ARG may be
1952 used to change the number of desired lines. For example, \
1954 formats the selected text to two lines. If the region was longer than two
1955 lines, the remaining lines remain empty. A negative prefix argument reduces
1956 the current number of lines by that amount. The wrapped text is pasted back
1957 into the table. If you formatted it to more lines than it was before, fields
1958 further down in the table get overwritten - so you might need to make space in
1959 the table first.
1961 If there is no region, the current field is split at the cursor position and
1962 the text fragment to the right of the cursor is prepended to the field one
1963 line down.
1965 If there is no region, but you specify a prefix ARG, the current field gets
1966 blank, and the content is appended to the field above."
1970 ;; There is a region: fill as a paragraph.
1981 nil
1982 nlines))))
1985 ;; No region, split the current field at point.
2010 ;;;###autoload
2012 "Edit table field in a different window.
2013 This is mainly useful for fields that contain hidden parts.
2016 visible so that it can be edited in place.
2019 toggle `org-table-follow-field-mode'."
2029 display t intangible t))
2042 p)
2058 intangible t))
2066 "Finish editing a table data field.
2067 Remove all newline characters, insert the result into the table, realign
2068 the table and kill the editing buffer."
2072 text)
2089 "Minor mode to make the table field editor window follow the cursor.
2090 When this mode is active, the field editor window will always show the
2091 current field. The mode exits automatically when the cursor leaves the
2092 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2093 nil " TblFollow" nil
2109 ;; We have left the table, exit the follow mode
2119 ;;;###autoload
2121 "Sum numbers in region of current table column.
2122 The result will be displayed in the echo area, and will be available
2125 If there is an active region, it is interpreted as a rectangle and all
2126 numbers in that rectangle will be summed. If there is no active
2127 region and point is located in a table column, sum all numbers in that
2128 column.
2130 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2131 numbers are assumed to be times as well (in decimal hours) and the
2132 numbers are added as such.
2134 If NLAST is a number, only the NLAST fields will actually be summed."
2161 items1)))
2168 s diff)
2175 sres))))
2198 "Return the formula active for the current field.
2200 Assumes that table is already analyzed. If KEY is given, return
2201 the key to this formula. Otherwise return the formula preceded
2210 org-table-named-field-locations)))
2224 "Read a formula from the minibuffer, offer stored formula as default.
2225 When NAMED is non-nil, look for a named equation."
2230 org-table-named-field-locations)))
2243 stored)
2245 equation)
2251 scol))
2253 'org-table-formula-history
2254 )))))
2255 mustsave)
2257 ;; remove formula
2264 ;; We set the column equation, delete the named one.
2266 mustsave t))
2272 eq))
2275 "Store the list of formulas below the current table.
2276 If optional argument LOCATION is a buffer position, insert it at
2277 LOCATION instead."
2285 ;; Don't overwrite TBLFM, we might use text properties to
2286 ;; store stuff.
2300 ;; Fake a high number to make sure this is sorted at the end.
2307 a)
2317 "Compare two formulas for sorting."
2322 ;;;###autoload
2324 "Return an alist with the stored formulas directly after current table.
2325 By default, only return active formulas, i.e., formulas located
2326 on the first line after the table. However, if optional argument
2327 LOCATION is a buffer position, consider the formulas there."
2336 eq-alist seen)
2340 string)
2345 ;; Is it a column reference?
2347 ;; Since named columns are not possible in
2348 ;; LHS, assume this is a named field.
2356 "Double definition `%s=' in TBLFM line, please fix by hand"
2357 lhs)
2362 "Double definition `%s=' in TBLFM line, please fix by hand"
2363 lhs)))))))))))
2366 "Modify the equations after the table structure has been edited.
2368 For all numbers larger than LIMIT, shift them by DELTA."
2380 s n a)
2386 "Change makes TBLFM term %s invalid, use undo to recover"
2401 ;;;###autoload
2404 If yes, store the formula and apply it."
2405 ;; We already know we are in a table. Get field will only return a formula
2406 ;; when appropriate. It might return a separator line, but no problem.
2409 named eq)
2417 "List of commands triggering the recalculation of a line.
2429 ;;;###autoload
2431 "Rotate the recalculation mark in the first column.
2432 If in any row, the first field is not consistent with a mark,
2433 insert a new column for the markers.
2434 When there is an active region, change all the lines in the region,
2435 after prompting for the marking character.
2436 After each change, a message will be displayed indicating the meaning
2437 of the new mark."
2453 newchar))
2461 newchar))
2479 ;; Rotate mark in first row.
2481 ;; Rotate marks in additional rows if a region is active.
2489 ;; Only align if rotation actually changed lines' length.
2499 ;;;###autoload
2501 "Analyze table at point and store results.
2503 This function sets up the following dynamically scoped variables:
2505 `org-table-column-name-regexp',
2506 `org-table-column-names',
2507 `org-table-current-begin-pos',
2508 `org-table-current-line-types',
2509 `org-table-current-ncol',
2510 `org-table-dlines',
2511 `org-table-hlines',
2512 `org-table-local-parameters',
2513 `org-table-named-field-locations'."
2518 ;; Extract column names.
2531 ;; Extract local parameters.
2539 org-table-local-parameters)))))
2540 ;; Update named fields locations. We minimize `count-lines'
2541 ;; processing by storing last known number of lines in LAST.
2563 field))
2566 org-table-named-field-locations))))))))))
2567 ;; Re-use existing markers when possible.
2571 ;; Analyze the line types.
2582 ;; Get the number of columns from the first data line in table.
2590 al al2)
2604 "Move point to a specific field in the current table.
2606 REF is either the name of a field its absolute reference, as
2607 a string. No column is created unless CREATE-COLUMN-P is
2608 non-nil. If it is a function, it is called with the column
2609 number as its argument as is used as a predicate to know if the
2610 column can be created.
2612 This function assumes the table is already analyzed (i.e., using
2613 `org-table-analyze')."
2628 create-column-p)))
2634 ;;;###autoload
2636 "Recompute the current line if marked for it, and if we haven't just done it."
2656 org-tbl-calc-modes)
2658 ;;;###autoload
2660 suppress-align suppress-const
2661 suppress-store suppress-analysis)
2662 "Replace the table field value at the cursor by the result of a calculation.
2664 In a table, this command replaces the value in the current field with the
2666 formula, by storing it in a special line below the table. When called
2668 field formula.
2671 insert the active equation for the field
2672 back into the current field, so that it can be edited there. This is \
2673 useful
2675 check the referenced fields.
2677 When called, the command first prompts for a formula, which is read in
2678 the minibuffer. Previously entered formulas are available through the
2679 history list, and the last used formula is offered as a default.
2680 These stored formulas are adapted correctly when moving, inserting, or
2681 deleting columns with the corresponding commands.
2683 The formula can be any algebraic expression understood by the Calc package.
2684 For details, see the Org mode manual.
2686 This function can also be called from Lisp programs and offers
2687 additional arguments: EQUATION can be the formula to apply. If this
2688 argument is given, the user will not be prompted.
2690 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2691 unnecessary aligns.
2693 SUPPRESS-CONST suppresses the interpretation of constants in the
2694 formula, assuming that this has been done already outside the
2695 function.
2697 SUPPRESS-STORE means the formula should not be stored, either
2698 because it is already stored, or because it is a modified
2699 equation that should not overwrite the stored one.
2701 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2702 location of point."
2718 equation
2724 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2725 duration duration-output-format)
2726 ;; Parse the format string. Since we have a lot of modes, this is
2727 ;; a lot of work. However, I think calc still uses most of the time.
2740 'calc-float-format
2743 n))))
2748 duration-output-format
2777 ;; replace fields with duration values if relevant
2781 fields)))
2787 x))
2788 fields)))
2794 ;; Insert row and column number of formula result field
2805 t t form)))
2807 ;; Check for old vertical references
2809 ;; Insert remote references
2822 rmtrng))
2823 keep-empty numbers lispp))
2824 t t form)))
2825 ;; Insert complex ranges
2835 ;; possibly handle durations
2840 formrg)
2841 keep-empty numbers lispp)))
2846 ;; Insert simple ranges, i.e. included in the current row.
2849 form)
2860 keep-empty numbers lispp))
2861 t t form)))
2863 ;; Insert the references to fields in same row
2870 x keep-empty numbers lispp)))
2887 ;; Use <...> time-stamps so that Calc can handle them.
2890 ;; Internationalize local time-stamps by setting locale to
2891 ;; "C".
2894 org-ts-regexp
2902 form t t))
2905 form
2912 duration-output-format)
2913 ev)))
2918 Orig: %s
2919 $xyz-> %s
2920 @r$c-> %s
2943 ;; Replace any active time stamp in the result with
2944 ;; an inactive one. Dates in tables are likely
2945 ;; piece of regular data, not meant to appear in the
2946 ;; agenda.
2959 prop value)))
2962 "Get a calc vector from a column, according to descriptor DESC.
2964 Optional arguments TBEG and COL can give the beginning of the table and
2965 the current column, to avoid unnecessary parsing.
2967 HIGHLIGHT means just highlight the range.
2969 When CORNERS-ONLY is set, only return the corners of the range as
2970 a list (line1 column1 line2 column2) where line1 and line2 are
2971 line numbers relative to beginning of table, or TBEG, and column1
2972 and column2 are table column numbers."
2975 desc))
2986 thisline)))
2991 thisline)))
3003 ;; Just one field.
3010 ;; A range, return a vector. First sort the numbers to get
3011 ;; a regular rectangle.
3017 ;; Copy the range values into a list.
3032 ;; Return string representation of calc vector.
3038 "Return relative line number corresponding to descriptor DESC.
3039 The cursor is currently in relative line number CLINE."
3044 ;; 1 2 3 4 5 6
3045 desc))
3067 cline)))
3070 "Return relative line of Nth row with type TYPE.
3071 Search starts from relative line I. When BACKWARDS in non-nil,
3072 look before I. When RELATIVE is non-nil, the reference is
3073 relative. DESC is the original descriptor that started the
3074 search, as a string."
3082 ;; We are going to cross a hline. Check if this is
3083 ;; an authorized move.
3094 ;; The last hline doesn't exist. Instead, point to last row
3095 ;; in table.
3104 "Convert list ELEMENTS to something appropriate to insert into formula.
3105 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3106 NUMBERS indicates that everything should be converted to numbers.
3107 LISPP non-nil means to return something appropriate for a Lisp
3108 list, `literal' is for the format specifier L."
3109 ;; Calc nan (not a number) is used for the conversion of the empty
3110 ;; field to a reference for several reasons: (i) It is accepted in a
3111 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3112 ;; (ii) In a single field (not in range) it can be distinguished
3113 ;; from "(nan)" which is the reference made from a single field
3114 ;; containing "nan".
3116 ;; field reference
3119 elements
3121 ""
3130 ;; range reference
3135 elements))))
3141 x
3149 x)
3151 elements
3155 "If there has been more than one second since T1, display message.
3156 ARGS are passed as arguments to the `message' function. Returns
3157 current time if a message is printed, otherwise returns T1. If
3158 T1 is nil, always messages."
3162 curtime)
3163 t1)))
3165 ;;;###autoload
3167 "Recalculate the current table line by applying all stored formulas.
3169 With prefix arg ALL, do this for all lines in the table.
3172 if ALL is the symbol `iterate',
3173 recompute the table until it no longer changes.
3175 If NOALIGN is not nil, do not re-align the table after the computations
3176 are done. This is typically used internally to save time, if it is
3177 known that the table will be realigned a little later anyway."
3192 beg end eqlcol eqlfield)
3193 ;; Insert constants in all formulas.
3196 ;; Expand equations, then split the equation list between
3197 ;; column formulas and field formulas.
3209 old-lhs)))
3212 existing formula for column %s"
3213 old-lhs
3214 new))
3215 new))
3221 ;; Expand ranges in lhs of formulas
3223 ;; Get the correct line range to process.
3230 ;; This is a table with marked lines, compute selected
3231 ;; lines.
3233 ;; Move forward to the first non-header line.
3238 ;; Just leave BEG at the start of the table.
3243 ;; Mark named fields untouchable. Also check if several
3244 ;; field/range formulas try to set the same field.
3248 seen-fields)
3259 ;; Turn field coordinates associated to NAME
3260 ;; into an absolute reference.
3264 name)))
3267 reference))
3272 ;; Evaluate the column formulas, but skip fields covered by
3273 ;; field formulas.
3277 ;; Unprotected line, recalculate.
3282 log-last-time
3295 ;; Evaluate the field formulas.
3304 reference
3305 ;; Possibly create a new column, as long as
3306 ;; `org-table-formula-create-columns' allows it.
3318 t))
3323 ;; Clean up markers and internal text property.
3334 ;;;###autoload
3336 "Recalculate the table until it does not change anymore.
3337 The maximum number of iterations is 10, but you can choose a different value
3338 with the prefix ARG."
3343 thistbl)
3357 ;;;###autoload
3359 "Recalculate all tables in the current buffer."
3364 ;; Reason for separate `org-table-align': When repeating
3365 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3366 ;; the way.
3369 t)))
3371 ;;;###autoload
3373 "Iterate all tables in the buffer, to converge inter-table dependencies."
3378 c1)
3394 "Apply the #+TBLFM in the line at point to the table."
3401 ;; Insert a temporary formula at right after the table
3406 ;; Recalculate the table.
3411 ;; Delete the formula inserted temporarily.
3417 "Find the beginning of the TBLFM lines and return its position.
3418 Return nil when the beginning of TBLFM line was not found."
3425 "Expand list of formulas.
3426 If some of the RHS in the formulas are ranges or a row reference,
3427 expand them to individual field equations for each field. This
3428 function assumes the table is already analyzed (i.e., using
3429 `org-table-analyze')."
3436 ;; This just refers to one fixed field.
3439 ;; This just refers to one fixed named field.
3442 ;; Column formulas are treated specially and are not
3443 ;; expanded.
3448 rhs)
3449 res)))
3461 rhs)
3462 res))))))))))
3465 "Replace @<, @>, $<, $> with first/last row/column of the table.
3466 So @< and $< will always be replaced with @1 and $1, respectively.
3467 The advantage of these special markers are that structure editing of
3468 the table will not change them, while @1 and $1 will be modified
3469 when a line/row is swapped out of that privileged position. So for
3470 formulas that use a range of rows or columns, it may often be better
3472 borders of the table using the @< @> $< $> makers."
3475 s start)
3480 org-table-current-ncol)
3484 len
3491 s)
3494 "Replace $const with values in string F."
3499 org-table-column-name-regexp
3502 org-table-column-names))))
3503 f t t)))
3504 ;; Parameters and constants.
3508 new start))
3511 ;; When a duration is expected, convert value on the fly.
3517 v)))))
3524 "Find the value for a parameter or constant in a formula.
3525 Parameters get priority."
3556 map))
3563 "--"
3566 "--"
3567 "Shift Reference at Point"
3572 "-"
3573 "Change Test Row for Column Formulas"
3576 "--"
3581 org-table-overlay-coordinates)]
3582 "--"
3590 ;;;###autoload
3592 "Edit the formulas of the current table in a separate buffer."
3598 ;; Move point within the table before analyzing it.
3614 ;; Keep global-font-lock-mode from turning on font-lock-mode
3659 "Convert a formula from internal to user representation."
3662 s))
3665 "Convert a formula from user to internal representation."
3668 s))
3671 "Convert spreadsheet references from A7 to @7$28.
3672 Works for single references, but also for entire formulas and even the
3673 full TBLFM line."
3675 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3678 ;; format match, just advance
3683 ;; 3.e5 or something like this.
3686 ;; (member (match-string 1 s)
3687 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3688 )
3689 ;; function name, just advance
3699 t t s)))))
3700 s))
3703 "Convert spreadsheet references from to @7$28 to AB7.
3704 Works for single references, but also for entire formulas and even the
3705 full TBLFM line."
3712 t t s)))
3717 t nil s)))
3718 s)
3721 "Convert a base 26 number represented by letters into an integer.
3722 For example: AB -> 28."
3728 n))
3731 "Convert an integer into a base 26 number represented by letters.
3732 For example: 28 -> AB."
3737 s))
3740 "Convert a time string into numerical duration in seconds.
3741 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3742 If S is a string representing a number, keep this number."
3744 s
3767 "Convert a number of seconds to a time string.
3768 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3769 minutes or seconds."
3781 ;; Ignore seconds
3785 secs0)
3790 secs0)))))
3794 "Convert all references in this buffer, using FUNCTION."
3805 "Convert all references in the buffer from B3 to @3$2 and back."
3815 "Shift the reference at point one row/hline up."
3819 "Shift the reference at point one row/hline down."
3823 "Shift the reference at point one field to the left."
3827 "Shift the reference at point one field to the right."
3838 ;; A B3-like reference
3844 ;; An internal reference
3850 "Re-match the group N, and replace it with the shifted reference."
3855 t t)))
3858 "Shift a reference part REF.
3859 If DECR is set, decrease the references row/column, else increase.
3860 If HLINE is set, this may be a hline reference, it certainly is not
3861 a translation reference."
3890 "Toggle the display of coordinates in the referenced table."
3899 "Parse the buffer for formula definitions and install them.
3900 With prefix ARG, apply the new formulas to the table."
3909 eql)
3912 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3913 nil t)
3934 "Abort editing formulas, without installing the changes."
3945 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3986 "Show the location/value of the $ expression at point.
3987 When LOCAL is non-nil, show references for the table at point."
3997 var name e what match dest)
4001 "$1.."
4053 dest)
4079 ;; Column number.
4105 org-table-fedit-scroll-down))))
4117 "Make sure the cursor is in a dataline in a table."
4126 p1 p2)))
4131 "Move cursor one line up in the window showing the table."
4136 "Move cursor one line down in the window showing the table."
4141 "Move the cursor in the window showing the table.
4142 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4167 "Add a new overlay."
4173 "Highlight rectangular region in a table.
4174 When buffer positions BEG and END are provided, use them to
4175 delimit the region to highlight. Otherwise, refer to point. Use
4176 FACE, when non-nil, for the highlight."
4208 "Remove the rectangle overlays."
4218 "Add overlays to the table at point, to show row/column coordinates."
4246 ;;;###autoload
4248 "Toggle the display of Row/Column numbers in tables."
4259 ;;;###autoload
4261 "Toggle the formula debugger in tables."
4267 ;;; The orgtbl minor mode
4269 ;; Define a minor mode which can be used in other modes in order to
4270 ;; integrate the Org table editor.
4272 ;; This is really a hack, because the Org table editor uses several
4273 ;; keys which normally belong to the major mode, for example the TAB
4274 ;; and RET keys. Here is how it works: The minor mode defines all the
4275 ;; keys necessary to operate the table editor, but wraps the commands
4276 ;; into a function which tests if the cursor is currently inside
4277 ;; a table. If that is the case, the table editor command is
4278 ;; executed. However, when any of those keys is used outside a table,
4279 ;; the function uses `key-binding' to look up if the key has an
4280 ;; associated command in another currently active keymap (minor modes,
4281 ;; major mode, global), and executes that command. There might be
4282 ;; problems if any of the keys used by the table editor is otherwise
4283 ;; used as a prefix key.
4285 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4286 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4287 ;; addresses this by checking explicitly for both bindings.
4289 ;; The optimized version (see variable `orgtbl-optimized') takes over
4290 ;; all keys which are bound to `self-insert-command' in the *global map*.
4291 ;; Some modes bind other commands to simple characters, for example
4292 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4293 ;; active, this binding is ignored inside tables and replaced with a
4294 ;; modified self-insert.
4312 ;; Install it as a minor mode.
4316 ;;;###autoload
4318 "The `org-mode' table editor as a minor mode for use in other modes."
4323 ;; Exit without error, in case some hook functions calls this
4324 ;; by accident in org-mode.
4328 ;; Make sure we are first in minor-mode-map-alist
4330 ;; FIXME: maybe it should use emulation-mode-map-alists?
4337 auto-fill-inhibit-regexp)
4341 auto-fill-inhibit-regexp)
4342 orgtbl-line-start-regexp))
4360 "Remove all properties related to narrow-column invisibility."
4373 "Create a function for binding in the table minor mode.
4374 FUN is the command to call inside a table. N is used to create a unique
4375 command name. KEYS are keys that should be checked in for a command
4376 to execute outside of tables."
4382 "Outside of tables, run the binding of `"
4394 keys)
4398 "Error when there is no default binding for a table key."
4403 "Setup orgtbl keymaps."
4434 elt key fun cmd)
4442 ;; Special treatment needed for TAB, RET and DEL
4455 (orgtbl-make-binding 'org-delete-backward-char 109
4461 [(tab)] "\C-i"))
4463 (org-defkey orgtbl-mode-map [backtab]
4465 [backtab] [S-iso-lefttab] [(shift tab)]
4466 [(tab)] "\C-i"))
4468 (org-defkey orgtbl-mode-map "\M-\C-m"
4469 (orgtbl-make-binding 'org-table-wrap-region 105
4470 "\M-\C-m" [(meta return)]))
4471 (org-defkey orgtbl-mode-map [(meta return)]
4472 (orgtbl-make-binding 'org-table-wrap-region 106
4473 [(meta return)] "\M-\C-m"))
4475 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4476 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4478 (when orgtbl-optimized
4479 ;; If the user wants maximum table support, we need to hijack
4480 ;; some standard editing functions
4481 (org-remap orgtbl-mode-map
4482 'self-insert-command 'orgtbl-self-insert-command
4483 'delete-char 'org-delete-char
4484 'delete-backward-char 'org-delete-backward-char)
4485 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4486 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4487 '("OrgTbl"
4488 ["Create or convert" org-table-create-or-convert-from-region
4489 :active (not (org-at-table-p)) :keys "C-c |" ]
4490 "--"
4491 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4492 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4493 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4494 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4495 "--"
4496 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4497 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4498 ["Copy Field from Above"
4499 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4500 "--"
4501 ("Column"
4502 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4503 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4504 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4505 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4506 ("Row"
4507 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4508 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4509 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4510 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4511 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4512 "--"
4513 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4514 ("Rectangle"
4515 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4516 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4517 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4518 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4519 "--"
4520 ("Radio tables"
4521 ["Insert table template" orgtbl-insert-radio-table
4522 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4523 ["Comment/uncomment table" orgtbl-toggle-comment t])
4524 "--"
4525 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4526 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4527 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4528 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4529 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4530 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4531 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4532 ["Sum Column/Rectangle" org-table-sum
4533 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4534 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4535 ["Debug Formulas"
4536 org-table-toggle-formula-debugger :active (org-at-table-p)
4537 :keys "C-c {"
4538 :style toggle :selected org-table-formula-debug]
4539 ["Show Col/Row Numbers"
4540 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4541 :keys "C-c }"
4542 :style toggle :selected org-table-overlay-coordinates]
4543 "--"
4544 ("Plot"
4547 t))
4549 (defun orgtbl-ctrl-c-ctrl-c (arg)
4550 "If the cursor is inside a table, realign the table.
4551 If it is a table to be sent away to a receiver, do it.
4552 With prefix arg, also recompute table."
4553 (interactive "P")
4554 (let ((case-fold-search t) (pos (point)) action)
4555 (save-excursion
4556 (beginning-of-line 1)
4557 (setq action (cond
4561 (cond
4562 ((integerp action)
4563 (goto-char action)
4564 (org-table-maybe-eval-formula)
4565 (if arg
4566 (call-interactively 'org-table-recalculate)
4567 (org-table-maybe-recalculate-line))
4568 (call-interactively 'org-table-align)
4569 (when (orgtbl-send-table 'maybe)
4570 (run-hooks 'orgtbl-after-send-table-hook)))
4571 ((eq action 'recalc)
4572 (save-excursion
4573 (beginning-of-line 1)
4575 (if (org-at-table-p)
4576 (org-call-with-arg 'org-table-recalculate t))))
4577 (t (let (orgtbl-mode)
4578 (call-interactively (key-binding "\C-c\C-c")))))))
4580 (defun orgtbl-create-or-convert-from-region (_arg)
4581 "Create table or convert region to table, if no conflicting binding.
4582 This installs the table binding `C-c |', but only if there is no
4583 conflicting binding to this key outside orgtbl-mode."
4584 (interactive "P")
4585 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4586 (if cmd
4587 (call-interactively cmd)
4588 (call-interactively 'org-table-create-or-convert-from-region))))
4590 (defun orgtbl-tab (arg)
4591 "Justification and field motion for `orgtbl-mode'."
4592 (interactive "P")
4593 (if arg (org-table-edit-field t)
4594 (org-table-justify-field-maybe)
4595 (org-table-next-field)))
4597 (defun orgtbl-ret ()
4598 "Justification and field motion for `orgtbl-mode'."
4599 (interactive)
4600 (if (bobp)
4601 (newline)
4602 (org-table-justify-field-maybe)
4603 (org-table-next-row)))
4605 (defun orgtbl-self-insert-command (N)
4606 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4607 If the cursor is in a table looking at whitespace, the whitespace is
4608 overwritten, and the table is not marked as requiring realignment."
4609 (interactive "p")
4610 (if (and (org-at-table-p)
4611 (or
4612 (and org-table-auto-blank-field
4613 (member last-command
4614 '(orgtbl-hijacker-command-100
4615 orgtbl-hijacker-command-101
4616 orgtbl-hijacker-command-102
4617 orgtbl-hijacker-command-103
4618 orgtbl-hijacker-command-104
4619 orgtbl-hijacker-command-105
4620 yas/expand))
4621 (org-table-blank-field))
4622 t)
4623 (eq N 1)
4625 (let (org-table-may-need-update)
4626 (delete-region (match-beginning 1) (match-end 1))
4627 (self-insert-command N))
4628 (setq org-table-may-need-update t)
4629 (let* (orgtbl-mode
4630 a
4631 (cmd (or (key-binding
4632 (or (and (listp function-key-map)
4633 (setq a (assoc last-input-event function-key-map))
4634 (cdr a))
4635 (vector last-input-event)))
4636 'self-insert-command)))
4637 (call-interactively cmd)
4638 (if (and org-self-insert-cluster-for-undo
4639 (eq cmd 'self-insert-command))
4640 (if (not (eq last-command 'orgtbl-self-insert-command))
4641 (setq org-self-insert-command-undo-counter 1)
4642 (if (>= org-self-insert-command-undo-counter 20)
4643 (setq org-self-insert-command-undo-counter 1)
4644 (and (> org-self-insert-command-undo-counter 0)
4645 buffer-undo-list
4646 (not (cadr buffer-undo-list)) ; remove nil entry
4647 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4648 (setq org-self-insert-command-undo-counter
4649 (1+ org-self-insert-command-undo-counter))))))))
4651 ;;;###autoload
4653 "Regular expression matching exponentials as produced by calc.")
4655 (defun orgtbl-gather-send-defs ()
4656 "Gather a plist of :name, :transform, :params for each destination before
4657 a radio table."
4658 (save-excursion
4659 (goto-char (org-table-begin))
4660 (let (rtn)
4661 (beginning-of-line 0)
4662 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4663 (let ((name (org-no-properties (match-string 1)))
4664 (transform (intern (match-string 2)))
4665 (params (if (match-end 3)
4666 (read (concat "(" (match-string 3) ")")))))
4667 (push (list :name name :transform transform :params params)
4668 rtn)
4669 (beginning-of-line 0)))
4670 rtn)))
4672 (defun orgtbl-send-replace-tbl (name text)
4673 "Find and replace table NAME with TEXT."
4674 (save-excursion
4675 (goto-char (point-min))
4676 (let* ((location-flag nil)
4677 (name (regexp-quote name))
4680 (while (re-search-forward begin-re nil t)
4681 (unless location-flag (setq location-flag t))
4682 (let ((beg (line-beginning-position 2)))
4683 (unless (re-search-forward end-re nil t)
4684 (user-error "Cannot find end of receiver location at %d" beg))
4685 (beginning-of-line)
4686 (delete-region beg (point))
4688 (unless location-flag
4689 (user-error "No valid receiver location found in the buffer")))))
4691 ;;;###autoload
4692 (defun org-table-to-lisp (&optional txt)
4693 "Convert the table at point to a Lisp structure.
4694 The structure will be a list. Each item is either the symbol `hline'
4695 for a horizontal separator line, or a list of field values as strings.
4696 The table is taken from the parameter TXT, or from the buffer at point."
4697 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4698 (let ((txt (or txt
4699 (buffer-substring-no-properties (org-table-begin)
4700 (org-table-end)))))
4701 (mapcar (lambda (x)
4702 (if (string-match org-table-hline-regexp x) 'hline
4706 (defun orgtbl-send-table (&optional maybe)
4707 "Send a transformed version of table at point to the receiver position.
4708 With argument MAYBE, fail quietly if no transformation is defined
4709 for this table."
4710 (interactive)
4711 (catch 'exit
4712 (unless (org-at-table-p) (user-error "Not at a table"))
4713 ;; when non-interactive, we assume align has just happened.
4714 (when (called-interactively-p 'any) (org-table-align))
4715 (let ((dests (orgtbl-gather-send-defs))
4716 (table (org-table-to-lisp
4717 (buffer-substring-no-properties (org-table-begin)
4718 (org-table-end))))
4719 (ntbl 0))
4720 (unless dests
4721 (if maybe (throw 'exit nil)
4722 (user-error "Don't know how to transform this table")))
4723 (dolist (dest dests)
4724 (let ((name (plist-get dest :name))
4725 (transform (plist-get dest :transform))
4726 (params (plist-get dest :params)))
4727 (unless (fboundp transform)
4728 (user-error "No such transformation function %s" transform))
4729 (orgtbl-send-replace-tbl name (funcall transform table params)))
4730 (cl-incf ntbl))
4731 (message "Table converted and installed at %d receiver location%s"
4732 ntbl (if (> ntbl 1) "s" ""))
4733 (and (> ntbl 0) ntbl))))
4735 (defun org-remove-by-index (list indices &optional i0)
4736 "Remove the elements in LIST with indices in INDICES.
4737 First element has index 0, or I0 if given."
4738 (if (not indices)
4739 list
4740 (if (integerp indices) (setq indices (list indices)))
4741 (setq i0 (1- (or i0 0)))
4742 (delq :rm (mapcar (lambda (x)
4743 (setq i0 (1+ i0))
4744 (if (memq i0 indices) :rm x))
4745 list))))
4747 (defun orgtbl-toggle-comment ()
4748 "Comment or uncomment the orgtbl at point."
4749 (interactive)
4750 (let* ((case-fold-search t)
4751 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4752 (re2 (concat "^" orgtbl-line-start-regexp))
4753 (commented (save-excursion (beginning-of-line 1)
4754 (cond ((looking-at re1) t)
4755 ((looking-at re2) nil)
4756 (t (user-error "Not at an org table")))))
4757 (re (if commented re1 re2))
4758 beg end)
4759 (save-excursion
4760 (beginning-of-line 1)
4761 (while (looking-at re) (beginning-of-line 0))
4762 (beginning-of-line 2)
4763 (setq beg (point))
4764 (while (looking-at re) (beginning-of-line 2))
4765 (setq end (point)))
4766 (comment-region beg end (if commented '(4) nil))))
4768 (defun orgtbl-insert-radio-table ()
4769 "Insert a radio table template appropriate for this major mode."
4770 (interactive)
4771 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4772 (txt (nth 1 e))
4773 name pos)
4774 (unless e (user-error "No radio table setup defined for %s" major-mode))
4775 (setq name (read-string "Table name: "))
4776 (while (string-match "%n" txt)
4777 (setq txt (replace-match name t t txt)))
4779 (setq pos (point))
4780 (insert txt)
4781 (goto-char pos)))
4783 ;;;###autoload
4784 (defun orgtbl-to-generic (table params)
4785 "Convert the orgtbl-mode TABLE to some other format.
4787 This generic routine can be used for many standard cases.
4789 TABLE is a list, each entry either the symbol `hline' for
4790 a horizontal separator line, or a list of fields for that
4791 line. PARAMS is a property list of parameters that can
4792 influence the conversion.
4794 Valid parameters are:
4796 :backend, :raw
4798 Export back-end used as a basis to transcode elements of the
4799 table, when no specific parameter applies to it. It is also
4800 used to translate cells contents. You can prevent this by
4801 setting :raw property to a non-nil value.
4803 :splice
4805 When non-nil, only convert rows, not the table itself. This is
4806 equivalent to setting to the empty string both :tstart
4807 and :tend, which see.
4809 :skip
4811 When set to an integer N, skip the first N lines of the table.
4812 Horizontal separation lines do count for this parameter!
4814 :skipcols
4816 List of columns that should be skipped. If the table has
4817 a column with calculation marks, that column is automatically
4818 discarded beforehand.
4820 :hline
4822 String to be inserted on horizontal separation lines. May be
4823 nil to ignore these lines altogether.
4825 :sep
4827 Separator between two fields, as a string.
4829 Each in the following group may be either a string or a function
4830 of no arguments returning a string:
4832 :tstart, :tend
4834 Strings to start and end the table. Ignored when :splice is t.
4836 :lstart, :lend
4838 Strings to start and end a new table line.
4840 :llstart, :llend
4842 Strings to start and end the last table line. Default,
4843 respectively, to :lstart and :lend.
4845 Each in the following group may be a string or a function of one
4846 argument (either the cells in the current row, as a list of
4847 strings, or the current cell) returning a string:
4849 :lfmt
4851 Format string for an entire row, with enough %s to capture all
4852 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4854 :llfmt
4856 Format for the entire last line, defaults to :lfmt.
4858 :fmt
4860 A format to be used to wrap the field, should contain %s for
4861 the original field value. For example, to wrap everything in
4863 a property list with column numbers and format strings, or
4864 functions, e.g.,
4868 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4870 Same as above, specific for the header lines in the table.
4871 All lines before the first hline are treated as header. If
4872 any of these is not present, the data line value is used.
4874 This may be either a string or a function of two arguments:
4876 :efmt
4878 Use this format to print numbers with exponential. The format
4879 should have %s twice for inserting mantissa and exponent, for
4881 list with column numbers and format strings or functions.
4882 :fmt will still be applied after :efmt."
4883 ;; Make sure `org-export-create-backend' is available.
4884 (require 'ox)
4885 (let* ((backend (plist-get params :backend))
4886 (custom-backend
4887 ;; Build a custom back-end according to PARAMS. Before
4888 ;; defining a translator, check if there is anything to do.
4889 ;; When there isn't, let BACKEND handle the element.
4890 (org-export-create-backend
4891 :parent (or backend 'org)
4892 :transcoders
4893 `((table . ,(org-table--to-generic-table params))
4894 (table-row . ,(org-table--to-generic-row params))
4895 (table-cell . ,(org-table--to-generic-cell params))
4896 ;; Macros are not going to be expanded. However, no
4897 ;; regular back-end has a transcoder for them. We
4898 ;; provide one so they are not ignored, but displayed
4899 ;; as-is instead.
4900 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4901 data info)
4902 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4903 ;; Initialize communication channel in INFO.
4904 (with-temp-buffer
4905 (let ((org-inhibit-startup t)) (org-mode))
4906 (let ((standard-output (current-buffer))
4907 (org-element-use-cache nil))
4908 (dolist (e table)
4910 ((consp e)
4911 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4913 ;; Add back-end specific filters, but not user-defined ones. In
4914 ;; particular, make sure to call parse-tree filters on the
4915 ;; table.
4916 (setq info
4917 (let ((org-export-filters-alist nil))
4918 (org-export-install-filters
4919 (org-combine-plists
4920 (org-export-get-environment backend nil params)
4921 `(:back-end ,(org-export-get-backend backend))))))
4922 (setq data
4923 (org-export-filter-apply-functions
4924 (plist-get info :filter-parse-tree)
4925 (org-element-map (org-element-parse-buffer) 'table
4926 #'identity nil t)
4927 info)))
4928 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4929 (user-error "Unknown :backend value"))
4930 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4931 ;; Handle :skip parameter.
4932 (let ((skip (plist-get info :skip)))
4933 (when skip
4934 (unless (wholenump skip) (user-error "Wrong :skip value"))
4935 (let ((n 0))
4936 (org-element-map data 'table-row
4937 (lambda (row)
4938 (if (>= n skip) t
4939 (org-element-extract-element row)
4940 (cl-incf n)
4941 nil))
4942 nil t))))
4943 ;; Handle :skipcols parameter.
4944 (let ((skipcols (plist-get info :skipcols)))
4945 (when skipcols
4946 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4947 (org-element-map data 'table
4948 (lambda (table)
4949 (let ((specialp (org-export-table-has-special-column-p table)))
4950 (dolist (row (org-element-contents table))
4951 (when (eq (org-element-property :type row) 'standard)
4952 (let ((c 1))
4953 (dolist (cell (nthcdr (if specialp 1 0)
4954 (org-element-contents row)))
4955 (when (memq c skipcols)
4956 (org-element-extract-element cell))
4957 (cl-incf c))))))))))
4958 ;; Since we are going to export using a low-level mechanism,
4959 ;; ignore special column and special rows manually.
4960 (let ((special? (org-export-table-has-special-column-p data))
4961 ignore)
4962 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4963 (lambda (datum)
4964 (when (if (eq (org-element-type datum) 'table-row)
4965 (org-export-table-row-is-special-p datum nil)
4966 (org-export-first-sibling-p datum nil))
4967 (push datum ignore))))
4968 (setq info (plist-put info :ignore-list ignore)))
4969 ;; We use a low-level mechanism to export DATA so as to skip all
4970 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4971 ;; code evaluation, include keywords and macro expansion. Only
4972 ;; back-end specific filters are retained.
4973 (let ((output (org-export-data-with-backend data custom-backend info)))
4974 ;; Remove final newline.
4975 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4977 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4978 (cond ((null value) nil)
4979 ((functionp value) `(funcall ',value ,@args))
4980 ((stringp value)
4981 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4982 (args `(format ,value ,@args))
4983 (t value)))
4984 ((and with-cons (consp value))
4985 `(let ((val (cadr (memq column ',value))))
4986 (cond ((null val) contents)
4987 ((stringp val) (format val ,@args))
4988 ((functionp val) (funcall val ,@args))
4989 (t (user-error "Wrong %s value" ,name)))))
4990 (t (user-error "Wrong %s value" name))))
4992 (defun org-table--to-generic-table (params)
4993 "Return custom table transcoder according to PARAMS.
4994 PARAMS is a plist. See `orgtbl-to-generic' for more
4995 information."
4996 (let ((backend (plist-get params :backend))
4997 (splice (plist-get params :splice))
4998 (tstart (plist-get params :tstart))
4999 (tend (plist-get params :tend)))
5000 `(lambda (table contents info)
5001 (concat
5002 ,(and tstart (not splice)
5004 ,(if (or (not backend) tstart tend splice) 'contents
5005 `(org-export-with-backend ',backend table contents info))
5006 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5008 (defun org-table--to-generic-row (params)
5009 "Return custom table row transcoder according to PARAMS.
5010 PARAMS is a plist. See `orgtbl-to-generic' for more
5011 information."
5012 (let* ((backend (plist-get params :backend))
5013 (lstart (plist-get params :lstart))
5014 (llstart (plist-get params :llstart))
5015 (hlstart (plist-get params :hlstart))
5016 (hllstart (plist-get params :hllstart))
5017 (lend (plist-get params :lend))
5018 (llend (plist-get params :llend))
5019 (hlend (plist-get params :hlend))
5020 (hllend (plist-get params :hllend))
5021 (lfmt (plist-get params :lfmt))
5022 (llfmt (plist-get params :llfmt))
5023 (hlfmt (plist-get params :hlfmt))
5024 (hllfmt (plist-get params :hllfmt)))
5025 `(lambda (row contents info)
5026 (if (eq (org-element-property :type row) 'rule)
5027 ,(cond
5028 ((plist-member params :hline)
5029 (org-table--generic-apply (plist-get params :hline) ":hline"))
5030 (backend `(org-export-with-backend ',backend row nil info)))
5031 (let ((headerp ,(and (or hlfmt hlstart hlend)
5032 '(org-export-table-row-in-header-p row info)))
5033 (last-header-p
5034 ,(and (or hllfmt hllstart hllend)
5035 '(org-export-table-row-ends-header-p row info)))
5036 (lastp (not (org-export-get-next-element row info))))
5037 (when contents
5038 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5039 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5040 ;; `:lstart', `:lend' and their relatives.
5041 ,(let ((cells
5042 '(org-element-map row 'table-cell
5043 (lambda (cell)
5044 ;; Export all cells, without separators.
5045 ;;
5046 ;; Use `org-export-data-with-backend'
5047 ;; instead of `org-export-data' to eschew
5048 ;; cached values, which
5049 ;; ignore :orgtbl-ignore-sep parameter.
5050 (org-export-data-with-backend
5051 cell
5052 (plist-get info :back-end)
5053 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5054 info)))
5055 `(cond
5056 ,(and hllfmt
5057 `(last-header-p ,(org-table--generic-apply
5058 hllfmt ":hllfmt" nil cells)))
5059 ,(and hlfmt
5060 `(headerp ,(org-table--generic-apply
5061 hlfmt ":hlfmt" nil cells)))
5062 ,(and llfmt
5063 `(lastp ,(org-table--generic-apply
5064 llfmt ":llfmt" nil cells)))
5065 (t
5066 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5067 `(concat
5068 (cond
5069 ,(and
5070 (or hllstart hllend)
5071 `(last-header-p
5072 (concat
5073 ,(org-table--generic-apply hllstart ":hllstart")
5074 contents
5075 ,(org-table--generic-apply hllend ":hllend"))))
5076 ,(and
5077 (or hlstart hlend)
5078 `(headerp
5079 (concat
5080 ,(org-table--generic-apply hlstart ":hlstart")
5081 contents
5082 ,(org-table--generic-apply hlend ":hlend"))))
5083 ,(and
5084 (or llstart llend)
5085 `(lastp
5086 (concat
5087 ,(org-table--generic-apply llstart ":llstart")
5088 contents
5089 ,(org-table--generic-apply llend ":llend"))))
5090 (t
5091 ,(cond
5092 ((or lstart lend)
5093 `(concat
5094 ,(org-table--generic-apply lstart ":lstart")
5095 contents
5096 ,(org-table--generic-apply lend ":lend")))
5097 (backend
5098 `(org-export-with-backend
5099 ',backend row contents info))
5100 (t 'contents)))))))))))))))
5102 (defun org-table--to-generic-cell (params)
5103 "Return custom table cell transcoder according to PARAMS.
5104 PARAMS is a plist. See `orgtbl-to-generic' for more
5105 information."
5106 (let* ((backend (plist-get params :backend))
5107 (efmt (plist-get params :efmt))
5108 (fmt (plist-get params :fmt))
5109 (hfmt (plist-get params :hfmt))
5110 (sep (plist-get params :sep))
5111 (hsep (plist-get params :hsep)))
5112 `(lambda (cell contents info)
5113 ;; Make sure that contents are exported as Org data when :raw
5114 ;; parameter is non-nil.
5115 ,(when (and backend (plist-get params :raw))
5116 `(setq contents
5117 ;; Since we don't know what are the pseudo object
5118 ;; types defined in backend, we cannot pass them to
5119 ;; `org-element-interpret-data'. As a consequence,
5120 ;; they will be treated as pseudo elements, and will
5121 ;; have newlines appended instead of spaces.
5122 ;; Therefore, we must make sure :post-blank value is
5123 ;; really turned into spaces.
5124 (replace-regexp-in-string
5126 (org-trim
5127 (org-element-interpret-data
5128 (org-element-contents cell))))))
5130 (let ((headerp ,(and (or hfmt hsep)
5131 '(org-export-table-row-in-header-p
5132 (org-export-get-parent-element cell) info)))
5133 (column
5134 ;; Call costly `org-export-table-cell-address' only if
5135 ;; absolutely necessary, i.e., if one
5136 ;; of :fmt :efmt :hfmt has a "plist type" value.
5137 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5138 (list efmt hfmt fmt))
5139 '(1+ (cdr (org-export-table-cell-address cell info))))))
5140 (when contents
5141 ;; Check if we can apply `:efmt' on CONTENTS.
5142 ,(when efmt
5143 `(when (string-match orgtbl-exp-regexp contents)
5144 (let ((mantissa (match-string 1 contents))
5145 (exponent (match-string 2 contents)))
5146 (setq contents ,(org-table--generic-apply
5147 efmt ":efmt" t 'mantissa 'exponent)))))
5148 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5149 (cond
5150 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5151 hfmt ":hfmt" t 'contents))))
5152 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5153 fmt ":fmt" t 'contents))))))
5154 ;; If a separator is provided, use it instead of BACKEND's.
5155 ;; Separators are ignored when LFMT (or equivalent) is
5156 ;; provided.
5157 ,(cond
5158 ((or hsep sep)
5159 `(if (or ,(and (not sep) '(not headerp))
5160 (plist-get info :orgtbl-ignore-sep)
5161 (not (org-export-get-next-element cell info)))
5162 ,(if (not backend) 'contents
5163 `(org-export-with-backend ',backend cell contents info))
5164 (concat contents
5165 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5166 (or hsep sep)))))
5167 (backend `(org-export-with-backend ',backend cell contents info))
5168 (t 'contents))))))
5170 ;;;###autoload
5171 (defun orgtbl-to-tsv (table params)
5172 "Convert the orgtbl-mode table to TAB separated material."
5175 ;;;###autoload
5176 (defun orgtbl-to-csv (table params)
5177 "Convert the orgtbl-mode table to CSV material.
5178 This does take care of the proper quoting of fields with comma or quotes."
5179 (orgtbl-to-generic table
5180 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5181 params)))
5183 ;;;###autoload
5184 (defun orgtbl-to-latex (table params)
5185 "Convert the orgtbl-mode TABLE to LaTeX.
5187 TABLE is a list, each entry either the symbol `hline' for
5188 a horizontal separator line, or a list of fields for that line.
5189 PARAMS is a property list of parameters that can influence the
5190 conversion. All parameters from `orgtbl-to-generic' are
5191 supported. It is also possible to use the following ones:
5193 :booktabs
5197 :environment
5199 Specify environment to use, as a string. If you use
5201 as a string, to get proper continuation strings."
5202 (require 'ox-latex)
5203 (orgtbl-to-generic
5204 table
5205 (org-combine-plists
5206 ;; Provide sane default values.
5207 (list :backend 'latex
5208 :latex-default-table-mode 'table
5209 :latex-tables-centered nil
5210 :latex-tables-booktabs (plist-get params :booktabs)
5211 :latex-table-scientific-notation nil
5212 :latex-default-table-environment
5213 (or (plist-get params :environment) "tabular"))
5214 params)))
5216 ;;;###autoload
5217 (defun orgtbl-to-html (table params)
5218 "Convert the orgtbl-mode TABLE to HTML.
5220 TABLE is a list, each entry either the symbol `hline' for
5221 a horizontal separator line, or a list of fields for that line.
5222 PARAMS is a property list of parameters that can influence the
5223 conversion. All parameters from `orgtbl-to-generic' are
5224 supported. It is also possible to use the following one:
5226 :attributes
5228 Attributes and values, as a plist, which will be used in
5229 <table> tag."
5230 (require 'ox-html)
5231 (orgtbl-to-generic
5232 table
5233 (org-combine-plists
5234 ;; Provide sane default values.
5235 (list :backend 'html
5236 :html-table-data-tags '("<td%s>" . "</td>")
5237 :html-table-use-header-tags-for-first-column nil
5238 :html-table-align-individual-fields t
5239 :html-table-row-tags '("<tr>" . "</tr>")
5240 :html-table-attributes
5241 (if (plist-member params :attributes)
5242 (plist-get params :attributes)
5243 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5244 :frame "hsides")))
5245 params)))
5247 ;;;###autoload
5248 (defun orgtbl-to-texinfo (table params)
5249 "Convert the orgtbl-mode TABLE to Texinfo.
5251 TABLE is a list, each entry either the symbol `hline' for
5252 a horizontal separator line, or a list of fields for that line.
5253 PARAMS is a property list of parameters that can influence the
5254 conversion. All parameters from `orgtbl-to-generic' are
5255 supported. It is also possible to use the following one:
5257 :columns
5259 Column widths, as a string. When providing column fractions,
5261 (require 'ox-texinfo)
5262 (let ((output
5263 (orgtbl-to-generic
5264 table
5265 (org-combine-plists
5266 (list :backend 'texinfo
5267 :texinfo-tables-verbatim nil
5268 :texinfo-table-scientific-notation nil)
5269 params)))
5270 (columns (let ((w (plist-get params :columns)))
5271 (cond ((not w) nil)
5273 (t (concat "@columnfractions " w))))))
5274 (if (not columns) output
5275 (replace-regexp-in-string
5278 ;;;###autoload
5279 (defun orgtbl-to-orgtbl (table params)
5280 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5282 TABLE is a list, each entry either the symbol `hline' for
5283 a horizontal separator line, or a list of fields for that line.
5284 PARAMS is a property list of parameters that can influence the
5285 conversion. All parameters from `orgtbl-to-generic' are
5286 supported.
5288 Useful when slicing one table into many. The :hline, :sep,
5289 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5290 be set to provide ORGTBL directives for the generated table."
5291 (require 'ox-org)
5292 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5294 (defun orgtbl-to-table.el (table params)
5295 "Convert the orgtbl-mode TABLE into a table.el table.
5296 TABLE is a list, each entry either the symbol `hline' for
5297 a horizontal separator line, or a list of fields for that line.
5298 PARAMS is a property list of parameters that can influence the
5299 conversion. All parameters from `orgtbl-to-generic' are
5300 supported."
5301 (with-temp-buffer
5302 (insert (orgtbl-to-orgtbl table params))
5303 (org-table-align)
5304 (replace-regexp-in-string
5305 "-|" "-+"
5306 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5308 (defun orgtbl-to-unicode (table params)
5309 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5311 TABLE is a list, each entry either the symbol `hline' for
5312 a horizontal separator line, or a list of fields for that line.
5313 PARAMS is a property list of parameters that can influence the
5314 conversion. All parameters from `orgtbl-to-generic' are
5315 supported. It is also possible to use the following ones:
5317 :ascii-art
5320 the table. You can download it here:
5321 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5323 :narrow
5325 When non-nil, narrow columns width than provided width cookie,
5327 (require 'ox-ascii)
5328 (orgtbl-to-generic
5329 table
5330 (org-combine-plists
5331 (list :backend 'ascii
5332 :ascii-charset 'utf-8
5333 :ascii-table-widen-columns (not (plist-get params :narrow))
5334 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5335 params)))
5337 ;; Put the cursor in a column containing numerical values
5338 ;; of an Org table,
5339 ;; type C-c " a
5340 ;; A new column is added with a bar plot.
5341 ;; When the table is refreshed (C-u C-c *),
5342 ;; the plot is updated to reflect the new values.
5344 (defun orgtbl-ascii-draw (value min max &optional width characters)
5345 "Draw an ascii bar in a table.
5346 VALUE is the value to plot, it determines the width of the bar to draw.
5347 MIN is the value that will be displayed as empty (zero width bar).
5348 MAX is the value that will draw a bar filling all the WIDTH.
5349 WIDTH is the span in characters from MIN to MAX.
5350 CHARACTERS is a string that will compose the bar, with shades of grey
5351 from pure white to pure black. It defaults to a 10 characters string
5352 of regular ascii characters."
5353 (let* ((width (ceiling (or width 12)))
5354 (characters (or characters " .:;c!lhVHW"))
5355 (len (1- (length characters)))
5356 (value (float (if (numberp value)
5357 value (string-to-number value))))
5358 (relative (/ (- value min) (- max min)))
5359 (steps (round (* relative width len))))
5360 (cond ((< steps 0) "too small")
5361 ((> steps (* width len)) "too large")
5362 (t (let* ((int-division (/ steps len))
5363 (remainder (- steps (* int-division len))))
5364 (concat (make-string int-division (elt characters len))
5365 (string (elt characters remainder))))))))
5367 ;;;###autoload
5368 (defun orgtbl-ascii-plot (&optional ask)
5369 "Draw an ASCII bar plot in a column.
5371 With cursor in a column containing numerical values, this function
5372 will draw a plot in a new column.
5374 ASK, if given, is a numeric prefix to override the default 12
5376 prefix,
5377 which will prompt for the width."
5378 (interactive "P")
5379 (let ((col (org-table-current-column))
5380 (min 1e999) ; 1e999 will be converted to infinity
5381 (max -1e999) ; which is the desired result
5382 (table (org-table-to-lisp))
5383 (length
5384 (cond ((consp ask)
5385 (read-number "Length of column " 12))
5386 ((numberp ask) ask)
5387 (t 12))))
5388 ;; Skip any hline a the top of table.
5389 (while (eq (car table) 'hline) (setq table (cdr table)))
5390 ;; Skip table header if any.
5391 (dolist (x (or (cdr (memq 'hline table)) table))
5392 (when (consp x)
5393 (setq x (nth (1- col) x))
5394 (when (string-match
5396 x)
5397 (setq x (string-to-number x))
5398 (when (> min x) (setq min x))
5399 (when (< max x) (setq max x)))))
5400 (org-table-insert-column)
5401 (org-table-move-column-right)
5402 (org-table-store-formulas
5403 (cons
5404 (cons
5405 (concat "$" (number-to-string (1+ col)))
5406 (format "'(%s $%s %s %s %s)"
5407 "orgtbl-ascii-draw" col min max length))
5408 (org-table-get-stored-formulas)))
5409 (org-table-recalculate t)))
5411 ;; Example of extension: unicode characters
5412 ;; Here are two examples of different styles.
5414 ;; Unicode block characters are used to give a smooth effect.
5415 ;; See http://en.wikipedia.org/wiki/Block_Elements
5416 ;; Use one of those drawing functions
5417 ;; - orgtbl-ascii-draw (the default ascii)
5418 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5419 ;; - orgtbl-uc-draw-cont (smooth unicode)
5421 ;; This is best viewed with the "DejaVu Sans Mono" font
5422 ;; (use M-x set-default-font).
5424 (defun orgtbl-uc-draw-grid (value min max &optional width)
5425 "Draw a bar in a table using block unicode characters.
5426 It is a variant of orgtbl-ascii-draw with Unicode block
5427 characters, for a smooth display. Bars appear as grids (to the
5428 extent the font allows)."
5429 ;; http://en.wikipedia.org/wiki/Block_Elements
5430 ;; best viewed with the "DejaVu Sans Mono" font.
5431 (orgtbl-ascii-draw value min max width
5434 (defun orgtbl-uc-draw-cont (value min max &optional width)
5435 "Draw a bar in a table using block unicode characters.
5436 It is a variant of orgtbl-ascii-draw with Unicode block
5437 characters, for a smooth display. Bars are solid (to the extent
5438 the font allows)."
5439 (orgtbl-ascii-draw value min max width
5442 (defun org-table-get-remote-range (name-or-id form)
5443 "Get a field value or a list of values in a range from table at ID.
5445 NAME-OR-ID may be the name of a table in the current file as set
5447 will then be used. Alternatively, it may be an ID referring to
5448 any entry, also in a different file. In this case, the first
5449 table in that entry will be referenced.
5453 The return value is either a single string for a single field, or a
5454 list of the fields in the rectangle."
5455 (save-match-data
5456 (let ((case-fold-search t) (id-loc nil)
5457 ;; Protect a bunch of variables from being overwritten by
5458 ;; the context of the remote table.
5459 org-table-column-names org-table-column-name-regexp
5460 org-table-local-parameters org-table-named-field-locations
5461 org-table-current-line-types
5462 org-table-current-begin-pos org-table-dlines
5463 org-table-current-ncol
5464 org-table-hlines org-table-last-alignment
5465 org-table-last-column-widths org-table-last-alignment
5466 org-table-last-column-widths
5467 buffer loc)
5468 (setq form (org-table-convert-refs-to-rc form))
5469 (org-with-wide-buffer
5470 (goto-char (point-min))
5471 (if (re-search-forward
5474 nil t)
5475 (setq buffer (current-buffer) loc (match-beginning 0))
5476 (setq id-loc (org-id-find name-or-id 'marker))
5477 (unless (and id-loc (markerp id-loc))
5479 (setq buffer (marker-buffer id-loc)
5480 loc (marker-position id-loc))
5481 (move-marker id-loc nil))
5482 (with-current-buffer buffer
5483 (org-with-wide-buffer
5484 (goto-char loc)
5485 (forward-char 1)
5487 (not (match-beginning 1)))
5488 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5489 (org-table-analyze)
5490 (setq form (org-table-formula-substitute-names
5491 (org-table-formula-handle-first/last-rc form)))
5492 (if (and (string-match org-table-range-regexp form)
5493 (> (length (match-string 0 form)) 1))
5494 (org-table-get-range
5495 (match-string 0 form) org-table-current-begin-pos 1)
5496 form)))))))
5498 (defun org-table-remote-reference-indirection (form)
5499 "Return formula with table remote references substituted by indirection.
5501 This indirection works only with the format @ROW$COLUMN. The
5503 distinguished from a plain table name or ID."
5504 (let ((regexp
5505 ;; Same as in `org-table-eval-formula'.
5507 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5510 (replace-regexp-in-string
5511 regexp
5512 (lambda (m)
5513 (save-match-data
5514 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5515 (org-table-get-range
5517 (concat "@0" eq)
5518 eq)))))
5519 form t t 1)))
5521 (defmacro org-define-lookup-function (mode)
5522 (let ((mode-str (symbol-name mode))
5523 (first-p (eq mode 'first))
5524 (all-p (eq mode 'all)))
5525 (let ((plural-str (if all-p "s" "")))
5526 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5527 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5528 If R-LIST is nil, return matching element%s of S-LIST.
5529 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5530 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5531 This function is generated by a call to the macro `org-define-lookup-function'."
5532 mode-str plural-str plural-str plural-str)
5533 (let ,(let ((lvars '((p (or predicate 'equal))
5534 (sl s-list)
5535 (rl (or r-list s-list))
5536 (ret nil))))
5537 (if first-p (cons '(match-p nil) lvars) lvars))
5538 (while ,(if first-p '(and (not match-p) sl) 'sl)
5539 (when (funcall p val (car sl))
5540 ,(when first-p '(setq match-p t))
5541 (let ((rval (car rl)))
5542 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5543 (setq sl (cdr sl) rl (cdr rl)))
5544 ret)))))
5546 (org-define-lookup-function first)
5547 (org-define-lookup-function last)
5548 (org-define-lookup-function all)
5550 (provide 'org-table)
5552 ;; Local variables:
5553 ;; generated-autoload-file: "org-loaddefs.el"
5554 ;; End:
5556 ;;; org-table.el ends here