| blob | 65261663d98733a1b88882e132bc8fddf089ba07 |
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 '(64) Prompt for a regular expression as field separator
551 integer When a number, use that many spaces as field separator
552 regexp When a regular expression, use it to match the separator
553 nil When nil, the command tries to be smart and figure out the
554 separator in the following way:
555 - when each line contains a TAB, assume TAB-separated material
556 - when each line contains a comma, assume CSV material
557 - else, assume one or more SPACE characters as separator."
561 re)
570 ;; Get the right field separator
581 ;; parse the csv stuff
606 ;;;###autoload
608 "Import FILE as a table.
609 The file is assumed to be tab-separated. Such files can be produced by most
610 spreadsheet and database applications. If no tabs (at least one per line)
611 are found, lines will be split on whitespace into fields."
622 ;;;###autoload
624 "Export table to a file, with configurable format.
625 Such a file can be imported into usual spreadsheet programs.
627 FILE can be the output file name. If not given, it will be taken
628 from a TABLE_EXPORT_FILE property in the current entry or higher
629 up in the hierarchy, or the user will be prompted for a file
630 name. FORMAT can be an export format, of the same kind as it
631 used when `orgtbl-mode' sends a table in a different format.
633 The command suggests a format depending on TABLE_EXPORT_FORMAT,
634 whether it is set locally or up in the hierarchy, then on the
635 extension of the given file name, and finally on the variable
636 `org-table-export-default-format'."
650 buf deffmt-readable fileext)
666 org-table-export-default-format))
684 'hline
687 skipcols i0)))
688 lines))
692 skipcols i0))
695 skipcols i0)))
712 "Marker at the beginning of the table last aligned.
715 "Marker at the end of the table last aligned.
718 "List of flags for flushright alignment, from the last re-alignment.
721 "List of max width of fields in each column.
724 "Non-nil means debug table formulas.
736 ;;;###autoload
738 "Align the table at point by aligning all vertical bars."
741 ;; Limits of table
744 ;; Current cursor position
750 column
752 rfmt hfmt
760 emptystrings links dates emph raise narrow
761 falign falign1 fmax f1 len c e space)
764 ;; Check if we have links or dates
776 ;; Make sure the link properties are right
778 ;; Make sure the date properties are right
783 ;; Check if we are narrowing any columns
786 org-format-transports-properties-p
791 ;; Get the rows
794 ;; Store the indentation of the first line
797 ;; Mark the hlines by setting the corresponding element to nil
798 ;; At the same time, we remove trailing space.
801 nil
804 l)))
805 lines))
806 ;; Get the data fields by splitting the lines.
811 ;; How many fields in the longest line?
818 ;; A list of empty strings to fill any short rows on output
820 ;; Check for special formatting.
824 ;; Check if there is an explicit width specified
834 ;; Find fields that are wider than fmax, and shorten them
840 'help-echo
841 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
849 xx)))))
850 ;; Get the maximum width for each column
852 lengths)
853 ;; Get the fraction of numbers, to decide about alignment of the column
859 nil
866 ;; Store the alignment of this table, for later editing of single fields
868 org-table-last-column-widths lengths)
870 ;; With invisible characters, `format' does not get the field width right
871 ;; So we need to make these fields wide by hand.
889 ;; Compute the formats needed for output of the table
902 hfmt))
906 ;; Replace the old one
913 ;; Try to move to the old location
922 ))
924 ;;;###autoload
926 "Find the beginning of the table and return its position.
927 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
931 org-table-border-regexp)
932 nil t))
938 ;;;###autoload
940 "Find the end of the table and return its position.
941 With argument TABLE-TYPE, go to the end of a table.el-type table."
945 org-table-border-regexp)
946 nil t))
951 ;;;###autoload
953 "Justify the current field, text to left, number to right.
954 Optional argument NEW may specify text to replace the current field content."
963 ;; This is not the same table, force a full re-align
969 l f n o e)
992 ;;;###autoload
994 "Go to the next field in the current table, creating new lines as needed.
995 Before doing so, re-align the table if necessary."
1000 org-table-may-need-update)
1011 org-table-tab-jumps-over-hlines
1022 ;;;###autoload
1024 "Go to the previous field in the table.
1025 Before doing so, re-align the table if necessary."
1030 org-table-may-need-update)
1045 "Move to the end of the current table field.
1046 If already at or after the end, move to the end of the next table field.
1047 With numeric argument N, move N-1 fields forward first."
1060 "Move to the beginning of the current table field.
1061 If already at or before the beginning, move to the beginning of the
1062 previous field.
1063 With numeric argument N, move N-1 fields backward first."
1076 ;;;###autoload
1078 "Go to the next row (same column) in the current table.
1079 Before doing so, re-align the table if necessary."
1087 org-table-may-need-update)
1100 ;;;###autoload
1102 "Copy a field down in the current column.
1103 If the field at the cursor is empty, copy into it the content of
1104 the nearest non-empty field above. With argument N, use the Nth
1105 non-empty field. If the current field is not empty, it is copied
1106 down to the next row, and the cursor is moved with it.
1107 Therefore, repeating this command causes the column to be filled
1108 row-by-row.
1109 If the variable `org-table-copy-increment' is non-nil and the
1110 field is an integer or a timestamp, it will be incremented while
1111 copying. In the case of a timestamp, increment by one day."
1119 txt)
1131 beg t))
1154 "Is point inside a table data field?
1155 I.e. not on a hline or before the first or after the last column?
1156 This actually throws an error, so it aborts the current command."
1162 nil
1164 t))
1170 "Get the field in table line LINE, column COLUMN.
1171 If LINE is larger than the number of data lines in the table, the function
1172 returns nil. However, if COLUMN is too large, we will simply return an
1173 empty string.
1174 If LINE is nil, use the current line.
1175 If column is nil, use the current column."
1182 "Put VALUE into line LINE, column COLUMN.
1183 When ALIGN is set, also realign the table."
1192 "Return the index of the current data line."
1199 cnt))
1202 "Go to the Nth data line in the current table.
1203 Return t when the line exists, nil if it does not exist."
1210 ;;;###autoload
1212 "Blank the current table field or active region."
1229 "Return the value of the field in column N of current row.
1230 N defaults to current field.
1231 If REPLACE is a string, replace field with this value. The return value
1232 is always the old value."
1241 t t))
1243 val)
1246 ;;;###autoload
1248 "Show info about the current field, and highlight any reference at point."
1256 org-table-named-field-locations)))
1276 dline col
1278 dline col ref1
1280 ;; FIXME: formula info not correct if special table line
1290 "Find out which column we are in."
1300 cnt)))
1302 ;;;###autoload
1304 "Find out what table data line we are in.
1305 Only data lines count for this."
1317 cnt)))
1319 ;;;###autoload
1321 "Move the cursor to the Nth column in the current table line.
1322 With optional argument ON-DELIM, stop with point before the left delimiter
1323 of the field.
1324 If there are less than N fields, just go to after the last delimiter.
1325 However, when FORCE is non-nil, create new columns if necessary."
1335 t)))))
1342 ;;;###autoload
1344 "Insert a new column into the table."
1352 ;; Current cursor position
1358 nil
1372 "Find a data line in the current table, which is needed for column commands."
1375 t
1386 t
1391 "Turn a buffer line number into a data line number.
1392 If there is no data line in this line, return nil.
1393 If there is no matching dline (most likely te reference was a hline), the
1394 first dline below it is used. When ABOVE is non-nil, the one above is used."
1397 i)
1410 nil))
1412 ;;;###autoload
1414 "Delete a column from the table."
1423 ;; Current cursor position
1429 nil
1445 ;;;###autoload
1447 "Move column to the right."
1450 ;;;###autoload
1452 "Move column to the left."
1456 ;;;###autoload
1458 "Move the current column to the right. With arg LEFT, move to the left."
1468 ;; Current cursor position
1478 nil
1496 ;;;###autoload
1498 "Move table row down."
1501 ;;;###autoload
1503 "Move table row up."
1507 ;;;###autoload
1509 "Move the current table line down. With arg UP, move it up."
1518 txt hline2p)
1541 ;;;###autoload
1543 "Insert a new row above the current line into the table.
1544 With prefix ARG, insert below the current line."
1550 ;; Fix the first field if necessary
1563 ;;;###autoload
1565 "Insert a horizontal-line below the current line into the table.
1566 With prefix ABOVE, insert above the current line."
1587 ;;;###autoload
1589 "Insert a hline and move to the row below that line."
1603 In particular, this does handle wide and invisible characters."
1605 ;; It's a hline, just map the characters
1611 t t s)))
1612 s))
1614 ;;;###autoload
1616 "Delete the current row or horizontal line from the table."
1630 ;;;###autoload
1632 "Sort table lines according to the column at point.
1634 The position of point indicates the column to be used for
1635 sorting, and the range of lines is the range between the nearest
1636 horizontal separator lines, or the entire table of no such lines
1637 exist. If point is before the first column, you will be prompted
1638 for the sorting column. If there is an active region, the mark
1639 specifies the first line and the sorting column, while point
1640 should be in the last line to be included into the sorting.
1642 The command then prompts for the sorting type which can be
1643 alphabetically, numerically, or by time (as given in a time stamp
1644 in the field). Sorting in reverse order is also possible.
1646 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1648 If SORTING-TYPE is specified when this function is called from a Lisp
1649 program, no prompting will take place. SORTING-TYPE must be a character,
1650 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1651 should be done in reverse order."
1656 beg end bcol ecol tend tbeg column lns pos)
1701 x))
1715 ;;;###autoload
1717 "Copy region in table to the clipboard and blank all relevant fields.
1718 If there is no active region, use just the field at point."
1724 ;;;###autoload
1726 "Copy rectangular region in table to clipboard.
1727 A special clipboard is used which can only be accessed
1728 with `org-table-paste-rectangle'."
1732 current-prefix-arg))
1734 region cols
1760 org-table-clip))
1762 ;;;###autoload
1764 "Paste a rectangular region into a table.
1765 The upper right corner ends up in the current field. All involved fields
1766 will be overwritten. If the rectangle does not fit into the present table,
1767 the table is enlarged as needed. The process ignores horizontal separator
1768 lines."
1778 c cols field)
1793 ;;;###autoload
1795 "Convert from `org-mode' table to table.el and back.
1796 Obviously, this only works within limits. When an Org-mode table is
1797 converted to table.el, all horizontal separator lines get lost, because
1798 table.el uses these as cell boundaries and has no notion of horizontal lines.
1799 A table.el table can be converted to an Org-mode table only if it does not
1800 do row or column spanning. Multiline cells will become multiple cells.
1801 Beware, Org-mode does not test if the table can be successfully converted - it
1802 blindly applies a recipe that works for simple tables."
1806 ;; convert to Org-mode table
1815 ;; convert to table.el table
1818 ;; first, get rid of all horizontal lines
1822 ;; insert a hline before first
1826 ;; insert a hline after each line
1831 ;; replace "+" at beginning and ending of hlines
1840 "Transpose Org table at point and eliminate hlines.
1841 So a table like
1843 | 1 | 2 | 4 | 5 |
1844 |---+---+---+---|
1845 | a | b | c | d |
1846 | e | f | g | h |
1848 will be transposed as
1850 | 1 | a | e |
1851 | 2 | b | f |
1852 | 4 | c | g |
1853 | 5 | d | h |
1855 Note that horizontal lines disappear."
1867 table)))
1881 ;;;###autoload
1883 "Wrap several fields in a column like a paragraph.
1884 This is useful if you'd like to spread the contents of a field over several
1885 lines, in order to keep the table compact.
1887 If there is an active region, and both point and mark are in the same column,
1888 the text in the column is wrapped to minimum width for the given number of
1889 lines. Generally, this makes the table more compact. A prefix ARG may be
1891 formats the selected text to two lines. If the region was longer than two
1892 lines, the remaining lines remain empty. A negative prefix argument reduces
1893 the current number of lines by that amount. The wrapped text is pasted back
1894 into the table. If you formatted it to more lines than it was before, fields
1895 further down in the table get overwritten - so you might need to make space in
1896 the table first.
1898 If there is no region, the current field is split at the cursor position and
1899 the text fragment to the right of the cursor is prepended to the field one
1900 line down.
1902 If there is no region, but you specify a prefix ARG, the current field gets
1903 blank, and the content is appended to the field above."
1907 ;; There is a region: fill as a paragraph
1911 nlines)
1918 arg)
1922 nil nlines)))
1926 ;; No region, split the current field at point
1930 ;; combine with field above
1940 ;; split field
1952 ;;;###autoload
1954 "Edit table field in a different window.
1955 This is mainly useful for fields that contain hidden parts.
1957 it can be edited in place."
1966 display t intangible t))
1979 p)
1995 intangible t))
2003 "Finish editing a table data field.
2004 Remove all newline characters, insert the result into the table, realign
2005 the table and kill the editing buffer."
2009 text)
2026 "Minor mode to make the table field editor window follow the cursor.
2027 When this mode is active, the field editor window will always show the
2028 current field. The mode exits automatically when the cursor leaves the
2029 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2030 nil " TblFollow" nil
2046 ;; We have left the table, exit the follow mode
2056 ;;;###autoload
2058 "Sum numbers in region of current table column.
2059 The result will be displayed in the echo area, and will be available
2062 If there is an active region, it is interpreted as a rectangle and all
2063 numbers in that rectangle will be summed. If there is no active
2064 region and point is located in a table column, sum all numbers in that
2065 column.
2067 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2068 numbers are assumed to be times as well (in decimal hours) and the
2069 numbers are added as such.
2071 If NLAST is a number, only the NLAST fields will actually be summed."
2098 items1)))
2105 s diff)
2113 sres))))
2136 "Return the formula active for the current field.
2137 Assumes that specials are in place.
2138 If KEY is given, return the key to this formula.
2142 org-table-named-field-locations)))
2156 "Read a formula from the minibuffer, offer stored formula as default.
2157 When NAMED is non-nil, look for a named equation."
2161 org-table-named-field-locations)))
2168 name
2169 ref)
2179 stored)
2181 equation)
2188 scol))
2190 'org-table-formula-history
2191 )))))
2192 mustsave)
2194 ;; remove formula
2201 ;; We set the column equation, delete the named one.
2203 mustsave t))
2209 eq))
2212 "Store the list of formulas below the current table."
2219 ;; don't overwrite TBLFM, we might use text properties to store stuff
2235 ;; Fake a high number to make sure this is sorted at the end.
2242 a)
2252 "Compare two formulas for sorting."
2257 ;;;###autoload
2259 "Return an alist with the stored formulas directly after current table."
2268 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2287 "Modify the equations after the table structure has been edited.
2289 For all numbers larger than LIMIT, shift them by DELTA."
2301 s n a)
2321 "Get the column names and local parameters for this table."
2324 names name fields fields1 field cnt
2325 c v l line col types dlines hlines last-dline)
2327 org-table-local-parameters nil
2328 org-table-named-field-locations nil
2329 org-table-current-begin-line nil
2330 org-table-current-begin-pos nil
2331 org-table-current-line-types nil
2350 org-table-local-parameters))))
2366 ;; Analyse the line types
2370 l org-table-current-begin-line)
2387 al al2)
2397 ;;;###autoload
2400 If yes, store the formula and apply it."
2401 ;; We already know we are in a table. Get field will only return a formula
2402 ;; when appropriate. It might return a separator line, but no problem.
2405 named eq)
2416 "List of commands triggering the recalculation of a line.
2428 ;;;###autoload
2430 "Rotate the recalculation mark in the first column.
2431 If in any row, the first field is not consistent with a mark,
2432 insert a new column for the markers.
2433 When there is an active region, change all the lines in the region,
2434 after prompting for the marking character.
2435 After each change, a message will be displayed indicating the meaning
2436 of the new mark."
2451 epos new)
2458 newchar))
2490 ;;;###autoload
2492 "Recompute the current line if marked for it, and if we haven't just done it."
2512 org-tbl-calc-modes)
2514 ;;;###autoload
2516 suppress-align suppress-const
2517 suppress-store suppress-analysis)
2518 "Replace the table field value at the cursor by the result of a calculation.
2520 This function makes use of Dave Gillespie's Calc package, in my view the
2521 most exciting program ever written for GNU Emacs. So you need to have Calc
2522 installed in order to use this function.
2524 In a table, this command replaces the value in the current field with the
2526 formula, by storing it in a special line below the table. When called
2527 with a `C-u' prefix, the current field must be a named field, and the
2528 formula is installed as valid in only this specific field.
2530 When called with two `C-u' prefixes, insert the active equation
2531 for the field back into the current field, so that it can be
2533 to check the referenced fields.
2535 When called, the command first prompts for a formula, which is read in
2536 the minibuffer. Previously entered formulas are available through the
2537 history list, and the last used formula is offered as a default.
2538 These stored formulas are adapted correctly when moving, inserting, or
2539 deleting columns with the corresponding commands.
2541 The formula can be any algebraic expression understood by the Calc package.
2542 For details, see the Org-mode manual.
2544 This function can also be called from Lisp programs and offers
2545 additional arguments: EQUATION can be the formula to apply. If this
2546 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2547 used to speed-up recursive calls by by-passing unnecessary aligns.
2548 SUPPRESS-CONST suppresses the interpretation of constants in the
2549 formula, assuming that this has been done already outside the function.
2550 SUPPRESS-STORE means the formula should not be stored, either because
2551 it is already stored, or because it is a modified equation that should
2552 not overwrite the stored one."
2568 equation
2574 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2575 duration duration-output-format)
2576 ;; Parse the format string. Since we have a lot of modes, this is
2577 ;; a lot of work. However, I think calc still uses most of the time.
2590 'calc-float-format
2593 n))))
2597 duration-output-format nil
2601 duration-output-format org-table-duration-custom-format
2602 numbers t
2625 ;; replace fields with duration values if relevant
2629 fields)))
2635 x))
2636 fields)))
2642 ;; Insert row and column number of formula result field
2653 t t form)))
2655 ;; Check for old vertical references
2657 ;; Insert remote references
2669 rmtrng))
2670 keep-empty numbers lispp))
2671 t t form)))
2672 ;; Insert complex ranges
2680 ;; possibly handle durations
2685 formrg)
2686 keep-empty numbers lispp)))
2691 ;; Insert simple ranges
2700 keep-empty numbers lispp))
2701 t t form)))
2703 ;; Insert the references to fields in same row
2713 x keep-empty numbers lispp))
2714 t t form)))
2726 ;; Use <...> time-stamps so that Calc can handle them
2728 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2739 form
2746 duration-output-format)
2747 ev)))
2752 Orig: %s
2753 $xyz-> %s
2754 @r$c-> %s
2786 prop value)))
2789 "Get a calc vector from a column, according to descriptor DESC.
2790 Optional arguments TBEG and COL can give the beginning of the table and
2791 the current column, to avoid unnecessary parsing.
2793 HIGHLIGHT means just highlight the range.
2795 When CORNERS-ONLY is set, only return the corners of the range as
2796 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2797 in the buffer and column1 and column2 are table column numbers."
2804 beg end c1 c2 r1 r2 rangep tmp)
2821 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2828 ;; just one field
2835 ;; A range, return a vector
2836 ;; First sort the numbers to get a regular rectangle
2840 ;; Only return the corners of the range
2842 ;; Copy the range values into a list
2856 ;; return string representation of calc vector
2861 "Analyze descriptor DESC and retrieve the corresponding line number.
2862 The cursor is currently in line CLINE, the table begins in line BLINE,
2863 and TABLE is a vector with line types."
2871 ;; 1 2 3 4 5 6
2891 nil hn cline desc)))
2894 rel on cline desc)))
2898 "FIXME: Needs more documentation."
2911 nil))
2912 t)))
2916 desc cline)
2917 i)))
2922 s))
2925 "Convert list ELEMENTS to something appropriate to insert into formula.
2926 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2927 NUMBERS indicates that everything should be converted to numbers.
2928 LISPP non-nil means to return something appropriate for a Lisp
2929 list, 'literal is for the format specifier L."
2930 ;; Calc nan (not a number) is used for the conversion of the empty
2931 ;; field to a reference for several reasons: (i) It is accepted in a
2932 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2933 ;; (ii) In a single field (not in range) it can be distinguished
2934 ;; from "(nan)" which is the reference made from a single field
2935 ;; containing "nan".
2937 ;; field reference
2940 elements
2942 ""
2951 ;; range reference
2956 elements))))
2962 x
2970 x)
2972 elements
2975 ;;;###autoload
2977 "Set `org-table-formula-constants-local' in the current buffer."
2993 ;;;###autoload
2995 "Recalculate the current table line by applying all stored formulas.
2996 With prefix arg ALL, do this for all lines in the table.
2997 With the prefix argument ALL is `(16)' \
2999 it is the symbol `iterate', recompute the table until it no longer changes.
3000 If NOALIGN is not nil, do not re-align the table after the computations
3001 are done. This is typically used internally to save time, if it is
3002 known that the table will be realigned a little later anyway."
3017 seen-fields lhs1
3019 ;; Insert constants in all formulas
3037 eqlist))
3038 ;; Split the equation list
3044 ;; Expand ranges in lhs of formulas
3047 ;; Get the correct line range to process
3053 ;; This is a table with marked lines, compute selected lines
3055 ;; Move forward to the first non-header line
3066 ;; First find the named fields, and mark them untouchable.
3067 ;; Also check if several field/range formulas try to set the same field.
3086 name)))
3096 ;; Now evaluate the column formulas, but skip fields covered by
3097 ;; field formulas
3101 ;; Unprotected line, recalculate
3113 ;; Now evaluate the field formulas
3127 ;; back to initial position
3134 ;;;###autoload
3136 "Recalculate the table until it does not change anymore.
3137 The maximum number of iterations is 10, but you can choose a different value
3138 with the prefix ARG."
3143 thistbl)
3157 ;;;###autoload
3159 "Recalculate all tables in the current buffer."
3166 ;;;###autoload
3168 "Iterate all tables in the buffer, to converge inter-table dependencies."
3173 c1)
3189 "Apply the #+TBLFM in the line at point to the table."
3195 s e)
3197 ;; Insert a temporary formula at right after the table
3202 ;; Recalculate the table
3208 ;; delete the formula inserted temporarily
3212 "Find the beginning of the TBLFM lines and return its position.
3213 Return nil when the beginning of TBLFM line was not found."
3217 org-table-TBLFM-begin-regexp
3218 nil t))
3222 "Expand list of formulas.
3223 If some of the RHS in the formulas are ranges or a row reference, expand
3224 them to individual field equations for each field."
3230 ;; This just refers to one fixed field
3233 ;; This just refers to one fixed named field
3255 "Replace @<, @>, $<, $> with first/last row/column of the table.
3256 So @< and $< will always be replaced with @1 and $1, respectively.
3257 The advantage of these special markers are that structure editing of
3258 the table will not change them, while @1 and $1 will be modified
3259 when a line/row is swapped out of that privileged position. So for
3260 formulas that use a range of rows or columns, it may often be better
3262 borders of the table using the @< @> $< $> makers."
3265 s start)
3270 org-table-current-ncol)
3274 len
3281 s)
3284 "Replace $const with values in string F."
3286 ;; First, check for column names
3291 ;; Parameters and constants
3293 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3303 f))
3306 "Find the value for a parameter or constant in a formula.
3307 Parameters get priority."
3338 map))
3345 "--"
3348 "--"
3349 "Shift Reference at Point"
3354 "-"
3355 "Change Test Row for Column Formulas"
3358 "--"
3363 org-table-overlay-coordinates)]
3364 "--"
3370 ;;;###autoload
3372 "Edit the formulas of the current table in a separate buffer."
3374 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3388 entry s type title)
3391 ;; Keep global-font-lock-mode from turning on font-lock-mode
3432 "Convert a formula from internal to user representation."
3435 s))
3438 "Convert a formula from user to internal representation."
3441 s))
3444 "Convert spreadsheet references from A7 to @7$28.
3445 Works for single references, but also for entire formulas and even the
3446 full TBLFM line."
3448 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3451 ;; format match, just advance
3456 ;; 3.e5 or something like this.
3459 ;; (member (match-string 1 s)
3460 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3461 )
3462 ;; function name, just advance
3472 t t s)))))
3473 s))
3476 "Convert spreadsheet references from to @7$28 to AB7.
3477 Works for single references, but also for entire formulas and even the
3478 full TBLFM line."
3485 t t s)))
3490 t nil s)))
3491 s)
3494 "Convert a base 26 number represented by letters into an integer.
3495 For example: AB -> 28."
3501 n))
3504 "Convert an integer into a base 26 number represented by letters.
3505 For example: 28 -> AB."
3510 s))
3513 "Convert a time string into numerical duration in seconds.
3514 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3515 If S is a string representing a number, keep this number."
3517 s
3540 "Convert a number of seconds to a time string.
3541 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3542 minutes or seconds."
3557 "Convert all references in this buffer, using FUNCTION."
3567 "Convert all references in the buffer from B3 to @3$2 and back."
3577 "Shift the reference at point one row/hline up."
3581 "Shift the reference at point one row/hline down."
3585 "Shift the reference at point one field to the left."
3589 "Shift the reference at point one field to the right."
3600 ;; A B3-like reference
3606 ;; An internal reference
3612 "Re-match the group N, and replace it with the shifted reference."
3617 t t)))
3620 "Shift a reference part REF.
3621 If DECR is set, decrease the references row/column, else increase.
3622 If HLINE is set, this may be a hline reference, it certainly is not
3623 a translation reference."
3652 "Toggle the display of coordinates in the referenced table."
3661 "Parse the buffer for formula definitions and install them.
3662 With prefix ARG, apply the new formulas to the table."
3672 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3673 nil t)
3697 "Abort editing formulas, without installing the changes."
3708 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3749 "Show the location/value of the $ expression at point."
3758 var name e what match dest)
3763 "$1.."
3846 ;; column number
3874 org-table-fedit-scroll-down))))
3885 "Make sure the cursor is in a dataline in a table."
3894 p1 p2)))
3899 "Move cursor one line up in the window showing the table."
3904 "Move cursor one line down in the window showing the table."
3909 "Move the cursor in the window showing the table.
3910 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3935 "Add a new overlay."
3941 "Highlight rectangular region in a table."
3945 l1 c1 l2 c2 tmp)
3969 "Remove the rectangle overlays."
3980 "Add overlays to the table at point, to show row/column coordinates."
4008 ;;;###autoload
4010 "Toggle the display of Row/Column numbers in tables."
4021 ;;;###autoload
4023 "Toggle the formula debugger in tables."
4029 ;;; The orgtbl minor mode
4031 ;; Define a minor mode which can be used in other modes in order to
4032 ;; integrate the org-mode table editor.
4034 ;; This is really a hack, because the org-mode table editor uses several
4035 ;; keys which normally belong to the major mode, for example the TAB and
4036 ;; RET keys. Here is how it works: The minor mode defines all the keys
4037 ;; necessary to operate the table editor, but wraps the commands into a
4038 ;; function which tests if the cursor is currently inside a table. If that
4039 ;; is the case, the table editor command is executed. However, when any of
4040 ;; those keys is used outside a table, the function uses `key-binding' to
4041 ;; look up if the key has an associated command in another currently active
4042 ;; keymap (minor modes, major mode, global), and executes that command.
4043 ;; There might be problems if any of the keys used by the table editor is
4044 ;; otherwise used as a prefix key.
4046 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4047 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4048 ;; addresses this by checking explicitly for both bindings.
4050 ;; The optimized version (see variable `orgtbl-optimized') takes over
4051 ;; all keys which are bound to `self-insert-command' in the *global map*.
4052 ;; Some modes bind other commands to simple characters, for example
4053 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4054 ;; active, this binding is ignored inside tables and replaced with a
4055 ;; modified self-insert.
4073 ;; Install it as a minor mode.
4077 ;;;###autoload
4079 "The `org-mode' table editor as a minor mode for use in other modes."
4084 ;; Exit without error, in case some hook functions calls this
4085 ;; by accident in org-mode.
4089 ;; Make sure we are first in minor-mode-map-alist
4091 ;; FIXME: maybe it should use emulation-mode-map-alists?
4098 auto-fill-inhibit-regexp)
4102 auto-fill-inhibit-regexp)
4103 orgtbl-line-start-regexp))
4121 "Remove all properties related to narrow-column invisibility."
4134 "Create a function for binding in the table minor mode.
4135 FUN is the command to call inside a table. N is used to create a unique
4136 command name. KEYS are keys that should be checked in for a command
4137 to execute outside of tables."
4143 "Outside of tables, run the binding of `"
4155 keys)
4159 "Error when there is no default binding for a table key."
4164 "Setup orgtbl keymaps."
4195 elt key fun cmd)
4203 ;; Special treatment needed for TAB and RET
4223 [(tab)] "\C-i")))
4225 (org-defkey orgtbl-mode-map [backtab]
4227 [backtab] [S-iso-lefttab] [(shift tab)]
4228 [(tab)] "\C-i"))
4230 (org-defkey orgtbl-mode-map "\M-\C-m"
4231 (orgtbl-make-binding 'org-table-wrap-region 105
4232 "\M-\C-m" [(meta return)]))
4233 (org-defkey orgtbl-mode-map [(meta return)]
4234 (orgtbl-make-binding 'org-table-wrap-region 106
4235 [(meta return)] "\M-\C-m"))
4237 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4238 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4240 (when orgtbl-optimized
4241 ;; If the user wants maximum table support, we need to hijack
4242 ;; some standard editing functions
4243 (org-remap orgtbl-mode-map
4244 'self-insert-command 'orgtbl-self-insert-command
4245 'delete-char 'org-delete-char
4246 'delete-backward-char 'org-delete-backward-char)
4247 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4248 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4249 '("OrgTbl"
4250 ["Create or convert" org-table-create-or-convert-from-region
4251 :active (not (org-at-table-p)) :keys "C-c |" ]
4252 "--"
4253 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4254 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4255 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4256 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4257 "--"
4258 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4259 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4260 ["Copy Field from Above"
4261 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4262 "--"
4263 ("Column"
4264 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4265 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4266 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4267 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4268 ("Row"
4269 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4270 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4271 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4272 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4273 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4274 "--"
4275 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4276 ("Rectangle"
4277 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4278 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4279 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4280 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4281 "--"
4282 ("Radio tables"
4283 ["Insert table template" orgtbl-insert-radio-table
4284 (assq major-mode orgtbl-radio-table-templates)]
4285 ["Comment/uncomment table" orgtbl-toggle-comment t])
4286 "--"
4287 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4288 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4289 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4290 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4291 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4292 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4293 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4294 ["Sum Column/Rectangle" org-table-sum
4295 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4296 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4297 ["Debug Formulas"
4298 org-table-toggle-formula-debugger :active (org-at-table-p)
4299 :keys "C-c {"
4300 :style toggle :selected org-table-formula-debug]
4301 ["Show Col/Row Numbers"
4302 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4303 :keys "C-c }"
4304 :style toggle :selected org-table-overlay-coordinates]
4305 ))
4306 t))
4308 (defun orgtbl-ctrl-c-ctrl-c (arg)
4309 "If the cursor is inside a table, realign the table.
4310 If it is a table to be sent away to a receiver, do it.
4311 With prefix arg, also recompute table."
4312 (interactive "P")
4313 (let ((case-fold-search t) (pos (point)) action)
4314 (save-excursion
4315 (beginning-of-line 1)
4316 (setq action (cond
4320 (cond
4321 ((integerp action)
4322 (goto-char action)
4323 (org-table-maybe-eval-formula)
4324 (if arg
4325 (call-interactively 'org-table-recalculate)
4326 (org-table-maybe-recalculate-line))
4327 (call-interactively 'org-table-align)
4328 (when (orgtbl-send-table 'maybe)
4329 (run-hooks 'orgtbl-after-send-table-hook)))
4330 ((eq action 'recalc)
4331 (org-table-set-constants)
4332 (save-excursion
4333 (beginning-of-line 1)
4335 (if (org-at-table-p)
4336 (org-call-with-arg 'org-table-recalculate t))))
4337 (t (let (orgtbl-mode)
4338 (call-interactively (key-binding "\C-c\C-c")))))))
4340 (defun orgtbl-create-or-convert-from-region (arg)
4341 "Create table or convert region to table, if no conflicting binding.
4342 This installs the table binding `C-c |', but only if there is no
4343 conflicting binding to this key outside orgtbl-mode."
4344 (interactive "P")
4345 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4346 (if cmd
4347 (call-interactively cmd)
4348 (call-interactively 'org-table-create-or-convert-from-region))))
4350 (defun orgtbl-tab (arg)
4351 "Justification and field motion for `orgtbl-mode'."
4352 (interactive "P")
4353 (if arg (org-table-edit-field t)
4354 (org-table-justify-field-maybe)
4355 (org-table-next-field)))
4357 (defun orgtbl-ret ()
4358 "Justification and field motion for `orgtbl-mode'."
4359 (interactive)
4360 (if (bobp)
4361 (newline)
4362 (org-table-justify-field-maybe)
4363 (org-table-next-row)))
4365 (defun orgtbl-self-insert-command (N)
4366 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4367 If the cursor is in a table looking at whitespace, the whitespace is
4368 overwritten, and the table is not marked as requiring realignment."
4369 (interactive "p")
4370 (if (and (org-at-table-p)
4371 (or
4372 (and org-table-auto-blank-field
4373 (member last-command
4374 '(orgtbl-hijacker-command-100
4375 orgtbl-hijacker-command-101
4376 orgtbl-hijacker-command-102
4377 orgtbl-hijacker-command-103
4378 orgtbl-hijacker-command-104
4379 orgtbl-hijacker-command-105
4380 yas/expand))
4381 (org-table-blank-field))
4382 t)
4383 (eq N 1)
4385 (let (org-table-may-need-update)
4386 (goto-char (1- (match-end 0)))
4387 (org-delete-backward-char 1)
4388 (goto-char (match-beginning 0))
4389 (self-insert-command N))
4390 (setq org-table-may-need-update t)
4391 (let* (orgtbl-mode
4392 a
4393 (cmd (or (key-binding
4394 (or (and (listp function-key-map)
4395 (setq a (assoc last-input-event function-key-map))
4396 (cdr a))
4397 (vector last-input-event)))
4398 'self-insert-command)))
4399 (call-interactively cmd)
4400 (if (and org-self-insert-cluster-for-undo
4401 (eq cmd 'self-insert-command))
4402 (if (not (eq last-command 'orgtbl-self-insert-command))
4403 (setq org-self-insert-command-undo-counter 1)
4404 (if (>= org-self-insert-command-undo-counter 20)
4405 (setq org-self-insert-command-undo-counter 1)
4406 (and (> org-self-insert-command-undo-counter 0)
4407 buffer-undo-list
4408 (not (cadr buffer-undo-list)) ; remove nil entry
4409 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4410 (setq org-self-insert-command-undo-counter
4411 (1+ org-self-insert-command-undo-counter))))))))
4414 "Regular expression matching exponentials as produced by calc.")
4416 (defun orgtbl-gather-send-defs ()
4417 "Gather a plist of :name, :transform, :params for each destination before
4418 a radio table."
4419 (save-excursion
4420 (goto-char (org-table-begin))
4421 (let (rtn)
4422 (beginning-of-line 0)
4423 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4424 (let ((name (org-no-properties (match-string 1)))
4425 (transform (intern (match-string 2)))
4426 (params (if (match-end 3)
4427 (read (concat "(" (match-string 3) ")")))))
4428 (push (list :name name :transform transform :params params)
4429 rtn)
4430 (beginning-of-line 0)))
4431 rtn)))
4433 (defun orgtbl-send-replace-tbl (name txt)
4434 "Find and replace table NAME with TXT."
4435 (save-excursion
4436 (goto-char (point-min))
4437 (unless (re-search-forward
4439 (user-error "Don't know where to insert translated table"))
4440 (goto-char (match-beginning 0))
4441 (beginning-of-line 2)
4442 (save-excursion
4443 (let ((beg (point)))
4444 (unless (re-search-forward
4445 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4446 (user-error "Cannot find end of insertion region"))
4447 (beginning-of-line 1)
4448 (delete-region beg (point))))
4451 ;;;###autoload
4452 (defun org-table-to-lisp (&optional txt)
4453 "Convert the table at point to a Lisp structure.
4454 The structure will be a list. Each item is either the symbol `hline'
4455 for a horizontal separator line, or a list of field values as strings.
4456 The table is taken from the parameter TXT, or from the buffer at point."
4457 (unless txt
4458 (unless (org-at-table-p)
4459 (user-error "No table at point")))
4460 (let* ((txt (or txt
4461 (buffer-substring-no-properties (org-table-begin)
4462 (org-table-end))))
4465 (mapcar
4466 (lambda (x)
4467 (if (string-match org-table-hline-regexp x)
4468 'hline
4470 lines)))
4472 (defun orgtbl-send-table (&optional maybe)
4473 "Send a transformed version of this table to the receiver position.
4474 With argument MAYBE, fail quietly if no transformation is defined for
4475 this table."
4476 (interactive)
4477 (catch 'exit
4478 (unless (org-at-table-p) (user-error "Not at a table"))
4479 ;; when non-interactive, we assume align has just happened.
4480 (when (org-called-interactively-p 'any) (org-table-align))
4481 (let ((dests (orgtbl-gather-send-defs))
4482 (txt (buffer-substring-no-properties (org-table-begin)
4483 (org-table-end)))
4484 (ntbl 0))
4485 (unless dests (if maybe (throw 'exit nil)
4486 (user-error "Don't know how to transform this table")))
4487 (dolist (dest dests)
4488 (let* ((name (plist-get dest :name))
4489 (transform (plist-get dest :transform))
4490 (params (plist-get dest :params))
4491 (skip (plist-get params :skip))
4492 (skipcols (plist-get params :skipcols))
4493 (no-escape (plist-get params :no-escape))
4494 beg
4495 (lines (org-table-clean-before-export
4496 (nthcdr (or skip 0)
4498 (i0 (if org-table-clean-did-remove-column 2 1))
4499 (lines (if no-escape lines
4500 (mapcar (lambda(l) (replace-regexp-in-string
4502 (table (mapcar
4503 (lambda (x)
4504 (if (string-match org-table-hline-regexp x)
4505 'hline
4506 (org-remove-by-index
4508 skipcols i0)))
4509 lines))
4510 (fun (if (= i0 2) 'cdr 'identity))
4511 (org-table-last-alignment
4512 (org-remove-by-index (funcall fun org-table-last-alignment)
4513 skipcols i0))
4514 (org-table-last-column-widths
4515 (org-remove-by-index (funcall fun org-table-last-column-widths)
4516 skipcols i0))
4517 (txt (if (fboundp transform)
4518 (funcall transform table params)
4519 (user-error "No such transformation function %s" transform))))
4520 (orgtbl-send-replace-tbl name txt))
4521 (setq ntbl (1+ ntbl)))
4522 (message "Table converted and installed at %d receiver location%s"
4523 ntbl (if (> ntbl 1) "s" ""))
4524 (if (> ntbl 0)
4525 ntbl
4526 nil))))
4528 (defun org-remove-by-index (list indices &optional i0)
4529 "Remove the elements in LIST with indices in INDICES.
4530 First element has index 0, or I0 if given."
4531 (if (not indices)
4532 list
4533 (if (integerp indices) (setq indices (list indices)))
4534 (setq i0 (1- (or i0 0)))
4535 (delq :rm (mapcar (lambda (x)
4536 (setq i0 (1+ i0))
4537 (if (memq i0 indices) :rm x))
4538 list))))
4540 (defun orgtbl-toggle-comment ()
4541 "Comment or uncomment the orgtbl at point."
4542 (interactive)
4543 (let* ((case-fold-search t)
4544 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4545 (re2 (concat "^" orgtbl-line-start-regexp))
4546 (commented (save-excursion (beginning-of-line 1)
4547 (cond ((looking-at re1) t)
4548 ((looking-at re2) nil)
4549 (t (user-error "Not at an org table")))))
4550 (re (if commented re1 re2))
4551 beg end)
4552 (save-excursion
4553 (beginning-of-line 1)
4554 (while (looking-at re) (beginning-of-line 0))
4555 (beginning-of-line 2)
4556 (setq beg (point))
4557 (while (looking-at re) (beginning-of-line 2))
4558 (setq end (point)))
4559 (comment-region beg end (if commented '(4) nil))))
4561 (defun orgtbl-insert-radio-table ()
4562 "Insert a radio table template appropriate for this major mode."
4563 (interactive)
4564 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4565 (txt (nth 1 e))
4566 name pos)
4567 (unless e (user-error "No radio table setup defined for %s" major-mode))
4568 (setq name (read-string "Table name: "))
4569 (while (string-match "%n" txt)
4570 (setq txt (replace-match name t t txt)))
4572 (setq pos (point))
4573 (insert txt)
4574 (goto-char pos)))
4576 ;; Dynamically bound input and output for table formatting.
4577 (defvar *orgtbl-table* nil
4578 "Carries the current table through formatting routines.")
4579 (defvar *orgtbl-rtn* nil
4580 "Formatting routines push the output lines here.")
4581 ;; Formatting parameters for the current table section.
4582 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4583 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4584 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4585 (defvar *orgtbl-fmt* nil "Format for each entry.")
4586 (defvar *orgtbl-efmt* nil "Format for numbers.")
4587 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4588 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4589 (defvar *orgtbl-lstart* nil "Text starting a row.")
4590 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4591 (defvar *orgtbl-lend* nil "Text ending a row.")
4592 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4594 (defsubst orgtbl-get-fmt (fmt i)
4595 "Retrieve the format from FMT corresponding to the Ith column."
4596 (if (and (not (functionp fmt)) (consp fmt))
4597 (plist-get fmt i)
4598 fmt))
4600 (defsubst orgtbl-apply-fmt (fmt &rest args)
4601 "Apply format FMT to arguments ARGS.
4602 When FMT is nil, return the first argument from ARGS."
4603 (cond ((functionp fmt) (apply fmt args))
4604 (fmt (apply 'format fmt args))
4605 (args (car args))
4606 (t args)))
4608 (defsubst orgtbl-eval-str (str)
4609 "If STR is a function, evaluate it with no arguments."
4610 (if (functionp str)
4611 (funcall str)
4612 str))
4614 (defun orgtbl-format-line (line)
4615 "Format LINE as a table row."
4616 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4617 (let* ((i 0)
4618 (line
4619 (mapcar
4620 (lambda (f)
4621 (setq i (1+ i))
4622 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4623 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4624 (orgtbl-apply-fmt efmt (match-string 1 f)
4625 (match-string 2 f))
4626 f)))
4627 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4628 *orgtbl-default-fmt*)
4629 f)))
4630 line)))
4631 (push (if *orgtbl-lfmt*
4632 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4633 (concat (orgtbl-eval-str *orgtbl-lstart*)
4634 (mapconcat 'identity line *orgtbl-sep*)
4635 (orgtbl-eval-str *orgtbl-lend*)))
4636 *orgtbl-rtn*))))
4638 (defun orgtbl-format-section (section-stopper)
4639 "Format lines until the first occurrence of SECTION-STOPPER."
4640 (let (prevline)
4641 (progn
4642 (while (not (eq (car *orgtbl-table*) section-stopper))
4643 (if prevline (orgtbl-format-line prevline))
4644 (setq prevline (pop *orgtbl-table*)))
4645 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4646 (*orgtbl-lend* *orgtbl-llend*)
4647 (*orgtbl-lfmt* *orgtbl-llfmt*))
4648 (orgtbl-format-line prevline))))))
4650 ;;;###autoload
4651 (defun orgtbl-to-generic (table params &optional backend)
4652 "Convert the orgtbl-mode TABLE to some other format.
4653 This generic routine can be used for many standard cases.
4654 TABLE is a list, each entry either the symbol `hline' for a horizontal
4655 separator line, or a list of fields for that line.
4656 PARAMS is a property list of parameters that can influence the conversion.
4657 A third optional argument BACKEND can be used to convert the content of
4658 the cells using a specific export back-end.
4660 For the generic converter, some parameters are obligatory: you need to
4661 specify either :lfmt, or all of (:lstart :lend :sep).
4663 Valid parameters are:
4665 :splice When set to t, return only table body lines, don't wrap
4666 them into :tstart and :tend. Default is nil. When :splice
4667 is non-nil, this also means that the exporter should not look
4668 for and interpret header and footer sections.
4670 :hline String to be inserted on horizontal separation lines.
4671 May be nil to ignore hlines.
4673 :sep Separator between two fields
4674 :remove-nil-lines Do not include lines that evaluate to nil.
4676 Each in the following group may be either a string or a function
4677 of no arguments returning a string:
4679 :tstart String to start the table. Ignored when :splice is t.
4680 :tend String to end the table. Ignored when :splice is t.
4681 :lstart String to start a new table line.
4682 :llstart String to start the last table line, defaults to :lstart.
4683 :lend String to end a table line
4684 :llend String to end the last table line, defaults to :lend.
4686 Each in the following group may be a string, a function of one
4687 argument (the field or line) returning a string, or a plist
4688 mapping columns to either of the above:
4690 :lfmt Format for entire line, with enough %s to capture all fields.
4691 If this is present, :lstart, :lend, and :sep are ignored.
4692 :llfmt Format for the entire last line, defaults to :lfmt.
4693 :fmt A format to be used to wrap the field, should contain
4694 %s for the original field value. For example, to wrap
4696 This may also be a property list with column numbers and
4698 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4699 Same as above, specific for the header lines in the table.
4700 All lines before the first hline are treated as header.
4701 If any of these is not present, the data line value is used.
4703 This may be either a string or a function of two arguments:
4705 :efmt Use this format to print numbers with exponentials.
4706 The format should have %s twice for inserting mantissa
4708 may also be a property list with column numbers and
4709 formats. :fmt will still be applied after :efmt.
4711 In addition to this, the parameters :skip and :skipcols are always handled
4712 directly by `orgtbl-send-table'. See manual."
4713 (let* ((splicep (plist-get params :splice))
4714 (hline (plist-get params :hline))
4715 (skipheadrule (plist-get params :skipheadrule))
4716 (remove-nil-linesp (plist-get params :remove-nil-lines))
4717 (remove-newlines (plist-get params :remove-newlines))
4718 (*orgtbl-hline* hline)
4719 (*orgtbl-table* table)
4720 (*orgtbl-sep* (plist-get params :sep))
4721 (*orgtbl-efmt* (plist-get params :efmt))
4722 (*orgtbl-lstart* (plist-get params :lstart))
4723 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4724 (*orgtbl-lend* (plist-get params :lend))
4725 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4726 (*orgtbl-lfmt* (plist-get params :lfmt))
4727 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4728 (*orgtbl-fmt* (plist-get params :fmt))
4729 *orgtbl-rtn*)
4730 ;; Convert cells content to backend BACKEND
4731 (when backend
4732 (setq *orgtbl-table*
4733 (mapcar
4734 (lambda(r)
4735 (if (listp r)
4736 (mapcar
4737 (lambda (c)
4738 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4739 r)
4740 r))
4741 *orgtbl-table*)))
4742 ;; Put header
4743 (unless splicep
4744 (when (plist-member params :tstart)
4745 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4746 (if tstart (push tstart *orgtbl-rtn*)))))
4747 ;; If we have a heading, format it and handle the trailing hline.
4748 (if (and (not splicep)
4749 (or (consp (car *orgtbl-table*))
4750 (consp (nth 1 *orgtbl-table*)))
4751 (memq 'hline (cdr *orgtbl-table*)))
4752 (progn
4753 (when (eq 'hline (car *orgtbl-table*))
4754 ;; There is a hline before the first data line
4755 (and hline (push hline *orgtbl-rtn*))
4756 (pop *orgtbl-table*))
4757 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4758 *orgtbl-lstart*))
4759 (*orgtbl-llstart* (or (plist-get params :hllstart)
4760 *orgtbl-llstart*))
4761 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4762 (*orgtbl-llend* (or (plist-get params :hllend)
4763 (plist-get params :hlend) *orgtbl-llend*))
4764 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4765 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4766 (plist-get params :hlfmt) *orgtbl-llfmt*))
4767 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4768 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4769 (orgtbl-format-section 'hline))
4770 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4771 (pop *orgtbl-table*)))
4772 ;; Now format the main section.
4773 (orgtbl-format-section nil)
4774 (unless splicep
4775 (when (plist-member params :tend)
4776 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4777 (if tend (push tend *orgtbl-rtn*)))))
4778 (mapconcat (if remove-newlines
4779 (lambda (tend)
4781 'identity)
4782 (nreverse (if remove-nil-linesp
4783 (remq nil *orgtbl-rtn*)
4786 ;;;###autoload
4787 (defun orgtbl-to-tsv (table params)
4788 "Convert the orgtbl-mode table to TAB separated material."
4790 ;;;###autoload
4791 (defun orgtbl-to-csv (table params)
4792 "Convert the orgtbl-mode table to CSV material.
4793 This does take care of the proper quoting of fields with comma or quotes."
4794 (orgtbl-to-generic table (org-combine-plists
4795 '(:sep "," :fmt org-quote-csv-field)
4796 params)))
4798 ;;;###autoload
4799 (defun orgtbl-to-latex (table params)
4800 "Convert the orgtbl-mode TABLE to LaTeX.
4801 TABLE is a list, each entry either the symbol `hline' for a horizontal
4802 separator line, or a list of fields for that line.
4803 PARAMS is a property list of parameters that can influence the conversion.
4804 Supports all parameters from `orgtbl-to-generic'. Most important for
4805 LaTeX are:
4807 :splice When set to t, return only table body lines, don't wrap
4808 them into a tabular environment. Default is nil.
4810 :fmt A format to be used to wrap the field, should contain %s for the
4811 original field value. For example, to wrap everything in dollars,
4814 The format may also be a function that formats its one argument.
4816 :efmt Format for transforming numbers with exponentials. The format
4817 should have %s twice for inserting mantissa and exponent, for
4819 This may also be a property list with column numbers and formats.
4820 The format may also be a function that formats its two arguments.
4822 :llend If you find too much space below the last line of a table,
4825 The general parameters :skip and :skipcols have already been applied when
4826 this function is called."
4827 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4828 org-table-last-alignment ""))
4829 (params2
4830 (list
4835 (require 'ox-latex)
4836 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4838 ;;;###autoload
4839 (defun orgtbl-to-html (table params)
4840 "Convert the orgtbl-mode TABLE to HTML.
4841 TABLE is a list, each entry either the symbol `hline' for a horizontal
4842 separator line, or a list of fields for that line.
4843 PARAMS is a property list of parameters that can influence the conversion.
4844 Currently this function recognizes the following parameters:
4846 :splice When set to t, return only table body lines, don't wrap
4847 them into a <table> environment. Default is nil.
4849 The general parameters :skip and :skipcols have already been applied when
4850 this function is called. The function does *not* use `orgtbl-to-generic',
4851 so you cannot specify parameters for it."
4852 (require 'ox-html)
4853 (let ((output (org-export-string-as
4854 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4855 (if (not (plist-get params :splice)) output
4856 (org-trim
4857 (replace-regexp-in-string
4861 ;;;###autoload
4862 (defun orgtbl-to-texinfo (table params)
4863 "Convert the orgtbl-mode TABLE to TeXInfo.
4864 TABLE is a list, each entry either the symbol `hline' for a horizontal
4865 separator line, or a list of fields for that line.
4866 PARAMS is a property list of parameters that can influence the conversion.
4867 Supports all parameters from `orgtbl-to-generic'. Most important for
4868 TeXInfo are:
4870 :splice nil/t When set to t, return only table body lines, don't wrap
4871 them into a multitable environment. Default is nil.
4873 :fmt fmt A format to be used to wrap the field, should contain
4874 %s for the original field value. For example, to wrap
4876 This may also be a property list with column numbers and
4878 Each format also may be a function that formats its one
4879 argument.
4882 are computed automatically from the width of the columns
4883 under org-mode.
4885 The general parameters :skip and :skipcols have already been applied when
4886 this function is called."
4887 (let* ((total (float (apply '+ org-table-last-column-widths)))
4888 (colfrac (or (plist-get params :cf)
4889 (mapconcat
4890 (lambda (x) (format "%.3f" (/ (float x) total)))
4891 org-table-last-column-widths " ")))
4892 (params2
4893 (list
4894 :tstart (concat "@multitable @columnfractions " colfrac)
4895 :tend "@end multitable"
4896 :lstart "@item " :lend "" :sep " @tab "
4897 :hlstart "@headitem ")))
4898 (require 'ox-texinfo)
4899 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4901 ;;;###autoload
4902 (defun orgtbl-to-orgtbl (table params)
4903 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4904 Useful when slicing one table into many. The :hline, :sep,
4905 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4906 and :tend suppress strings without splicing; they can be set to
4907 provide ORGTBL directives for the generated table."
4908 (let* ((params2
4909 (list
4910 :remove-newlines t
4911 :tstart nil :tend nil
4912 :hline "|---"
4913 :sep " | "
4914 :lstart "| "
4915 :lend " |"))
4916 (params (org-combine-plists params2 params)))
4917 (with-temp-buffer
4918 (insert (orgtbl-to-generic table params))
4919 (goto-char (point-min))
4920 (while (re-search-forward org-table-hline-regexp nil t)
4921 (org-table-align))
4922 (buffer-substring 1 (buffer-size)))))
4924 (defun orgtbl-to-table.el (table params)
4925 "Convert the orgtbl-mode TABLE into a table.el table."
4926 (with-temp-buffer
4927 (insert (orgtbl-to-orgtbl table params))
4928 (org-table-align)
4929 (replace-regexp-in-string
4930 "-|" "-+"
4931 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4933 (defun orgtbl-to-unicode (table params)
4934 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4935 You need the ascii-art-to-unicode.el package for this. You can download
4936 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4937 (with-temp-buffer
4938 (insert (orgtbl-to-table.el table params))
4939 (goto-char (point-min))
4940 (if (or (featurep 'ascii-art-to-unicode)
4941 (require 'ascii-art-to-unicode nil t))
4942 (aa2u)
4943 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4944 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4945 "Link to ascii-art-to-unicode.el") org-stored-links))
4946 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4947 (buffer-string)))
4949 (defun org-table-get-remote-range (name-or-id form)
4950 "Get a field value or a list of values in a range from table at ID.
4952 NAME-OR-ID may be the name of a table in the current file as set
4954 will then be used. Alternatively, it may be an ID referring to
4955 any entry, also in a different file. In this case, the first
4956 table in that entry will be referenced.
4960 The return value is either a single string for a single field, or a
4961 list of the fields in the rectangle."
4962 (save-match-data
4963 (let ((case-fold-search t) (id-loc nil)
4964 ;; Protect a bunch of variables from being overwritten
4965 ;; by the context of the remote table
4966 org-table-column-names org-table-column-name-regexp
4967 org-table-local-parameters org-table-named-field-locations
4968 org-table-current-line-types org-table-current-begin-line
4969 org-table-current-begin-pos org-table-dlines
4970 org-table-current-ncol
4971 org-table-hlines org-table-last-alignment
4972 org-table-last-column-widths org-table-last-alignment
4973 org-table-last-column-widths tbeg
4974 buffer loc)
4975 (setq form (org-table-convert-refs-to-rc form))
4976 (save-excursion
4977 (save-restriction
4978 (widen)
4979 (save-excursion
4980 (goto-char (point-min))
4981 (if (re-search-forward
4984 nil t)
4985 (setq buffer (current-buffer) loc (match-beginning 0))
4986 (setq id-loc (org-id-find name-or-id 'marker))
4987 (unless (and id-loc (markerp id-loc))
4989 (setq buffer (marker-buffer id-loc)
4990 loc (marker-position id-loc))
4991 (move-marker id-loc nil)))
4992 (with-current-buffer buffer
4993 (save-excursion
4994 (save-restriction
4995 (widen)
4996 (goto-char loc)
4997 (forward-char 1)
4999 (not (match-beginning 1)))
5000 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5001 (setq tbeg (point-at-bol))
5002 (org-table-get-specials)
5003 (setq form (org-table-formula-substitute-names
5004 (org-table-formula-handle-first/last-rc form)))
5005 (if (and (string-match org-table-range-regexp form)
5006 (> (length (match-string 0 form)) 1))
5007 (save-match-data
5008 (org-table-get-range (match-string 0 form) tbeg 1))
5009 form)))))))))
5011 (defmacro org-define-lookup-function (mode)
5012 (let ((mode-str (symbol-name mode))
5013 (first-p (equal mode 'first))
5014 (all-p (equal mode 'all)))
5015 (let ((plural-str (if all-p "s" "")))
5016 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5017 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5018 If R-LIST is nil, return matching element%s of S-LIST.
5019 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5020 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5021 This function is generated by a call to the macro `org-define-lookup-function'."
5022 mode-str plural-str plural-str plural-str)
5023 (let ,(let ((lvars '((p (or predicate 'equal))
5024 (sl s-list)
5025 (rl (or r-list s-list))
5026 (ret nil))))
5027 (if first-p (add-to-list 'lvars '(match-p nil)))
5028 lvars)
5029 (while ,(if first-p '(and (not match-p) sl) 'sl)
5030 (progn
5031 (if (funcall p val (car sl))
5032 (progn
5033 ,(if first-p '(setq match-p t))
5034 (let ((rval (car rl)))
5035 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5036 (setq sl (cdr sl) rl (cdr rl))))
5037 ret)))))
5039 (org-define-lookup-function first)
5040 (org-define-lookup-function last)
5041 (org-define-lookup-function all)
5043 (provide 'org-table)
5045 ;; Local variables:
5046 ;; generated-autoload-file: "org-loaddefs.el"
5047 ;; End:
5049 ;;; org-table.el ends here