| blob | c7e7eb867f8d5cbd461268e7f03b286eb9ff15af |
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."
1840 table)))
1847 ;;;###autoload
1849 "Wrap several fields in a column like a paragraph.
1850 This is useful if you'd like to spread the contents of a field over several
1851 lines, in order to keep the table compact.
1853 If there is an active region, and both point and mark are in the same column,
1854 the text in the column is wrapped to minimum width for the given number of
1855 lines. Generally, this makes the table more compact. A prefix ARG may be
1857 formats the selected text to two lines. If the region was longer than two
1858 lines, the remaining lines remain empty. A negative prefix argument reduces
1859 the current number of lines by that amount. The wrapped text is pasted back
1860 into the table. If you formatted it to more lines than it was before, fields
1861 further down in the table get overwritten - so you might need to make space in
1862 the table first.
1864 If there is no region, the current field is split at the cursor position and
1865 the text fragment to the right of the cursor is prepended to the field one
1866 line down.
1868 If there is no region, but you specify a prefix ARG, the current field gets
1869 blank, and the content is appended to the field above."
1873 ;; There is a region: fill as a paragraph
1877 nlines)
1884 arg)
1888 nil nlines)))
1892 ;; No region, split the current field at point
1896 ;; combine with field above
1906 ;; split field
1918 ;;;###autoload
1920 "Edit table field in a different window.
1921 This is mainly useful for fields that contain hidden parts.
1923 it can be edited in place."
1932 display t intangible t))
1945 p)
1961 intangible t))
1969 "Finish editing a table data field.
1970 Remove all newline characters, insert the result into the table, realign
1971 the table and kill the editing buffer."
1975 text)
1992 "Minor mode to make the table field editor window follow the cursor.
1993 When this mode is active, the field editor window will always show the
1994 current field. The mode exits automatically when the cursor leaves the
1995 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1996 nil " TblFollow" nil
2012 ;; We have left the table, exit the follow mode
2022 ;;;###autoload
2024 "Sum numbers in region of current table column.
2025 The result will be displayed in the echo area, and will be available
2028 If there is an active region, it is interpreted as a rectangle and all
2029 numbers in that rectangle will be summed. If there is no active
2030 region and point is located in a table column, sum all numbers in that
2031 column.
2033 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2034 numbers are assumed to be times as well (in decimal hours) and the
2035 numbers are added as such.
2037 If NLAST is a number, only the NLAST fields will actually be summed."
2064 items1)))
2071 s diff)
2079 sres))))
2102 "Return the formula active for the current field.
2103 Assumes that specials are in place.
2104 If KEY is given, return the key to this formula.
2108 org-table-named-field-locations)))
2122 "Read a formula from the minibuffer, offer stored formula as default.
2123 When NAMED is non-nil, look for a named equation."
2127 org-table-named-field-locations)))
2134 name
2135 ref)
2145 stored)
2147 equation)
2154 scol))
2156 'org-table-formula-history
2157 )))))
2158 mustsave)
2160 ;; remove formula
2167 ;; We set the column equation, delete the named one.
2169 mustsave t))
2175 eq))
2178 "Store the list of formulas below the current table."
2185 ;; don't overwrite TBLFM, we might use text properties to store stuff
2201 ;; Fake a high number to make sure this is sorted at the end.
2208 a)
2218 "Compare two formulas for sorting."
2223 ;;;###autoload
2225 "Return an alist with the stored formulas directly after current table."
2234 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2253 "Modify the equations after the table structure has been edited.
2255 For all numbers larger than LIMIT, shift them by DELTA."
2267 s n a)
2287 "Get the column names and local parameters for this table."
2290 names name fields fields1 field cnt
2291 c v l line col types dlines hlines last-dline)
2293 org-table-local-parameters nil
2294 org-table-named-field-locations nil
2295 org-table-current-begin-line nil
2296 org-table-current-begin-pos nil
2297 org-table-current-line-types nil
2316 org-table-local-parameters))))
2332 ;; Analyse the line types
2336 l org-table-current-begin-line)
2353 al al2)
2363 ;;;###autoload
2366 If yes, store the formula and apply it."
2367 ;; We already know we are in a table. Get field will only return a formula
2368 ;; when appropriate. It might return a separator line, but no problem.
2371 named eq)
2382 "List of commands triggering the recalculation of a line.
2394 ;;;###autoload
2396 "Rotate the recalculation mark in the first column.
2397 If in any row, the first field is not consistent with a mark,
2398 insert a new column for the markers.
2399 When there is an active region, change all the lines in the region,
2400 after prompting for the marking character.
2401 After each change, a message will be displayed indicating the meaning
2402 of the new mark."
2417 epos new)
2424 newchar))
2456 ;;;###autoload
2458 "Recompute the current line if marked for it, and if we haven't just done it."
2478 org-tbl-calc-modes)
2480 ;;;###autoload
2482 suppress-align suppress-const
2483 suppress-store suppress-analysis)
2484 "Replace the table field value at the cursor by the result of a calculation.
2486 This function makes use of Dave Gillespie's Calc package, in my view the
2487 most exciting program ever written for GNU Emacs. So you need to have Calc
2488 installed in order to use this function.
2490 In a table, this command replaces the value in the current field with the
2492 formula, by storing it in a special line below the table. When called
2493 with a `C-u' prefix, the current field must be a named field, and the
2494 formula is installed as valid in only this specific field.
2496 When called with two `C-u' prefixes, insert the active equation
2497 for the field back into the current field, so that it can be
2499 to check the referenced fields.
2501 When called, the command first prompts for a formula, which is read in
2502 the minibuffer. Previously entered formulas are available through the
2503 history list, and the last used formula is offered as a default.
2504 These stored formulas are adapted correctly when moving, inserting, or
2505 deleting columns with the corresponding commands.
2507 The formula can be any algebraic expression understood by the Calc package.
2508 For details, see the Org-mode manual.
2510 This function can also be called from Lisp programs and offers
2511 additional arguments: EQUATION can be the formula to apply. If this
2512 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2513 used to speed-up recursive calls by by-passing unnecessary aligns.
2514 SUPPRESS-CONST suppresses the interpretation of constants in the
2515 formula, assuming that this has been done already outside the function.
2516 SUPPRESS-STORE means the formula should not be stored, either because
2517 it is already stored, or because it is a modified equation that should
2518 not overwrite the stored one."
2534 equation
2540 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2541 duration duration-output-format)
2542 ;; Parse the format string. Since we have a lot of modes, this is
2543 ;; a lot of work. However, I think calc still uses most of the time.
2556 'calc-float-format
2559 n))))
2563 duration-output-format nil
2567 duration-output-format org-table-duration-custom-format
2568 numbers t
2591 ;; replace fields with duration values if relevant
2595 fields)))
2601 x))
2602 fields)))
2608 ;; Insert row and column number of formula result field
2619 t t form)))
2621 ;; Check for old vertical references
2623 ;; Insert remote references
2635 rmtrng))
2636 keep-empty numbers lispp))
2637 t t form)))
2638 ;; Insert complex ranges
2646 ;; possibly handle durations
2651 formrg)
2652 keep-empty numbers lispp)))
2657 ;; Insert simple ranges
2666 keep-empty numbers lispp))
2667 t t form)))
2669 ;; Insert the references to fields in same row
2679 x keep-empty numbers lispp))
2680 t t form)))
2692 ;; Use <...> time-stamps so that Calc can handle them
2694 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2705 form
2712 duration-output-format)
2713 ev)))
2718 Orig: %s
2719 $xyz-> %s
2720 @r$c-> %s
2752 prop value)))
2755 "Get a calc vector from a column, according to descriptor DESC.
2756 Optional arguments TBEG and COL can give the beginning of the table and
2757 the current column, to avoid unnecessary parsing.
2759 HIGHLIGHT means just highlight the range.
2761 When CORNERS-ONLY is set, only return the corners of the range as
2762 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2763 in the buffer and column1 and column2 are table column numbers."
2770 beg end c1 c2 r1 r2 rangep tmp)
2787 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2794 ;; just one field
2801 ;; A range, return a vector
2802 ;; First sort the numbers to get a regular rectangle
2806 ;; Only return the corners of the range
2808 ;; Copy the range values into a list
2822 ;; return string representation of calc vector
2827 "Analyze descriptor DESC and retrieve the corresponding line number.
2828 The cursor is currently in line CLINE, the table begins in line BLINE,
2829 and TABLE is a vector with line types."
2837 ;; 1 2 3 4 5 6
2857 nil hn cline desc)))
2860 rel on cline desc)))
2864 "FIXME: Needs more documentation."
2877 nil))
2878 t)))
2882 desc cline)
2883 i)))
2888 s))
2891 "Convert list ELEMENTS to something appropriate to insert into formula.
2892 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2893 NUMBERS indicates that everything should be converted to numbers.
2894 LISPP non-nil means to return something appropriate for a Lisp
2895 list, 'literal is for the format specifier L."
2896 ;; Calc nan (not a number) is used for the conversion of the empty
2897 ;; field to a reference for several reasons: (i) It is accepted in a
2898 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2899 ;; (ii) In a single field (not in range) it can be distinguished
2900 ;; from "(nan)" which is the reference made from a single field
2901 ;; containing "nan".
2903 ;; field reference
2906 elements
2908 ""
2917 ;; range reference
2922 elements))))
2928 x
2936 x)
2938 elements
2941 ;;;###autoload
2943 "Set `org-table-formula-constants-local' in the current buffer."
2959 ;;;###autoload
2961 "Recalculate the current table line by applying all stored formulas.
2962 With prefix arg ALL, do this for all lines in the table.
2963 With the prefix argument ALL is `(16)' \
2965 it is the symbol `iterate', recompute the table until it no longer changes.
2966 If NOALIGN is not nil, do not re-align the table after the computations
2967 are done. This is typically used internally to save time, if it is
2968 known that the table will be realigned a little later anyway."
2983 seen-fields lhs1
2985 ;; Insert constants in all formulas
3001 eqlist))
3002 ;; Split the equation list
3008 ;; Expand ranges in lhs of formulas
3011 ;; Get the correct line range to process
3017 ;; This is a table with marked lines, compute selected lines
3019 ;; Move forward to the first non-header line
3030 ;; First find the named fields, and mark them untouchable.
3031 ;; Also check if several field/range formulas try to set the same field.
3050 name)))
3060 ;; Now evaluate the column formulas, but skip fields covered by
3061 ;; field formulas
3065 ;; Unprotected line, recalculate
3077 ;; Now evaluate the field formulas
3091 ;; back to initial position
3098 ;;;###autoload
3100 "Recalculate the table until it does not change anymore.
3101 The maximum number of iterations is 10, but you can choose a different value
3102 with the prefix ARG."
3107 thistbl)
3121 ;;;###autoload
3123 "Recalculate all tables in the current buffer."
3130 ;;;###autoload
3132 "Iterate all tables in the buffer, to converge inter-table dependencies."
3137 c1)
3153 "Apply the #+TBLFM in the line at point to the table."
3159 s e)
3161 ;; Insert a temporary formula at right after the table
3166 ;; Recalculate the table
3172 ;; delete the formula inserted temporarily
3176 "Find the beginning of the TBLFM lines and return its position.
3177 Return nil when the beginning of TBLFM line was not found."
3181 org-table-TBLFM-begin-regexp
3182 nil t))
3186 "Expand list of formulas.
3187 If some of the RHS in the formulas are ranges or a row reference, expand
3188 them to individual field equations for each field."
3194 ;; This just refers to one fixed field
3197 ;; This just refers to one fixed named field
3219 "Replace @<, @>, $<, $> with first/last row/column of the table.
3220 So @< and $< will always be replaced with @1 and $1, respectively.
3221 The advantage of these special markers are that structure editing of
3222 the table will not change them, while @1 and $1 will be modified
3223 when a line/row is swapped out of that privileged position. So for
3224 formulas that use a range of rows or columns, it may often be better
3226 borders of the table using the @< @> $< $> makers."
3229 s start)
3234 org-table-current-ncol)
3238 len
3245 s)
3248 "Replace $const with values in string F."
3250 ;; First, check for column names
3255 ;; Parameters and constants
3257 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3267 f))
3270 "Find the value for a parameter or constant in a formula.
3271 Parameters get priority."
3302 map))
3309 "--"
3312 "--"
3313 "Shift Reference at Point"
3318 "-"
3319 "Change Test Row for Column Formulas"
3322 "--"
3327 org-table-overlay-coordinates)]
3328 "--"
3334 ;;;###autoload
3336 "Edit the formulas of the current table in a separate buffer."
3338 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3352 entry s type title)
3355 ;; Keep global-font-lock-mode from turning on font-lock-mode
3396 "Convert a formula from internal to user representation."
3399 s))
3402 "Convert a formula from user to internal representation."
3405 s))
3408 "Convert spreadsheet references from A7 to @7$28.
3409 Works for single references, but also for entire formulas and even the
3410 full TBLFM line."
3412 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3415 ;; format match, just advance
3420 ;; 3.e5 or something like this.
3423 ;; (member (match-string 1 s)
3424 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3425 )
3426 ;; function name, just advance
3436 t t s)))))
3437 s))
3440 "Convert spreadsheet references from to @7$28 to AB7.
3441 Works for single references, but also for entire formulas and even the
3442 full TBLFM line."
3449 t t s)))
3454 t nil s)))
3455 s)
3458 "Convert a base 26 number represented by letters into an integer.
3459 For example: AB -> 28."
3465 n))
3468 "Convert an integer into a base 26 number represented by letters.
3469 For example: 28 -> AB."
3474 s))
3477 "Convert a time string into numerical duration in seconds.
3478 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3479 If S is a string representing a number, keep this number."
3481 s
3504 "Convert a number of seconds to a time string.
3505 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3506 minutes or seconds."
3521 "Convert all references in this buffer, using FUNCTION."
3531 "Convert all references in the buffer from B3 to @3$2 and back."
3541 "Shift the reference at point one row/hline up."
3545 "Shift the reference at point one row/hline down."
3549 "Shift the reference at point one field to the left."
3553 "Shift the reference at point one field to the right."
3564 ;; A B3-like reference
3570 ;; An internal reference
3576 "Re-match the group N, and replace it with the shifted reference."
3581 t t)))
3584 "Shift a reference part REF.
3585 If DECR is set, decrease the references row/column, else increase.
3586 If HLINE is set, this may be a hline reference, it certainly is not
3587 a translation reference."
3616 "Toggle the display of coordinates in the referenced table."
3625 "Parse the buffer for formula definitions and install them.
3626 With prefix ARG, apply the new formulas to the table."
3636 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3637 nil t)
3661 "Abort editing formulas, without installing the changes."
3672 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3713 "Show the location/value of the $ expression at point."
3722 var name e what match dest)
3727 "$1.."
3810 ;; column number
3838 org-table-fedit-scroll-down))))
3849 "Make sure the cursor is in a dataline in a table."
3858 p1 p2)))
3863 "Move cursor one line up in the window showing the table."
3868 "Move cursor one line down in the window showing the table."
3873 "Move the cursor in the window showing the table.
3874 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3899 "Add a new overlay."
3905 "Highlight rectangular region in a table."
3909 l1 c1 l2 c2 tmp)
3933 "Remove the rectangle overlays."
3944 "Add overlays to the table at point, to show row/column coordinates."
3972 ;;;###autoload
3974 "Toggle the display of Row/Column numbers in tables."
3985 ;;;###autoload
3987 "Toggle the formula debugger in tables."
3993 ;;; The orgtbl minor mode
3995 ;; Define a minor mode which can be used in other modes in order to
3996 ;; integrate the org-mode table editor.
3998 ;; This is really a hack, because the org-mode table editor uses several
3999 ;; keys which normally belong to the major mode, for example the TAB and
4000 ;; RET keys. Here is how it works: The minor mode defines all the keys
4001 ;; necessary to operate the table editor, but wraps the commands into a
4002 ;; function which tests if the cursor is currently inside a table. If that
4003 ;; is the case, the table editor command is executed. However, when any of
4004 ;; those keys is used outside a table, the function uses `key-binding' to
4005 ;; look up if the key has an associated command in another currently active
4006 ;; keymap (minor modes, major mode, global), and executes that command.
4007 ;; There might be problems if any of the keys used by the table editor is
4008 ;; otherwise used as a prefix key.
4010 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4011 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4012 ;; addresses this by checking explicitly for both bindings.
4014 ;; The optimized version (see variable `orgtbl-optimized') takes over
4015 ;; all keys which are bound to `self-insert-command' in the *global map*.
4016 ;; Some modes bind other commands to simple characters, for example
4017 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4018 ;; active, this binding is ignored inside tables and replaced with a
4019 ;; modified self-insert.
4037 ;; Install it as a minor mode.
4041 ;;;###autoload
4043 "The `org-mode' table editor as a minor mode for use in other modes."
4048 ;; Exit without error, in case some hook functions calls this
4049 ;; by accident in org-mode.
4053 ;; Make sure we are first in minor-mode-map-alist
4055 ;; FIXME: maybe it should use emulation-mode-map-alists?
4062 auto-fill-inhibit-regexp)
4066 auto-fill-inhibit-regexp)
4067 orgtbl-line-start-regexp))
4085 "Remove all properties related to narrow-column invisibility."
4098 "Create a function for binding in the table minor mode.
4099 FUN is the command to call inside a table. N is used to create a unique
4100 command name. KEYS are keys that should be checked in for a command
4101 to execute outside of tables."
4107 "Outside of tables, run the binding of `"
4119 keys)
4123 "Error when there is no default binding for a table key."
4128 "Setup orgtbl keymaps."
4159 elt key fun cmd)
4167 ;; Special treatment needed for TAB and RET
4187 [(tab)] "\C-i")))
4189 (org-defkey orgtbl-mode-map [backtab]
4191 [backtab] [S-iso-lefttab] [(shift tab)]
4192 [(tab)] "\C-i"))
4194 (org-defkey orgtbl-mode-map "\M-\C-m"
4195 (orgtbl-make-binding 'org-table-wrap-region 105
4196 "\M-\C-m" [(meta return)]))
4197 (org-defkey orgtbl-mode-map [(meta return)]
4198 (orgtbl-make-binding 'org-table-wrap-region 106
4199 [(meta return)] "\M-\C-m"))
4201 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4202 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4204 (when orgtbl-optimized
4205 ;; If the user wants maximum table support, we need to hijack
4206 ;; some standard editing functions
4207 (org-remap orgtbl-mode-map
4208 'self-insert-command 'orgtbl-self-insert-command
4209 'delete-char 'org-delete-char
4210 'delete-backward-char 'org-delete-backward-char)
4211 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4212 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4213 '("OrgTbl"
4214 ["Create or convert" org-table-create-or-convert-from-region
4215 :active (not (org-at-table-p)) :keys "C-c |" ]
4216 "--"
4217 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4218 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4219 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4220 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4221 "--"
4222 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4223 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4224 ["Copy Field from Above"
4225 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4226 "--"
4227 ("Column"
4228 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4229 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4230 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4231 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4232 ("Row"
4233 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4234 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4235 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4236 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4237 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4238 "--"
4239 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4240 ("Rectangle"
4241 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4242 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4243 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4244 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4245 "--"
4246 ("Radio tables"
4247 ["Insert table template" orgtbl-insert-radio-table
4248 (assq major-mode orgtbl-radio-table-templates)]
4249 ["Comment/uncomment table" orgtbl-toggle-comment t])
4250 "--"
4251 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4252 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4253 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4254 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4255 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4256 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4257 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4258 ["Sum Column/Rectangle" org-table-sum
4259 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4260 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4261 ["Debug Formulas"
4262 org-table-toggle-formula-debugger :active (org-at-table-p)
4263 :keys "C-c {"
4264 :style toggle :selected org-table-formula-debug]
4265 ["Show Col/Row Numbers"
4266 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4267 :keys "C-c }"
4268 :style toggle :selected org-table-overlay-coordinates]
4269 ))
4270 t))
4272 (defun orgtbl-ctrl-c-ctrl-c (arg)
4273 "If the cursor is inside a table, realign the table.
4274 If it is a table to be sent away to a receiver, do it.
4275 With prefix arg, also recompute table."
4276 (interactive "P")
4277 (let ((case-fold-search t) (pos (point)) action)
4278 (save-excursion
4279 (beginning-of-line 1)
4280 (setq action (cond
4284 (cond
4285 ((integerp action)
4286 (goto-char action)
4287 (org-table-maybe-eval-formula)
4288 (if arg
4289 (call-interactively 'org-table-recalculate)
4290 (org-table-maybe-recalculate-line))
4291 (call-interactively 'org-table-align)
4292 (when (orgtbl-send-table 'maybe)
4293 (run-hooks 'orgtbl-after-send-table-hook)))
4294 ((eq action 'recalc)
4295 (org-table-set-constants)
4296 (save-excursion
4297 (beginning-of-line 1)
4299 (if (org-at-table-p)
4300 (org-call-with-arg 'org-table-recalculate t))))
4301 (t (let (orgtbl-mode)
4302 (call-interactively (key-binding "\C-c\C-c")))))))
4304 (defun orgtbl-create-or-convert-from-region (arg)
4305 "Create table or convert region to table, if no conflicting binding.
4306 This installs the table binding `C-c |', but only if there is no
4307 conflicting binding to this key outside orgtbl-mode."
4308 (interactive "P")
4309 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4310 (if cmd
4311 (call-interactively cmd)
4312 (call-interactively 'org-table-create-or-convert-from-region))))
4314 (defun orgtbl-tab (arg)
4315 "Justification and field motion for `orgtbl-mode'."
4316 (interactive "P")
4317 (if arg (org-table-edit-field t)
4318 (org-table-justify-field-maybe)
4319 (org-table-next-field)))
4321 (defun orgtbl-ret ()
4322 "Justification and field motion for `orgtbl-mode'."
4323 (interactive)
4324 (if (bobp)
4325 (newline)
4326 (org-table-justify-field-maybe)
4327 (org-table-next-row)))
4329 (defun orgtbl-self-insert-command (N)
4330 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4331 If the cursor is in a table looking at whitespace, the whitespace is
4332 overwritten, and the table is not marked as requiring realignment."
4333 (interactive "p")
4334 (if (and (org-at-table-p)
4335 (or
4336 (and org-table-auto-blank-field
4337 (member last-command
4338 '(orgtbl-hijacker-command-100
4339 orgtbl-hijacker-command-101
4340 orgtbl-hijacker-command-102
4341 orgtbl-hijacker-command-103
4342 orgtbl-hijacker-command-104
4343 orgtbl-hijacker-command-105
4344 yas/expand))
4345 (org-table-blank-field))
4346 t)
4347 (eq N 1)
4349 (let (org-table-may-need-update)
4350 (goto-char (1- (match-end 0)))
4351 (org-delete-backward-char 1)
4352 (goto-char (match-beginning 0))
4353 (self-insert-command N))
4354 (setq org-table-may-need-update t)
4355 (let* (orgtbl-mode
4356 a
4357 (cmd (or (key-binding
4358 (or (and (listp function-key-map)
4359 (setq a (assoc last-input-event function-key-map))
4360 (cdr a))
4361 (vector last-input-event)))
4362 'self-insert-command)))
4363 (call-interactively cmd)
4364 (if (and org-self-insert-cluster-for-undo
4365 (eq cmd 'self-insert-command))
4366 (if (not (eq last-command 'orgtbl-self-insert-command))
4367 (setq org-self-insert-command-undo-counter 1)
4368 (if (>= org-self-insert-command-undo-counter 20)
4369 (setq org-self-insert-command-undo-counter 1)
4370 (and (> org-self-insert-command-undo-counter 0)
4371 buffer-undo-list
4372 (not (cadr buffer-undo-list)) ; remove nil entry
4373 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4374 (setq org-self-insert-command-undo-counter
4375 (1+ org-self-insert-command-undo-counter))))))))
4378 "Regular expression matching exponentials as produced by calc.")
4380 (defun orgtbl-gather-send-defs ()
4381 "Gather a plist of :name, :transform, :params for each destination before
4382 a radio table."
4383 (save-excursion
4384 (goto-char (org-table-begin))
4385 (let (rtn)
4386 (beginning-of-line 0)
4387 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4388 (let ((name (org-no-properties (match-string 1)))
4389 (transform (intern (match-string 2)))
4390 (params (if (match-end 3)
4391 (read (concat "(" (match-string 3) ")")))))
4392 (push (list :name name :transform transform :params params)
4393 rtn)
4394 (beginning-of-line 0)))
4395 rtn)))
4397 (defun orgtbl-send-replace-tbl (name txt)
4398 "Find and replace table NAME with TXT."
4399 (save-excursion
4400 (goto-char (point-min))
4401 (unless (re-search-forward
4403 (user-error "Don't know where to insert translated table"))
4404 (goto-char (match-beginning 0))
4405 (beginning-of-line 2)
4406 (save-excursion
4407 (let ((beg (point)))
4408 (unless (re-search-forward
4409 (concat "END RECEIVE ORGTBL +" name) nil t)
4410 (user-error "Cannot find end of insertion region"))
4411 (beginning-of-line 1)
4412 (delete-region beg (point))))
4415 ;;;###autoload
4416 (defun org-table-to-lisp (&optional txt)
4417 "Convert the table at point to a Lisp structure.
4418 The structure will be a list. Each item is either the symbol `hline'
4419 for a horizontal separator line, or a list of field values as strings.
4420 The table is taken from the parameter TXT, or from the buffer at point."
4421 (unless txt
4422 (unless (org-at-table-p)
4423 (user-error "No table at point")))
4424 (let* ((txt (or txt
4425 (buffer-substring-no-properties (org-table-begin)
4426 (org-table-end))))
4429 (mapcar
4430 (lambda (x)
4431 (if (string-match org-table-hline-regexp x)
4432 'hline
4434 lines)))
4436 (defun orgtbl-send-table (&optional maybe)
4437 "Send a transformed version of this table to the receiver position.
4438 With argument MAYBE, fail quietly if no transformation is defined for
4439 this table."
4440 (interactive)
4441 (catch 'exit
4442 (unless (org-at-table-p) (user-error "Not at a table"))
4443 ;; when non-interactive, we assume align has just happened.
4444 (when (org-called-interactively-p 'any) (org-table-align))
4445 (let ((dests (orgtbl-gather-send-defs))
4446 (txt (buffer-substring-no-properties (org-table-begin)
4447 (org-table-end)))
4448 (ntbl 0))
4449 (unless dests (if maybe (throw 'exit nil)
4450 (user-error "Don't know how to transform this table")))
4451 (dolist (dest dests)
4452 (let* ((name (plist-get dest :name))
4453 (transform (plist-get dest :transform))
4454 (params (plist-get dest :params))
4455 (skip (plist-get params :skip))
4456 (skipcols (plist-get params :skipcols))
4457 (no-escape (plist-get params :no-escape))
4458 beg
4459 (lines (org-table-clean-before-export
4460 (nthcdr (or skip 0)
4462 (i0 (if org-table-clean-did-remove-column 2 1))
4463 (lines (if no-escape lines
4464 (mapcar (lambda(l) (replace-regexp-in-string
4466 (table (mapcar
4467 (lambda (x)
4468 (if (string-match org-table-hline-regexp x)
4469 'hline
4470 (org-remove-by-index
4472 skipcols i0)))
4473 lines))
4474 (fun (if (= i0 2) 'cdr 'identity))
4475 (org-table-last-alignment
4476 (org-remove-by-index (funcall fun org-table-last-alignment)
4477 skipcols i0))
4478 (org-table-last-column-widths
4479 (org-remove-by-index (funcall fun org-table-last-column-widths)
4480 skipcols i0))
4481 (txt (if (fboundp transform)
4482 (funcall transform table params)
4483 (user-error "No such transformation function %s" transform))))
4484 (orgtbl-send-replace-tbl name txt))
4485 (setq ntbl (1+ ntbl)))
4486 (message "Table converted and installed at %d receiver location%s"
4487 ntbl (if (> ntbl 1) "s" ""))
4488 (if (> ntbl 0)
4489 ntbl
4490 nil))))
4492 (defun org-remove-by-index (list indices &optional i0)
4493 "Remove the elements in LIST with indices in INDICES.
4494 First element has index 0, or I0 if given."
4495 (if (not indices)
4496 list
4497 (if (integerp indices) (setq indices (list indices)))
4498 (setq i0 (1- (or i0 0)))
4499 (delq :rm (mapcar (lambda (x)
4500 (setq i0 (1+ i0))
4501 (if (memq i0 indices) :rm x))
4502 list))))
4504 (defun orgtbl-toggle-comment ()
4505 "Comment or uncomment the orgtbl at point."
4506 (interactive)
4507 (let* ((case-fold-search t)
4508 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4509 (re2 (concat "^" orgtbl-line-start-regexp))
4510 (commented (save-excursion (beginning-of-line 1)
4511 (cond ((looking-at re1) t)
4512 ((looking-at re2) nil)
4513 (t (user-error "Not at an org table")))))
4514 (re (if commented re1 re2))
4515 beg end)
4516 (save-excursion
4517 (beginning-of-line 1)
4518 (while (looking-at re) (beginning-of-line 0))
4519 (beginning-of-line 2)
4520 (setq beg (point))
4521 (while (looking-at re) (beginning-of-line 2))
4522 (setq end (point)))
4523 (comment-region beg end (if commented '(4) nil))))
4525 (defun orgtbl-insert-radio-table ()
4526 "Insert a radio table template appropriate for this major mode."
4527 (interactive)
4528 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4529 (txt (nth 1 e))
4530 name pos)
4531 (unless e (user-error "No radio table setup defined for %s" major-mode))
4532 (setq name (read-string "Table name: "))
4533 (while (string-match "%n" txt)
4534 (setq txt (replace-match name t t txt)))
4536 (setq pos (point))
4537 (insert txt)
4538 (goto-char pos)))
4540 ;; Dynamically bound input and output for table formatting.
4541 (defvar *orgtbl-table* nil
4542 "Carries the current table through formatting routines.")
4543 (defvar *orgtbl-rtn* nil
4544 "Formatting routines push the output lines here.")
4545 ;; Formatting parameters for the current table section.
4546 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4547 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4548 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4549 (defvar *orgtbl-fmt* nil "Format for each entry.")
4550 (defvar *orgtbl-efmt* nil "Format for numbers.")
4551 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4552 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4553 (defvar *orgtbl-lstart* nil "Text starting a row.")
4554 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4555 (defvar *orgtbl-lend* nil "Text ending a row.")
4556 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4558 (defsubst orgtbl-get-fmt (fmt i)
4559 "Retrieve the format from FMT corresponding to the Ith column."
4560 (if (and (not (functionp fmt)) (consp fmt))
4561 (plist-get fmt i)
4562 fmt))
4564 (defsubst orgtbl-apply-fmt (fmt &rest args)
4565 "Apply format FMT to arguments ARGS.
4566 When FMT is nil, return the first argument from ARGS."
4567 (cond ((functionp fmt) (apply fmt args))
4568 (fmt (apply 'format fmt args))
4569 (args (car args))
4570 (t args)))
4572 (defsubst orgtbl-eval-str (str)
4573 "If STR is a function, evaluate it with no arguments."
4574 (if (functionp str)
4575 (funcall str)
4576 str))
4578 (defun orgtbl-format-line (line)
4579 "Format LINE as a table row."
4580 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4581 (let* ((i 0)
4582 (line
4583 (mapcar
4584 (lambda (f)
4585 (setq i (1+ i))
4586 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4587 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4588 (orgtbl-apply-fmt efmt (match-string 1 f)
4589 (match-string 2 f))
4590 f)))
4591 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4592 *orgtbl-default-fmt*)
4593 f)))
4594 line)))
4595 (push (if *orgtbl-lfmt*
4596 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4597 (concat (orgtbl-eval-str *orgtbl-lstart*)
4598 (mapconcat 'identity line *orgtbl-sep*)
4599 (orgtbl-eval-str *orgtbl-lend*)))
4600 *orgtbl-rtn*))))
4602 (defun orgtbl-format-section (section-stopper)
4603 "Format lines until the first occurrence of SECTION-STOPPER."
4604 (let (prevline)
4605 (progn
4606 (while (not (eq (car *orgtbl-table*) section-stopper))
4607 (if prevline (orgtbl-format-line prevline))
4608 (setq prevline (pop *orgtbl-table*)))
4609 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4610 (*orgtbl-lend* *orgtbl-llend*)
4611 (*orgtbl-lfmt* *orgtbl-llfmt*))
4612 (orgtbl-format-line prevline))))))
4614 ;;;###autoload
4615 (defun orgtbl-to-generic (table params &optional backend)
4616 "Convert the orgtbl-mode TABLE to some other format.
4617 This generic routine can be used for many standard cases.
4618 TABLE is a list, each entry either the symbol `hline' for a horizontal
4619 separator line, or a list of fields for that line.
4620 PARAMS is a property list of parameters that can influence the conversion.
4621 A third optional argument BACKEND can be used to convert the content of
4622 the cells using a specific export back-end.
4624 For the generic converter, some parameters are obligatory: you need to
4625 specify either :lfmt, or all of (:lstart :lend :sep).
4627 Valid parameters are:
4629 :splice When set to t, return only table body lines, don't wrap
4630 them into :tstart and :tend. Default is nil. When :splice
4631 is non-nil, this also means that the exporter should not look
4632 for and interpret header and footer sections.
4634 :hline String to be inserted on horizontal separation lines.
4635 May be nil to ignore hlines.
4637 :sep Separator between two fields
4638 :remove-nil-lines Do not include lines that evaluate to nil.
4640 Each in the following group may be either a string or a function
4641 of no arguments returning a string:
4643 :tstart String to start the table. Ignored when :splice is t.
4644 :tend String to end the table. Ignored when :splice is t.
4645 :lstart String to start a new table line.
4646 :llstart String to start the last table line, defaults to :lstart.
4647 :lend String to end a table line
4648 :llend String to end the last table line, defaults to :lend.
4650 Each in the following group may be a string, a function of one
4651 argument (the field or line) returning a string, or a plist
4652 mapping columns to either of the above:
4654 :lfmt Format for entire line, with enough %s to capture all fields.
4655 If this is present, :lstart, :lend, and :sep are ignored.
4656 :llfmt Format for the entire last line, defaults to :lfmt.
4657 :fmt A format to be used to wrap the field, should contain
4658 %s for the original field value. For example, to wrap
4660 This may also be a property list with column numbers and
4662 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4663 Same as above, specific for the header lines in the table.
4664 All lines before the first hline are treated as header.
4665 If any of these is not present, the data line value is used.
4667 This may be either a string or a function of two arguments:
4669 :efmt Use this format to print numbers with exponentials.
4670 The format should have %s twice for inserting mantissa
4672 may also be a property list with column numbers and
4673 formats. :fmt will still be applied after :efmt.
4675 In addition to this, the parameters :skip and :skipcols are always handled
4676 directly by `orgtbl-send-table'. See manual."
4677 (let* ((splicep (plist-get params :splice))
4678 (hline (plist-get params :hline))
4679 (skipheadrule (plist-get params :skipheadrule))
4680 (remove-nil-linesp (plist-get params :remove-nil-lines))
4681 (remove-newlines (plist-get params :remove-newlines))
4682 (*orgtbl-hline* hline)
4683 (*orgtbl-table* table)
4684 (*orgtbl-sep* (plist-get params :sep))
4685 (*orgtbl-efmt* (plist-get params :efmt))
4686 (*orgtbl-lstart* (plist-get params :lstart))
4687 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4688 (*orgtbl-lend* (plist-get params :lend))
4689 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4690 (*orgtbl-lfmt* (plist-get params :lfmt))
4691 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4692 (*orgtbl-fmt* (plist-get params :fmt))
4693 *orgtbl-rtn*)
4694 ;; Convert cells content to backend BACKEND
4695 (when backend
4696 (setq *orgtbl-table*
4697 (mapcar
4698 (lambda(r)
4699 (if (listp r)
4700 (mapcar
4701 (lambda (c)
4702 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4703 r)
4704 r))
4705 *orgtbl-table*)))
4706 ;; Put header
4707 (unless splicep
4708 (when (plist-member params :tstart)
4709 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4710 (if tstart (push tstart *orgtbl-rtn*)))))
4711 ;; If we have a heading, format it and handle the trailing hline.
4712 (if (and (not splicep)
4713 (or (consp (car *orgtbl-table*))
4714 (consp (nth 1 *orgtbl-table*)))
4715 (memq 'hline (cdr *orgtbl-table*)))
4716 (progn
4717 (when (eq 'hline (car *orgtbl-table*))
4718 ;; There is a hline before the first data line
4719 (and hline (push hline *orgtbl-rtn*))
4720 (pop *orgtbl-table*))
4721 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4722 *orgtbl-lstart*))
4723 (*orgtbl-llstart* (or (plist-get params :hllstart)
4724 *orgtbl-llstart*))
4725 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4726 (*orgtbl-llend* (or (plist-get params :hllend)
4727 (plist-get params :hlend) *orgtbl-llend*))
4728 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4729 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4730 (plist-get params :hlfmt) *orgtbl-llfmt*))
4731 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4732 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4733 (orgtbl-format-section 'hline))
4734 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4735 (pop *orgtbl-table*)))
4736 ;; Now format the main section.
4737 (orgtbl-format-section nil)
4738 (unless splicep
4739 (when (plist-member params :tend)
4740 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4741 (if tend (push tend *orgtbl-rtn*)))))
4742 (mapconcat (if remove-newlines
4743 (lambda (tend)
4745 'identity)
4746 (nreverse (if remove-nil-linesp
4747 (remq nil *orgtbl-rtn*)
4750 ;;;###autoload
4751 (defun orgtbl-to-tsv (table params)
4752 "Convert the orgtbl-mode table to TAB separated material."
4754 ;;;###autoload
4755 (defun orgtbl-to-csv (table params)
4756 "Convert the orgtbl-mode table to CSV material.
4757 This does take care of the proper quoting of fields with comma or quotes."
4758 (orgtbl-to-generic table (org-combine-plists
4759 '(:sep "," :fmt org-quote-csv-field)
4760 params)))
4762 ;;;###autoload
4763 (defun orgtbl-to-latex (table params)
4764 "Convert the orgtbl-mode TABLE to LaTeX.
4765 TABLE is a list, each entry either the symbol `hline' for a horizontal
4766 separator line, or a list of fields for that line.
4767 PARAMS is a property list of parameters that can influence the conversion.
4768 Supports all parameters from `orgtbl-to-generic'. Most important for
4769 LaTeX are:
4771 :splice When set to t, return only table body lines, don't wrap
4772 them into a tabular environment. Default is nil.
4774 :fmt A format to be used to wrap the field, should contain %s for the
4775 original field value. For example, to wrap everything in dollars,
4778 The format may also be a function that formats its one argument.
4780 :efmt Format for transforming numbers with exponentials. The format
4781 should have %s twice for inserting mantissa and exponent, for
4783 This may also be a property list with column numbers and formats.
4784 The format may also be a function that formats its two arguments.
4786 :llend If you find too much space below the last line of a table,
4789 The general parameters :skip and :skipcols have already been applied when
4790 this function is called."
4791 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4792 org-table-last-alignment ""))
4793 (params2
4794 (list
4799 (require 'ox-latex)
4800 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4802 ;;;###autoload
4803 (defun orgtbl-to-html (table params)
4804 "Convert the orgtbl-mode TABLE to HTML.
4805 TABLE is a list, each entry either the symbol `hline' for a horizontal
4806 separator line, or a list of fields for that line.
4807 PARAMS is a property list of parameters that can influence the conversion.
4808 Currently this function recognizes the following parameters:
4810 :splice When set to t, return only table body lines, don't wrap
4811 them into a <table> environment. Default is nil.
4813 The general parameters :skip and :skipcols have already been applied when
4814 this function is called. The function does *not* use `orgtbl-to-generic',
4815 so you cannot specify parameters for it."
4816 (require 'ox-html)
4817 (let ((output (org-export-string-as
4818 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4819 (if (not (plist-get params :splice)) output
4820 (org-trim
4821 (replace-regexp-in-string
4825 ;;;###autoload
4826 (defun orgtbl-to-texinfo (table params)
4827 "Convert the orgtbl-mode TABLE to TeXInfo.
4828 TABLE is a list, each entry either the symbol `hline' for a horizontal
4829 separator line, or a list of fields for that line.
4830 PARAMS is a property list of parameters that can influence the conversion.
4831 Supports all parameters from `orgtbl-to-generic'. Most important for
4832 TeXInfo are:
4834 :splice nil/t When set to t, return only table body lines, don't wrap
4835 them into a multitable environment. Default is nil.
4837 :fmt fmt A format to be used to wrap the field, should contain
4838 %s for the original field value. For example, to wrap
4840 This may also be a property list with column numbers and
4842 Each format also may be a function that formats its one
4843 argument.
4846 are computed automatically from the width of the columns
4847 under org-mode.
4849 The general parameters :skip and :skipcols have already been applied when
4850 this function is called."
4851 (let* ((total (float (apply '+ org-table-last-column-widths)))
4852 (colfrac (or (plist-get params :cf)
4853 (mapconcat
4854 (lambda (x) (format "%.3f" (/ (float x) total)))
4855 org-table-last-column-widths " ")))
4856 (params2
4857 (list
4858 :tstart (concat "@multitable @columnfractions " colfrac)
4859 :tend "@end multitable"
4860 :lstart "@item " :lend "" :sep " @tab "
4861 :hlstart "@headitem ")))
4862 (require 'ox-texinfo)
4863 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4865 ;;;###autoload
4866 (defun orgtbl-to-orgtbl (table params)
4867 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4868 Useful when slicing one table into many. The :hline, :sep,
4869 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4870 and :tend suppress strings without splicing; they can be set to
4871 provide ORGTBL directives for the generated table."
4872 (let* ((params2
4873 (list
4874 :remove-newlines t
4875 :tstart nil :tend nil
4876 :hline "|---"
4877 :sep " | "
4878 :lstart "| "
4879 :lend " |"))
4880 (params (org-combine-plists params2 params)))
4881 (with-temp-buffer
4882 (insert (orgtbl-to-generic table params))
4883 (goto-char (point-min))
4884 (while (re-search-forward org-table-hline-regexp nil t)
4885 (org-table-align))
4886 (buffer-substring 1 (buffer-size)))))
4888 (defun orgtbl-to-table.el (table params)
4889 "Convert the orgtbl-mode TABLE into a table.el table."
4890 (with-temp-buffer
4891 (insert (orgtbl-to-orgtbl table params))
4892 (org-table-align)
4893 (replace-regexp-in-string
4894 "-|" "-+"
4895 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4897 (defun orgtbl-to-unicode (table params)
4898 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4899 You need the ascii-art-to-unicode.el package for this. You can download
4900 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4901 (with-temp-buffer
4902 (insert (orgtbl-to-table.el table params))
4903 (goto-char (point-min))
4904 (if (or (featurep 'ascii-art-to-unicode)
4905 (require 'ascii-art-to-unicode nil t))
4906 (aa2u)
4907 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4908 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4909 "Link to ascii-art-to-unicode.el") org-stored-links))
4910 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4911 (buffer-string)))
4913 (defun org-table-get-remote-range (name-or-id form)
4914 "Get a field value or a list of values in a range from table at ID.
4916 NAME-OR-ID may be the name of a table in the current file as set
4918 will then be used. Alternatively, it may be an ID referring to
4919 any entry, also in a different file. In this case, the first
4920 table in that entry will be referenced.
4924 The return value is either a single string for a single field, or a
4925 list of the fields in the rectangle."
4926 (save-match-data
4927 (let ((case-fold-search t) (id-loc nil)
4928 ;; Protect a bunch of variables from being overwritten
4929 ;; by the context of the remote table
4930 org-table-column-names org-table-column-name-regexp
4931 org-table-local-parameters org-table-named-field-locations
4932 org-table-current-line-types org-table-current-begin-line
4933 org-table-current-begin-pos org-table-dlines
4934 org-table-current-ncol
4935 org-table-hlines org-table-last-alignment
4936 org-table-last-column-widths org-table-last-alignment
4937 org-table-last-column-widths tbeg
4938 buffer loc)
4939 (setq form (org-table-convert-refs-to-rc form))
4940 (save-excursion
4941 (save-restriction
4942 (widen)
4943 (save-excursion
4944 (goto-char (point-min))
4945 (if (re-search-forward
4948 nil t)
4949 (setq buffer (current-buffer) loc (match-beginning 0))
4950 (setq id-loc (org-id-find name-or-id 'marker))
4951 (unless (and id-loc (markerp id-loc))
4953 (setq buffer (marker-buffer id-loc)
4954 loc (marker-position id-loc))
4955 (move-marker id-loc nil)))
4956 (with-current-buffer buffer
4957 (save-excursion
4958 (save-restriction
4959 (widen)
4960 (goto-char loc)
4961 (forward-char 1)
4963 (not (match-beginning 1)))
4964 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
4965 (setq tbeg (point-at-bol))
4966 (org-table-get-specials)
4967 (setq form (org-table-formula-substitute-names
4968 (org-table-formula-handle-first/last-rc form)))
4969 (if (and (string-match org-table-range-regexp form)
4970 (> (length (match-string 0 form)) 1))
4971 (save-match-data
4972 (org-table-get-range (match-string 0 form) tbeg 1))
4973 form)))))))))
4975 (defmacro org-define-lookup-function (mode)
4976 (let ((mode-str (symbol-name mode))
4977 (first-p (equal mode 'first))
4978 (all-p (equal mode 'all)))
4979 (let ((plural-str (if all-p "s" "")))
4980 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
4981 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
4982 If R-LIST is nil, return matching element%s of S-LIST.
4983 If PREDICATE is not nil, use it instead of `equal' to match VAL.
4984 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
4985 This function is generated by a call to the macro `org-define-lookup-function'."
4986 mode-str plural-str plural-str plural-str)
4987 (let ,(let ((lvars '((p (or predicate 'equal))
4988 (sl s-list)
4989 (rl (or r-list s-list))
4990 (ret nil))))
4991 (if first-p (add-to-list 'lvars '(match-p nil)))
4992 lvars)
4993 (while ,(if first-p '(and (not match-p) sl) 'sl)
4994 (progn
4995 (if (funcall p val (car sl))
4996 (progn
4997 ,(if first-p '(setq match-p t))
4998 (let ((rval (car rl)))
4999 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5000 (setq sl (cdr sl) rl (cdr rl))))
5001 ret)))))
5003 (org-define-lookup-function first)
5004 (org-define-lookup-function last)
5005 (org-define-lookup-function all)
5007 (provide 'org-table)
5009 ;; Local variables:
5010 ;; generated-autoload-file: "org-loaddefs.el"
5011 ;; End:
5013 ;;; org-table.el ends here