| blob | 33fcb41c838a7d47b32256e709c3a9e0ce763e68 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2012 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
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 All occurrences of %n in a template will be replaced with the name of the
98 table, obtained by prompting the user."
105 "Settings for tables in Org-mode."
110 "The default size for newly created tables, Columns x Rows."
116 "Regular expression for recognizing numbers in table columns.
117 If a table column contains mostly numbers, it will be aligned to the
118 right. If not, it will be aligned to the left.
120 The default value of this option is a regular expression which allows
121 anything which looks remotely like a number as used in scientific
122 context. For example, all of the following will be considered a
123 number:
124 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
126 Other options offered by the customize interface are more restrictive."
146 "Fraction of numbers in a column required to make the column align right.
147 In a column all non-white fields are considered. If at least
148 this fraction of fields is matched by `org-table-number-regexp',
149 alignment to the right border applies."
154 "Behavior of tables during editing in Org-mode."
159 "Non-nil means automatically re-align table when pressing TAB or RETURN.
161 removal/insertion."
166 "Non-nil means automatically blank table field when starting to type into it.
167 This only happens when typing immediately after a field motion
168 command (TAB, S-TAB or RET).
169 Only relevant when `org-enable-table-editor' is equal to `optimized'."
174 "Non-nil means automatically exit the follow mode.
175 When nil, the follow mode will stay on and be active in any table
176 the cursor enters. Since the table follow filed mode messes with the
177 window configuration, it is not recommended to set this variable to nil,
178 except maybe locally in a special file that has mostly tables with long
179 fields."
185 "Whether the user should confirm when Org fixes formulas."
193 'safe-local-variable
197 "Non-nil means tab in the last column of a table with jump over a hline.
198 If a horizontal separator line is following the current line,
199 `org-table-next-field' can either create a new row before that line, or jump
200 over the line. When this option is nil, a new line will be created before
201 this line."
206 "Options concerning tables in Org-mode."
211 "Should org-mode work with table references like B3 instead of @3$2?
212 Possible values are:
213 nil never use them
214 from accept as input, do not present for editing
215 t accept as input and present for editing"
230 calc-angle-mode deg
231 calc-prefer-frac nil
232 calc-symbolic-mode nil
234 calc-display-working-message t
235 )
236 "List with Calc mode settings for use in `calc-eval' for table formulas.
237 The list must contain alternating symbols (Calc modes variables and values).
238 Don't remove any of the default settings, just change the values. Org-mode
239 relies on the variables to be present in the list."
244 "Format for the output of calc computations like $1+$2;t.
245 The default value is 'hours, and will output the results as a
246 number of hours. Other allowed values are 'seconds, 'minutes and
247 'days, and the output will be a fraction of seconds, minutes or
248 days."
257 "Format for fields which contain the result of a formula.
259 characters. Beware that modifying the display can prevent the
260 field from being used in another formula."
266 "Non-nil means TAB and RET evaluate a formula in current table field.
267 If the current field starts with an equal sign, it is assumed to be a formula
268 which should be evaluated as described in the manual and in the documentation
269 string of the command `org-table-eval-formula'. This feature requires the
270 Emacs calc package.
271 When this variable is nil, formula calculation is only available through
277 "Non-nil means interpret constants in formulas in tables.
278 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
279 by the value given in `org-table-formula-constants', or by a value obtained
280 from the `constants.el' package."
285 "Alist with constant names and values, for use in table formulas.
286 The car of each element is a name of a constant, without the `$' before it.
287 The cdr is the value as a string. For example, if you'd like to use the
288 speed of light in a formula, you would configure
292 and then use it in an equation like `$1*$c'.
294 Constants can also be defined on a per-file basis using a line like
296 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
303 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
304 Automatically means when TAB or RET or C-c C-c are pressed in the line."
309 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
314 "Non-nil means relative formula references may cross hlines.
315 Here are the allowed values:
317 nil Relative references may not cross hlines. They will reference the
318 field next to the hline instead. Coming from below, the reference
319 will be to the field below the hline. Coming from above, it will be
320 to the field above.
321 t Relative references may cross hlines.
322 error An attempt to cross a hline will throw an error.
324 It is probably good to never set this variable to nil, for the sake of
325 portability of tables."
333 "Options concerning table import and export in Org-mode."
338 "Default export parameters for `org-table-export'.
339 These can be overridden for a specific table by setting the
340 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
341 radio tables for the different export transformations and
342 available parameters."
380 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
381 ;; 1 2 3 4 5
392 "Is this a table line colgroup information?"
396 line)
398 nil
405 "Is this a table line with only alignment/width cookies?"
418 s))))
426 ;;;###autoload
428 "Use the table.el package to insert a new table.
429 If there is already a table at point, convert between Org-mode tables
430 and table.el tables."
443 ;;;###autoload
445 "Convert region to table, or create an empty table.
446 If there is an active region, convert it to a table, using the function
447 `org-table-convert-region'. See the documentation of that function
448 to learn how the prefix argument is interpreted to determine the field
449 separator.
450 If there is no such region, create an empty table with `org-table-create'."
456 ;;;###autoload
458 "Query for a size and insert a table skeleton.
478 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
482 ;; Insert a hline after the first row.
489 ;;;###autoload
491 "Convert region to a table.
492 The region goes from BEG0 to END0, but these borders will be moved
493 slightly, to make sure a beginning of line in the first line is included.
495 SEPARATOR specifies the field separator in the lines. It can have the
496 following values:
498 '(4) Use the comma as a field separator
499 '(16) Use a TAB as field separator
500 integer When a number, use that many spaces as field separator
501 nil When nil, the command tries to be smart and figure out the
502 separator in the following way:
503 - when each line contains a TAB, assume TAB-separated material
504 - when each line contains a comma, assume CSV material
505 - else, assume one or more SPACE characters as separator."
509 re)
516 ;; Get the right field separator
527 ;; parse the csv stuff
550 ;;;###autoload
552 "Import FILE as a table.
553 The file is assumed to be tab-separated. Such files can be produced by most
554 spreadsheet and database applications. If no tabs (at least one per line)
555 are found, lines will be split on whitespace into fields."
566 ;;;###autoload
568 "Export table to a file, with configurable format.
569 Such a file can be imported into usual spreadsheet programs.
571 FILE can be the output file name. If not given, it will be taken
572 from a TABLE_EXPORT_FILE property in the current entry or higher
573 up in the hierarchy, or the user will be prompted for a file
574 name. FORMAT can be an export format, of the same kind as it
575 used when `orgtbl-mode' sends a table in a different format.
577 The command suggests a format depending on TABLE_EXPORT_FORMAT,
578 whether it is set locally or up in the hierarchy, then on the
579 extension of the given file name, and finally on the variable
580 `org-table-export-default-format'."
596 buf deffmt-readable fileext)
612 org-table-export-default-format))
630 'hline
633 skipcols i0)))
634 lines))
638 skipcols i0))
641 skipcols i0)))
658 "Marker at the beginning of the table last aligned.
661 "Marker at the end of the table last aligned.
664 "List of flags for flushright alignment, from the last re-alignment.
667 "List of max width of fields in each column.
670 "Non-nil means debug table formulas.
682 ;;;###autoload
684 "Align the table at point by aligning all vertical bars."
687 ;; Limits of table
690 ;; Current cursor position
696 column
698 rfmt hfmt
706 emptystrings links dates emph raise narrow
707 falign falign1 fmax f1 len c e space)
710 ;; Check if we have links or dates
722 ;; Make sure the link properties are right
724 ;; Make sure the date properties are right
729 ;; Check if we are narrowing any columns
732 org-format-transports-properties-p
737 ;; Get the rows
740 ;; Store the indentation of the first line
743 ;; Mark the hlines by setting the corresponding element to nil
744 ;; At the same time, we remove trailing space.
747 nil
750 l)))
751 lines))
752 ;; Get the data fields by splitting the lines.
757 ;; How many fields in the longest line?
764 ;; A list of empty strings to fill any short rows on output
766 ;; Check for special formatting.
770 ;; Check if there is an explicit width specified
780 ;; Find fields that are wider than fmax, and shorten them
786 'help-echo
787 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
795 xx)))))
796 ;; Get the maximum width for each column
798 lengths)
799 ;; Get the fraction of numbers, to decide about alignment of the column
805 nil
812 ;; Store the alignment of this table, for later editing of single fields
814 org-table-last-column-widths lengths)
816 ;; With invisible characters, `format' does not get the field width right
817 ;; So we need to make these fields wide by hand.
835 ;; Compute the formats needed for output of the table
848 hfmt))
852 ;; Replace the old one
859 ;; Try to move to the old location
867 ))
870 "Find the beginning of the table and return its position.
871 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
875 org-table-border-regexp)
876 nil t))
883 "Find the end of the table and return its position.
884 With argument TABLE-TYPE, go to the end of a table.el-type table."
888 org-table-border-regexp)
889 nil t))
894 ;;;###autoload
896 "Justify the current field, text to left, number to right.
897 Optional argument NEW may specify text to replace the current field content."
906 ;; This is not the same table, force a full re-align
912 l f n o e)
935 ;;;###autoload
937 "Go to the next field in the current table, creating new lines as needed.
938 Before doing so, re-align the table if necessary."
943 org-table-may-need-update)
954 org-table-tab-jumps-over-hlines
965 ;;;###autoload
967 "Go to the previous field in the table.
968 Before doing so, re-align the table if necessary."
973 org-table-may-need-update)
988 "Move to the end of the current table field.
989 If already at or after the end, move to the end of the next table field.
990 With numeric argument N, move N-1 fields forward first."
1003 "Move to the beginning of the current table field.
1004 If already at or before the beginning, move to the beginning of the
1005 previous field.
1006 With numeric argument N, move N-1 fields backward first."
1019 ;;;###autoload
1021 "Go to the next row (same column) in the current table.
1022 Before doing so, re-align the table if necessary."
1030 org-table-may-need-update)
1043 ;;;###autoload
1045 "Copy a field down in the current column.
1046 If the field at the cursor is empty, copy into it the content of
1047 the nearest non-empty field above. With argument N, use the Nth
1048 non-empty field. If the current field is not empty, it is copied
1049 down to the next row, and the cursor is moved with it.
1050 Therefore, repeating this command causes the column to be filled
1051 row-by-row.
1052 If the variable `org-table-copy-increment' is non-nil and the
1053 field is an integer or a timestamp, it will be incremented while
1054 copying. In the case of a timestamp, increment by one day."
1062 txt)
1074 beg t))
1097 "Is point inside a table data field?
1098 I.e. not on a hline or before the first or after the last column?
1099 This actually throws an error, so it aborts the current command."
1105 nil
1107 t))
1113 "Get the field in table line LINE, column COLUMN.
1114 If LINE is larger than the number of data lines in the table, the function
1115 returns nil. However, if COLUMN is too large, we will simply return an
1116 empty string.
1117 If LINE is nil, use the current line.
1118 If column is nil, use the current column."
1125 "Put VALUE into line LINE, column COLUMN.
1126 When ALIGN is set, also realign the table."
1135 "Return the index of the current data line."
1142 cnt))
1145 "Go to the Nth data line in the current table.
1146 Return t when the line exists, nil if it does not exist."
1154 "Blank the current table field or active region."
1171 "Return the value of the field in column N of current row.
1172 N defaults to current field.
1173 If REPLACE is a string, replace field with this value. The return value
1174 is always the old value."
1183 t t))
1185 val)
1188 ;;;###autoload
1190 "Show info about the current field, and highlight any reference at point."
1198 org-table-named-field-locations)))
1218 dline col
1220 dline col ref1
1222 ;; FIXME: formula info not correct if special table line
1232 "Find out which column we are in."
1242 cnt)))
1244 ;;;###autoload
1246 "Find out what table data line we are in.
1247 Only data lines count for this."
1259 cnt)))
1261 ;;;###autoload
1263 "Move the cursor to the Nth column in the current table line.
1264 With optional argument ON-DELIM, stop with point before the left delimiter
1265 of the field.
1266 If there are less than N fields, just go to after the last delimiter.
1267 However, when FORCE is non-nil, create new columns if necessary."
1277 t)))))
1284 ;;;###autoload
1286 "Insert a new column into the table."
1294 ;; Current cursor position
1300 nil
1314 "Find a data line in the current table, which is needed for column commands."
1317 t
1328 t
1333 "Turn a buffer line number into a data line number.
1334 If there is no data line in this line, return nil.
1335 If there is no matching dline (most likely te reference was a hline), the
1336 first dline below it is used. When ABOVE is non-nil, the one above is used."
1339 i)
1352 nil))
1354 ;;;###autoload
1356 "Delete a column from the table."
1365 ;; Current cursor position
1371 nil
1387 ;;;###autoload
1389 "Move column to the right."
1392 ;;;###autoload
1394 "Move column to the left."
1398 ;;;###autoload
1400 "Move the current column to the right. With arg LEFT, move to the left."
1410 ;; Current cursor position
1420 nil
1438 ;;;###autoload
1440 "Move table row down."
1443 ;;;###autoload
1445 "Move table row up."
1449 ;;;###autoload
1451 "Move the current table line down. With arg UP, move it up."
1460 txt hline2p)
1483 ;;;###autoload
1485 "Insert a new row above the current line into the table.
1486 With prefix ARG, insert below the current line."
1492 ;; Fix the first field if necessary
1505 ;;;###autoload
1507 "Insert a horizontal-line below the current line into the table.
1508 With prefix ABOVE, insert above the current line."
1529 ;;;###autoload
1531 "Insert a hline and move to the row below that line."
1545 In particular, this does handle wide and invisible characters."
1547 ;; It's a hline, just map the characters
1553 t t s)))
1554 s))
1556 ;;;###autoload
1558 "Delete the current row or horizontal line from the table."
1572 ;;;###autoload
1574 "Sort table lines according to the column at point.
1576 The position of point indicates the column to be used for
1577 sorting, and the range of lines is the range between the nearest
1578 horizontal separator lines, or the entire table of no such lines
1579 exist. If point is before the first column, you will be prompted
1580 for the sorting column. If there is an active region, the mark
1581 specifies the first line and the sorting column, while point
1582 should be in the last line to be included into the sorting.
1584 The command then prompts for the sorting type which can be
1585 alphabetically, numerically, or by time (as given in a time stamp
1586 in the field). Sorting in reverse order is also possible.
1588 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1590 If SORTING-TYPE is specified when this function is called from a Lisp
1591 program, no prompting will take place. SORTING-TYPE must be a character,
1592 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1593 should be done in reverse order."
1597 beg end bcol ecol tend tbeg column lns pos)
1642 x))
1653 ;;;###autoload
1655 "Copy region in table to the clipboard and blank all relevant fields.
1656 If there is no active region, use just the field at point."
1662 ;;;###autoload
1664 "Copy rectangular region in table to clipboard.
1665 A special clipboard is used which can only be accessed
1666 with `org-table-paste-rectangle'."
1670 current-prefix-arg))
1672 region cols
1698 org-table-clip))
1700 ;;;###autoload
1702 "Paste a rectangular region into a table.
1703 The upper right corner ends up in the current field. All involved fields
1704 will be overwritten. If the rectangle does not fit into the present table,
1705 the table is enlarged as needed. The process ignores horizontal separator
1706 lines."
1716 c cols field)
1731 ;;;###autoload
1733 "Convert from `org-mode' table to table.el and back.
1734 Obviously, this only works within limits. When an Org-mode table is
1735 converted to table.el, all horizontal separator lines get lost, because
1736 table.el uses these as cell boundaries and has no notion of horizontal lines.
1737 A table.el table can be converted to an Org-mode table only if it does not
1738 do row or column spanning. Multiline cells will become multiple cells.
1739 Beware, Org-mode does not test if the table can be successfully converted - it
1740 blindly applies a recipe that works for simple tables."
1744 ;; convert to Org-mode table
1753 ;; convert to table.el table
1756 ;; first, get rid of all horizontal lines
1760 ;; insert a hline before first
1764 ;; insert a hline after each line
1769 ;; replace "+" at beginning and ending of hlines
1778 "Transpose orgmode table at point and eliminate hlines.
1779 So a table like
1781 | 1 | 2 | 4 | 5 |
1782 |---+---+---+---|
1783 | a | b | c | d |
1784 | e | f | g | h |
1786 will be transposed as
1788 | 1 | a | e |
1789 | 2 | b | f |
1790 | 4 | c | g |
1791 | 5 | d | h |
1793 Note that horizontal lines disappeared."
1797 ;; remove 'hline from list
1805 ;;;###autoload
1807 "Wrap several fields in a column like a paragraph.
1808 This is useful if you'd like to spread the contents of a field over several
1809 lines, in order to keep the table compact.
1811 If there is an active region, and both point and mark are in the same column,
1812 the text in the column is wrapped to minimum width for the given number of
1813 lines. Generally, this makes the table more compact. A prefix ARG may be
1815 formats the selected text to two lines. If the region was longer than two
1816 lines, the remaining lines remain empty. A negative prefix argument reduces
1817 the current number of lines by that amount. The wrapped text is pasted back
1818 into the table. If you formatted it to more lines than it was before, fields
1819 further down in the table get overwritten - so you might need to make space in
1820 the table first.
1822 If there is no region, the current field is split at the cursor position and
1823 the text fragment to the right of the cursor is prepended to the field one
1824 line down.
1826 If there is no region, but you specify a prefix ARG, the current field gets
1827 blank, and the content is appended to the field above."
1831 ;; There is a region: fill as a paragraph
1835 nlines)
1842 arg)
1846 nil nlines)))
1850 ;; No region, split the current field at point
1854 ;; combine with field above
1864 ;; split field
1876 ;;;###autoload
1878 "Edit table field in a different window.
1879 This is mainly useful for fields that contain hidden parts.
1881 it can be edited in place."
1890 display t intangible t))
1903 p)
1919 intangible t))
1927 "Finish editing a table data field.
1928 Remove all newline characters, insert the result into the table, realign
1929 the table and kill the editing buffer."
1933 text)
1950 "Minor mode to make the table field editor window follow the cursor.
1951 When this mode is active, the field editor window will always show the
1952 current field. The mode exits automatically when the cursor leaves the
1953 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1954 nil " TblFollow" nil
1970 ;; We have left the table, exit the follow mode
1980 ;;;###autoload
1982 "Sum numbers in region of current table column.
1983 The result will be displayed in the echo area, and will be available
1986 If there is an active region, it is interpreted as a rectangle and all
1987 numbers in that rectangle will be summed. If there is no active
1988 region and point is located in a table column, sum all numbers in that
1989 column.
1991 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1992 numbers are assumed to be times as well (in decimal hours) and the
1993 numbers are added as such.
1995 If NLAST is a number, only the NLAST fields will actually be summed."
2022 items1)))
2029 s diff)
2037 sres))))
2060 "Return the formula active for the current field.
2061 Assumes that specials are in place.
2062 If KEY is given, return the key to this formula.
2066 org-table-named-field-locations)))
2080 "Read a formula from the minibuffer, offer stored formula as default.
2081 When NAMED is non-nil, look for a named equation."
2085 org-table-named-field-locations)))
2092 name
2093 ref)
2103 stored)
2105 equation)
2112 scol))
2114 'org-table-formula-history
2115 )))))
2116 mustsave)
2118 ;; remove formula
2125 ;; We set the column equation, delete the named one.
2127 mustsave t))
2133 eq))
2136 "Store the list of formulas below the current table."
2143 ;; don't overwrite TBLFM, we might use text properties to store stuff
2159 ;; Fake a high number to make sure this is sorted at the end.
2166 a)
2176 "Compare two formulas for sorting."
2181 ;;;###autoload
2183 "Return an alist with the stored formulas directly after current table."
2192 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2211 "Modify the equations after the table structure has been edited.
2213 For all numbers larger than LIMIT, shift them by DELTA."
2225 s n a)
2245 "Get the column names and local parameters for this table."
2248 names name fields fields1 field cnt
2249 c v l line col types dlines hlines last-dline)
2251 org-table-local-parameters nil
2252 org-table-named-field-locations nil
2253 org-table-current-begin-line nil
2254 org-table-current-begin-pos nil
2255 org-table-current-line-types nil
2274 org-table-local-parameters))))
2290 ;; Analyse the line types
2294 l org-table-current-begin-line)
2311 al al2)
2321 ;;;###autoload
2324 If yes, store the formula and apply it."
2325 ;; We already know we are in a table. Get field will only return a formula
2326 ;; when appropriate. It might return a separator line, but no problem.
2329 named eq)
2340 "List of commands triggering the recalculation of a line.
2352 ;;;###autoload
2354 "Rotate the recalculation mark in the first column.
2355 If in any row, the first field is not consistent with a mark,
2356 insert a new column for the markers.
2357 When there is an active region, change all the lines in the region,
2358 after prompting for the marking character.
2359 After each change, a message will be displayed indicating the meaning
2360 of the new mark."
2375 epos new)
2382 newchar))
2414 ;;;###autoload
2416 "Recompute the current line if marked for it, and if we haven't just done it."
2436 org-tbl-calc-modes)
2438 ;;;###autoload
2440 suppress-align suppress-const
2441 suppress-store suppress-analysis)
2442 "Replace the table field value at the cursor by the result of a calculation.
2444 This function makes use of Dave Gillespie's Calc package, in my view the
2445 most exciting program ever written for GNU Emacs. So you need to have Calc
2446 installed in order to use this function.
2448 In a table, this command replaces the value in the current field with the
2450 formula, by storing it in a special line below the table. When called
2451 with a `C-u' prefix, the current field must be a named field, and the
2452 formula is installed as valid in only this specific field.
2454 When called with two `C-u' prefixes, insert the active equation
2455 for the field back into the current field, so that it can be
2457 to check the referenced fields.
2459 When called, the command first prompts for a formula, which is read in
2460 the minibuffer. Previously entered formulas are available through the
2461 history list, and the last used formula is offered as a default.
2462 These stored formulas are adapted correctly when moving, inserting, or
2463 deleting columns with the corresponding commands.
2465 The formula can be any algebraic expression understood by the Calc package.
2466 For details, see the Org-mode manual.
2468 This function can also be called from Lisp programs and offers
2469 additional arguments: EQUATION can be the formula to apply. If this
2470 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2471 used to speed-up recursive calls by by-passing unnecessary aligns.
2472 SUPPRESS-CONST suppresses the interpretation of constants in the
2473 formula, assuming that this has been done already outside the function.
2474 SUPPRESS-STORE means the formula should not be stored, either because
2475 it is already stored, or because it is a modified equation that should
2476 not overwrite the stored one."
2492 equation
2498 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2499 duration duration-output-format)
2500 ;; Parse the format string. Since we have a lot of modes, this is
2501 ;; a lot of work. However, I think calc still uses most of the time.
2514 'calc-float-format
2517 n))))
2521 duration-output-format nil
2525 duration-output-format org-table-duration-custom-format
2526 numbers t
2549 ;; replace fields with duration values if relevant
2553 fields)))
2557 fields)))
2563 ;; Insert row and column number of formula result field
2574 t t form)))
2576 ;; Check for old vertical references
2578 ;; Insert remote references
2590 rmtrng))
2591 keep-empty numbers lispp))
2592 t t form)))
2593 ;; Insert complex ranges
2601 ;; possibly handle durations
2606 formrg)
2607 keep-empty numbers lispp)))
2612 ;; Insert simple ranges
2621 keep-empty numbers lispp))
2622 t t form)))
2624 ;; Insert the references to fields in same row
2634 t t form)))
2646 ;; "Inactivate" time-stamps so that Calc can handle them
2649 form
2655 duration-output-format)
2656 ev)))
2661 Orig: %s
2662 $xyz-> %s
2663 @r$c-> %s
2695 prop value)))
2698 "Get a calc vector from a column, according to descriptor DESC.
2699 Optional arguments TBEG and COL can give the beginning of the table and
2700 the current column, to avoid unnecessary parsing.
2702 HIGHLIGHT means just highlight the range.
2704 When CORNERS-ONLY is set, only return the corners of the range as
2705 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2706 in the buffer and column1 and column2 are table column numbers."
2713 beg end c1 c2 r1 r2 rangep tmp)
2730 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2737 ;; just one field
2744 ;; A range, return a vector
2745 ;; First sort the numbers to get a regular rectangle
2749 ;; Only return the corners of the range
2751 ;; Copy the range values into a list
2765 ;; return string representation of calc vector
2770 "Analyze descriptor DESC and retrieve the corresponding line number.
2771 The cursor is currently in line CLINE, the table begins in line BLINE,
2772 and TABLE is a vector with line types."
2780 ;; 1 2 3 4 5 6
2800 nil hn cline desc)))
2803 rel on cline desc)))
2807 "FIXME: Needs more documentation."
2820 nil))
2821 t)))
2825 desc cline)
2826 i)))
2831 s))
2834 "Convert list ELEMENTS to something appropriate to insert into formula.
2835 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2836 NUMBERS indicates that everything should be converted to numbers.
2837 LISPP means to return something appropriate for a Lisp list."
2841 elements
2850 elements))))
2856 x
2862 elements
2865 ;;;###autoload
2867 "Recalculate the current table line by applying all stored formulas.
2868 With prefix arg ALL, do this for all lines in the table.
2869 With the prefix argument ALL is `(16)' \
2871 it is the symbol `iterate', recompute the table until it no longer changes.
2872 If NOALIGN is not nil, do not re-align the table after the computations
2873 are done. This is typically used internally to save time, if it is
2874 known that the table will be realigned a little later anyway."
2889 seen-fields lhs1
2891 ;; Insert constants in all formulas
2907 eqlist))
2908 ;; Split the equation list
2914 ;; Expand ranges in lhs of formulas
2917 ;; Get the correct line range to process
2923 ;; This is a table with marked lines, compute selected lines
2925 ;; Move forward to the first non-header line
2936 ;; First find the named fields, and mark them untouchable.
2937 ;; Also check if several field/range formulas try to set the same field.
2956 name)))
2966 ;; Now evaluate the column formulas, but skip fields covered by
2967 ;; field formulas
2971 ;; Unprotected line, recalculate
2983 ;; Now evaluate the field formulas
2997 ;; back to initial position
3004 ;;;###autoload
3006 "Recalculate the table until it does not change anymore.
3007 The maximum number of iterations is 10, but you can choose a different value
3008 with the prefix ARG."
3013 thistbl)
3027 ;;;###autoload
3029 "Recalculate all tables in the current buffer."
3036 ;;;###autoload
3038 "Iterate all tables in the buffer, to converge inter-table dependencies."
3043 c1)
3059 "Expand list of formulas.
3060 If some of the RHS in the formulas are ranges or a row reference, expand
3061 them to individual field equations for each field."
3067 ;; This just refers to one fixed field
3070 ;; This just refers to one fixed named field
3092 "Replace @<, @>, $<, $> with first/last row/column of the table.
3093 So @< and $< will always be replaced with @1 and $1, respectively.
3094 The advantage of these special markers are that structure editing of
3095 the table will not change them, while @1 and $1 will be modified
3096 when a line/row is swapped out of that privileged position. So for
3097 formulas that use a range of rows or columns, it may often be better
3099 borders of the table using the @< @> $< $> makers."
3102 s start)
3107 org-table-current-ncol)
3111 len
3118 s)
3121 "Replace $const with values in string F."
3123 ;; First, check for column names
3128 ;; Parameters and constants
3130 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3140 f))
3143 "Find the value for a parameter or constant in a formula.
3144 Parameters get priority."
3175 map))
3182 "--"
3185 "--"
3186 "Shift Reference at Point"
3191 "-"
3192 "Change Test Row for Column Formulas"
3195 "--"
3200 org-table-overlay-coordinates)]
3201 "--"
3207 ;;;###autoload
3209 "Edit the formulas of the current table in a separate buffer."
3211 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3225 entry s type title)
3228 ;; Keep global-font-lock-mode from turning on font-lock-mode
3269 "Convert a formula from internal to user representation."
3272 s))
3275 "Convert a formula from user to internal representation."
3278 s))
3281 "Convert spreadsheet references from A7 to @7$28.
3282 Works for single references, but also for entire formulas and even the
3283 full TBLFM line."
3285 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3288 ;; format match, just advance
3293 ;; 3.e5 or something like this.
3296 ;; (member (match-string 1 s)
3297 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3298 )
3299 ;; function name, just advance
3309 t t s)))))
3310 s))
3313 "Convert spreadsheet references from to @7$28 to AB7.
3314 Works for single references, but also for entire formulas and even the
3315 full TBLFM line."
3322 t t s)))
3327 t nil s)))
3328 s)
3331 "Convert a base 26 number represented by letters into an integer.
3332 For example: AB -> 28."
3338 n))
3341 "Convert an integer into a base 26 number represented by letters.
3342 For example: 28 -> AB."
3347 s))
3350 "Convert a time string into numerical duration in seconds.
3351 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3352 If S is a string representing a number, keep this number."
3354 s
3377 "Convert a number of seconds to a time string.
3378 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3379 minutes or seconds."
3394 "Convert all references in this buffer, using FUNCTION."
3404 "Convert all references in the buffer from B3 to @3$2 and back."
3414 "Shift the reference at point one row/hline up."
3418 "Shift the reference at point one row/hline down."
3422 "Shift the reference at point one field to the left."
3426 "Shift the reference at point one field to the right."
3437 ;; A B3-like reference
3443 ;; An internal reference
3449 "Re-match the group N, and replace it with the shifted reference."
3454 t t)))
3457 "Shift a reference part REF.
3458 If DECR is set, decrease the references row/column, else increase.
3459 If HLINE is set, this may be a hline reference, it certainly is not
3460 a translation reference."
3489 "Toggle the display of coordinates in the referenced table."
3498 "Parse the buffer for formula definitions and install them.
3499 With prefix ARG, apply the new formulas to the table."
3509 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3510 nil t)
3534 "Abort editing formulas, without installing the changes."
3545 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3586 "Show the location/value of the $ expression at point."
3595 var name e what match dest)
3600 "$1.."
3683 ;; column number
3711 org-table-fedit-scroll-down))))
3722 "Make sure the cursor is in a dataline in a table."
3731 p1 p2)))
3736 "Move cursor one line up in the window showing the table."
3741 "Move cursor one line down in the window showing the table."
3746 "Move the cursor in the window showing the table.
3747 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3772 "Add a new overlay."
3778 "Highlight rectangular region in a table."
3782 l1 c1 l2 c2 tmp)
3806 "Remove the rectangle overlays."
3817 "Add overlays to the table at point, to show row/column coordinates."
3845 ;;;###autoload
3847 "Toggle the display of Row/Column numbers in tables."
3858 ;;;###autoload
3860 "Toggle the formula debugger in tables."
3866 ;;; The orgtbl minor mode
3868 ;; Define a minor mode which can be used in other modes in order to
3869 ;; integrate the org-mode table editor.
3871 ;; This is really a hack, because the org-mode table editor uses several
3872 ;; keys which normally belong to the major mode, for example the TAB and
3873 ;; RET keys. Here is how it works: The minor mode defines all the keys
3874 ;; necessary to operate the table editor, but wraps the commands into a
3875 ;; function which tests if the cursor is currently inside a table. If that
3876 ;; is the case, the table editor command is executed. However, when any of
3877 ;; those keys is used outside a table, the function uses `key-binding' to
3878 ;; look up if the key has an associated command in another currently active
3879 ;; keymap (minor modes, major mode, global), and executes that command.
3880 ;; There might be problems if any of the keys used by the table editor is
3881 ;; otherwise used as a prefix key.
3883 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3884 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3885 ;; addresses this by checking explicitly for both bindings.
3887 ;; The optimized version (see variable `orgtbl-optimized') takes over
3888 ;; all keys which are bound to `self-insert-command' in the *global map*.
3889 ;; Some modes bind other commands to simple characters, for example
3890 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3891 ;; active, this binding is ignored inside tables and replaced with a
3892 ;; modified self-insert.
3910 ;; Install it as a minor mode.
3914 ;;;###autoload
3916 "The `org-mode' table editor as a minor mode for use in other modes."
3921 ;; Exit without error, in case some hook functions calls this
3922 ;; by accident in org-mode.
3926 ;; Make sure we are first in minor-mode-map-alist
3928 ;; FIXME: maybe it should use emulation-mode-map-alists?
3935 auto-fill-inhibit-regexp)
3939 auto-fill-inhibit-regexp)
3940 orgtbl-line-start-regexp))
3958 "Remove all properties related to narrow-column invisibility."
3971 "Create a function for binding in the table minor mode.
3972 FUN is the command to call inside a table. N is used to create a unique
3973 command name. KEYS are keys that should be checked in for a command
3974 to execute outside of tables."
3980 "Outside of tables, run the binding of `"
3992 keys)
3996 "Error when there is no default binding for a table key."
4001 "Setup orgtbl keymaps."
4032 elt key fun cmd)
4040 ;; Special treatment needed for TAB and RET
4060 [(tab)] "\C-i")))
4062 (org-defkey orgtbl-mode-map [backtab]
4064 [backtab] [S-iso-lefttab] [(shift tab)]
4065 [(tab)] "\C-i"))
4067 (org-defkey orgtbl-mode-map "\M-\C-m"
4068 (orgtbl-make-binding 'org-table-wrap-region 105
4069 "\M-\C-m" [(meta return)]))
4070 (org-defkey orgtbl-mode-map [(meta return)]
4071 (orgtbl-make-binding 'org-table-wrap-region 106
4072 [(meta return)] "\M-\C-m"))
4074 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4075 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4077 (when orgtbl-optimized
4078 ;; If the user wants maximum table support, we need to hijack
4079 ;; some standard editing functions
4080 (org-remap orgtbl-mode-map
4081 'self-insert-command 'orgtbl-self-insert-command
4082 'delete-char 'org-delete-char
4083 'delete-backward-char 'org-delete-backward-char)
4084 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4085 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4086 '("OrgTbl"
4087 ["Create or convert" org-table-create-or-convert-from-region
4088 :active (not (org-at-table-p)) :keys "C-c |" ]
4089 "--"
4090 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4091 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4092 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4093 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4094 "--"
4095 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4096 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4097 ["Copy Field from Above"
4098 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4099 "--"
4100 ("Column"
4101 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4102 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4103 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4104 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4105 ("Row"
4106 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4107 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4108 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4109 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4110 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4111 "--"
4112 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4113 ("Rectangle"
4114 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4115 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4116 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4117 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4118 "--"
4119 ("Radio tables"
4120 ["Insert table template" orgtbl-insert-radio-table
4121 (assq major-mode orgtbl-radio-table-templates)]
4122 ["Comment/uncomment table" orgtbl-toggle-comment t])
4123 "--"
4124 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4125 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4126 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4127 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4128 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4129 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4130 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4131 ["Sum Column/Rectangle" org-table-sum
4132 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4133 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4134 ["Debug Formulas"
4135 org-table-toggle-formula-debugger :active (org-at-table-p)
4136 :keys "C-c {"
4137 :style toggle :selected org-table-formula-debug]
4138 ["Show Col/Row Numbers"
4139 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4140 :keys "C-c }"
4141 :style toggle :selected org-table-overlay-coordinates]
4142 ))
4143 t))
4145 (defun orgtbl-ctrl-c-ctrl-c (arg)
4146 "If the cursor is inside a table, realign the table.
4147 If it is a table to be sent away to a receiver, do it.
4148 With prefix arg, also recompute table."
4149 (interactive "P")
4150 (let ((case-fold-search t) (pos (point)) action consts-str consts cst const-str)
4151 (save-excursion
4152 (beginning-of-line 1)
4153 (setq action (cond
4157 (cond
4158 ((integerp action)
4159 (goto-char action)
4160 (org-table-maybe-eval-formula)
4161 (if arg
4162 (call-interactively 'org-table-recalculate)
4163 (org-table-maybe-recalculate-line))
4164 (call-interactively 'org-table-align)
4165 (when (orgtbl-send-table 'maybe)
4166 (run-hooks 'orgtbl-after-send-table-hook)))
4167 ((eq action 'recalc)
4168 (save-excursion
4169 (goto-char (point-min))
4171 (setq const-str (substring-no-properties (match-string 1)))
4173 (when consts
4174 (let (e)
4175 (while (setq e (pop consts))
4177 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4178 (setq org-table-formula-constants-local cst)))))
4179 (save-excursion
4180 (beginning-of-line 1)
4182 (if (org-at-table-p)
4183 (org-call-with-arg 'org-table-recalculate t))))
4184 (t (let (orgtbl-mode)
4185 (call-interactively (key-binding "\C-c\C-c")))))))
4187 (defun orgtbl-create-or-convert-from-region (arg)
4188 "Create table or convert region to table, if no conflicting binding.
4189 This installs the table binding `C-c |', but only if there is no
4190 conflicting binding to this key outside orgtbl-mode."
4191 (interactive "P")
4192 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4193 (if cmd
4194 (call-interactively cmd)
4195 (call-interactively 'org-table-create-or-convert-from-region))))
4197 (defun orgtbl-tab (arg)
4198 "Justification and field motion for `orgtbl-mode'."
4199 (interactive "P")
4200 (if arg (org-table-edit-field t)
4201 (org-table-justify-field-maybe)
4202 (org-table-next-field)))
4204 (defun orgtbl-ret ()
4205 "Justification and field motion for `orgtbl-mode'."
4206 (interactive)
4207 (if (bobp)
4208 (newline)
4209 (org-table-justify-field-maybe)
4210 (org-table-next-row)))
4212 (defun orgtbl-self-insert-command (N)
4213 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4214 If the cursor is in a table looking at whitespace, the whitespace is
4215 overwritten, and the table is not marked as requiring realignment."
4216 (interactive "p")
4217 (if (and (org-at-table-p)
4218 (or
4219 (and org-table-auto-blank-field
4220 (member last-command
4221 '(orgtbl-hijacker-command-100
4222 orgtbl-hijacker-command-101
4223 orgtbl-hijacker-command-102
4224 orgtbl-hijacker-command-103
4225 orgtbl-hijacker-command-104
4226 orgtbl-hijacker-command-105
4227 yas/expand))
4228 (org-table-blank-field))
4229 t)
4230 (eq N 1)
4232 (let (org-table-may-need-update)
4233 (goto-char (1- (match-end 0)))
4234 (backward-delete-char 1)
4235 (goto-char (match-beginning 0))
4236 (self-insert-command N))
4237 (setq org-table-may-need-update t)
4238 (let* (orgtbl-mode
4239 a
4240 (cmd (or (key-binding
4241 (or (and (listp function-key-map)
4242 (setq a (assoc last-input-event function-key-map))
4243 (cdr a))
4244 (vector last-input-event)))
4245 'self-insert-command)))
4246 (call-interactively cmd)
4247 (if (and org-self-insert-cluster-for-undo
4248 (eq cmd 'self-insert-command))
4249 (if (not (eq last-command 'orgtbl-self-insert-command))
4250 (setq org-self-insert-command-undo-counter 1)
4251 (if (>= org-self-insert-command-undo-counter 20)
4252 (setq org-self-insert-command-undo-counter 1)
4253 (and (> org-self-insert-command-undo-counter 0)
4254 buffer-undo-list
4255 (not (cadr buffer-undo-list)) ; remove nil entry
4256 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4257 (setq org-self-insert-command-undo-counter
4258 (1+ org-self-insert-command-undo-counter))))))))
4261 "Regular expression matching exponentials as produced by calc.")
4263 (defun orgtbl-export (table target)
4264 (require 'org-exp)
4265 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4267 org-table-last-alignment org-table-last-column-widths
4268 maxcol column)
4269 (if (not (fboundp func))
4270 (error "Cannot export orgtbl table to %s" target))
4271 (setq lines (org-table-clean-before-export lines))
4272 (setq table
4273 (mapcar
4274 (lambda (x)
4275 (if (string-match org-table-hline-regexp x)
4276 'hline
4278 lines))
4279 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4280 table)))
4281 (loop for i from (1- maxcol) downto 0 do
4282 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4283 (setq column (delq nil column))
4284 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4285 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
4286 (funcall func table nil)))
4288 (defun orgtbl-gather-send-defs ()
4289 "Gather a plist of :name, :transform, :params for each destination before
4290 a radio table."
4291 (save-excursion
4292 (goto-char (org-table-begin))
4293 (let (rtn)
4294 (beginning-of-line 0)
4295 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4296 (let ((name (org-no-properties (match-string 1)))
4297 (transform (intern (match-string 2)))
4298 (params (if (match-end 3)
4299 (read (concat "(" (match-string 3) ")")))))
4300 (push (list :name name :transform transform :params params)
4301 rtn)
4302 (beginning-of-line 0)))
4303 rtn)))
4305 (defun orgtbl-send-replace-tbl (name txt)
4306 "Find and replace table NAME with TXT."
4307 (save-excursion
4308 (goto-char (point-min))
4309 (unless (re-search-forward
4311 (error "Don't know where to insert translated table"))
4312 (goto-char (match-beginning 0))
4313 (beginning-of-line 2)
4314 (save-excursion
4315 (let ((beg (point)))
4316 (unless (re-search-forward
4317 (concat "END RECEIVE ORGTBL +" name) nil t)
4318 (error "Cannot find end of insertion region"))
4319 (beginning-of-line 1)
4320 (delete-region beg (point))))
4323 ;;;###autoload
4324 (defun org-table-to-lisp (&optional txt)
4325 "Convert the table at point to a Lisp structure.
4326 The structure will be a list. Each item is either the symbol `hline'
4327 for a horizontal separator line, or a list of field values as strings.
4328 The table is taken from the parameter TXT, or from the buffer at point."
4329 (unless txt
4330 (unless (org-at-table-p)
4331 (error "No table at point")))
4332 (let* ((txt (or txt
4333 (buffer-substring-no-properties (org-table-begin)
4334 (org-table-end))))
4337 (mapcar
4338 (lambda (x)
4339 (if (string-match org-table-hline-regexp x)
4340 'hline
4342 lines)))
4344 (defun orgtbl-send-table (&optional maybe)
4345 "Send a transformed version of this table to the receiver position.
4346 With argument MAYBE, fail quietly if no transformation is defined for
4347 this table."
4348 (interactive)
4349 (catch 'exit
4350 (unless (org-at-table-p) (error "Not at a table"))
4351 ;; when non-interactive, we assume align has just happened.
4352 (when (org-called-interactively-p 'any) (org-table-align))
4353 (let ((dests (orgtbl-gather-send-defs))
4354 (txt (buffer-substring-no-properties (org-table-begin)
4355 (org-table-end)))
4356 (ntbl 0))
4357 (unless dests (if maybe (throw 'exit nil)
4358 (error "Don't know how to transform this table")))
4359 (dolist (dest dests)
4360 (let* ((name (plist-get dest :name))
4361 (transform (plist-get dest :transform))
4362 (params (plist-get dest :params))
4363 (skip (plist-get params :skip))
4364 (skipcols (plist-get params :skipcols))
4365 (no-escape (plist-get params :no-escape))
4366 beg
4367 (lines (org-table-clean-before-export
4368 (nthcdr (or skip 0)
4370 (i0 (if org-table-clean-did-remove-column 2 1))
4371 (lines (if no-escape lines
4372 (mapcar (lambda(l) (replace-regexp-in-string
4374 (table (mapcar
4375 (lambda (x)
4376 (if (string-match org-table-hline-regexp x)
4377 'hline
4378 (org-remove-by-index
4380 skipcols i0)))
4381 lines))
4382 (fun (if (= i0 2) 'cdr 'identity))
4383 (org-table-last-alignment
4384 (org-remove-by-index (funcall fun org-table-last-alignment)
4385 skipcols i0))
4386 (org-table-last-column-widths
4387 (org-remove-by-index (funcall fun org-table-last-column-widths)
4388 skipcols i0))
4389 (txt (if (fboundp transform)
4390 (funcall transform table params)
4391 (error "No such transformation function %s" transform))))
4392 (orgtbl-send-replace-tbl name txt))
4393 (setq ntbl (1+ ntbl)))
4394 (message "Table converted and installed at %d receiver location%s"
4395 ntbl (if (> ntbl 1) "s" ""))
4396 (if (> ntbl 0)
4397 ntbl
4398 nil))))
4400 (defun org-remove-by-index (list indices &optional i0)
4401 "Remove the elements in LIST with indices in INDICES.
4402 First element has index 0, or I0 if given."
4403 (if (not indices)
4404 list
4405 (if (integerp indices) (setq indices (list indices)))
4406 (setq i0 (1- (or i0 0)))
4407 (delq :rm (mapcar (lambda (x)
4408 (setq i0 (1+ i0))
4409 (if (memq i0 indices) :rm x))
4410 list))))
4412 (defun orgtbl-toggle-comment ()
4413 "Comment or uncomment the orgtbl at point."
4414 (interactive)
4415 (let* ((case-fold-search t)
4416 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4417 (re2 (concat "^" orgtbl-line-start-regexp))
4418 (commented (save-excursion (beginning-of-line 1)
4419 (cond ((looking-at re1) t)
4420 ((looking-at re2) nil)
4421 (t (error "Not at an org table")))))
4422 (re (if commented re1 re2))
4423 beg end)
4424 (save-excursion
4425 (beginning-of-line 1)
4426 (while (looking-at re) (beginning-of-line 0))
4427 (beginning-of-line 2)
4428 (setq beg (point))
4429 (while (looking-at re) (beginning-of-line 2))
4430 (setq end (point)))
4431 (comment-region beg end (if commented '(4) nil))))
4433 (defun orgtbl-insert-radio-table ()
4434 "Insert a radio table template appropriate for this major mode."
4435 (interactive)
4436 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4437 (txt (nth 1 e))
4438 name pos)
4439 (unless e (error "No radio table setup defined for %s" major-mode))
4440 (setq name (read-string "Table name: "))
4441 (while (string-match "%n" txt)
4442 (setq txt (replace-match name t t txt)))
4444 (setq pos (point))
4445 (insert txt)
4446 (goto-char pos)))
4448 ;; Dynamically bound input and output for table formatting.
4449 (defvar *orgtbl-table* nil
4450 "Carries the current table through formatting routines.")
4451 (defvar *orgtbl-rtn* nil
4452 "Formatting routines push the output lines here.")
4453 ;; Formatting parameters for the current table section.
4454 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4455 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4456 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4457 (defvar *orgtbl-fmt* nil "Format for each entry.")
4458 (defvar *orgtbl-efmt* nil "Format for numbers.")
4459 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4460 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4461 (defvar *orgtbl-lstart* nil "Text starting a row.")
4462 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4463 (defvar *orgtbl-lend* nil "Text ending a row.")
4464 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4466 (defsubst orgtbl-get-fmt (fmt i)
4467 "Retrieve the format from FMT corresponding to the Ith column."
4468 (if (and (not (functionp fmt)) (consp fmt))
4469 (plist-get fmt i)
4470 fmt))
4472 (defsubst orgtbl-apply-fmt (fmt &rest args)
4473 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4474 (cond ((functionp fmt) (apply fmt args))
4475 (fmt (apply 'format fmt args))
4476 (args (car args))
4477 (t args)))
4479 (defsubst orgtbl-eval-str (str)
4480 "If STR is a function, evaluate it with no arguments."
4481 (if (functionp str)
4482 (funcall str)
4483 str))
4485 (defun orgtbl-format-line (line)
4486 "Format LINE as a table row."
4487 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4488 (let* ((i 0)
4489 (line
4490 (mapcar
4491 (lambda (f)
4492 (setq i (1+ i))
4493 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4494 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4495 (orgtbl-apply-fmt efmt (match-string 1 f)
4496 (match-string 2 f))
4497 f)))
4498 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4499 *orgtbl-default-fmt*)
4500 f)))
4501 line)))
4502 (push (if *orgtbl-lfmt*
4503 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4504 (concat (orgtbl-eval-str *orgtbl-lstart*)
4505 (mapconcat 'identity line *orgtbl-sep*)
4506 (orgtbl-eval-str *orgtbl-lend*)))
4507 *orgtbl-rtn*))))
4509 (defun orgtbl-format-section (section-stopper)
4510 "Format lines until the first occurrence of SECTION-STOPPER."
4511 (let (prevline)
4512 (progn
4513 (while (not (eq (car *orgtbl-table*) section-stopper))
4514 (if prevline (orgtbl-format-line prevline))
4515 (setq prevline (pop *orgtbl-table*)))
4516 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4517 (*orgtbl-lend* *orgtbl-llend*)
4518 (*orgtbl-lfmt* *orgtbl-llfmt*))
4519 (orgtbl-format-line prevline))))))
4521 ;;;###autoload
4522 (defun orgtbl-to-generic (table params)
4523 "Convert the orgtbl-mode TABLE to some other format.
4524 This generic routine can be used for many standard cases.
4525 TABLE is a list, each entry either the symbol `hline' for a horizontal
4526 separator line, or a list of fields for that line.
4527 PARAMS is a property list of parameters that can influence the conversion.
4528 For the generic converter, some parameters are obligatory: you need to
4529 specify either :lfmt, or all of (:lstart :lend :sep).
4531 Valid parameters are:
4533 :splice When set to t, return only table body lines, don't wrap
4534 them into :tstart and :tend. Default is nil. When :splice
4535 is non-nil, this also means that the exporter should not look
4536 for and interpret header and footer sections.
4538 :hline String to be inserted on horizontal separation lines.
4539 May be nil to ignore hlines.
4541 :sep Separator between two fields
4542 :remove-nil-lines Do not include lines that evaluate to nil.
4544 Each in the following group may be either a string or a function
4545 of no arguments returning a string:
4547 :tstart String to start the table. Ignored when :splice is t.
4548 :tend String to end the table. Ignored when :splice is t.
4549 :lstart String to start a new table line.
4550 :llstart String to start the last table line, defaults to :lstart.
4551 :lend String to end a table line
4552 :llend String to end the last table line, defaults to :lend.
4554 Each in the following group may be a string, a function of one
4555 argument (the field or line) returning a string, or a plist
4556 mapping columns to either of the above:
4558 :lfmt Format for entire line, with enough %s to capture all fields.
4559 If this is present, :lstart, :lend, and :sep are ignored.
4560 :llfmt Format for the entire last line, defaults to :lfmt.
4561 :fmt A format to be used to wrap the field, should contain
4562 %s for the original field value. For example, to wrap
4564 This may also be a property list with column numbers and
4566 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4567 Same as above, specific for the header lines in the table.
4568 All lines before the first hline are treated as header.
4569 If any of these is not present, the data line value is used.
4571 This may be either a string or a function of two arguments:
4573 :efmt Use this format to print numbers with exponentials.
4574 The format should have %s twice for inserting mantissa
4576 may also be a property list with column numbers and
4577 formats. :fmt will still be applied after :efmt.
4579 In addition to this, the parameters :skip and :skipcols are always handled
4580 directly by `orgtbl-send-table'. See manual."
4581 (let* ((splicep (plist-get params :splice))
4582 (hline (plist-get params :hline))
4583 (skipheadrule (plist-get params :skipheadrule))
4584 (remove-nil-linesp (plist-get params :remove-nil-lines))
4585 (remove-newlines (plist-get params :remove-newlines))
4586 (*orgtbl-hline* hline)
4587 (*orgtbl-table* table)
4588 (*orgtbl-sep* (plist-get params :sep))
4589 (*orgtbl-efmt* (plist-get params :efmt))
4590 (*orgtbl-lstart* (plist-get params :lstart))
4591 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4592 (*orgtbl-lend* (plist-get params :lend))
4593 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4594 (*orgtbl-lfmt* (plist-get params :lfmt))
4595 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4596 (*orgtbl-fmt* (plist-get params :fmt))
4597 *orgtbl-rtn*)
4599 ;; Put header
4600 (unless splicep
4601 (when (plist-member params :tstart)
4602 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4603 (if tstart (push tstart *orgtbl-rtn*)))))
4605 ;; Do we have a heading section? If so, format it and handle the
4606 ;; trailing hline.
4607 (if (and (not splicep)
4608 (or (consp (car *orgtbl-table*))
4609 (consp (nth 1 *orgtbl-table*)))
4610 (memq 'hline (cdr *orgtbl-table*)))
4611 (progn
4612 (when (eq 'hline (car *orgtbl-table*))
4613 ;; there is a hline before the first data line
4614 (and hline (push hline *orgtbl-rtn*))
4615 (pop *orgtbl-table*))
4616 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4617 *orgtbl-lstart*))
4618 (*orgtbl-llstart* (or (plist-get params :hllstart)
4619 *orgtbl-llstart*))
4620 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4621 (*orgtbl-llend* (or (plist-get params :hllend)
4622 (plist-get params :hlend) *orgtbl-llend*))
4623 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4624 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4625 (plist-get params :hlfmt) *orgtbl-llfmt*))
4626 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4627 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4628 (orgtbl-format-section 'hline))
4629 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4630 (pop *orgtbl-table*)))
4632 ;; Now format the main section.
4633 (orgtbl-format-section nil)
4635 (unless splicep
4636 (when (plist-member params :tend)
4637 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4638 (if tend (push tend *orgtbl-rtn*)))))
4640 (mapconcat (if remove-newlines
4641 (lambda (tend)
4643 'identity)
4644 (nreverse (if remove-nil-linesp
4645 (remq nil *orgtbl-rtn*)
4648 ;;;###autoload
4649 (defun orgtbl-to-tsv (table params)
4650 "Convert the orgtbl-mode table to TAB separated material."
4652 ;;;###autoload
4653 (defun orgtbl-to-csv (table params)
4654 "Convert the orgtbl-mode table to CSV material.
4655 This does take care of the proper quoting of fields with comma or quotes."
4656 (orgtbl-to-generic table (org-combine-plists
4657 '(:sep "," :fmt org-quote-csv-field)
4658 params)))
4660 ;;;###autoload
4661 (defun orgtbl-to-latex (table params)
4662 "Convert the orgtbl-mode TABLE to LaTeX.
4663 TABLE is a list, each entry either the symbol `hline' for a horizontal
4664 separator line, or a list of fields for that line.
4665 PARAMS is a property list of parameters that can influence the conversion.
4666 Supports all parameters from `orgtbl-to-generic'. Most important for
4667 LaTeX are:
4669 :splice When set to t, return only table body lines, don't wrap
4670 them into a tabular environment. Default is nil.
4672 :fmt A format to be used to wrap the field, should contain %s for the
4673 original field value. For example, to wrap everything in dollars,
4676 The format may also be a function that formats its one argument.
4678 :efmt Format for transforming numbers with exponentials. The format
4679 should have %s twice for inserting mantissa and exponent, for
4681 This may also be a property list with column numbers and formats.
4682 The format may also be a function that formats its two arguments.
4684 :llend If you find too much space below the last line of a table,
4687 The general parameters :skip and :skipcols have already been applied when
4688 this function is called."
4689 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4690 org-table-last-alignment ""))
4691 (params2
4692 (list
4697 (orgtbl-to-generic table (org-combine-plists params2 params))))
4699 ;;;###autoload
4700 (defun orgtbl-to-html (table params)
4701 "Convert the orgtbl-mode TABLE to HTML.
4702 TABLE is a list, each entry either the symbol `hline' for a horizontal
4703 separator line, or a list of fields for that line.
4704 PARAMS is a property list of parameters that can influence the conversion.
4705 Currently this function recognizes the following parameters:
4707 :splice When set to t, return only table body lines, don't wrap
4708 them into a <table> environment. Default is nil.
4710 The general parameters :skip and :skipcols have already been applied when
4711 this function is called. The function does *not* use `orgtbl-to-generic',
4712 so you cannot specify parameters for it."
4713 (let* ((splicep (plist-get params :splice))
4714 (html-table-tag org-export-html-table-tag)
4715 html)
4716 ;; Just call the formatter we already have
4717 ;; We need to make text lines for it, so put the fields back together.
4718 (setq html (org-format-org-table-html
4719 (mapcar
4720 (lambda (x)
4721 (if (eq x 'hline)
4722 "|----+----|"
4723 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4724 table)
4725 splicep))
4727 (setq html (replace-match "" t t html)))
4728 html))
4730 ;;;###autoload
4731 (defun orgtbl-to-texinfo (table params)
4732 "Convert the orgtbl-mode TABLE to TeXInfo.
4733 TABLE is a list, each entry either the symbol `hline' for a horizontal
4734 separator line, or a list of fields for that line.
4735 PARAMS is a property list of parameters that can influence the conversion.
4736 Supports all parameters from `orgtbl-to-generic'. Most important for
4737 TeXInfo are:
4739 :splice nil/t When set to t, return only table body lines, don't wrap
4740 them into a multitable environment. Default is nil.
4742 :fmt fmt A format to be used to wrap the field, should contain
4743 %s for the original field value. For example, to wrap
4745 This may also be a property list with column numbers and
4747 Each format also may be a function that formats its one
4748 argument.
4751 are computed automatically from the width of the columns
4752 under org-mode.
4754 The general parameters :skip and :skipcols have already been applied when
4755 this function is called."
4756 (let* ((total (float (apply '+ org-table-last-column-widths)))
4757 (colfrac (or (plist-get params :cf)
4758 (mapconcat
4759 (lambda (x) (format "%.3f" (/ (float x) total)))
4760 org-table-last-column-widths " ")))
4761 (params2
4762 (list
4763 :tstart (concat "@multitable @columnfractions " colfrac)
4764 :tend "@end multitable"
4765 :lstart "@item " :lend "" :sep " @tab "
4766 :hlstart "@headitem ")))
4767 (orgtbl-to-generic table (org-combine-plists params2 params))))
4769 ;;;###autoload
4770 (defun orgtbl-to-orgtbl (table params)
4771 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4772 Useful when slicing one table into many. The :hline, :sep,
4773 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4774 and :tend suppress strings without splicing; they can be set to
4775 provide ORGTBL directives for the generated table."
4776 (let* ((params2
4777 (list
4778 :remove-newlines t
4779 :tstart nil :tend nil
4780 :hline "|---"
4781 :sep " | "
4782 :lstart "| "
4783 :lend " |"))
4784 (params (org-combine-plists params2 params)))
4785 (with-temp-buffer
4786 (insert (orgtbl-to-generic table params))
4787 (goto-char (point-min))
4788 (while (re-search-forward org-table-hline-regexp nil t)
4789 (org-table-align))
4790 (buffer-substring 1 (buffer-size)))))
4792 (defun orgtbl-to-table.el (table params)
4793 "Convert the orgtbl-mode TABLE into a table.el table."
4794 (with-temp-buffer
4795 (insert (orgtbl-to-orgtbl table params))
4796 (org-table-align)
4797 (replace-regexp-in-string
4798 "-|" "-+"
4799 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4801 (defun orgtbl-to-unicode (table params)
4802 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4803 You need the ascii-art-to-unicode.el package for this. You can download
4804 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4805 (with-temp-buffer
4806 (insert (orgtbl-to-table.el table params))
4807 (goto-char (point-min))
4808 (if (or (featurep 'ascii-art-to-unicode)
4809 (require 'ascii-art-to-unicode nil t))
4810 (aa2u)
4811 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4812 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4813 "Link to ascii-art-to-unicode.el") org-stored-links))
4814 (error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4815 (buffer-string)))
4817 (defun org-table-get-remote-range (name-or-id form)
4818 "Get a field value or a list of values in a range from table at ID.
4820 NAME-OR-ID may be the name of a table in the current file as set by
4822 will then be used. Alternatively, it may be an ID referring to
4823 any entry, also in a different file. In this case, the first table
4824 in that entry will be referenced.
4828 The return value is either a single string for a single field, or a
4829 list of the fields in the rectangle ."
4830 (save-match-data
4831 (let ((case-fold-search t) (id-loc nil)
4832 ;; Protect a bunch of variables from being overwritten
4833 ;; by the context of the remote table
4834 org-table-column-names org-table-column-name-regexp
4835 org-table-local-parameters org-table-named-field-locations
4836 org-table-current-line-types org-table-current-begin-line
4837 org-table-current-begin-pos org-table-dlines
4838 org-table-current-ncol
4839 org-table-hlines org-table-last-alignment
4840 org-table-last-column-widths org-table-last-alignment
4841 org-table-last-column-widths tbeg
4842 buffer loc)
4843 (setq form (org-table-convert-refs-to-rc form))
4844 (save-excursion
4845 (save-restriction
4846 (widen)
4847 (save-excursion
4848 (goto-char (point-min))
4849 (if (re-search-forward
4851 nil t)
4852 (setq buffer (current-buffer) loc (match-beginning 0))
4853 (setq id-loc (org-id-find name-or-id 'marker))
4854 (unless (and id-loc (markerp id-loc))
4856 (setq buffer (marker-buffer id-loc)
4857 loc (marker-position id-loc))
4858 (move-marker id-loc nil)))
4859 (with-current-buffer buffer
4860 (save-excursion
4861 (save-restriction
4862 (widen)
4863 (goto-char loc)
4864 (forward-char 1)
4866 (not (match-beginning 1)))
4867 (error "Cannot find a table at NAME or ID %s" name-or-id))
4868 (setq tbeg (point-at-bol))
4869 (org-table-get-specials)
4870 (setq form (org-table-formula-substitute-names
4871 (org-table-formula-handle-first/last-rc form)))
4872 (if (and (string-match org-table-range-regexp form)
4873 (> (length (match-string 0 form)) 1))
4874 (save-match-data
4875 (org-table-get-range (match-string 0 form) tbeg 1))
4876 form)))))))))
4878 (defmacro org-define-lookup-function (mode)
4879 (let ((mode-str (symbol-name mode))
4880 (first-p (equal mode 'first))
4881 (all-p (equal mode 'all)))
4882 (let ((plural-str (if all-p "s" "")))
4883 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
4884 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
4885 If R-LIST is nil, return matching element%s of S-LIST.
4886 If PREDICATE is not nil, use it instead of `equal' to match VAL.
4887 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
4888 This function is generated by a call to the macro `org-define-lookup-function'."
4889 mode-str plural-str plural-str plural-str)
4890 (let ,(let ((lvars '((p (or predicate 'equal))
4891 (sl s-list)
4892 (rl (or r-list s-list))
4893 (ret nil))))
4894 (if first-p (add-to-list 'lvars '(match-p nil)))
4895 lvars)
4896 (while ,(if first-p '(and (not match-p) sl) 'sl)
4897 (progn
4898 (if (funcall p val (car sl))
4899 (progn
4900 ,(if first-p '(setq match-p t))
4901 (let ((rval (car rl)))
4902 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
4903 (setq sl (cdr sl) rl (cdr rl))))
4904 ret)))))
4906 (org-define-lookup-function first)
4907 (org-define-lookup-function last)
4908 (org-define-lookup-function all)
4910 (provide 'org-table)
4912 ;; Local variables:
4913 ;; generated-autoload-file: "org-loaddefs.el"
4914 ;; End:
4916 ;;; org-table.el ends here