| blob | 832371d9023a79a7d255f3051f1da91587274412 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2013 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."
115 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
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."
140 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
141 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
142 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
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."
1598 beg end bcol ecol tend tbeg column lns pos)
1643 x))
1657 ;;;###autoload
1659 "Copy region in table to the clipboard and blank all relevant fields.
1660 If there is no active region, use just the field at point."
1666 ;;;###autoload
1668 "Copy rectangular region in table to clipboard.
1669 A special clipboard is used which can only be accessed
1670 with `org-table-paste-rectangle'."
1674 current-prefix-arg))
1676 region cols
1702 org-table-clip))
1704 ;;;###autoload
1706 "Paste a rectangular region into a table.
1707 The upper right corner ends up in the current field. All involved fields
1708 will be overwritten. If the rectangle does not fit into the present table,
1709 the table is enlarged as needed. The process ignores horizontal separator
1710 lines."
1720 c cols field)
1735 ;;;###autoload
1737 "Convert from `org-mode' table to table.el and back.
1738 Obviously, this only works within limits. When an Org-mode table is
1739 converted to table.el, all horizontal separator lines get lost, because
1740 table.el uses these as cell boundaries and has no notion of horizontal lines.
1741 A table.el table can be converted to an Org-mode table only if it does not
1742 do row or column spanning. Multiline cells will become multiple cells.
1743 Beware, Org-mode does not test if the table can be successfully converted - it
1744 blindly applies a recipe that works for simple tables."
1748 ;; convert to Org-mode table
1757 ;; convert to table.el table
1760 ;; first, get rid of all horizontal lines
1764 ;; insert a hline before first
1768 ;; insert a hline after each line
1773 ;; replace "+" at beginning and ending of hlines
1782 "Transpose orgmode table at point and eliminate hlines.
1783 So a table like
1785 | 1 | 2 | 4 | 5 |
1786 |---+---+---+---|
1787 | a | b | c | d |
1788 | e | f | g | h |
1790 will be transposed as
1792 | 1 | a | e |
1793 | 2 | b | f |
1794 | 4 | c | g |
1795 | 5 | d | h |
1797 Note that horizontal lines disappeared."
1801 ;; remove 'hline from list
1809 ;;;###autoload
1811 "Wrap several fields in a column like a paragraph.
1812 This is useful if you'd like to spread the contents of a field over several
1813 lines, in order to keep the table compact.
1815 If there is an active region, and both point and mark are in the same column,
1816 the text in the column is wrapped to minimum width for the given number of
1817 lines. Generally, this makes the table more compact. A prefix ARG may be
1819 formats the selected text to two lines. If the region was longer than two
1820 lines, the remaining lines remain empty. A negative prefix argument reduces
1821 the current number of lines by that amount. The wrapped text is pasted back
1822 into the table. If you formatted it to more lines than it was before, fields
1823 further down in the table get overwritten - so you might need to make space in
1824 the table first.
1826 If there is no region, the current field is split at the cursor position and
1827 the text fragment to the right of the cursor is prepended to the field one
1828 line down.
1830 If there is no region, but you specify a prefix ARG, the current field gets
1831 blank, and the content is appended to the field above."
1835 ;; There is a region: fill as a paragraph
1839 nlines)
1846 arg)
1850 nil nlines)))
1854 ;; No region, split the current field at point
1858 ;; combine with field above
1868 ;; split field
1880 ;;;###autoload
1882 "Edit table field in a different window.
1883 This is mainly useful for fields that contain hidden parts.
1885 it can be edited in place."
1894 display t intangible t))
1907 p)
1923 intangible t))
1931 "Finish editing a table data field.
1932 Remove all newline characters, insert the result into the table, realign
1933 the table and kill the editing buffer."
1937 text)
1954 "Minor mode to make the table field editor window follow the cursor.
1955 When this mode is active, the field editor window will always show the
1956 current field. The mode exits automatically when the cursor leaves the
1957 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1958 nil " TblFollow" nil
1974 ;; We have left the table, exit the follow mode
1984 ;;;###autoload
1986 "Sum numbers in region of current table column.
1987 The result will be displayed in the echo area, and will be available
1990 If there is an active region, it is interpreted as a rectangle and all
1991 numbers in that rectangle will be summed. If there is no active
1992 region and point is located in a table column, sum all numbers in that
1993 column.
1995 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1996 numbers are assumed to be times as well (in decimal hours) and the
1997 numbers are added as such.
1999 If NLAST is a number, only the NLAST fields will actually be summed."
2026 items1)))
2033 s diff)
2041 sres))))
2064 "Return the formula active for the current field.
2065 Assumes that specials are in place.
2066 If KEY is given, return the key to this formula.
2070 org-table-named-field-locations)))
2084 "Read a formula from the minibuffer, offer stored formula as default.
2085 When NAMED is non-nil, look for a named equation."
2089 org-table-named-field-locations)))
2096 name
2097 ref)
2107 stored)
2109 equation)
2116 scol))
2118 'org-table-formula-history
2119 )))))
2120 mustsave)
2122 ;; remove formula
2129 ;; We set the column equation, delete the named one.
2131 mustsave t))
2137 eq))
2140 "Store the list of formulas below the current table."
2147 ;; don't overwrite TBLFM, we might use text properties to store stuff
2163 ;; Fake a high number to make sure this is sorted at the end.
2170 a)
2180 "Compare two formulas for sorting."
2185 ;;;###autoload
2187 "Return an alist with the stored formulas directly after current table."
2196 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2215 "Modify the equations after the table structure has been edited.
2217 For all numbers larger than LIMIT, shift them by DELTA."
2229 s n a)
2249 "Get the column names and local parameters for this table."
2252 names name fields fields1 field cnt
2253 c v l line col types dlines hlines last-dline)
2255 org-table-local-parameters nil
2256 org-table-named-field-locations nil
2257 org-table-current-begin-line nil
2258 org-table-current-begin-pos nil
2259 org-table-current-line-types nil
2278 org-table-local-parameters))))
2294 ;; Analyse the line types
2298 l org-table-current-begin-line)
2315 al al2)
2325 ;;;###autoload
2328 If yes, store the formula and apply it."
2329 ;; We already know we are in a table. Get field will only return a formula
2330 ;; when appropriate. It might return a separator line, but no problem.
2333 named eq)
2344 "List of commands triggering the recalculation of a line.
2356 ;;;###autoload
2358 "Rotate the recalculation mark in the first column.
2359 If in any row, the first field is not consistent with a mark,
2360 insert a new column for the markers.
2361 When there is an active region, change all the lines in the region,
2362 after prompting for the marking character.
2363 After each change, a message will be displayed indicating the meaning
2364 of the new mark."
2379 epos new)
2386 newchar))
2418 ;;;###autoload
2420 "Recompute the current line if marked for it, and if we haven't just done it."
2440 org-tbl-calc-modes)
2442 ;;;###autoload
2444 suppress-align suppress-const
2445 suppress-store suppress-analysis)
2446 "Replace the table field value at the cursor by the result of a calculation.
2448 This function makes use of Dave Gillespie's Calc package, in my view the
2449 most exciting program ever written for GNU Emacs. So you need to have Calc
2450 installed in order to use this function.
2452 In a table, this command replaces the value in the current field with the
2454 formula, by storing it in a special line below the table. When called
2455 with a `C-u' prefix, the current field must be a named field, and the
2456 formula is installed as valid in only this specific field.
2458 When called with two `C-u' prefixes, insert the active equation
2459 for the field back into the current field, so that it can be
2461 to check the referenced fields.
2463 When called, the command first prompts for a formula, which is read in
2464 the minibuffer. Previously entered formulas are available through the
2465 history list, and the last used formula is offered as a default.
2466 These stored formulas are adapted correctly when moving, inserting, or
2467 deleting columns with the corresponding commands.
2469 The formula can be any algebraic expression understood by the Calc package.
2470 For details, see the Org-mode manual.
2472 This function can also be called from Lisp programs and offers
2473 additional arguments: EQUATION can be the formula to apply. If this
2474 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2475 used to speed-up recursive calls by by-passing unnecessary aligns.
2476 SUPPRESS-CONST suppresses the interpretation of constants in the
2477 formula, assuming that this has been done already outside the function.
2478 SUPPRESS-STORE means the formula should not be stored, either because
2479 it is already stored, or because it is a modified equation that should
2480 not overwrite the stored one."
2496 equation
2502 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2503 duration duration-output-format)
2504 ;; Parse the format string. Since we have a lot of modes, this is
2505 ;; a lot of work. However, I think calc still uses most of the time.
2518 'calc-float-format
2521 n))))
2525 duration-output-format nil
2529 duration-output-format org-table-duration-custom-format
2530 numbers t
2553 ;; replace fields with duration values if relevant
2557 fields)))
2563 x))
2564 fields)))
2570 ;; Insert row and column number of formula result field
2581 t t form)))
2583 ;; Check for old vertical references
2585 ;; Insert remote references
2597 rmtrng))
2598 keep-empty numbers lispp))
2599 t t form)))
2600 ;; Insert complex ranges
2608 ;; possibly handle durations
2613 formrg)
2614 keep-empty numbers lispp)))
2619 ;; Insert simple ranges
2628 keep-empty numbers lispp))
2629 t t form)))
2631 ;; Insert the references to fields in same row
2641 x keep-empty numbers lispp))
2642 t t form)))
2654 ;; Use <...> time-stamps so that Calc can handle them
2656 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2667 form
2674 duration-output-format)
2675 ev)))
2680 Orig: %s
2681 $xyz-> %s
2682 @r$c-> %s
2714 prop value)))
2717 "Get a calc vector from a column, according to descriptor DESC.
2718 Optional arguments TBEG and COL can give the beginning of the table and
2719 the current column, to avoid unnecessary parsing.
2721 HIGHLIGHT means just highlight the range.
2723 When CORNERS-ONLY is set, only return the corners of the range as
2724 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2725 in the buffer and column1 and column2 are table column numbers."
2732 beg end c1 c2 r1 r2 rangep tmp)
2749 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2756 ;; just one field
2763 ;; A range, return a vector
2764 ;; First sort the numbers to get a regular rectangle
2768 ;; Only return the corners of the range
2770 ;; Copy the range values into a list
2784 ;; return string representation of calc vector
2789 "Analyze descriptor DESC and retrieve the corresponding line number.
2790 The cursor is currently in line CLINE, the table begins in line BLINE,
2791 and TABLE is a vector with line types."
2799 ;; 1 2 3 4 5 6
2819 nil hn cline desc)))
2822 rel on cline desc)))
2826 "FIXME: Needs more documentation."
2839 nil))
2840 t)))
2844 desc cline)
2845 i)))
2850 s))
2853 "Convert list ELEMENTS to something appropriate to insert into formula.
2854 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2855 NUMBERS indicates that everything should be converted to numbers.
2856 LISPP non-nil means to return something appropriate for a Lisp
2857 list, 'literal is for the format specifier L."
2858 ;; Calc nan (not a number) is used for the conversion of the empty
2859 ;; field to a reference for several reasons: (i) It is accepted in a
2860 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2861 ;; (ii) In a single field (not in range) it can be distinguished
2862 ;; from "(nan)" which is the reference made from a single field
2863 ;; containing "nan".
2865 ;; field reference
2868 elements
2876 ;; range reference
2881 elements))))
2887 x
2895 x)
2897 elements
2900 ;;;###autoload
2902 "Recalculate the current table line by applying all stored formulas.
2903 With prefix arg ALL, do this for all lines in the table.
2904 With the prefix argument ALL is `(16)' \
2906 it is the symbol `iterate', recompute the table until it no longer changes.
2907 If NOALIGN is not nil, do not re-align the table after the computations
2908 are done. This is typically used internally to save time, if it is
2909 known that the table will be realigned a little later anyway."
2924 seen-fields lhs1
2926 ;; Insert constants in all formulas
2942 eqlist))
2943 ;; Split the equation list
2949 ;; Expand ranges in lhs of formulas
2952 ;; Get the correct line range to process
2958 ;; This is a table with marked lines, compute selected lines
2960 ;; Move forward to the first non-header line
2971 ;; First find the named fields, and mark them untouchable.
2972 ;; Also check if several field/range formulas try to set the same field.
2991 name)))
3001 ;; Now evaluate the column formulas, but skip fields covered by
3002 ;; field formulas
3006 ;; Unprotected line, recalculate
3018 ;; Now evaluate the field formulas
3032 ;; back to initial position
3039 ;;;###autoload
3041 "Recalculate the table until it does not change anymore.
3042 The maximum number of iterations is 10, but you can choose a different value
3043 with the prefix ARG."
3048 thistbl)
3062 ;;;###autoload
3064 "Recalculate all tables in the current buffer."
3071 ;;;###autoload
3073 "Iterate all tables in the buffer, to converge inter-table dependencies."
3078 c1)
3094 "Expand list of formulas.
3095 If some of the RHS in the formulas are ranges or a row reference, expand
3096 them to individual field equations for each field."
3102 ;; This just refers to one fixed field
3105 ;; This just refers to one fixed named field
3127 "Replace @<, @>, $<, $> with first/last row/column of the table.
3128 So @< and $< will always be replaced with @1 and $1, respectively.
3129 The advantage of these special markers are that structure editing of
3130 the table will not change them, while @1 and $1 will be modified
3131 when a line/row is swapped out of that privileged position. So for
3132 formulas that use a range of rows or columns, it may often be better
3134 borders of the table using the @< @> $< $> makers."
3137 s start)
3142 org-table-current-ncol)
3146 len
3153 s)
3156 "Replace $const with values in string F."
3158 ;; First, check for column names
3163 ;; Parameters and constants
3165 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3175 f))
3178 "Find the value for a parameter or constant in a formula.
3179 Parameters get priority."
3210 map))
3217 "--"
3220 "--"
3221 "Shift Reference at Point"
3226 "-"
3227 "Change Test Row for Column Formulas"
3230 "--"
3235 org-table-overlay-coordinates)]
3236 "--"
3242 ;;;###autoload
3244 "Edit the formulas of the current table in a separate buffer."
3246 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3260 entry s type title)
3263 ;; Keep global-font-lock-mode from turning on font-lock-mode
3304 "Convert a formula from internal to user representation."
3307 s))
3310 "Convert a formula from user to internal representation."
3313 s))
3316 "Convert spreadsheet references from A7 to @7$28.
3317 Works for single references, but also for entire formulas and even the
3318 full TBLFM line."
3320 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3323 ;; format match, just advance
3328 ;; 3.e5 or something like this.
3331 ;; (member (match-string 1 s)
3332 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3333 )
3334 ;; function name, just advance
3344 t t s)))))
3345 s))
3348 "Convert spreadsheet references from to @7$28 to AB7.
3349 Works for single references, but also for entire formulas and even the
3350 full TBLFM line."
3357 t t s)))
3362 t nil s)))
3363 s)
3366 "Convert a base 26 number represented by letters into an integer.
3367 For example: AB -> 28."
3373 n))
3376 "Convert an integer into a base 26 number represented by letters.
3377 For example: 28 -> AB."
3382 s))
3385 "Convert a time string into numerical duration in seconds.
3386 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3387 If S is a string representing a number, keep this number."
3389 s
3412 "Convert a number of seconds to a time string.
3413 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3414 minutes or seconds."
3429 "Convert all references in this buffer, using FUNCTION."
3439 "Convert all references in the buffer from B3 to @3$2 and back."
3449 "Shift the reference at point one row/hline up."
3453 "Shift the reference at point one row/hline down."
3457 "Shift the reference at point one field to the left."
3461 "Shift the reference at point one field to the right."
3472 ;; A B3-like reference
3478 ;; An internal reference
3484 "Re-match the group N, and replace it with the shifted reference."
3489 t t)))
3492 "Shift a reference part REF.
3493 If DECR is set, decrease the references row/column, else increase.
3494 If HLINE is set, this may be a hline reference, it certainly is not
3495 a translation reference."
3524 "Toggle the display of coordinates in the referenced table."
3533 "Parse the buffer for formula definitions and install them.
3534 With prefix ARG, apply the new formulas to the table."
3544 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3545 nil t)
3569 "Abort editing formulas, without installing the changes."
3580 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3621 "Show the location/value of the $ expression at point."
3630 var name e what match dest)
3635 "$1.."
3718 ;; column number
3746 org-table-fedit-scroll-down))))
3757 "Make sure the cursor is in a dataline in a table."
3766 p1 p2)))
3771 "Move cursor one line up in the window showing the table."
3776 "Move cursor one line down in the window showing the table."
3781 "Move the cursor in the window showing the table.
3782 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3807 "Add a new overlay."
3813 "Highlight rectangular region in a table."
3817 l1 c1 l2 c2 tmp)
3841 "Remove the rectangle overlays."
3852 "Add overlays to the table at point, to show row/column coordinates."
3880 ;;;###autoload
3882 "Toggle the display of Row/Column numbers in tables."
3893 ;;;###autoload
3895 "Toggle the formula debugger in tables."
3901 ;;; The orgtbl minor mode
3903 ;; Define a minor mode which can be used in other modes in order to
3904 ;; integrate the org-mode table editor.
3906 ;; This is really a hack, because the org-mode table editor uses several
3907 ;; keys which normally belong to the major mode, for example the TAB and
3908 ;; RET keys. Here is how it works: The minor mode defines all the keys
3909 ;; necessary to operate the table editor, but wraps the commands into a
3910 ;; function which tests if the cursor is currently inside a table. If that
3911 ;; is the case, the table editor command is executed. However, when any of
3912 ;; those keys is used outside a table, the function uses `key-binding' to
3913 ;; look up if the key has an associated command in another currently active
3914 ;; keymap (minor modes, major mode, global), and executes that command.
3915 ;; There might be problems if any of the keys used by the table editor is
3916 ;; otherwise used as a prefix key.
3918 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3919 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3920 ;; addresses this by checking explicitly for both bindings.
3922 ;; The optimized version (see variable `orgtbl-optimized') takes over
3923 ;; all keys which are bound to `self-insert-command' in the *global map*.
3924 ;; Some modes bind other commands to simple characters, for example
3925 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3926 ;; active, this binding is ignored inside tables and replaced with a
3927 ;; modified self-insert.
3945 ;; Install it as a minor mode.
3949 ;;;###autoload
3951 "The `org-mode' table editor as a minor mode for use in other modes."
3956 ;; Exit without error, in case some hook functions calls this
3957 ;; by accident in org-mode.
3961 ;; Make sure we are first in minor-mode-map-alist
3963 ;; FIXME: maybe it should use emulation-mode-map-alists?
3970 auto-fill-inhibit-regexp)
3974 auto-fill-inhibit-regexp)
3975 orgtbl-line-start-regexp))
3993 "Remove all properties related to narrow-column invisibility."
4006 "Create a function for binding in the table minor mode.
4007 FUN is the command to call inside a table. N is used to create a unique
4008 command name. KEYS are keys that should be checked in for a command
4009 to execute outside of tables."
4015 "Outside of tables, run the binding of `"
4027 keys)
4031 "Error when there is no default binding for a table key."
4036 "Setup orgtbl keymaps."
4067 elt key fun cmd)
4075 ;; Special treatment needed for TAB and RET
4095 [(tab)] "\C-i")))
4097 (org-defkey orgtbl-mode-map [backtab]
4099 [backtab] [S-iso-lefttab] [(shift tab)]
4100 [(tab)] "\C-i"))
4102 (org-defkey orgtbl-mode-map "\M-\C-m"
4103 (orgtbl-make-binding 'org-table-wrap-region 105
4104 "\M-\C-m" [(meta return)]))
4105 (org-defkey orgtbl-mode-map [(meta return)]
4106 (orgtbl-make-binding 'org-table-wrap-region 106
4107 [(meta return)] "\M-\C-m"))
4109 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4110 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4112 (when orgtbl-optimized
4113 ;; If the user wants maximum table support, we need to hijack
4114 ;; some standard editing functions
4115 (org-remap orgtbl-mode-map
4116 'self-insert-command 'orgtbl-self-insert-command
4117 'delete-char 'org-delete-char
4118 'delete-backward-char 'org-delete-backward-char)
4119 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4120 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4121 '("OrgTbl"
4122 ["Create or convert" org-table-create-or-convert-from-region
4123 :active (not (org-at-table-p)) :keys "C-c |" ]
4124 "--"
4125 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4126 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4127 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4128 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4129 "--"
4130 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4131 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4132 ["Copy Field from Above"
4133 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4134 "--"
4135 ("Column"
4136 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4137 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4138 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4139 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4140 ("Row"
4141 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4142 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4143 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4144 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4145 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4146 "--"
4147 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4148 ("Rectangle"
4149 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4150 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4151 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4152 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4153 "--"
4154 ("Radio tables"
4155 ["Insert table template" orgtbl-insert-radio-table
4156 (assq major-mode orgtbl-radio-table-templates)]
4157 ["Comment/uncomment table" orgtbl-toggle-comment t])
4158 "--"
4159 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4160 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4161 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4162 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4163 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4164 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4165 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4166 ["Sum Column/Rectangle" org-table-sum
4167 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4168 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4169 ["Debug Formulas"
4170 org-table-toggle-formula-debugger :active (org-at-table-p)
4171 :keys "C-c {"
4172 :style toggle :selected org-table-formula-debug]
4173 ["Show Col/Row Numbers"
4174 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4175 :keys "C-c }"
4176 :style toggle :selected org-table-overlay-coordinates]
4177 ))
4178 t))
4180 (defun orgtbl-ctrl-c-ctrl-c (arg)
4181 "If the cursor is inside a table, realign the table.
4182 If it is a table to be sent away to a receiver, do it.
4183 With prefix arg, also recompute table."
4184 (interactive "P")
4185 (let ((case-fold-search t) (pos (point)) action consts-str consts cst const-str)
4186 (save-excursion
4187 (beginning-of-line 1)
4188 (setq action (cond
4192 (cond
4193 ((integerp action)
4194 (goto-char action)
4195 (org-table-maybe-eval-formula)
4196 (if arg
4197 (call-interactively 'org-table-recalculate)
4198 (org-table-maybe-recalculate-line))
4199 (call-interactively 'org-table-align)
4200 (when (orgtbl-send-table 'maybe)
4201 (run-hooks 'orgtbl-after-send-table-hook)))
4202 ((eq action 'recalc)
4203 (save-excursion
4204 (goto-char (point-min))
4206 (setq const-str (substring-no-properties (match-string 1)))
4208 (when consts
4209 (let (e)
4210 (while (setq e (pop consts))
4212 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4213 (setq org-table-formula-constants-local cst)))))
4214 (save-excursion
4215 (beginning-of-line 1)
4217 (if (org-at-table-p)
4218 (org-call-with-arg 'org-table-recalculate t))))
4219 (t (let (orgtbl-mode)
4220 (call-interactively (key-binding "\C-c\C-c")))))))
4222 (defun orgtbl-create-or-convert-from-region (arg)
4223 "Create table or convert region to table, if no conflicting binding.
4224 This installs the table binding `C-c |', but only if there is no
4225 conflicting binding to this key outside orgtbl-mode."
4226 (interactive "P")
4227 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4228 (if cmd
4229 (call-interactively cmd)
4230 (call-interactively 'org-table-create-or-convert-from-region))))
4232 (defun orgtbl-tab (arg)
4233 "Justification and field motion for `orgtbl-mode'."
4234 (interactive "P")
4235 (if arg (org-table-edit-field t)
4236 (org-table-justify-field-maybe)
4237 (org-table-next-field)))
4239 (defun orgtbl-ret ()
4240 "Justification and field motion for `orgtbl-mode'."
4241 (interactive)
4242 (if (bobp)
4243 (newline)
4244 (org-table-justify-field-maybe)
4245 (org-table-next-row)))
4247 (defun orgtbl-self-insert-command (N)
4248 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4249 If the cursor is in a table looking at whitespace, the whitespace is
4250 overwritten, and the table is not marked as requiring realignment."
4251 (interactive "p")
4252 (if (and (org-at-table-p)
4253 (or
4254 (and org-table-auto-blank-field
4255 (member last-command
4256 '(orgtbl-hijacker-command-100
4257 orgtbl-hijacker-command-101
4258 orgtbl-hijacker-command-102
4259 orgtbl-hijacker-command-103
4260 orgtbl-hijacker-command-104
4261 orgtbl-hijacker-command-105
4262 yas/expand))
4263 (org-table-blank-field))
4264 t)
4265 (eq N 1)
4267 (let (org-table-may-need-update)
4268 (goto-char (1- (match-end 0)))
4269 (org-delete-backward-char 1)
4270 (goto-char (match-beginning 0))
4271 (self-insert-command N))
4272 (setq org-table-may-need-update t)
4273 (let* (orgtbl-mode
4274 a
4275 (cmd (or (key-binding
4276 (or (and (listp function-key-map)
4277 (setq a (assoc last-input-event function-key-map))
4278 (cdr a))
4279 (vector last-input-event)))
4280 'self-insert-command)))
4281 (call-interactively cmd)
4282 (if (and org-self-insert-cluster-for-undo
4283 (eq cmd 'self-insert-command))
4284 (if (not (eq last-command 'orgtbl-self-insert-command))
4285 (setq org-self-insert-command-undo-counter 1)
4286 (if (>= org-self-insert-command-undo-counter 20)
4287 (setq org-self-insert-command-undo-counter 1)
4288 (and (> org-self-insert-command-undo-counter 0)
4289 buffer-undo-list
4290 (not (cadr buffer-undo-list)) ; remove nil entry
4291 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4292 (setq org-self-insert-command-undo-counter
4293 (1+ org-self-insert-command-undo-counter))))))))
4296 "Regular expression matching exponentials as produced by calc.")
4298 (defun orgtbl-export (table target)
4299 (require 'org-exp)
4300 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4302 org-table-last-alignment org-table-last-column-widths
4303 maxcol column)
4304 (if (not (fboundp func))
4305 (error "Cannot export orgtbl table to %s" target))
4306 (setq lines (org-table-clean-before-export lines))
4307 (setq table
4308 (mapcar
4309 (lambda (x)
4310 (if (string-match org-table-hline-regexp x)
4311 'hline
4313 lines))
4314 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4315 table)))
4316 (loop for i from (1- maxcol) downto 0 do
4317 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4318 (setq column (delq nil column))
4319 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4320 (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))
4321 (funcall func table nil)))
4323 (defun orgtbl-gather-send-defs ()
4324 "Gather a plist of :name, :transform, :params for each destination before
4325 a radio table."
4326 (save-excursion
4327 (goto-char (org-table-begin))
4328 (let (rtn)
4329 (beginning-of-line 0)
4330 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4331 (let ((name (org-no-properties (match-string 1)))
4332 (transform (intern (match-string 2)))
4333 (params (if (match-end 3)
4334 (read (concat "(" (match-string 3) ")")))))
4335 (push (list :name name :transform transform :params params)
4336 rtn)
4337 (beginning-of-line 0)))
4338 rtn)))
4340 (defun orgtbl-send-replace-tbl (name txt)
4341 "Find and replace table NAME with TXT."
4342 (save-excursion
4343 (goto-char (point-min))
4344 (unless (re-search-forward
4346 (error "Don't know where to insert translated table"))
4347 (goto-char (match-beginning 0))
4348 (beginning-of-line 2)
4349 (save-excursion
4350 (let ((beg (point)))
4351 (unless (re-search-forward
4352 (concat "END RECEIVE ORGTBL +" name) nil t)
4353 (error "Cannot find end of insertion region"))
4354 (beginning-of-line 1)
4355 (delete-region beg (point))))
4358 ;;;###autoload
4359 (defun org-table-to-lisp (&optional txt)
4360 "Convert the table at point to a Lisp structure.
4361 The structure will be a list. Each item is either the symbol `hline'
4362 for a horizontal separator line, or a list of field values as strings.
4363 The table is taken from the parameter TXT, or from the buffer at point."
4364 (unless txt
4365 (unless (org-at-table-p)
4366 (error "No table at point")))
4367 (let* ((txt (or txt
4368 (buffer-substring-no-properties (org-table-begin)
4369 (org-table-end))))
4372 (mapcar
4373 (lambda (x)
4374 (if (string-match org-table-hline-regexp x)
4375 'hline
4377 lines)))
4379 (defun orgtbl-send-table (&optional maybe)
4380 "Send a transformed version of this table to the receiver position.
4381 With argument MAYBE, fail quietly if no transformation is defined for
4382 this table."
4383 (interactive)
4384 (catch 'exit
4385 (unless (org-at-table-p) (error "Not at a table"))
4386 ;; when non-interactive, we assume align has just happened.
4387 (when (org-called-interactively-p 'any) (org-table-align))
4388 (let ((dests (orgtbl-gather-send-defs))
4389 (txt (buffer-substring-no-properties (org-table-begin)
4390 (org-table-end)))
4391 (ntbl 0))
4392 (unless dests (if maybe (throw 'exit nil)
4393 (error "Don't know how to transform this table")))
4394 (dolist (dest dests)
4395 (let* ((name (plist-get dest :name))
4396 (transform (plist-get dest :transform))
4397 (params (plist-get dest :params))
4398 (skip (plist-get params :skip))
4399 (skipcols (plist-get params :skipcols))
4400 (no-escape (plist-get params :no-escape))
4401 beg
4402 (lines (org-table-clean-before-export
4403 (nthcdr (or skip 0)
4405 (i0 (if org-table-clean-did-remove-column 2 1))
4406 (lines (if no-escape lines
4407 (mapcar (lambda(l) (replace-regexp-in-string
4409 (table (mapcar
4410 (lambda (x)
4411 (if (string-match org-table-hline-regexp x)
4412 'hline
4413 (org-remove-by-index
4415 skipcols i0)))
4416 lines))
4417 (fun (if (= i0 2) 'cdr 'identity))
4418 (org-table-last-alignment
4419 (org-remove-by-index (funcall fun org-table-last-alignment)
4420 skipcols i0))
4421 (org-table-last-column-widths
4422 (org-remove-by-index (funcall fun org-table-last-column-widths)
4423 skipcols i0))
4424 (txt (if (fboundp transform)
4425 (funcall transform table params)
4426 (error "No such transformation function %s" transform))))
4427 (orgtbl-send-replace-tbl name txt))
4428 (setq ntbl (1+ ntbl)))
4429 (message "Table converted and installed at %d receiver location%s"
4430 ntbl (if (> ntbl 1) "s" ""))
4431 (if (> ntbl 0)
4432 ntbl
4433 nil))))
4435 (defun org-remove-by-index (list indices &optional i0)
4436 "Remove the elements in LIST with indices in INDICES.
4437 First element has index 0, or I0 if given."
4438 (if (not indices)
4439 list
4440 (if (integerp indices) (setq indices (list indices)))
4441 (setq i0 (1- (or i0 0)))
4442 (delq :rm (mapcar (lambda (x)
4443 (setq i0 (1+ i0))
4444 (if (memq i0 indices) :rm x))
4445 list))))
4447 (defun orgtbl-toggle-comment ()
4448 "Comment or uncomment the orgtbl at point."
4449 (interactive)
4450 (let* ((case-fold-search t)
4451 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4452 (re2 (concat "^" orgtbl-line-start-regexp))
4453 (commented (save-excursion (beginning-of-line 1)
4454 (cond ((looking-at re1) t)
4455 ((looking-at re2) nil)
4456 (t (error "Not at an org table")))))
4457 (re (if commented re1 re2))
4458 beg end)
4459 (save-excursion
4460 (beginning-of-line 1)
4461 (while (looking-at re) (beginning-of-line 0))
4462 (beginning-of-line 2)
4463 (setq beg (point))
4464 (while (looking-at re) (beginning-of-line 2))
4465 (setq end (point)))
4466 (comment-region beg end (if commented '(4) nil))))
4468 (defun orgtbl-insert-radio-table ()
4469 "Insert a radio table template appropriate for this major mode."
4470 (interactive)
4471 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4472 (txt (nth 1 e))
4473 name pos)
4474 (unless e (error "No radio table setup defined for %s" major-mode))
4475 (setq name (read-string "Table name: "))
4476 (while (string-match "%n" txt)
4477 (setq txt (replace-match name t t txt)))
4479 (setq pos (point))
4480 (insert txt)
4481 (goto-char pos)))
4483 ;; Dynamically bound input and output for table formatting.
4484 (defvar *orgtbl-table* nil
4485 "Carries the current table through formatting routines.")
4486 (defvar *orgtbl-rtn* nil
4487 "Formatting routines push the output lines here.")
4488 ;; Formatting parameters for the current table section.
4489 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4490 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4491 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4492 (defvar *orgtbl-fmt* nil "Format for each entry.")
4493 (defvar *orgtbl-efmt* nil "Format for numbers.")
4494 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4495 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4496 (defvar *orgtbl-lstart* nil "Text starting a row.")
4497 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4498 (defvar *orgtbl-lend* nil "Text ending a row.")
4499 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4501 (defsubst orgtbl-get-fmt (fmt i)
4502 "Retrieve the format from FMT corresponding to the Ith column."
4503 (if (and (not (functionp fmt)) (consp fmt))
4504 (plist-get fmt i)
4505 fmt))
4507 (defsubst orgtbl-apply-fmt (fmt &rest args)
4508 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4509 (cond ((functionp fmt) (apply fmt args))
4510 (fmt (apply 'format fmt args))
4511 (args (car args))
4512 (t args)))
4514 (defsubst orgtbl-eval-str (str)
4515 "If STR is a function, evaluate it with no arguments."
4516 (if (functionp str)
4517 (funcall str)
4518 str))
4520 (defun orgtbl-format-line (line)
4521 "Format LINE as a table row."
4522 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4523 (let* ((i 0)
4524 (line
4525 (mapcar
4526 (lambda (f)
4527 (setq i (1+ i))
4528 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4529 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4530 (orgtbl-apply-fmt efmt (match-string 1 f)
4531 (match-string 2 f))
4532 f)))
4533 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4534 *orgtbl-default-fmt*)
4535 f)))
4536 line)))
4537 (push (if *orgtbl-lfmt*
4538 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4539 (concat (orgtbl-eval-str *orgtbl-lstart*)
4540 (mapconcat 'identity line *orgtbl-sep*)
4541 (orgtbl-eval-str *orgtbl-lend*)))
4542 *orgtbl-rtn*))))
4544 (defun orgtbl-format-section (section-stopper)
4545 "Format lines until the first occurrence of SECTION-STOPPER."
4546 (let (prevline)
4547 (progn
4548 (while (not (eq (car *orgtbl-table*) section-stopper))
4549 (if prevline (orgtbl-format-line prevline))
4550 (setq prevline (pop *orgtbl-table*)))
4551 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4552 (*orgtbl-lend* *orgtbl-llend*)
4553 (*orgtbl-lfmt* *orgtbl-llfmt*))
4554 (orgtbl-format-line prevline))))))
4556 ;;;###autoload
4557 (defun orgtbl-to-generic (table params)
4558 "Convert the orgtbl-mode TABLE to some other format.
4559 This generic routine can be used for many standard cases.
4560 TABLE is a list, each entry either the symbol `hline' for a horizontal
4561 separator line, or a list of fields for that line.
4562 PARAMS is a property list of parameters that can influence the conversion.
4563 For the generic converter, some parameters are obligatory: you need to
4564 specify either :lfmt, or all of (:lstart :lend :sep).
4566 Valid parameters are:
4568 :splice When set to t, return only table body lines, don't wrap
4569 them into :tstart and :tend. Default is nil. When :splice
4570 is non-nil, this also means that the exporter should not look
4571 for and interpret header and footer sections.
4573 :hline String to be inserted on horizontal separation lines.
4574 May be nil to ignore hlines.
4576 :sep Separator between two fields
4577 :remove-nil-lines Do not include lines that evaluate to nil.
4579 Each in the following group may be either a string or a function
4580 of no arguments returning a string:
4582 :tstart String to start the table. Ignored when :splice is t.
4583 :tend String to end the table. Ignored when :splice is t.
4584 :lstart String to start a new table line.
4585 :llstart String to start the last table line, defaults to :lstart.
4586 :lend String to end a table line
4587 :llend String to end the last table line, defaults to :lend.
4589 Each in the following group may be a string, a function of one
4590 argument (the field or line) returning a string, or a plist
4591 mapping columns to either of the above:
4593 :lfmt Format for entire line, with enough %s to capture all fields.
4594 If this is present, :lstart, :lend, and :sep are ignored.
4595 :llfmt Format for the entire last line, defaults to :lfmt.
4596 :fmt A format to be used to wrap the field, should contain
4597 %s for the original field value. For example, to wrap
4599 This may also be a property list with column numbers and
4601 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4602 Same as above, specific for the header lines in the table.
4603 All lines before the first hline are treated as header.
4604 If any of these is not present, the data line value is used.
4606 This may be either a string or a function of two arguments:
4608 :efmt Use this format to print numbers with exponentials.
4609 The format should have %s twice for inserting mantissa
4611 may also be a property list with column numbers and
4612 formats. :fmt will still be applied after :efmt.
4614 In addition to this, the parameters :skip and :skipcols are always handled
4615 directly by `orgtbl-send-table'. See manual."
4616 (let* ((splicep (plist-get params :splice))
4617 (hline (plist-get params :hline))
4618 (skipheadrule (plist-get params :skipheadrule))
4619 (remove-nil-linesp (plist-get params :remove-nil-lines))
4620 (remove-newlines (plist-get params :remove-newlines))
4621 (*orgtbl-hline* hline)
4622 (*orgtbl-table* table)
4623 (*orgtbl-sep* (plist-get params :sep))
4624 (*orgtbl-efmt* (plist-get params :efmt))
4625 (*orgtbl-lstart* (plist-get params :lstart))
4626 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4627 (*orgtbl-lend* (plist-get params :lend))
4628 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4629 (*orgtbl-lfmt* (plist-get params :lfmt))
4630 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4631 (*orgtbl-fmt* (plist-get params :fmt))
4632 *orgtbl-rtn*)
4634 ;; Put header
4635 (unless splicep
4636 (when (plist-member params :tstart)
4637 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4638 (if tstart (push tstart *orgtbl-rtn*)))))
4640 ;; Do we have a heading section? If so, format it and handle the
4641 ;; trailing hline.
4642 (if (and (not splicep)
4643 (or (consp (car *orgtbl-table*))
4644 (consp (nth 1 *orgtbl-table*)))
4645 (memq 'hline (cdr *orgtbl-table*)))
4646 (progn
4647 (when (eq 'hline (car *orgtbl-table*))
4648 ;; there is a hline before the first data line
4649 (and hline (push hline *orgtbl-rtn*))
4650 (pop *orgtbl-table*))
4651 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4652 *orgtbl-lstart*))
4653 (*orgtbl-llstart* (or (plist-get params :hllstart)
4654 *orgtbl-llstart*))
4655 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4656 (*orgtbl-llend* (or (plist-get params :hllend)
4657 (plist-get params :hlend) *orgtbl-llend*))
4658 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4659 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4660 (plist-get params :hlfmt) *orgtbl-llfmt*))
4661 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4662 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4663 (orgtbl-format-section 'hline))
4664 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4665 (pop *orgtbl-table*)))
4667 ;; Now format the main section.
4668 (orgtbl-format-section nil)
4670 (unless splicep
4671 (when (plist-member params :tend)
4672 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4673 (if tend (push tend *orgtbl-rtn*)))))
4675 (mapconcat (if remove-newlines
4676 (lambda (tend)
4678 'identity)
4679 (nreverse (if remove-nil-linesp
4680 (remq nil *orgtbl-rtn*)
4683 ;;;###autoload
4684 (defun orgtbl-to-tsv (table params)
4685 "Convert the orgtbl-mode table to TAB separated material."
4687 ;;;###autoload
4688 (defun orgtbl-to-csv (table params)
4689 "Convert the orgtbl-mode table to CSV material.
4690 This does take care of the proper quoting of fields with comma or quotes."
4691 (orgtbl-to-generic table (org-combine-plists
4692 '(:sep "," :fmt org-quote-csv-field)
4693 params)))
4695 ;;;###autoload
4696 (defun orgtbl-to-latex (table params)
4697 "Convert the orgtbl-mode TABLE to LaTeX.
4698 TABLE is a list, each entry either the symbol `hline' for a horizontal
4699 separator line, or a list of fields for that line.
4700 PARAMS is a property list of parameters that can influence the conversion.
4701 Supports all parameters from `orgtbl-to-generic'. Most important for
4702 LaTeX are:
4704 :splice When set to t, return only table body lines, don't wrap
4705 them into a tabular environment. Default is nil.
4707 :fmt A format to be used to wrap the field, should contain %s for the
4708 original field value. For example, to wrap everything in dollars,
4711 The format may also be a function that formats its one argument.
4713 :efmt Format for transforming numbers with exponentials. The format
4714 should have %s twice for inserting mantissa and exponent, for
4716 This may also be a property list with column numbers and formats.
4717 The format may also be a function that formats its two arguments.
4719 :llend If you find too much space below the last line of a table,
4722 The general parameters :skip and :skipcols have already been applied when
4723 this function is called."
4724 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4725 org-table-last-alignment ""))
4726 (params2
4727 (list
4732 (orgtbl-to-generic table (org-combine-plists params2 params))))
4734 ;;;###autoload
4735 (defun orgtbl-to-html (table params)
4736 "Convert the orgtbl-mode TABLE to HTML.
4737 TABLE is a list, each entry either the symbol `hline' for a horizontal
4738 separator line, or a list of fields for that line.
4739 PARAMS is a property list of parameters that can influence the conversion.
4740 Currently this function recognizes the following parameters:
4742 :splice When set to t, return only table body lines, don't wrap
4743 them into a <table> environment. Default is nil.
4745 The general parameters :skip and :skipcols have already been applied when
4746 this function is called. The function does *not* use `orgtbl-to-generic',
4747 so you cannot specify parameters for it."
4748 (let* ((splicep (plist-get params :splice))
4749 (html-table-tag org-export-html-table-tag)
4750 html)
4751 ;; Just call the formatter we already have
4752 ;; We need to make text lines for it, so put the fields back together.
4753 (setq html (org-format-org-table-html
4754 (mapcar
4755 (lambda (x)
4756 (if (eq x 'hline)
4757 "|----+----|"
4758 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4759 table)
4760 splicep))
4762 (setq html (replace-match "" t t html)))
4763 html))
4765 ;;;###autoload
4766 (defun orgtbl-to-texinfo (table params)
4767 "Convert the orgtbl-mode TABLE to TeXInfo.
4768 TABLE is a list, each entry either the symbol `hline' for a horizontal
4769 separator line, or a list of fields for that line.
4770 PARAMS is a property list of parameters that can influence the conversion.
4771 Supports all parameters from `orgtbl-to-generic'. Most important for
4772 TeXInfo are:
4774 :splice nil/t When set to t, return only table body lines, don't wrap
4775 them into a multitable environment. Default is nil.
4777 :fmt fmt A format to be used to wrap the field, should contain
4778 %s for the original field value. For example, to wrap
4780 This may also be a property list with column numbers and
4782 Each format also may be a function that formats its one
4783 argument.
4786 are computed automatically from the width of the columns
4787 under org-mode.
4789 The general parameters :skip and :skipcols have already been applied when
4790 this function is called."
4791 (let* ((total (float (apply '+ org-table-last-column-widths)))
4792 (colfrac (or (plist-get params :cf)
4793 (mapconcat
4794 (lambda (x) (format "%.3f" (/ (float x) total)))
4795 org-table-last-column-widths " ")))
4796 (params2
4797 (list
4798 :tstart (concat "@multitable @columnfractions " colfrac)
4799 :tend "@end multitable"
4800 :lstart "@item " :lend "" :sep " @tab "
4801 :hlstart "@headitem ")))
4802 (orgtbl-to-generic table (org-combine-plists params2 params))))
4804 ;;;###autoload
4805 (defun orgtbl-to-orgtbl (table params)
4806 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4807 Useful when slicing one table into many. The :hline, :sep,
4808 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4809 and :tend suppress strings without splicing; they can be set to
4810 provide ORGTBL directives for the generated table."
4811 (let* ((params2
4812 (list
4813 :remove-newlines t
4814 :tstart nil :tend nil
4815 :hline "|---"
4816 :sep " | "
4817 :lstart "| "
4818 :lend " |"))
4819 (params (org-combine-plists params2 params)))
4820 (with-temp-buffer
4821 (insert (orgtbl-to-generic table params))
4822 (goto-char (point-min))
4823 (while (re-search-forward org-table-hline-regexp nil t)
4824 (org-table-align))
4825 (buffer-substring 1 (buffer-size)))))
4827 (defun orgtbl-to-table.el (table params)
4828 "Convert the orgtbl-mode TABLE into a table.el table."
4829 (with-temp-buffer
4830 (insert (orgtbl-to-orgtbl table params))
4831 (org-table-align)
4832 (replace-regexp-in-string
4833 "-|" "-+"
4834 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4836 (defun orgtbl-to-unicode (table params)
4837 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4838 You need the ascii-art-to-unicode.el package for this. You can download
4839 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4840 (with-temp-buffer
4841 (insert (orgtbl-to-table.el table params))
4842 (goto-char (point-min))
4843 (if (or (featurep 'ascii-art-to-unicode)
4844 (require 'ascii-art-to-unicode nil t))
4845 (aa2u)
4846 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4847 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4848 "Link to ascii-art-to-unicode.el") org-stored-links))
4849 (error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4850 (buffer-string)))
4852 (defun org-table-get-remote-range (name-or-id form)
4853 "Get a field value or a list of values in a range from table at ID.
4855 NAME-OR-ID may be the name of a table in the current file as set by
4857 will then be used. Alternatively, it may be an ID referring to
4858 any entry, also in a different file. In this case, the first table
4859 in that entry will be referenced.
4863 The return value is either a single string for a single field, or a
4864 list of the fields in the rectangle ."
4865 (save-match-data
4866 (let ((case-fold-search t) (id-loc nil)
4867 ;; Protect a bunch of variables from being overwritten
4868 ;; by the context of the remote table
4869 org-table-column-names org-table-column-name-regexp
4870 org-table-local-parameters org-table-named-field-locations
4871 org-table-current-line-types org-table-current-begin-line
4872 org-table-current-begin-pos org-table-dlines
4873 org-table-current-ncol
4874 org-table-hlines org-table-last-alignment
4875 org-table-last-column-widths org-table-last-alignment
4876 org-table-last-column-widths tbeg
4877 buffer loc)
4878 (setq form (org-table-convert-refs-to-rc form))
4879 (save-excursion
4880 (save-restriction
4881 (widen)
4882 (save-excursion
4883 (goto-char (point-min))
4884 (if (re-search-forward
4886 nil t)
4887 (setq buffer (current-buffer) loc (match-beginning 0))
4888 (setq id-loc (org-id-find name-or-id 'marker))
4889 (unless (and id-loc (markerp id-loc))
4891 (setq buffer (marker-buffer id-loc)
4892 loc (marker-position id-loc))
4893 (move-marker id-loc nil)))
4894 (with-current-buffer buffer
4895 (save-excursion
4896 (save-restriction
4897 (widen)
4898 (goto-char loc)
4899 (forward-char 1)
4901 (not (match-beginning 1)))
4902 (error "Cannot find a table at NAME or ID %s" name-or-id))
4903 (setq tbeg (point-at-bol))
4904 (org-table-get-specials)
4905 (setq form (org-table-formula-substitute-names
4906 (org-table-formula-handle-first/last-rc form)))
4907 (if (and (string-match org-table-range-regexp form)
4908 (> (length (match-string 0 form)) 1))
4909 (save-match-data
4910 (org-table-get-range (match-string 0 form) tbeg 1))
4911 form)))))))))
4913 (defmacro org-define-lookup-function (mode)
4914 (let ((mode-str (symbol-name mode))
4915 (first-p (equal mode 'first))
4916 (all-p (equal mode 'all)))
4917 (let ((plural-str (if all-p "s" "")))
4918 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
4919 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
4920 If R-LIST is nil, return matching element%s of S-LIST.
4921 If PREDICATE is not nil, use it instead of `equal' to match VAL.
4922 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
4923 This function is generated by a call to the macro `org-define-lookup-function'."
4924 mode-str plural-str plural-str plural-str)
4925 (let ,(let ((lvars '((p (or predicate 'equal))
4926 (sl s-list)
4927 (rl (or r-list s-list))
4928 (ret nil))))
4929 (if first-p (add-to-list 'lvars '(match-p nil)))
4930 lvars)
4931 (while ,(if first-p '(and (not match-p) sl) 'sl)
4932 (progn
4933 (if (funcall p val (car sl))
4934 (progn
4935 ,(if first-p '(setq match-p t))
4936 (let ((rval (car rl)))
4937 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
4938 (setq sl (cdr sl) rl (cdr rl))))
4939 ret)))))
4941 (org-define-lookup-function first)
4942 (org-define-lookup-function last)
4943 (org-define-lookup-function all)
4945 (provide 'org-table)
4947 ;; Local variables:
4948 ;; generated-autoload-file: "org-loaddefs.el"
4949 ;; End:
4951 ;;; org-table.el ends here