| blob | 097a191d2be90376ba89142fc4072ccb834f8dda |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2015 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:
73 "Hook for functions attaching to `C-c C-c', if the table is sent.
74 This can be used to add additional functionality after the table is sent
75 to the receiver position, otherwise, if table is not sent, the functions
81 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
82 In the optimized version, the table editor takes over all simple keys that
83 normally just insert a character. In tables, the characters are inserted
84 in a way to minimize disturbing the table structure (i.e. in overwrite mode
85 for empty fields). Outside tables, the correct binding of the keys is
86 restored.
88 The default for this option is t if the optimized version is also used in
89 Org-mode. See the variable `org-enable-table-editor' for details. Changing
90 this variable requires a restart of Emacs to become effective."
96 % END RECEIVE ORGTBL %n
98 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
99 | | |
102 @c END RECEIVE ORGTBL %n
103 @ignore
104 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
105 | | |
108 <!-- END RECEIVE ORGTBL %n -->
109 <!--
110 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
111 | | |
114 #+ END RECEIVE ORGTBL %n
116 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
117 | | |
119 "Templates for radio tables in different major modes.
120 Each template must define lines that will be treated as a comment and that
123 insertion of the template. The transformed table will later be inserted
124 between these lines.
126 The template should also contain a minimal table in a multiline comment.
127 If multiline comments are not possible in the buffer language,
128 you can pack it into a string that will not be used when the code
129 is compiled or executed. Above the table will you need a line with
131 convert the table into a data structure useful in the
132 language of the buffer. Check the manual for the section on
134 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
136 All occurrences of %n in a template will be replaced with the name of the
137 table, obtained by prompting the user."
144 "Settings for tables in Org-mode."
149 "The default size for newly created tables, Columns x Rows."
154 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
155 "Regular expression for recognizing numbers in table columns.
156 If a table column contains mostly numbers, it will be aligned to the
157 right. If not, it will be aligned to the left.
159 The default value of this option is a regular expression which allows
160 anything which looks remotely like a number as used in scientific
161 context. For example, all of the following will be considered a
162 number:
163 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
165 Other options offered by the customize interface are more restrictive."
179 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
180 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
181 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
185 "Fraction of numbers in a column required to make the column align right.
186 In a column all non-white fields are considered. If at least
187 this fraction of fields is matched by `org-table-number-regexp',
188 alignment to the right border applies."
193 "Behavior of tables during editing in Org-mode."
198 "Non-nil means automatically re-align table when pressing TAB or RETURN.
200 removal/insertion."
205 "Non-nil means automatically blank table field when starting to type into it.
206 This only happens when typing immediately after a field motion
207 command (TAB, S-TAB or RET).
208 Only relevant when `org-enable-table-editor' is equal to `optimized'."
213 "Non-nil means automatically exit the follow mode.
214 When nil, the follow mode will stay on and be active in any table
215 the cursor enters. Since the table follow filed mode messes with the
216 window configuration, it is not recommended to set this variable to nil,
217 except maybe locally in a special file that has mostly tables with long
218 fields."
224 "Whether the user should confirm when Org fixes formulas."
232 'safe-local-variable
236 "Non-nil means tab in the last column of a table with jump over a hline.
237 If a horizontal separator line is following the current line,
238 `org-table-next-field' can either create a new row before that line, or jump
239 over the line. When this option is nil, a new line will be created before
240 this line."
245 "Options concerning tables in Org-mode."
250 "Should org-mode work with table references like B3 instead of @3$2?
251 Possible values are:
252 nil never use them
253 from accept as input, do not present for editing
254 t accept as input and present for editing"
274 calc-angle-mode deg
275 calc-prefer-frac nil
276 calc-symbolic-mode nil
278 calc-display-working-message t
279 )
280 "List with Calc mode settings for use in `calc-eval' for table formulas.
281 The list must contain alternating symbols (Calc modes variables and values).
282 Don't remove any of the default settings, just change the values. Org-mode
283 relies on the variables to be present in the list."
288 "Format for the output of calc computations like $1+$2;t.
289 The default value is `hours', and will output the results as a
290 number of hours. Other allowed values are `seconds', `minutes' and
291 `days', and the output will be a fraction of seconds, minutes or
292 days."
301 "Format for fields which contain the result of a formula.
303 characters. Beware that modifying the display can prevent the
304 field from being used in another formula."
310 "Non-nil means TAB and RET evaluate a formula in current table field.
311 If the current field starts with an equal sign, it is assumed to be a formula
312 which should be evaluated as described in the manual and in the documentation
313 string of the command `org-table-eval-formula'. This feature requires the
314 Emacs calc package.
315 When this variable is nil, formula calculation is only available through
321 "Non-nil means interpret constants in formulas in tables.
322 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
323 by the value given in `org-table-formula-constants', or by a value obtained
324 from the `constants.el' package."
329 "Alist with constant names and values, for use in table formulas.
330 The car of each element is a name of a constant, without the `$' before it.
331 The cdr is the value as a string. For example, if you'd like to use the
332 speed of light in a formula, you would configure
336 and then use it in an equation like `$1*$c'.
338 Constants can also be defined on a per-file basis using a line like
340 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
347 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
350 are pressed in the line."
355 "Non-nil means relative formula references may cross hlines.
356 Here are the allowed values:
358 nil Relative references may not cross hlines. They will reference the
359 field next to the hline instead. Coming from below, the reference
360 will be to the field below the hline. Coming from above, it will be
361 to the field above.
362 t Relative references may cross hlines.
363 error An attempt to cross a hline will throw an error.
365 It is probably good to never set this variable to nil, for the sake of
366 portability of tables."
374 "Non-nil means that evaluation of a field formula can add new
375 columns if an out-of-bounds field is being set."
382 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
386 "Options concerning table import and export in Org-mode."
391 "Default export parameters for `org-table-export'.
392 These can be overridden for a specific table by setting the
393 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
394 radio tables for the different export transformations and
395 available parameters."
400 "Max lines that `org-table-convert-region' will attempt to process.
402 The function can be slow on larger regions; this safety feature
403 prevents it from hanging emacs."
426 "Alist with column names, derived from the `!' line.
430 "Regular expression matching the current column names.
434 "Alist with parameter names, derived from the `$' line.
438 "Alist with locations of named fields.
439 Associations follow the pattern (NAME LINE COLUMN) where
440 NAME is the name of the field as a string,
441 LINE is the number of lines from the beginning of the table,
442 COLUMN is the column of the field, as an integer.
446 "Table row types in current table.
450 "Current table begin position, as a marker.
454 "Number of columns in current table.
458 "Vector of data line line numbers in the current table.
459 Line numbers are counted from the beginning of the table. This
463 "Vector of hline line numbers in the current table.
464 Line numbers are counted from the beginning of the table. This
468 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
469 ;; 1 2 3 4 5
484 "Save current field; execute BODY; restore field.
485 Field is restored even in case of abnormal exit."
496 ;;;###autoload
498 "Use the table.el package to insert a new table.
499 If there is already a table at point, convert between Org-mode tables
500 and table.el tables."
513 ;;;###autoload
515 "Convert region to table, or create an empty table.
516 If there is an active region, convert it to a table, using the function
517 `org-table-convert-region'. See the documentation of that function
518 to learn how the prefix argument is interpreted to determine the field
519 separator.
520 If there is no such region, create an empty table with `org-table-create'."
526 ;;;###autoload
528 "Query for a size and insert a table skeleton.
548 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
552 ;; Insert a hline after the first row.
559 ;;;###autoload
561 "Convert region to a table.
562 The region goes from BEG0 to END0, but these borders will be moved
563 slightly, to make sure a beginning of line in the first line is included.
565 SEPARATOR specifies the field separator in the lines. It can have the
566 following values:
568 (4) Use the comma as a field separator
569 (16) Use a TAB as field separator
570 (64) Prompt for a regular expression as field separator
571 integer When a number, use that many spaces as field separator
572 regexp When a regular expression, use it to match the separator
573 nil When nil, the command tries to be smart and figure out the
574 separator in the following way:
575 - when each line contains a TAB, assume TAB-separated material
576 - when each line contains a comma, assume CSV material
577 - else, assume one or more SPACE characters as separator."
581 re)
583 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
584 org-table-convert-region-max-lines)
593 ;; Get the right field separator
604 ;; parse the csv stuff
629 ;;;###autoload
631 "Import FILE as a table.
632 The file is assumed to be tab-separated. Such files can be produced by most
633 spreadsheet and database applications. If no tabs (at least one per line)
634 are found, lines will be split on whitespace into fields."
643 ;;;###autoload
645 "Export table to a file, with configurable format.
646 Such a file can be imported into usual spreadsheet programs.
648 FILE can be the output file name. If not given, it will be taken
649 from a TABLE_EXPORT_FILE property in the current entry or higher
650 up in the hierarchy, or the user will be prompted for a file
651 name. FORMAT can be an export format, of the same kind as it
652 used when `orgtbl-mode' sends a table in a different format.
654 The command suggests a format depending on TABLE_EXPORT_FORMAT,
655 whether it is set locally or up in the hierarchy, then on the
656 extension of the given file name, and finally on the variable
657 `org-table-export-default-format'."
690 formats)))
691 org-table-export-default-format)
717 "Marker at the beginning of the table last aligned.
720 "Marker at the end of the table last aligned.
723 "List of flags for flushright alignment, from the last re-alignment.
726 "List of max width of fields in each column.
729 "Non-nil means debug table formulas.
739 ;;;###autoload
741 "Align the table at point by aligning all vertical bars."
746 ;; Make sure invisible characters in the table are at the right
747 ;; place since column widths take them into account.
753 ;; Table's rows. Separators are replaced by nil. Trailing
754 ;; spaces are also removed.
760 l)))
762 ;; Get the data fields by splitting the lines.
765 ;; Compute number of fields in the longest line. If the
766 ;; table contains no field, create a default table.
771 ;; A list of empty strings to fill any short rows on output.
773 lengths typenums)
774 ;; Check for special formatting.
777 fmax falign)
778 ;; Look for an explicit width or alignment.
791 ;; Find fields that are wider than FMAX, and shorten them.
796 'help-echo
805 fmax)))
819 f2
821 x))))))
822 ;; Get the maximum width for each column
824 lengths)
825 ;; Get the fraction of numbers among non-empty cells to
826 ;; decide about alignment of the column.
835 1
841 ;; Store alignment of this table, for later editing of single
842 ;; fields.
845 ;; With invisible characters, `format' does not get the field
846 ;; width right So we need to make these fields wide by hand.
847 ;; Invisible characters may be introduced by fontified links,
848 ;; emphasis, macros or sub/superscripts.
866 ;; Compute the formats needed for output of the table.
875 ;; Replace modified lines only. Check not only contents, but
876 ;; also columns' width.
880 hfmt))
902 ;;;###autoload
904 "Find the beginning of the table and return its position.
905 With a non-nil optional argument TABLE-TYPE, return the beginning
906 of a table.el-type table. This function assumes point is on
907 a table."
915 ;;;###autoload
917 "Find the end of the table and return its position.
918 With a non-nil optional argument TABLE-TYPE, return the end of
919 a table.el-type table. This function assumes point is on
920 a table."
928 ;; When the line right after the table is the last line in
929 ;; the buffer with trailing spaces but no final newline
930 ;; character, trailing spaces, be sure to catch the correct
931 ;; ending at its beginning. In any other case, ending is
932 ;; expected to be at point max.
937 ;;;###autoload
939 "Justify the current field, text to left, number to right.
940 Optional argument NEW may specify text to replace the current field content."
949 ;; This is not the same table, force a full re-align
955 l f n o e)
981 ;;;###autoload
983 "Go to the next field in the current table, creating new lines as needed.
984 Before doing so, re-align the table if necessary."
989 org-table-may-need-update)
1000 org-table-tab-jumps-over-hlines
1011 ;;;###autoload
1013 "Go to the previous field in the table.
1014 Before doing so, re-align the table if necessary."
1019 org-table-may-need-update)
1034 "Move to the beginning of the current table field.
1035 If already at or before the beginning, move to the beginning of the
1036 previous field.
1037 With numeric argument N, move N-1 fields backward first."
1050 "Move to the end of the current table field.
1051 If already at or after the end, move to the end of the next table field.
1052 With numeric argument N, move N-1 fields forward first."
1065 ;;;###autoload
1067 "Go to the next row (same column) in the current table.
1068 Before doing so, re-align the table if necessary."
1076 org-table-may-need-update)
1089 ;;;###autoload
1091 "Copy the value of the current field one row below.
1093 If the field at the cursor is empty, copy the content of the
1094 nearest non-empty field above. With argument N, use the Nth
1095 non-empty field.
1097 If the current field is not empty, it is copied down to the next
1098 row, and the cursor is moved with it. Therefore, repeating this
1099 command causes the column to be filled row-by-row.
1101 If the variable `org-table-copy-increment' is non-nil and the
1102 field is an integer or a timestamp, it will be incremented while
1103 copying. By default, increment by the difference between the
1104 value in the current field and the one in the field above. To
1105 increment using a fixed integer, set `org-table-copy-increment'
1106 to a number. In the case of a timestamp, increment by days."
1118 txt txt-up inc)
1126 beg t))
1136 beg t))
1143 ;; Above field was not empty, go down to the next row
1176 "Is point inside a table data field?
1177 I.e. not on a hline or before the first or after the last column?
1178 This actually throws an error, so it aborts the current command."
1190 "Get the field in table line LINE, column COLUMN.
1191 If LINE is larger than the number of data lines in the table, the function
1192 returns nil. However, if COLUMN is too large, we will simply return an
1193 empty string.
1194 If LINE is nil, use the current line.
1195 If COLUMN is nil, use the current column."
1202 "Put VALUE into line LINE, column COLUMN.
1203 When ALIGN is set, also realign the table."
1212 "Return the index of the current data line."
1219 cnt))
1222 "Go to the Nth data line in the current table.
1223 Return t when the line exists, nil if it does not exist."
1230 ;;;###autoload
1232 "Blank the current table field or active region."
1249 "Return the value of the field in column N of current row.
1250 N defaults to current field.
1251 If REPLACE is a string, replace field with this value. The return value
1252 is always the old value."
1261 t t))
1263 val)
1266 ;;;###autoload
1268 "Show info about the current field, and highlight any reference at point."
1278 col)
1279 org-table-named-field-locations)))
1297 dline col
1299 dline col ref1
1301 ;; FIXME: formula info not correct if special table line
1311 "Find out which column we are in."
1320 column)))
1322 ;;;###autoload
1324 "Find out what table data line we are in.
1325 Only data lines count for this."
1338 c)))
1340 ;;;###autoload
1342 "Move the cursor to the Nth column in the current table line.
1343 With optional argument ON-DELIM, stop with point before the left delimiter
1344 of the field.
1345 If there are less than N fields, just go to after the last delimiter.
1346 However, when FORCE is non-nil, create new columns if necessary."
1356 t)))))
1363 ;;;###autoload
1365 "Insert a new column into the table."
1387 "Find a data line in the current table, which is needed for column commands."
1390 t
1401 t
1406 "Turn a buffer line number into a data line number.
1408 If there is no data line in this line, return nil.
1410 If there is no matching dline (most likely the reference was
1411 a hline), the first dline below it is used. When ABOVE is
1412 non-nil, the one above is used."
1417 nil)
1428 ;;;###autoload
1430 "Delete a column from the table."
1442 nil
1457 ;;;###autoload
1459 "Move column to the right."
1462 ;;;###autoload
1464 "Move column to the left."
1468 ;;;###autoload
1470 "Move the current column to the right. With arg LEFT, move to the left."
1504 ;;;###autoload
1506 "Move table row down."
1509 ;;;###autoload
1511 "Move table row up."
1515 ;;;###autoload
1517 "Move the current table line down. With arg UP, move it up."
1526 txt hline2p)
1549 ;;;###autoload
1551 "Insert a new row above the current line into the table.
1552 With prefix ARG, insert below the current line."
1558 ;; Fix the first field if necessary
1571 ;;;###autoload
1573 "Insert a horizontal-line below the current line into the table.
1574 With prefix ABOVE, insert above the current line."
1595 ;;;###autoload
1597 "Insert a hline and move to the row below that line."
1611 In particular, this does handle wide and invisible characters."
1613 ;; It's a hline, just map the characters
1619 t t s)))
1620 s))
1622 ;;;###autoload
1624 "Delete the current row or horizontal line from the table."
1638 ;;;###autoload
1640 "Sort table lines according to the column at point.
1642 The position of point indicates the column to be used for
1643 sorting, and the range of lines is the range between the nearest
1644 horizontal separator lines, or the entire table of no such lines
1645 exist. If point is before the first column, you will be prompted
1646 for the sorting column. If there is an active region, the mark
1647 specifies the first line and the sorting column, while point
1648 should be in the last line to be included into the sorting.
1650 The command then prompts for the sorting type which can be
1651 alphabetically, numerically, or by time (as given in a time stamp
1652 in the field, or as a HH:MM value). Sorting in reverse order is
1653 also possible.
1655 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1657 If SORTING-TYPE is specified when this function is called from a Lisp
1658 program, no prompting will take place. SORTING-TYPE must be a character,
1659 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1660 sorting should be done in reverse order.
1662 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1663 a function to be called to extract the key. It must return either
1664 a string or a number that should serve as the sorting key for that
1665 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1666 is specified interactively, the comparison will be either a string or
1667 numeric compare based on the type of the first key in the table."
1670 ;; Point must be either within a field or before a data line.
1675 ;; Set appropriate case sensitivity and column used for sorting.
1686 ;; Narrow buffer to appropriate sorting area.
1699 start))
1702 end))))
1703 ;; Determine arguments for `sort-subr'. Also record original
1704 ;; position. `org-table-save-field' cannot help here since
1705 ;; sorting is too much destructive.
1711 ;; Function to be called on the contents of the field
1712 ;; used for sorting in the current row.
1744 #'end-of-line
1748 nil
1749 predicate)
1750 ;; Move back to initial field.
1754 ;;;###autoload
1756 "Copy region in table to the clipboard and blank all relevant fields.
1757 If there is no active region, use just the field at point."
1763 ;;;###autoload
1765 "Copy rectangular region in table to clipboard.
1766 A special clipboard is used which can only be accessed
1767 with `org-table-paste-rectangle'."
1771 current-prefix-arg))
1776 region)
1788 ;; Collect every cell between COLUMN-START and COLUMN-END.
1798 ;;;###autoload
1800 "Paste a rectangular region into a table.
1801 The upper right corner ends up in the current field. All involved fields
1802 will be overwritten. If the rectangle does not fit into the present table,
1803 the table is enlarged as needed. The process ignores horizontal separator
1804 lines."
1815 ;; If we left the table, create a new row.
1827 ;;;###autoload
1829 "Convert from `org-mode' table to table.el and back.
1830 Obviously, this only works within limits. When an Org-mode table is
1831 converted to table.el, all horizontal separator lines get lost, because
1832 table.el uses these as cell boundaries and has no notion of horizontal lines.
1833 A table.el table can be converted to an Org-mode table only if it does not
1834 do row or column spanning. Multiline cells will become multiple cells.
1835 Beware, Org-mode does not test if the table can be successfully converted - it
1836 blindly applies a recipe that works for simple tables."
1840 ;; convert to Org-mode table
1849 ;; convert to table.el table
1852 ;; first, get rid of all horizontal lines
1856 ;; insert a hline before first
1860 ;; insert a hline after each line
1865 ;; replace "+" at beginning and ending of hlines
1874 "Transpose Org table at point and eliminate hlines.
1875 So a table like
1877 | 1 | 2 | 4 | 5 |
1878 |---+---+---+---|
1879 | a | b | c | d |
1880 | e | f | g | h |
1882 will be transposed as
1884 | 1 | a | e |
1885 | 2 | b | f |
1886 | 4 | c | g |
1887 | 5 | d | h |
1889 Note that horizontal lines disappear."
1901 table)))
1915 ;;;###autoload
1917 "Wrap several fields in a column like a paragraph.
1918 This is useful if you'd like to spread the contents of a field over several
1919 lines, in order to keep the table compact.
1921 If there is an active region, and both point and mark are in the same column,
1922 the text in the column is wrapped to minimum width for the given number of
1923 lines. Generally, this makes the table more compact. A prefix ARG may be
1924 used to change the number of desired lines. For example, \
1926 formats the selected text to two lines. If the region was longer than two
1927 lines, the remaining lines remain empty. A negative prefix argument reduces
1928 the current number of lines by that amount. The wrapped text is pasted back
1929 into the table. If you formatted it to more lines than it was before, fields
1930 further down in the table get overwritten - so you might need to make space in
1931 the table first.
1933 If there is no region, the current field is split at the cursor position and
1934 the text fragment to the right of the cursor is prepended to the field one
1935 line down.
1937 If there is no region, but you specify a prefix ARG, the current field gets
1938 blank, and the content is appended to the field above."
1942 ;; There is a region: fill as a paragraph.
1953 nil
1954 nlines))))
1957 ;; No region, split the current field at point.
1982 ;;;###autoload
1984 "Edit table field in a different window.
1985 This is mainly useful for fields that contain hidden parts.
1987 it can be edited in place."
1996 display t intangible t))
2009 p)
2025 intangible t))
2033 "Finish editing a table data field.
2034 Remove all newline characters, insert the result into the table, realign
2035 the table and kill the editing buffer."
2039 text)
2056 "Minor mode to make the table field editor window follow the cursor.
2057 When this mode is active, the field editor window will always show the
2058 current field. The mode exits automatically when the cursor leaves the
2059 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2060 nil " TblFollow" nil
2076 ;; We have left the table, exit the follow mode
2086 ;;;###autoload
2088 "Sum numbers in region of current table column.
2089 The result will be displayed in the echo area, and will be available
2092 If there is an active region, it is interpreted as a rectangle and all
2093 numbers in that rectangle will be summed. If there is no active
2094 region and point is located in a table column, sum all numbers in that
2095 column.
2097 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2098 numbers are assumed to be times as well (in decimal hours) and the
2099 numbers are added as such.
2101 If NLAST is a number, only the NLAST fields will actually be summed."
2128 items1)))
2135 s diff)
2143 sres))))
2166 "Return the formula active for the current field.
2168 Assumes that table is already analyzed. If KEY is given, return
2169 the key to this formula. Otherwise return the formula preceded
2174 col)
2175 org-table-named-field-locations)))
2187 "Read a formula from the minibuffer, offer stored formula as default.
2188 When NAMED is non-nil, look for a named equation."
2193 org-table-named-field-locations)))
2198 name
2199 ref)
2206 stored)
2208 equation)
2215 scol))
2217 'org-table-formula-history
2218 )))))
2219 mustsave)
2221 ;; remove formula
2228 ;; We set the column equation, delete the named one.
2230 mustsave t))
2236 eq))
2239 "Store the list of formulas below the current table."
2246 ;; don't overwrite TBLFM, we might use text properties to store stuff
2262 ;; Fake a high number to make sure this is sorted at the end.
2269 a)
2279 "Compare two formulas for sorting."
2284 ;;;###autoload
2286 "Return an alist with the stored formulas directly after current table."
2295 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2314 "Modify the equations after the table structure has been edited.
2316 For all numbers larger than LIMIT, shift them by DELTA."
2328 s n a)
2334 "Change makes TBLFM term %s invalid, use undo to recover"
2349 ;;;###autoload
2352 If yes, store the formula and apply it."
2353 ;; We already know we are in a table. Get field will only return a formula
2354 ;; when appropriate. It might return a separator line, but no problem.
2357 named eq)
2368 "List of commands triggering the recalculation of a line.
2380 ;;;###autoload
2382 "Rotate the recalculation mark in the first column.
2383 If in any row, the first field is not consistent with a mark,
2384 insert a new column for the markers.
2385 When there is an active region, change all the lines in the region,
2386 after prompting for the marking character.
2387 After each change, a message will be displayed indicating the meaning
2388 of the new mark."
2404 newchar))
2412 newchar))
2430 ;; Rotate mark in first row.
2432 ;; Rotate marks in additional rows if a region is active.
2440 ;; Only align if rotation actually changed lines' length.
2450 ;;;###autoload
2452 "Analyze table at point and store results.
2454 This function sets up the following dynamically scoped variables:
2456 `org-table-column-name-regexp',
2457 `org-table-column-names',
2458 `org-table-current-begin-pos',
2459 `org-table-current-line-types',
2460 `org-table-current-ncol',
2461 `org-table-dlines',
2462 `org-table-hlines',
2463 `org-table-local-parameters',
2464 `org-table-named-field-locations'."
2469 ;; Extract column names.
2482 ;; Extract local parameters.
2490 org-table-local-parameters)))))
2491 ;; Update named fields locations. We minimize `count-lines'
2492 ;; processing by storing last known number of lines in LAST.
2514 field))
2517 org-table-named-field-locations))))))))))
2518 ;; Re-use existing markers when possible.
2522 ;; Analyze the line types.
2540 al al2)
2552 "Move point to a specific field in the current table.
2554 REF is either the name of a field its absolute reference, as
2555 a string. No column is created unless CREATE-COLUMN-P is
2556 non-nil. If it is a function, it is called with the column
2557 number as its argument as is used as a predicate to know if the
2558 column can be created.
2560 This function assumes the table is already analyzed (i.e., using
2561 `org-table-analyze')."
2576 create-column-p)))
2582 ;;;###autoload
2584 "Recompute the current line if marked for it, and if we haven't just done it."
2604 org-tbl-calc-modes)
2606 ;;;###autoload
2608 suppress-align suppress-const
2609 suppress-store suppress-analysis)
2610 "Replace the table field value at the cursor by the result of a calculation.
2612 This function makes use of Dave Gillespie's Calc package, in my view the
2613 most exciting program ever written for GNU Emacs. So you need to have Calc
2614 installed in order to use this function.
2616 In a table, this command replaces the value in the current field with the
2618 formula, by storing it in a special line below the table. When called
2619 with a `C-u' prefix, the current field must be a named field, and the
2620 formula is installed as valid in only this specific field.
2622 When called with two `C-u' prefixes, insert the active equation
2623 for the field back into the current field, so that it can be
2625 to check the referenced fields.
2627 When called, the command first prompts for a formula, which is read in
2628 the minibuffer. Previously entered formulas are available through the
2629 history list, and the last used formula is offered as a default.
2630 These stored formulas are adapted correctly when moving, inserting, or
2631 deleting columns with the corresponding commands.
2633 The formula can be any algebraic expression understood by the Calc package.
2634 For details, see the Org-mode manual.
2636 This function can also be called from Lisp programs and offers
2637 additional arguments: EQUATION can be the formula to apply. If this
2638 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2639 used to speed-up recursive calls by by-passing unnecessary aligns.
2640 SUPPRESS-CONST suppresses the interpretation of constants in the
2641 formula, assuming that this has been done already outside the function.
2642 SUPPRESS-STORE means the formula should not be stored, either because
2643 it is already stored, or because it is a modified equation that should
2644 not overwrite the stored one."
2660 equation
2666 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2667 duration duration-output-format)
2668 ;; Parse the format string. Since we have a lot of modes, this is
2669 ;; a lot of work. However, I think calc still uses most of the time.
2682 'calc-float-format
2685 n))))
2689 duration-output-format nil
2693 duration-output-format org-table-duration-custom-format
2694 numbers t
2717 ;; replace fields with duration values if relevant
2721 fields)))
2727 x))
2728 fields)))
2734 ;; Insert row and column number of formula result field
2745 t t form)))
2747 ;; Check for old vertical references
2749 ;; Insert remote references
2762 rmtrng))
2763 keep-empty numbers lispp))
2764 t t form)))
2765 ;; Insert complex ranges
2775 ;; possibly handle durations
2780 formrg)
2781 keep-empty numbers lispp)))
2786 ;; Insert simple ranges, i.e. included in the current row.
2789 form)
2800 keep-empty numbers lispp))
2801 t t form)))
2803 ;; Insert the references to fields in same row
2810 x keep-empty numbers lispp)))
2828 ;; Use <...> time-stamps so that Calc can handle them
2831 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2842 form
2849 duration-output-format)
2850 ev)))
2855 Orig: %s
2856 $xyz-> %s
2857 @r$c-> %s
2889 prop value)))
2892 "Get a calc vector from a column, according to descriptor DESC.
2894 Optional arguments TBEG and COL can give the beginning of the table and
2895 the current column, to avoid unnecessary parsing.
2897 HIGHLIGHT means just highlight the range.
2899 When CORNERS-ONLY is set, only return the corners of the range as
2900 a list (line1 column1 line2 column2) where line1 and line2 are
2901 line numbers relative to beginning of table, or TBEG, and column1
2902 and column2 are table column numbers."
2914 thisline)))
2919 thisline)))
2931 ;; Just one field.
2938 ;; A range, return a vector. First sort the numbers to get
2939 ;; a regular rectangle.
2945 ;; Copy the range values into a list.
2960 ;; Return string representation of calc vector.
2966 "Return relative line number corresponding to descriptor DESC.
2967 The cursor is currently in relative line number CLINE."
2972 ;; 1 2 3 4 5 6
2973 desc))
2995 cline)))
2998 "Return relative line of Nth row with type TYPE.
2999 Search starts from relative line I. When BACKWARDS in non-nil,
3000 look before I. When RELATIVE is non-nil, the reference is
3001 relative. DESC is the original descriptor that started the
3002 search, as a string."
3010 ;; We are going to cross a hline. Check if this is
3011 ;; an authorized move.
3022 ;; The last hline doesn't exist. Instead, point to last row
3023 ;; in table.
3032 "Convert list ELEMENTS to something appropriate to insert into formula.
3033 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3034 NUMBERS indicates that everything should be converted to numbers.
3035 LISPP non-nil means to return something appropriate for a Lisp
3036 list, `literal' is for the format specifier L."
3037 ;; Calc nan (not a number) is used for the conversion of the empty
3038 ;; field to a reference for several reasons: (i) It is accepted in a
3039 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3040 ;; (ii) In a single field (not in range) it can be distinguished
3041 ;; from "(nan)" which is the reference made from a single field
3042 ;; containing "nan".
3044 ;; field reference
3047 elements
3049 ""
3058 ;; range reference
3063 elements))))
3069 x
3077 x)
3079 elements
3083 "If there has been more than one second since T1, display message.
3084 ARGS are passed as arguments to the `message' function. Returns
3085 current time if a message is printed, otherwise returns T1. If
3086 T1 is nil, always messages."
3090 curtime)
3091 t1)))
3093 ;;;###autoload
3095 "Recalculate the current table line by applying all stored formulas.
3096 With prefix arg ALL, do this for all lines in the table.
3097 With the prefix argument ALL is `(16)' \
3099 it is the symbol `iterate', recompute the table until it no longer changes.
3100 If NOALIGN is not nil, do not re-align the table after the computations
3101 are done. This is typically used internally to save time, if it is
3102 known that the table will be realigned a little later anyway."
3118 beg end eqlnum eqlname)
3119 ;; Insert constants in all formulas
3137 existing formula for column %s"
3138 old-lhs
3143 eqlist))
3144 ;; Split the equation list.
3150 ;; Expand ranges in lhs of formulas
3152 ;; Get the correct line range to process
3159 ;; This is a table with marked lines, compute selected
3160 ;; lines.
3162 ;; Move forward to the first non-header line.
3167 ;; Just leave BEG where it is.
3172 ;; Mark named fields untouchable. Also check if several
3173 ;; field/range formulas try to set the same field.
3177 seen-fields)
3188 ;; Turn field coordinates associated to NAME
3189 ;; into an absolute reference.
3193 name)))
3196 reference))
3201 ;; Evaluate the column formulas, but skip fields covered by
3202 ;; field formulas.
3206 ;; Unprotected line, recalculate.
3211 log-last-time
3223 ;; Evaluate the field formulas.
3232 reference
3233 ;; Possibly create a new column, as long as
3234 ;; `org-table-formula-create-columns' allows it.
3246 t))
3251 ;; Clean up markers and internal text property.
3262 ;;;###autoload
3264 "Recalculate the table until it does not change anymore.
3265 The maximum number of iterations is 10, but you can choose a different value
3266 with the prefix ARG."
3271 thistbl)
3285 ;;;###autoload
3287 "Recalculate all tables in the current buffer."
3294 ;;;###autoload
3296 "Iterate all tables in the buffer, to converge inter-table dependencies."
3301 c1)
3317 "Apply the #+TBLFM in the line at point to the table."
3324 ;; Insert a temporary formula at right after the table
3329 ;; Recalculate the table.
3334 ;; Delete the formula inserted temporarily.
3340 "Find the beginning of the TBLFM lines and return its position.
3341 Return nil when the beginning of TBLFM line was not found."
3348 "Expand list of formulas.
3349 If some of the RHS in the formulas are ranges or a row reference, expand
3350 them to individual field equations for each field."
3357 ;; This just refers to one fixed field.
3360 ;; This just refers to one fixed named field.
3365 rhs)
3366 res)))
3378 rhs)
3379 res))))))))))
3382 "Replace @<, @>, $<, $> with first/last row/column of the table.
3383 So @< and $< will always be replaced with @1 and $1, respectively.
3384 The advantage of these special markers are that structure editing of
3385 the table will not change them, while @1 and $1 will be modified
3386 when a line/row is swapped out of that privileged position. So for
3387 formulas that use a range of rows or columns, it may often be better
3389 borders of the table using the @< @> $< $> makers."
3392 s start)
3397 org-table-current-ncol)
3401 len
3408 s)
3411 "Replace $const with values in string F."
3416 org-table-column-name-regexp
3419 org-table-column-names))))
3420 f t t)))
3421 ;; Parameters and constants.
3425 new start))
3428 ;; When a duration is expected, convert value on the fly.
3434 v)))))
3441 "Find the value for a parameter or constant in a formula.
3442 Parameters get priority."
3473 map))
3480 "--"
3483 "--"
3484 "Shift Reference at Point"
3489 "-"
3490 "Change Test Row for Column Formulas"
3493 "--"
3498 org-table-overlay-coordinates)]
3499 "--"
3505 ;;;###autoload
3507 "Edit the formulas of the current table in a separate buffer."
3526 ;; Keep global-font-lock-mode from turning on font-lock-mode
3569 "Convert a formula from internal to user representation."
3572 s))
3575 "Convert a formula from user to internal representation."
3578 s))
3581 "Convert spreadsheet references from A7 to @7$28.
3582 Works for single references, but also for entire formulas and even the
3583 full TBLFM line."
3585 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3588 ;; format match, just advance
3593 ;; 3.e5 or something like this.
3596 ;; (member (match-string 1 s)
3597 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3598 )
3599 ;; function name, just advance
3609 t t s)))))
3610 s))
3613 "Convert spreadsheet references from to @7$28 to AB7.
3614 Works for single references, but also for entire formulas and even the
3615 full TBLFM line."
3622 t t s)))
3627 t nil s)))
3628 s)
3631 "Convert a base 26 number represented by letters into an integer.
3632 For example: AB -> 28."
3638 n))
3641 "Convert an integer into a base 26 number represented by letters.
3642 For example: 28 -> AB."
3647 s))
3650 "Convert a time string into numerical duration in seconds.
3651 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3652 If S is a string representing a number, keep this number."
3654 s
3677 "Convert a number of seconds to a time string.
3678 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3679 minutes or seconds."
3694 "Convert all references in this buffer, using FUNCTION."
3705 "Convert all references in the buffer from B3 to @3$2 and back."
3715 "Shift the reference at point one row/hline up."
3719 "Shift the reference at point one row/hline down."
3723 "Shift the reference at point one field to the left."
3727 "Shift the reference at point one field to the right."
3738 ;; A B3-like reference
3744 ;; An internal reference
3750 "Re-match the group N, and replace it with the shifted reference."
3755 t t)))
3758 "Shift a reference part REF.
3759 If DECR is set, decrease the references row/column, else increase.
3760 If HLINE is set, this may be a hline reference, it certainly is not
3761 a translation reference."
3790 "Toggle the display of coordinates in the referenced table."
3799 "Parse the buffer for formula definitions and install them.
3800 With prefix ARG, apply the new formulas to the table."
3810 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3811 nil t)
3835 "Abort editing formulas, without installing the changes."
3846 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3887 "Show the location/value of the $ expression at point."
3898 var name e what match dest)
3902 "$1.."
3952 dest)
3978 ;; Column number.
4004 org-table-fedit-scroll-down))))
4016 "Make sure the cursor is in a dataline in a table."
4025 p1 p2)))
4030 "Move cursor one line up in the window showing the table."
4035 "Move cursor one line down in the window showing the table."
4040 "Move the cursor in the window showing the table.
4041 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4066 "Add a new overlay."
4072 "Highlight rectangular region in a table.
4073 When buffer positions BEG and END are provided, use them to
4074 delimit the region to highlight. Otherwise, refer to point. Use
4075 FACE, when non-nil, for the highlight."
4107 "Remove the rectangle overlays."
4117 "Add overlays to the table at point, to show row/column coordinates."
4145 ;;;###autoload
4147 "Toggle the display of Row/Column numbers in tables."
4158 ;;;###autoload
4160 "Toggle the formula debugger in tables."
4166 ;;; The orgtbl minor mode
4168 ;; Define a minor mode which can be used in other modes in order to
4169 ;; integrate the org-mode table editor.
4171 ;; This is really a hack, because the org-mode table editor uses several
4172 ;; keys which normally belong to the major mode, for example the TAB and
4173 ;; RET keys. Here is how it works: The minor mode defines all the keys
4174 ;; necessary to operate the table editor, but wraps the commands into a
4175 ;; function which tests if the cursor is currently inside a table. If that
4176 ;; is the case, the table editor command is executed. However, when any of
4177 ;; those keys is used outside a table, the function uses `key-binding' to
4178 ;; look up if the key has an associated command in another currently active
4179 ;; keymap (minor modes, major mode, global), and executes that command.
4180 ;; There might be problems if any of the keys used by the table editor is
4181 ;; otherwise used as a prefix key.
4183 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4184 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4185 ;; addresses this by checking explicitly for both bindings.
4187 ;; The optimized version (see variable `orgtbl-optimized') takes over
4188 ;; all keys which are bound to `self-insert-command' in the *global map*.
4189 ;; Some modes bind other commands to simple characters, for example
4190 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4191 ;; active, this binding is ignored inside tables and replaced with a
4192 ;; modified self-insert.
4210 ;; Install it as a minor mode.
4214 ;;;###autoload
4216 "The `org-mode' table editor as a minor mode for use in other modes."
4221 ;; Exit without error, in case some hook functions calls this
4222 ;; by accident in org-mode.
4226 ;; Make sure we are first in minor-mode-map-alist
4228 ;; FIXME: maybe it should use emulation-mode-map-alists?
4235 auto-fill-inhibit-regexp)
4239 auto-fill-inhibit-regexp)
4240 orgtbl-line-start-regexp))
4258 "Remove all properties related to narrow-column invisibility."
4271 "Create a function for binding in the table minor mode.
4272 FUN is the command to call inside a table. N is used to create a unique
4273 command name. KEYS are keys that should be checked in for a command
4274 to execute outside of tables."
4280 "Outside of tables, run the binding of `"
4292 keys)
4296 "Error when there is no default binding for a table key."
4301 "Setup orgtbl keymaps."
4332 elt key fun cmd)
4340 ;; Special treatment needed for TAB and RET
4360 [(tab)] "\C-i")))
4362 (org-defkey orgtbl-mode-map [backtab]
4364 [backtab] [S-iso-lefttab] [(shift tab)]
4365 [(tab)] "\C-i"))
4367 (org-defkey orgtbl-mode-map "\M-\C-m"
4368 (orgtbl-make-binding 'org-table-wrap-region 105
4369 "\M-\C-m" [(meta return)]))
4370 (org-defkey orgtbl-mode-map [(meta return)]
4371 (orgtbl-make-binding 'org-table-wrap-region 106
4372 [(meta return)] "\M-\C-m"))
4374 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4375 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4377 (when orgtbl-optimized
4378 ;; If the user wants maximum table support, we need to hijack
4379 ;; some standard editing functions
4380 (org-remap orgtbl-mode-map
4381 'self-insert-command 'orgtbl-self-insert-command
4382 'delete-char 'org-delete-char
4383 'delete-backward-char 'org-delete-backward-char)
4384 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4385 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4386 '("OrgTbl"
4387 ["Create or convert" org-table-create-or-convert-from-region
4388 :active (not (org-at-table-p)) :keys "C-c |" ]
4389 "--"
4390 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4391 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4392 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4393 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4394 "--"
4395 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4396 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4397 ["Copy Field from Above"
4398 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4399 "--"
4400 ("Column"
4401 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4402 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4403 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4404 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4405 ("Row"
4406 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4407 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4408 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4409 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4410 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4411 "--"
4412 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4413 ("Rectangle"
4414 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4415 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4416 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4417 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4418 "--"
4419 ("Radio tables"
4420 ["Insert table template" orgtbl-insert-radio-table
4421 (assq major-mode orgtbl-radio-table-templates)]
4422 ["Comment/uncomment table" orgtbl-toggle-comment t])
4423 "--"
4424 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4425 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4426 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4427 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4428 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4429 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4430 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4431 ["Sum Column/Rectangle" org-table-sum
4432 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4433 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4434 ["Debug Formulas"
4435 org-table-toggle-formula-debugger :active (org-at-table-p)
4436 :keys "C-c {"
4437 :style toggle :selected org-table-formula-debug]
4438 ["Show Col/Row Numbers"
4439 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4440 :keys "C-c }"
4441 :style toggle :selected org-table-overlay-coordinates]
4442 "--"
4443 ("Plot"
4446 t))
4448 (defun orgtbl-ctrl-c-ctrl-c (arg)
4449 "If the cursor is inside a table, realign the table.
4450 If it is a table to be sent away to a receiver, do it.
4451 With prefix arg, also recompute table."
4452 (interactive "P")
4453 (let ((case-fold-search t) (pos (point)) action)
4454 (save-excursion
4455 (beginning-of-line 1)
4456 (setq action (cond
4460 (cond
4461 ((integerp action)
4462 (goto-char action)
4463 (org-table-maybe-eval-formula)
4464 (if arg
4465 (call-interactively 'org-table-recalculate)
4466 (org-table-maybe-recalculate-line))
4467 (call-interactively 'org-table-align)
4468 (when (orgtbl-send-table 'maybe)
4469 (run-hooks 'orgtbl-after-send-table-hook)))
4470 ((eq action 'recalc)
4471 (save-excursion
4472 (beginning-of-line 1)
4474 (if (org-at-table-p)
4475 (org-call-with-arg 'org-table-recalculate t))))
4476 (t (let (orgtbl-mode)
4477 (call-interactively (key-binding "\C-c\C-c")))))))
4479 (defun orgtbl-create-or-convert-from-region (_arg)
4480 "Create table or convert region to table, if no conflicting binding.
4481 This installs the table binding `C-c |', but only if there is no
4482 conflicting binding to this key outside orgtbl-mode."
4483 (interactive "P")
4484 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4485 (if cmd
4486 (call-interactively cmd)
4487 (call-interactively 'org-table-create-or-convert-from-region))))
4489 (defun orgtbl-tab (arg)
4490 "Justification and field motion for `orgtbl-mode'."
4491 (interactive "P")
4492 (if arg (org-table-edit-field t)
4493 (org-table-justify-field-maybe)
4494 (org-table-next-field)))
4496 (defun orgtbl-ret ()
4497 "Justification and field motion for `orgtbl-mode'."
4498 (interactive)
4499 (if (bobp)
4500 (newline)
4501 (org-table-justify-field-maybe)
4502 (org-table-next-row)))
4504 (defun orgtbl-self-insert-command (N)
4505 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4506 If the cursor is in a table looking at whitespace, the whitespace is
4507 overwritten, and the table is not marked as requiring realignment."
4508 (interactive "p")
4509 (if (and (org-at-table-p)
4510 (or
4511 (and org-table-auto-blank-field
4512 (member last-command
4513 '(orgtbl-hijacker-command-100
4514 orgtbl-hijacker-command-101
4515 orgtbl-hijacker-command-102
4516 orgtbl-hijacker-command-103
4517 orgtbl-hijacker-command-104
4518 orgtbl-hijacker-command-105
4519 yas/expand))
4520 (org-table-blank-field))
4521 t)
4522 (eq N 1)
4524 (let (org-table-may-need-update)
4525 (goto-char (1- (match-end 0)))
4526 (org-delete-backward-char 1)
4527 (goto-char (match-beginning 0))
4528 (self-insert-command N))
4529 (setq org-table-may-need-update t)
4530 (let* (orgtbl-mode
4531 a
4532 (cmd (or (key-binding
4533 (or (and (listp function-key-map)
4534 (setq a (assoc last-input-event function-key-map))
4535 (cdr a))
4536 (vector last-input-event)))
4537 'self-insert-command)))
4538 (call-interactively cmd)
4539 (if (and org-self-insert-cluster-for-undo
4540 (eq cmd 'self-insert-command))
4541 (if (not (eq last-command 'orgtbl-self-insert-command))
4542 (setq org-self-insert-command-undo-counter 1)
4543 (if (>= org-self-insert-command-undo-counter 20)
4544 (setq org-self-insert-command-undo-counter 1)
4545 (and (> org-self-insert-command-undo-counter 0)
4546 buffer-undo-list
4547 (not (cadr buffer-undo-list)) ; remove nil entry
4548 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4549 (setq org-self-insert-command-undo-counter
4550 (1+ org-self-insert-command-undo-counter))))))))
4552 ;;;###autoload
4554 "Regular expression matching exponentials as produced by calc.")
4556 (defun orgtbl-gather-send-defs ()
4557 "Gather a plist of :name, :transform, :params for each destination before
4558 a radio table."
4559 (save-excursion
4560 (goto-char (org-table-begin))
4561 (let (rtn)
4562 (beginning-of-line 0)
4563 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4564 (let ((name (org-no-properties (match-string 1)))
4565 (transform (intern (match-string 2)))
4566 (params (if (match-end 3)
4567 (read (concat "(" (match-string 3) ")")))))
4568 (push (list :name name :transform transform :params params)
4569 rtn)
4570 (beginning-of-line 0)))
4571 rtn)))
4573 (defun orgtbl-send-replace-tbl (name txt)
4574 "Find and replace table NAME with TXT."
4575 (save-excursion
4576 (goto-char (point-min))
4577 (unless (re-search-forward
4579 (user-error "Don't know where to insert translated table"))
4580 (let ((beg (line-beginning-position 2)))
4581 (unless (re-search-forward
4582 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4583 (user-error "Cannot find end of insertion region"))
4584 (beginning-of-line)
4585 (delete-region beg (point)))
4588 ;;;###autoload
4589 (defun org-table-to-lisp (&optional txt)
4590 "Convert the table at point to a Lisp structure.
4591 The structure will be a list. Each item is either the symbol `hline'
4592 for a horizontal separator line, or a list of field values as strings.
4593 The table is taken from the parameter TXT, or from the buffer at point."
4594 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4595 (let ((txt (or txt
4596 (buffer-substring-no-properties (org-table-begin)
4597 (org-table-end)))))
4598 (mapcar (lambda (x)
4599 (if (string-match org-table-hline-regexp x) 'hline
4603 (defun orgtbl-send-table (&optional maybe)
4604 "Send a transformed version of table at point to the receiver position.
4605 With argument MAYBE, fail quietly if no transformation is defined
4606 for this table."
4607 (interactive)
4608 (catch 'exit
4609 (unless (org-at-table-p) (user-error "Not at a table"))
4610 ;; when non-interactive, we assume align has just happened.
4611 (when (org-called-interactively-p 'any) (org-table-align))
4612 (let ((dests (orgtbl-gather-send-defs))
4613 (table (org-table-to-lisp
4614 (buffer-substring-no-properties (org-table-begin)
4615 (org-table-end))))
4616 (ntbl 0))
4617 (unless dests
4618 (if maybe (throw 'exit nil)
4619 (user-error "Don't know how to transform this table")))
4620 (dolist (dest dests)
4621 (let ((name (plist-get dest :name))
4622 (transform (plist-get dest :transform))
4623 (params (plist-get dest :params)))
4624 (unless (fboundp transform)
4625 (user-error "No such transformation function %s" transform))
4626 (orgtbl-send-replace-tbl name (funcall transform table params)))
4627 (incf ntbl))
4628 (message "Table converted and installed at %d receiver location%s"
4629 ntbl (if (> ntbl 1) "s" ""))
4630 (and (> ntbl 0) ntbl))))
4632 (defun org-remove-by-index (list indices &optional i0)
4633 "Remove the elements in LIST with indices in INDICES.
4634 First element has index 0, or I0 if given."
4635 (if (not indices)
4636 list
4637 (if (integerp indices) (setq indices (list indices)))
4638 (setq i0 (1- (or i0 0)))
4639 (delq :rm (mapcar (lambda (x)
4640 (setq i0 (1+ i0))
4641 (if (memq i0 indices) :rm x))
4642 list))))
4644 (defun orgtbl-toggle-comment ()
4645 "Comment or uncomment the orgtbl at point."
4646 (interactive)
4647 (let* ((case-fold-search t)
4648 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4649 (re2 (concat "^" orgtbl-line-start-regexp))
4650 (commented (save-excursion (beginning-of-line 1)
4651 (cond ((looking-at re1) t)
4652 ((looking-at re2) nil)
4653 (t (user-error "Not at an org table")))))
4654 (re (if commented re1 re2))
4655 beg end)
4656 (save-excursion
4657 (beginning-of-line 1)
4658 (while (looking-at re) (beginning-of-line 0))
4659 (beginning-of-line 2)
4660 (setq beg (point))
4661 (while (looking-at re) (beginning-of-line 2))
4662 (setq end (point)))
4663 (comment-region beg end (if commented '(4) nil))))
4665 (defun orgtbl-insert-radio-table ()
4666 "Insert a radio table template appropriate for this major mode."
4667 (interactive)
4668 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4669 (txt (nth 1 e))
4670 name pos)
4671 (unless e (user-error "No radio table setup defined for %s" major-mode))
4672 (setq name (read-string "Table name: "))
4673 (while (string-match "%n" txt)
4674 (setq txt (replace-match name t t txt)))
4676 (setq pos (point))
4677 (insert txt)
4678 (goto-char pos)))
4680 ;;;###autoload
4681 (defun orgtbl-to-generic (table params)
4682 "Convert the orgtbl-mode TABLE to some other format.
4684 This generic routine can be used for many standard cases.
4686 TABLE is a list, each entry either the symbol `hline' for
4687 a horizontal separator line, or a list of fields for that
4688 line. PARAMS is a property list of parameters that can
4689 influence the conversion.
4691 Valid parameters are:
4693 :backend, :raw
4695 Export back-end used as a basis to transcode elements of the
4696 table, when no specific parameter applies to it. It is also
4697 used to translate cells contents. You can prevent this by
4698 setting :raw property to a non-nil value.
4700 :splice
4702 When non-nil, only convert rows, not the table itself. This is
4703 equivalent to setting to the empty string both :tstart
4704 and :tend, which see.
4706 :skip
4708 When set to an integer N, skip the first N lines of the table.
4709 Horizontal separation lines do count for this parameter!
4711 :skipcols
4713 List of columns that should be skipped. If the table has
4714 a column with calculation marks, that column is automatically
4715 discarded beforehand.
4717 :hline
4719 String to be inserted on horizontal separation lines. May be
4720 nil to ignore these lines altogether.
4722 :sep
4724 Separator between two fields, as a string.
4726 Each in the following group may be either a string or a function
4727 of no arguments returning a string:
4729 :tstart, :tend
4731 Strings to start and end the table. Ignored when :splice is t.
4733 :lstart, :lend
4735 Strings to start and end a new table line.
4737 :llstart, :llend
4739 Strings to start and end the last table line. Default,
4740 respectively, to :lstart and :lend.
4742 Each in the following group may be a string or a function of one
4743 argument (either the cells in the current row, as a list of
4744 strings, or the current cell) returning a string:
4746 :lfmt
4748 Format string for an entire row, with enough %s to capture all
4749 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4751 :llfmt
4753 Format for the entire last line, defaults to :lfmt.
4755 :fmt
4757 A format to be used to wrap the field, should contain %s for
4758 the original field value. For example, to wrap everything in
4760 a property list with column numbers and format strings, or
4761 functions, e.g.,
4765 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4767 Same as above, specific for the header lines in the table.
4768 All lines before the first hline are treated as header. If
4769 any of these is not present, the data line value is used.
4771 This may be either a string or a function of two arguments:
4773 :efmt
4775 Use this format to print numbers with exponential. The format
4776 should have %s twice for inserting mantissa and exponent, for
4778 list with column numbers and format strings or functions.
4779 :fmt will still be applied after :efmt."
4780 ;; Make sure `org-export-create-backend' is available.
4781 (require 'ox)
4782 (let* ((backend (plist-get params :backend))
4783 (custom-backend
4784 ;; Build a custom back-end according to PARAMS. Before
4785 ;; defining a translator, check if there is anything to do.
4786 ;; When there isn't, let BACKEND handle the element.
4787 (org-export-create-backend
4788 :parent (or backend 'org)
4789 :transcoders
4790 `((table . ,(org-table--to-generic-table params))
4791 (table-row . ,(org-table--to-generic-row params))
4792 (table-cell . ,(org-table--to-generic-cell params))
4793 ;; Macros are not going to be expanded. However, no
4794 ;; regular back-end has a transcoder for them. We
4795 ;; provide one so they are not ignored, but displayed
4796 ;; as-is instead.
4797 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4798 data info)
4799 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4800 ;; Initialize communication channel in INFO.
4801 (with-temp-buffer
4802 (let ((org-inhibit-startup t)) (org-mode))
4803 (let ((standard-output (current-buffer)))
4804 (dolist (e table)
4806 ((consp e)
4807 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4809 (setq data
4810 (org-element-map (org-element-parse-buffer) 'table
4811 #'identity nil t))
4812 (setq info (org-export-get-environment backend nil params)))
4813 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4814 (user-error "Unknown :backend value"))
4815 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4816 ;; Handle :skip parameter.
4817 (let ((skip (plist-get info :skip)))
4818 (when skip
4819 (unless (wholenump skip) (user-error "Wrong :skip value"))
4820 (let ((n 0))
4821 (org-element-map data 'table-row
4822 (lambda (row)
4823 (if (>= n skip) t
4824 (org-element-extract-element row)
4825 (incf n)
4826 nil))
4827 nil t))))
4828 ;; Handle :skipcols parameter.
4829 (let ((skipcols (plist-get info :skipcols)))
4830 (when skipcols
4831 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4832 (org-element-map data 'table
4833 (lambda (table)
4834 (let ((specialp (org-export-table-has-special-column-p table)))
4835 (dolist (row (org-element-contents table))
4836 (when (eq (org-element-property :type row) 'standard)
4837 (let ((c 1))
4838 (dolist (cell (nthcdr (if specialp 1 0)
4839 (org-element-contents row)))
4840 (when (memq c skipcols)
4841 (org-element-extract-element cell))
4842 (incf c))))))))))
4843 ;; Since we are going to export using a low-level mechanism,
4844 ;; ignore special column and special rows manually.
4845 (let ((special? (org-export-table-has-special-column-p data))
4846 ignore)
4847 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4848 (lambda (datum)
4849 (when (if (eq (org-element-type datum) 'table-row)
4850 (org-export-table-row-is-special-p datum nil)
4851 (org-export-first-sibling-p datum nil))
4852 (push datum ignore))))
4853 (setq info (plist-put info :ignore-list ignore)))
4854 ;; We use a low-level mechanism to export DATA so as to skip all
4855 ;; usual pre-processing and post-processing, i.e., hooks, filters,
4856 ;; Babel code evaluation, include keywords and macro expansion,
4857 ;; and filters.
4858 (let ((output (org-export-data-with-backend data custom-backend info)))
4859 ;; Remove final newline.
4860 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4862 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4863 (cond ((null value) nil)
4864 ((functionp value) `(funcall ',value ,@args))
4865 ((stringp value)
4866 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4867 (args `(format ,value ,@args))
4868 (t value)))
4869 ((and with-cons (consp value))
4870 `(let ((val (cadr (memq column ',value))))
4871 (cond ((null val) contents)
4872 ((stringp val) (format val ,@args))
4873 ((functionp val) (funcall val ,@args))
4874 (t (user-error "Wrong %s value" ,name)))))
4875 (t (user-error "Wrong %s value" name))))
4877 (defun org-table--to-generic-table (params)
4878 "Return custom table transcoder according to PARAMS.
4879 PARAMS is a plist. See `orgtbl-to-generic' for more
4880 information."
4881 (let ((backend (plist-get params :backend))
4882 (splice (plist-get params :splice))
4883 (tstart (plist-get params :tstart))
4884 (tend (plist-get params :tend)))
4885 `(lambda (table contents info)
4886 (concat
4887 ,(and tstart (not splice)
4889 ,(if (or (not backend) tstart tend splice) 'contents
4890 `(org-export-with-backend ',backend table contents info))
4891 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4893 (defun org-table--to-generic-row (params)
4894 "Return custom table row transcoder according to PARAMS.
4895 PARAMS is a plist. See `orgtbl-to-generic' for more
4896 information."
4897 (let* ((backend (plist-get params :backend))
4898 (lstart (plist-get params :lstart))
4899 (llstart (plist-get params :llstart))
4900 (hlstart (plist-get params :hlstart))
4901 (hllstart (plist-get params :hllstart))
4902 (lend (plist-get params :lend))
4903 (llend (plist-get params :llend))
4904 (hlend (plist-get params :hlend))
4905 (hllend (plist-get params :hllend))
4906 (lfmt (plist-get params :lfmt))
4907 (llfmt (plist-get params :llfmt))
4908 (hlfmt (plist-get params :hlfmt))
4909 (hllfmt (plist-get params :hllfmt)))
4910 `(lambda (row contents info)
4911 (if (eq (org-element-property :type row) 'rule)
4912 ,(cond
4913 ((plist-member params :hline)
4914 (org-table--generic-apply (plist-get params :hline) ":hline"))
4915 (backend `(org-export-with-backend ',backend row nil info)))
4916 (let ((headerp (org-export-table-row-in-header-p row info))
4917 (lastp (not (org-export-get-next-element row info)))
4918 (last-header-p (org-export-table-row-ends-header-p row info)))
4919 (when contents
4920 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4921 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4922 ;; `:lstart', `:lend' and their relatives.
4923 ,(let ((cells
4924 '(org-element-map row 'table-cell
4925 (lambda (cell)
4926 ;; Export all cells, without separators.
4927 ;;
4928 ;; Use `org-export-data-with-backend'
4929 ;; instead of `org-export-data' to eschew
4930 ;; cached values, which
4931 ;; ignore :orgtbl-ignore-sep parameter.
4932 (org-export-data-with-backend
4933 cell
4934 (plist-get info :back-end)
4935 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4936 info)))
4937 `(cond
4938 ,(and hllfmt
4939 `(last-header-p ,(org-table--generic-apply
4940 hllfmt ":hllfmt" nil cells)))
4941 ,(and hlfmt
4942 `(headerp ,(org-table--generic-apply
4943 hlfmt ":hlfmt" nil cells)))
4944 ,(and llfmt
4945 `(lastp ,(org-table--generic-apply
4946 llfmt ":llfmt" nil cells)))
4947 (t
4948 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4949 `(concat
4950 (cond
4951 ,(and
4952 (or hllstart hllend)
4953 `(last-header-p
4954 (concat
4955 ,(org-table--generic-apply hllstart ":hllstart")
4956 contents
4957 ,(org-table--generic-apply hllend ":hllend"))))
4958 ,(and
4959 (or hlstart hlend)
4960 `(headerp
4961 (concat
4962 ,(org-table--generic-apply hlstart ":hlstart")
4963 contents
4964 ,(org-table--generic-apply hlend ":hlend"))))
4965 ,(and
4966 (or llstart llend)
4967 `(lastp
4968 (concat
4969 ,(org-table--generic-apply llstart ":llstart")
4970 contents
4971 ,(org-table--generic-apply llend ":llend"))))
4972 (t
4973 ,(cond
4974 ((or lstart lend)
4975 `(concat
4976 ,(org-table--generic-apply lstart ":lstart")
4977 contents
4978 ,(org-table--generic-apply lend ":lend")))
4979 (backend
4980 `(org-export-with-backend
4981 ',backend row contents info))
4982 (t 'contents)))))))))))))))
4984 (defun org-table--to-generic-cell (params)
4985 "Return custom table cell transcoder according to PARAMS.
4986 PARAMS is a plist. See `orgtbl-to-generic' for more
4987 information."
4988 (let* ((backend (plist-get params :backend))
4989 (efmt (plist-get params :efmt))
4990 (fmt (plist-get params :fmt))
4991 (hfmt (plist-get params :hfmt))
4992 (sep (plist-get params :sep))
4993 (hsep (plist-get params :hsep)))
4994 `(lambda (cell contents info)
4995 (let ((headerp (org-export-table-row-in-header-p
4996 (org-export-get-parent-element cell) info))
4997 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4998 ;; Make sure that contents are exported as Org data when :raw
4999 ;; parameter is non-nil.
5000 ,(when (and backend (plist-get params :raw))
5001 `(setq contents
5002 ;; Since we don't know what are the pseudo object
5003 ;; types defined in backend, we cannot pass them to
5004 ;; `org-element-interpret-data'. As a consequence,
5005 ;; they will be treated as pseudo elements, and
5006 ;; will have newlines appended instead of spaces.
5007 ;; Therefore, we must make sure :post-blank value
5008 ;; is really turned into spaces.
5009 (replace-regexp-in-string
5011 (org-trim
5012 (org-element-interpret-data
5013 (org-element-contents cell))))))
5014 (when contents
5015 ;; Check if we can apply `:efmt' on CONTENTS.
5016 ,(when efmt
5017 `(when (string-match orgtbl-exp-regexp contents)
5018 (let ((mantissa (match-string 1 contents))
5019 (exponent (match-string 2 contents)))
5020 (setq contents ,(org-table--generic-apply
5021 efmt ":efmt" t 'mantissa 'exponent)))))
5022 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5023 (cond
5024 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5025 hfmt ":hfmt" t 'contents))))
5026 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5027 fmt ":fmt" t 'contents))))))
5028 ;; If a separator is provided, use it instead of BACKEND's.
5029 ;; Separators are ignored when LFMT (or equivalent) is
5030 ;; provided.
5031 ,(cond
5032 ((or hsep sep)
5033 `(if (or ,(and (not sep) '(not headerp))
5034 (plist-get info :orgtbl-ignore-sep)
5035 (not (org-export-get-next-element cell info)))
5036 ,(if (not backend) 'contents
5037 `(org-export-with-backend ',backend cell contents info))
5038 (concat contents
5039 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5040 (or hsep sep)))))
5041 (backend `(org-export-with-backend ',backend cell contents info))
5042 (t 'contents))))))
5044 ;;;###autoload
5045 (defun orgtbl-to-tsv (table params)
5046 "Convert the orgtbl-mode table to TAB separated material."
5049 ;;;###autoload
5050 (defun orgtbl-to-csv (table params)
5051 "Convert the orgtbl-mode table to CSV material.
5052 This does take care of the proper quoting of fields with comma or quotes."
5053 (orgtbl-to-generic table
5054 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5055 params)))
5057 ;;;###autoload
5058 (defun orgtbl-to-latex (table params)
5059 "Convert the orgtbl-mode TABLE to LaTeX.
5061 TABLE is a list, each entry either the symbol `hline' for
5062 a horizontal separator line, or a list of fields for that line.
5063 PARAMS is a property list of parameters that can influence the
5064 conversion. All parameters from `orgtbl-to-generic' are
5065 supported. It is also possible to use the following ones:
5067 :booktabs
5071 :environment
5073 Specify environment to use, as a string. If you use
5075 as a string, to get proper continuation strings."
5076 (require 'ox-latex)
5077 (orgtbl-to-generic
5078 table
5079 (org-combine-plists
5080 ;; Provide sane default values.
5081 (list :backend 'latex
5082 :latex-default-table-mode 'table
5083 :latex-tables-centered nil
5084 :latex-tables-booktabs (plist-get params :booktabs)
5085 :latex-table-scientific-notation nil
5086 :latex-default-table-environment
5087 (or (plist-get params :environment) "tabular"))
5088 params)))
5090 ;;;###autoload
5091 (defun orgtbl-to-html (table params)
5092 "Convert the orgtbl-mode TABLE to HTML.
5094 TABLE is a list, each entry either the symbol `hline' for
5095 a horizontal separator line, or a list of fields for that line.
5096 PARAMS is a property list of parameters that can influence the
5097 conversion. All parameters from `orgtbl-to-generic' are
5098 supported. It is also possible to use the following one:
5100 :attributes
5102 Attributes and values, as a plist, which will be used in
5103 <table> tag."
5104 (require 'ox-html)
5105 (orgtbl-to-generic
5106 table
5107 (org-combine-plists
5108 ;; Provide sane default values.
5109 (list :backend 'html
5110 :html-table-data-tags '("<td%s>" . "</td>")
5111 :html-table-use-header-tags-for-first-column nil
5112 :html-table-align-individual-fields t
5113 :html-table-row-tags '("<tr>" . "</tr>")
5114 :html-table-attributes
5115 (if (plist-member params :attributes)
5116 (plist-get params :attributes)
5117 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5118 :frame "hsides")))
5119 params)))
5121 ;;;###autoload
5122 (defun orgtbl-to-texinfo (table params)
5123 "Convert the orgtbl-mode TABLE to Texinfo.
5125 TABLE is a list, each entry either the symbol `hline' for
5126 a horizontal separator line, or a list of fields for that line.
5127 PARAMS is a property list of parameters that can influence the
5128 conversion. All parameters from `orgtbl-to-generic' are
5129 supported. It is also possible to use the following one:
5131 :columns
5133 Column widths, as a string. When providing column fractions,
5135 (require 'ox-texinfo)
5136 (let ((output
5137 (orgtbl-to-generic
5138 table
5139 (org-combine-plists
5140 (list :backend 'texinfo
5141 :texinfo-tables-verbatim nil
5142 :texinfo-table-scientific-notation nil)
5143 params)))
5144 (columns (let ((w (plist-get params :columns)))
5145 (cond ((not w) nil)
5147 (t (concat "@columnfractions " w))))))
5148 (if (not columns) output
5149 (replace-regexp-in-string
5152 ;;;###autoload
5153 (defun orgtbl-to-orgtbl (table params)
5154 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5156 TABLE is a list, each entry either the symbol `hline' for
5157 a horizontal separator line, or a list of fields for that line.
5158 PARAMS is a property list of parameters that can influence the
5159 conversion. All parameters from `orgtbl-to-generic' are
5160 supported.
5162 Useful when slicing one table into many. The :hline, :sep,
5163 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5164 be set to provide ORGTBL directives for the generated table."
5165 (require 'ox-org)
5166 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5168 (defun orgtbl-to-table.el (table params)
5169 "Convert the orgtbl-mode TABLE into a table.el table.
5170 TABLE is a list, each entry either the symbol `hline' for
5171 a horizontal separator line, or a list of fields for that line.
5172 PARAMS is a property list of parameters that can influence the
5173 conversion. All parameters from `orgtbl-to-generic' are
5174 supported."
5175 (with-temp-buffer
5176 (insert (orgtbl-to-orgtbl table params))
5177 (org-table-align)
5178 (replace-regexp-in-string
5179 "-|" "-+"
5180 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5182 (defun orgtbl-to-unicode (table params)
5183 "Convert the orgtbl-mode TABLE into a table with unicode characters.
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 :ascii-art
5194 the table. You can download it here:
5195 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5197 :narrow
5199 When non-nil, narrow columns width than provided width cookie,
5201 (require 'ox-ascii)
5202 (orgtbl-to-generic
5203 table
5204 (org-combine-plists
5205 (list :backend 'ascii
5206 :ascii-charset 'utf-8
5207 :ascii-table-widen-columns (not (plist-get params :narrow))
5208 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5209 params)))
5211 ;; Put the cursor in a column containing numerical values
5212 ;; of an Org-Mode table,
5213 ;; type C-c " a
5214 ;; A new column is added with a bar plot.
5215 ;; When the table is refreshed (C-u C-c *),
5216 ;; the plot is updated to reflect the new values.
5218 (defun orgtbl-ascii-draw (value min max &optional width characters)
5219 "Draw an ascii bar in a table.
5220 VALUE is a the value to plot, the width of the bar to draw. A
5221 value equal to MIN will be displayed as empty (zero width bar).
5222 A value equal to MAX will draw a bar filling all the WIDTH.
5223 WIDTH is the expected width in characters of the column.
5224 CHARACTERS is a string that will compose the bar, with shades of
5225 grey from pure white to pure black. It defaults to a 10
5226 characters string of regular ascii characters."
5227 (let* ((characters (or characters " .:;c!lhVHW"))
5228 (width (or width 12))
5229 (value (if (numberp value) value (string-to-number value)))
5230 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5231 (cond
5232 ((< value 0) "too small")
5233 ((> value width) "too large")
5234 (t
5235 (let ((len (1- (length characters))))
5236 (concat
5237 (make-string (floor value) (elt characters len))
5238 (string (elt characters
5239 (floor (* (- value (floor value)) len))))))))))
5241 ;;;###autoload
5242 (defun orgtbl-ascii-plot (&optional ask)
5243 "Draw an ascii bar plot in a column.
5244 With cursor in a column containing numerical values, this
5245 function will draw a plot in a new column.
5246 ASK, if given, is a numeric prefix to override the default 12
5247 characters width of the plot. ASK may also be the
5249 (interactive "P")
5250 (let ((col (org-table-current-column))
5251 (min 1e999) ; 1e999 will be converted to infinity
5252 (max -1e999) ; which is the desired result
5253 (table (org-table-to-lisp))
5254 (length
5255 (cond ((consp ask)
5256 (read-number "Length of column " 12))
5257 ((numberp ask) ask)
5258 (t 12))))
5259 ;; Skip any hline a the top of table.
5260 (while (eq (car table) 'hline) (setq table (cdr table)))
5261 ;; Skip table header if any.
5262 (dolist (x (or (cdr (memq 'hline table)) table))
5263 (when (consp x)
5264 (setq x (nth (1- col) x))
5265 (when (string-match
5267 x)
5268 (setq x (string-to-number x))
5269 (when (> min x) (setq min x))
5270 (when (< max x) (setq max x)))))
5271 (org-table-insert-column)
5272 (org-table-move-column-right)
5273 (org-table-store-formulas
5274 (cons
5275 (cons
5276 (number-to-string (1+ col))
5277 (format "'(%s $%s %s %s %s)"
5278 "orgtbl-ascii-draw" col min max length))
5279 (org-table-get-stored-formulas)))
5280 (org-table-recalculate t)))
5282 ;; Example of extension: unicode characters
5283 ;; Here are two examples of different styles.
5285 ;; Unicode block characters are used to give a smooth effect.
5286 ;; See http://en.wikipedia.org/wiki/Block_Elements
5287 ;; Use one of those drawing functions
5288 ;; - orgtbl-ascii-draw (the default ascii)
5289 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5290 ;; - orgtbl-uc-draw-cont (smooth unicode)
5292 ;; This is best viewed with the "DejaVu Sans Mono" font
5293 ;; (use M-x set-default-font).
5295 (defun orgtbl-uc-draw-grid (value min max &optional width)
5296 "Draw a bar in a table using block unicode characters.
5297 It is a variant of orgtbl-ascii-draw with Unicode block
5298 characters, for a smooth display. Bars appear as grids (to the
5299 extent the font allows)."
5300 ;; http://en.wikipedia.org/wiki/Block_Elements
5301 ;; best viewed with the "DejaVu Sans Mono" font.
5302 (orgtbl-ascii-draw value min max width
5305 (defun orgtbl-uc-draw-cont (value min max &optional width)
5306 "Draw a bar in a table using block unicode characters.
5307 It is a variant of orgtbl-ascii-draw with Unicode block
5308 characters, for a smooth display. Bars are solid (to the extent
5309 the font allows)."
5310 (orgtbl-ascii-draw value min max width
5313 (defun org-table-get-remote-range (name-or-id form)
5314 "Get a field value or a list of values in a range from table at ID.
5316 NAME-OR-ID may be the name of a table in the current file as set
5318 will then be used. Alternatively, it may be an ID referring to
5319 any entry, also in a different file. In this case, the first
5320 table in that entry will be referenced.
5324 The return value is either a single string for a single field, or a
5325 list of the fields in the rectangle."
5326 (save-match-data
5327 (let ((case-fold-search t) (id-loc nil)
5328 ;; Protect a bunch of variables from being overwritten by
5329 ;; the context of the remote table.
5330 org-table-column-names org-table-column-name-regexp
5331 org-table-local-parameters org-table-named-field-locations
5332 org-table-current-line-types
5333 org-table-current-begin-pos org-table-dlines
5334 org-table-current-ncol
5335 org-table-hlines org-table-last-alignment
5336 org-table-last-column-widths org-table-last-alignment
5337 org-table-last-column-widths
5338 buffer loc)
5339 (setq form (org-table-convert-refs-to-rc form))
5340 (org-with-wide-buffer
5341 (goto-char (point-min))
5342 (if (re-search-forward
5345 nil t)
5346 (setq buffer (current-buffer) loc (match-beginning 0))
5347 (setq id-loc (org-id-find name-or-id 'marker))
5348 (unless (and id-loc (markerp id-loc))
5350 (setq buffer (marker-buffer id-loc)
5351 loc (marker-position id-loc))
5352 (move-marker id-loc nil))
5353 (with-current-buffer buffer
5354 (org-with-wide-buffer
5355 (goto-char loc)
5356 (forward-char 1)
5358 (not (match-beginning 1)))
5359 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5360 (org-table-analyze)
5361 (setq form (org-table-formula-substitute-names
5362 (org-table-formula-handle-first/last-rc form)))
5363 (if (and (string-match org-table-range-regexp form)
5364 (> (length (match-string 0 form)) 1))
5365 (org-table-get-range
5366 (match-string 0 form) org-table-current-begin-pos 1)
5367 form)))))))
5369 (defun org-table-remote-reference-indirection (form)
5370 "Return formula with table remote references substituted by indirection.
5372 This indirection works only with the format @ROW$COLUMN. The
5374 distinguished from a plain table name or ID."
5375 (let ((start 0))
5376 (while (string-match (concat
5377 ;; Same as in `org-table-eval-formula'.
5379 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5381 ;; Same as in `org-table-eval-formula'.
5383 form
5384 start)
5385 ;; The position of the character as far as possible to the right
5386 ;; that will not be replaced and particularly not be shifted by
5387 ;; `replace-match'.
5388 (setq start (match-beginning 1))
5389 ;; Substitute the remote reference with the value found in the
5390 ;; field.
5391 (setq form
5392 (replace-match
5393 (save-match-data
5394 (org-table-get-range (org-table-formula-handle-first/last-rc
5395 (match-string 1 form))))
5396 t t form 1))))
5397 form)
5399 (defmacro org-define-lookup-function (mode)
5400 (let ((mode-str (symbol-name mode))
5401 (first-p (equal mode 'first))
5402 (all-p (equal mode 'all)))
5403 (let ((plural-str (if all-p "s" "")))
5404 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5405 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5406 If R-LIST is nil, return matching element%s of S-LIST.
5407 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5408 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5409 This function is generated by a call to the macro `org-define-lookup-function'."
5410 mode-str plural-str plural-str plural-str)
5411 (let ,(let ((lvars '((p (or predicate 'equal))
5412 (sl s-list)
5413 (rl (or r-list s-list))
5414 (ret nil))))
5415 (if first-p (cons '(match-p nil) lvars) lvars))
5416 (while ,(if first-p '(and (not match-p) sl) 'sl)
5417 (when (funcall p val (car sl))
5418 ,(when first-p '(setq match-p t))
5419 (let ((rval (car rl)))
5420 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5421 (setq sl (cdr sl) rl (cdr rl)))
5422 ret)))))
5424 (org-define-lookup-function first)
5425 (org-define-lookup-function last)
5426 (org-define-lookup-function all)
5428 (provide 'org-table)
5430 ;; Local variables:
5431 ;; generated-autoload-file: "org-loaddefs.el"
5432 ;; End:
5434 ;;; org-table.el ends here