| blob | 6a7935e16dda21db3318c9564e936f7836a4d69e |
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:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, otherwise, if table is not sent, the functions
60 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
61 In the optimized version, the table editor takes over all simple keys that
62 normally just insert a character. In tables, the characters are inserted
63 in a way to minimize disturbing the table structure (i.e. in overwrite mode
64 for empty fields). Outside tables, the correct binding of the keys is
65 restored.
67 The default for this option is t if the optimized version is also used in
68 Org-mode. See the variable `org-enable-table-editor' for details. Changing
69 this variable requires a restart of Emacs to become effective."
75 % END RECEIVE ORGTBL %n
77 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
78 | | |
81 @c END RECEIVE ORGTBL %n
82 @ignore
83 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
84 | | |
87 <!-- END RECEIVE ORGTBL %n -->
88 <!--
89 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
90 | | |
93 #+ END RECEIVE ORGTBL %n
95 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
96 | | |
98 "Templates for radio tables in different major modes.
99 Each template must define lines that will be treated as a comment and that
102 insertion of the template. The transformed table will later be inserted
103 between these lines.
105 The template should also contain a minimal table in a multiline comment.
106 If multiline comments are not possible in the buffer language,
107 you can pack it into a string that will not be used when the code
108 is compiled or executed. Above the table will you need a line with
110 convert the table into a data structure useful in the
111 language of the buffer. Check the manual for the section on
113 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
115 All occurrences of %n in a template will be replaced with the name of the
116 table, obtained by prompting the user."
123 "Settings for tables in Org-mode."
128 "The default size for newly created tables, Columns x Rows."
133 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
134 "Regular expression for recognizing numbers in table columns.
135 If a table column contains mostly numbers, it will be aligned to the
136 right. If not, it will be aligned to the left.
138 The default value of this option is a regular expression which allows
139 anything which looks remotely like a number as used in scientific
140 context. For example, all of the following will be considered a
141 number:
142 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
144 Other options offered by the customize interface are more restrictive."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
159 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
160 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
164 "Fraction of numbers in a column required to make the column align right.
165 In a column all non-white fields are considered. If at least
166 this fraction of fields is matched by `org-table-number-regexp',
167 alignment to the right border applies."
172 "Behavior of tables during editing in Org-mode."
177 "Non-nil means automatically re-align table when pressing TAB or RETURN.
179 removal/insertion."
184 "Non-nil means automatically blank table field when starting to type into it.
185 This only happens when typing immediately after a field motion
186 command (TAB, S-TAB or RET).
187 Only relevant when `org-enable-table-editor' is equal to `optimized'."
192 "Non-nil means automatically exit the follow mode.
193 When nil, the follow mode will stay on and be active in any table
194 the cursor enters. Since the table follow filed mode messes with the
195 window configuration, it is not recommended to set this variable to nil,
196 except maybe locally in a special file that has mostly tables with long
197 fields."
203 "Whether the user should confirm when Org fixes formulas."
211 'safe-local-variable
215 "Non-nil means tab in the last column of a table with jump over a hline.
216 If a horizontal separator line is following the current line,
217 `org-table-next-field' can either create a new row before that line, or jump
218 over the line. When this option is nil, a new line will be created before
219 this line."
224 "Options concerning tables in Org-mode."
229 "Should org-mode work with table references like B3 instead of @3$2?
230 Possible values are:
231 nil never use them
232 from accept as input, do not present for editing
233 t accept as input and present for editing"
253 calc-angle-mode deg
254 calc-prefer-frac nil
255 calc-symbolic-mode nil
257 calc-display-working-message t
258 )
259 "List with Calc mode settings for use in `calc-eval' for table formulas.
260 The list must contain alternating symbols (Calc modes variables and values).
261 Don't remove any of the default settings, just change the values. Org-mode
262 relies on the variables to be present in the list."
267 "Format for the output of calc computations like $1+$2;t.
268 The default value is 'hours, and will output the results as a
269 number of hours. Other allowed values are 'seconds, 'minutes and
270 'days, and the output will be a fraction of seconds, minutes or
271 days."
280 "Format for fields which contain the result of a formula.
282 characters. Beware that modifying the display can prevent the
283 field from being used in another formula."
289 "Non-nil means TAB and RET evaluate a formula in current table field.
290 If the current field starts with an equal sign, it is assumed to be a formula
291 which should be evaluated as described in the manual and in the documentation
292 string of the command `org-table-eval-formula'. This feature requires the
293 Emacs calc package.
294 When this variable is nil, formula calculation is only available through
300 "Non-nil means interpret constants in formulas in tables.
301 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
302 by the value given in `org-table-formula-constants', or by a value obtained
303 from the `constants.el' package."
308 "Alist with constant names and values, for use in table formulas.
309 The car of each element is a name of a constant, without the `$' before it.
310 The cdr is the value as a string. For example, if you'd like to use the
311 speed of light in a formula, you would configure
315 and then use it in an equation like `$1*$c'.
317 Constants can also be defined on a per-file basis using a line like
319 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
326 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
327 Automatically means when TAB or RET or C-c C-c are pressed in the line."
332 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
337 "Non-nil means relative formula references may cross hlines.
338 Here are the allowed values:
340 nil Relative references may not cross hlines. They will reference the
341 field next to the hline instead. Coming from below, the reference
342 will be to the field below the hline. Coming from above, it will be
343 to the field above.
344 t Relative references may cross hlines.
345 error An attempt to cross a hline will throw an error.
347 It is probably good to never set this variable to nil, for the sake of
348 portability of tables."
356 "Options concerning table import and export in Org-mode."
361 "Default export parameters for `org-table-export'.
362 These can be overridden for a specific table by setting the
363 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
364 radio tables for the different export transformations and
365 available parameters."
403 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
404 ;; 1 2 3 4 5
415 "Is this a table line colgroup information?"
419 line)
421 nil
428 "Is this a table line with only alignment/width cookies?"
441 s))))
447 "Check if the table has a marking column.
448 If yes remove the column and the special lines."
461 lines))))
470 nil)
474 ;; remove the first column
477 lines))))
483 ;;;###autoload
485 "Use the table.el package to insert a new table.
486 If there is already a table at point, convert between Org-mode tables
487 and table.el tables."
500 ;;;###autoload
502 "Convert region to table, or create an empty table.
503 If there is an active region, convert it to a table, using the function
504 `org-table-convert-region'. See the documentation of that function
505 to learn how the prefix argument is interpreted to determine the field
506 separator.
507 If there is no such region, create an empty table with `org-table-create'."
513 ;;;###autoload
515 "Query for a size and insert a table skeleton.
535 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
539 ;; Insert a hline after the first row.
546 ;;;###autoload
548 "Convert region to a table.
549 The region goes from BEG0 to END0, but these borders will be moved
550 slightly, to make sure a beginning of line in the first line is included.
552 SEPARATOR specifies the field separator in the lines. It can have the
553 following values:
555 '(4) Use the comma as a field separator
556 '(16) Use a TAB as field separator
557 '(64) Prompt for a regular expression as field separator
558 integer When a number, use that many spaces as field separator
559 regexp When a regular expression, use it to match the separator
560 nil When nil, the command tries to be smart and figure out the
561 separator in the following way:
562 - when each line contains a TAB, assume TAB-separated material
563 - when each line contains a comma, assume CSV material
564 - else, assume one or more SPACE characters as separator."
568 re)
577 ;; Get the right field separator
588 ;; parse the csv stuff
613 ;;;###autoload
615 "Import FILE as a table.
616 The file is assumed to be tab-separated. Such files can be produced by most
617 spreadsheet and database applications. If no tabs (at least one per line)
618 are found, lines will be split on whitespace into fields."
629 ;;;###autoload
631 "Export table to a file, with configurable format.
632 Such a file can be imported into usual spreadsheet programs.
634 FILE can be the output file name. If not given, it will be taken
635 from a TABLE_EXPORT_FILE property in the current entry or higher
636 up in the hierarchy, or the user will be prompted for a file
637 name. FORMAT can be an export format, of the same kind as it
638 used when `orgtbl-mode' sends a table in a different format.
640 The command suggests a format depending on TABLE_EXPORT_FORMAT,
641 whether it is set locally or up in the hierarchy, then on the
642 extension of the given file name, and finally on the variable
643 `org-table-export-default-format'."
657 buf deffmt-readable fileext)
673 org-table-export-default-format))
691 'hline
694 skipcols i0)))
695 lines))
699 skipcols i0))
702 skipcols i0)))
719 "Marker at the beginning of the table last aligned.
722 "Marker at the end of the table last aligned.
725 "List of flags for flushright alignment, from the last re-alignment.
728 "List of max width of fields in each column.
731 "Non-nil means debug table formulas.
743 ;;;###autoload
745 "Align the table at point by aligning all vertical bars."
748 ;; Limits of table
751 ;; Current cursor position
757 column
759 rfmt hfmt
767 emptystrings links dates emph raise narrow
768 falign falign1 fmax f1 len c e space)
771 ;; Check if we have links or dates
783 ;; Make sure the link properties are right
785 ;; Make sure the date properties are right
790 ;; Check if we are narrowing any columns
793 org-format-transports-properties-p
798 ;; Get the rows
801 ;; Store the indentation of the first line
804 ;; Mark the hlines by setting the corresponding element to nil
805 ;; At the same time, we remove trailing space.
808 nil
811 l)))
812 lines))
813 ;; Get the data fields by splitting the lines.
818 ;; How many fields in the longest line?
825 ;; A list of empty strings to fill any short rows on output
827 ;; Check for special formatting.
831 ;; Check if there is an explicit width specified
841 ;; Find fields that are wider than fmax, and shorten them
847 'help-echo
857 xx)))))
858 ;; Get the maximum width for each column
860 lengths)
861 ;; Get the fraction of numbers, to decide about alignment of the column
867 nil
874 ;; Store the alignment of this table, for later editing of single fields
876 org-table-last-column-widths lengths)
878 ;; With invisible characters, `format' does not get the field width right
879 ;; So we need to make these fields wide by hand.
897 ;; Compute the formats needed for output of the table
910 hfmt))
914 ;; Replace the old one
921 ;; Try to move to the old location
930 ))
932 ;;;###autoload
934 "Find the beginning of the table and return its position.
935 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
939 org-table-border-regexp)
940 nil t))
946 ;;;###autoload
948 "Find the end of the table and return its position.
949 With argument TABLE-TYPE, go to the end of a table.el-type table."
953 org-table-border-regexp)
954 nil t))
959 ;;;###autoload
961 "Justify the current field, text to left, number to right.
962 Optional argument NEW may specify text to replace the current field content."
971 ;; This is not the same table, force a full re-align
977 l f n o e)
1000 ;;;###autoload
1002 "Go to the next field in the current table, creating new lines as needed.
1003 Before doing so, re-align the table if necessary."
1008 org-table-may-need-update)
1019 org-table-tab-jumps-over-hlines
1030 ;;;###autoload
1032 "Go to the previous field in the table.
1033 Before doing so, re-align the table if necessary."
1038 org-table-may-need-update)
1053 "Move to the end of the current table field.
1054 If already at or after the end, move to the end of the next table field.
1055 With numeric argument N, move N-1 fields forward first."
1068 "Move to the beginning of the current table field.
1069 If already at or before the beginning, move to the beginning of the
1070 previous field.
1071 With numeric argument N, move N-1 fields backward first."
1084 ;;;###autoload
1086 "Go to the next row (same column) in the current table.
1087 Before doing so, re-align the table if necessary."
1095 org-table-may-need-update)
1108 ;;;###autoload
1110 "Copy the value of the current field one row below.
1112 If the field at the cursor is empty, copy the content of the
1113 nearest non-empty field above. With argument N, use the Nth
1114 non-empty field.
1116 If the current field is not empty, it is copied down to the next
1117 row, and the cursor is moved with it. Therefore, repeating this
1118 command causes the column to be filled row-by-row.
1120 If the variable `org-table-copy-increment' is non-nil and the
1121 field is an integer or a timestamp, it will be incremented while
1122 copying. By default, increment by the difference between the
1123 value in the current field and the one in the field above. To
1124 increment using a fixed integer, set `org-table-copy-increment'
1125 to a number. In the case of a timestamp, increment by days."
1137 txt txt-up inc)
1145 beg t))
1155 beg t))
1162 ;; Above field was not empty, go down to the next row
1193 "Is point inside a table data field?
1194 I.e. not on a hline or before the first or after the last column?
1195 This actually throws an error, so it aborts the current command."
1201 nil
1203 t))
1209 "Get the field in table line LINE, column COLUMN.
1210 If LINE is larger than the number of data lines in the table, the function
1211 returns nil. However, if COLUMN is too large, we will simply return an
1212 empty string.
1213 If LINE is nil, use the current line.
1214 If column is nil, use the current column."
1221 "Put VALUE into line LINE, column COLUMN.
1222 When ALIGN is set, also realign the table."
1231 "Return the index of the current data line."
1238 cnt))
1241 "Go to the Nth data line in the current table.
1242 Return t when the line exists, nil if it does not exist."
1249 ;;;###autoload
1251 "Blank the current table field or active region."
1268 "Return the value of the field in column N of current row.
1269 N defaults to current field.
1270 If REPLACE is a string, replace field with this value. The return value
1271 is always the old value."
1280 t t))
1282 val)
1285 ;;;###autoload
1287 "Show info about the current field, and highlight any reference at point."
1296 org-table-named-field-locations)))
1316 dline col
1318 dline col ref1
1320 ;; FIXME: formula info not correct if special table line
1330 "Find out which column we are in."
1340 cnt)))
1342 ;;;###autoload
1344 "Find out what table data line we are in.
1345 Only data lines count for this."
1357 cnt)))
1359 ;;;###autoload
1361 "Move the cursor to the Nth column in the current table line.
1362 With optional argument ON-DELIM, stop with point before the left delimiter
1363 of the field.
1364 If there are less than N fields, just go to after the last delimiter.
1365 However, when FORCE is non-nil, create new columns if necessary."
1375 t)))))
1382 ;;;###autoload
1384 "Insert a new column into the table."
1392 ;; Current cursor position
1398 nil
1412 "Find a data line in the current table, which is needed for column commands."
1415 t
1426 t
1431 "Turn a buffer line number into a data line number.
1432 If there is no data line in this line, return nil.
1433 If there is no matching dline (most likely te reference was a hline), the
1434 first dline below it is used. When ABOVE is non-nil, the one above is used."
1437 i)
1450 nil))
1452 ;;;###autoload
1454 "Delete a column from the table."
1463 ;; Current cursor position
1469 nil
1485 ;;;###autoload
1487 "Move column to the right."
1490 ;;;###autoload
1492 "Move column to the left."
1496 ;;;###autoload
1498 "Move the current column to the right. With arg LEFT, move to the left."
1508 ;; Current cursor position
1518 nil
1536 ;;;###autoload
1538 "Move table row down."
1541 ;;;###autoload
1543 "Move table row up."
1547 ;;;###autoload
1549 "Move the current table line down. With arg UP, move it up."
1558 txt hline2p)
1581 ;;;###autoload
1583 "Insert a new row above the current line into the table.
1584 With prefix ARG, insert below the current line."
1590 ;; Fix the first field if necessary
1603 ;;;###autoload
1605 "Insert a horizontal-line below the current line into the table.
1606 With prefix ABOVE, insert above the current line."
1627 ;;;###autoload
1629 "Insert a hline and move to the row below that line."
1643 In particular, this does handle wide and invisible characters."
1645 ;; It's a hline, just map the characters
1651 t t s)))
1652 s))
1654 ;;;###autoload
1656 "Delete the current row or horizontal line from the table."
1670 ;;;###autoload
1672 "Sort table lines according to the column at point.
1674 The position of point indicates the column to be used for
1675 sorting, and the range of lines is the range between the nearest
1676 horizontal separator lines, or the entire table of no such lines
1677 exist. If point is before the first column, you will be prompted
1678 for the sorting column. If there is an active region, the mark
1679 specifies the first line and the sorting column, while point
1680 should be in the last line to be included into the sorting.
1682 The command then prompts for the sorting type which can be
1683 alphabetically, numerically, or by time (as given in a time stamp
1684 in the field, or as a HH:MM value). Sorting in reverse order is
1685 also possible.
1687 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1689 If SORTING-TYPE is specified when this function is called from a Lisp
1690 program, no prompting will take place. SORTING-TYPE must be a character,
1691 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1692 should be done in reverse order."
1697 beg end bcol ecol tend tbeg column lns pos)
1742 x))
1756 ;;;###autoload
1758 "Copy region in table to the clipboard and blank all relevant fields.
1759 If there is no active region, use just the field at point."
1765 ;;;###autoload
1767 "Copy rectangular region in table to clipboard.
1768 A special clipboard is used which can only be accessed
1769 with `org-table-paste-rectangle'."
1773 current-prefix-arg))
1775 region cols
1801 org-table-clip))
1803 ;;;###autoload
1805 "Paste a rectangular region into a table.
1806 The upper right corner ends up in the current field. All involved fields
1807 will be overwritten. If the rectangle does not fit into the present table,
1808 the table is enlarged as needed. The process ignores horizontal separator
1809 lines."
1819 c cols field)
1834 ;;;###autoload
1836 "Convert from `org-mode' table to table.el and back.
1837 Obviously, this only works within limits. When an Org-mode table is
1838 converted to table.el, all horizontal separator lines get lost, because
1839 table.el uses these as cell boundaries and has no notion of horizontal lines.
1840 A table.el table can be converted to an Org-mode table only if it does not
1841 do row or column spanning. Multiline cells will become multiple cells.
1842 Beware, Org-mode does not test if the table can be successfully converted - it
1843 blindly applies a recipe that works for simple tables."
1847 ;; convert to Org-mode table
1856 ;; convert to table.el table
1859 ;; first, get rid of all horizontal lines
1863 ;; insert a hline before first
1867 ;; insert a hline after each line
1872 ;; replace "+" at beginning and ending of hlines
1881 "Transpose Org table at point and eliminate hlines.
1882 So a table like
1884 | 1 | 2 | 4 | 5 |
1885 |---+---+---+---|
1886 | a | b | c | d |
1887 | e | f | g | h |
1889 will be transposed as
1891 | 1 | a | e |
1892 | 2 | b | f |
1893 | 4 | c | g |
1894 | 5 | d | h |
1896 Note that horizontal lines disappear."
1908 table)))
1922 ;;;###autoload
1924 "Wrap several fields in a column like a paragraph.
1925 This is useful if you'd like to spread the contents of a field over several
1926 lines, in order to keep the table compact.
1928 If there is an active region, and both point and mark are in the same column,
1929 the text in the column is wrapped to minimum width for the given number of
1930 lines. Generally, this makes the table more compact. A prefix ARG may be
1932 formats the selected text to two lines. If the region was longer than two
1933 lines, the remaining lines remain empty. A negative prefix argument reduces
1934 the current number of lines by that amount. The wrapped text is pasted back
1935 into the table. If you formatted it to more lines than it was before, fields
1936 further down in the table get overwritten - so you might need to make space in
1937 the table first.
1939 If there is no region, the current field is split at the cursor position and
1940 the text fragment to the right of the cursor is prepended to the field one
1941 line down.
1943 If there is no region, but you specify a prefix ARG, the current field gets
1944 blank, and the content is appended to the field above."
1948 ;; There is a region: fill as a paragraph
1952 nlines)
1959 arg)
1963 nil nlines)))
1967 ;; No region, split the current field at point
1971 ;; combine with field above
1981 ;; split field
1993 ;;;###autoload
1995 "Edit table field in a different window.
1996 This is mainly useful for fields that contain hidden parts.
1998 it can be edited in place."
2007 display t intangible t))
2020 p)
2036 intangible t))
2044 "Finish editing a table data field.
2045 Remove all newline characters, insert the result into the table, realign
2046 the table and kill the editing buffer."
2050 text)
2067 "Minor mode to make the table field editor window follow the cursor.
2068 When this mode is active, the field editor window will always show the
2069 current field. The mode exits automatically when the cursor leaves the
2070 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2071 nil " TblFollow" nil
2087 ;; We have left the table, exit the follow mode
2097 ;;;###autoload
2099 "Sum numbers in region of current table column.
2100 The result will be displayed in the echo area, and will be available
2103 If there is an active region, it is interpreted as a rectangle and all
2104 numbers in that rectangle will be summed. If there is no active
2105 region and point is located in a table column, sum all numbers in that
2106 column.
2108 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2109 numbers are assumed to be times as well (in decimal hours) and the
2110 numbers are added as such.
2112 If NLAST is a number, only the NLAST fields will actually be summed."
2139 items1)))
2146 s diff)
2154 sres))))
2177 "Return the formula active for the current field.
2178 Assumes that specials are in place.
2179 If KEY is given, return the key to this formula.
2183 org-table-named-field-locations)))
2197 "Read a formula from the minibuffer, offer stored formula as default.
2198 When NAMED is non-nil, look for a named equation."
2202 org-table-named-field-locations)))
2209 name
2210 ref)
2220 stored)
2222 equation)
2229 scol))
2231 'org-table-formula-history
2232 )))))
2233 mustsave)
2235 ;; remove formula
2242 ;; We set the column equation, delete the named one.
2244 mustsave t))
2250 eq))
2253 "Store the list of formulas below the current table."
2260 ;; don't overwrite TBLFM, we might use text properties to store stuff
2276 ;; Fake a high number to make sure this is sorted at the end.
2283 a)
2293 "Compare two formulas for sorting."
2298 ;;;###autoload
2300 "Return an alist with the stored formulas directly after current table."
2309 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2328 "Modify the equations after the table structure has been edited.
2330 For all numbers larger than LIMIT, shift them by DELTA."
2342 s n a)
2348 "Change makes TBLFM term %s invalid, use undo to recover"
2364 "Get the column names and local parameters for this table."
2367 names name fields fields1 field cnt
2368 c v l line col types dlines hlines last-dline)
2370 org-table-local-parameters nil
2371 org-table-named-field-locations nil
2372 org-table-current-begin-line nil
2373 org-table-current-begin-pos nil
2374 org-table-current-line-types nil
2393 org-table-local-parameters))))
2409 ;; Analyse the line types
2413 l org-table-current-begin-line)
2430 al al2)
2440 ;;;###autoload
2443 If yes, store the formula and apply it."
2444 ;; We already know we are in a table. Get field will only return a formula
2445 ;; when appropriate. It might return a separator line, but no problem.
2448 named eq)
2459 "List of commands triggering the recalculation of a line.
2471 ;;;###autoload
2473 "Rotate the recalculation mark in the first column.
2474 If in any row, the first field is not consistent with a mark,
2475 insert a new column for the markers.
2476 When there is an active region, change all the lines in the region,
2477 after prompting for the marking character.
2478 After each change, a message will be displayed indicating the meaning
2479 of the new mark."
2494 epos new)
2501 newchar))
2533 ;;;###autoload
2535 "Recompute the current line if marked for it, and if we haven't just done it."
2555 org-tbl-calc-modes)
2557 ;;;###autoload
2559 suppress-align suppress-const
2560 suppress-store suppress-analysis)
2561 "Replace the table field value at the cursor by the result of a calculation.
2563 This function makes use of Dave Gillespie's Calc package, in my view the
2564 most exciting program ever written for GNU Emacs. So you need to have Calc
2565 installed in order to use this function.
2567 In a table, this command replaces the value in the current field with the
2569 formula, by storing it in a special line below the table. When called
2570 with a `C-u' prefix, the current field must be a named field, and the
2571 formula is installed as valid in only this specific field.
2573 When called with two `C-u' prefixes, insert the active equation
2574 for the field back into the current field, so that it can be
2576 to check the referenced fields.
2578 When called, the command first prompts for a formula, which is read in
2579 the minibuffer. Previously entered formulas are available through the
2580 history list, and the last used formula is offered as a default.
2581 These stored formulas are adapted correctly when moving, inserting, or
2582 deleting columns with the corresponding commands.
2584 The formula can be any algebraic expression understood by the Calc package.
2585 For details, see the Org-mode manual.
2587 This function can also be called from Lisp programs and offers
2588 additional arguments: EQUATION can be the formula to apply. If this
2589 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2590 used to speed-up recursive calls by by-passing unnecessary aligns.
2591 SUPPRESS-CONST suppresses the interpretation of constants in the
2592 formula, assuming that this has been done already outside the function.
2593 SUPPRESS-STORE means the formula should not be stored, either because
2594 it is already stored, or because it is a modified equation that should
2595 not overwrite the stored one."
2611 equation
2617 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2618 duration duration-output-format)
2619 ;; Parse the format string. Since we have a lot of modes, this is
2620 ;; a lot of work. However, I think calc still uses most of the time.
2633 'calc-float-format
2636 n))))
2640 duration-output-format nil
2644 duration-output-format org-table-duration-custom-format
2645 numbers t
2668 ;; replace fields with duration values if relevant
2672 fields)))
2678 x))
2679 fields)))
2685 ;; Insert row and column number of formula result field
2696 t t form)))
2698 ;; Check for old vertical references
2700 ;; Insert remote references
2713 rmtrng))
2714 keep-empty numbers lispp))
2715 t t form)))
2716 ;; Insert complex ranges
2724 ;; possibly handle durations
2729 formrg)
2730 keep-empty numbers lispp)))
2735 ;; Insert simple ranges
2744 keep-empty numbers lispp))
2745 t t form)))
2747 ;; Insert the references to fields in same row
2757 x keep-empty numbers lispp))
2758 t t form)))
2770 ;; Use <...> time-stamps so that Calc can handle them
2773 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2784 form
2791 duration-output-format)
2792 ev)))
2797 Orig: %s
2798 $xyz-> %s
2799 @r$c-> %s
2831 prop value)))
2834 "Get a calc vector from a column, according to descriptor DESC.
2835 Optional arguments TBEG and COL can give the beginning of the table and
2836 the current column, to avoid unnecessary parsing.
2838 HIGHLIGHT means just highlight the range.
2840 When CORNERS-ONLY is set, only return the corners of the range as
2841 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2842 in the buffer and column1 and column2 are table column numbers."
2849 beg end c1 c2 r1 r2 rangep tmp)
2866 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2873 ;; just one field
2880 ;; A range, return a vector
2881 ;; First sort the numbers to get a regular rectangle
2885 ;; Only return the corners of the range
2887 ;; Copy the range values into a list
2901 ;; return string representation of calc vector
2906 "Analyze descriptor DESC and retrieve the corresponding line number.
2907 The cursor is currently in line CLINE, the table begins in line BLINE,
2908 and TABLE is a vector with line types."
2916 ;; 1 2 3 4 5 6
2936 nil hn cline desc)))
2939 rel on cline desc)))
2943 "FIXME: Needs more documentation."
2956 nil))
2957 t)))
2961 desc cline)
2962 i)))
2967 s))
2970 "Convert list ELEMENTS to something appropriate to insert into formula.
2971 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2972 NUMBERS indicates that everything should be converted to numbers.
2973 LISPP non-nil means to return something appropriate for a Lisp
2974 list, 'literal is for the format specifier L."
2975 ;; Calc nan (not a number) is used for the conversion of the empty
2976 ;; field to a reference for several reasons: (i) It is accepted in a
2977 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2978 ;; (ii) In a single field (not in range) it can be distinguished
2979 ;; from "(nan)" which is the reference made from a single field
2980 ;; containing "nan".
2982 ;; field reference
2985 elements
2987 ""
2996 ;; range reference
3001 elements))))
3007 x
3015 x)
3017 elements
3020 ;;;###autoload
3022 "Set `org-table-formula-constants-local' in the current buffer."
3038 ;;;###autoload
3040 "Recalculate the current table line by applying all stored formulas.
3041 With prefix arg ALL, do this for all lines in the table.
3042 With the prefix argument ALL is `(16)' \
3044 it is the symbol `iterate', recompute the table until it no longer changes.
3045 If NOALIGN is not nil, do not re-align the table after the computations
3046 are done. This is typically used internally to save time, if it is
3047 known that the table will be realigned a little later anyway."
3062 seen-fields lhs1
3064 ;; Insert constants in all formulas
3082 eqlist))
3083 ;; Split the equation list
3089 ;; Expand ranges in lhs of formulas
3092 ;; Get the correct line range to process
3098 ;; This is a table with marked lines, compute selected lines
3100 ;; Move forward to the first non-header line
3111 ;; First find the named fields, and mark them untouchable.
3112 ;; Also check if several field/range formulas try to set the same field.
3131 name)))
3141 ;; Now evaluate the column formulas, but skip fields covered by
3142 ;; field formulas
3146 ;; Unprotected line, recalculate
3158 ;; Now evaluate the field formulas
3172 ;; back to initial position
3179 ;;;###autoload
3181 "Recalculate the table until it does not change anymore.
3182 The maximum number of iterations is 10, but you can choose a different value
3183 with the prefix ARG."
3188 thistbl)
3202 ;;;###autoload
3204 "Recalculate all tables in the current buffer."
3211 ;;;###autoload
3213 "Iterate all tables in the buffer, to converge inter-table dependencies."
3218 c1)
3234 "Apply the #+TBLFM in the line at point to the table."
3240 s e)
3242 ;; Insert a temporary formula at right after the table
3247 ;; Recalculate the table
3253 ;; delete the formula inserted temporarily
3257 "Find the beginning of the TBLFM lines and return its position.
3258 Return nil when the beginning of TBLFM line was not found."
3262 org-table-TBLFM-begin-regexp
3263 nil t))
3267 "Expand list of formulas.
3268 If some of the RHS in the formulas are ranges or a row reference, expand
3269 them to individual field equations for each field."
3275 ;; This just refers to one fixed field
3278 ;; This just refers to one fixed named field
3300 "Replace @<, @>, $<, $> with first/last row/column of the table.
3301 So @< and $< will always be replaced with @1 and $1, respectively.
3302 The advantage of these special markers are that structure editing of
3303 the table will not change them, while @1 and $1 will be modified
3304 when a line/row is swapped out of that privileged position. So for
3305 formulas that use a range of rows or columns, it may often be better
3307 borders of the table using the @< @> $< $> makers."
3310 s start)
3315 org-table-current-ncol)
3319 len
3326 s)
3329 "Replace $const with values in string F."
3331 ;; First, check for column names
3336 ;; Parameters and constants
3338 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3348 f))
3351 "Find the value for a parameter or constant in a formula.
3352 Parameters get priority."
3383 map))
3390 "--"
3393 "--"
3394 "Shift Reference at Point"
3399 "-"
3400 "Change Test Row for Column Formulas"
3403 "--"
3408 org-table-overlay-coordinates)]
3409 "--"
3415 ;;;###autoload
3417 "Edit the formulas of the current table in a separate buffer."
3419 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3433 entry s type title)
3436 ;; Keep global-font-lock-mode from turning on font-lock-mode
3477 "Convert a formula from internal to user representation."
3480 s))
3483 "Convert a formula from user to internal representation."
3486 s))
3489 "Convert spreadsheet references from A7 to @7$28.
3490 Works for single references, but also for entire formulas and even the
3491 full TBLFM line."
3493 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3496 ;; format match, just advance
3501 ;; 3.e5 or something like this.
3504 ;; (member (match-string 1 s)
3505 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3506 )
3507 ;; function name, just advance
3517 t t s)))))
3518 s))
3521 "Convert spreadsheet references from to @7$28 to AB7.
3522 Works for single references, but also for entire formulas and even the
3523 full TBLFM line."
3530 t t s)))
3535 t nil s)))
3536 s)
3539 "Convert a base 26 number represented by letters into an integer.
3540 For example: AB -> 28."
3546 n))
3549 "Convert an integer into a base 26 number represented by letters.
3550 For example: 28 -> AB."
3555 s))
3558 "Convert a time string into numerical duration in seconds.
3559 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3560 If S is a string representing a number, keep this number."
3562 s
3585 "Convert a number of seconds to a time string.
3586 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3587 minutes or seconds."
3602 "Convert all references in this buffer, using FUNCTION."
3612 "Convert all references in the buffer from B3 to @3$2 and back."
3622 "Shift the reference at point one row/hline up."
3626 "Shift the reference at point one row/hline down."
3630 "Shift the reference at point one field to the left."
3634 "Shift the reference at point one field to the right."
3645 ;; A B3-like reference
3651 ;; An internal reference
3657 "Re-match the group N, and replace it with the shifted reference."
3662 t t)))
3665 "Shift a reference part REF.
3666 If DECR is set, decrease the references row/column, else increase.
3667 If HLINE is set, this may be a hline reference, it certainly is not
3668 a translation reference."
3697 "Toggle the display of coordinates in the referenced table."
3706 "Parse the buffer for formula definitions and install them.
3707 With prefix ARG, apply the new formulas to the table."
3717 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3718 nil t)
3742 "Abort editing formulas, without installing the changes."
3753 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3794 "Show the location/value of the $ expression at point."
3803 var name e what match dest)
3808 "$1.."
3891 ;; column number
3919 org-table-fedit-scroll-down))))
3930 "Make sure the cursor is in a dataline in a table."
3939 p1 p2)))
3944 "Move cursor one line up in the window showing the table."
3949 "Move cursor one line down in the window showing the table."
3954 "Move the cursor in the window showing the table.
3955 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3980 "Add a new overlay."
3986 "Highlight rectangular region in a table."
3990 l1 c1 l2 c2 tmp)
4014 "Remove the rectangle overlays."
4025 "Add overlays to the table at point, to show row/column coordinates."
4053 ;;;###autoload
4055 "Toggle the display of Row/Column numbers in tables."
4066 ;;;###autoload
4068 "Toggle the formula debugger in tables."
4074 ;;; The orgtbl minor mode
4076 ;; Define a minor mode which can be used in other modes in order to
4077 ;; integrate the org-mode table editor.
4079 ;; This is really a hack, because the org-mode table editor uses several
4080 ;; keys which normally belong to the major mode, for example the TAB and
4081 ;; RET keys. Here is how it works: The minor mode defines all the keys
4082 ;; necessary to operate the table editor, but wraps the commands into a
4083 ;; function which tests if the cursor is currently inside a table. If that
4084 ;; is the case, the table editor command is executed. However, when any of
4085 ;; those keys is used outside a table, the function uses `key-binding' to
4086 ;; look up if the key has an associated command in another currently active
4087 ;; keymap (minor modes, major mode, global), and executes that command.
4088 ;; There might be problems if any of the keys used by the table editor is
4089 ;; otherwise used as a prefix key.
4091 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4092 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4093 ;; addresses this by checking explicitly for both bindings.
4095 ;; The optimized version (see variable `orgtbl-optimized') takes over
4096 ;; all keys which are bound to `self-insert-command' in the *global map*.
4097 ;; Some modes bind other commands to simple characters, for example
4098 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4099 ;; active, this binding is ignored inside tables and replaced with a
4100 ;; modified self-insert.
4118 ;; Install it as a minor mode.
4122 ;;;###autoload
4124 "The `org-mode' table editor as a minor mode for use in other modes."
4129 ;; Exit without error, in case some hook functions calls this
4130 ;; by accident in org-mode.
4134 ;; Make sure we are first in minor-mode-map-alist
4136 ;; FIXME: maybe it should use emulation-mode-map-alists?
4143 auto-fill-inhibit-regexp)
4147 auto-fill-inhibit-regexp)
4148 orgtbl-line-start-regexp))
4166 "Remove all properties related to narrow-column invisibility."
4179 "Create a function for binding in the table minor mode.
4180 FUN is the command to call inside a table. N is used to create a unique
4181 command name. KEYS are keys that should be checked in for a command
4182 to execute outside of tables."
4188 "Outside of tables, run the binding of `"
4200 keys)
4204 "Error when there is no default binding for a table key."
4209 "Setup orgtbl keymaps."
4240 elt key fun cmd)
4248 ;; Special treatment needed for TAB and RET
4268 [(tab)] "\C-i")))
4270 (org-defkey orgtbl-mode-map [backtab]
4272 [backtab] [S-iso-lefttab] [(shift tab)]
4273 [(tab)] "\C-i"))
4275 (org-defkey orgtbl-mode-map "\M-\C-m"
4276 (orgtbl-make-binding 'org-table-wrap-region 105
4277 "\M-\C-m" [(meta return)]))
4278 (org-defkey orgtbl-mode-map [(meta return)]
4279 (orgtbl-make-binding 'org-table-wrap-region 106
4280 [(meta return)] "\M-\C-m"))
4282 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4283 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4285 (when orgtbl-optimized
4286 ;; If the user wants maximum table support, we need to hijack
4287 ;; some standard editing functions
4288 (org-remap orgtbl-mode-map
4289 'self-insert-command 'orgtbl-self-insert-command
4290 'delete-char 'org-delete-char
4291 'delete-backward-char 'org-delete-backward-char)
4292 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4293 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4294 '("OrgTbl"
4295 ["Create or convert" org-table-create-or-convert-from-region
4296 :active (not (org-at-table-p)) :keys "C-c |" ]
4297 "--"
4298 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4299 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4300 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4301 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4302 "--"
4303 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4304 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4305 ["Copy Field from Above"
4306 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4307 "--"
4308 ("Column"
4309 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4310 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4311 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4312 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4313 ("Row"
4314 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4315 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4316 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4317 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4318 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4319 "--"
4320 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4321 ("Rectangle"
4322 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4323 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4324 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4325 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4326 "--"
4327 ("Radio tables"
4328 ["Insert table template" orgtbl-insert-radio-table
4329 (assq major-mode orgtbl-radio-table-templates)]
4330 ["Comment/uncomment table" orgtbl-toggle-comment t])
4331 "--"
4332 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4333 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4334 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4335 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4336 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4337 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4338 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4339 ["Sum Column/Rectangle" org-table-sum
4340 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4341 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4342 ["Debug Formulas"
4343 org-table-toggle-formula-debugger :active (org-at-table-p)
4344 :keys "C-c {"
4345 :style toggle :selected org-table-formula-debug]
4346 ["Show Col/Row Numbers"
4347 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4348 :keys "C-c }"
4349 :style toggle :selected org-table-overlay-coordinates]
4350 ))
4351 t))
4353 (defun orgtbl-ctrl-c-ctrl-c (arg)
4354 "If the cursor is inside a table, realign the table.
4355 If it is a table to be sent away to a receiver, do it.
4356 With prefix arg, also recompute table."
4357 (interactive "P")
4358 (let ((case-fold-search t) (pos (point)) action)
4359 (save-excursion
4360 (beginning-of-line 1)
4361 (setq action (cond
4365 (cond
4366 ((integerp action)
4367 (goto-char action)
4368 (org-table-maybe-eval-formula)
4369 (if arg
4370 (call-interactively 'org-table-recalculate)
4371 (org-table-maybe-recalculate-line))
4372 (call-interactively 'org-table-align)
4373 (when (orgtbl-send-table 'maybe)
4374 (run-hooks 'orgtbl-after-send-table-hook)))
4375 ((eq action 'recalc)
4376 (org-table-set-constants)
4377 (save-excursion
4378 (beginning-of-line 1)
4380 (if (org-at-table-p)
4381 (org-call-with-arg 'org-table-recalculate t))))
4382 (t (let (orgtbl-mode)
4383 (call-interactively (key-binding "\C-c\C-c")))))))
4385 (defun orgtbl-create-or-convert-from-region (arg)
4386 "Create table or convert region to table, if no conflicting binding.
4387 This installs the table binding `C-c |', but only if there is no
4388 conflicting binding to this key outside orgtbl-mode."
4389 (interactive "P")
4390 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4391 (if cmd
4392 (call-interactively cmd)
4393 (call-interactively 'org-table-create-or-convert-from-region))))
4395 (defun orgtbl-tab (arg)
4396 "Justification and field motion for `orgtbl-mode'."
4397 (interactive "P")
4398 (if arg (org-table-edit-field t)
4399 (org-table-justify-field-maybe)
4400 (org-table-next-field)))
4402 (defun orgtbl-ret ()
4403 "Justification and field motion for `orgtbl-mode'."
4404 (interactive)
4405 (if (bobp)
4406 (newline)
4407 (org-table-justify-field-maybe)
4408 (org-table-next-row)))
4410 (defun orgtbl-self-insert-command (N)
4411 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4412 If the cursor is in a table looking at whitespace, the whitespace is
4413 overwritten, and the table is not marked as requiring realignment."
4414 (interactive "p")
4415 (if (and (org-at-table-p)
4416 (or
4417 (and org-table-auto-blank-field
4418 (member last-command
4419 '(orgtbl-hijacker-command-100
4420 orgtbl-hijacker-command-101
4421 orgtbl-hijacker-command-102
4422 orgtbl-hijacker-command-103
4423 orgtbl-hijacker-command-104
4424 orgtbl-hijacker-command-105
4425 yas/expand))
4426 (org-table-blank-field))
4427 t)
4428 (eq N 1)
4430 (let (org-table-may-need-update)
4431 (goto-char (1- (match-end 0)))
4432 (org-delete-backward-char 1)
4433 (goto-char (match-beginning 0))
4434 (self-insert-command N))
4435 (setq org-table-may-need-update t)
4436 (let* (orgtbl-mode
4437 a
4438 (cmd (or (key-binding
4439 (or (and (listp function-key-map)
4440 (setq a (assoc last-input-event function-key-map))
4441 (cdr a))
4442 (vector last-input-event)))
4443 'self-insert-command)))
4444 (call-interactively cmd)
4445 (if (and org-self-insert-cluster-for-undo
4446 (eq cmd 'self-insert-command))
4447 (if (not (eq last-command 'orgtbl-self-insert-command))
4448 (setq org-self-insert-command-undo-counter 1)
4449 (if (>= org-self-insert-command-undo-counter 20)
4450 (setq org-self-insert-command-undo-counter 1)
4451 (and (> org-self-insert-command-undo-counter 0)
4452 buffer-undo-list
4453 (not (cadr buffer-undo-list)) ; remove nil entry
4454 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4455 (setq org-self-insert-command-undo-counter
4456 (1+ org-self-insert-command-undo-counter))))))))
4459 "Regular expression matching exponentials as produced by calc.")
4461 (defun orgtbl-gather-send-defs ()
4462 "Gather a plist of :name, :transform, :params for each destination before
4463 a radio table."
4464 (save-excursion
4465 (goto-char (org-table-begin))
4466 (let (rtn)
4467 (beginning-of-line 0)
4468 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4469 (let ((name (org-no-properties (match-string 1)))
4470 (transform (intern (match-string 2)))
4471 (params (if (match-end 3)
4472 (read (concat "(" (match-string 3) ")")))))
4473 (push (list :name name :transform transform :params params)
4474 rtn)
4475 (beginning-of-line 0)))
4476 rtn)))
4478 (defun orgtbl-send-replace-tbl (name txt)
4479 "Find and replace table NAME with TXT."
4480 (save-excursion
4481 (goto-char (point-min))
4482 (unless (re-search-forward
4484 (user-error "Don't know where to insert translated table"))
4485 (goto-char (match-beginning 0))
4486 (beginning-of-line 2)
4487 (save-excursion
4488 (let ((beg (point)))
4489 (unless (re-search-forward
4490 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4491 (user-error "Cannot find end of insertion region"))
4492 (beginning-of-line 1)
4493 (delete-region beg (point))))
4496 ;;;###autoload
4497 (defun org-table-to-lisp (&optional txt)
4498 "Convert the table at point to a Lisp structure.
4499 The structure will be a list. Each item is either the symbol `hline'
4500 for a horizontal separator line, or a list of field values as strings.
4501 The table is taken from the parameter TXT, or from the buffer at point."
4502 (unless txt
4503 (unless (org-at-table-p)
4504 (user-error "No table at point")))
4505 (let* ((txt (or txt
4506 (buffer-substring-no-properties (org-table-begin)
4507 (org-table-end))))
4510 (mapcar
4511 (lambda (x)
4512 (if (string-match org-table-hline-regexp x)
4513 'hline
4515 lines)))
4517 (defun orgtbl-send-table (&optional maybe)
4518 "Send a transformed version of this table to the receiver position.
4519 With argument MAYBE, fail quietly if no transformation is defined for
4520 this table."
4521 (interactive)
4522 (catch 'exit
4523 (unless (org-at-table-p) (user-error "Not at a table"))
4524 ;; when non-interactive, we assume align has just happened.
4525 (when (org-called-interactively-p 'any) (org-table-align))
4526 (let ((dests (orgtbl-gather-send-defs))
4527 (txt (buffer-substring-no-properties (org-table-begin)
4528 (org-table-end)))
4529 (ntbl 0))
4530 (unless dests (if maybe (throw 'exit nil)
4531 (user-error "Don't know how to transform this table")))
4532 (dolist (dest dests)
4533 (let* ((name (plist-get dest :name))
4534 (transform (plist-get dest :transform))
4535 (params (plist-get dest :params))
4536 (skip (plist-get params :skip))
4537 (skipcols (plist-get params :skipcols))
4538 (no-escape (plist-get params :no-escape))
4539 beg
4540 (lines (org-table-clean-before-export
4541 (nthcdr (or skip 0)
4543 (i0 (if org-table-clean-did-remove-column 2 1))
4544 (lines (if no-escape lines
4545 (mapcar (lambda(l) (replace-regexp-in-string
4547 (table (mapcar
4548 (lambda (x)
4549 (if (string-match org-table-hline-regexp x)
4550 'hline
4551 (org-remove-by-index
4553 skipcols i0)))
4554 lines))
4555 (fun (if (= i0 2) 'cdr 'identity))
4556 (org-table-last-alignment
4557 (org-remove-by-index (funcall fun org-table-last-alignment)
4558 skipcols i0))
4559 (org-table-last-column-widths
4560 (org-remove-by-index (funcall fun org-table-last-column-widths)
4561 skipcols i0))
4562 (txt (if (fboundp transform)
4563 (funcall transform table params)
4564 (user-error "No such transformation function %s" transform))))
4565 (orgtbl-send-replace-tbl name txt))
4566 (setq ntbl (1+ ntbl)))
4567 (message "Table converted and installed at %d receiver location%s"
4568 ntbl (if (> ntbl 1) "s" ""))
4569 (if (> ntbl 0)
4570 ntbl
4571 nil))))
4573 (defun org-remove-by-index (list indices &optional i0)
4574 "Remove the elements in LIST with indices in INDICES.
4575 First element has index 0, or I0 if given."
4576 (if (not indices)
4577 list
4578 (if (integerp indices) (setq indices (list indices)))
4579 (setq i0 (1- (or i0 0)))
4580 (delq :rm (mapcar (lambda (x)
4581 (setq i0 (1+ i0))
4582 (if (memq i0 indices) :rm x))
4583 list))))
4585 (defun orgtbl-toggle-comment ()
4586 "Comment or uncomment the orgtbl at point."
4587 (interactive)
4588 (let* ((case-fold-search t)
4589 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4590 (re2 (concat "^" orgtbl-line-start-regexp))
4591 (commented (save-excursion (beginning-of-line 1)
4592 (cond ((looking-at re1) t)
4593 ((looking-at re2) nil)
4594 (t (user-error "Not at an org table")))))
4595 (re (if commented re1 re2))
4596 beg end)
4597 (save-excursion
4598 (beginning-of-line 1)
4599 (while (looking-at re) (beginning-of-line 0))
4600 (beginning-of-line 2)
4601 (setq beg (point))
4602 (while (looking-at re) (beginning-of-line 2))
4603 (setq end (point)))
4604 (comment-region beg end (if commented '(4) nil))))
4606 (defun orgtbl-insert-radio-table ()
4607 "Insert a radio table template appropriate for this major mode."
4608 (interactive)
4609 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4610 (txt (nth 1 e))
4611 name pos)
4612 (unless e (user-error "No radio table setup defined for %s" major-mode))
4613 (setq name (read-string "Table name: "))
4614 (while (string-match "%n" txt)
4615 (setq txt (replace-match name t t txt)))
4617 (setq pos (point))
4618 (insert txt)
4619 (goto-char pos)))
4621 ;; Dynamically bound input and output for table formatting.
4622 (defvar *orgtbl-table* nil
4623 "Carries the current table through formatting routines.")
4624 (defvar *orgtbl-rtn* nil
4625 "Formatting routines push the output lines here.")
4626 ;; Formatting parameters for the current table section.
4627 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4628 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4629 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4630 (defvar *orgtbl-fmt* nil "Format for each entry.")
4631 (defvar *orgtbl-efmt* nil "Format for numbers.")
4632 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4633 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4634 (defvar *orgtbl-lstart* nil "Text starting a row.")
4635 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4636 (defvar *orgtbl-lend* nil "Text ending a row.")
4637 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4639 (defsubst orgtbl-get-fmt (fmt i)
4640 "Retrieve the format from FMT corresponding to the Ith column."
4641 (if (and (not (functionp fmt)) (consp fmt))
4642 (plist-get fmt i)
4643 fmt))
4645 (defsubst orgtbl-apply-fmt (fmt &rest args)
4646 "Apply format FMT to arguments ARGS.
4647 When FMT is nil, return the first argument from ARGS."
4648 (cond ((functionp fmt) (apply fmt args))
4649 (fmt (apply 'format fmt args))
4650 (args (car args))
4651 (t args)))
4653 (defsubst orgtbl-eval-str (str)
4654 "If STR is a function, evaluate it with no arguments."
4655 (if (functionp str)
4656 (funcall str)
4657 str))
4659 (defun orgtbl-format-line (line)
4660 "Format LINE as a table row."
4661 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4662 (let* ((i 0)
4663 (line
4664 (mapcar
4665 (lambda (f)
4666 (setq i (1+ i))
4667 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4668 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4669 (orgtbl-apply-fmt efmt (match-string 1 f)
4670 (match-string 2 f))
4671 f)))
4672 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4673 *orgtbl-default-fmt*)
4674 f)))
4675 line)))
4676 (push (if *orgtbl-lfmt*
4677 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4678 (concat (orgtbl-eval-str *orgtbl-lstart*)
4679 (mapconcat 'identity line *orgtbl-sep*)
4680 (orgtbl-eval-str *orgtbl-lend*)))
4681 *orgtbl-rtn*))))
4683 (defun orgtbl-format-section (section-stopper)
4684 "Format lines until the first occurrence of SECTION-STOPPER."
4685 (let (prevline)
4686 (progn
4687 (while (not (eq (car *orgtbl-table*) section-stopper))
4688 (if prevline (orgtbl-format-line prevline))
4689 (setq prevline (pop *orgtbl-table*)))
4690 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4691 (*orgtbl-lend* *orgtbl-llend*)
4692 (*orgtbl-lfmt* *orgtbl-llfmt*))
4693 (orgtbl-format-line prevline))))))
4695 ;;;###autoload
4696 (defun orgtbl-to-generic (table params &optional backend)
4697 "Convert the orgtbl-mode TABLE to some other format.
4698 This generic routine can be used for many standard cases.
4699 TABLE is a list, each entry either the symbol `hline' for a horizontal
4700 separator line, or a list of fields for that line.
4701 PARAMS is a property list of parameters that can influence the conversion.
4702 A third optional argument BACKEND can be used to convert the content of
4703 the cells using a specific export back-end.
4705 For the generic converter, some parameters are obligatory: you need to
4706 specify either :lfmt, or all of (:lstart :lend :sep).
4708 Valid parameters are:
4710 :splice When set to t, return only table body lines, don't wrap
4711 them into :tstart and :tend. Default is nil. When :splice
4712 is non-nil, this also means that the exporter should not look
4713 for and interpret header and footer sections.
4715 :hline String to be inserted on horizontal separation lines.
4716 May be nil to ignore hlines.
4718 :sep Separator between two fields
4719 :remove-nil-lines Do not include lines that evaluate to nil.
4721 Each in the following group may be either a string or a function
4722 of no arguments returning a string:
4724 :tstart String to start the table. Ignored when :splice is t.
4725 :tend String to end the table. Ignored when :splice is t.
4726 :lstart String to start a new table line.
4727 :llstart String to start the last table line, defaults to :lstart.
4728 :lend String to end a table line
4729 :llend String to end the last table line, defaults to :lend.
4731 Each in the following group may be a string, a function of one
4732 argument (the field or line) returning a string, or a plist
4733 mapping columns to either of the above:
4735 :lfmt Format for entire line, with enough %s to capture all fields.
4736 If this is present, :lstart, :lend, and :sep are ignored.
4737 :llfmt Format for the entire last line, defaults to :lfmt.
4738 :fmt A format to be used to wrap the field, should contain
4739 %s for the original field value. For example, to wrap
4741 This may also be a property list with column numbers and
4743 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4744 Same as above, specific for the header lines in the table.
4745 All lines before the first hline are treated as header.
4746 If any of these is not present, the data line value is used.
4748 This may be either a string or a function of two arguments:
4750 :efmt Use this format to print numbers with exponentials.
4751 The format should have %s twice for inserting mantissa
4753 may also be a property list with column numbers and
4754 formats. :fmt will still be applied after :efmt.
4756 In addition to this, the parameters :skip and :skipcols are always handled
4757 directly by `orgtbl-send-table'. See manual."
4758 (let* ((splicep (plist-get params :splice))
4759 (hline (plist-get params :hline))
4760 (skipheadrule (plist-get params :skipheadrule))
4761 (remove-nil-linesp (plist-get params :remove-nil-lines))
4762 (remove-newlines (plist-get params :remove-newlines))
4763 (*orgtbl-hline* hline)
4764 (*orgtbl-table* table)
4765 (*orgtbl-sep* (plist-get params :sep))
4766 (*orgtbl-efmt* (plist-get params :efmt))
4767 (*orgtbl-lstart* (plist-get params :lstart))
4768 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4769 (*orgtbl-lend* (plist-get params :lend))
4770 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4771 (*orgtbl-lfmt* (plist-get params :lfmt))
4772 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4773 (*orgtbl-fmt* (plist-get params :fmt))
4774 *orgtbl-rtn*)
4775 ;; Convert cells content to backend BACKEND
4776 (when backend
4777 (setq *orgtbl-table*
4778 (mapcar
4779 (lambda(r)
4780 (if (listp r)
4781 (mapcar
4782 (lambda (c)
4783 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4784 r)
4785 r))
4786 *orgtbl-table*)))
4787 ;; Put header
4788 (unless splicep
4789 (when (plist-member params :tstart)
4790 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4791 (if tstart (push tstart *orgtbl-rtn*)))))
4792 ;; If we have a heading, format it and handle the trailing hline.
4793 (if (and (not splicep)
4794 (or (consp (car *orgtbl-table*))
4795 (consp (nth 1 *orgtbl-table*)))
4796 (memq 'hline (cdr *orgtbl-table*)))
4797 (progn
4798 (when (eq 'hline (car *orgtbl-table*))
4799 ;; There is a hline before the first data line
4800 (and hline (push hline *orgtbl-rtn*))
4801 (pop *orgtbl-table*))
4802 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4803 *orgtbl-lstart*))
4804 (*orgtbl-llstart* (or (plist-get params :hllstart)
4805 *orgtbl-llstart*))
4806 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4807 (*orgtbl-llend* (or (plist-get params :hllend)
4808 (plist-get params :hlend) *orgtbl-llend*))
4809 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4810 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4811 (plist-get params :hlfmt) *orgtbl-llfmt*))
4812 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4813 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4814 (orgtbl-format-section 'hline))
4815 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4816 (pop *orgtbl-table*)))
4817 ;; Now format the main section.
4818 (orgtbl-format-section nil)
4819 (unless splicep
4820 (when (plist-member params :tend)
4821 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4822 (if tend (push tend *orgtbl-rtn*)))))
4823 (mapconcat (if remove-newlines
4824 (lambda (tend)
4826 'identity)
4827 (nreverse (if remove-nil-linesp
4828 (remq nil *orgtbl-rtn*)
4831 ;;;###autoload
4832 (defun orgtbl-to-tsv (table params)
4833 "Convert the orgtbl-mode table to TAB separated material."
4835 ;;;###autoload
4836 (defun orgtbl-to-csv (table params)
4837 "Convert the orgtbl-mode table to CSV material.
4838 This does take care of the proper quoting of fields with comma or quotes."
4839 (orgtbl-to-generic table (org-combine-plists
4840 '(:sep "," :fmt org-quote-csv-field)
4841 params)))
4843 ;;;###autoload
4844 (defun orgtbl-to-latex (table params)
4845 "Convert the orgtbl-mode TABLE to LaTeX.
4846 TABLE is a list, each entry either the symbol `hline' for a horizontal
4847 separator line, or a list of fields for that line.
4848 PARAMS is a property list of parameters that can influence the conversion.
4849 Supports all parameters from `orgtbl-to-generic'. Most important for
4850 LaTeX are:
4852 :splice When set to t, return only table body lines, don't wrap
4853 them into a tabular environment. Default is nil.
4855 :fmt A format to be used to wrap the field, should contain %s for the
4856 original field value. For example, to wrap everything in dollars,
4859 The format may also be a function that formats its one argument.
4861 :efmt Format for transforming numbers with exponentials. The format
4862 should have %s twice for inserting mantissa and exponent, for
4864 This may also be a property list with column numbers and formats.
4865 The format may also be a function that formats its two arguments.
4867 :llend If you find too much space below the last line of a table,
4870 The general parameters :skip and :skipcols have already been applied when
4871 this function is called."
4872 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4873 org-table-last-alignment ""))
4874 (params2
4875 (list
4880 (require 'ox-latex)
4881 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4883 ;;;###autoload
4884 (defun orgtbl-to-html (table params)
4885 "Convert the orgtbl-mode TABLE to HTML.
4886 TABLE is a list, each entry either the symbol `hline' for a horizontal
4887 separator line, or a list of fields for that line.
4888 PARAMS is a property list of parameters that can influence the conversion.
4889 Currently this function recognizes the following parameters:
4891 :splice When set to t, return only table body lines, don't wrap
4892 them into a <table> environment. Default is nil.
4894 The general parameters :skip and :skipcols have already been applied when
4895 this function is called. The function does *not* use `orgtbl-to-generic',
4896 so you cannot specify parameters for it."
4897 (require 'ox-html)
4898 (let ((output (org-export-string-as
4899 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4900 (if (not (plist-get params :splice)) output
4901 (org-trim
4902 (replace-regexp-in-string
4906 ;;;###autoload
4907 (defun orgtbl-to-texinfo (table params)
4908 "Convert the orgtbl-mode TABLE to TeXInfo.
4909 TABLE is a list, each entry either the symbol `hline' for a horizontal
4910 separator line, or a list of fields for that line.
4911 PARAMS is a property list of parameters that can influence the conversion.
4912 Supports all parameters from `orgtbl-to-generic'. Most important for
4913 TeXInfo are:
4915 :splice nil/t When set to t, return only table body lines, don't wrap
4916 them into a multitable environment. Default is nil.
4918 :fmt fmt A format to be used to wrap the field, should contain
4919 %s for the original field value. For example, to wrap
4921 This may also be a property list with column numbers and
4923 Each format also may be a function that formats its one
4924 argument.
4927 are computed automatically from the width of the columns
4928 under org-mode.
4930 The general parameters :skip and :skipcols have already been applied when
4931 this function is called."
4932 (let* ((total (float (apply '+ org-table-last-column-widths)))
4933 (colfrac (or (plist-get params :cf)
4934 (mapconcat
4935 (lambda (x) (format "%.3f" (/ (float x) total)))
4936 org-table-last-column-widths " ")))
4937 (params2
4938 (list
4939 :tstart (concat "@multitable @columnfractions " colfrac)
4940 :tend "@end multitable"
4941 :lstart "@item " :lend "" :sep " @tab "
4942 :hlstart "@headitem ")))
4943 (require 'ox-texinfo)
4944 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4946 ;;;###autoload
4947 (defun orgtbl-to-orgtbl (table params)
4948 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4949 Useful when slicing one table into many. The :hline, :sep,
4950 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4951 and :tend suppress strings without splicing; they can be set to
4952 provide ORGTBL directives for the generated table."
4953 (let* ((params2
4954 (list
4955 :remove-newlines t
4956 :tstart nil :tend nil
4957 :hline "|---"
4958 :sep " | "
4959 :lstart "| "
4960 :lend " |"))
4961 (params (org-combine-plists params2 params)))
4962 (with-temp-buffer
4963 (insert (orgtbl-to-generic table params))
4964 (goto-char (point-min))
4965 (while (re-search-forward org-table-hline-regexp nil t)
4966 (org-table-align))
4967 (buffer-substring 1 (buffer-size)))))
4969 (defun orgtbl-to-table.el (table params)
4970 "Convert the orgtbl-mode TABLE into a table.el table."
4971 (with-temp-buffer
4972 (insert (orgtbl-to-orgtbl table params))
4973 (org-table-align)
4974 (replace-regexp-in-string
4975 "-|" "-+"
4976 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4978 (defun orgtbl-to-unicode (table params)
4979 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4980 You need the ascii-art-to-unicode.el package for this. You can download
4981 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4982 (with-temp-buffer
4983 (insert (orgtbl-to-table.el table params))
4984 (goto-char (point-min))
4985 (if (or (featurep 'ascii-art-to-unicode)
4986 (require 'ascii-art-to-unicode nil t))
4987 (aa2u)
4988 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4989 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4990 "Link to ascii-art-to-unicode.el") org-stored-links))
4991 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4992 (buffer-string)))
4994 (defun org-table-get-remote-range (name-or-id form)
4995 "Get a field value or a list of values in a range from table at ID.
4997 NAME-OR-ID may be the name of a table in the current file as set
4999 will then be used. Alternatively, it may be an ID referring to
5000 any entry, also in a different file. In this case, the first
5001 table in that entry will be referenced.
5005 The return value is either a single string for a single field, or a
5006 list of the fields in the rectangle."
5007 (save-match-data
5008 (let ((case-fold-search t) (id-loc nil)
5009 ;; Protect a bunch of variables from being overwritten
5010 ;; by the context of the remote table
5011 org-table-column-names org-table-column-name-regexp
5012 org-table-local-parameters org-table-named-field-locations
5013 org-table-current-line-types org-table-current-begin-line
5014 org-table-current-begin-pos org-table-dlines
5015 org-table-current-ncol
5016 org-table-hlines org-table-last-alignment
5017 org-table-last-column-widths org-table-last-alignment
5018 org-table-last-column-widths tbeg
5019 buffer loc)
5020 (setq form (org-table-convert-refs-to-rc form))
5021 (save-excursion
5022 (save-restriction
5023 (widen)
5024 (save-excursion
5025 (goto-char (point-min))
5026 (if (re-search-forward
5029 nil t)
5030 (setq buffer (current-buffer) loc (match-beginning 0))
5031 (setq id-loc (org-id-find name-or-id 'marker))
5032 (unless (and id-loc (markerp id-loc))
5034 (setq buffer (marker-buffer id-loc)
5035 loc (marker-position id-loc))
5036 (move-marker id-loc nil)))
5037 (with-current-buffer buffer
5038 (save-excursion
5039 (save-restriction
5040 (widen)
5041 (goto-char loc)
5042 (forward-char 1)
5044 (not (match-beginning 1)))
5045 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5046 (setq tbeg (point-at-bol))
5047 (org-table-get-specials)
5048 (setq form (org-table-formula-substitute-names
5049 (org-table-formula-handle-first/last-rc form)))
5050 (if (and (string-match org-table-range-regexp form)
5051 (> (length (match-string 0 form)) 1))
5052 (save-match-data
5053 (org-table-get-range (match-string 0 form) tbeg 1))
5054 form)))))))))
5056 (defun org-table-remote-reference-indirection (form)
5057 "Return formula with table remote references substituted by indirection.
5059 This indirection works only with the format @ROW$COLUMN. The
5061 distinguished from a plain table name or ID."
5062 (let ((start 0))
5063 (while (string-match (concat
5064 ;; Same as in `org-table-eval-formula'.
5066 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5068 ;; Same as in `org-table-eval-formula'.
5070 form
5071 start)
5072 ;; The position of the character as far as possible to the right
5073 ;; that will not be replaced and particularly not be shifted by
5074 ;; `replace-match'.
5075 (setq start (match-beginning 1))
5076 ;; Substitute the remote reference with the value found in the
5077 ;; field.
5078 (setq form
5079 (replace-match
5080 (save-match-data
5081 (org-table-get-range (org-table-formula-handle-first/last-rc
5082 (match-string 1 form))))
5083 t t form 1))))
5084 form)
5086 (defmacro org-define-lookup-function (mode)
5087 (let ((mode-str (symbol-name mode))
5088 (first-p (equal mode 'first))
5089 (all-p (equal mode 'all)))
5090 (let ((plural-str (if all-p "s" "")))
5091 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5092 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5093 If R-LIST is nil, return matching element%s of S-LIST.
5094 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5095 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5096 This function is generated by a call to the macro `org-define-lookup-function'."
5097 mode-str plural-str plural-str plural-str)
5098 (let ,(let ((lvars '((p (or predicate 'equal))
5099 (sl s-list)
5100 (rl (or r-list s-list))
5101 (ret nil))))
5102 (if first-p (add-to-list 'lvars '(match-p nil)))
5103 lvars)
5104 (while ,(if first-p '(and (not match-p) sl) 'sl)
5105 (progn
5106 (if (funcall p val (car sl))
5107 (progn
5108 ,(if first-p '(setq match-p t))
5109 (let ((rval (car rl)))
5110 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5111 (setq sl (cdr sl) rl (cdr rl))))
5112 ret)))))
5114 (org-define-lookup-function first)
5115 (org-define-lookup-function last)
5116 (org-define-lookup-function all)
5118 (provide 'org-table)
5120 ;; Local variables:
5121 ;; generated-autoload-file: "org-loaddefs.el"
5122 ;; End:
5124 ;;; org-table.el ends here