| blob | ed926a387b5aa116a0870fc43ff5cdcc03365d7f |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2014 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."
1251 org-table-named-field-locations)))
1271 dline col
1273 dline col ref1
1275 ;; FIXME: formula info not correct if special table line
1285 "Find out which column we are in."
1295 cnt)))
1297 ;;;###autoload
1299 "Find out what table data line we are in.
1300 Only data lines count for this."
1312 cnt)))
1314 ;;;###autoload
1316 "Move the cursor to the Nth column in the current table line.
1317 With optional argument ON-DELIM, stop with point before the left delimiter
1318 of the field.
1319 If there are less than N fields, just go to after the last delimiter.
1320 However, when FORCE is non-nil, create new columns if necessary."
1330 t)))))
1337 ;;;###autoload
1339 "Insert a new column into the table."
1347 ;; Current cursor position
1353 nil
1367 "Find a data line in the current table, which is needed for column commands."
1370 t
1381 t
1386 "Turn a buffer line number into a data line number.
1387 If there is no data line in this line, return nil.
1388 If there is no matching dline (most likely te reference was a hline), the
1389 first dline below it is used. When ABOVE is non-nil, the one above is used."
1392 i)
1405 nil))
1407 ;;;###autoload
1409 "Delete a column from the table."
1418 ;; Current cursor position
1424 nil
1440 ;;;###autoload
1442 "Move column to the right."
1445 ;;;###autoload
1447 "Move column to the left."
1451 ;;;###autoload
1453 "Move the current column to the right. With arg LEFT, move to the left."
1463 ;; Current cursor position
1473 nil
1491 ;;;###autoload
1493 "Move table row down."
1496 ;;;###autoload
1498 "Move table row up."
1502 ;;;###autoload
1504 "Move the current table line down. With arg UP, move it up."
1513 txt hline2p)
1536 ;;;###autoload
1538 "Insert a new row above the current line into the table.
1539 With prefix ARG, insert below the current line."
1545 ;; Fix the first field if necessary
1558 ;;;###autoload
1560 "Insert a horizontal-line below the current line into the table.
1561 With prefix ABOVE, insert above the current line."
1582 ;;;###autoload
1584 "Insert a hline and move to the row below that line."
1598 In particular, this does handle wide and invisible characters."
1600 ;; It's a hline, just map the characters
1606 t t s)))
1607 s))
1609 ;;;###autoload
1611 "Delete the current row or horizontal line from the table."
1625 ;;;###autoload
1627 "Sort table lines according to the column at point.
1629 The position of point indicates the column to be used for
1630 sorting, and the range of lines is the range between the nearest
1631 horizontal separator lines, or the entire table of no such lines
1632 exist. If point is before the first column, you will be prompted
1633 for the sorting column. If there is an active region, the mark
1634 specifies the first line and the sorting column, while point
1635 should be in the last line to be included into the sorting.
1637 The command then prompts for the sorting type which can be
1638 alphabetically, numerically, or by time (as given in a time stamp
1639 in the field). Sorting in reverse order is also possible.
1641 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1643 If SORTING-TYPE is specified when this function is called from a Lisp
1644 program, no prompting will take place. SORTING-TYPE must be a character,
1645 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1646 should be done in reverse order."
1651 beg end bcol ecol tend tbeg column lns pos)
1696 x))
1710 ;;;###autoload
1712 "Copy region in table to the clipboard and blank all relevant fields.
1713 If there is no active region, use just the field at point."
1719 ;;;###autoload
1721 "Copy rectangular region in table to clipboard.
1722 A special clipboard is used which can only be accessed
1723 with `org-table-paste-rectangle'."
1727 current-prefix-arg))
1729 region cols
1755 org-table-clip))
1757 ;;;###autoload
1759 "Paste a rectangular region into a table.
1760 The upper right corner ends up in the current field. All involved fields
1761 will be overwritten. If the rectangle does not fit into the present table,
1762 the table is enlarged as needed. The process ignores horizontal separator
1763 lines."
1773 c cols field)
1788 ;;;###autoload
1790 "Convert from `org-mode' table to table.el and back.
1791 Obviously, this only works within limits. When an Org-mode table is
1792 converted to table.el, all horizontal separator lines get lost, because
1793 table.el uses these as cell boundaries and has no notion of horizontal lines.
1794 A table.el table can be converted to an Org-mode table only if it does not
1795 do row or column spanning. Multiline cells will become multiple cells.
1796 Beware, Org-mode does not test if the table can be successfully converted - it
1797 blindly applies a recipe that works for simple tables."
1801 ;; convert to Org-mode table
1810 ;; convert to table.el table
1813 ;; first, get rid of all horizontal lines
1817 ;; insert a hline before first
1821 ;; insert a hline after each line
1826 ;; replace "+" at beginning and ending of hlines
1835 "Transpose orgmode table at point and eliminate hlines.
1836 So a table like
1838 | 1 | 2 | 4 | 5 |
1839 |---+---+---+---|
1840 | a | b | c | d |
1841 | e | f | g | h |
1843 will be transposed as
1845 | 1 | a | e |
1846 | 2 | b | f |
1847 | 4 | c | g |
1848 | 5 | d | h |
1850 Note that horizontal lines disappeared."
1860 table)))
1867 ;;;###autoload
1869 "Wrap several fields in a column like a paragraph.
1870 This is useful if you'd like to spread the contents of a field over several
1871 lines, in order to keep the table compact.
1873 If there is an active region, and both point and mark are in the same column,
1874 the text in the column is wrapped to minimum width for the given number of
1875 lines. Generally, this makes the table more compact. A prefix ARG may be
1877 formats the selected text to two lines. If the region was longer than two
1878 lines, the remaining lines remain empty. A negative prefix argument reduces
1879 the current number of lines by that amount. The wrapped text is pasted back
1880 into the table. If you formatted it to more lines than it was before, fields
1881 further down in the table get overwritten - so you might need to make space in
1882 the table first.
1884 If there is no region, the current field is split at the cursor position and
1885 the text fragment to the right of the cursor is prepended to the field one
1886 line down.
1888 If there is no region, but you specify a prefix ARG, the current field gets
1889 blank, and the content is appended to the field above."
1893 ;; There is a region: fill as a paragraph
1897 nlines)
1904 arg)
1908 nil nlines)))
1912 ;; No region, split the current field at point
1916 ;; combine with field above
1926 ;; split field
1938 ;;;###autoload
1940 "Edit table field in a different window.
1941 This is mainly useful for fields that contain hidden parts.
1943 it can be edited in place."
1952 display t intangible t))
1965 p)
1981 intangible t))
1989 "Finish editing a table data field.
1990 Remove all newline characters, insert the result into the table, realign
1991 the table and kill the editing buffer."
1995 text)
2012 "Minor mode to make the table field editor window follow the cursor.
2013 When this mode is active, the field editor window will always show the
2014 current field. The mode exits automatically when the cursor leaves the
2015 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2016 nil " TblFollow" nil
2032 ;; We have left the table, exit the follow mode
2042 ;;;###autoload
2044 "Sum numbers in region of current table column.
2045 The result will be displayed in the echo area, and will be available
2048 If there is an active region, it is interpreted as a rectangle and all
2049 numbers in that rectangle will be summed. If there is no active
2050 region and point is located in a table column, sum all numbers in that
2051 column.
2053 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2054 numbers are assumed to be times as well (in decimal hours) and the
2055 numbers are added as such.
2057 If NLAST is a number, only the NLAST fields will actually be summed."
2084 items1)))
2091 s diff)
2099 sres))))
2122 "Return the formula active for the current field.
2123 Assumes that specials are in place.
2124 If KEY is given, return the key to this formula.
2128 org-table-named-field-locations)))
2142 "Read a formula from the minibuffer, offer stored formula as default.
2143 When NAMED is non-nil, look for a named equation."
2147 org-table-named-field-locations)))
2154 name
2155 ref)
2165 stored)
2167 equation)
2174 scol))
2176 'org-table-formula-history
2177 )))))
2178 mustsave)
2180 ;; remove formula
2187 ;; We set the column equation, delete the named one.
2189 mustsave t))
2195 eq))
2198 "Store the list of formulas below the current table."
2205 ;; don't overwrite TBLFM, we might use text properties to store stuff
2221 ;; Fake a high number to make sure this is sorted at the end.
2228 a)
2238 "Compare two formulas for sorting."
2243 ;;;###autoload
2245 "Return an alist with the stored formulas directly after current table."
2254 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2273 "Modify the equations after the table structure has been edited.
2275 For all numbers larger than LIMIT, shift them by DELTA."
2287 s n a)
2293 "Change makes TBLFM term %s invalid, use undo to recover"
2309 "Get the column names and local parameters for this table."
2312 names name fields fields1 field cnt
2313 c v l line col types dlines hlines last-dline)
2315 org-table-local-parameters nil
2316 org-table-named-field-locations nil
2317 org-table-current-begin-line nil
2318 org-table-current-begin-pos nil
2319 org-table-current-line-types nil
2338 org-table-local-parameters))))
2354 ;; Analyse the line types
2358 l org-table-current-begin-line)
2375 al al2)
2385 ;;;###autoload
2388 If yes, store the formula and apply it."
2389 ;; We already know we are in a table. Get field will only return a formula
2390 ;; when appropriate. It might return a separator line, but no problem.
2393 named eq)
2404 "List of commands triggering the recalculation of a line.
2416 ;;;###autoload
2418 "Rotate the recalculation mark in the first column.
2419 If in any row, the first field is not consistent with a mark,
2420 insert a new column for the markers.
2421 When there is an active region, change all the lines in the region,
2422 after prompting for the marking character.
2423 After each change, a message will be displayed indicating the meaning
2424 of the new mark."
2439 epos new)
2446 newchar))
2478 ;;;###autoload
2480 "Recompute the current line if marked for it, and if we haven't just done it."
2500 org-tbl-calc-modes)
2502 ;;;###autoload
2504 suppress-align suppress-const
2505 suppress-store suppress-analysis)
2506 "Replace the table field value at the cursor by the result of a calculation.
2508 This function makes use of Dave Gillespie's Calc package, in my view the
2509 most exciting program ever written for GNU Emacs. So you need to have Calc
2510 installed in order to use this function.
2512 In a table, this command replaces the value in the current field with the
2514 formula, by storing it in a special line below the table. When called
2515 with a `C-u' prefix, the current field must be a named field, and the
2516 formula is installed as valid in only this specific field.
2518 When called with two `C-u' prefixes, insert the active equation
2519 for the field back into the current field, so that it can be
2521 to check the referenced fields.
2523 When called, the command first prompts for a formula, which is read in
2524 the minibuffer. Previously entered formulas are available through the
2525 history list, and the last used formula is offered as a default.
2526 These stored formulas are adapted correctly when moving, inserting, or
2527 deleting columns with the corresponding commands.
2529 The formula can be any algebraic expression understood by the Calc package.
2530 For details, see the Org-mode manual.
2532 This function can also be called from Lisp programs and offers
2533 additional arguments: EQUATION can be the formula to apply. If this
2534 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2535 used to speed-up recursive calls by by-passing unnecessary aligns.
2536 SUPPRESS-CONST suppresses the interpretation of constants in the
2537 formula, assuming that this has been done already outside the function.
2538 SUPPRESS-STORE means the formula should not be stored, either because
2539 it is already stored, or because it is a modified equation that should
2540 not overwrite the stored one."
2556 equation
2562 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2563 duration duration-output-format)
2564 ;; Parse the format string. Since we have a lot of modes, this is
2565 ;; a lot of work. However, I think calc still uses most of the time.
2578 'calc-float-format
2581 n))))
2585 duration-output-format nil
2589 duration-output-format org-table-duration-custom-format
2590 numbers t
2613 ;; replace fields with duration values if relevant
2617 fields)))
2623 x))
2624 fields)))
2630 ;; Insert row and column number of formula result field
2641 t t form)))
2643 ;; Check for old vertical references
2645 ;; Insert remote references
2657 rmtrng))
2658 keep-empty numbers lispp))
2659 t t form)))
2660 ;; Insert complex ranges
2668 ;; possibly handle durations
2673 formrg)
2674 keep-empty numbers lispp)))
2679 ;; Insert simple ranges
2688 keep-empty numbers lispp))
2689 t t form)))
2691 ;; Insert the references to fields in same row
2701 x keep-empty numbers lispp))
2702 t t form)))
2714 ;; Use <...> time-stamps so that Calc can handle them
2716 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2727 form
2734 duration-output-format)
2735 ev)))
2740 Orig: %s
2741 $xyz-> %s
2742 @r$c-> %s
2774 prop value)))
2777 "Get a calc vector from a column, according to descriptor DESC.
2778 Optional arguments TBEG and COL can give the beginning of the table and
2779 the current column, to avoid unnecessary parsing.
2781 HIGHLIGHT means just highlight the range.
2783 When CORNERS-ONLY is set, only return the corners of the range as
2784 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2785 in the buffer and column1 and column2 are table column numbers."
2792 beg end c1 c2 r1 r2 rangep tmp)
2809 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2816 ;; just one field
2823 ;; A range, return a vector
2824 ;; First sort the numbers to get a regular rectangle
2828 ;; Only return the corners of the range
2830 ;; Copy the range values into a list
2844 ;; return string representation of calc vector
2849 "Analyze descriptor DESC and retrieve the corresponding line number.
2850 The cursor is currently in line CLINE, the table begins in line BLINE,
2851 and TABLE is a vector with line types."
2859 ;; 1 2 3 4 5 6
2879 nil hn cline desc)))
2882 rel on cline desc)))
2886 "FIXME: Needs more documentation."
2899 nil))
2900 t)))
2904 desc cline)
2905 i)))
2910 s))
2913 "Convert list ELEMENTS to something appropriate to insert into formula.
2914 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2915 NUMBERS indicates that everything should be converted to numbers.
2916 LISPP non-nil means to return something appropriate for a Lisp
2917 list, 'literal is for the format specifier L."
2918 ;; Calc nan (not a number) is used for the conversion of the empty
2919 ;; field to a reference for several reasons: (i) It is accepted in a
2920 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2921 ;; (ii) In a single field (not in range) it can be distinguished
2922 ;; from "(nan)" which is the reference made from a single field
2923 ;; containing "nan".
2925 ;; field reference
2928 elements
2930 ""
2939 ;; range reference
2944 elements))))
2950 x
2958 x)
2960 elements
2963 ;;;###autoload
2965 "Set `org-table-formula-constants-local' in the current buffer."
2981 ;;;###autoload
2983 "Recalculate the current table line by applying all stored formulas.
2984 With prefix arg ALL, do this for all lines in the table.
2985 With the prefix argument ALL is `(16)' \
2987 it is the symbol `iterate', recompute the table until it no longer changes.
2988 If NOALIGN is not nil, do not re-align the table after the computations
2989 are done. This is typically used internally to save time, if it is
2990 known that the table will be realigned a little later anyway."
3005 seen-fields lhs1
3007 ;; Insert constants in all formulas
3023 eqlist))
3024 ;; Split the equation list
3030 ;; Expand ranges in lhs of formulas
3033 ;; Get the correct line range to process
3039 ;; This is a table with marked lines, compute selected lines
3041 ;; Move forward to the first non-header line
3052 ;; First find the named fields, and mark them untouchable.
3053 ;; Also check if several field/range formulas try to set the same field.
3072 name)))
3082 ;; Now evaluate the column formulas, but skip fields covered by
3083 ;; field formulas
3087 ;; Unprotected line, recalculate
3099 ;; Now evaluate the field formulas
3113 ;; back to initial position
3120 ;;;###autoload
3122 "Recalculate the table until it does not change anymore.
3123 The maximum number of iterations is 10, but you can choose a different value
3124 with the prefix ARG."
3129 thistbl)
3143 ;;;###autoload
3145 "Recalculate all tables in the current buffer."
3152 ;;;###autoload
3154 "Iterate all tables in the buffer, to converge inter-table dependencies."
3159 c1)
3175 "Apply the #+TBLFM in the line at point to the table."
3181 s e)
3183 ;; Insert a temporary formula at right after the table
3188 ;; Recalculate the table
3194 ;; delete the formula inserted temporarily
3198 "Find the beginning of the TBLFM lines and return its position.
3199 Return nil when the beginning of TBLFM line was not found."
3203 org-table-TBLFM-begin-regexp
3204 nil t))
3208 "Expand list of formulas.
3209 If some of the RHS in the formulas are ranges or a row reference, expand
3210 them to individual field equations for each field."
3216 ;; This just refers to one fixed field
3219 ;; This just refers to one fixed named field
3241 "Replace @<, @>, $<, $> with first/last row/column of the table.
3242 So @< and $< will always be replaced with @1 and $1, respectively.
3243 The advantage of these special markers are that structure editing of
3244 the table will not change them, while @1 and $1 will be modified
3245 when a line/row is swapped out of that privileged position. So for
3246 formulas that use a range of rows or columns, it may often be better
3248 borders of the table using the @< @> $< $> makers."
3251 s start)
3256 org-table-current-ncol)
3260 len
3267 s)
3270 "Replace $const with values in string F."
3272 ;; First, check for column names
3277 ;; Parameters and constants
3279 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3289 f))
3292 "Find the value for a parameter or constant in a formula.
3293 Parameters get priority."
3324 map))
3331 "--"
3334 "--"
3335 "Shift Reference at Point"
3340 "-"
3341 "Change Test Row for Column Formulas"
3344 "--"
3349 org-table-overlay-coordinates)]
3350 "--"
3356 ;;;###autoload
3358 "Edit the formulas of the current table in a separate buffer."
3360 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3374 entry s type title)
3377 ;; Keep global-font-lock-mode from turning on font-lock-mode
3418 "Convert a formula from internal to user representation."
3421 s))
3424 "Convert a formula from user to internal representation."
3427 s))
3430 "Convert spreadsheet references from A7 to @7$28.
3431 Works for single references, but also for entire formulas and even the
3432 full TBLFM line."
3434 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3437 ;; format match, just advance
3442 ;; 3.e5 or something like this.
3445 ;; (member (match-string 1 s)
3446 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3447 )
3448 ;; function name, just advance
3458 t t s)))))
3459 s))
3462 "Convert spreadsheet references from to @7$28 to AB7.
3463 Works for single references, but also for entire formulas and even the
3464 full TBLFM line."
3471 t t s)))
3476 t nil s)))
3477 s)
3480 "Convert a base 26 number represented by letters into an integer.
3481 For example: AB -> 28."
3487 n))
3490 "Convert an integer into a base 26 number represented by letters.
3491 For example: 28 -> AB."
3496 s))
3499 "Convert a time string into numerical duration in seconds.
3500 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3501 If S is a string representing a number, keep this number."
3503 s
3526 "Convert a number of seconds to a time string.
3527 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3528 minutes or seconds."
3543 "Convert all references in this buffer, using FUNCTION."
3553 "Convert all references in the buffer from B3 to @3$2 and back."
3563 "Shift the reference at point one row/hline up."
3567 "Shift the reference at point one row/hline down."
3571 "Shift the reference at point one field to the left."
3575 "Shift the reference at point one field to the right."
3586 ;; A B3-like reference
3592 ;; An internal reference
3598 "Re-match the group N, and replace it with the shifted reference."
3603 t t)))
3606 "Shift a reference part REF.
3607 If DECR is set, decrease the references row/column, else increase.
3608 If HLINE is set, this may be a hline reference, it certainly is not
3609 a translation reference."
3638 "Toggle the display of coordinates in the referenced table."
3647 "Parse the buffer for formula definitions and install them.
3648 With prefix ARG, apply the new formulas to the table."
3658 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3659 nil t)
3683 "Abort editing formulas, without installing the changes."
3694 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3735 "Show the location/value of the $ expression at point."
3744 var name e what match dest)
3749 "$1.."
3832 ;; column number
3860 org-table-fedit-scroll-down))))
3871 "Make sure the cursor is in a dataline in a table."
3880 p1 p2)))
3885 "Move cursor one line up in the window showing the table."
3890 "Move cursor one line down in the window showing the table."
3895 "Move the cursor in the window showing the table.
3896 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3921 "Add a new overlay."
3927 "Highlight rectangular region in a table."
3931 l1 c1 l2 c2 tmp)
3955 "Remove the rectangle overlays."
3966 "Add overlays to the table at point, to show row/column coordinates."
3994 ;;;###autoload
3996 "Toggle the display of Row/Column numbers in tables."
4007 ;;;###autoload
4009 "Toggle the formula debugger in tables."
4015 ;;; The orgtbl minor mode
4017 ;; Define a minor mode which can be used in other modes in order to
4018 ;; integrate the org-mode table editor.
4020 ;; This is really a hack, because the org-mode table editor uses several
4021 ;; keys which normally belong to the major mode, for example the TAB and
4022 ;; RET keys. Here is how it works: The minor mode defines all the keys
4023 ;; necessary to operate the table editor, but wraps the commands into a
4024 ;; function which tests if the cursor is currently inside a table. If that
4025 ;; is the case, the table editor command is executed. However, when any of
4026 ;; those keys is used outside a table, the function uses `key-binding' to
4027 ;; look up if the key has an associated command in another currently active
4028 ;; keymap (minor modes, major mode, global), and executes that command.
4029 ;; There might be problems if any of the keys used by the table editor is
4030 ;; otherwise used as a prefix key.
4032 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4033 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4034 ;; addresses this by checking explicitly for both bindings.
4036 ;; The optimized version (see variable `orgtbl-optimized') takes over
4037 ;; all keys which are bound to `self-insert-command' in the *global map*.
4038 ;; Some modes bind other commands to simple characters, for example
4039 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4040 ;; active, this binding is ignored inside tables and replaced with a
4041 ;; modified self-insert.
4059 ;; Install it as a minor mode.
4063 ;;;###autoload
4065 "The `org-mode' table editor as a minor mode for use in other modes."
4070 ;; Exit without error, in case some hook functions calls this
4071 ;; by accident in org-mode.
4075 ;; Make sure we are first in minor-mode-map-alist
4077 ;; FIXME: maybe it should use emulation-mode-map-alists?
4084 auto-fill-inhibit-regexp)
4088 auto-fill-inhibit-regexp)
4089 orgtbl-line-start-regexp))
4107 "Remove all properties related to narrow-column invisibility."
4120 "Create a function for binding in the table minor mode.
4121 FUN is the command to call inside a table. N is used to create a unique
4122 command name. KEYS are keys that should be checked in for a command
4123 to execute outside of tables."
4129 "Outside of tables, run the binding of `"
4141 keys)
4145 "Error when there is no default binding for a table key."
4150 "Setup orgtbl keymaps."
4181 elt key fun cmd)
4189 ;; Special treatment needed for TAB and RET
4209 [(tab)] "\C-i")))
4211 (org-defkey orgtbl-mode-map [backtab]
4213 [backtab] [S-iso-lefttab] [(shift tab)]
4214 [(tab)] "\C-i"))
4216 (org-defkey orgtbl-mode-map "\M-\C-m"
4217 (orgtbl-make-binding 'org-table-wrap-region 105
4218 "\M-\C-m" [(meta return)]))
4219 (org-defkey orgtbl-mode-map [(meta return)]
4220 (orgtbl-make-binding 'org-table-wrap-region 106
4221 [(meta return)] "\M-\C-m"))
4223 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4224 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4226 (when orgtbl-optimized
4227 ;; If the user wants maximum table support, we need to hijack
4228 ;; some standard editing functions
4229 (org-remap orgtbl-mode-map
4230 'self-insert-command 'orgtbl-self-insert-command
4231 'delete-char 'org-delete-char
4232 'delete-backward-char 'org-delete-backward-char)
4233 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4234 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4235 '("OrgTbl"
4236 ["Create or convert" org-table-create-or-convert-from-region
4237 :active (not (org-at-table-p)) :keys "C-c |" ]
4238 "--"
4239 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4240 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4241 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4242 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4243 "--"
4244 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4245 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4246 ["Copy Field from Above"
4247 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4248 "--"
4249 ("Column"
4250 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4251 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4252 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4253 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4254 ("Row"
4255 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4256 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4257 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4258 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4259 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4260 "--"
4261 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4262 ("Rectangle"
4263 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4264 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4265 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4266 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4267 "--"
4268 ("Radio tables"
4269 ["Insert table template" orgtbl-insert-radio-table
4270 (assq major-mode orgtbl-radio-table-templates)]
4271 ["Comment/uncomment table" orgtbl-toggle-comment t])
4272 "--"
4273 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4274 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4275 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4276 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4277 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4278 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4279 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4280 ["Sum Column/Rectangle" org-table-sum
4281 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4282 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4283 ["Debug Formulas"
4284 org-table-toggle-formula-debugger :active (org-at-table-p)
4285 :keys "C-c {"
4286 :style toggle :selected org-table-formula-debug]
4287 ["Show Col/Row Numbers"
4288 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4289 :keys "C-c }"
4290 :style toggle :selected org-table-overlay-coordinates]
4291 ))
4292 t))
4294 (defun orgtbl-ctrl-c-ctrl-c (arg)
4295 "If the cursor is inside a table, realign the table.
4296 If it is a table to be sent away to a receiver, do it.
4297 With prefix arg, also recompute table."
4298 (interactive "P")
4299 (let ((case-fold-search t) (pos (point)) action)
4300 (save-excursion
4301 (beginning-of-line 1)
4302 (setq action (cond
4306 (cond
4307 ((integerp action)
4308 (goto-char action)
4309 (org-table-maybe-eval-formula)
4310 (if arg
4311 (call-interactively 'org-table-recalculate)
4312 (org-table-maybe-recalculate-line))
4313 (call-interactively 'org-table-align)
4314 (when (orgtbl-send-table 'maybe)
4315 (run-hooks 'orgtbl-after-send-table-hook)))
4316 ((eq action 'recalc)
4317 (org-table-set-constants)
4318 (save-excursion
4319 (beginning-of-line 1)
4321 (if (org-at-table-p)
4322 (org-call-with-arg 'org-table-recalculate t))))
4323 (t (let (orgtbl-mode)
4324 (call-interactively (key-binding "\C-c\C-c")))))))
4326 (defun orgtbl-create-or-convert-from-region (arg)
4327 "Create table or convert region to table, if no conflicting binding.
4328 This installs the table binding `C-c |', but only if there is no
4329 conflicting binding to this key outside orgtbl-mode."
4330 (interactive "P")
4331 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4332 (if cmd
4333 (call-interactively cmd)
4334 (call-interactively 'org-table-create-or-convert-from-region))))
4336 (defun orgtbl-tab (arg)
4337 "Justification and field motion for `orgtbl-mode'."
4338 (interactive "P")
4339 (if arg (org-table-edit-field t)
4340 (org-table-justify-field-maybe)
4341 (org-table-next-field)))
4343 (defun orgtbl-ret ()
4344 "Justification and field motion for `orgtbl-mode'."
4345 (interactive)
4346 (if (bobp)
4347 (newline)
4348 (org-table-justify-field-maybe)
4349 (org-table-next-row)))
4351 (defun orgtbl-self-insert-command (N)
4352 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4353 If the cursor is in a table looking at whitespace, the whitespace is
4354 overwritten, and the table is not marked as requiring realignment."
4355 (interactive "p")
4356 (if (and (org-at-table-p)
4357 (or
4358 (and org-table-auto-blank-field
4359 (member last-command
4360 '(orgtbl-hijacker-command-100
4361 orgtbl-hijacker-command-101
4362 orgtbl-hijacker-command-102
4363 orgtbl-hijacker-command-103
4364 orgtbl-hijacker-command-104
4365 orgtbl-hijacker-command-105
4366 yas/expand))
4367 (org-table-blank-field))
4368 t)
4369 (eq N 1)
4371 (let (org-table-may-need-update)
4372 (goto-char (1- (match-end 0)))
4373 (org-delete-backward-char 1)
4374 (goto-char (match-beginning 0))
4375 (self-insert-command N))
4376 (setq org-table-may-need-update t)
4377 (let* (orgtbl-mode
4378 a
4379 (cmd (or (key-binding
4380 (or (and (listp function-key-map)
4381 (setq a (assoc last-input-event function-key-map))
4382 (cdr a))
4383 (vector last-input-event)))
4384 'self-insert-command)))
4385 (call-interactively cmd)
4386 (if (and org-self-insert-cluster-for-undo
4387 (eq cmd 'self-insert-command))
4388 (if (not (eq last-command 'orgtbl-self-insert-command))
4389 (setq org-self-insert-command-undo-counter 1)
4390 (if (>= org-self-insert-command-undo-counter 20)
4391 (setq org-self-insert-command-undo-counter 1)
4392 (and (> org-self-insert-command-undo-counter 0)
4393 buffer-undo-list
4394 (not (cadr buffer-undo-list)) ; remove nil entry
4395 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4396 (setq org-self-insert-command-undo-counter
4397 (1+ org-self-insert-command-undo-counter))))))))
4400 "Regular expression matching exponentials as produced by calc.")
4402 (defun orgtbl-gather-send-defs ()
4403 "Gather a plist of :name, :transform, :params for each destination before
4404 a radio table."
4405 (save-excursion
4406 (goto-char (org-table-begin))
4407 (let (rtn)
4408 (beginning-of-line 0)
4409 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4410 (let ((name (org-no-properties (match-string 1)))
4411 (transform (intern (match-string 2)))
4412 (params (if (match-end 3)
4413 (read (concat "(" (match-string 3) ")")))))
4414 (push (list :name name :transform transform :params params)
4415 rtn)
4416 (beginning-of-line 0)))
4417 rtn)))
4419 (defun orgtbl-send-replace-tbl (name txt)
4420 "Find and replace table NAME with TXT."
4421 (save-excursion
4422 (goto-char (point-min))
4423 (unless (re-search-forward
4425 (user-error "Don't know where to insert translated table"))
4426 (goto-char (match-beginning 0))
4427 (beginning-of-line 2)
4428 (save-excursion
4429 (let ((beg (point)))
4430 (unless (re-search-forward
4431 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4432 (user-error "Cannot find end of insertion region"))
4433 (beginning-of-line 1)
4434 (delete-region beg (point))))
4437 ;;;###autoload
4438 (defun org-table-to-lisp (&optional txt)
4439 "Convert the table at point to a Lisp structure.
4440 The structure will be a list. Each item is either the symbol `hline'
4441 for a horizontal separator line, or a list of field values as strings.
4442 The table is taken from the parameter TXT, or from the buffer at point."
4443 (unless txt
4444 (unless (org-at-table-p)
4445 (user-error "No table at point")))
4446 (let* ((txt (or txt
4447 (buffer-substring-no-properties (org-table-begin)
4448 (org-table-end))))
4451 (mapcar
4452 (lambda (x)
4453 (if (string-match org-table-hline-regexp x)
4454 'hline
4456 lines)))
4458 (defun orgtbl-send-table (&optional maybe)
4459 "Send a transformed version of this table to the receiver position.
4460 With argument MAYBE, fail quietly if no transformation is defined for
4461 this table."
4462 (interactive)
4463 (catch 'exit
4464 (unless (org-at-table-p) (user-error "Not at a table"))
4465 ;; when non-interactive, we assume align has just happened.
4466 (when (org-called-interactively-p 'any) (org-table-align))
4467 (let ((dests (orgtbl-gather-send-defs))
4468 (txt (buffer-substring-no-properties (org-table-begin)
4469 (org-table-end)))
4470 (ntbl 0))
4471 (unless dests (if maybe (throw 'exit nil)
4472 (user-error "Don't know how to transform this table")))
4473 (dolist (dest dests)
4474 (let* ((name (plist-get dest :name))
4475 (transform (plist-get dest :transform))
4476 (params (plist-get dest :params))
4477 (skip (plist-get params :skip))
4478 (skipcols (plist-get params :skipcols))
4479 (no-escape (plist-get params :no-escape))
4480 beg
4481 (lines (org-table-clean-before-export
4482 (nthcdr (or skip 0)
4484 (i0 (if org-table-clean-did-remove-column 2 1))
4485 (lines (if no-escape lines
4486 (mapcar (lambda(l) (replace-regexp-in-string
4488 (table (mapcar
4489 (lambda (x)
4490 (if (string-match org-table-hline-regexp x)
4491 'hline
4492 (org-remove-by-index
4494 skipcols i0)))
4495 lines))
4496 (fun (if (= i0 2) 'cdr 'identity))
4497 (org-table-last-alignment
4498 (org-remove-by-index (funcall fun org-table-last-alignment)
4499 skipcols i0))
4500 (org-table-last-column-widths
4501 (org-remove-by-index (funcall fun org-table-last-column-widths)
4502 skipcols i0))
4503 (txt (if (fboundp transform)
4504 (funcall transform table params)
4505 (user-error "No such transformation function %s" transform))))
4506 (orgtbl-send-replace-tbl name txt))
4507 (setq ntbl (1+ ntbl)))
4508 (message "Table converted and installed at %d receiver location%s"
4509 ntbl (if (> ntbl 1) "s" ""))
4510 (if (> ntbl 0)
4511 ntbl
4512 nil))))
4514 (defun org-remove-by-index (list indices &optional i0)
4515 "Remove the elements in LIST with indices in INDICES.
4516 First element has index 0, or I0 if given."
4517 (if (not indices)
4518 list
4519 (if (integerp indices) (setq indices (list indices)))
4520 (setq i0 (1- (or i0 0)))
4521 (delq :rm (mapcar (lambda (x)
4522 (setq i0 (1+ i0))
4523 (if (memq i0 indices) :rm x))
4524 list))))
4526 (defun orgtbl-toggle-comment ()
4527 "Comment or uncomment the orgtbl at point."
4528 (interactive)
4529 (let* ((case-fold-search t)
4530 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4531 (re2 (concat "^" orgtbl-line-start-regexp))
4532 (commented (save-excursion (beginning-of-line 1)
4533 (cond ((looking-at re1) t)
4534 ((looking-at re2) nil)
4535 (t (user-error "Not at an org table")))))
4536 (re (if commented re1 re2))
4537 beg end)
4538 (save-excursion
4539 (beginning-of-line 1)
4540 (while (looking-at re) (beginning-of-line 0))
4541 (beginning-of-line 2)
4542 (setq beg (point))
4543 (while (looking-at re) (beginning-of-line 2))
4544 (setq end (point)))
4545 (comment-region beg end (if commented '(4) nil))))
4547 (defun orgtbl-insert-radio-table ()
4548 "Insert a radio table template appropriate for this major mode."
4549 (interactive)
4550 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4551 (txt (nth 1 e))
4552 name pos)
4553 (unless e (user-error "No radio table setup defined for %s" major-mode))
4554 (setq name (read-string "Table name: "))
4555 (while (string-match "%n" txt)
4556 (setq txt (replace-match name t t txt)))
4558 (setq pos (point))
4559 (insert txt)
4560 (goto-char pos)))
4562 ;; Dynamically bound input and output for table formatting.
4563 (defvar *orgtbl-table* nil
4564 "Carries the current table through formatting routines.")
4565 (defvar *orgtbl-rtn* nil
4566 "Formatting routines push the output lines here.")
4567 ;; Formatting parameters for the current table section.
4568 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4569 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4570 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4571 (defvar *orgtbl-fmt* nil "Format for each entry.")
4572 (defvar *orgtbl-efmt* nil "Format for numbers.")
4573 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4574 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4575 (defvar *orgtbl-lstart* nil "Text starting a row.")
4576 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4577 (defvar *orgtbl-lend* nil "Text ending a row.")
4578 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4580 (defsubst orgtbl-get-fmt (fmt i)
4581 "Retrieve the format from FMT corresponding to the Ith column."
4582 (if (and (not (functionp fmt)) (consp fmt))
4583 (plist-get fmt i)
4584 fmt))
4586 (defsubst orgtbl-apply-fmt (fmt &rest args)
4587 "Apply format FMT to arguments ARGS.
4588 When FMT is nil, return the first argument from ARGS."
4589 (cond ((functionp fmt) (apply fmt args))
4590 (fmt (apply 'format fmt args))
4591 (args (car args))
4592 (t args)))
4594 (defsubst orgtbl-eval-str (str)
4595 "If STR is a function, evaluate it with no arguments."
4596 (if (functionp str)
4597 (funcall str)
4598 str))
4600 (defun orgtbl-format-line (line)
4601 "Format LINE as a table row."
4602 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4603 (let* ((i 0)
4604 (line
4605 (mapcar
4606 (lambda (f)
4607 (setq i (1+ i))
4608 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4609 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4610 (orgtbl-apply-fmt efmt (match-string 1 f)
4611 (match-string 2 f))
4612 f)))
4613 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4614 *orgtbl-default-fmt*)
4615 f)))
4616 line)))
4617 (push (if *orgtbl-lfmt*
4618 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4619 (concat (orgtbl-eval-str *orgtbl-lstart*)
4620 (mapconcat 'identity line *orgtbl-sep*)
4621 (orgtbl-eval-str *orgtbl-lend*)))
4622 *orgtbl-rtn*))))
4624 (defun orgtbl-format-section (section-stopper)
4625 "Format lines until the first occurrence of SECTION-STOPPER."
4626 (let (prevline)
4627 (progn
4628 (while (not (eq (car *orgtbl-table*) section-stopper))
4629 (if prevline (orgtbl-format-line prevline))
4630 (setq prevline (pop *orgtbl-table*)))
4631 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4632 (*orgtbl-lend* *orgtbl-llend*)
4633 (*orgtbl-lfmt* *orgtbl-llfmt*))
4634 (orgtbl-format-line prevline))))))
4636 ;;;###autoload
4637 (defun orgtbl-to-generic (table params &optional backend)
4638 "Convert the orgtbl-mode TABLE to some other format.
4639 This generic routine can be used for many standard cases.
4640 TABLE is a list, each entry either the symbol `hline' for a horizontal
4641 separator line, or a list of fields for that line.
4642 PARAMS is a property list of parameters that can influence the conversion.
4643 A third optional argument BACKEND can be used to convert the content of
4644 the cells using a specific export back-end.
4646 For the generic converter, some parameters are obligatory: you need to
4647 specify either :lfmt, or all of (:lstart :lend :sep).
4649 Valid parameters are:
4651 :splice When set to t, return only table body lines, don't wrap
4652 them into :tstart and :tend. Default is nil. When :splice
4653 is non-nil, this also means that the exporter should not look
4654 for and interpret header and footer sections.
4656 :hline String to be inserted on horizontal separation lines.
4657 May be nil to ignore hlines.
4659 :sep Separator between two fields
4660 :remove-nil-lines Do not include lines that evaluate to nil.
4662 Each in the following group may be either a string or a function
4663 of no arguments returning a string:
4665 :tstart String to start the table. Ignored when :splice is t.
4666 :tend String to end the table. Ignored when :splice is t.
4667 :lstart String to start a new table line.
4668 :llstart String to start the last table line, defaults to :lstart.
4669 :lend String to end a table line
4670 :llend String to end the last table line, defaults to :lend.
4672 Each in the following group may be a string, a function of one
4673 argument (the field or line) returning a string, or a plist
4674 mapping columns to either of the above:
4676 :lfmt Format for entire line, with enough %s to capture all fields.
4677 If this is present, :lstart, :lend, and :sep are ignored.
4678 :llfmt Format for the entire last line, defaults to :lfmt.
4679 :fmt A format to be used to wrap the field, should contain
4680 %s for the original field value. For example, to wrap
4682 This may also be a property list with column numbers and
4684 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4685 Same as above, specific for the header lines in the table.
4686 All lines before the first hline are treated as header.
4687 If any of these is not present, the data line value is used.
4689 This may be either a string or a function of two arguments:
4691 :efmt Use this format to print numbers with exponentials.
4692 The format should have %s twice for inserting mantissa
4694 may also be a property list with column numbers and
4695 formats. :fmt will still be applied after :efmt.
4697 In addition to this, the parameters :skip and :skipcols are always handled
4698 directly by `orgtbl-send-table'. See manual."
4699 (let* ((splicep (plist-get params :splice))
4700 (hline (plist-get params :hline))
4701 (skipheadrule (plist-get params :skipheadrule))
4702 (remove-nil-linesp (plist-get params :remove-nil-lines))
4703 (remove-newlines (plist-get params :remove-newlines))
4704 (*orgtbl-hline* hline)
4705 (*orgtbl-table* table)
4706 (*orgtbl-sep* (plist-get params :sep))
4707 (*orgtbl-efmt* (plist-get params :efmt))
4708 (*orgtbl-lstart* (plist-get params :lstart))
4709 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4710 (*orgtbl-lend* (plist-get params :lend))
4711 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4712 (*orgtbl-lfmt* (plist-get params :lfmt))
4713 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4714 (*orgtbl-fmt* (plist-get params :fmt))
4715 *orgtbl-rtn*)
4716 ;; Convert cells content to backend BACKEND
4717 (when backend
4718 (setq *orgtbl-table*
4719 (mapcar
4720 (lambda(r)
4721 (if (listp r)
4722 (mapcar
4723 (lambda (c)
4724 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4725 r)
4726 r))
4727 *orgtbl-table*)))
4728 ;; Put header
4729 (unless splicep
4730 (when (plist-member params :tstart)
4731 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4732 (if tstart (push tstart *orgtbl-rtn*)))))
4733 ;; If we have a heading, format it and handle the trailing hline.
4734 (if (and (not splicep)
4735 (or (consp (car *orgtbl-table*))
4736 (consp (nth 1 *orgtbl-table*)))
4737 (memq 'hline (cdr *orgtbl-table*)))
4738 (progn
4739 (when (eq 'hline (car *orgtbl-table*))
4740 ;; There is a hline before the first data line
4741 (and hline (push hline *orgtbl-rtn*))
4742 (pop *orgtbl-table*))
4743 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4744 *orgtbl-lstart*))
4745 (*orgtbl-llstart* (or (plist-get params :hllstart)
4746 *orgtbl-llstart*))
4747 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4748 (*orgtbl-llend* (or (plist-get params :hllend)
4749 (plist-get params :hlend) *orgtbl-llend*))
4750 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4751 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4752 (plist-get params :hlfmt) *orgtbl-llfmt*))
4753 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4754 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4755 (orgtbl-format-section 'hline))
4756 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4757 (pop *orgtbl-table*)))
4758 ;; Now format the main section.
4759 (orgtbl-format-section nil)
4760 (unless splicep
4761 (when (plist-member params :tend)
4762 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4763 (if tend (push tend *orgtbl-rtn*)))))
4764 (mapconcat (if remove-newlines
4765 (lambda (tend)
4767 'identity)
4768 (nreverse (if remove-nil-linesp
4769 (remq nil *orgtbl-rtn*)
4772 ;;;###autoload
4773 (defun orgtbl-to-tsv (table params)
4774 "Convert the orgtbl-mode table to TAB separated material."
4776 ;;;###autoload
4777 (defun orgtbl-to-csv (table params)
4778 "Convert the orgtbl-mode table to CSV material.
4779 This does take care of the proper quoting of fields with comma or quotes."
4780 (orgtbl-to-generic table (org-combine-plists
4781 '(:sep "," :fmt org-quote-csv-field)
4782 params)))
4784 ;;;###autoload
4785 (defun orgtbl-to-latex (table params)
4786 "Convert the orgtbl-mode TABLE to LaTeX.
4787 TABLE is a list, each entry either the symbol `hline' for a horizontal
4788 separator line, or a list of fields for that line.
4789 PARAMS is a property list of parameters that can influence the conversion.
4790 Supports all parameters from `orgtbl-to-generic'. Most important for
4791 LaTeX are:
4793 :splice When set to t, return only table body lines, don't wrap
4794 them into a tabular environment. Default is nil.
4796 :fmt A format to be used to wrap the field, should contain %s for the
4797 original field value. For example, to wrap everything in dollars,
4800 The format may also be a function that formats its one argument.
4802 :efmt Format for transforming numbers with exponentials. The format
4803 should have %s twice for inserting mantissa and exponent, for
4805 This may also be a property list with column numbers and formats.
4806 The format may also be a function that formats its two arguments.
4808 :llend If you find too much space below the last line of a table,
4811 The general parameters :skip and :skipcols have already been applied when
4812 this function is called."
4813 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4814 org-table-last-alignment ""))
4815 (params2
4816 (list
4821 (require 'ox-latex)
4822 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4824 ;;;###autoload
4825 (defun orgtbl-to-html (table params)
4826 "Convert the orgtbl-mode TABLE to HTML.
4827 TABLE is a list, each entry either the symbol `hline' for a horizontal
4828 separator line, or a list of fields for that line.
4829 PARAMS is a property list of parameters that can influence the conversion.
4830 Currently this function recognizes the following parameters:
4832 :splice When set to t, return only table body lines, don't wrap
4833 them into a <table> environment. Default is nil.
4835 The general parameters :skip and :skipcols have already been applied when
4836 this function is called. The function does *not* use `orgtbl-to-generic',
4837 so you cannot specify parameters for it."
4838 (require 'ox-html)
4839 (let ((output (org-export-string-as
4840 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4841 (if (not (plist-get params :splice)) output
4842 (org-trim
4843 (replace-regexp-in-string
4847 ;;;###autoload
4848 (defun orgtbl-to-texinfo (table params)
4849 "Convert the orgtbl-mode TABLE to TeXInfo.
4850 TABLE is a list, each entry either the symbol `hline' for a horizontal
4851 separator line, or a list of fields for that line.
4852 PARAMS is a property list of parameters that can influence the conversion.
4853 Supports all parameters from `orgtbl-to-generic'. Most important for
4854 TeXInfo are:
4856 :splice nil/t When set to t, return only table body lines, don't wrap
4857 them into a multitable environment. Default is nil.
4859 :fmt fmt A format to be used to wrap the field, should contain
4860 %s for the original field value. For example, to wrap
4862 This may also be a property list with column numbers and
4864 Each format also may be a function that formats its one
4865 argument.
4868 are computed automatically from the width of the columns
4869 under org-mode.
4871 The general parameters :skip and :skipcols have already been applied when
4872 this function is called."
4873 (let* ((total (float (apply '+ org-table-last-column-widths)))
4874 (colfrac (or (plist-get params :cf)
4875 (mapconcat
4876 (lambda (x) (format "%.3f" (/ (float x) total)))
4877 org-table-last-column-widths " ")))
4878 (params2
4879 (list
4880 :tstart (concat "@multitable @columnfractions " colfrac)
4881 :tend "@end multitable"
4882 :lstart "@item " :lend "" :sep " @tab "
4883 :hlstart "@headitem ")))
4884 (require 'ox-texinfo)
4885 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4887 ;;;###autoload
4888 (defun orgtbl-to-orgtbl (table params)
4889 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4890 Useful when slicing one table into many. The :hline, :sep,
4891 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4892 and :tend suppress strings without splicing; they can be set to
4893 provide ORGTBL directives for the generated table."
4894 (let* ((params2
4895 (list
4896 :remove-newlines t
4897 :tstart nil :tend nil
4898 :hline "|---"
4899 :sep " | "
4900 :lstart "| "
4901 :lend " |"))
4902 (params (org-combine-plists params2 params)))
4903 (with-temp-buffer
4904 (insert (orgtbl-to-generic table params))
4905 (goto-char (point-min))
4906 (while (re-search-forward org-table-hline-regexp nil t)
4907 (org-table-align))
4908 (buffer-substring 1 (buffer-size)))))
4910 (defun orgtbl-to-table.el (table params)
4911 "Convert the orgtbl-mode TABLE into a table.el table."
4912 (with-temp-buffer
4913 (insert (orgtbl-to-orgtbl table params))
4914 (org-table-align)
4915 (replace-regexp-in-string
4916 "-|" "-+"
4917 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4919 (defun orgtbl-to-unicode (table params)
4920 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4921 You need the ascii-art-to-unicode.el package for this. You can download
4922 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4923 (with-temp-buffer
4924 (insert (orgtbl-to-table.el table params))
4925 (goto-char (point-min))
4926 (if (or (featurep 'ascii-art-to-unicode)
4927 (require 'ascii-art-to-unicode nil t))
4928 (aa2u)
4929 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4930 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4931 "Link to ascii-art-to-unicode.el") org-stored-links))
4932 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4933 (buffer-string)))
4935 (defun org-table-get-remote-range (name-or-id form)
4936 "Get a field value or a list of values in a range from table at ID.
4938 NAME-OR-ID may be the name of a table in the current file as set
4940 will then be used. Alternatively, it may be an ID referring to
4941 any entry, also in a different file. In this case, the first
4942 table in that entry will be referenced.
4946 The return value is either a single string for a single field, or a
4947 list of the fields in the rectangle."
4948 (save-match-data
4949 (let ((case-fold-search t) (id-loc nil)
4950 ;; Protect a bunch of variables from being overwritten
4951 ;; by the context of the remote table
4952 org-table-column-names org-table-column-name-regexp
4953 org-table-local-parameters org-table-named-field-locations
4954 org-table-current-line-types org-table-current-begin-line
4955 org-table-current-begin-pos org-table-dlines
4956 org-table-current-ncol
4957 org-table-hlines org-table-last-alignment
4958 org-table-last-column-widths org-table-last-alignment
4959 org-table-last-column-widths tbeg
4960 buffer loc)
4961 (setq form (org-table-convert-refs-to-rc form))
4962 (save-excursion
4963 (save-restriction
4964 (widen)
4965 (save-excursion
4966 (goto-char (point-min))
4967 (if (re-search-forward
4970 nil t)
4971 (setq buffer (current-buffer) loc (match-beginning 0))
4972 (setq id-loc (org-id-find name-or-id 'marker))
4973 (unless (and id-loc (markerp id-loc))
4975 (setq buffer (marker-buffer id-loc)
4976 loc (marker-position id-loc))
4977 (move-marker id-loc nil)))
4978 (with-current-buffer buffer
4979 (save-excursion
4980 (save-restriction
4981 (widen)
4982 (goto-char loc)
4983 (forward-char 1)
4985 (not (match-beginning 1)))
4986 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
4987 (setq tbeg (point-at-bol))
4988 (org-table-get-specials)
4989 (setq form (org-table-formula-substitute-names
4990 (org-table-formula-handle-first/last-rc form)))
4991 (if (and (string-match org-table-range-regexp form)
4992 (> (length (match-string 0 form)) 1))
4993 (save-match-data
4994 (org-table-get-range (match-string 0 form) tbeg 1))
4995 form)))))))))
4997 (defmacro org-define-lookup-function (mode)
4998 (let ((mode-str (symbol-name mode))
4999 (first-p (equal mode 'first))
5000 (all-p (equal mode 'all)))
5001 (let ((plural-str (if all-p "s" "")))
5002 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5003 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5004 If R-LIST is nil, return matching element%s of S-LIST.
5005 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5006 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5007 This function is generated by a call to the macro `org-define-lookup-function'."
5008 mode-str plural-str plural-str plural-str)
5009 (let ,(let ((lvars '((p (or predicate 'equal))
5010 (sl s-list)
5011 (rl (or r-list s-list))
5012 (ret nil))))
5013 (if first-p (add-to-list 'lvars '(match-p nil)))
5014 lvars)
5015 (while ,(if first-p '(and (not match-p) sl) 'sl)
5016 (progn
5017 (if (funcall p val (car sl))
5018 (progn
5019 ,(if first-p '(setq match-p t))
5020 (let ((rval (car rl)))
5021 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5022 (setq sl (cdr sl) rl (cdr rl))))
5023 ret)))))
5025 (org-define-lookup-function first)
5026 (org-define-lookup-function last)
5027 (org-define-lookup-function all)
5029 (provide 'org-table)
5031 ;; Local variables:
5032 ;; generated-autoload-file: "org-loaddefs.el"
5033 ;; End:
5035 ;;; org-table.el ends here