| blob | 7594ef6e11bb0979faadba85ec23b2ead7ce1796 |
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:
50 "Hook for functions attaching to `C-c C-c', if the table is sent.
51 This can be used to add additional functionality after the table is sent
52 to the receiver position, otherwise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
91 #+ END RECEIVE ORGTBL %n
93 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
94 | | |
96 "Templates for radio tables in different major modes.
97 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))))
424 "Check if the table has a marking column.
425 If yes remove the column and the special lines."
438 lines))))
447 nil)
451 ;; remove the first column
454 lines))))
460 ;;;###autoload
462 "Use the table.el package to insert a new table.
463 If there is already a table at point, convert between Org-mode tables
464 and table.el tables."
477 ;;;###autoload
479 "Convert region to table, or create an empty table.
480 If there is an active region, convert it to a table, using the function
481 `org-table-convert-region'. See the documentation of that function
482 to learn how the prefix argument is interpreted to determine the field
483 separator.
484 If there is no such region, create an empty table with `org-table-create'."
490 ;;;###autoload
492 "Query for a size and insert a table skeleton.
512 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
516 ;; Insert a hline after the first row.
523 ;;;###autoload
525 "Convert region to a table.
526 The region goes from BEG0 to END0, but these borders will be moved
527 slightly, to make sure a beginning of line in the first line is included.
529 SEPARATOR specifies the field separator in the lines. It can have the
530 following values:
532 '(4) Use the comma as a field separator
533 '(16) Use a TAB as field separator
534 integer When a number, use that many spaces as field separator
535 nil When nil, the command tries to be smart and figure out the
536 separator in the following way:
537 - when each line contains a TAB, assume TAB-separated material
538 - when each line contains a comma, assume CSV material
539 - else, assume one or more SPACE characters as separator."
543 re)
550 ;; Get the right field separator
561 ;; parse the csv stuff
584 ;;;###autoload
586 "Import FILE as a table.
587 The file is assumed to be tab-separated. Such files can be produced by most
588 spreadsheet and database applications. If no tabs (at least one per line)
589 are found, lines will be split on whitespace into fields."
600 ;;;###autoload
602 "Export table to a file, with configurable format.
603 Such a file can be imported into usual spreadsheet programs.
605 FILE can be the output file name. If not given, it will be taken
606 from a TABLE_EXPORT_FILE property in the current entry or higher
607 up in the hierarchy, or the user will be prompted for a file
608 name. FORMAT can be an export format, of the same kind as it
609 used when `orgtbl-mode' sends a table in a different format.
611 The command suggests a format depending on TABLE_EXPORT_FORMAT,
612 whether it is set locally or up in the hierarchy, then on the
613 extension of the given file name, and finally on the variable
614 `org-table-export-default-format'."
628 buf deffmt-readable fileext)
644 org-table-export-default-format))
662 'hline
665 skipcols i0)))
666 lines))
670 skipcols i0))
673 skipcols i0)))
690 "Marker at the beginning of the table last aligned.
693 "Marker at the end of the table last aligned.
696 "List of flags for flushright alignment, from the last re-alignment.
699 "List of max width of fields in each column.
702 "Non-nil means debug table formulas.
714 ;;;###autoload
716 "Align the table at point by aligning all vertical bars."
719 ;; Limits of table
722 ;; Current cursor position
728 column
730 rfmt hfmt
738 emptystrings links dates emph raise narrow
739 falign falign1 fmax f1 len c e space)
742 ;; Check if we have links or dates
754 ;; Make sure the link properties are right
756 ;; Make sure the date properties are right
761 ;; Check if we are narrowing any columns
764 org-format-transports-properties-p
769 ;; Get the rows
772 ;; Store the indentation of the first line
775 ;; Mark the hlines by setting the corresponding element to nil
776 ;; At the same time, we remove trailing space.
779 nil
782 l)))
783 lines))
784 ;; Get the data fields by splitting the lines.
789 ;; How many fields in the longest line?
796 ;; A list of empty strings to fill any short rows on output
798 ;; Check for special formatting.
802 ;; Check if there is an explicit width specified
812 ;; Find fields that are wider than fmax, and shorten them
818 'help-echo
819 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
827 xx)))))
828 ;; Get the maximum width for each column
830 lengths)
831 ;; Get the fraction of numbers, to decide about alignment of the column
837 nil
844 ;; Store the alignment of this table, for later editing of single fields
846 org-table-last-column-widths lengths)
848 ;; With invisible characters, `format' does not get the field width right
849 ;; So we need to make these fields wide by hand.
867 ;; Compute the formats needed for output of the table
880 hfmt))
884 ;; Replace the old one
891 ;; Try to move to the old location
900 ))
903 "Find the beginning of the table and return its position.
904 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
908 org-table-border-regexp)
909 nil t))
916 "Find the end of the table and return its position.
917 With argument TABLE-TYPE, go to the end of a table.el-type table."
921 org-table-border-regexp)
922 nil t))
927 ;;;###autoload
929 "Justify the current field, text to left, number to right.
930 Optional argument NEW may specify text to replace the current field content."
939 ;; This is not the same table, force a full re-align
945 l f n o e)
968 ;;;###autoload
970 "Go to the next field in the current table, creating new lines as needed.
971 Before doing so, re-align the table if necessary."
976 org-table-may-need-update)
987 org-table-tab-jumps-over-hlines
998 ;;;###autoload
1000 "Go to the previous field in the table.
1001 Before doing so, re-align the table if necessary."
1006 org-table-may-need-update)
1021 "Move to the end of the current table field.
1022 If already at or after the end, move to the end of the next table field.
1023 With numeric argument N, move N-1 fields forward first."
1036 "Move to the beginning of the current table field.
1037 If already at or before the beginning, move to the beginning of the
1038 previous field.
1039 With numeric argument N, move N-1 fields backward first."
1052 ;;;###autoload
1054 "Go to the next row (same column) in the current table.
1055 Before doing so, re-align the table if necessary."
1063 org-table-may-need-update)
1076 ;;;###autoload
1078 "Copy a field down in the current column.
1079 If the field at the cursor is empty, copy into it the content of
1080 the nearest non-empty field above. With argument N, use the Nth
1081 non-empty field. If the current field is not empty, it is copied
1082 down to the next row, and the cursor is moved with it.
1083 Therefore, repeating this command causes the column to be filled
1084 row-by-row.
1085 If the variable `org-table-copy-increment' is non-nil and the
1086 field is an integer or a timestamp, it will be incremented while
1087 copying. In the case of a timestamp, increment by one day."
1095 txt)
1107 beg t))
1130 "Is point inside a table data field?
1131 I.e. not on a hline or before the first or after the last column?
1132 This actually throws an error, so it aborts the current command."
1138 nil
1140 t))
1146 "Get the field in table line LINE, column COLUMN.
1147 If LINE is larger than the number of data lines in the table, the function
1148 returns nil. However, if COLUMN is too large, we will simply return an
1149 empty string.
1150 If LINE is nil, use the current line.
1151 If column is nil, use the current column."
1158 "Put VALUE into line LINE, column COLUMN.
1159 When ALIGN is set, also realign the table."
1168 "Return the index of the current data line."
1175 cnt))
1178 "Go to the Nth data line in the current table.
1179 Return t when the line exists, nil if it does not exist."
1187 "Blank the current table field or active region."
1204 "Return the value of the field in column N of current row.
1205 N defaults to current field.
1206 If REPLACE is a string, replace field with this value. The return value
1207 is always the old value."
1216 t t))
1218 val)
1221 ;;;###autoload
1223 "Show info about the current field, and highlight any reference at point."
1231 org-table-named-field-locations)))
1251 dline col
1253 dline col ref1
1255 ;; FIXME: formula info not correct if special table line
1265 "Find out which column we are in."
1275 cnt)))
1277 ;;;###autoload
1279 "Find out what table data line we are in.
1280 Only data lines count for this."
1292 cnt)))
1294 ;;;###autoload
1296 "Move the cursor to the Nth column in the current table line.
1297 With optional argument ON-DELIM, stop with point before the left delimiter
1298 of the field.
1299 If there are less than N fields, just go to after the last delimiter.
1300 However, when FORCE is non-nil, create new columns if necessary."
1310 t)))))
1317 ;;;###autoload
1319 "Insert a new column into the table."
1327 ;; Current cursor position
1333 nil
1347 "Find a data line in the current table, which is needed for column commands."
1350 t
1361 t
1366 "Turn a buffer line number into a data line number.
1367 If there is no data line in this line, return nil.
1368 If there is no matching dline (most likely te reference was a hline), the
1369 first dline below it is used. When ABOVE is non-nil, the one above is used."
1372 i)
1385 nil))
1387 ;;;###autoload
1389 "Delete a column from the table."
1398 ;; Current cursor position
1404 nil
1420 ;;;###autoload
1422 "Move column to the right."
1425 ;;;###autoload
1427 "Move column to the left."
1431 ;;;###autoload
1433 "Move the current column to the right. With arg LEFT, move to the left."
1443 ;; Current cursor position
1453 nil
1471 ;;;###autoload
1473 "Move table row down."
1476 ;;;###autoload
1478 "Move table row up."
1482 ;;;###autoload
1484 "Move the current table line down. With arg UP, move it up."
1493 txt hline2p)
1516 ;;;###autoload
1518 "Insert a new row above the current line into the table.
1519 With prefix ARG, insert below the current line."
1525 ;; Fix the first field if necessary
1538 ;;;###autoload
1540 "Insert a horizontal-line below the current line into the table.
1541 With prefix ABOVE, insert above the current line."
1562 ;;;###autoload
1564 "Insert a hline and move to the row below that line."
1578 In particular, this does handle wide and invisible characters."
1580 ;; It's a hline, just map the characters
1586 t t s)))
1587 s))
1589 ;;;###autoload
1591 "Delete the current row or horizontal line from the table."
1605 ;;;###autoload
1607 "Sort table lines according to the column at point.
1609 The position of point indicates the column to be used for
1610 sorting, and the range of lines is the range between the nearest
1611 horizontal separator lines, or the entire table of no such lines
1612 exist. If point is before the first column, you will be prompted
1613 for the sorting column. If there is an active region, the mark
1614 specifies the first line and the sorting column, while point
1615 should be in the last line to be included into the sorting.
1617 The command then prompts for the sorting type which can be
1618 alphabetically, numerically, or by time (as given in a time stamp
1619 in the field). Sorting in reverse order is also possible.
1621 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1623 If SORTING-TYPE is specified when this function is called from a Lisp
1624 program, no prompting will take place. SORTING-TYPE must be a character,
1625 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1626 should be done in reverse order."
1631 beg end bcol ecol tend tbeg column lns pos)
1676 x))
1690 ;;;###autoload
1692 "Copy region in table to the clipboard and blank all relevant fields.
1693 If there is no active region, use just the field at point."
1699 ;;;###autoload
1701 "Copy rectangular region in table to clipboard.
1702 A special clipboard is used which can only be accessed
1703 with `org-table-paste-rectangle'."
1707 current-prefix-arg))
1709 region cols
1735 org-table-clip))
1737 ;;;###autoload
1739 "Paste a rectangular region into a table.
1740 The upper right corner ends up in the current field. All involved fields
1741 will be overwritten. If the rectangle does not fit into the present table,
1742 the table is enlarged as needed. The process ignores horizontal separator
1743 lines."
1753 c cols field)
1768 ;;;###autoload
1770 "Convert from `org-mode' table to table.el and back.
1771 Obviously, this only works within limits. When an Org-mode table is
1772 converted to table.el, all horizontal separator lines get lost, because
1773 table.el uses these as cell boundaries and has no notion of horizontal lines.
1774 A table.el table can be converted to an Org-mode table only if it does not
1775 do row or column spanning. Multiline cells will become multiple cells.
1776 Beware, Org-mode does not test if the table can be successfully converted - it
1777 blindly applies a recipe that works for simple tables."
1781 ;; convert to Org-mode table
1790 ;; convert to table.el table
1793 ;; first, get rid of all horizontal lines
1797 ;; insert a hline before first
1801 ;; insert a hline after each line
1806 ;; replace "+" at beginning and ending of hlines
1815 "Transpose orgmode table at point and eliminate hlines.
1816 So a table like
1818 | 1 | 2 | 4 | 5 |
1819 |---+---+---+---|
1820 | a | b | c | d |
1821 | e | f | g | h |
1823 will be transposed as
1825 | 1 | a | e |
1826 | 2 | b | f |
1827 | 4 | c | g |
1828 | 5 | d | h |
1830 Note that horizontal lines disappeared."
1834 ;; remove 'hline from list
1842 ;;;###autoload
1844 "Wrap several fields in a column like a paragraph.
1845 This is useful if you'd like to spread the contents of a field over several
1846 lines, in order to keep the table compact.
1848 If there is an active region, and both point and mark are in the same column,
1849 the text in the column is wrapped to minimum width for the given number of
1850 lines. Generally, this makes the table more compact. A prefix ARG may be
1852 formats the selected text to two lines. If the region was longer than two
1853 lines, the remaining lines remain empty. A negative prefix argument reduces
1854 the current number of lines by that amount. The wrapped text is pasted back
1855 into the table. If you formatted it to more lines than it was before, fields
1856 further down in the table get overwritten - so you might need to make space in
1857 the table first.
1859 If there is no region, the current field is split at the cursor position and
1860 the text fragment to the right of the cursor is prepended to the field one
1861 line down.
1863 If there is no region, but you specify a prefix ARG, the current field gets
1864 blank, and the content is appended to the field above."
1868 ;; There is a region: fill as a paragraph
1872 nlines)
1879 arg)
1883 nil nlines)))
1887 ;; No region, split the current field at point
1891 ;; combine with field above
1901 ;; split field
1913 ;;;###autoload
1915 "Edit table field in a different window.
1916 This is mainly useful for fields that contain hidden parts.
1918 it can be edited in place."
1927 display t intangible t))
1940 p)
1956 intangible t))
1964 "Finish editing a table data field.
1965 Remove all newline characters, insert the result into the table, realign
1966 the table and kill the editing buffer."
1970 text)
1987 "Minor mode to make the table field editor window follow the cursor.
1988 When this mode is active, the field editor window will always show the
1989 current field. The mode exits automatically when the cursor leaves the
1990 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1991 nil " TblFollow" nil
2007 ;; We have left the table, exit the follow mode
2017 ;;;###autoload
2019 "Sum numbers in region of current table column.
2020 The result will be displayed in the echo area, and will be available
2023 If there is an active region, it is interpreted as a rectangle and all
2024 numbers in that rectangle will be summed. If there is no active
2025 region and point is located in a table column, sum all numbers in that
2026 column.
2028 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2029 numbers are assumed to be times as well (in decimal hours) and the
2030 numbers are added as such.
2032 If NLAST is a number, only the NLAST fields will actually be summed."
2059 items1)))
2066 s diff)
2074 sres))))
2097 "Return the formula active for the current field.
2098 Assumes that specials are in place.
2099 If KEY is given, return the key to this formula.
2103 org-table-named-field-locations)))
2117 "Read a formula from the minibuffer, offer stored formula as default.
2118 When NAMED is non-nil, look for a named equation."
2122 org-table-named-field-locations)))
2129 name
2130 ref)
2140 stored)
2142 equation)
2149 scol))
2151 'org-table-formula-history
2152 )))))
2153 mustsave)
2155 ;; remove formula
2162 ;; We set the column equation, delete the named one.
2164 mustsave t))
2170 eq))
2173 "Store the list of formulas below the current table."
2180 ;; don't overwrite TBLFM, we might use text properties to store stuff
2196 ;; Fake a high number to make sure this is sorted at the end.
2203 a)
2213 "Compare two formulas for sorting."
2218 ;;;###autoload
2220 "Return an alist with the stored formulas directly after current table."
2229 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2248 "Modify the equations after the table structure has been edited.
2250 For all numbers larger than LIMIT, shift them by DELTA."
2262 s n a)
2282 "Get the column names and local parameters for this table."
2285 names name fields fields1 field cnt
2286 c v l line col types dlines hlines last-dline)
2288 org-table-local-parameters nil
2289 org-table-named-field-locations nil
2290 org-table-current-begin-line nil
2291 org-table-current-begin-pos nil
2292 org-table-current-line-types nil
2311 org-table-local-parameters))))
2327 ;; Analyse the line types
2331 l org-table-current-begin-line)
2348 al al2)
2358 ;;;###autoload
2361 If yes, store the formula and apply it."
2362 ;; We already know we are in a table. Get field will only return a formula
2363 ;; when appropriate. It might return a separator line, but no problem.
2366 named eq)
2377 "List of commands triggering the recalculation of a line.
2389 ;;;###autoload
2391 "Rotate the recalculation mark in the first column.
2392 If in any row, the first field is not consistent with a mark,
2393 insert a new column for the markers.
2394 When there is an active region, change all the lines in the region,
2395 after prompting for the marking character.
2396 After each change, a message will be displayed indicating the meaning
2397 of the new mark."
2412 epos new)
2419 newchar))
2451 ;;;###autoload
2453 "Recompute the current line if marked for it, and if we haven't just done it."
2473 org-tbl-calc-modes)
2475 ;;;###autoload
2477 suppress-align suppress-const
2478 suppress-store suppress-analysis)
2479 "Replace the table field value at the cursor by the result of a calculation.
2481 This function makes use of Dave Gillespie's Calc package, in my view the
2482 most exciting program ever written for GNU Emacs. So you need to have Calc
2483 installed in order to use this function.
2485 In a table, this command replaces the value in the current field with the
2487 formula, by storing it in a special line below the table. When called
2488 with a `C-u' prefix, the current field must be a named field, and the
2489 formula is installed as valid in only this specific field.
2491 When called with two `C-u' prefixes, insert the active equation
2492 for the field back into the current field, so that it can be
2494 to check the referenced fields.
2496 When called, the command first prompts for a formula, which is read in
2497 the minibuffer. Previously entered formulas are available through the
2498 history list, and the last used formula is offered as a default.
2499 These stored formulas are adapted correctly when moving, inserting, or
2500 deleting columns with the corresponding commands.
2502 The formula can be any algebraic expression understood by the Calc package.
2503 For details, see the Org-mode manual.
2505 This function can also be called from Lisp programs and offers
2506 additional arguments: EQUATION can be the formula to apply. If this
2507 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2508 used to speed-up recursive calls by by-passing unnecessary aligns.
2509 SUPPRESS-CONST suppresses the interpretation of constants in the
2510 formula, assuming that this has been done already outside the function.
2511 SUPPRESS-STORE means the formula should not be stored, either because
2512 it is already stored, or because it is a modified equation that should
2513 not overwrite the stored one."
2529 equation
2535 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2536 duration duration-output-format)
2537 ;; Parse the format string. Since we have a lot of modes, this is
2538 ;; a lot of work. However, I think calc still uses most of the time.
2551 'calc-float-format
2554 n))))
2558 duration-output-format nil
2562 duration-output-format org-table-duration-custom-format
2563 numbers t
2586 ;; replace fields with duration values if relevant
2590 fields)))
2596 x))
2597 fields)))
2603 ;; Insert row and column number of formula result field
2614 t t form)))
2616 ;; Check for old vertical references
2618 ;; Insert remote references
2630 rmtrng))
2631 keep-empty numbers lispp))
2632 t t form)))
2633 ;; Insert complex ranges
2641 ;; possibly handle durations
2646 formrg)
2647 keep-empty numbers lispp)))
2652 ;; Insert simple ranges
2661 keep-empty numbers lispp))
2662 t t form)))
2664 ;; Insert the references to fields in same row
2674 x keep-empty numbers lispp))
2675 t t form)))
2687 ;; Use <...> time-stamps so that Calc can handle them
2689 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2700 form
2707 duration-output-format)
2708 ev)))
2713 Orig: %s
2714 $xyz-> %s
2715 @r$c-> %s
2747 prop value)))
2750 "Get a calc vector from a column, according to descriptor DESC.
2751 Optional arguments TBEG and COL can give the beginning of the table and
2752 the current column, to avoid unnecessary parsing.
2754 HIGHLIGHT means just highlight the range.
2756 When CORNERS-ONLY is set, only return the corners of the range as
2757 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2758 in the buffer and column1 and column2 are table column numbers."
2765 beg end c1 c2 r1 r2 rangep tmp)
2782 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2789 ;; just one field
2796 ;; A range, return a vector
2797 ;; First sort the numbers to get a regular rectangle
2801 ;; Only return the corners of the range
2803 ;; Copy the range values into a list
2817 ;; return string representation of calc vector
2822 "Analyze descriptor DESC and retrieve the corresponding line number.
2823 The cursor is currently in line CLINE, the table begins in line BLINE,
2824 and TABLE is a vector with line types."
2832 ;; 1 2 3 4 5 6
2852 nil hn cline desc)))
2855 rel on cline desc)))
2859 "FIXME: Needs more documentation."
2872 nil))
2873 t)))
2877 desc cline)
2878 i)))
2883 s))
2886 "Convert list ELEMENTS to something appropriate to insert into formula.
2887 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2888 NUMBERS indicates that everything should be converted to numbers.
2889 LISPP non-nil means to return something appropriate for a Lisp
2890 list, 'literal is for the format specifier L."
2891 ;; Calc nan (not a number) is used for the conversion of the empty
2892 ;; field to a reference for several reasons: (i) It is accepted in a
2893 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2894 ;; (ii) In a single field (not in range) it can be distinguished
2895 ;; from "(nan)" which is the reference made from a single field
2896 ;; containing "nan".
2898 ;; field reference
2901 elements
2903 ""
2912 ;; range reference
2917 elements))))
2923 x
2931 x)
2933 elements
2936 ;;;###autoload
2938 "Set `org-table-formula-constants-local' in the current buffer."
2954 ;;;###autoload
2956 "Recalculate the current table line by applying all stored formulas.
2957 With prefix arg ALL, do this for all lines in the table.
2958 With the prefix argument ALL is `(16)' \
2960 it is the symbol `iterate', recompute the table until it no longer changes.
2961 If NOALIGN is not nil, do not re-align the table after the computations
2962 are done. This is typically used internally to save time, if it is
2963 known that the table will be realigned a little later anyway."
2978 seen-fields lhs1
2980 ;; Insert constants in all formulas
2996 eqlist))
2997 ;; Split the equation list
3003 ;; Expand ranges in lhs of formulas
3006 ;; Get the correct line range to process
3012 ;; This is a table with marked lines, compute selected lines
3014 ;; Move forward to the first non-header line
3025 ;; First find the named fields, and mark them untouchable.
3026 ;; Also check if several field/range formulas try to set the same field.
3045 name)))
3055 ;; Now evaluate the column formulas, but skip fields covered by
3056 ;; field formulas
3060 ;; Unprotected line, recalculate
3072 ;; Now evaluate the field formulas
3086 ;; back to initial position
3093 ;;;###autoload
3095 "Recalculate the table until it does not change anymore.
3096 The maximum number of iterations is 10, but you can choose a different value
3097 with the prefix ARG."
3102 thistbl)
3116 ;;;###autoload
3118 "Recalculate all tables in the current buffer."
3125 ;;;###autoload
3127 "Iterate all tables in the buffer, to converge inter-table dependencies."
3132 c1)
3148 "Apply the #+TBLFM in the line at point to the table."
3154 s e)
3156 ;; Insert a temporary formula at right after the table
3161 ;; Recalculate the table
3167 ;; delete the formula inserted temporarily
3171 "Find the beginning of the TBLFM lines and return its position.
3172 Return nil when the beginning of TBLFM line was not found."
3176 org-table-TBLFM-begin-regexp
3177 nil t))
3181 "Expand list of formulas.
3182 If some of the RHS in the formulas are ranges or a row reference, expand
3183 them to individual field equations for each field."
3189 ;; This just refers to one fixed field
3192 ;; This just refers to one fixed named field
3214 "Replace @<, @>, $<, $> with first/last row/column of the table.
3215 So @< and $< will always be replaced with @1 and $1, respectively.
3216 The advantage of these special markers are that structure editing of
3217 the table will not change them, while @1 and $1 will be modified
3218 when a line/row is swapped out of that privileged position. So for
3219 formulas that use a range of rows or columns, it may often be better
3221 borders of the table using the @< @> $< $> makers."
3224 s start)
3229 org-table-current-ncol)
3233 len
3240 s)
3243 "Replace $const with values in string F."
3245 ;; First, check for column names
3250 ;; Parameters and constants
3252 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3262 f))
3265 "Find the value for a parameter or constant in a formula.
3266 Parameters get priority."
3297 map))
3304 "--"
3307 "--"
3308 "Shift Reference at Point"
3313 "-"
3314 "Change Test Row for Column Formulas"
3317 "--"
3322 org-table-overlay-coordinates)]
3323 "--"
3329 ;;;###autoload
3331 "Edit the formulas of the current table in a separate buffer."
3333 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3347 entry s type title)
3350 ;; Keep global-font-lock-mode from turning on font-lock-mode
3391 "Convert a formula from internal to user representation."
3394 s))
3397 "Convert a formula from user to internal representation."
3400 s))
3403 "Convert spreadsheet references from A7 to @7$28.
3404 Works for single references, but also for entire formulas and even the
3405 full TBLFM line."
3407 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3410 ;; format match, just advance
3415 ;; 3.e5 or something like this.
3418 ;; (member (match-string 1 s)
3419 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3420 )
3421 ;; function name, just advance
3431 t t s)))))
3432 s))
3435 "Convert spreadsheet references from to @7$28 to AB7.
3436 Works for single references, but also for entire formulas and even the
3437 full TBLFM line."
3444 t t s)))
3449 t nil s)))
3450 s)
3453 "Convert a base 26 number represented by letters into an integer.
3454 For example: AB -> 28."
3460 n))
3463 "Convert an integer into a base 26 number represented by letters.
3464 For example: 28 -> AB."
3469 s))
3472 "Convert a time string into numerical duration in seconds.
3473 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3474 If S is a string representing a number, keep this number."
3476 s
3499 "Convert a number of seconds to a time string.
3500 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3501 minutes or seconds."
3516 "Convert all references in this buffer, using FUNCTION."
3526 "Convert all references in the buffer from B3 to @3$2 and back."
3536 "Shift the reference at point one row/hline up."
3540 "Shift the reference at point one row/hline down."
3544 "Shift the reference at point one field to the left."
3548 "Shift the reference at point one field to the right."
3559 ;; A B3-like reference
3565 ;; An internal reference
3571 "Re-match the group N, and replace it with the shifted reference."
3576 t t)))
3579 "Shift a reference part REF.
3580 If DECR is set, decrease the references row/column, else increase.
3581 If HLINE is set, this may be a hline reference, it certainly is not
3582 a translation reference."
3611 "Toggle the display of coordinates in the referenced table."
3620 "Parse the buffer for formula definitions and install them.
3621 With prefix ARG, apply the new formulas to the table."
3631 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3632 nil t)
3656 "Abort editing formulas, without installing the changes."
3667 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3708 "Show the location/value of the $ expression at point."
3717 var name e what match dest)
3722 "$1.."
3805 ;; column number
3833 org-table-fedit-scroll-down))))
3844 "Make sure the cursor is in a dataline in a table."
3853 p1 p2)))
3858 "Move cursor one line up in the window showing the table."
3863 "Move cursor one line down in the window showing the table."
3868 "Move the cursor in the window showing the table.
3869 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3894 "Add a new overlay."
3900 "Highlight rectangular region in a table."
3904 l1 c1 l2 c2 tmp)
3928 "Remove the rectangle overlays."
3939 "Add overlays to the table at point, to show row/column coordinates."
3967 ;;;###autoload
3969 "Toggle the display of Row/Column numbers in tables."
3980 ;;;###autoload
3982 "Toggle the formula debugger in tables."
3988 ;;; The orgtbl minor mode
3990 ;; Define a minor mode which can be used in other modes in order to
3991 ;; integrate the org-mode table editor.
3993 ;; This is really a hack, because the org-mode table editor uses several
3994 ;; keys which normally belong to the major mode, for example the TAB and
3995 ;; RET keys. Here is how it works: The minor mode defines all the keys
3996 ;; necessary to operate the table editor, but wraps the commands into a
3997 ;; function which tests if the cursor is currently inside a table. If that
3998 ;; is the case, the table editor command is executed. However, when any of
3999 ;; those keys is used outside a table, the function uses `key-binding' to
4000 ;; look up if the key has an associated command in another currently active
4001 ;; keymap (minor modes, major mode, global), and executes that command.
4002 ;; There might be problems if any of the keys used by the table editor is
4003 ;; otherwise used as a prefix key.
4005 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4006 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4007 ;; addresses this by checking explicitly for both bindings.
4009 ;; The optimized version (see variable `orgtbl-optimized') takes over
4010 ;; all keys which are bound to `self-insert-command' in the *global map*.
4011 ;; Some modes bind other commands to simple characters, for example
4012 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4013 ;; active, this binding is ignored inside tables and replaced with a
4014 ;; modified self-insert.
4032 ;; Install it as a minor mode.
4036 ;;;###autoload
4038 "The `org-mode' table editor as a minor mode for use in other modes."
4043 ;; Exit without error, in case some hook functions calls this
4044 ;; by accident in org-mode.
4048 ;; Make sure we are first in minor-mode-map-alist
4050 ;; FIXME: maybe it should use emulation-mode-map-alists?
4057 auto-fill-inhibit-regexp)
4061 auto-fill-inhibit-regexp)
4062 orgtbl-line-start-regexp))
4080 "Remove all properties related to narrow-column invisibility."
4093 "Create a function for binding in the table minor mode.
4094 FUN is the command to call inside a table. N is used to create a unique
4095 command name. KEYS are keys that should be checked in for a command
4096 to execute outside of tables."
4102 "Outside of tables, run the binding of `"
4114 keys)
4118 "Error when there is no default binding for a table key."
4123 "Setup orgtbl keymaps."
4154 elt key fun cmd)
4162 ;; Special treatment needed for TAB and RET
4182 [(tab)] "\C-i")))
4184 (org-defkey orgtbl-mode-map [backtab]
4186 [backtab] [S-iso-lefttab] [(shift tab)]
4187 [(tab)] "\C-i"))
4189 (org-defkey orgtbl-mode-map "\M-\C-m"
4190 (orgtbl-make-binding 'org-table-wrap-region 105
4191 "\M-\C-m" [(meta return)]))
4192 (org-defkey orgtbl-mode-map [(meta return)]
4193 (orgtbl-make-binding 'org-table-wrap-region 106
4194 [(meta return)] "\M-\C-m"))
4196 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4197 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4199 (when orgtbl-optimized
4200 ;; If the user wants maximum table support, we need to hijack
4201 ;; some standard editing functions
4202 (org-remap orgtbl-mode-map
4203 'self-insert-command 'orgtbl-self-insert-command
4204 'delete-char 'org-delete-char
4205 'delete-backward-char 'org-delete-backward-char)
4206 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4207 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4208 '("OrgTbl"
4209 ["Create or convert" org-table-create-or-convert-from-region
4210 :active (not (org-at-table-p)) :keys "C-c |" ]
4211 "--"
4212 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4213 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4214 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4215 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4216 "--"
4217 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4218 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4219 ["Copy Field from Above"
4220 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4221 "--"
4222 ("Column"
4223 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4224 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4225 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4226 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4227 ("Row"
4228 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4229 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4230 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4231 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4232 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4233 "--"
4234 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4235 ("Rectangle"
4236 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4237 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4238 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4239 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4240 "--"
4241 ("Radio tables"
4242 ["Insert table template" orgtbl-insert-radio-table
4243 (assq major-mode orgtbl-radio-table-templates)]
4244 ["Comment/uncomment table" orgtbl-toggle-comment t])
4245 "--"
4246 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4247 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4248 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4249 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4250 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4251 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4252 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4253 ["Sum Column/Rectangle" org-table-sum
4254 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4255 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4256 ["Debug Formulas"
4257 org-table-toggle-formula-debugger :active (org-at-table-p)
4258 :keys "C-c {"
4259 :style toggle :selected org-table-formula-debug]
4260 ["Show Col/Row Numbers"
4261 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4262 :keys "C-c }"
4263 :style toggle :selected org-table-overlay-coordinates]
4264 ))
4265 t))
4267 (defun orgtbl-ctrl-c-ctrl-c (arg)
4268 "If the cursor is inside a table, realign the table.
4269 If it is a table to be sent away to a receiver, do it.
4270 With prefix arg, also recompute table."
4271 (interactive "P")
4272 (let ((case-fold-search t) (pos (point)) action)
4273 (save-excursion
4274 (beginning-of-line 1)
4275 (setq action (cond
4279 (cond
4280 ((integerp action)
4281 (goto-char action)
4282 (org-table-maybe-eval-formula)
4283 (if arg
4284 (call-interactively 'org-table-recalculate)
4285 (org-table-maybe-recalculate-line))
4286 (call-interactively 'org-table-align)
4287 (when (orgtbl-send-table 'maybe)
4288 (run-hooks 'orgtbl-after-send-table-hook)))
4289 ((eq action 'recalc)
4290 (org-table-set-constants)
4291 (save-excursion
4292 (beginning-of-line 1)
4294 (if (org-at-table-p)
4295 (org-call-with-arg 'org-table-recalculate t))))
4296 (t (let (orgtbl-mode)
4297 (call-interactively (key-binding "\C-c\C-c")))))))
4299 (defun orgtbl-create-or-convert-from-region (arg)
4300 "Create table or convert region to table, if no conflicting binding.
4301 This installs the table binding `C-c |', but only if there is no
4302 conflicting binding to this key outside orgtbl-mode."
4303 (interactive "P")
4304 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4305 (if cmd
4306 (call-interactively cmd)
4307 (call-interactively 'org-table-create-or-convert-from-region))))
4309 (defun orgtbl-tab (arg)
4310 "Justification and field motion for `orgtbl-mode'."
4311 (interactive "P")
4312 (if arg (org-table-edit-field t)
4313 (org-table-justify-field-maybe)
4314 (org-table-next-field)))
4316 (defun orgtbl-ret ()
4317 "Justification and field motion for `orgtbl-mode'."
4318 (interactive)
4319 (if (bobp)
4320 (newline)
4321 (org-table-justify-field-maybe)
4322 (org-table-next-row)))
4324 (defun orgtbl-self-insert-command (N)
4325 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4326 If the cursor is in a table looking at whitespace, the whitespace is
4327 overwritten, and the table is not marked as requiring realignment."
4328 (interactive "p")
4329 (if (and (org-at-table-p)
4330 (or
4331 (and org-table-auto-blank-field
4332 (member last-command
4333 '(orgtbl-hijacker-command-100
4334 orgtbl-hijacker-command-101
4335 orgtbl-hijacker-command-102
4336 orgtbl-hijacker-command-103
4337 orgtbl-hijacker-command-104
4338 orgtbl-hijacker-command-105
4339 yas/expand))
4340 (org-table-blank-field))
4341 t)
4342 (eq N 1)
4344 (let (org-table-may-need-update)
4345 (goto-char (1- (match-end 0)))
4346 (org-delete-backward-char 1)
4347 (goto-char (match-beginning 0))
4348 (self-insert-command N))
4349 (setq org-table-may-need-update t)
4350 (let* (orgtbl-mode
4351 a
4352 (cmd (or (key-binding
4353 (or (and (listp function-key-map)
4354 (setq a (assoc last-input-event function-key-map))
4355 (cdr a))
4356 (vector last-input-event)))
4357 'self-insert-command)))
4358 (call-interactively cmd)
4359 (if (and org-self-insert-cluster-for-undo
4360 (eq cmd 'self-insert-command))
4361 (if (not (eq last-command 'orgtbl-self-insert-command))
4362 (setq org-self-insert-command-undo-counter 1)
4363 (if (>= org-self-insert-command-undo-counter 20)
4364 (setq org-self-insert-command-undo-counter 1)
4365 (and (> org-self-insert-command-undo-counter 0)
4366 buffer-undo-list
4367 (not (cadr buffer-undo-list)) ; remove nil entry
4368 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4369 (setq org-self-insert-command-undo-counter
4370 (1+ org-self-insert-command-undo-counter))))))))
4373 "Regular expression matching exponentials as produced by calc.")
4375 (defun orgtbl-gather-send-defs ()
4376 "Gather a plist of :name, :transform, :params for each destination before
4377 a radio table."
4378 (save-excursion
4379 (goto-char (org-table-begin))
4380 (let (rtn)
4381 (beginning-of-line 0)
4382 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4383 (let ((name (org-no-properties (match-string 1)))
4384 (transform (intern (match-string 2)))
4385 (params (if (match-end 3)
4386 (read (concat "(" (match-string 3) ")")))))
4387 (push (list :name name :transform transform :params params)
4388 rtn)
4389 (beginning-of-line 0)))
4390 rtn)))
4392 (defun orgtbl-send-replace-tbl (name txt)
4393 "Find and replace table NAME with TXT."
4394 (save-excursion
4395 (goto-char (point-min))
4396 (unless (re-search-forward
4398 (user-error "Don't know where to insert translated table"))
4399 (goto-char (match-beginning 0))
4400 (beginning-of-line 2)
4401 (save-excursion
4402 (let ((beg (point)))
4403 (unless (re-search-forward
4404 (concat "END RECEIVE ORGTBL +" name) nil t)
4405 (user-error "Cannot find end of insertion region"))
4406 (beginning-of-line 1)
4407 (delete-region beg (point))))
4410 ;;;###autoload
4411 (defun org-table-to-lisp (&optional txt)
4412 "Convert the table at point to a Lisp structure.
4413 The structure will be a list. Each item is either the symbol `hline'
4414 for a horizontal separator line, or a list of field values as strings.
4415 The table is taken from the parameter TXT, or from the buffer at point."
4416 (unless txt
4417 (unless (org-at-table-p)
4418 (user-error "No table at point")))
4419 (let* ((txt (or txt
4420 (buffer-substring-no-properties (org-table-begin)
4421 (org-table-end))))
4424 (mapcar
4425 (lambda (x)
4426 (if (string-match org-table-hline-regexp x)
4427 'hline
4429 lines)))
4431 (defun orgtbl-send-table (&optional maybe)
4432 "Send a transformed version of this table to the receiver position.
4433 With argument MAYBE, fail quietly if no transformation is defined for
4434 this table."
4435 (interactive)
4436 (catch 'exit
4437 (unless (org-at-table-p) (user-error "Not at a table"))
4438 ;; when non-interactive, we assume align has just happened.
4439 (when (org-called-interactively-p 'any) (org-table-align))
4440 (let ((dests (orgtbl-gather-send-defs))
4441 (txt (buffer-substring-no-properties (org-table-begin)
4442 (org-table-end)))
4443 (ntbl 0))
4444 (unless dests (if maybe (throw 'exit nil)
4445 (user-error "Don't know how to transform this table")))
4446 (dolist (dest dests)
4447 (let* ((name (plist-get dest :name))
4448 (transform (plist-get dest :transform))
4449 (params (plist-get dest :params))
4450 (skip (plist-get params :skip))
4451 (skipcols (plist-get params :skipcols))
4452 (no-escape (plist-get params :no-escape))
4453 beg
4454 (lines (org-table-clean-before-export
4455 (nthcdr (or skip 0)
4457 (i0 (if org-table-clean-did-remove-column 2 1))
4458 (lines (if no-escape lines
4459 (mapcar (lambda(l) (replace-regexp-in-string
4461 (table (mapcar
4462 (lambda (x)
4463 (if (string-match org-table-hline-regexp x)
4464 'hline
4465 (org-remove-by-index
4467 skipcols i0)))
4468 lines))
4469 (fun (if (= i0 2) 'cdr 'identity))
4470 (org-table-last-alignment
4471 (org-remove-by-index (funcall fun org-table-last-alignment)
4472 skipcols i0))
4473 (org-table-last-column-widths
4474 (org-remove-by-index (funcall fun org-table-last-column-widths)
4475 skipcols i0))
4476 (txt (if (fboundp transform)
4477 (funcall transform table params)
4478 (user-error "No such transformation function %s" transform))))
4479 (orgtbl-send-replace-tbl name txt))
4480 (setq ntbl (1+ ntbl)))
4481 (message "Table converted and installed at %d receiver location%s"
4482 ntbl (if (> ntbl 1) "s" ""))
4483 (if (> ntbl 0)
4484 ntbl
4485 nil))))
4487 (defun org-remove-by-index (list indices &optional i0)
4488 "Remove the elements in LIST with indices in INDICES.
4489 First element has index 0, or I0 if given."
4490 (if (not indices)
4491 list
4492 (if (integerp indices) (setq indices (list indices)))
4493 (setq i0 (1- (or i0 0)))
4494 (delq :rm (mapcar (lambda (x)
4495 (setq i0 (1+ i0))
4496 (if (memq i0 indices) :rm x))
4497 list))))
4499 (defun orgtbl-toggle-comment ()
4500 "Comment or uncomment the orgtbl at point."
4501 (interactive)
4502 (let* ((case-fold-search t)
4503 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4504 (re2 (concat "^" orgtbl-line-start-regexp))
4505 (commented (save-excursion (beginning-of-line 1)
4506 (cond ((looking-at re1) t)
4507 ((looking-at re2) nil)
4508 (t (user-error "Not at an org table")))))
4509 (re (if commented re1 re2))
4510 beg end)
4511 (save-excursion
4512 (beginning-of-line 1)
4513 (while (looking-at re) (beginning-of-line 0))
4514 (beginning-of-line 2)
4515 (setq beg (point))
4516 (while (looking-at re) (beginning-of-line 2))
4517 (setq end (point)))
4518 (comment-region beg end (if commented '(4) nil))))
4520 (defun orgtbl-insert-radio-table ()
4521 "Insert a radio table template appropriate for this major mode."
4522 (interactive)
4523 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4524 (txt (nth 1 e))
4525 name pos)
4526 (unless e (user-error "No radio table setup defined for %s" major-mode))
4527 (setq name (read-string "Table name: "))
4528 (while (string-match "%n" txt)
4529 (setq txt (replace-match name t t txt)))
4531 (setq pos (point))
4532 (insert txt)
4533 (goto-char pos)))
4535 ;; Dynamically bound input and output for table formatting.
4536 (defvar *orgtbl-table* nil
4537 "Carries the current table through formatting routines.")
4538 (defvar *orgtbl-rtn* nil
4539 "Formatting routines push the output lines here.")
4540 ;; Formatting parameters for the current table section.
4541 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4542 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4543 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4544 (defvar *orgtbl-fmt* nil "Format for each entry.")
4545 (defvar *orgtbl-efmt* nil "Format for numbers.")
4546 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4547 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4548 (defvar *orgtbl-lstart* nil "Text starting a row.")
4549 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4550 (defvar *orgtbl-lend* nil "Text ending a row.")
4551 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4553 (defsubst orgtbl-get-fmt (fmt i)
4554 "Retrieve the format from FMT corresponding to the Ith column."
4555 (if (and (not (functionp fmt)) (consp fmt))
4556 (plist-get fmt i)
4557 fmt))
4559 (defsubst orgtbl-apply-fmt (fmt &rest args)
4560 "Apply format FMT to arguments ARGS.
4561 When FMT is nil, return the first argument from ARGS."
4562 (cond ((functionp fmt) (apply fmt args))
4563 (fmt (apply 'format fmt args))
4564 (args (car args))
4565 (t args)))
4567 (defsubst orgtbl-eval-str (str)
4568 "If STR is a function, evaluate it with no arguments."
4569 (if (functionp str)
4570 (funcall str)
4571 str))
4573 (defun orgtbl-format-line (line)
4574 "Format LINE as a table row."
4575 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4576 (let* ((i 0)
4577 (line
4578 (mapcar
4579 (lambda (f)
4580 (setq i (1+ i))
4581 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4582 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4583 (orgtbl-apply-fmt efmt (match-string 1 f)
4584 (match-string 2 f))
4585 f)))
4586 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4587 *orgtbl-default-fmt*)
4588 f)))
4589 line)))
4590 (push (if *orgtbl-lfmt*
4591 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4592 (concat (orgtbl-eval-str *orgtbl-lstart*)
4593 (mapconcat 'identity line *orgtbl-sep*)
4594 (orgtbl-eval-str *orgtbl-lend*)))
4595 *orgtbl-rtn*))))
4597 (defun orgtbl-format-section (section-stopper)
4598 "Format lines until the first occurrence of SECTION-STOPPER."
4599 (let (prevline)
4600 (progn
4601 (while (not (eq (car *orgtbl-table*) section-stopper))
4602 (if prevline (orgtbl-format-line prevline))
4603 (setq prevline (pop *orgtbl-table*)))
4604 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4605 (*orgtbl-lend* *orgtbl-llend*)
4606 (*orgtbl-lfmt* *orgtbl-llfmt*))
4607 (orgtbl-format-line prevline))))))
4609 ;;;###autoload
4610 (defun orgtbl-to-generic (table params &optional backend)
4611 "Convert the orgtbl-mode TABLE to some other format.
4612 This generic routine can be used for many standard cases.
4613 TABLE is a list, each entry either the symbol `hline' for a horizontal
4614 separator line, or a list of fields for that line.
4615 PARAMS is a property list of parameters that can influence the conversion.
4616 A third optional argument BACKEND can be used to convert the content of
4617 the cells using a specific export back-end.
4619 For the generic converter, some parameters are obligatory: you need to
4620 specify either :lfmt, or all of (:lstart :lend :sep).
4622 Valid parameters are:
4624 :splice When set to t, return only table body lines, don't wrap
4625 them into :tstart and :tend. Default is nil. When :splice
4626 is non-nil, this also means that the exporter should not look
4627 for and interpret header and footer sections.
4629 :hline String to be inserted on horizontal separation lines.
4630 May be nil to ignore hlines.
4632 :sep Separator between two fields
4633 :remove-nil-lines Do not include lines that evaluate to nil.
4635 Each in the following group may be either a string or a function
4636 of no arguments returning a string:
4638 :tstart String to start the table. Ignored when :splice is t.
4639 :tend String to end the table. Ignored when :splice is t.
4640 :lstart String to start a new table line.
4641 :llstart String to start the last table line, defaults to :lstart.
4642 :lend String to end a table line
4643 :llend String to end the last table line, defaults to :lend.
4645 Each in the following group may be a string, a function of one
4646 argument (the field or line) returning a string, or a plist
4647 mapping columns to either of the above:
4649 :lfmt Format for entire line, with enough %s to capture all fields.
4650 If this is present, :lstart, :lend, and :sep are ignored.
4651 :llfmt Format for the entire last line, defaults to :lfmt.
4652 :fmt A format to be used to wrap the field, should contain
4653 %s for the original field value. For example, to wrap
4655 This may also be a property list with column numbers and
4657 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4658 Same as above, specific for the header lines in the table.
4659 All lines before the first hline are treated as header.
4660 If any of these is not present, the data line value is used.
4662 This may be either a string or a function of two arguments:
4664 :efmt Use this format to print numbers with exponentials.
4665 The format should have %s twice for inserting mantissa
4667 may also be a property list with column numbers and
4668 formats. :fmt will still be applied after :efmt.
4670 In addition to this, the parameters :skip and :skipcols are always handled
4671 directly by `orgtbl-send-table'. See manual."
4672 (let* ((splicep (plist-get params :splice))
4673 (hline (plist-get params :hline))
4674 (skipheadrule (plist-get params :skipheadrule))
4675 (remove-nil-linesp (plist-get params :remove-nil-lines))
4676 (remove-newlines (plist-get params :remove-newlines))
4677 (*orgtbl-hline* hline)
4678 (*orgtbl-table* table)
4679 (*orgtbl-sep* (plist-get params :sep))
4680 (*orgtbl-efmt* (plist-get params :efmt))
4681 (*orgtbl-lstart* (plist-get params :lstart))
4682 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4683 (*orgtbl-lend* (plist-get params :lend))
4684 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4685 (*orgtbl-lfmt* (plist-get params :lfmt))
4686 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4687 (*orgtbl-fmt* (plist-get params :fmt))
4688 *orgtbl-rtn*)
4689 ;; Convert cells content to backend BACKEND
4690 (when backend
4691 (setq *orgtbl-table*
4692 (mapcar
4693 (lambda(r)
4694 (if (listp r)
4695 (mapcar
4696 (lambda (c)
4697 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4698 r)
4699 r))
4700 *orgtbl-table*)))
4701 ;; Put header
4702 (unless splicep
4703 (when (plist-member params :tstart)
4704 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4705 (if tstart (push tstart *orgtbl-rtn*)))))
4706 ;; If we have a heading, format it and handle the trailing hline.
4707 (if (and (not splicep)
4708 (or (consp (car *orgtbl-table*))
4709 (consp (nth 1 *orgtbl-table*)))
4710 (memq 'hline (cdr *orgtbl-table*)))
4711 (progn
4712 (when (eq 'hline (car *orgtbl-table*))
4713 ;; There is a hline before the first data line
4714 (and hline (push hline *orgtbl-rtn*))
4715 (pop *orgtbl-table*))
4716 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4717 *orgtbl-lstart*))
4718 (*orgtbl-llstart* (or (plist-get params :hllstart)
4719 *orgtbl-llstart*))
4720 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4721 (*orgtbl-llend* (or (plist-get params :hllend)
4722 (plist-get params :hlend) *orgtbl-llend*))
4723 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4724 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4725 (plist-get params :hlfmt) *orgtbl-llfmt*))
4726 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4727 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4728 (orgtbl-format-section 'hline))
4729 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4730 (pop *orgtbl-table*)))
4731 ;; Now format the main section.
4732 (orgtbl-format-section nil)
4733 (unless splicep
4734 (when (plist-member params :tend)
4735 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4736 (if tend (push tend *orgtbl-rtn*)))))
4737 (mapconcat (if remove-newlines
4738 (lambda (tend)
4740 'identity)
4741 (nreverse (if remove-nil-linesp
4742 (remq nil *orgtbl-rtn*)
4745 ;;;###autoload
4746 (defun orgtbl-to-tsv (table params)
4747 "Convert the orgtbl-mode table to TAB separated material."
4749 ;;;###autoload
4750 (defun orgtbl-to-csv (table params)
4751 "Convert the orgtbl-mode table to CSV material.
4752 This does take care of the proper quoting of fields with comma or quotes."
4753 (orgtbl-to-generic table (org-combine-plists
4754 '(:sep "," :fmt org-quote-csv-field)
4755 params)))
4757 ;;;###autoload
4758 (defun orgtbl-to-latex (table params)
4759 "Convert the orgtbl-mode TABLE to LaTeX.
4760 TABLE is a list, each entry either the symbol `hline' for a horizontal
4761 separator line, or a list of fields for that line.
4762 PARAMS is a property list of parameters that can influence the conversion.
4763 Supports all parameters from `orgtbl-to-generic'. Most important for
4764 LaTeX are:
4766 :splice When set to t, return only table body lines, don't wrap
4767 them into a tabular environment. Default is nil.
4769 :fmt A format to be used to wrap the field, should contain %s for the
4770 original field value. For example, to wrap everything in dollars,
4773 The format may also be a function that formats its one argument.
4775 :efmt Format for transforming numbers with exponentials. The format
4776 should have %s twice for inserting mantissa and exponent, for
4778 This may also be a property list with column numbers and formats.
4779 The format may also be a function that formats its two arguments.
4781 :llend If you find too much space below the last line of a table,
4784 The general parameters :skip and :skipcols have already been applied when
4785 this function is called."
4786 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4787 org-table-last-alignment ""))
4788 (params2
4789 (list
4794 (require 'ox-latex)
4795 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4797 ;;;###autoload
4798 (defun orgtbl-to-html (table params)
4799 "Convert the orgtbl-mode TABLE to HTML.
4800 TABLE is a list, each entry either the symbol `hline' for a horizontal
4801 separator line, or a list of fields for that line.
4802 PARAMS is a property list of parameters that can influence the conversion.
4803 Currently this function recognizes the following parameters:
4805 :splice When set to t, return only table body lines, don't wrap
4806 them into a <table> environment. Default is nil.
4808 The general parameters :skip and :skipcols have already been applied when
4809 this function is called. The function does *not* use `orgtbl-to-generic',
4810 so you cannot specify parameters for it."
4811 (require 'ox-html)
4812 (let ((output (org-export-string-as
4813 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4814 (if (not (plist-get params :splice)) output
4815 (org-trim
4816 (replace-regexp-in-string
4820 ;;;###autoload
4821 (defun orgtbl-to-texinfo (table params)
4822 "Convert the orgtbl-mode TABLE to TeXInfo.
4823 TABLE is a list, each entry either the symbol `hline' for a horizontal
4824 separator line, or a list of fields for that line.
4825 PARAMS is a property list of parameters that can influence the conversion.
4826 Supports all parameters from `orgtbl-to-generic'. Most important for
4827 TeXInfo are:
4829 :splice nil/t When set to t, return only table body lines, don't wrap
4830 them into a multitable environment. Default is nil.
4832 :fmt fmt A format to be used to wrap the field, should contain
4833 %s for the original field value. For example, to wrap
4835 This may also be a property list with column numbers and
4837 Each format also may be a function that formats its one
4838 argument.
4841 are computed automatically from the width of the columns
4842 under org-mode.
4844 The general parameters :skip and :skipcols have already been applied when
4845 this function is called."
4846 (let* ((total (float (apply '+ org-table-last-column-widths)))
4847 (colfrac (or (plist-get params :cf)
4848 (mapconcat
4849 (lambda (x) (format "%.3f" (/ (float x) total)))
4850 org-table-last-column-widths " ")))
4851 (params2
4852 (list
4853 :tstart (concat "@multitable @columnfractions " colfrac)
4854 :tend "@end multitable"
4855 :lstart "@item " :lend "" :sep " @tab "
4856 :hlstart "@headitem ")))
4857 (require 'ox-texinfo)
4858 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4860 ;;;###autoload
4861 (defun orgtbl-to-orgtbl (table params)
4862 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4863 Useful when slicing one table into many. The :hline, :sep,
4864 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4865 and :tend suppress strings without splicing; they can be set to
4866 provide ORGTBL directives for the generated table."
4867 (let* ((params2
4868 (list
4869 :remove-newlines t
4870 :tstart nil :tend nil
4871 :hline "|---"
4872 :sep " | "
4873 :lstart "| "
4874 :lend " |"))
4875 (params (org-combine-plists params2 params)))
4876 (with-temp-buffer
4877 (insert (orgtbl-to-generic table params))
4878 (goto-char (point-min))
4879 (while (re-search-forward org-table-hline-regexp nil t)
4880 (org-table-align))
4881 (buffer-substring 1 (buffer-size)))))
4883 (defun orgtbl-to-table.el (table params)
4884 "Convert the orgtbl-mode TABLE into a table.el table."
4885 (with-temp-buffer
4886 (insert (orgtbl-to-orgtbl table params))
4887 (org-table-align)
4888 (replace-regexp-in-string
4889 "-|" "-+"
4890 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4892 (defun orgtbl-to-unicode (table params)
4893 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4894 You need the ascii-art-to-unicode.el package for this. You can download
4895 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4896 (with-temp-buffer
4897 (insert (orgtbl-to-table.el table params))
4898 (goto-char (point-min))
4899 (if (or (featurep 'ascii-art-to-unicode)
4900 (require 'ascii-art-to-unicode nil t))
4901 (aa2u)
4902 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4903 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4904 "Link to ascii-art-to-unicode.el") org-stored-links))
4905 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4906 (buffer-string)))
4908 (defun org-table-get-remote-range (name-or-id form)
4909 "Get a field value or a list of values in a range from table at ID.
4911 NAME-OR-ID may be the name of a table in the current file as set
4913 will then be used. Alternatively, it may be an ID referring to
4914 any entry, also in a different file. In this case, the first
4915 table in that entry will be referenced.
4919 The return value is either a single string for a single field, or a
4920 list of the fields in the rectangle."
4921 (save-match-data
4922 (let ((case-fold-search t) (id-loc nil)
4923 ;; Protect a bunch of variables from being overwritten
4924 ;; by the context of the remote table
4925 org-table-column-names org-table-column-name-regexp
4926 org-table-local-parameters org-table-named-field-locations
4927 org-table-current-line-types org-table-current-begin-line
4928 org-table-current-begin-pos org-table-dlines
4929 org-table-current-ncol
4930 org-table-hlines org-table-last-alignment
4931 org-table-last-column-widths org-table-last-alignment
4932 org-table-last-column-widths tbeg
4933 buffer loc)
4934 (setq form (org-table-convert-refs-to-rc form))
4935 (save-excursion
4936 (save-restriction
4937 (widen)
4938 (save-excursion
4939 (goto-char (point-min))
4940 (if (re-search-forward
4943 nil t)
4944 (setq buffer (current-buffer) loc (match-beginning 0))
4945 (setq id-loc (org-id-find name-or-id 'marker))
4946 (unless (and id-loc (markerp id-loc))
4948 (setq buffer (marker-buffer id-loc)
4949 loc (marker-position id-loc))
4950 (move-marker id-loc nil)))
4951 (with-current-buffer buffer
4952 (save-excursion
4953 (save-restriction
4954 (widen)
4955 (goto-char loc)
4956 (forward-char 1)
4958 (not (match-beginning 1)))
4959 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
4960 (setq tbeg (point-at-bol))
4961 (org-table-get-specials)
4962 (setq form (org-table-formula-substitute-names
4963 (org-table-formula-handle-first/last-rc form)))
4964 (if (and (string-match org-table-range-regexp form)
4965 (> (length (match-string 0 form)) 1))
4966 (save-match-data
4967 (org-table-get-range (match-string 0 form) tbeg 1))
4968 form)))))))))
4970 (defmacro org-define-lookup-function (mode)
4971 (let ((mode-str (symbol-name mode))
4972 (first-p (equal mode 'first))
4973 (all-p (equal mode 'all)))
4974 (let ((plural-str (if all-p "s" "")))
4975 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
4976 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
4977 If R-LIST is nil, return matching element%s of S-LIST.
4978 If PREDICATE is not nil, use it instead of `equal' to match VAL.
4979 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
4980 This function is generated by a call to the macro `org-define-lookup-function'."
4981 mode-str plural-str plural-str plural-str)
4982 (let ,(let ((lvars '((p (or predicate 'equal))
4983 (sl s-list)
4984 (rl (or r-list s-list))
4985 (ret nil))))
4986 (if first-p (add-to-list 'lvars '(match-p nil)))
4987 lvars)
4988 (while ,(if first-p '(and (not match-p) sl) 'sl)
4989 (progn
4990 (if (funcall p val (car sl))
4991 (progn
4992 ,(if first-p '(setq match-p t))
4993 (let ((rval (car rl)))
4994 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
4995 (setq sl (cdr sl) rl (cdr rl))))
4996 ret)))))
4998 (org-define-lookup-function first)
4999 (org-define-lookup-function last)
5000 (org-define-lookup-function all)
5002 (provide 'org-table)
5004 ;; Local variables:
5005 ;; generated-autoload-file: "org-loaddefs.el"
5006 ;; End:
5008 ;;; org-table.el ends here