| blob | 441100a24522fed101509fc45fc1f178e47cb590 |
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 Each template must define lines that will be treated as a comment and that
100 insertion of the template. The transformed table will later be inserted
101 between these lines.
103 The template should also contain a minimal table in a multiline comment.
104 If multiline comments are not possible in the buffer language,
105 you can pack it into a string that will not be used when the code
106 is compiled or executed. Above the table will you need a line with
108 convert the table into a data structure useful in the
109 language of the buffer. Check the manual for the section on
111 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
113 All occurrences of %n in a template will be replaced with the name of the
114 table, obtained by prompting the user."
121 "Settings for tables in Org-mode."
126 "The default size for newly created tables, Columns x Rows."
131 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
132 "Regular expression for recognizing numbers in table columns.
133 If a table column contains mostly numbers, it will be aligned to the
134 right. If not, it will be aligned to the left.
136 The default value of this option is a regular expression which allows
137 anything which looks remotely like a number as used in scientific
138 context. For example, all of the following will be considered a
139 number:
140 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
142 Other options offered by the customize interface are more restrictive."
156 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
157 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
158 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
162 "Fraction of numbers in a column required to make the column align right.
163 In a column all non-white fields are considered. If at least
164 this fraction of fields is matched by `org-table-number-regexp',
165 alignment to the right border applies."
170 "Behavior of tables during editing in Org-mode."
175 "Non-nil means automatically re-align table when pressing TAB or RETURN.
177 removal/insertion."
182 "Non-nil means automatically blank table field when starting to type into it.
183 This only happens when typing immediately after a field motion
184 command (TAB, S-TAB or RET).
185 Only relevant when `org-enable-table-editor' is equal to `optimized'."
190 "Non-nil means automatically exit the follow mode.
191 When nil, the follow mode will stay on and be active in any table
192 the cursor enters. Since the table follow filed mode messes with the
193 window configuration, it is not recommended to set this variable to nil,
194 except maybe locally in a special file that has mostly tables with long
195 fields."
201 "Whether the user should confirm when Org fixes formulas."
209 'safe-local-variable
213 "Non-nil means tab in the last column of a table with jump over a hline.
214 If a horizontal separator line is following the current line,
215 `org-table-next-field' can either create a new row before that line, or jump
216 over the line. When this option is nil, a new line will be created before
217 this line."
222 "Options concerning tables in Org-mode."
227 "Should org-mode work with table references like B3 instead of @3$2?
228 Possible values are:
229 nil never use them
230 from accept as input, do not present for editing
231 t accept as input and present for editing"
246 calc-angle-mode deg
247 calc-prefer-frac nil
248 calc-symbolic-mode nil
250 calc-display-working-message t
251 )
252 "List with Calc mode settings for use in `calc-eval' for table formulas.
253 The list must contain alternating symbols (Calc modes variables and values).
254 Don't remove any of the default settings, just change the values. Org-mode
255 relies on the variables to be present in the list."
260 "Format for the output of calc computations like $1+$2;t.
261 The default value is 'hours, and will output the results as a
262 number of hours. Other allowed values are 'seconds, 'minutes and
263 'days, and the output will be a fraction of seconds, minutes or
264 days."
273 "Format for fields which contain the result of a formula.
275 characters. Beware that modifying the display can prevent the
276 field from being used in another formula."
282 "Non-nil means TAB and RET evaluate a formula in current table field.
283 If the current field starts with an equal sign, it is assumed to be a formula
284 which should be evaluated as described in the manual and in the documentation
285 string of the command `org-table-eval-formula'. This feature requires the
286 Emacs calc package.
287 When this variable is nil, formula calculation is only available through
293 "Non-nil means interpret constants in formulas in tables.
294 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
295 by the value given in `org-table-formula-constants', or by a value obtained
296 from the `constants.el' package."
301 "Alist with constant names and values, for use in table formulas.
302 The car of each element is a name of a constant, without the `$' before it.
303 The cdr is the value as a string. For example, if you'd like to use the
304 speed of light in a formula, you would configure
308 and then use it in an equation like `$1*$c'.
310 Constants can also be defined on a per-file basis using a line like
312 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
319 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
320 Automatically means when TAB or RET or C-c C-c are pressed in the line."
325 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
330 "Non-nil means relative formula references may cross hlines.
331 Here are the allowed values:
333 nil Relative references may not cross hlines. They will reference the
334 field next to the hline instead. Coming from below, the reference
335 will be to the field below the hline. Coming from above, it will be
336 to the field above.
337 t Relative references may cross hlines.
338 error An attempt to cross a hline will throw an error.
340 It is probably good to never set this variable to nil, for the sake of
341 portability of tables."
349 "Options concerning table import and export in Org-mode."
354 "Default export parameters for `org-table-export'.
355 These can be overridden for a specific table by setting the
356 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
357 radio tables for the different export transformations and
358 available parameters."
396 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
397 ;; 1 2 3 4 5
408 "Is this a table line colgroup information?"
412 line)
414 nil
421 "Is this a table line with only alignment/width cookies?"
434 s))))
440 "Check if the table has a marking column.
441 If yes remove the column and the special lines."
454 lines))))
463 nil)
467 ;; remove the first column
470 lines))))
476 ;;;###autoload
478 "Use the table.el package to insert a new table.
479 If there is already a table at point, convert between Org-mode tables
480 and table.el tables."
493 ;;;###autoload
495 "Convert region to table, or create an empty table.
496 If there is an active region, convert it to a table, using the function
497 `org-table-convert-region'. See the documentation of that function
498 to learn how the prefix argument is interpreted to determine the field
499 separator.
500 If there is no such region, create an empty table with `org-table-create'."
506 ;;;###autoload
508 "Query for a size and insert a table skeleton.
528 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
532 ;; Insert a hline after the first row.
539 ;;;###autoload
541 "Convert region to a table.
542 The region goes from BEG0 to END0, but these borders will be moved
543 slightly, to make sure a beginning of line in the first line is included.
545 SEPARATOR specifies the field separator in the lines. It can have the
546 following values:
548 '(4) Use the comma as a field separator
549 '(16) Use a TAB as field separator
550 integer When a number, use that many spaces as field separator
551 nil When nil, the command tries to be smart and figure out the
552 separator in the following way:
553 - when each line contains a TAB, assume TAB-separated material
554 - when each line contains a comma, assume CSV material
555 - else, assume one or more SPACE characters as separator."
559 re)
566 ;; Get the right field separator
577 ;; parse the csv stuff
600 ;;;###autoload
602 "Import FILE as a table.
603 The file is assumed to be tab-separated. Such files can be produced by most
604 spreadsheet and database applications. If no tabs (at least one per line)
605 are found, lines will be split on whitespace into fields."
616 ;;;###autoload
618 "Export table to a file, with configurable format.
619 Such a file can be imported into usual spreadsheet programs.
621 FILE can be the output file name. If not given, it will be taken
622 from a TABLE_EXPORT_FILE property in the current entry or higher
623 up in the hierarchy, or the user will be prompted for a file
624 name. FORMAT can be an export format, of the same kind as it
625 used when `orgtbl-mode' sends a table in a different format.
627 The command suggests a format depending on TABLE_EXPORT_FORMAT,
628 whether it is set locally or up in the hierarchy, then on the
629 extension of the given file name, and finally on the variable
630 `org-table-export-default-format'."
644 buf deffmt-readable fileext)
660 org-table-export-default-format))
678 'hline
681 skipcols i0)))
682 lines))
686 skipcols i0))
689 skipcols i0)))
706 "Marker at the beginning of the table last aligned.
709 "Marker at the end of the table last aligned.
712 "List of flags for flushright alignment, from the last re-alignment.
715 "List of max width of fields in each column.
718 "Non-nil means debug table formulas.
730 ;;;###autoload
732 "Align the table at point by aligning all vertical bars."
735 ;; Limits of table
738 ;; Current cursor position
744 column
746 rfmt hfmt
754 emptystrings links dates emph raise narrow
755 falign falign1 fmax f1 len c e space)
758 ;; Check if we have links or dates
770 ;; Make sure the link properties are right
772 ;; Make sure the date properties are right
777 ;; Check if we are narrowing any columns
780 org-format-transports-properties-p
785 ;; Get the rows
788 ;; Store the indentation of the first line
791 ;; Mark the hlines by setting the corresponding element to nil
792 ;; At the same time, we remove trailing space.
795 nil
798 l)))
799 lines))
800 ;; Get the data fields by splitting the lines.
805 ;; How many fields in the longest line?
812 ;; A list of empty strings to fill any short rows on output
814 ;; Check for special formatting.
818 ;; Check if there is an explicit width specified
828 ;; Find fields that are wider than fmax, and shorten them
834 'help-echo
835 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
843 xx)))))
844 ;; Get the maximum width for each column
846 lengths)
847 ;; Get the fraction of numbers, to decide about alignment of the column
853 nil
860 ;; Store the alignment of this table, for later editing of single fields
862 org-table-last-column-widths lengths)
864 ;; With invisible characters, `format' does not get the field width right
865 ;; So we need to make these fields wide by hand.
883 ;; Compute the formats needed for output of the table
896 hfmt))
900 ;; Replace the old one
907 ;; Try to move to the old location
916 ))
918 ;;;###autoload
920 "Find the beginning of the table and return its position.
921 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
925 org-table-border-regexp)
926 nil t))
932 ;;;###autoload
934 "Find the end of the table and return its position.
935 With argument TABLE-TYPE, go to the end of a table.el-type table."
939 org-table-border-regexp)
940 nil t))
945 ;;;###autoload
947 "Justify the current field, text to left, number to right.
948 Optional argument NEW may specify text to replace the current field content."
957 ;; This is not the same table, force a full re-align
963 l f n o e)
986 ;;;###autoload
988 "Go to the next field in the current table, creating new lines as needed.
989 Before doing so, re-align the table if necessary."
994 org-table-may-need-update)
1005 org-table-tab-jumps-over-hlines
1016 ;;;###autoload
1018 "Go to the previous field in the table.
1019 Before doing so, re-align the table if necessary."
1024 org-table-may-need-update)
1039 "Move to the end of the current table field.
1040 If already at or after the end, move to the end of the next table field.
1041 With numeric argument N, move N-1 fields forward first."
1054 "Move to the beginning of the current table field.
1055 If already at or before the beginning, move to the beginning of the
1056 previous field.
1057 With numeric argument N, move N-1 fields backward first."
1070 ;;;###autoload
1072 "Go to the next row (same column) in the current table.
1073 Before doing so, re-align the table if necessary."
1081 org-table-may-need-update)
1094 ;;;###autoload
1096 "Copy a field down in the current column.
1097 If the field at the cursor is empty, copy into it the content of
1098 the nearest non-empty field above. With argument N, use the Nth
1099 non-empty field. If the current field is not empty, it is copied
1100 down to the next row, and the cursor is moved with it.
1101 Therefore, repeating this command causes the column to be filled
1102 row-by-row.
1103 If the variable `org-table-copy-increment' is non-nil and the
1104 field is an integer or a timestamp, it will be incremented while
1105 copying. In the case of a timestamp, increment by one day."
1113 txt)
1125 beg t))
1148 "Is point inside a table data field?
1149 I.e. not on a hline or before the first or after the last column?
1150 This actually throws an error, so it aborts the current command."
1156 nil
1158 t))
1164 "Get the field in table line LINE, column COLUMN.
1165 If LINE is larger than the number of data lines in the table, the function
1166 returns nil. However, if COLUMN is too large, we will simply return an
1167 empty string.
1168 If LINE is nil, use the current line.
1169 If column is nil, use the current column."
1176 "Put VALUE into line LINE, column COLUMN.
1177 When ALIGN is set, also realign the table."
1186 "Return the index of the current data line."
1193 cnt))
1196 "Go to the Nth data line in the current table.
1197 Return t when the line exists, nil if it does not exist."
1204 ;;;###autoload
1206 "Blank the current table field or active region."
1223 "Return the value of the field in column N of current row.
1224 N defaults to current field.
1225 If REPLACE is a string, replace field with this value. The return value
1226 is always the old value."
1235 t t))
1237 val)
1240 ;;;###autoload
1242 "Show info about the current field, and highlight any reference at point."
1250 org-table-named-field-locations)))
1270 dline col
1272 dline col ref1
1274 ;; FIXME: formula info not correct if special table line
1284 "Find out which column we are in."
1294 cnt)))
1296 ;;;###autoload
1298 "Find out what table data line we are in.
1299 Only data lines count for this."
1311 cnt)))
1313 ;;;###autoload
1315 "Move the cursor to the Nth column in the current table line.
1316 With optional argument ON-DELIM, stop with point before the left delimiter
1317 of the field.
1318 If there are less than N fields, just go to after the last delimiter.
1319 However, when FORCE is non-nil, create new columns if necessary."
1329 t)))))
1336 ;;;###autoload
1338 "Insert a new column into the table."
1346 ;; Current cursor position
1352 nil
1366 "Find a data line in the current table, which is needed for column commands."
1369 t
1380 t
1385 "Turn a buffer line number into a data line number.
1386 If there is no data line in this line, return nil.
1387 If there is no matching dline (most likely te reference was a hline), the
1388 first dline below it is used. When ABOVE is non-nil, the one above is used."
1391 i)
1404 nil))
1406 ;;;###autoload
1408 "Delete a column from the table."
1417 ;; Current cursor position
1423 nil
1439 ;;;###autoload
1441 "Move column to the right."
1444 ;;;###autoload
1446 "Move column to the left."
1450 ;;;###autoload
1452 "Move the current column to the right. With arg LEFT, move to the left."
1462 ;; Current cursor position
1472 nil
1490 ;;;###autoload
1492 "Move table row down."
1495 ;;;###autoload
1497 "Move table row up."
1501 ;;;###autoload
1503 "Move the current table line down. With arg UP, move it up."
1512 txt hline2p)
1535 ;;;###autoload
1537 "Insert a new row above the current line into the table.
1538 With prefix ARG, insert below the current line."
1544 ;; Fix the first field if necessary
1557 ;;;###autoload
1559 "Insert a horizontal-line below the current line into the table.
1560 With prefix ABOVE, insert above the current line."
1581 ;;;###autoload
1583 "Insert a hline and move to the row below that line."
1597 In particular, this does handle wide and invisible characters."
1599 ;; It's a hline, just map the characters
1605 t t s)))
1606 s))
1608 ;;;###autoload
1610 "Delete the current row or horizontal line from the table."
1624 ;;;###autoload
1626 "Sort table lines according to the column at point.
1628 The position of point indicates the column to be used for
1629 sorting, and the range of lines is the range between the nearest
1630 horizontal separator lines, or the entire table of no such lines
1631 exist. If point is before the first column, you will be prompted
1632 for the sorting column. If there is an active region, the mark
1633 specifies the first line and the sorting column, while point
1634 should be in the last line to be included into the sorting.
1636 The command then prompts for the sorting type which can be
1637 alphabetically, numerically, or by time (as given in a time stamp
1638 in the field). Sorting in reverse order is also possible.
1640 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1642 If SORTING-TYPE is specified when this function is called from a Lisp
1643 program, no prompting will take place. SORTING-TYPE must be a character,
1644 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1645 should be done in reverse order."
1650 beg end bcol ecol tend tbeg column lns pos)
1695 x))
1709 ;;;###autoload
1711 "Copy region in table to the clipboard and blank all relevant fields.
1712 If there is no active region, use just the field at point."
1718 ;;;###autoload
1720 "Copy rectangular region in table to clipboard.
1721 A special clipboard is used which can only be accessed
1722 with `org-table-paste-rectangle'."
1726 current-prefix-arg))
1728 region cols
1754 org-table-clip))
1756 ;;;###autoload
1758 "Paste a rectangular region into a table.
1759 The upper right corner ends up in the current field. All involved fields
1760 will be overwritten. If the rectangle does not fit into the present table,
1761 the table is enlarged as needed. The process ignores horizontal separator
1762 lines."
1772 c cols field)
1787 ;;;###autoload
1789 "Convert from `org-mode' table to table.el and back.
1790 Obviously, this only works within limits. When an Org-mode table is
1791 converted to table.el, all horizontal separator lines get lost, because
1792 table.el uses these as cell boundaries and has no notion of horizontal lines.
1793 A table.el table can be converted to an Org-mode table only if it does not
1794 do row or column spanning. Multiline cells will become multiple cells.
1795 Beware, Org-mode does not test if the table can be successfully converted - it
1796 blindly applies a recipe that works for simple tables."
1800 ;; convert to Org-mode table
1809 ;; convert to table.el table
1812 ;; first, get rid of all horizontal lines
1816 ;; insert a hline before first
1820 ;; insert a hline after each line
1825 ;; replace "+" at beginning and ending of hlines
1834 "Transpose orgmode table at point and eliminate hlines.
1835 So a table like
1837 | 1 | 2 | 4 | 5 |
1838 |---+---+---+---|
1839 | a | b | c | d |
1840 | e | f | g | h |
1842 will be transposed as
1844 | 1 | a | e |
1845 | 2 | b | f |
1846 | 4 | c | g |
1847 | 5 | d | h |
1849 Note that horizontal lines disappeared."
1859 table)))
1866 ;;;###autoload
1868 "Wrap several fields in a column like a paragraph.
1869 This is useful if you'd like to spread the contents of a field over several
1870 lines, in order to keep the table compact.
1872 If there is an active region, and both point and mark are in the same column,
1873 the text in the column is wrapped to minimum width for the given number of
1874 lines. Generally, this makes the table more compact. A prefix ARG may be
1876 formats the selected text to two lines. If the region was longer than two
1877 lines, the remaining lines remain empty. A negative prefix argument reduces
1878 the current number of lines by that amount. The wrapped text is pasted back
1879 into the table. If you formatted it to more lines than it was before, fields
1880 further down in the table get overwritten - so you might need to make space in
1881 the table first.
1883 If there is no region, the current field is split at the cursor position and
1884 the text fragment to the right of the cursor is prepended to the field one
1885 line down.
1887 If there is no region, but you specify a prefix ARG, the current field gets
1888 blank, and the content is appended to the field above."
1892 ;; There is a region: fill as a paragraph
1896 nlines)
1903 arg)
1907 nil nlines)))
1911 ;; No region, split the current field at point
1915 ;; combine with field above
1925 ;; split field
1937 ;;;###autoload
1939 "Edit table field in a different window.
1940 This is mainly useful for fields that contain hidden parts.
1942 it can be edited in place."
1951 display t intangible t))
1964 p)
1980 intangible t))
1988 "Finish editing a table data field.
1989 Remove all newline characters, insert the result into the table, realign
1990 the table and kill the editing buffer."
1994 text)
2011 "Minor mode to make the table field editor window follow the cursor.
2012 When this mode is active, the field editor window will always show the
2013 current field. The mode exits automatically when the cursor leaves the
2014 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2015 nil " TblFollow" nil
2031 ;; We have left the table, exit the follow mode
2041 ;;;###autoload
2043 "Sum numbers in region of current table column.
2044 The result will be displayed in the echo area, and will be available
2047 If there is an active region, it is interpreted as a rectangle and all
2048 numbers in that rectangle will be summed. If there is no active
2049 region and point is located in a table column, sum all numbers in that
2050 column.
2052 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2053 numbers are assumed to be times as well (in decimal hours) and the
2054 numbers are added as such.
2056 If NLAST is a number, only the NLAST fields will actually be summed."
2083 items1)))
2090 s diff)
2098 sres))))
2121 "Return the formula active for the current field.
2122 Assumes that specials are in place.
2123 If KEY is given, return the key to this formula.
2127 org-table-named-field-locations)))
2141 "Read a formula from the minibuffer, offer stored formula as default.
2142 When NAMED is non-nil, look for a named equation."
2146 org-table-named-field-locations)))
2153 name
2154 ref)
2164 stored)
2166 equation)
2173 scol))
2175 'org-table-formula-history
2176 )))))
2177 mustsave)
2179 ;; remove formula
2186 ;; We set the column equation, delete the named one.
2188 mustsave t))
2194 eq))
2197 "Store the list of formulas below the current table."
2204 ;; don't overwrite TBLFM, we might use text properties to store stuff
2220 ;; Fake a high number to make sure this is sorted at the end.
2227 a)
2237 "Compare two formulas for sorting."
2242 ;;;###autoload
2244 "Return an alist with the stored formulas directly after current table."
2253 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2272 "Modify the equations after the table structure has been edited.
2274 For all numbers larger than LIMIT, shift them by DELTA."
2288 s n a)
2308 "Get the column names and local parameters for this table."
2311 names name fields fields1 field cnt
2312 c v l line col types dlines hlines last-dline)
2314 org-table-local-parameters nil
2315 org-table-named-field-locations nil
2316 org-table-current-begin-line nil
2317 org-table-current-begin-pos nil
2318 org-table-current-line-types nil
2337 org-table-local-parameters))))
2353 ;; Analyse the line types
2357 l org-table-current-begin-line)
2374 al al2)
2384 ;;;###autoload
2387 If yes, store the formula and apply it."
2388 ;; We already know we are in a table. Get field will only return a formula
2389 ;; when appropriate. It might return a separator line, but no problem.
2392 named eq)
2403 "List of commands triggering the recalculation of a line.
2415 ;;;###autoload
2417 "Rotate the recalculation mark in the first column.
2418 If in any row, the first field is not consistent with a mark,
2419 insert a new column for the markers.
2420 When there is an active region, change all the lines in the region,
2421 after prompting for the marking character.
2422 After each change, a message will be displayed indicating the meaning
2423 of the new mark."
2438 epos new)
2445 newchar))
2477 ;;;###autoload
2479 "Recompute the current line if marked for it, and if we haven't just done it."
2499 org-tbl-calc-modes)
2501 ;;;###autoload
2503 suppress-align suppress-const
2504 suppress-store suppress-analysis)
2505 "Replace the table field value at the cursor by the result of a calculation.
2507 This function makes use of Dave Gillespie's Calc package, in my view the
2508 most exciting program ever written for GNU Emacs. So you need to have Calc
2509 installed in order to use this function.
2511 In a table, this command replaces the value in the current field with the
2513 formula, by storing it in a special line below the table. When called
2514 with a `C-u' prefix, the current field must be a named field, and the
2515 formula is installed as valid in only this specific field.
2517 When called with two `C-u' prefixes, insert the active equation
2518 for the field back into the current field, so that it can be
2520 to check the referenced fields.
2522 When called, the command first prompts for a formula, which is read in
2523 the minibuffer. Previously entered formulas are available through the
2524 history list, and the last used formula is offered as a default.
2525 These stored formulas are adapted correctly when moving, inserting, or
2526 deleting columns with the corresponding commands.
2528 The formula can be any algebraic expression understood by the Calc package.
2529 For details, see the Org-mode manual.
2531 This function can also be called from Lisp programs and offers
2532 additional arguments: EQUATION can be the formula to apply. If this
2533 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2534 used to speed-up recursive calls by by-passing unnecessary aligns.
2535 SUPPRESS-CONST suppresses the interpretation of constants in the
2536 formula, assuming that this has been done already outside the function.
2537 SUPPRESS-STORE means the formula should not be stored, either because
2538 it is already stored, or because it is a modified equation that should
2539 not overwrite the stored one."
2555 equation
2561 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2562 duration duration-output-format)
2563 ;; Parse the format string. Since we have a lot of modes, this is
2564 ;; a lot of work. However, I think calc still uses most of the time.
2577 'calc-float-format
2580 n))))
2584 duration-output-format nil
2588 duration-output-format org-table-duration-custom-format
2589 numbers t
2612 ;; replace fields with duration values if relevant
2616 fields)))
2622 x))
2623 fields)))
2629 ;; Insert row and column number of formula result field
2640 t t form)))
2642 ;; Check for old vertical references
2644 ;; Insert remote references
2656 rmtrng))
2657 keep-empty numbers lispp))
2658 t t form)))
2659 ;; Insert complex ranges
2667 ;; possibly handle durations
2672 formrg)
2673 keep-empty numbers lispp)))
2678 ;; Insert simple ranges
2687 keep-empty numbers lispp))
2688 t t form)))
2690 ;; Insert the references to fields in same row
2700 x keep-empty numbers lispp))
2701 t t form)))
2713 ;; Use <...> time-stamps so that Calc can handle them
2715 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2726 form
2733 duration-output-format)
2734 ev)))
2739 Orig: %s
2740 $xyz-> %s
2741 @r$c-> %s
2773 prop value)))
2776 "Get a calc vector from a column, according to descriptor DESC.
2777 Optional arguments TBEG and COL can give the beginning of the table and
2778 the current column, to avoid unnecessary parsing.
2780 HIGHLIGHT means just highlight the range.
2782 When CORNERS-ONLY is set, only return the corners of the range as
2783 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2784 in the buffer and column1 and column2 are table column numbers."
2791 beg end c1 c2 r1 r2 rangep tmp)
2808 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2815 ;; just one field
2822 ;; A range, return a vector
2823 ;; First sort the numbers to get a regular rectangle
2827 ;; Only return the corners of the range
2829 ;; Copy the range values into a list
2843 ;; return string representation of calc vector
2848 "Analyze descriptor DESC and retrieve the corresponding line number.
2849 The cursor is currently in line CLINE, the table begins in line BLINE,
2850 and TABLE is a vector with line types."
2858 ;; 1 2 3 4 5 6
2878 nil hn cline desc)))
2881 rel on cline desc)))
2885 "FIXME: Needs more documentation."
2898 nil))
2899 t)))
2903 desc cline)
2904 i)))
2909 s))
2912 "Convert list ELEMENTS to something appropriate to insert into formula.
2913 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2914 NUMBERS indicates that everything should be converted to numbers.
2915 LISPP non-nil means to return something appropriate for a Lisp
2916 list, 'literal is for the format specifier L."
2917 ;; Calc nan (not a number) is used for the conversion of the empty
2918 ;; field to a reference for several reasons: (i) It is accepted in a
2919 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2920 ;; (ii) In a single field (not in range) it can be distinguished
2921 ;; from "(nan)" which is the reference made from a single field
2922 ;; containing "nan".
2924 ;; field reference
2927 elements
2929 ""
2938 ;; range reference
2943 elements))))
2949 x
2957 x)
2959 elements
2962 ;;;###autoload
2964 "Set `org-table-formula-constants-local' in the current buffer."
2980 ;;;###autoload
2982 "Recalculate the current table line by applying all stored formulas.
2983 With prefix arg ALL, do this for all lines in the table.
2984 With the prefix argument ALL is `(16)' \
2986 it is the symbol `iterate', recompute the table until it no longer changes.
2987 If NOALIGN is not nil, do not re-align the table after the computations
2988 are done. This is typically used internally to save time, if it is
2989 known that the table will be realigned a little later anyway."
3004 seen-fields lhs1
3006 ;; Insert constants in all formulas
3022 eqlist))
3023 ;; Split the equation list
3029 ;; Expand ranges in lhs of formulas
3032 ;; Get the correct line range to process
3038 ;; This is a table with marked lines, compute selected lines
3040 ;; Move forward to the first non-header line
3051 ;; First find the named fields, and mark them untouchable.
3052 ;; Also check if several field/range formulas try to set the same field.
3071 name)))
3081 ;; Now evaluate the column formulas, but skip fields covered by
3082 ;; field formulas
3086 ;; Unprotected line, recalculate
3098 ;; Now evaluate the field formulas
3112 ;; back to initial position
3119 ;;;###autoload
3121 "Recalculate the table until it does not change anymore.
3122 The maximum number of iterations is 10, but you can choose a different value
3123 with the prefix ARG."
3128 thistbl)
3142 ;;;###autoload
3144 "Recalculate all tables in the current buffer."
3151 ;;;###autoload
3153 "Iterate all tables in the buffer, to converge inter-table dependencies."
3158 c1)
3174 "Apply the #+TBLFM in the line at point to the table."
3180 s e)
3182 ;; Insert a temporary formula at right after the table
3187 ;; Recalculate the table
3193 ;; delete the formula inserted temporarily
3197 "Find the beginning of the TBLFM lines and return its position.
3198 Return nil when the beginning of TBLFM line was not found."
3202 org-table-TBLFM-begin-regexp
3203 nil t))
3207 "Expand list of formulas.
3208 If some of the RHS in the formulas are ranges or a row reference, expand
3209 them to individual field equations for each field."
3215 ;; This just refers to one fixed field
3218 ;; This just refers to one fixed named field
3240 "Replace @<, @>, $<, $> with first/last row/column of the table.
3241 So @< and $< will always be replaced with @1 and $1, respectively.
3242 The advantage of these special markers are that structure editing of
3243 the table will not change them, while @1 and $1 will be modified
3244 when a line/row is swapped out of that privileged position. So for
3245 formulas that use a range of rows or columns, it may often be better
3247 borders of the table using the @< @> $< $> makers."
3250 s start)
3255 org-table-current-ncol)
3259 len
3266 s)
3269 "Replace $const with values in string F."
3271 ;; First, check for column names
3276 ;; Parameters and constants
3278 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3288 f))
3291 "Find the value for a parameter or constant in a formula.
3292 Parameters get priority."
3323 map))
3330 "--"
3333 "--"
3334 "Shift Reference at Point"
3339 "-"
3340 "Change Test Row for Column Formulas"
3343 "--"
3348 org-table-overlay-coordinates)]
3349 "--"
3355 ;;;###autoload
3357 "Edit the formulas of the current table in a separate buffer."
3359 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3373 entry s type title)
3376 ;; Keep global-font-lock-mode from turning on font-lock-mode
3417 "Convert a formula from internal to user representation."
3420 s))
3423 "Convert a formula from user to internal representation."
3426 s))
3429 "Convert spreadsheet references from A7 to @7$28.
3430 Works for single references, but also for entire formulas and even the
3431 full TBLFM line."
3433 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3436 ;; format match, just advance
3441 ;; 3.e5 or something like this.
3444 ;; (member (match-string 1 s)
3445 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3446 )
3447 ;; function name, just advance
3457 t t s)))))
3458 s))
3461 "Convert spreadsheet references from to @7$28 to AB7.
3462 Works for single references, but also for entire formulas and even the
3463 full TBLFM line."
3470 t t s)))
3475 t nil s)))
3476 s)
3479 "Convert a base 26 number represented by letters into an integer.
3480 For example: AB -> 28."
3486 n))
3489 "Convert an integer into a base 26 number represented by letters.
3490 For example: 28 -> AB."
3495 s))
3498 "Convert a time string into numerical duration in seconds.
3499 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3500 If S is a string representing a number, keep this number."
3502 s
3525 "Convert a number of seconds to a time string.
3526 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3527 minutes or seconds."
3542 "Convert all references in this buffer, using FUNCTION."
3552 "Convert all references in the buffer from B3 to @3$2 and back."
3562 "Shift the reference at point one row/hline up."
3566 "Shift the reference at point one row/hline down."
3570 "Shift the reference at point one field to the left."
3574 "Shift the reference at point one field to the right."
3585 ;; A B3-like reference
3591 ;; An internal reference
3597 "Re-match the group N, and replace it with the shifted reference."
3602 t t)))
3605 "Shift a reference part REF.
3606 If DECR is set, decrease the references row/column, else increase.
3607 If HLINE is set, this may be a hline reference, it certainly is not
3608 a translation reference."
3637 "Toggle the display of coordinates in the referenced table."
3646 "Parse the buffer for formula definitions and install them.
3647 With prefix ARG, apply the new formulas to the table."
3657 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3658 nil t)
3682 "Abort editing formulas, without installing the changes."
3693 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3734 "Show the location/value of the $ expression at point."
3743 var name e what match dest)
3748 "$1.."
3831 ;; column number
3859 org-table-fedit-scroll-down))))
3870 "Make sure the cursor is in a dataline in a table."
3879 p1 p2)))
3884 "Move cursor one line up in the window showing the table."
3889 "Move cursor one line down in the window showing the table."
3894 "Move the cursor in the window showing the table.
3895 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3920 "Add a new overlay."
3926 "Highlight rectangular region in a table."
3930 l1 c1 l2 c2 tmp)
3954 "Remove the rectangle overlays."
3965 "Add overlays to the table at point, to show row/column coordinates."
3993 ;;;###autoload
3995 "Toggle the display of Row/Column numbers in tables."
4006 ;;;###autoload
4008 "Toggle the formula debugger in tables."
4014 ;;; The orgtbl minor mode
4016 ;; Define a minor mode which can be used in other modes in order to
4017 ;; integrate the org-mode table editor.
4019 ;; This is really a hack, because the org-mode table editor uses several
4020 ;; keys which normally belong to the major mode, for example the TAB and
4021 ;; RET keys. Here is how it works: The minor mode defines all the keys
4022 ;; necessary to operate the table editor, but wraps the commands into a
4023 ;; function which tests if the cursor is currently inside a table. If that
4024 ;; is the case, the table editor command is executed. However, when any of
4025 ;; those keys is used outside a table, the function uses `key-binding' to
4026 ;; look up if the key has an associated command in another currently active
4027 ;; keymap (minor modes, major mode, global), and executes that command.
4028 ;; There might be problems if any of the keys used by the table editor is
4029 ;; otherwise used as a prefix key.
4031 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4032 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4033 ;; addresses this by checking explicitly for both bindings.
4035 ;; The optimized version (see variable `orgtbl-optimized') takes over
4036 ;; all keys which are bound to `self-insert-command' in the *global map*.
4037 ;; Some modes bind other commands to simple characters, for example
4038 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4039 ;; active, this binding is ignored inside tables and replaced with a
4040 ;; modified self-insert.
4058 ;; Install it as a minor mode.
4062 ;;;###autoload
4064 "The `org-mode' table editor as a minor mode for use in other modes."
4069 ;; Exit without error, in case some hook functions calls this
4070 ;; by accident in org-mode.
4074 ;; Make sure we are first in minor-mode-map-alist
4076 ;; FIXME: maybe it should use emulation-mode-map-alists?
4083 auto-fill-inhibit-regexp)
4087 auto-fill-inhibit-regexp)
4088 orgtbl-line-start-regexp))
4106 "Remove all properties related to narrow-column invisibility."
4119 "Create a function for binding in the table minor mode.
4120 FUN is the command to call inside a table. N is used to create a unique
4121 command name. KEYS are keys that should be checked in for a command
4122 to execute outside of tables."
4128 "Outside of tables, run the binding of `"
4140 keys)
4144 "Error when there is no default binding for a table key."
4149 "Setup orgtbl keymaps."
4180 elt key fun cmd)
4188 ;; Special treatment needed for TAB and RET
4208 [(tab)] "\C-i")))
4210 (org-defkey orgtbl-mode-map [backtab]
4212 [backtab] [S-iso-lefttab] [(shift tab)]
4213 [(tab)] "\C-i"))
4215 (org-defkey orgtbl-mode-map "\M-\C-m"
4216 (orgtbl-make-binding 'org-table-wrap-region 105
4217 "\M-\C-m" [(meta return)]))
4218 (org-defkey orgtbl-mode-map [(meta return)]
4219 (orgtbl-make-binding 'org-table-wrap-region 106
4220 [(meta return)] "\M-\C-m"))
4222 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4223 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4225 (when orgtbl-optimized
4226 ;; If the user wants maximum table support, we need to hijack
4227 ;; some standard editing functions
4228 (org-remap orgtbl-mode-map
4229 'self-insert-command 'orgtbl-self-insert-command
4230 'delete-char 'org-delete-char
4231 'delete-backward-char 'org-delete-backward-char)
4232 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4233 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4234 '("OrgTbl"
4235 ["Create or convert" org-table-create-or-convert-from-region
4236 :active (not (org-at-table-p)) :keys "C-c |" ]
4237 "--"
4238 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4239 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4240 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4241 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4242 "--"
4243 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4244 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4245 ["Copy Field from Above"
4246 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4247 "--"
4248 ("Column"
4249 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4250 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4251 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4252 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4253 ("Row"
4254 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4255 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4256 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4257 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4258 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4259 "--"
4260 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4261 ("Rectangle"
4262 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4263 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4264 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4265 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4266 "--"
4267 ("Radio tables"
4268 ["Insert table template" orgtbl-insert-radio-table
4269 (assq major-mode orgtbl-radio-table-templates)]
4270 ["Comment/uncomment table" orgtbl-toggle-comment t])
4271 "--"
4272 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4273 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4274 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4275 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4276 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4277 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4278 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4279 ["Sum Column/Rectangle" org-table-sum
4280 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4281 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4282 ["Debug Formulas"
4283 org-table-toggle-formula-debugger :active (org-at-table-p)
4284 :keys "C-c {"
4285 :style toggle :selected org-table-formula-debug]
4286 ["Show Col/Row Numbers"
4287 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4288 :keys "C-c }"
4289 :style toggle :selected org-table-overlay-coordinates]
4290 ))
4291 t))
4293 (defun orgtbl-ctrl-c-ctrl-c (arg)
4294 "If the cursor is inside a table, realign the table.
4295 If it is a table to be sent away to a receiver, do it.
4296 With prefix arg, also recompute table."
4297 (interactive "P")
4298 (let ((case-fold-search t) (pos (point)) action)
4299 (save-excursion
4300 (beginning-of-line 1)
4301 (setq action (cond
4305 (cond
4306 ((integerp action)
4307 (goto-char action)
4308 (org-table-maybe-eval-formula)
4309 (if arg
4310 (call-interactively 'org-table-recalculate)
4311 (org-table-maybe-recalculate-line))
4312 (call-interactively 'org-table-align)
4313 (when (orgtbl-send-table 'maybe)
4314 (run-hooks 'orgtbl-after-send-table-hook)))
4315 ((eq action 'recalc)
4316 (org-table-set-constants)
4317 (save-excursion
4318 (beginning-of-line 1)
4320 (if (org-at-table-p)
4321 (org-call-with-arg 'org-table-recalculate t))))
4322 (t (let (orgtbl-mode)
4323 (call-interactively (key-binding "\C-c\C-c")))))))
4325 (defun orgtbl-create-or-convert-from-region (arg)
4326 "Create table or convert region to table, if no conflicting binding.
4327 This installs the table binding `C-c |', but only if there is no
4328 conflicting binding to this key outside orgtbl-mode."
4329 (interactive "P")
4330 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4331 (if cmd
4332 (call-interactively cmd)
4333 (call-interactively 'org-table-create-or-convert-from-region))))
4335 (defun orgtbl-tab (arg)
4336 "Justification and field motion for `orgtbl-mode'."
4337 (interactive "P")
4338 (if arg (org-table-edit-field t)
4339 (org-table-justify-field-maybe)
4340 (org-table-next-field)))
4342 (defun orgtbl-ret ()
4343 "Justification and field motion for `orgtbl-mode'."
4344 (interactive)
4345 (if (bobp)
4346 (newline)
4347 (org-table-justify-field-maybe)
4348 (org-table-next-row)))
4350 (defun orgtbl-self-insert-command (N)
4351 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4352 If the cursor is in a table looking at whitespace, the whitespace is
4353 overwritten, and the table is not marked as requiring realignment."
4354 (interactive "p")
4355 (if (and (org-at-table-p)
4356 (or
4357 (and org-table-auto-blank-field
4358 (member last-command
4359 '(orgtbl-hijacker-command-100
4360 orgtbl-hijacker-command-101
4361 orgtbl-hijacker-command-102
4362 orgtbl-hijacker-command-103
4363 orgtbl-hijacker-command-104
4364 orgtbl-hijacker-command-105
4365 yas/expand))
4366 (org-table-blank-field))
4367 t)
4368 (eq N 1)
4370 (let (org-table-may-need-update)
4371 (goto-char (1- (match-end 0)))
4372 (org-delete-backward-char 1)
4373 (goto-char (match-beginning 0))
4374 (self-insert-command N))
4375 (setq org-table-may-need-update t)
4376 (let* (orgtbl-mode
4377 a
4378 (cmd (or (key-binding
4379 (or (and (listp function-key-map)
4380 (setq a (assoc last-input-event function-key-map))
4381 (cdr a))
4382 (vector last-input-event)))
4383 'self-insert-command)))
4384 (call-interactively cmd)
4385 (if (and org-self-insert-cluster-for-undo
4386 (eq cmd 'self-insert-command))
4387 (if (not (eq last-command 'orgtbl-self-insert-command))
4388 (setq org-self-insert-command-undo-counter 1)
4389 (if (>= org-self-insert-command-undo-counter 20)
4390 (setq org-self-insert-command-undo-counter 1)
4391 (and (> org-self-insert-command-undo-counter 0)
4392 buffer-undo-list
4393 (not (cadr buffer-undo-list)) ; remove nil entry
4394 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4395 (setq org-self-insert-command-undo-counter
4396 (1+ org-self-insert-command-undo-counter))))))))
4399 "Regular expression matching exponentials as produced by calc.")
4401 (defun orgtbl-gather-send-defs ()
4402 "Gather a plist of :name, :transform, :params for each destination before
4403 a radio table."
4404 (save-excursion
4405 (goto-char (org-table-begin))
4406 (let (rtn)
4407 (beginning-of-line 0)
4408 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4409 (let ((name (org-no-properties (match-string 1)))
4410 (transform (intern (match-string 2)))
4411 (params (if (match-end 3)
4412 (read (concat "(" (match-string 3) ")")))))
4413 (push (list :name name :transform transform :params params)
4414 rtn)
4415 (beginning-of-line 0)))
4416 rtn)))
4418 (defun orgtbl-send-replace-tbl (name txt)
4419 "Find and replace table NAME with TXT."
4420 (save-excursion
4421 (goto-char (point-min))
4422 (unless (re-search-forward
4424 (user-error "Don't know where to insert translated table"))
4425 (goto-char (match-beginning 0))
4426 (beginning-of-line 2)
4427 (save-excursion
4428 (let ((beg (point)))
4429 (unless (re-search-forward
4430 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4431 (user-error "Cannot find end of insertion region"))
4432 (beginning-of-line 1)
4433 (delete-region beg (point))))
4436 ;;;###autoload
4437 (defun org-table-to-lisp (&optional txt)
4438 "Convert the table at point to a Lisp structure.
4439 The structure will be a list. Each item is either the symbol `hline'
4440 for a horizontal separator line, or a list of field values as strings.
4441 The table is taken from the parameter TXT, or from the buffer at point."
4442 (unless txt
4443 (unless (org-at-table-p)
4444 (user-error "No table at point")))
4445 (let* ((txt (or txt
4446 (buffer-substring-no-properties (org-table-begin)
4447 (org-table-end))))
4450 (mapcar
4451 (lambda (x)
4452 (if (string-match org-table-hline-regexp x)
4453 'hline
4455 lines)))
4457 (defun orgtbl-send-table (&optional maybe)
4458 "Send a transformed version of this table to the receiver position.
4459 With argument MAYBE, fail quietly if no transformation is defined for
4460 this table."
4461 (interactive)
4462 (catch 'exit
4463 (unless (org-at-table-p) (user-error "Not at a table"))
4464 ;; when non-interactive, we assume align has just happened.
4465 (when (org-called-interactively-p 'any) (org-table-align))
4466 (let ((dests (orgtbl-gather-send-defs))
4467 (txt (buffer-substring-no-properties (org-table-begin)
4468 (org-table-end)))
4469 (ntbl 0))
4470 (unless dests (if maybe (throw 'exit nil)
4471 (user-error "Don't know how to transform this table")))
4472 (dolist (dest dests)
4473 (let* ((name (plist-get dest :name))
4474 (transform (plist-get dest :transform))
4475 (params (plist-get dest :params))
4476 (skip (plist-get params :skip))
4477 (skipcols (plist-get params :skipcols))
4478 (no-escape (plist-get params :no-escape))
4479 beg
4480 (lines (org-table-clean-before-export
4481 (nthcdr (or skip 0)
4483 (i0 (if org-table-clean-did-remove-column 2 1))
4484 (lines (if no-escape lines
4485 (mapcar (lambda(l) (replace-regexp-in-string
4487 (table (mapcar
4488 (lambda (x)
4489 (if (string-match org-table-hline-regexp x)
4490 'hline
4491 (org-remove-by-index
4493 skipcols i0)))
4494 lines))
4495 (fun (if (= i0 2) 'cdr 'identity))
4496 (org-table-last-alignment
4497 (org-remove-by-index (funcall fun org-table-last-alignment)
4498 skipcols i0))
4499 (org-table-last-column-widths
4500 (org-remove-by-index (funcall fun org-table-last-column-widths)
4501 skipcols i0))
4502 (txt (if (fboundp transform)
4503 (funcall transform table params)
4504 (user-error "No such transformation function %s" transform))))
4505 (orgtbl-send-replace-tbl name txt))
4506 (setq ntbl (1+ ntbl)))
4507 (message "Table converted and installed at %d receiver location%s"
4508 ntbl (if (> ntbl 1) "s" ""))
4509 (if (> ntbl 0)
4510 ntbl
4511 nil))))
4513 (defun org-remove-by-index (list indices &optional i0)
4514 "Remove the elements in LIST with indices in INDICES.
4515 First element has index 0, or I0 if given."
4516 (if (not indices)
4517 list
4518 (if (integerp indices) (setq indices (list indices)))
4519 (setq i0 (1- (or i0 0)))
4520 (delq :rm (mapcar (lambda (x)
4521 (setq i0 (1+ i0))
4522 (if (memq i0 indices) :rm x))
4523 list))))
4525 (defun orgtbl-toggle-comment ()
4526 "Comment or uncomment the orgtbl at point."
4527 (interactive)
4528 (let* ((case-fold-search t)
4529 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4530 (re2 (concat "^" orgtbl-line-start-regexp))
4531 (commented (save-excursion (beginning-of-line 1)
4532 (cond ((looking-at re1) t)
4533 ((looking-at re2) nil)
4534 (t (user-error "Not at an org table")))))
4535 (re (if commented re1 re2))
4536 beg end)
4537 (save-excursion
4538 (beginning-of-line 1)
4539 (while (looking-at re) (beginning-of-line 0))
4540 (beginning-of-line 2)
4541 (setq beg (point))
4542 (while (looking-at re) (beginning-of-line 2))
4543 (setq end (point)))
4544 (comment-region beg end (if commented '(4) nil))))
4546 (defun orgtbl-insert-radio-table ()
4547 "Insert a radio table template appropriate for this major mode."
4548 (interactive)
4549 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4550 (txt (nth 1 e))
4551 name pos)
4552 (unless e (user-error "No radio table setup defined for %s" major-mode))
4553 (setq name (read-string "Table name: "))
4554 (while (string-match "%n" txt)
4555 (setq txt (replace-match name t t txt)))
4557 (setq pos (point))
4558 (insert txt)
4559 (goto-char pos)))
4561 ;; Dynamically bound input and output for table formatting.
4562 (defvar *orgtbl-table* nil
4563 "Carries the current table through formatting routines.")
4564 (defvar *orgtbl-rtn* nil
4565 "Formatting routines push the output lines here.")
4566 ;; Formatting parameters for the current table section.
4567 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4568 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4569 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4570 (defvar *orgtbl-fmt* nil "Format for each entry.")
4571 (defvar *orgtbl-efmt* nil "Format for numbers.")
4572 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4573 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4574 (defvar *orgtbl-lstart* nil "Text starting a row.")
4575 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4576 (defvar *orgtbl-lend* nil "Text ending a row.")
4577 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4579 (defsubst orgtbl-get-fmt (fmt i)
4580 "Retrieve the format from FMT corresponding to the Ith column."
4581 (if (and (not (functionp fmt)) (consp fmt))
4582 (plist-get fmt i)
4583 fmt))
4585 (defsubst orgtbl-apply-fmt (fmt &rest args)
4586 "Apply format FMT to arguments ARGS.
4587 When FMT is nil, return the first argument from ARGS."
4588 (cond ((functionp fmt) (apply fmt args))
4589 (fmt (apply 'format fmt args))
4590 (args (car args))
4591 (t args)))
4593 (defsubst orgtbl-eval-str (str)
4594 "If STR is a function, evaluate it with no arguments."
4595 (if (functionp str)
4596 (funcall str)
4597 str))
4599 (defun orgtbl-format-line (line)
4600 "Format LINE as a table row."
4601 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4602 (let* ((i 0)
4603 (line
4604 (mapcar
4605 (lambda (f)
4606 (setq i (1+ i))
4607 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4608 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4609 (orgtbl-apply-fmt efmt (match-string 1 f)
4610 (match-string 2 f))
4611 f)))
4612 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4613 *orgtbl-default-fmt*)
4614 f)))
4615 line)))
4616 (push (if *orgtbl-lfmt*
4617 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4618 (concat (orgtbl-eval-str *orgtbl-lstart*)
4619 (mapconcat 'identity line *orgtbl-sep*)
4620 (orgtbl-eval-str *orgtbl-lend*)))
4621 *orgtbl-rtn*))))
4623 (defun orgtbl-format-section (section-stopper)
4624 "Format lines until the first occurrence of SECTION-STOPPER."
4625 (let (prevline)
4626 (progn
4627 (while (not (eq (car *orgtbl-table*) section-stopper))
4628 (if prevline (orgtbl-format-line prevline))
4629 (setq prevline (pop *orgtbl-table*)))
4630 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4631 (*orgtbl-lend* *orgtbl-llend*)
4632 (*orgtbl-lfmt* *orgtbl-llfmt*))
4633 (orgtbl-format-line prevline))))))
4635 ;;;###autoload
4636 (defun orgtbl-to-generic (table params &optional backend)
4637 "Convert the orgtbl-mode TABLE to some other format.
4638 This generic routine can be used for many standard cases.
4639 TABLE is a list, each entry either the symbol `hline' for a horizontal
4640 separator line, or a list of fields for that line.
4641 PARAMS is a property list of parameters that can influence the conversion.
4642 A third optional argument BACKEND can be used to convert the content of
4643 the cells using a specific export back-end.
4645 For the generic converter, some parameters are obligatory: you need to
4646 specify either :lfmt, or all of (:lstart :lend :sep).
4648 Valid parameters are:
4650 :splice When set to t, return only table body lines, don't wrap
4651 them into :tstart and :tend. Default is nil. When :splice
4652 is non-nil, this also means that the exporter should not look
4653 for and interpret header and footer sections.
4655 :hline String to be inserted on horizontal separation lines.
4656 May be nil to ignore hlines.
4658 :sep Separator between two fields
4659 :remove-nil-lines Do not include lines that evaluate to nil.
4661 Each in the following group may be either a string or a function
4662 of no arguments returning a string:
4664 :tstart String to start the table. Ignored when :splice is t.
4665 :tend String to end the table. Ignored when :splice is t.
4666 :lstart String to start a new table line.
4667 :llstart String to start the last table line, defaults to :lstart.
4668 :lend String to end a table line
4669 :llend String to end the last table line, defaults to :lend.
4671 Each in the following group may be a string, a function of one
4672 argument (the field or line) returning a string, or a plist
4673 mapping columns to either of the above:
4675 :lfmt Format for entire line, with enough %s to capture all fields.
4676 If this is present, :lstart, :lend, and :sep are ignored.
4677 :llfmt Format for the entire last line, defaults to :lfmt.
4678 :fmt A format to be used to wrap the field, should contain
4679 %s for the original field value. For example, to wrap
4681 This may also be a property list with column numbers and
4683 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4684 Same as above, specific for the header lines in the table.
4685 All lines before the first hline are treated as header.
4686 If any of these is not present, the data line value is used.
4688 This may be either a string or a function of two arguments:
4690 :efmt Use this format to print numbers with exponentials.
4691 The format should have %s twice for inserting mantissa
4693 may also be a property list with column numbers and
4694 formats. :fmt will still be applied after :efmt.
4696 In addition to this, the parameters :skip and :skipcols are always handled
4697 directly by `orgtbl-send-table'. See manual."
4698 (let* ((splicep (plist-get params :splice))
4699 (hline (plist-get params :hline))
4700 (skipheadrule (plist-get params :skipheadrule))
4701 (remove-nil-linesp (plist-get params :remove-nil-lines))
4702 (remove-newlines (plist-get params :remove-newlines))
4703 (*orgtbl-hline* hline)
4704 (*orgtbl-table* table)
4705 (*orgtbl-sep* (plist-get params :sep))
4706 (*orgtbl-efmt* (plist-get params :efmt))
4707 (*orgtbl-lstart* (plist-get params :lstart))
4708 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4709 (*orgtbl-lend* (plist-get params :lend))
4710 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4711 (*orgtbl-lfmt* (plist-get params :lfmt))
4712 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4713 (*orgtbl-fmt* (plist-get params :fmt))
4714 *orgtbl-rtn*)
4715 ;; Convert cells content to backend BACKEND
4716 (when backend
4717 (setq *orgtbl-table*
4718 (mapcar
4719 (lambda(r)
4720 (if (listp r)
4721 (mapcar
4722 (lambda (c)
4723 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4724 r)
4725 r))
4726 *orgtbl-table*)))
4727 ;; Put header
4728 (unless splicep
4729 (when (plist-member params :tstart)
4730 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4731 (if tstart (push tstart *orgtbl-rtn*)))))
4732 ;; If we have a heading, format it and handle the trailing hline.
4733 (if (and (not splicep)
4734 (or (consp (car *orgtbl-table*))
4735 (consp (nth 1 *orgtbl-table*)))
4736 (memq 'hline (cdr *orgtbl-table*)))
4737 (progn
4738 (when (eq 'hline (car *orgtbl-table*))
4739 ;; There is a hline before the first data line
4740 (and hline (push hline *orgtbl-rtn*))
4741 (pop *orgtbl-table*))
4742 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4743 *orgtbl-lstart*))
4744 (*orgtbl-llstart* (or (plist-get params :hllstart)
4745 *orgtbl-llstart*))
4746 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4747 (*orgtbl-llend* (or (plist-get params :hllend)
4748 (plist-get params :hlend) *orgtbl-llend*))
4749 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4750 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4751 (plist-get params :hlfmt) *orgtbl-llfmt*))
4752 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4753 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4754 (orgtbl-format-section 'hline))
4755 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4756 (pop *orgtbl-table*)))
4757 ;; Now format the main section.
4758 (orgtbl-format-section nil)
4759 (unless splicep
4760 (when (plist-member params :tend)
4761 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4762 (if tend (push tend *orgtbl-rtn*)))))
4763 (mapconcat (if remove-newlines
4764 (lambda (tend)
4766 'identity)
4767 (nreverse (if remove-nil-linesp
4768 (remq nil *orgtbl-rtn*)
4771 ;;;###autoload
4772 (defun orgtbl-to-tsv (table params)
4773 "Convert the orgtbl-mode table to TAB separated material."
4775 ;;;###autoload
4776 (defun orgtbl-to-csv (table params)
4777 "Convert the orgtbl-mode table to CSV material.
4778 This does take care of the proper quoting of fields with comma or quotes."
4779 (orgtbl-to-generic table (org-combine-plists
4780 '(:sep "," :fmt org-quote-csv-field)
4781 params)))
4783 ;;;###autoload
4784 (defun orgtbl-to-latex (table params)
4785 "Convert the orgtbl-mode TABLE to LaTeX.
4786 TABLE is a list, each entry either the symbol `hline' for a horizontal
4787 separator line, or a list of fields for that line.
4788 PARAMS is a property list of parameters that can influence the conversion.
4789 Supports all parameters from `orgtbl-to-generic'. Most important for
4790 LaTeX are:
4792 :splice When set to t, return only table body lines, don't wrap
4793 them into a tabular environment. Default is nil.
4795 :fmt A format to be used to wrap the field, should contain %s for the
4796 original field value. For example, to wrap everything in dollars,
4799 The format may also be a function that formats its one argument.
4801 :efmt Format for transforming numbers with exponentials. The format
4802 should have %s twice for inserting mantissa and exponent, for
4804 This may also be a property list with column numbers and formats.
4805 The format may also be a function that formats its two arguments.
4807 :llend If you find too much space below the last line of a table,
4810 The general parameters :skip and :skipcols have already been applied when
4811 this function is called."
4812 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4813 org-table-last-alignment ""))
4814 (params2
4815 (list
4820 (require 'ox-latex)
4821 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4823 ;;;###autoload
4824 (defun orgtbl-to-html (table params)
4825 "Convert the orgtbl-mode TABLE to HTML.
4826 TABLE is a list, each entry either the symbol `hline' for a horizontal
4827 separator line, or a list of fields for that line.
4828 PARAMS is a property list of parameters that can influence the conversion.
4829 Currently this function recognizes the following parameters:
4831 :splice When set to t, return only table body lines, don't wrap
4832 them into a <table> environment. Default is nil.
4834 The general parameters :skip and :skipcols have already been applied when
4835 this function is called. The function does *not* use `orgtbl-to-generic',
4836 so you cannot specify parameters for it."
4837 (require 'ox-html)
4838 (let ((output (org-export-string-as
4839 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4840 (if (not (plist-get params :splice)) output
4841 (org-trim
4842 (replace-regexp-in-string
4846 ;;;###autoload
4847 (defun orgtbl-to-texinfo (table params)
4848 "Convert the orgtbl-mode TABLE to TeXInfo.
4849 TABLE is a list, each entry either the symbol `hline' for a horizontal
4850 separator line, or a list of fields for that line.
4851 PARAMS is a property list of parameters that can influence the conversion.
4852 Supports all parameters from `orgtbl-to-generic'. Most important for
4853 TeXInfo are:
4855 :splice nil/t When set to t, return only table body lines, don't wrap
4856 them into a multitable environment. Default is nil.
4858 :fmt fmt A format to be used to wrap the field, should contain
4859 %s for the original field value. For example, to wrap
4861 This may also be a property list with column numbers and
4863 Each format also may be a function that formats its one
4864 argument.
4867 are computed automatically from the width of the columns
4868 under org-mode.
4870 The general parameters :skip and :skipcols have already been applied when
4871 this function is called."
4872 (let* ((total (float (apply '+ org-table-last-column-widths)))
4873 (colfrac (or (plist-get params :cf)
4874 (mapconcat
4875 (lambda (x) (format "%.3f" (/ (float x) total)))
4876 org-table-last-column-widths " ")))
4877 (params2
4878 (list
4879 :tstart (concat "@multitable @columnfractions " colfrac)
4880 :tend "@end multitable"
4881 :lstart "@item " :lend "" :sep " @tab "
4882 :hlstart "@headitem ")))
4883 (require 'ox-texinfo)
4884 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4886 ;;;###autoload
4887 (defun orgtbl-to-orgtbl (table params)
4888 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4889 Useful when slicing one table into many. The :hline, :sep,
4890 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4891 and :tend suppress strings without splicing; they can be set to
4892 provide ORGTBL directives for the generated table."
4893 (let* ((params2
4894 (list
4895 :remove-newlines t
4896 :tstart nil :tend nil
4897 :hline "|---"
4898 :sep " | "
4899 :lstart "| "
4900 :lend " |"))
4901 (params (org-combine-plists params2 params)))
4902 (with-temp-buffer
4903 (insert (orgtbl-to-generic table params))
4904 (goto-char (point-min))
4905 (while (re-search-forward org-table-hline-regexp nil t)
4906 (org-table-align))
4907 (buffer-substring 1 (buffer-size)))))
4909 (defun orgtbl-to-table.el (table params)
4910 "Convert the orgtbl-mode TABLE into a table.el table."
4911 (with-temp-buffer
4912 (insert (orgtbl-to-orgtbl table params))
4913 (org-table-align)
4914 (replace-regexp-in-string
4915 "-|" "-+"
4916 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4918 (defun orgtbl-to-unicode (table params)
4919 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4920 You need the ascii-art-to-unicode.el package for this. You can download
4921 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4922 (with-temp-buffer
4923 (insert (orgtbl-to-table.el table params))
4924 (goto-char (point-min))
4925 (if (or (featurep 'ascii-art-to-unicode)
4926 (require 'ascii-art-to-unicode nil t))
4927 (aa2u)
4928 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4929 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4930 "Link to ascii-art-to-unicode.el") org-stored-links))
4931 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4932 (buffer-string)))
4934 (defun org-table-get-remote-range (name-or-id form)
4935 "Get a field value or a list of values in a range from table at ID.
4937 NAME-OR-ID may be the name of a table in the current file as set
4939 will then be used. Alternatively, it may be an ID referring to
4940 any entry, also in a different file. In this case, the first
4941 table in that entry will be referenced.
4945 The return value is either a single string for a single field, or a
4946 list of the fields in the rectangle."
4947 (save-match-data
4948 (let ((case-fold-search t) (id-loc nil)
4949 ;; Protect a bunch of variables from being overwritten
4950 ;; by the context of the remote table
4951 org-table-column-names org-table-column-name-regexp
4952 org-table-local-parameters org-table-named-field-locations
4953 org-table-current-line-types org-table-current-begin-line
4954 org-table-current-begin-pos org-table-dlines
4955 org-table-current-ncol
4956 org-table-hlines org-table-last-alignment
4957 org-table-last-column-widths org-table-last-alignment
4958 org-table-last-column-widths tbeg
4959 buffer loc)
4960 (setq form (org-table-convert-refs-to-rc form))
4961 (save-excursion
4962 (save-restriction
4963 (widen)
4964 (save-excursion
4965 (goto-char (point-min))
4966 (if (re-search-forward
4969 nil t)
4970 (setq buffer (current-buffer) loc (match-beginning 0))
4971 (setq id-loc (org-id-find name-or-id 'marker))
4972 (unless (and id-loc (markerp id-loc))
4974 (setq buffer (marker-buffer id-loc)
4975 loc (marker-position id-loc))
4976 (move-marker id-loc nil)))
4977 (with-current-buffer buffer
4978 (save-excursion
4979 (save-restriction
4980 (widen)
4981 (goto-char loc)
4982 (forward-char 1)
4984 (not (match-beginning 1)))
4985 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
4986 (setq tbeg (point-at-bol))
4987 (org-table-get-specials)
4988 (setq form (org-table-formula-substitute-names
4989 (org-table-formula-handle-first/last-rc form)))
4990 (if (and (string-match org-table-range-regexp form)
4991 (> (length (match-string 0 form)) 1))
4992 (save-match-data
4993 (org-table-get-range (match-string 0 form) tbeg 1))
4994 form)))))))))
4996 (defmacro org-define-lookup-function (mode)
4997 (let ((mode-str (symbol-name mode))
4998 (first-p (equal mode 'first))
4999 (all-p (equal mode 'all)))
5000 (let ((plural-str (if all-p "s" "")))
5001 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5002 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5003 If R-LIST is nil, return matching element%s of S-LIST.
5004 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5005 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5006 This function is generated by a call to the macro `org-define-lookup-function'."
5007 mode-str plural-str plural-str plural-str)
5008 (let ,(let ((lvars '((p (or predicate 'equal))
5009 (sl s-list)
5010 (rl (or r-list s-list))
5011 (ret nil))))
5012 (if first-p (add-to-list 'lvars '(match-p nil)))
5013 lvars)
5014 (while ,(if first-p '(and (not match-p) sl) 'sl)
5015 (progn
5016 (if (funcall p val (car sl))
5017 (progn
5018 ,(if first-p '(setq match-p t))
5019 (let ((rval (car rl)))
5020 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5021 (setq sl (cdr sl) rl (cdr rl))))
5022 ret)))))
5024 (org-define-lookup-function first)
5025 (org-define-lookup-function last)
5026 (org-define-lookup-function all)
5028 (provide 'org-table)
5030 ;; Local variables:
5031 ;; generated-autoload-file: "org-loaddefs.el"
5032 ;; End:
5034 ;;; org-table.el ends here