| blob | 520ac8a1587b9b7f95766a8ec6d8f9ef4b8c702f |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2014 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:
50 "Hook for functions attaching to `C-c C-c', if the table is sent.
51 This can be used to add additional functionality after the table is sent
52 to the receiver position, otherwise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
91 #+ END RECEIVE ORGTBL %n
93 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
94 | | |
96 "Templates for radio tables in different major modes.
97 Each template must define lines that will be treated as a comment and that
100 insertion of the template. The transformed table will later be inserted
101 between these lines.
103 The template should also contain a minimal table in a multiline comment.
104 If multiline comments are not possible in the buffer language,
105 you can pack it into a string that will not be used when the code
106 is compiled or executed. Above the table will you need a line with
108 convert the table into a data structure useful in the
109 language of the buffer. Check the manual for the section on
111 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
113 All occurrences of %n in a template will be replaced with the name of the
114 table, obtained by prompting the user."
121 "Settings for tables in Org-mode."
126 "The default size for newly created tables, Columns x Rows."
131 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
132 "Regular expression for recognizing numbers in table columns.
133 If a table column contains mostly numbers, it will be aligned to the
134 right. If not, it will be aligned to the left.
136 The default value of this option is a regular expression which allows
137 anything which looks remotely like a number as used in scientific
138 context. For example, all of the following will be considered a
139 number:
140 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
142 Other options offered by the customize interface are more restrictive."
156 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
157 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
158 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
162 "Fraction of numbers in a column required to make the column align right.
163 In a column all non-white fields are considered. If at least
164 this fraction of fields is matched by `org-table-number-regexp',
165 alignment to the right border applies."
170 "Behavior of tables during editing in Org-mode."
175 "Non-nil means automatically re-align table when pressing TAB or RETURN.
177 removal/insertion."
182 "Non-nil means automatically blank table field when starting to type into it.
183 This only happens when typing immediately after a field motion
184 command (TAB, S-TAB or RET).
185 Only relevant when `org-enable-table-editor' is equal to `optimized'."
190 "Non-nil means automatically exit the follow mode.
191 When nil, the follow mode will stay on and be active in any table
192 the cursor enters. Since the table follow filed mode messes with the
193 window configuration, it is not recommended to set this variable to nil,
194 except maybe locally in a special file that has mostly tables with long
195 fields."
201 "Whether the user should confirm when Org fixes formulas."
209 'safe-local-variable
213 "Non-nil means tab in the last column of a table with jump over a hline.
214 If a horizontal separator line is following the current line,
215 `org-table-next-field' can either create a new row before that line, or jump
216 over the line. When this option is nil, a new line will be created before
217 this line."
222 "Options concerning tables in Org-mode."
227 "Should org-mode work with table references like B3 instead of @3$2?
228 Possible values are:
229 nil never use them
230 from accept as input, do not present for editing
231 t accept as input and present for editing"
246 calc-angle-mode deg
247 calc-prefer-frac nil
248 calc-symbolic-mode nil
250 calc-display-working-message t
251 )
252 "List with Calc mode settings for use in `calc-eval' for table formulas.
253 The list must contain alternating symbols (Calc modes variables and values).
254 Don't remove any of the default settings, just change the values. Org-mode
255 relies on the variables to be present in the list."
260 "Format for the output of calc computations like $1+$2;t.
261 The default value is 'hours, and will output the results as a
262 number of hours. Other allowed values are 'seconds, 'minutes and
263 'days, and the output will be a fraction of seconds, minutes or
264 days."
273 "Format for fields which contain the result of a formula.
275 characters. Beware that modifying the display can prevent the
276 field from being used in another formula."
282 "Non-nil means TAB and RET evaluate a formula in current table field.
283 If the current field starts with an equal sign, it is assumed to be a formula
284 which should be evaluated as described in the manual and in the documentation
285 string of the command `org-table-eval-formula'. This feature requires the
286 Emacs calc package.
287 When this variable is nil, formula calculation is only available through
293 "Non-nil means interpret constants in formulas in tables.
294 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
295 by the value given in `org-table-formula-constants', or by a value obtained
296 from the `constants.el' package."
301 "Alist with constant names and values, for use in table formulas.
302 The car of each element is a name of a constant, without the `$' before it.
303 The cdr is the value as a string. For example, if you'd like to use the
304 speed of light in a formula, you would configure
308 and then use it in an equation like `$1*$c'.
310 Constants can also be defined on a per-file basis using a line like
312 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
319 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
320 Automatically means when TAB or RET or C-c C-c are pressed in the line."
325 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
330 "Non-nil means relative formula references may cross hlines.
331 Here are the allowed values:
333 nil Relative references may not cross hlines. They will reference the
334 field next to the hline instead. Coming from below, the reference
335 will be to the field below the hline. Coming from above, it will be
336 to the field above.
337 t Relative references may cross hlines.
338 error An attempt to cross a hline will throw an error.
340 It is probably good to never set this variable to nil, for the sake of
341 portability of tables."
349 "Options concerning table import and export in Org-mode."
354 "Default export parameters for `org-table-export'.
355 These can be overridden for a specific table by setting the
356 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
357 radio tables for the different export transformations and
358 available parameters."
396 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
397 ;; 1 2 3 4 5
408 "Is this a table line colgroup information?"
412 line)
414 nil
421 "Is this a table line with only alignment/width cookies?"
434 s))))
440 "Check if the table has a marking column.
441 If yes remove the column and the special lines."
454 lines))))
463 nil)
467 ;; remove the first column
470 lines))))
476 ;;;###autoload
478 "Use the table.el package to insert a new table.
479 If there is already a table at point, convert between Org-mode tables
480 and table.el tables."
493 ;;;###autoload
495 "Convert region to table, or create an empty table.
496 If there is an active region, convert it to a table, using the function
497 `org-table-convert-region'. See the documentation of that function
498 to learn how the prefix argument is interpreted to determine the field
499 separator.
500 If there is no such region, create an empty table with `org-table-create'."
506 ;;;###autoload
508 "Query for a size and insert a table skeleton.
528 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
532 ;; Insert a hline after the first row.
539 ;;;###autoload
541 "Convert region to a table.
542 The region goes from BEG0 to END0, but these borders will be moved
543 slightly, to make sure a beginning of line in the first line is included.
545 SEPARATOR specifies the field separator in the lines. It can have the
546 following values:
548 '(4) Use the comma as a field separator
549 '(16) Use a TAB as field separator
550 '(64) Prompt for a regular expression as field separator
551 integer When a number, use that many spaces as field separator
552 regexp When a regular expression, use it to match the separator
553 nil When nil, the command tries to be smart and figure out the
554 separator in the following way:
555 - when each line contains a TAB, assume TAB-separated material
556 - when each line contains a comma, assume CSV material
557 - else, assume one or more SPACE characters as separator."
561 re)
570 ;; Get the right field separator
581 ;; parse the csv stuff
606 ;;;###autoload
608 "Import FILE as a table.
609 The file is assumed to be tab-separated. Such files can be produced by most
610 spreadsheet and database applications. If no tabs (at least one per line)
611 are found, lines will be split on whitespace into fields."
622 ;;;###autoload
624 "Export table to a file, with configurable format.
625 Such a file can be imported into usual spreadsheet programs.
627 FILE can be the output file name. If not given, it will be taken
628 from a TABLE_EXPORT_FILE property in the current entry or higher
629 up in the hierarchy, or the user will be prompted for a file
630 name. FORMAT can be an export format, of the same kind as it
631 used when `orgtbl-mode' sends a table in a different format.
633 The command suggests a format depending on TABLE_EXPORT_FORMAT,
634 whether it is set locally or up in the hierarchy, then on the
635 extension of the given file name, and finally on the variable
636 `org-table-export-default-format'."
650 buf deffmt-readable fileext)
666 org-table-export-default-format))
684 'hline
687 skipcols i0)))
688 lines))
692 skipcols i0))
695 skipcols i0)))
712 "Marker at the beginning of the table last aligned.
715 "Marker at the end of the table last aligned.
718 "List of flags for flushright alignment, from the last re-alignment.
721 "List of max width of fields in each column.
724 "Non-nil means debug table formulas.
736 ;;;###autoload
738 "Align the table at point by aligning all vertical bars."
741 ;; Limits of table
744 ;; Current cursor position
750 column
752 rfmt hfmt
760 emptystrings links dates emph raise narrow
761 falign falign1 fmax f1 len c e space)
764 ;; Check if we have links or dates
776 ;; Make sure the link properties are right
778 ;; Make sure the date properties are right
783 ;; Check if we are narrowing any columns
786 org-format-transports-properties-p
791 ;; Get the rows
794 ;; Store the indentation of the first line
797 ;; Mark the hlines by setting the corresponding element to nil
798 ;; At the same time, we remove trailing space.
801 nil
804 l)))
805 lines))
806 ;; Get the data fields by splitting the lines.
811 ;; How many fields in the longest line?
818 ;; A list of empty strings to fill any short rows on output
820 ;; Check for special formatting.
824 ;; Check if there is an explicit width specified
834 ;; Find fields that are wider than fmax, and shorten them
840 'help-echo
841 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
849 xx)))))
850 ;; Get the maximum width for each column
852 lengths)
853 ;; Get the fraction of numbers, to decide about alignment of the column
859 nil
866 ;; Store the alignment of this table, for later editing of single fields
868 org-table-last-column-widths lengths)
870 ;; With invisible characters, `format' does not get the field width right
871 ;; So we need to make these fields wide by hand.
889 ;; Compute the formats needed for output of the table
902 hfmt))
906 ;; Replace the old one
913 ;; Try to move to the old location
922 ))
924 ;;;###autoload
926 "Find the beginning of the table and return its position.
927 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
931 org-table-border-regexp)
932 nil t))
938 ;;;###autoload
940 "Find the end of the table and return its position.
941 With argument TABLE-TYPE, go to the end of a table.el-type table."
945 org-table-border-regexp)
946 nil t))
951 ;;;###autoload
953 "Justify the current field, text to left, number to right.
954 Optional argument NEW may specify text to replace the current field content."
963 ;; This is not the same table, force a full re-align
969 l f n o e)
992 ;;;###autoload
994 "Go to the next field in the current table, creating new lines as needed.
995 Before doing so, re-align the table if necessary."
1000 org-table-may-need-update)
1011 org-table-tab-jumps-over-hlines
1022 ;;;###autoload
1024 "Go to the previous field in the table.
1025 Before doing so, re-align the table if necessary."
1030 org-table-may-need-update)
1045 "Move to the end of the current table field.
1046 If already at or after the end, move to the end of the next table field.
1047 With numeric argument N, move N-1 fields forward first."
1060 "Move to the beginning of the current table field.
1061 If already at or before the beginning, move to the beginning of the
1062 previous field.
1063 With numeric argument N, move N-1 fields backward first."
1076 ;;;###autoload
1078 "Go to the next row (same column) in the current table.
1079 Before doing so, re-align the table if necessary."
1087 org-table-may-need-update)
1100 ;;;###autoload
1102 "Copy a field down in the current column.
1103 If the field at the cursor is empty, copy into it the content of
1104 the nearest non-empty field above. With argument N, use the Nth
1105 non-empty field. If the current field is not empty, it is copied
1106 down to the next row, and the cursor is moved with it.
1107 Therefore, repeating this command causes the column to be filled
1108 row-by-row.
1109 If the variable `org-table-copy-increment' is non-nil and the
1110 field is an integer or a timestamp, it will be incremented while
1111 copying. In the case of a timestamp, increment by one day."
1119 txt)
1131 beg t))
1154 "Is point inside a table data field?
1155 I.e. not on a hline or before the first or after the last column?
1156 This actually throws an error, so it aborts the current command."
1162 nil
1164 t))
1170 "Get the field in table line LINE, column COLUMN.
1171 If LINE is larger than the number of data lines in the table, the function
1172 returns nil. However, if COLUMN is too large, we will simply return an
1173 empty string.
1174 If LINE is nil, use the current line.
1175 If column is nil, use the current column."
1182 "Put VALUE into line LINE, column COLUMN.
1183 When ALIGN is set, also realign the table."
1192 "Return the index of the current data line."
1199 cnt))
1202 "Go to the Nth data line in the current table.
1203 Return t when the line exists, nil if it does not exist."
1210 ;;;###autoload
1212 "Blank the current table field or active region."
1229 "Return the value of the field in column N of current row.
1230 N defaults to current field.
1231 If REPLACE is a string, replace field with this value. The return value
1232 is always the old value."
1241 t t))
1243 val)
1246 ;;;###autoload
1248 "Show info about the current field, and highlight any reference at point."
1257 org-table-named-field-locations)))
1277 dline col
1279 dline col ref1
1281 ;; FIXME: formula info not correct if special table line
1291 "Find out which column we are in."
1301 cnt)))
1303 ;;;###autoload
1305 "Find out what table data line we are in.
1306 Only data lines count for this."
1318 cnt)))
1320 ;;;###autoload
1322 "Move the cursor to the Nth column in the current table line.
1323 With optional argument ON-DELIM, stop with point before the left delimiter
1324 of the field.
1325 If there are less than N fields, just go to after the last delimiter.
1326 However, when FORCE is non-nil, create new columns if necessary."
1336 t)))))
1343 ;;;###autoload
1345 "Insert a new column into the table."
1353 ;; Current cursor position
1359 nil
1373 "Find a data line in the current table, which is needed for column commands."
1376 t
1387 t
1392 "Turn a buffer line number into a data line number.
1393 If there is no data line in this line, return nil.
1394 If there is no matching dline (most likely te reference was a hline), the
1395 first dline below it is used. When ABOVE is non-nil, the one above is used."
1398 i)
1411 nil))
1413 ;;;###autoload
1415 "Delete a column from the table."
1424 ;; Current cursor position
1430 nil
1446 ;;;###autoload
1448 "Move column to the right."
1451 ;;;###autoload
1453 "Move column to the left."
1457 ;;;###autoload
1459 "Move the current column to the right. With arg LEFT, move to the left."
1469 ;; Current cursor position
1479 nil
1497 ;;;###autoload
1499 "Move table row down."
1502 ;;;###autoload
1504 "Move table row up."
1508 ;;;###autoload
1510 "Move the current table line down. With arg UP, move it up."
1519 txt hline2p)
1542 ;;;###autoload
1544 "Insert a new row above the current line into the table.
1545 With prefix ARG, insert below the current line."
1551 ;; Fix the first field if necessary
1564 ;;;###autoload
1566 "Insert a horizontal-line below the current line into the table.
1567 With prefix ABOVE, insert above the current line."
1588 ;;;###autoload
1590 "Insert a hline and move to the row below that line."
1604 In particular, this does handle wide and invisible characters."
1606 ;; It's a hline, just map the characters
1612 t t s)))
1613 s))
1615 ;;;###autoload
1617 "Delete the current row or horizontal line from the table."
1631 ;;;###autoload
1633 "Sort table lines according to the column at point.
1635 The position of point indicates the column to be used for
1636 sorting, and the range of lines is the range between the nearest
1637 horizontal separator lines, or the entire table of no such lines
1638 exist. If point is before the first column, you will be prompted
1639 for the sorting column. If there is an active region, the mark
1640 specifies the first line and the sorting column, while point
1641 should be in the last line to be included into the sorting.
1643 The command then prompts for the sorting type which can be
1644 alphabetically, numerically, or by time (as given in a time stamp
1645 in the field). Sorting in reverse order is also possible.
1647 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1649 If SORTING-TYPE is specified when this function is called from a Lisp
1650 program, no prompting will take place. SORTING-TYPE must be a character,
1651 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1652 should be done in reverse order."
1657 beg end bcol ecol tend tbeg column lns pos)
1702 x))
1716 ;;;###autoload
1718 "Copy region in table to the clipboard and blank all relevant fields.
1719 If there is no active region, use just the field at point."
1725 ;;;###autoload
1727 "Copy rectangular region in table to clipboard.
1728 A special clipboard is used which can only be accessed
1729 with `org-table-paste-rectangle'."
1733 current-prefix-arg))
1735 region cols
1761 org-table-clip))
1763 ;;;###autoload
1765 "Paste a rectangular region into a table.
1766 The upper right corner ends up in the current field. All involved fields
1767 will be overwritten. If the rectangle does not fit into the present table,
1768 the table is enlarged as needed. The process ignores horizontal separator
1769 lines."
1779 c cols field)
1794 ;;;###autoload
1796 "Convert from `org-mode' table to table.el and back.
1797 Obviously, this only works within limits. When an Org-mode table is
1798 converted to table.el, all horizontal separator lines get lost, because
1799 table.el uses these as cell boundaries and has no notion of horizontal lines.
1800 A table.el table can be converted to an Org-mode table only if it does not
1801 do row or column spanning. Multiline cells will become multiple cells.
1802 Beware, Org-mode does not test if the table can be successfully converted - it
1803 blindly applies a recipe that works for simple tables."
1807 ;; convert to Org-mode table
1816 ;; convert to table.el table
1819 ;; first, get rid of all horizontal lines
1823 ;; insert a hline before first
1827 ;; insert a hline after each line
1832 ;; replace "+" at beginning and ending of hlines
1841 "Transpose Org table at point and eliminate hlines.
1842 So a table like
1844 | 1 | 2 | 4 | 5 |
1845 |---+---+---+---|
1846 | a | b | c | d |
1847 | e | f | g | h |
1849 will be transposed as
1851 | 1 | a | e |
1852 | 2 | b | f |
1853 | 4 | c | g |
1854 | 5 | d | h |
1856 Note that horizontal lines disappear."
1868 table)))
1882 ;;;###autoload
1884 "Wrap several fields in a column like a paragraph.
1885 This is useful if you'd like to spread the contents of a field over several
1886 lines, in order to keep the table compact.
1888 If there is an active region, and both point and mark are in the same column,
1889 the text in the column is wrapped to minimum width for the given number of
1890 lines. Generally, this makes the table more compact. A prefix ARG may be
1892 formats the selected text to two lines. If the region was longer than two
1893 lines, the remaining lines remain empty. A negative prefix argument reduces
1894 the current number of lines by that amount. The wrapped text is pasted back
1895 into the table. If you formatted it to more lines than it was before, fields
1896 further down in the table get overwritten - so you might need to make space in
1897 the table first.
1899 If there is no region, the current field is split at the cursor position and
1900 the text fragment to the right of the cursor is prepended to the field one
1901 line down.
1903 If there is no region, but you specify a prefix ARG, the current field gets
1904 blank, and the content is appended to the field above."
1908 ;; There is a region: fill as a paragraph
1912 nlines)
1919 arg)
1923 nil nlines)))
1927 ;; No region, split the current field at point
1931 ;; combine with field above
1941 ;; split field
1953 ;;;###autoload
1955 "Edit table field in a different window.
1956 This is mainly useful for fields that contain hidden parts.
1958 it can be edited in place."
1967 display t intangible t))
1980 p)
1996 intangible t))
2004 "Finish editing a table data field.
2005 Remove all newline characters, insert the result into the table, realign
2006 the table and kill the editing buffer."
2010 text)
2027 "Minor mode to make the table field editor window follow the cursor.
2028 When this mode is active, the field editor window will always show the
2029 current field. The mode exits automatically when the cursor leaves the
2030 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2031 nil " TblFollow" nil
2047 ;; We have left the table, exit the follow mode
2057 ;;;###autoload
2059 "Sum numbers in region of current table column.
2060 The result will be displayed in the echo area, and will be available
2063 If there is an active region, it is interpreted as a rectangle and all
2064 numbers in that rectangle will be summed. If there is no active
2065 region and point is located in a table column, sum all numbers in that
2066 column.
2068 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2069 numbers are assumed to be times as well (in decimal hours) and the
2070 numbers are added as such.
2072 If NLAST is a number, only the NLAST fields will actually be summed."
2099 items1)))
2106 s diff)
2114 sres))))
2137 "Return the formula active for the current field.
2138 Assumes that specials are in place.
2139 If KEY is given, return the key to this formula.
2143 org-table-named-field-locations)))
2157 "Read a formula from the minibuffer, offer stored formula as default.
2158 When NAMED is non-nil, look for a named equation."
2162 org-table-named-field-locations)))
2169 name
2170 ref)
2180 stored)
2182 equation)
2189 scol))
2191 'org-table-formula-history
2192 )))))
2193 mustsave)
2195 ;; remove formula
2202 ;; We set the column equation, delete the named one.
2204 mustsave t))
2210 eq))
2213 "Store the list of formulas below the current table."
2220 ;; don't overwrite TBLFM, we might use text properties to store stuff
2236 ;; Fake a high number to make sure this is sorted at the end.
2243 a)
2253 "Compare two formulas for sorting."
2258 ;;;###autoload
2260 "Return an alist with the stored formulas directly after current table."
2269 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2288 "Modify the equations after the table structure has been edited.
2290 For all numbers larger than LIMIT, shift them by DELTA."
2302 s n a)
2308 "Change makes TBLFM term %s invalid, use undo to recover"
2324 "Get the column names and local parameters for this table."
2327 names name fields fields1 field cnt
2328 c v l line col types dlines hlines last-dline)
2330 org-table-local-parameters nil
2331 org-table-named-field-locations nil
2332 org-table-current-begin-line nil
2333 org-table-current-begin-pos nil
2334 org-table-current-line-types nil
2353 org-table-local-parameters))))
2369 ;; Analyse the line types
2373 l org-table-current-begin-line)
2390 al al2)
2400 ;;;###autoload
2403 If yes, store the formula and apply it."
2404 ;; We already know we are in a table. Get field will only return a formula
2405 ;; when appropriate. It might return a separator line, but no problem.
2408 named eq)
2419 "List of commands triggering the recalculation of a line.
2431 ;;;###autoload
2433 "Rotate the recalculation mark in the first column.
2434 If in any row, the first field is not consistent with a mark,
2435 insert a new column for the markers.
2436 When there is an active region, change all the lines in the region,
2437 after prompting for the marking character.
2438 After each change, a message will be displayed indicating the meaning
2439 of the new mark."
2454 epos new)
2461 newchar))
2493 ;;;###autoload
2495 "Recompute the current line if marked for it, and if we haven't just done it."
2515 org-tbl-calc-modes)
2517 ;;;###autoload
2519 suppress-align suppress-const
2520 suppress-store suppress-analysis)
2521 "Replace the table field value at the cursor by the result of a calculation.
2523 This function makes use of Dave Gillespie's Calc package, in my view the
2524 most exciting program ever written for GNU Emacs. So you need to have Calc
2525 installed in order to use this function.
2527 In a table, this command replaces the value in the current field with the
2529 formula, by storing it in a special line below the table. When called
2530 with a `C-u' prefix, the current field must be a named field, and the
2531 formula is installed as valid in only this specific field.
2533 When called with two `C-u' prefixes, insert the active equation
2534 for the field back into the current field, so that it can be
2536 to check the referenced fields.
2538 When called, the command first prompts for a formula, which is read in
2539 the minibuffer. Previously entered formulas are available through the
2540 history list, and the last used formula is offered as a default.
2541 These stored formulas are adapted correctly when moving, inserting, or
2542 deleting columns with the corresponding commands.
2544 The formula can be any algebraic expression understood by the Calc package.
2545 For details, see the Org-mode manual.
2547 This function can also be called from Lisp programs and offers
2548 additional arguments: EQUATION can be the formula to apply. If this
2549 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2550 used to speed-up recursive calls by by-passing unnecessary aligns.
2551 SUPPRESS-CONST suppresses the interpretation of constants in the
2552 formula, assuming that this has been done already outside the function.
2553 SUPPRESS-STORE means the formula should not be stored, either because
2554 it is already stored, or because it is a modified equation that should
2555 not overwrite the stored one."
2571 equation
2577 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2578 duration duration-output-format)
2579 ;; Parse the format string. Since we have a lot of modes, this is
2580 ;; a lot of work. However, I think calc still uses most of the time.
2593 'calc-float-format
2596 n))))
2600 duration-output-format nil
2604 duration-output-format org-table-duration-custom-format
2605 numbers t
2628 ;; replace fields with duration values if relevant
2632 fields)))
2638 x))
2639 fields)))
2645 ;; Insert row and column number of formula result field
2656 t t form)))
2658 ;; Check for old vertical references
2660 ;; Insert remote references
2673 rmtrng))
2674 keep-empty numbers lispp))
2675 t t form)))
2676 ;; Insert complex ranges
2684 ;; possibly handle durations
2689 formrg)
2690 keep-empty numbers lispp)))
2695 ;; Insert simple ranges
2704 keep-empty numbers lispp))
2705 t t form)))
2707 ;; Insert the references to fields in same row
2717 x keep-empty numbers lispp))
2718 t t form)))
2730 ;; Use <...> time-stamps so that Calc can handle them
2732 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2743 form
2750 duration-output-format)
2751 ev)))
2756 Orig: %s
2757 $xyz-> %s
2758 @r$c-> %s
2790 prop value)))
2793 "Get a calc vector from a column, according to descriptor DESC.
2794 Optional arguments TBEG and COL can give the beginning of the table and
2795 the current column, to avoid unnecessary parsing.
2797 HIGHLIGHT means just highlight the range.
2799 When CORNERS-ONLY is set, only return the corners of the range as
2800 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2801 in the buffer and column1 and column2 are table column numbers."
2808 beg end c1 c2 r1 r2 rangep tmp)
2825 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2832 ;; just one field
2839 ;; A range, return a vector
2840 ;; First sort the numbers to get a regular rectangle
2844 ;; Only return the corners of the range
2846 ;; Copy the range values into a list
2860 ;; return string representation of calc vector
2865 "Analyze descriptor DESC and retrieve the corresponding line number.
2866 The cursor is currently in line CLINE, the table begins in line BLINE,
2867 and TABLE is a vector with line types."
2875 ;; 1 2 3 4 5 6
2895 nil hn cline desc)))
2898 rel on cline desc)))
2902 "FIXME: Needs more documentation."
2915 nil))
2916 t)))
2920 desc cline)
2921 i)))
2926 s))
2929 "Convert list ELEMENTS to something appropriate to insert into formula.
2930 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2931 NUMBERS indicates that everything should be converted to numbers.
2932 LISPP non-nil means to return something appropriate for a Lisp
2933 list, 'literal is for the format specifier L."
2934 ;; Calc nan (not a number) is used for the conversion of the empty
2935 ;; field to a reference for several reasons: (i) It is accepted in a
2936 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2937 ;; (ii) In a single field (not in range) it can be distinguished
2938 ;; from "(nan)" which is the reference made from a single field
2939 ;; containing "nan".
2941 ;; field reference
2944 elements
2946 ""
2955 ;; range reference
2960 elements))))
2966 x
2974 x)
2976 elements
2979 ;;;###autoload
2981 "Set `org-table-formula-constants-local' in the current buffer."
2997 ;;;###autoload
2999 "Recalculate the current table line by applying all stored formulas.
3000 With prefix arg ALL, do this for all lines in the table.
3001 With the prefix argument ALL is `(16)' \
3003 it is the symbol `iterate', recompute the table until it no longer changes.
3004 If NOALIGN is not nil, do not re-align the table after the computations
3005 are done. This is typically used internally to save time, if it is
3006 known that the table will be realigned a little later anyway."
3021 seen-fields lhs1
3023 ;; Insert constants in all formulas
3041 eqlist))
3042 ;; Split the equation list
3048 ;; Expand ranges in lhs of formulas
3051 ;; Get the correct line range to process
3057 ;; This is a table with marked lines, compute selected lines
3059 ;; Move forward to the first non-header line
3070 ;; First find the named fields, and mark them untouchable.
3071 ;; Also check if several field/range formulas try to set the same field.
3090 name)))
3100 ;; Now evaluate the column formulas, but skip fields covered by
3101 ;; field formulas
3105 ;; Unprotected line, recalculate
3117 ;; Now evaluate the field formulas
3131 ;; back to initial position
3138 ;;;###autoload
3140 "Recalculate the table until it does not change anymore.
3141 The maximum number of iterations is 10, but you can choose a different value
3142 with the prefix ARG."
3147 thistbl)
3161 ;;;###autoload
3163 "Recalculate all tables in the current buffer."
3170 ;;;###autoload
3172 "Iterate all tables in the buffer, to converge inter-table dependencies."
3177 c1)
3193 "Apply the #+TBLFM in the line at point to the table."
3199 s e)
3201 ;; Insert a temporary formula at right after the table
3206 ;; Recalculate the table
3212 ;; delete the formula inserted temporarily
3216 "Find the beginning of the TBLFM lines and return its position.
3217 Return nil when the beginning of TBLFM line was not found."
3221 org-table-TBLFM-begin-regexp
3222 nil t))
3226 "Expand list of formulas.
3227 If some of the RHS in the formulas are ranges or a row reference, expand
3228 them to individual field equations for each field."
3234 ;; This just refers to one fixed field
3237 ;; This just refers to one fixed named field
3259 "Replace @<, @>, $<, $> with first/last row/column of the table.
3260 So @< and $< will always be replaced with @1 and $1, respectively.
3261 The advantage of these special markers are that structure editing of
3262 the table will not change them, while @1 and $1 will be modified
3263 when a line/row is swapped out of that privileged position. So for
3264 formulas that use a range of rows or columns, it may often be better
3266 borders of the table using the @< @> $< $> makers."
3269 s start)
3274 org-table-current-ncol)
3278 len
3285 s)
3288 "Replace $const with values in string F."
3290 ;; First, check for column names
3295 ;; Parameters and constants
3297 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3307 f))
3310 "Find the value for a parameter or constant in a formula.
3311 Parameters get priority."
3342 map))
3349 "--"
3352 "--"
3353 "Shift Reference at Point"
3358 "-"
3359 "Change Test Row for Column Formulas"
3362 "--"
3367 org-table-overlay-coordinates)]
3368 "--"
3374 ;;;###autoload
3376 "Edit the formulas of the current table in a separate buffer."
3378 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3392 entry s type title)
3395 ;; Keep global-font-lock-mode from turning on font-lock-mode
3436 "Convert a formula from internal to user representation."
3439 s))
3442 "Convert a formula from user to internal representation."
3445 s))
3448 "Convert spreadsheet references from A7 to @7$28.
3449 Works for single references, but also for entire formulas and even the
3450 full TBLFM line."
3452 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3455 ;; format match, just advance
3460 ;; 3.e5 or something like this.
3463 ;; (member (match-string 1 s)
3464 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3465 )
3466 ;; function name, just advance
3476 t t s)))))
3477 s))
3480 "Convert spreadsheet references from to @7$28 to AB7.
3481 Works for single references, but also for entire formulas and even the
3482 full TBLFM line."
3489 t t s)))
3494 t nil s)))
3495 s)
3498 "Convert a base 26 number represented by letters into an integer.
3499 For example: AB -> 28."
3505 n))
3508 "Convert an integer into a base 26 number represented by letters.
3509 For example: 28 -> AB."
3514 s))
3517 "Convert a time string into numerical duration in seconds.
3518 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3519 If S is a string representing a number, keep this number."
3521 s
3544 "Convert a number of seconds to a time string.
3545 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3546 minutes or seconds."
3561 "Convert all references in this buffer, using FUNCTION."
3571 "Convert all references in the buffer from B3 to @3$2 and back."
3581 "Shift the reference at point one row/hline up."
3585 "Shift the reference at point one row/hline down."
3589 "Shift the reference at point one field to the left."
3593 "Shift the reference at point one field to the right."
3604 ;; A B3-like reference
3610 ;; An internal reference
3616 "Re-match the group N, and replace it with the shifted reference."
3621 t t)))
3624 "Shift a reference part REF.
3625 If DECR is set, decrease the references row/column, else increase.
3626 If HLINE is set, this may be a hline reference, it certainly is not
3627 a translation reference."
3656 "Toggle the display of coordinates in the referenced table."
3665 "Parse the buffer for formula definitions and install them.
3666 With prefix ARG, apply the new formulas to the table."
3676 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3677 nil t)
3701 "Abort editing formulas, without installing the changes."
3712 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3753 "Show the location/value of the $ expression at point."
3762 var name e what match dest)
3767 "$1.."
3850 ;; column number
3878 org-table-fedit-scroll-down))))
3889 "Make sure the cursor is in a dataline in a table."
3898 p1 p2)))
3903 "Move cursor one line up in the window showing the table."
3908 "Move cursor one line down in the window showing the table."
3913 "Move the cursor in the window showing the table.
3914 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3939 "Add a new overlay."
3945 "Highlight rectangular region in a table."
3949 l1 c1 l2 c2 tmp)
3973 "Remove the rectangle overlays."
3984 "Add overlays to the table at point, to show row/column coordinates."
4012 ;;;###autoload
4014 "Toggle the display of Row/Column numbers in tables."
4025 ;;;###autoload
4027 "Toggle the formula debugger in tables."
4033 ;;; The orgtbl minor mode
4035 ;; Define a minor mode which can be used in other modes in order to
4036 ;; integrate the org-mode table editor.
4038 ;; This is really a hack, because the org-mode table editor uses several
4039 ;; keys which normally belong to the major mode, for example the TAB and
4040 ;; RET keys. Here is how it works: The minor mode defines all the keys
4041 ;; necessary to operate the table editor, but wraps the commands into a
4042 ;; function which tests if the cursor is currently inside a table. If that
4043 ;; is the case, the table editor command is executed. However, when any of
4044 ;; those keys is used outside a table, the function uses `key-binding' to
4045 ;; look up if the key has an associated command in another currently active
4046 ;; keymap (minor modes, major mode, global), and executes that command.
4047 ;; There might be problems if any of the keys used by the table editor is
4048 ;; otherwise used as a prefix key.
4050 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4051 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4052 ;; addresses this by checking explicitly for both bindings.
4054 ;; The optimized version (see variable `orgtbl-optimized') takes over
4055 ;; all keys which are bound to `self-insert-command' in the *global map*.
4056 ;; Some modes bind other commands to simple characters, for example
4057 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4058 ;; active, this binding is ignored inside tables and replaced with a
4059 ;; modified self-insert.
4077 ;; Install it as a minor mode.
4081 ;;;###autoload
4083 "The `org-mode' table editor as a minor mode for use in other modes."
4088 ;; Exit without error, in case some hook functions calls this
4089 ;; by accident in org-mode.
4093 ;; Make sure we are first in minor-mode-map-alist
4095 ;; FIXME: maybe it should use emulation-mode-map-alists?
4102 auto-fill-inhibit-regexp)
4106 auto-fill-inhibit-regexp)
4107 orgtbl-line-start-regexp))
4125 "Remove all properties related to narrow-column invisibility."
4138 "Create a function for binding in the table minor mode.
4139 FUN is the command to call inside a table. N is used to create a unique
4140 command name. KEYS are keys that should be checked in for a command
4141 to execute outside of tables."
4147 "Outside of tables, run the binding of `"
4159 keys)
4163 "Error when there is no default binding for a table key."
4168 "Setup orgtbl keymaps."
4199 elt key fun cmd)
4207 ;; Special treatment needed for TAB and RET
4227 [(tab)] "\C-i")))
4229 (org-defkey orgtbl-mode-map [backtab]
4231 [backtab] [S-iso-lefttab] [(shift tab)]
4232 [(tab)] "\C-i"))
4234 (org-defkey orgtbl-mode-map "\M-\C-m"
4235 (orgtbl-make-binding 'org-table-wrap-region 105
4236 "\M-\C-m" [(meta return)]))
4237 (org-defkey orgtbl-mode-map [(meta return)]
4238 (orgtbl-make-binding 'org-table-wrap-region 106
4239 [(meta return)] "\M-\C-m"))
4241 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4242 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4244 (when orgtbl-optimized
4245 ;; If the user wants maximum table support, we need to hijack
4246 ;; some standard editing functions
4247 (org-remap orgtbl-mode-map
4248 'self-insert-command 'orgtbl-self-insert-command
4249 'delete-char 'org-delete-char
4250 'delete-backward-char 'org-delete-backward-char)
4251 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4252 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4253 '("OrgTbl"
4254 ["Create or convert" org-table-create-or-convert-from-region
4255 :active (not (org-at-table-p)) :keys "C-c |" ]
4256 "--"
4257 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4258 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4259 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4260 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4261 "--"
4262 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4263 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4264 ["Copy Field from Above"
4265 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4266 "--"
4267 ("Column"
4268 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4269 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4270 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4271 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4272 ("Row"
4273 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4274 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4275 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4276 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4277 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4278 "--"
4279 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4280 ("Rectangle"
4281 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4282 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4283 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4284 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4285 "--"
4286 ("Radio tables"
4287 ["Insert table template" orgtbl-insert-radio-table
4288 (assq major-mode orgtbl-radio-table-templates)]
4289 ["Comment/uncomment table" orgtbl-toggle-comment t])
4290 "--"
4291 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4292 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4293 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4294 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4295 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4296 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4297 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4298 ["Sum Column/Rectangle" org-table-sum
4299 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4300 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4301 ["Debug Formulas"
4302 org-table-toggle-formula-debugger :active (org-at-table-p)
4303 :keys "C-c {"
4304 :style toggle :selected org-table-formula-debug]
4305 ["Show Col/Row Numbers"
4306 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4307 :keys "C-c }"
4308 :style toggle :selected org-table-overlay-coordinates]
4309 ))
4310 t))
4312 (defun orgtbl-ctrl-c-ctrl-c (arg)
4313 "If the cursor is inside a table, realign the table.
4314 If it is a table to be sent away to a receiver, do it.
4315 With prefix arg, also recompute table."
4316 (interactive "P")
4317 (let ((case-fold-search t) (pos (point)) action)
4318 (save-excursion
4319 (beginning-of-line 1)
4320 (setq action (cond
4324 (cond
4325 ((integerp action)
4326 (goto-char action)
4327 (org-table-maybe-eval-formula)
4328 (if arg
4329 (call-interactively 'org-table-recalculate)
4330 (org-table-maybe-recalculate-line))
4331 (call-interactively 'org-table-align)
4332 (when (orgtbl-send-table 'maybe)
4333 (run-hooks 'orgtbl-after-send-table-hook)))
4334 ((eq action 'recalc)
4335 (org-table-set-constants)
4336 (save-excursion
4337 (beginning-of-line 1)
4339 (if (org-at-table-p)
4340 (org-call-with-arg 'org-table-recalculate t))))
4341 (t (let (orgtbl-mode)
4342 (call-interactively (key-binding "\C-c\C-c")))))))
4344 (defun orgtbl-create-or-convert-from-region (arg)
4345 "Create table or convert region to table, if no conflicting binding.
4346 This installs the table binding `C-c |', but only if there is no
4347 conflicting binding to this key outside orgtbl-mode."
4348 (interactive "P")
4349 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4350 (if cmd
4351 (call-interactively cmd)
4352 (call-interactively 'org-table-create-or-convert-from-region))))
4354 (defun orgtbl-tab (arg)
4355 "Justification and field motion for `orgtbl-mode'."
4356 (interactive "P")
4357 (if arg (org-table-edit-field t)
4358 (org-table-justify-field-maybe)
4359 (org-table-next-field)))
4361 (defun orgtbl-ret ()
4362 "Justification and field motion for `orgtbl-mode'."
4363 (interactive)
4364 (if (bobp)
4365 (newline)
4366 (org-table-justify-field-maybe)
4367 (org-table-next-row)))
4369 (defun orgtbl-self-insert-command (N)
4370 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4371 If the cursor is in a table looking at whitespace, the whitespace is
4372 overwritten, and the table is not marked as requiring realignment."
4373 (interactive "p")
4374 (if (and (org-at-table-p)
4375 (or
4376 (and org-table-auto-blank-field
4377 (member last-command
4378 '(orgtbl-hijacker-command-100
4379 orgtbl-hijacker-command-101
4380 orgtbl-hijacker-command-102
4381 orgtbl-hijacker-command-103
4382 orgtbl-hijacker-command-104
4383 orgtbl-hijacker-command-105
4384 yas/expand))
4385 (org-table-blank-field))
4386 t)
4387 (eq N 1)
4389 (let (org-table-may-need-update)
4390 (goto-char (1- (match-end 0)))
4391 (org-delete-backward-char 1)
4392 (goto-char (match-beginning 0))
4393 (self-insert-command N))
4394 (setq org-table-may-need-update t)
4395 (let* (orgtbl-mode
4396 a
4397 (cmd (or (key-binding
4398 (or (and (listp function-key-map)
4399 (setq a (assoc last-input-event function-key-map))
4400 (cdr a))
4401 (vector last-input-event)))
4402 'self-insert-command)))
4403 (call-interactively cmd)
4404 (if (and org-self-insert-cluster-for-undo
4405 (eq cmd 'self-insert-command))
4406 (if (not (eq last-command 'orgtbl-self-insert-command))
4407 (setq org-self-insert-command-undo-counter 1)
4408 (if (>= org-self-insert-command-undo-counter 20)
4409 (setq org-self-insert-command-undo-counter 1)
4410 (and (> org-self-insert-command-undo-counter 0)
4411 buffer-undo-list
4412 (not (cadr buffer-undo-list)) ; remove nil entry
4413 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4414 (setq org-self-insert-command-undo-counter
4415 (1+ org-self-insert-command-undo-counter))))))))
4418 "Regular expression matching exponentials as produced by calc.")
4420 (defun orgtbl-gather-send-defs ()
4421 "Gather a plist of :name, :transform, :params for each destination before
4422 a radio table."
4423 (save-excursion
4424 (goto-char (org-table-begin))
4425 (let (rtn)
4426 (beginning-of-line 0)
4427 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4428 (let ((name (org-no-properties (match-string 1)))
4429 (transform (intern (match-string 2)))
4430 (params (if (match-end 3)
4431 (read (concat "(" (match-string 3) ")")))))
4432 (push (list :name name :transform transform :params params)
4433 rtn)
4434 (beginning-of-line 0)))
4435 rtn)))
4437 (defun orgtbl-send-replace-tbl (name txt)
4438 "Find and replace table NAME with TXT."
4439 (save-excursion
4440 (goto-char (point-min))
4441 (unless (re-search-forward
4443 (user-error "Don't know where to insert translated table"))
4444 (goto-char (match-beginning 0))
4445 (beginning-of-line 2)
4446 (save-excursion
4447 (let ((beg (point)))
4448 (unless (re-search-forward
4449 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4450 (user-error "Cannot find end of insertion region"))
4451 (beginning-of-line 1)
4452 (delete-region beg (point))))
4455 ;;;###autoload
4456 (defun org-table-to-lisp (&optional txt)
4457 "Convert the table at point to a Lisp structure.
4458 The structure will be a list. Each item is either the symbol `hline'
4459 for a horizontal separator line, or a list of field values as strings.
4460 The table is taken from the parameter TXT, or from the buffer at point."
4461 (unless txt
4462 (unless (org-at-table-p)
4463 (user-error "No table at point")))
4464 (let* ((txt (or txt
4465 (buffer-substring-no-properties (org-table-begin)
4466 (org-table-end))))
4469 (mapcar
4470 (lambda (x)
4471 (if (string-match org-table-hline-regexp x)
4472 'hline
4474 lines)))
4476 (defun orgtbl-send-table (&optional maybe)
4477 "Send a transformed version of this table to the receiver position.
4478 With argument MAYBE, fail quietly if no transformation is defined for
4479 this table."
4480 (interactive)
4481 (catch 'exit
4482 (unless (org-at-table-p) (user-error "Not at a table"))
4483 ;; when non-interactive, we assume align has just happened.
4484 (when (org-called-interactively-p 'any) (org-table-align))
4485 (let ((dests (orgtbl-gather-send-defs))
4486 (txt (buffer-substring-no-properties (org-table-begin)
4487 (org-table-end)))
4488 (ntbl 0))
4489 (unless dests (if maybe (throw 'exit nil)
4490 (user-error "Don't know how to transform this table")))
4491 (dolist (dest dests)
4492 (let* ((name (plist-get dest :name))
4493 (transform (plist-get dest :transform))
4494 (params (plist-get dest :params))
4495 (skip (plist-get params :skip))
4496 (skipcols (plist-get params :skipcols))
4497 (no-escape (plist-get params :no-escape))
4498 beg
4499 (lines (org-table-clean-before-export
4500 (nthcdr (or skip 0)
4502 (i0 (if org-table-clean-did-remove-column 2 1))
4503 (lines (if no-escape lines
4504 (mapcar (lambda(l) (replace-regexp-in-string
4506 (table (mapcar
4507 (lambda (x)
4508 (if (string-match org-table-hline-regexp x)
4509 'hline
4510 (org-remove-by-index
4512 skipcols i0)))
4513 lines))
4514 (fun (if (= i0 2) 'cdr 'identity))
4515 (org-table-last-alignment
4516 (org-remove-by-index (funcall fun org-table-last-alignment)
4517 skipcols i0))
4518 (org-table-last-column-widths
4519 (org-remove-by-index (funcall fun org-table-last-column-widths)
4520 skipcols i0))
4521 (txt (if (fboundp transform)
4522 (funcall transform table params)
4523 (user-error "No such transformation function %s" transform))))
4524 (orgtbl-send-replace-tbl name txt))
4525 (setq ntbl (1+ ntbl)))
4526 (message "Table converted and installed at %d receiver location%s"
4527 ntbl (if (> ntbl 1) "s" ""))
4528 (if (> ntbl 0)
4529 ntbl
4530 nil))))
4532 (defun org-remove-by-index (list indices &optional i0)
4533 "Remove the elements in LIST with indices in INDICES.
4534 First element has index 0, or I0 if given."
4535 (if (not indices)
4536 list
4537 (if (integerp indices) (setq indices (list indices)))
4538 (setq i0 (1- (or i0 0)))
4539 (delq :rm (mapcar (lambda (x)
4540 (setq i0 (1+ i0))
4541 (if (memq i0 indices) :rm x))
4542 list))))
4544 (defun orgtbl-toggle-comment ()
4545 "Comment or uncomment the orgtbl at point."
4546 (interactive)
4547 (let* ((case-fold-search t)
4548 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4549 (re2 (concat "^" orgtbl-line-start-regexp))
4550 (commented (save-excursion (beginning-of-line 1)
4551 (cond ((looking-at re1) t)
4552 ((looking-at re2) nil)
4553 (t (user-error "Not at an org table")))))
4554 (re (if commented re1 re2))
4555 beg end)
4556 (save-excursion
4557 (beginning-of-line 1)
4558 (while (looking-at re) (beginning-of-line 0))
4559 (beginning-of-line 2)
4560 (setq beg (point))
4561 (while (looking-at re) (beginning-of-line 2))
4562 (setq end (point)))
4563 (comment-region beg end (if commented '(4) nil))))
4565 (defun orgtbl-insert-radio-table ()
4566 "Insert a radio table template appropriate for this major mode."
4567 (interactive)
4568 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4569 (txt (nth 1 e))
4570 name pos)
4571 (unless e (user-error "No radio table setup defined for %s" major-mode))
4572 (setq name (read-string "Table name: "))
4573 (while (string-match "%n" txt)
4574 (setq txt (replace-match name t t txt)))
4576 (setq pos (point))
4577 (insert txt)
4578 (goto-char pos)))
4580 ;; Dynamically bound input and output for table formatting.
4581 (defvar *orgtbl-table* nil
4582 "Carries the current table through formatting routines.")
4583 (defvar *orgtbl-rtn* nil
4584 "Formatting routines push the output lines here.")
4585 ;; Formatting parameters for the current table section.
4586 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4587 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4588 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4589 (defvar *orgtbl-fmt* nil "Format for each entry.")
4590 (defvar *orgtbl-efmt* nil "Format for numbers.")
4591 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4592 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4593 (defvar *orgtbl-lstart* nil "Text starting a row.")
4594 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4595 (defvar *orgtbl-lend* nil "Text ending a row.")
4596 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4598 (defsubst orgtbl-get-fmt (fmt i)
4599 "Retrieve the format from FMT corresponding to the Ith column."
4600 (if (and (not (functionp fmt)) (consp fmt))
4601 (plist-get fmt i)
4602 fmt))
4604 (defsubst orgtbl-apply-fmt (fmt &rest args)
4605 "Apply format FMT to arguments ARGS.
4606 When FMT is nil, return the first argument from ARGS."
4607 (cond ((functionp fmt) (apply fmt args))
4608 (fmt (apply 'format fmt args))
4609 (args (car args))
4610 (t args)))
4612 (defsubst orgtbl-eval-str (str)
4613 "If STR is a function, evaluate it with no arguments."
4614 (if (functionp str)
4615 (funcall str)
4616 str))
4618 (defun orgtbl-format-line (line)
4619 "Format LINE as a table row."
4620 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4621 (let* ((i 0)
4622 (line
4623 (mapcar
4624 (lambda (f)
4625 (setq i (1+ i))
4626 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4627 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4628 (orgtbl-apply-fmt efmt (match-string 1 f)
4629 (match-string 2 f))
4630 f)))
4631 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4632 *orgtbl-default-fmt*)
4633 f)))
4634 line)))
4635 (push (if *orgtbl-lfmt*
4636 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4637 (concat (orgtbl-eval-str *orgtbl-lstart*)
4638 (mapconcat 'identity line *orgtbl-sep*)
4639 (orgtbl-eval-str *orgtbl-lend*)))
4640 *orgtbl-rtn*))))
4642 (defun orgtbl-format-section (section-stopper)
4643 "Format lines until the first occurrence of SECTION-STOPPER."
4644 (let (prevline)
4645 (progn
4646 (while (not (eq (car *orgtbl-table*) section-stopper))
4647 (if prevline (orgtbl-format-line prevline))
4648 (setq prevline (pop *orgtbl-table*)))
4649 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4650 (*orgtbl-lend* *orgtbl-llend*)
4651 (*orgtbl-lfmt* *orgtbl-llfmt*))
4652 (orgtbl-format-line prevline))))))
4654 ;;;###autoload
4655 (defun orgtbl-to-generic (table params &optional backend)
4656 "Convert the orgtbl-mode TABLE to some other format.
4657 This generic routine can be used for many standard cases.
4658 TABLE is a list, each entry either the symbol `hline' for a horizontal
4659 separator line, or a list of fields for that line.
4660 PARAMS is a property list of parameters that can influence the conversion.
4661 A third optional argument BACKEND can be used to convert the content of
4662 the cells using a specific export back-end.
4664 For the generic converter, some parameters are obligatory: you need to
4665 specify either :lfmt, or all of (:lstart :lend :sep).
4667 Valid parameters are:
4669 :splice When set to t, return only table body lines, don't wrap
4670 them into :tstart and :tend. Default is nil. When :splice
4671 is non-nil, this also means that the exporter should not look
4672 for and interpret header and footer sections.
4674 :hline String to be inserted on horizontal separation lines.
4675 May be nil to ignore hlines.
4677 :sep Separator between two fields
4678 :remove-nil-lines Do not include lines that evaluate to nil.
4680 Each in the following group may be either a string or a function
4681 of no arguments returning a string:
4683 :tstart String to start the table. Ignored when :splice is t.
4684 :tend String to end the table. Ignored when :splice is t.
4685 :lstart String to start a new table line.
4686 :llstart String to start the last table line, defaults to :lstart.
4687 :lend String to end a table line
4688 :llend String to end the last table line, defaults to :lend.
4690 Each in the following group may be a string, a function of one
4691 argument (the field or line) returning a string, or a plist
4692 mapping columns to either of the above:
4694 :lfmt Format for entire line, with enough %s to capture all fields.
4695 If this is present, :lstart, :lend, and :sep are ignored.
4696 :llfmt Format for the entire last line, defaults to :lfmt.
4697 :fmt A format to be used to wrap the field, should contain
4698 %s for the original field value. For example, to wrap
4700 This may also be a property list with column numbers and
4702 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4703 Same as above, specific for the header lines in the table.
4704 All lines before the first hline are treated as header.
4705 If any of these is not present, the data line value is used.
4707 This may be either a string or a function of two arguments:
4709 :efmt Use this format to print numbers with exponentials.
4710 The format should have %s twice for inserting mantissa
4712 may also be a property list with column numbers and
4713 formats. :fmt will still be applied after :efmt.
4715 In addition to this, the parameters :skip and :skipcols are always handled
4716 directly by `orgtbl-send-table'. See manual."
4717 (let* ((splicep (plist-get params :splice))
4718 (hline (plist-get params :hline))
4719 (skipheadrule (plist-get params :skipheadrule))
4720 (remove-nil-linesp (plist-get params :remove-nil-lines))
4721 (remove-newlines (plist-get params :remove-newlines))
4722 (*orgtbl-hline* hline)
4723 (*orgtbl-table* table)
4724 (*orgtbl-sep* (plist-get params :sep))
4725 (*orgtbl-efmt* (plist-get params :efmt))
4726 (*orgtbl-lstart* (plist-get params :lstart))
4727 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4728 (*orgtbl-lend* (plist-get params :lend))
4729 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4730 (*orgtbl-lfmt* (plist-get params :lfmt))
4731 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4732 (*orgtbl-fmt* (plist-get params :fmt))
4733 *orgtbl-rtn*)
4734 ;; Convert cells content to backend BACKEND
4735 (when backend
4736 (setq *orgtbl-table*
4737 (mapcar
4738 (lambda(r)
4739 (if (listp r)
4740 (mapcar
4741 (lambda (c)
4742 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4743 r)
4744 r))
4745 *orgtbl-table*)))
4746 ;; Put header
4747 (unless splicep
4748 (when (plist-member params :tstart)
4749 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4750 (if tstart (push tstart *orgtbl-rtn*)))))
4751 ;; If we have a heading, format it and handle the trailing hline.
4752 (if (and (not splicep)
4753 (or (consp (car *orgtbl-table*))
4754 (consp (nth 1 *orgtbl-table*)))
4755 (memq 'hline (cdr *orgtbl-table*)))
4756 (progn
4757 (when (eq 'hline (car *orgtbl-table*))
4758 ;; There is a hline before the first data line
4759 (and hline (push hline *orgtbl-rtn*))
4760 (pop *orgtbl-table*))
4761 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4762 *orgtbl-lstart*))
4763 (*orgtbl-llstart* (or (plist-get params :hllstart)
4764 *orgtbl-llstart*))
4765 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4766 (*orgtbl-llend* (or (plist-get params :hllend)
4767 (plist-get params :hlend) *orgtbl-llend*))
4768 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4769 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4770 (plist-get params :hlfmt) *orgtbl-llfmt*))
4771 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4772 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4773 (orgtbl-format-section 'hline))
4774 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4775 (pop *orgtbl-table*)))
4776 ;; Now format the main section.
4777 (orgtbl-format-section nil)
4778 (unless splicep
4779 (when (plist-member params :tend)
4780 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4781 (if tend (push tend *orgtbl-rtn*)))))
4782 (mapconcat (if remove-newlines
4783 (lambda (tend)
4785 'identity)
4786 (nreverse (if remove-nil-linesp
4787 (remq nil *orgtbl-rtn*)
4790 ;;;###autoload
4791 (defun orgtbl-to-tsv (table params)
4792 "Convert the orgtbl-mode table to TAB separated material."
4794 ;;;###autoload
4795 (defun orgtbl-to-csv (table params)
4796 "Convert the orgtbl-mode table to CSV material.
4797 This does take care of the proper quoting of fields with comma or quotes."
4798 (orgtbl-to-generic table (org-combine-plists
4799 '(:sep "," :fmt org-quote-csv-field)
4800 params)))
4802 ;;;###autoload
4803 (defun orgtbl-to-latex (table params)
4804 "Convert the orgtbl-mode TABLE to LaTeX.
4805 TABLE is a list, each entry either the symbol `hline' for a horizontal
4806 separator line, or a list of fields for that line.
4807 PARAMS is a property list of parameters that can influence the conversion.
4808 Supports all parameters from `orgtbl-to-generic'. Most important for
4809 LaTeX are:
4811 :splice When set to t, return only table body lines, don't wrap
4812 them into a tabular environment. Default is nil.
4814 :fmt A format to be used to wrap the field, should contain %s for the
4815 original field value. For example, to wrap everything in dollars,
4818 The format may also be a function that formats its one argument.
4820 :efmt Format for transforming numbers with exponentials. The format
4821 should have %s twice for inserting mantissa and exponent, for
4823 This may also be a property list with column numbers and formats.
4824 The format may also be a function that formats its two arguments.
4826 :llend If you find too much space below the last line of a table,
4829 The general parameters :skip and :skipcols have already been applied when
4830 this function is called."
4831 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4832 org-table-last-alignment ""))
4833 (params2
4834 (list
4839 (require 'ox-latex)
4840 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4842 ;;;###autoload
4843 (defun orgtbl-to-html (table params)
4844 "Convert the orgtbl-mode TABLE to HTML.
4845 TABLE is a list, each entry either the symbol `hline' for a horizontal
4846 separator line, or a list of fields for that line.
4847 PARAMS is a property list of parameters that can influence the conversion.
4848 Currently this function recognizes the following parameters:
4850 :splice When set to t, return only table body lines, don't wrap
4851 them into a <table> environment. Default is nil.
4853 The general parameters :skip and :skipcols have already been applied when
4854 this function is called. The function does *not* use `orgtbl-to-generic',
4855 so you cannot specify parameters for it."
4856 (require 'ox-html)
4857 (let ((output (org-export-string-as
4858 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4859 (if (not (plist-get params :splice)) output
4860 (org-trim
4861 (replace-regexp-in-string
4865 ;;;###autoload
4866 (defun orgtbl-to-texinfo (table params)
4867 "Convert the orgtbl-mode TABLE to TeXInfo.
4868 TABLE is a list, each entry either the symbol `hline' for a horizontal
4869 separator line, or a list of fields for that line.
4870 PARAMS is a property list of parameters that can influence the conversion.
4871 Supports all parameters from `orgtbl-to-generic'. Most important for
4872 TeXInfo are:
4874 :splice nil/t When set to t, return only table body lines, don't wrap
4875 them into a multitable environment. Default is nil.
4877 :fmt fmt A format to be used to wrap the field, should contain
4878 %s for the original field value. For example, to wrap
4880 This may also be a property list with column numbers and
4882 Each format also may be a function that formats its one
4883 argument.
4886 are computed automatically from the width of the columns
4887 under org-mode.
4889 The general parameters :skip and :skipcols have already been applied when
4890 this function is called."
4891 (let* ((total (float (apply '+ org-table-last-column-widths)))
4892 (colfrac (or (plist-get params :cf)
4893 (mapconcat
4894 (lambda (x) (format "%.3f" (/ (float x) total)))
4895 org-table-last-column-widths " ")))
4896 (params2
4897 (list
4898 :tstart (concat "@multitable @columnfractions " colfrac)
4899 :tend "@end multitable"
4900 :lstart "@item " :lend "" :sep " @tab "
4901 :hlstart "@headitem ")))
4902 (require 'ox-texinfo)
4903 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4905 ;;;###autoload
4906 (defun orgtbl-to-orgtbl (table params)
4907 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4908 Useful when slicing one table into many. The :hline, :sep,
4909 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4910 and :tend suppress strings without splicing; they can be set to
4911 provide ORGTBL directives for the generated table."
4912 (let* ((params2
4913 (list
4914 :remove-newlines t
4915 :tstart nil :tend nil
4916 :hline "|---"
4917 :sep " | "
4918 :lstart "| "
4919 :lend " |"))
4920 (params (org-combine-plists params2 params)))
4921 (with-temp-buffer
4922 (insert (orgtbl-to-generic table params))
4923 (goto-char (point-min))
4924 (while (re-search-forward org-table-hline-regexp nil t)
4925 (org-table-align))
4926 (buffer-substring 1 (buffer-size)))))
4928 (defun orgtbl-to-table.el (table params)
4929 "Convert the orgtbl-mode TABLE into a table.el table."
4930 (with-temp-buffer
4931 (insert (orgtbl-to-orgtbl table params))
4932 (org-table-align)
4933 (replace-regexp-in-string
4934 "-|" "-+"
4935 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4937 (defun orgtbl-to-unicode (table params)
4938 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4939 You need the ascii-art-to-unicode.el package for this. You can download
4940 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4941 (with-temp-buffer
4942 (insert (orgtbl-to-table.el table params))
4943 (goto-char (point-min))
4944 (if (or (featurep 'ascii-art-to-unicode)
4945 (require 'ascii-art-to-unicode nil t))
4946 (aa2u)
4947 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4948 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4949 "Link to ascii-art-to-unicode.el") org-stored-links))
4950 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4951 (buffer-string)))
4953 (defun org-table-get-remote-range (name-or-id form)
4954 "Get a field value or a list of values in a range from table at ID.
4956 NAME-OR-ID may be the name of a table in the current file as set
4958 will then be used. Alternatively, it may be an ID referring to
4959 any entry, also in a different file. In this case, the first
4960 table in that entry will be referenced.
4964 The return value is either a single string for a single field, or a
4965 list of the fields in the rectangle."
4966 (save-match-data
4967 (let ((case-fold-search t) (id-loc nil)
4968 ;; Protect a bunch of variables from being overwritten
4969 ;; by the context of the remote table
4970 org-table-column-names org-table-column-name-regexp
4971 org-table-local-parameters org-table-named-field-locations
4972 org-table-current-line-types org-table-current-begin-line
4973 org-table-current-begin-pos org-table-dlines
4974 org-table-current-ncol
4975 org-table-hlines org-table-last-alignment
4976 org-table-last-column-widths org-table-last-alignment
4977 org-table-last-column-widths tbeg
4978 buffer loc)
4979 (setq form (org-table-convert-refs-to-rc form))
4980 (save-excursion
4981 (save-restriction
4982 (widen)
4983 (save-excursion
4984 (goto-char (point-min))
4985 (if (re-search-forward
4988 nil t)
4989 (setq buffer (current-buffer) loc (match-beginning 0))
4990 (setq id-loc (org-id-find name-or-id 'marker))
4991 (unless (and id-loc (markerp id-loc))
4993 (setq buffer (marker-buffer id-loc)
4994 loc (marker-position id-loc))
4995 (move-marker id-loc nil)))
4996 (with-current-buffer buffer
4997 (save-excursion
4998 (save-restriction
4999 (widen)
5000 (goto-char loc)
5001 (forward-char 1)
5003 (not (match-beginning 1)))
5004 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5005 (setq tbeg (point-at-bol))
5006 (org-table-get-specials)
5007 (setq form (org-table-formula-substitute-names
5008 (org-table-formula-handle-first/last-rc form)))
5009 (if (and (string-match org-table-range-regexp form)
5010 (> (length (match-string 0 form)) 1))
5011 (save-match-data
5012 (org-table-get-range (match-string 0 form) tbeg 1))
5013 form)))))))))
5015 (defun org-table-remote-reference-indirection (form)
5016 "Return formula with table remote references substituted by indirection.
5018 This indirection works only with the format @ROW$COLUMN. The
5020 distinguished from a plain table name or ID."
5021 (let ((start 0))
5022 (while (string-match (concat
5023 ;; Same as in `org-table-eval-formula'.
5025 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5027 ;; Same as in `org-table-eval-formula'.
5029 form
5030 start)
5031 ;; The position of the character as far as possible to the right
5032 ;; that will not be replaced and particularly not be shifted by
5033 ;; `replace-match'.
5034 (setq start (match-beginning 1))
5035 ;; Substitute the remote reference with the value found in the
5036 ;; field.
5037 (setq form
5038 (replace-match
5039 (save-match-data
5040 (org-table-get-range (org-table-formula-handle-first/last-rc
5041 (match-string 1 form))))
5042 t t form 1))))
5043 form)
5045 (defmacro org-define-lookup-function (mode)
5046 (let ((mode-str (symbol-name mode))
5047 (first-p (equal mode 'first))
5048 (all-p (equal mode 'all)))
5049 (let ((plural-str (if all-p "s" "")))
5050 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5051 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5052 If R-LIST is nil, return matching element%s of S-LIST.
5053 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5054 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5055 This function is generated by a call to the macro `org-define-lookup-function'."
5056 mode-str plural-str plural-str plural-str)
5057 (let ,(let ((lvars '((p (or predicate 'equal))
5058 (sl s-list)
5059 (rl (or r-list s-list))
5060 (ret nil))))
5061 (if first-p (add-to-list 'lvars '(match-p nil)))
5062 lvars)
5063 (while ,(if first-p '(and (not match-p) sl) 'sl)
5064 (progn
5065 (if (funcall p val (car sl))
5066 (progn
5067 ,(if first-p '(setq match-p t))
5068 (let ((rval (car rl)))
5069 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5070 (setq sl (cdr sl) rl (cdr rl))))
5071 ret)))))
5073 (org-define-lookup-function first)
5074 (org-define-lookup-function last)
5075 (org-define-lookup-function all)
5077 (provide 'org-table)
5079 ;; Local variables:
5080 ;; generated-autoload-file: "org-loaddefs.el"
5081 ;; End:
5083 ;;; org-table.el ends here