| blob | f19c0270cbfd4836aaf40bbdfa69b9e6823b300d |
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."
450 lines))))
459 nil)
463 ;; remove the first column
466 lines))))
472 ;;;###autoload
474 "Use the table.el package to insert a new table.
475 If there is already a table at point, convert between Org-mode tables
476 and table.el tables."
489 ;;;###autoload
491 "Convert region to table, or create an empty table.
492 If there is an active region, convert it to a table, using the function
493 `org-table-convert-region'. See the documentation of that function
494 to learn how the prefix argument is interpreted to determine the field
495 separator.
496 If there is no such region, create an empty table with `org-table-create'."
502 ;;;###autoload
504 "Query for a size and insert a table skeleton.
524 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
528 ;; Insert a hline after the first row.
535 ;;;###autoload
537 "Convert region to a table.
538 The region goes from BEG0 to END0, but these borders will be moved
539 slightly, to make sure a beginning of line in the first line is included.
541 SEPARATOR specifies the field separator in the lines. It can have the
542 following values:
544 '(4) Use the comma as a field separator
545 '(16) Use a TAB as field separator
546 integer When a number, use that many spaces as field separator
547 nil When nil, the command tries to be smart and figure out the
548 separator in the following way:
549 - when each line contains a TAB, assume TAB-separated material
550 - when each line contains a comma, assume CSV material
551 - else, assume one or more SPACE characters as separator."
555 re)
562 ;; Get the right field separator
573 ;; parse the csv stuff
596 ;;;###autoload
598 "Import FILE as a table.
599 The file is assumed to be tab-separated. Such files can be produced by most
600 spreadsheet and database applications. If no tabs (at least one per line)
601 are found, lines will be split on whitespace into fields."
612 ;;;###autoload
614 "Export table to a file, with configurable format.
615 Such a file can be imported into usual spreadsheet programs.
617 FILE can be the output file name. If not given, it will be taken
618 from a TABLE_EXPORT_FILE property in the current entry or higher
619 up in the hierarchy, or the user will be prompted for a file
620 name. FORMAT can be an export format, of the same kind as it
621 used when `orgtbl-mode' sends a table in a different format.
623 The command suggests a format depending on TABLE_EXPORT_FORMAT,
624 whether it is set locally or up in the hierarchy, then on the
625 extension of the given file name, and finally on the variable
626 `org-table-export-default-format'."
640 buf deffmt-readable fileext)
656 org-table-export-default-format))
674 'hline
677 skipcols i0)))
678 lines))
682 skipcols i0))
685 skipcols i0)))
702 "Marker at the beginning of the table last aligned.
705 "Marker at the end of the table last aligned.
708 "List of flags for flushright alignment, from the last re-alignment.
711 "List of max width of fields in each column.
714 "Non-nil means debug table formulas.
726 ;;;###autoload
728 "Align the table at point by aligning all vertical bars."
731 ;; Limits of table
734 ;; Current cursor position
740 column
742 rfmt hfmt
750 emptystrings links dates emph raise narrow
751 falign falign1 fmax f1 len c e space)
754 ;; Check if we have links or dates
766 ;; Make sure the link properties are right
768 ;; Make sure the date properties are right
773 ;; Check if we are narrowing any columns
776 org-format-transports-properties-p
781 ;; Get the rows
784 ;; Store the indentation of the first line
787 ;; Mark the hlines by setting the corresponding element to nil
788 ;; At the same time, we remove trailing space.
791 nil
794 l)))
795 lines))
796 ;; Get the data fields by splitting the lines.
801 ;; How many fields in the longest line?
808 ;; A list of empty strings to fill any short rows on output
810 ;; Check for special formatting.
814 ;; Check if there is an explicit width specified
824 ;; Find fields that are wider than fmax, and shorten them
830 'help-echo
831 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
839 xx)))))
840 ;; Get the maximum width for each column
842 lengths)
843 ;; Get the fraction of numbers, to decide about alignment of the column
849 nil
856 ;; Store the alignment of this table, for later editing of single fields
858 org-table-last-column-widths lengths)
860 ;; With invisible characters, `format' does not get the field width right
861 ;; So we need to make these fields wide by hand.
879 ;; Compute the formats needed for output of the table
892 hfmt))
896 ;; Replace the old one
903 ;; Try to move to the old location
912 ))
914 ;;;###autoload
916 "Find the beginning of the table and return its position.
917 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
921 org-table-border-regexp)
922 nil t))
928 ;;;###autoload
930 "Find the end of the table and return its position.
931 With argument TABLE-TYPE, go to the end of a table.el-type table."
935 org-table-border-regexp)
936 nil t))
941 ;;;###autoload
943 "Justify the current field, text to left, number to right.
944 Optional argument NEW may specify text to replace the current field content."
953 ;; This is not the same table, force a full re-align
959 l f n o e)
982 ;;;###autoload
984 "Go to the next field in the current table, creating new lines as needed.
985 Before doing so, re-align the table if necessary."
990 org-table-may-need-update)
1001 org-table-tab-jumps-over-hlines
1012 ;;;###autoload
1014 "Go to the previous field in the table.
1015 Before doing so, re-align the table if necessary."
1020 org-table-may-need-update)
1035 "Move to the end of the current table field.
1036 If already at or after the end, move to the end of the next table field.
1037 With numeric argument N, move N-1 fields forward first."
1050 "Move to the beginning of the current table field.
1051 If already at or before the beginning, move to the beginning of the
1052 previous field.
1053 With numeric argument N, move N-1 fields backward first."
1066 ;;;###autoload
1068 "Go to the next row (same column) in the current table.
1069 Before doing so, re-align the table if necessary."
1077 org-table-may-need-update)
1090 ;;;###autoload
1092 "Copy a field down in the current column.
1093 If the field at the cursor is empty, copy into it the content of
1094 the nearest non-empty field above. With argument N, use the Nth
1095 non-empty field. If the current field is not empty, it is copied
1096 down to the next row, and the cursor is moved with it.
1097 Therefore, repeating this command causes the column to be filled
1098 row-by-row.
1099 If the variable `org-table-copy-increment' is non-nil and the
1100 field is an integer or a timestamp, it will be incremented while
1101 copying. In the case of a timestamp, increment by one day."
1109 txt)
1121 beg t))
1144 "Is point inside a table data field?
1145 I.e. not on a hline or before the first or after the last column?
1146 This actually throws an error, so it aborts the current command."
1152 nil
1154 t))
1160 "Get the field in table line LINE, column COLUMN.
1161 If LINE is larger than the number of data lines in the table, the function
1162 returns nil. However, if COLUMN is too large, we will simply return an
1163 empty string.
1164 If LINE is nil, use the current line.
1165 If column is nil, use the current column."
1172 "Put VALUE into line LINE, column COLUMN.
1173 When ALIGN is set, also realign the table."
1182 "Return the index of the current data line."
1189 cnt))
1192 "Go to the Nth data line in the current table.
1193 Return t when the line exists, nil if it does not exist."
1200 ;;;###autoload
1202 "Blank the current table field or active region."
1219 "Return the value of the field in column N of current row.
1220 N defaults to current field.
1221 If REPLACE is a string, replace field with this value. The return value
1222 is always the old value."
1231 t t))
1233 val)
1236 ;;;###autoload
1238 "Show info about the current field, and highlight any reference at point."
1247 org-table-named-field-locations)))
1267 dline col
1269 dline col ref1
1271 ;; FIXME: formula info not correct if special table line
1281 "Find out which column we are in."
1291 cnt)))
1293 ;;;###autoload
1295 "Find out what table data line we are in.
1296 Only data lines count for this."
1308 cnt)))
1310 ;;;###autoload
1312 "Move the cursor to the Nth column in the current table line.
1313 With optional argument ON-DELIM, stop with point before the left delimiter
1314 of the field.
1315 If there are less than N fields, just go to after the last delimiter.
1316 However, when FORCE is non-nil, create new columns if necessary."
1326 t)))))
1333 ;;;###autoload
1335 "Insert a new column into the table."
1343 ;; Current cursor position
1349 nil
1363 "Find a data line in the current table, which is needed for column commands."
1366 t
1377 t
1382 "Turn a buffer line number into a data line number.
1383 If there is no data line in this line, return nil.
1384 If there is no matching dline (most likely te reference was a hline), the
1385 first dline below it is used. When ABOVE is non-nil, the one above is used."
1388 i)
1401 nil))
1403 ;;;###autoload
1405 "Delete a column from the table."
1414 ;; Current cursor position
1420 nil
1436 ;;;###autoload
1438 "Move column to the right."
1441 ;;;###autoload
1443 "Move column to the left."
1447 ;;;###autoload
1449 "Move the current column to the right. With arg LEFT, move to the left."
1459 ;; Current cursor position
1469 nil
1487 ;;;###autoload
1489 "Move table row down."
1492 ;;;###autoload
1494 "Move table row up."
1498 ;;;###autoload
1500 "Move the current table line down. With arg UP, move it up."
1509 txt hline2p)
1532 ;;;###autoload
1534 "Insert a new row above the current line into the table.
1535 With prefix ARG, insert below the current line."
1541 ;; Fix the first field if necessary
1554 ;;;###autoload
1556 "Insert a horizontal-line below the current line into the table.
1557 With prefix ABOVE, insert above the current line."
1578 ;;;###autoload
1580 "Insert a hline and move to the row below that line."
1594 In particular, this does handle wide and invisible characters."
1596 ;; It's a hline, just map the characters
1602 t t s)))
1603 s))
1605 ;;;###autoload
1607 "Delete the current row or horizontal line from the table."
1621 ;;;###autoload
1623 "Sort table lines according to the column at point.
1625 The position of point indicates the column to be used for
1626 sorting, and the range of lines is the range between the nearest
1627 horizontal separator lines, or the entire table of no such lines
1628 exist. If point is before the first column, you will be prompted
1629 for the sorting column. If there is an active region, the mark
1630 specifies the first line and the sorting column, while point
1631 should be in the last line to be included into the sorting.
1633 The command then prompts for the sorting type which can be
1634 alphabetically, numerically, or by time (as given in a time stamp
1635 in the field). Sorting in reverse order is also possible.
1637 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1639 If SORTING-TYPE is specified when this function is called from a Lisp
1640 program, no prompting will take place. SORTING-TYPE must be a character,
1641 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1642 should be done in reverse order."
1647 beg end bcol ecol tend tbeg column lns pos)
1692 x))
1706 ;;;###autoload
1708 "Copy region in table to the clipboard and blank all relevant fields.
1709 If there is no active region, use just the field at point."
1715 ;;;###autoload
1717 "Copy rectangular region in table to clipboard.
1718 A special clipboard is used which can only be accessed
1719 with `org-table-paste-rectangle'."
1723 current-prefix-arg))
1725 region cols
1751 org-table-clip))
1753 ;;;###autoload
1755 "Paste a rectangular region into a table.
1756 The upper right corner ends up in the current field. All involved fields
1757 will be overwritten. If the rectangle does not fit into the present table,
1758 the table is enlarged as needed. The process ignores horizontal separator
1759 lines."
1769 c cols field)
1784 ;;;###autoload
1786 "Convert from `org-mode' table to table.el and back.
1787 Obviously, this only works within limits. When an Org-mode table is
1788 converted to table.el, all horizontal separator lines get lost, because
1789 table.el uses these as cell boundaries and has no notion of horizontal lines.
1790 A table.el table can be converted to an Org-mode table only if it does not
1791 do row or column spanning. Multiline cells will become multiple cells.
1792 Beware, Org-mode does not test if the table can be successfully converted - it
1793 blindly applies a recipe that works for simple tables."
1797 ;; convert to Org-mode table
1806 ;; convert to table.el table
1809 ;; first, get rid of all horizontal lines
1813 ;; insert a hline before first
1817 ;; insert a hline after each line
1822 ;; replace "+" at beginning and ending of hlines
1831 "Transpose orgmode table at point and eliminate hlines.
1832 So a table like
1834 | 1 | 2 | 4 | 5 |
1835 |---+---+---+---|
1836 | a | b | c | d |
1837 | e | f | g | h |
1839 will be transposed as
1841 | 1 | a | e |
1842 | 2 | b | f |
1843 | 4 | c | g |
1844 | 5 | d | h |
1846 Note that horizontal lines disappeared."
1856 table)))
1863 ;;;###autoload
1865 "Wrap several fields in a column like a paragraph.
1866 This is useful if you'd like to spread the contents of a field over several
1867 lines, in order to keep the table compact.
1869 If there is an active region, and both point and mark are in the same column,
1870 the text in the column is wrapped to minimum width for the given number of
1871 lines. Generally, this makes the table more compact. A prefix ARG may be
1873 formats the selected text to two lines. If the region was longer than two
1874 lines, the remaining lines remain empty. A negative prefix argument reduces
1875 the current number of lines by that amount. The wrapped text is pasted back
1876 into the table. If you formatted it to more lines than it was before, fields
1877 further down in the table get overwritten - so you might need to make space in
1878 the table first.
1880 If there is no region, the current field is split at the cursor position and
1881 the text fragment to the right of the cursor is prepended to the field one
1882 line down.
1884 If there is no region, but you specify a prefix ARG, the current field gets
1885 blank, and the content is appended to the field above."
1889 ;; There is a region: fill as a paragraph
1893 nlines)
1900 arg)
1904 nil nlines)))
1908 ;; No region, split the current field at point
1912 ;; combine with field above
1922 ;; split field
1934 ;;;###autoload
1936 "Edit table field in a different window.
1937 This is mainly useful for fields that contain hidden parts.
1939 it can be edited in place."
1948 display t intangible t))
1961 p)
1977 intangible t))
1985 "Finish editing a table data field.
1986 Remove all newline characters, insert the result into the table, realign
1987 the table and kill the editing buffer."
1991 text)
2008 "Minor mode to make the table field editor window follow the cursor.
2009 When this mode is active, the field editor window will always show the
2010 current field. The mode exits automatically when the cursor leaves the
2011 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2012 nil " TblFollow" nil
2028 ;; We have left the table, exit the follow mode
2038 ;;;###autoload
2040 "Sum numbers in region of current table column.
2041 The result will be displayed in the echo area, and will be available
2044 If there is an active region, it is interpreted as a rectangle and all
2045 numbers in that rectangle will be summed. If there is no active
2046 region and point is located in a table column, sum all numbers in that
2047 column.
2049 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2050 numbers are assumed to be times as well (in decimal hours) and the
2051 numbers are added as such.
2053 If NLAST is a number, only the NLAST fields will actually be summed."
2080 items1)))
2087 s diff)
2095 sres))))
2118 "Return the formula active for the current field.
2119 Assumes that specials are in place.
2120 If KEY is given, return the key to this formula.
2124 org-table-named-field-locations)))
2138 "Read a formula from the minibuffer, offer stored formula as default.
2139 When NAMED is non-nil, look for a named equation."
2143 org-table-named-field-locations)))
2150 name
2151 ref)
2161 stored)
2163 equation)
2170 scol))
2172 'org-table-formula-history
2173 )))))
2174 mustsave)
2176 ;; remove formula
2183 ;; We set the column equation, delete the named one.
2185 mustsave t))
2191 eq))
2194 "Store the list of formulas below the current table."
2201 ;; don't overwrite TBLFM, we might use text properties to store stuff
2217 ;; Fake a high number to make sure this is sorted at the end.
2224 a)
2234 "Compare two formulas for sorting."
2239 ;;;###autoload
2241 "Return an alist with the stored formulas directly after current table."
2250 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2269 "Modify the equations after the table structure has been edited.
2271 For all numbers larger than LIMIT, shift them by DELTA."
2283 s n a)
2289 "Change makes TBLFM term %s invalid, use undo to recover"
2305 "Get the column names and local parameters for this table."
2308 names name fields fields1 field cnt
2309 c v l line col types dlines hlines last-dline)
2311 org-table-local-parameters nil
2312 org-table-named-field-locations nil
2313 org-table-current-begin-line nil
2314 org-table-current-begin-pos nil
2315 org-table-current-line-types nil
2334 org-table-local-parameters))))
2350 ;; Analyse the line types
2354 l org-table-current-begin-line)
2371 al al2)
2381 ;;;###autoload
2384 If yes, store the formula and apply it."
2385 ;; We already know we are in a table. Get field will only return a formula
2386 ;; when appropriate. It might return a separator line, but no problem.
2389 named eq)
2400 "List of commands triggering the recalculation of a line.
2412 ;;;###autoload
2414 "Rotate the recalculation mark in the first column.
2415 If in any row, the first field is not consistent with a mark,
2416 insert a new column for the markers.
2417 When there is an active region, change all the lines in the region,
2418 after prompting for the marking character.
2419 After each change, a message will be displayed indicating the meaning
2420 of the new mark."
2435 epos new)
2442 newchar))
2474 ;;;###autoload
2476 "Recompute the current line if marked for it, and if we haven't just done it."
2496 org-tbl-calc-modes)
2498 ;;;###autoload
2500 suppress-align suppress-const
2501 suppress-store suppress-analysis)
2502 "Replace the table field value at the cursor by the result of a calculation.
2504 This function makes use of Dave Gillespie's Calc package, in my view the
2505 most exciting program ever written for GNU Emacs. So you need to have Calc
2506 installed in order to use this function.
2508 In a table, this command replaces the value in the current field with the
2510 formula, by storing it in a special line below the table. When called
2511 with a `C-u' prefix, the current field must be a named field, and the
2512 formula is installed as valid in only this specific field.
2514 When called with two `C-u' prefixes, insert the active equation
2515 for the field back into the current field, so that it can be
2517 to check the referenced fields.
2519 When called, the command first prompts for a formula, which is read in
2520 the minibuffer. Previously entered formulas are available through the
2521 history list, and the last used formula is offered as a default.
2522 These stored formulas are adapted correctly when moving, inserting, or
2523 deleting columns with the corresponding commands.
2525 The formula can be any algebraic expression understood by the Calc package.
2526 For details, see the Org-mode manual.
2528 This function can also be called from Lisp programs and offers
2529 additional arguments: EQUATION can be the formula to apply. If this
2530 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2531 used to speed-up recursive calls by by-passing unnecessary aligns.
2532 SUPPRESS-CONST suppresses the interpretation of constants in the
2533 formula, assuming that this has been done already outside the function.
2534 SUPPRESS-STORE means the formula should not be stored, either because
2535 it is already stored, or because it is a modified equation that should
2536 not overwrite the stored one."
2552 equation
2558 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2559 duration duration-output-format)
2560 ;; Parse the format string. Since we have a lot of modes, this is
2561 ;; a lot of work. However, I think calc still uses most of the time.
2574 'calc-float-format
2577 n))))
2581 duration-output-format nil
2585 duration-output-format org-table-duration-custom-format
2586 numbers t
2609 ;; replace fields with duration values if relevant
2613 fields)))
2619 x))
2620 fields)))
2626 ;; Insert row and column number of formula result field
2637 t t form)))
2639 ;; Check for old vertical references
2641 ;; Insert remote references
2653 rmtrng))
2654 keep-empty numbers lispp))
2655 t t form)))
2656 ;; Insert complex ranges
2664 ;; possibly handle durations
2669 formrg)
2670 keep-empty numbers lispp)))
2675 ;; Insert simple ranges
2684 keep-empty numbers lispp))
2685 t t form)))
2687 ;; Insert the references to fields in same row
2697 x keep-empty numbers lispp))
2698 t t form)))
2710 ;; Use <...> time-stamps so that Calc can handle them
2713 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2724 form
2731 duration-output-format)
2732 ev)))
2737 Orig: %s
2738 $xyz-> %s
2739 @r$c-> %s
2771 prop value)))
2774 "Get a calc vector from a column, according to descriptor DESC.
2775 Optional arguments TBEG and COL can give the beginning of the table and
2776 the current column, to avoid unnecessary parsing.
2778 HIGHLIGHT means just highlight the range.
2780 When CORNERS-ONLY is set, only return the corners of the range as
2781 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2782 in the buffer and column1 and column2 are table column numbers."
2789 beg end c1 c2 r1 r2 rangep tmp)
2806 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2813 ;; just one field
2820 ;; A range, return a vector
2821 ;; First sort the numbers to get a regular rectangle
2825 ;; Only return the corners of the range
2827 ;; Copy the range values into a list
2841 ;; return string representation of calc vector
2846 "Analyze descriptor DESC and retrieve the corresponding line number.
2847 The cursor is currently in line CLINE, the table begins in line BLINE,
2848 and TABLE is a vector with line types."
2856 ;; 1 2 3 4 5 6
2876 nil hn cline desc)))
2879 rel on cline desc)))
2883 "FIXME: Needs more documentation."
2896 nil))
2897 t)))
2901 desc cline)
2902 i)))
2907 s))
2910 "Convert list ELEMENTS to something appropriate to insert into formula.
2911 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2912 NUMBERS indicates that everything should be converted to numbers.
2913 LISPP non-nil means to return something appropriate for a Lisp
2914 list, 'literal is for the format specifier L."
2915 ;; Calc nan (not a number) is used for the conversion of the empty
2916 ;; field to a reference for several reasons: (i) It is accepted in a
2917 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2918 ;; (ii) In a single field (not in range) it can be distinguished
2919 ;; from "(nan)" which is the reference made from a single field
2920 ;; containing "nan".
2922 ;; field reference
2925 elements
2927 ""
2936 ;; range reference
2941 elements))))
2947 x
2955 x)
2957 elements
2960 ;;;###autoload
2962 "Set `org-table-formula-constants-local' in the current buffer."
2978 ;;;###autoload
2980 "Recalculate the current table line by applying all stored formulas.
2981 With prefix arg ALL, do this for all lines in the table.
2982 With the prefix argument ALL is `(16)' \
2984 it is the symbol `iterate', recompute the table until it no longer changes.
2985 If NOALIGN is not nil, do not re-align the table after the computations
2986 are done. This is typically used internally to save time, if it is
2987 known that the table will be realigned a little later anyway."
3002 seen-fields lhs1
3004 ;; Insert constants in all formulas
3020 eqlist))
3021 ;; Split the equation list
3027 ;; Expand ranges in lhs of formulas
3030 ;; Get the correct line range to process
3036 ;; This is a table with marked lines, compute selected lines
3038 ;; Move forward to the first non-header line
3049 ;; First find the named fields, and mark them untouchable.
3050 ;; Also check if several field/range formulas try to set the same field.
3069 name)))
3079 ;; Now evaluate the column formulas, but skip fields covered by
3080 ;; field formulas
3084 ;; Unprotected line, recalculate
3096 ;; Now evaluate the field formulas
3110 ;; back to initial position
3117 ;;;###autoload
3119 "Recalculate the table until it does not change anymore.
3120 The maximum number of iterations is 10, but you can choose a different value
3121 with the prefix ARG."
3126 thistbl)
3140 ;;;###autoload
3142 "Recalculate all tables in the current buffer."
3149 ;;;###autoload
3151 "Iterate all tables in the buffer, to converge inter-table dependencies."
3156 c1)
3172 "Apply the #+TBLFM in the line at point to the table."
3178 s e)
3180 ;; Insert a temporary formula at right after the table
3185 ;; Recalculate the table
3191 ;; delete the formula inserted temporarily
3195 "Find the beginning of the TBLFM lines and return its position.
3196 Return nil when the beginning of TBLFM line was not found."
3200 org-table-TBLFM-begin-regexp
3201 nil t))
3205 "Expand list of formulas.
3206 If some of the RHS in the formulas are ranges or a row reference, expand
3207 them to individual field equations for each field."
3213 ;; This just refers to one fixed field
3216 ;; This just refers to one fixed named field
3238 "Replace @<, @>, $<, $> with first/last row/column of the table.
3239 So @< and $< will always be replaced with @1 and $1, respectively.
3240 The advantage of these special markers are that structure editing of
3241 the table will not change them, while @1 and $1 will be modified
3242 when a line/row is swapped out of that privileged position. So for
3243 formulas that use a range of rows or columns, it may often be better
3245 borders of the table using the @< @> $< $> makers."
3248 s start)
3253 org-table-current-ncol)
3257 len
3264 s)
3267 "Replace $const with values in string F."
3269 ;; First, check for column names
3274 ;; Parameters and constants
3276 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3286 f))
3289 "Find the value for a parameter or constant in a formula.
3290 Parameters get priority."
3321 map))
3328 "--"
3331 "--"
3332 "Shift Reference at Point"
3337 "-"
3338 "Change Test Row for Column Formulas"
3341 "--"
3346 org-table-overlay-coordinates)]
3347 "--"
3353 ;;;###autoload
3355 "Edit the formulas of the current table in a separate buffer."
3357 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3371 entry s type title)
3374 ;; Keep global-font-lock-mode from turning on font-lock-mode
3415 "Convert a formula from internal to user representation."
3418 s))
3421 "Convert a formula from user to internal representation."
3424 s))
3427 "Convert spreadsheet references from A7 to @7$28.
3428 Works for single references, but also for entire formulas and even the
3429 full TBLFM line."
3431 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3434 ;; format match, just advance
3439 ;; 3.e5 or something like this.
3442 ;; (member (match-string 1 s)
3443 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3444 )
3445 ;; function name, just advance
3455 t t s)))))
3456 s))
3459 "Convert spreadsheet references from to @7$28 to AB7.
3460 Works for single references, but also for entire formulas and even the
3461 full TBLFM line."
3468 t t s)))
3473 t nil s)))
3474 s)
3477 "Convert a base 26 number represented by letters into an integer.
3478 For example: AB -> 28."
3484 n))
3487 "Convert an integer into a base 26 number represented by letters.
3488 For example: 28 -> AB."
3493 s))
3496 "Convert a time string into numerical duration in seconds.
3497 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3498 If S is a string representing a number, keep this number."
3500 s
3523 "Convert a number of seconds to a time string.
3524 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3525 minutes or seconds."
3540 "Convert all references in this buffer, using FUNCTION."
3550 "Convert all references in the buffer from B3 to @3$2 and back."
3560 "Shift the reference at point one row/hline up."
3564 "Shift the reference at point one row/hline down."
3568 "Shift the reference at point one field to the left."
3572 "Shift the reference at point one field to the right."
3583 ;; A B3-like reference
3589 ;; An internal reference
3595 "Re-match the group N, and replace it with the shifted reference."
3600 t t)))
3603 "Shift a reference part REF.
3604 If DECR is set, decrease the references row/column, else increase.
3605 If HLINE is set, this may be a hline reference, it certainly is not
3606 a translation reference."
3635 "Toggle the display of coordinates in the referenced table."
3644 "Parse the buffer for formula definitions and install them.
3645 With prefix ARG, apply the new formulas to the table."
3655 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3656 nil t)
3680 "Abort editing formulas, without installing the changes."
3691 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3732 "Show the location/value of the $ expression at point."
3741 var name e what match dest)
3746 "$1.."
3829 ;; column number
3857 org-table-fedit-scroll-down))))
3869 "Make sure the cursor is in a dataline in a table."
3878 p1 p2)))
3883 "Move cursor one line up in the window showing the table."
3888 "Move cursor one line down in the window showing the table."
3893 "Move the cursor in the window showing the table.
3894 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3919 "Add a new overlay."
3925 "Highlight rectangular region in a table."
3929 l1 c1 l2 c2 tmp)
3953 "Remove the rectangle overlays."
3964 "Add overlays to the table at point, to show row/column coordinates."
3992 ;;;###autoload
3994 "Toggle the display of Row/Column numbers in tables."
4005 ;;;###autoload
4007 "Toggle the formula debugger in tables."
4013 ;;; The orgtbl minor mode
4015 ;; Define a minor mode which can be used in other modes in order to
4016 ;; integrate the org-mode table editor.
4018 ;; This is really a hack, because the org-mode table editor uses several
4019 ;; keys which normally belong to the major mode, for example the TAB and
4020 ;; RET keys. Here is how it works: The minor mode defines all the keys
4021 ;; necessary to operate the table editor, but wraps the commands into a
4022 ;; function which tests if the cursor is currently inside a table. If that
4023 ;; is the case, the table editor command is executed. However, when any of
4024 ;; those keys is used outside a table, the function uses `key-binding' to
4025 ;; look up if the key has an associated command in another currently active
4026 ;; keymap (minor modes, major mode, global), and executes that command.
4027 ;; There might be problems if any of the keys used by the table editor is
4028 ;; otherwise used as a prefix key.
4030 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4031 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4032 ;; addresses this by checking explicitly for both bindings.
4034 ;; The optimized version (see variable `orgtbl-optimized') takes over
4035 ;; all keys which are bound to `self-insert-command' in the *global map*.
4036 ;; Some modes bind other commands to simple characters, for example
4037 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4038 ;; active, this binding is ignored inside tables and replaced with a
4039 ;; modified self-insert.
4057 ;; Install it as a minor mode.
4061 ;;;###autoload
4063 "The `org-mode' table editor as a minor mode for use in other modes."
4068 ;; Exit without error, in case some hook functions calls this
4069 ;; by accident in org-mode.
4073 ;; Make sure we are first in minor-mode-map-alist
4075 ;; FIXME: maybe it should use emulation-mode-map-alists?
4082 auto-fill-inhibit-regexp)
4086 auto-fill-inhibit-regexp)
4087 orgtbl-line-start-regexp))
4105 "Remove all properties related to narrow-column invisibility."
4118 "Create a function for binding in the table minor mode.
4119 FUN is the command to call inside a table. N is used to create a unique
4120 command name. KEYS are keys that should be checked in for a command
4121 to execute outside of tables."
4127 "Outside of tables, run the binding of `"
4139 keys)
4143 "Error when there is no default binding for a table key."
4148 "Setup orgtbl keymaps."
4179 elt key fun cmd)
4187 ;; Special treatment needed for TAB and RET
4207 [(tab)] "\C-i")))
4209 (org-defkey orgtbl-mode-map [backtab]
4211 [backtab] [S-iso-lefttab] [(shift tab)]
4212 [(tab)] "\C-i"))
4214 (org-defkey orgtbl-mode-map "\M-\C-m"
4215 (orgtbl-make-binding 'org-table-wrap-region 105
4216 "\M-\C-m" [(meta return)]))
4217 (org-defkey orgtbl-mode-map [(meta return)]
4218 (orgtbl-make-binding 'org-table-wrap-region 106
4219 [(meta return)] "\M-\C-m"))
4221 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4222 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4224 (when orgtbl-optimized
4225 ;; If the user wants maximum table support, we need to hijack
4226 ;; some standard editing functions
4227 (org-remap orgtbl-mode-map
4228 'self-insert-command 'orgtbl-self-insert-command
4229 'delete-char 'org-delete-char
4230 'delete-backward-char 'org-delete-backward-char)
4231 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4232 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4233 '("OrgTbl"
4234 ["Create or convert" org-table-create-or-convert-from-region
4235 :active (not (org-at-table-p)) :keys "C-c |" ]
4236 "--"
4237 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4238 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4239 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4240 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4241 "--"
4242 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4243 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4244 ["Copy Field from Above"
4245 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4246 "--"
4247 ("Column"
4248 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4249 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4250 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4251 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4252 ("Row"
4253 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4254 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4255 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4256 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4257 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4258 "--"
4259 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4260 ("Rectangle"
4261 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4262 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4263 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4264 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4265 "--"
4266 ("Radio tables"
4267 ["Insert table template" orgtbl-insert-radio-table
4268 (assq major-mode orgtbl-radio-table-templates)]
4269 ["Comment/uncomment table" orgtbl-toggle-comment t])
4270 "--"
4271 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4272 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4273 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4274 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4275 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4276 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4277 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4278 ["Sum Column/Rectangle" org-table-sum
4279 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4280 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4281 ["Debug Formulas"
4282 org-table-toggle-formula-debugger :active (org-at-table-p)
4283 :keys "C-c {"
4284 :style toggle :selected org-table-formula-debug]
4285 ["Show Col/Row Numbers"
4286 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4287 :keys "C-c }"
4288 :style toggle :selected org-table-overlay-coordinates]
4289 ))
4290 t))
4292 (defun orgtbl-ctrl-c-ctrl-c (arg)
4293 "If the cursor is inside a table, realign the table.
4294 If it is a table to be sent away to a receiver, do it.
4295 With prefix arg, also recompute table."
4296 (interactive "P")
4297 (let ((case-fold-search t) (pos (point)) action)
4298 (save-excursion
4299 (beginning-of-line 1)
4300 (setq action (cond
4304 (cond
4305 ((integerp action)
4306 (goto-char action)
4307 (org-table-maybe-eval-formula)
4308 (if arg
4309 (call-interactively 'org-table-recalculate)
4310 (org-table-maybe-recalculate-line))
4311 (call-interactively 'org-table-align)
4312 (when (orgtbl-send-table 'maybe)
4313 (run-hooks 'orgtbl-after-send-table-hook)))
4314 ((eq action 'recalc)
4315 (org-table-set-constants)
4316 (save-excursion
4317 (beginning-of-line 1)
4319 (if (org-at-table-p)
4320 (org-call-with-arg 'org-table-recalculate t))))
4321 (t (let (orgtbl-mode)
4322 (call-interactively (key-binding "\C-c\C-c")))))))
4324 (defun orgtbl-create-or-convert-from-region (arg)
4325 "Create table or convert region to table, if no conflicting binding.
4326 This installs the table binding `C-c |', but only if there is no
4327 conflicting binding to this key outside orgtbl-mode."
4328 (interactive "P")
4329 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4330 (if cmd
4331 (call-interactively cmd)
4332 (call-interactively 'org-table-create-or-convert-from-region))))
4334 (defun orgtbl-tab (arg)
4335 "Justification and field motion for `orgtbl-mode'."
4336 (interactive "P")
4337 (if arg (org-table-edit-field t)
4338 (org-table-justify-field-maybe)
4339 (org-table-next-field)))
4341 (defun orgtbl-ret ()
4342 "Justification and field motion for `orgtbl-mode'."
4343 (interactive)
4344 (if (bobp)
4345 (newline)
4346 (org-table-justify-field-maybe)
4347 (org-table-next-row)))
4349 (defun orgtbl-self-insert-command (N)
4350 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4351 If the cursor is in a table looking at whitespace, the whitespace is
4352 overwritten, and the table is not marked as requiring realignment."
4353 (interactive "p")
4354 (if (and (org-at-table-p)
4355 (or
4356 (and org-table-auto-blank-field
4357 (member last-command
4358 '(orgtbl-hijacker-command-100
4359 orgtbl-hijacker-command-101
4360 orgtbl-hijacker-command-102
4361 orgtbl-hijacker-command-103
4362 orgtbl-hijacker-command-104
4363 orgtbl-hijacker-command-105
4364 yas/expand))
4365 (org-table-blank-field))
4366 t)
4367 (eq N 1)
4369 (let (org-table-may-need-update)
4370 (goto-char (1- (match-end 0)))
4371 (org-delete-backward-char 1)
4372 (goto-char (match-beginning 0))
4373 (self-insert-command N))
4374 (setq org-table-may-need-update t)
4375 (let* (orgtbl-mode
4376 a
4377 (cmd (or (key-binding
4378 (or (and (listp function-key-map)
4379 (setq a (assoc last-input-event function-key-map))
4380 (cdr a))
4381 (vector last-input-event)))
4382 'self-insert-command)))
4383 (call-interactively cmd)
4384 (if (and org-self-insert-cluster-for-undo
4385 (eq cmd 'self-insert-command))
4386 (if (not (eq last-command 'orgtbl-self-insert-command))
4387 (setq org-self-insert-command-undo-counter 1)
4388 (if (>= org-self-insert-command-undo-counter 20)
4389 (setq org-self-insert-command-undo-counter 1)
4390 (and (> org-self-insert-command-undo-counter 0)
4391 buffer-undo-list
4392 (not (cadr buffer-undo-list)) ; remove nil entry
4393 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4394 (setq org-self-insert-command-undo-counter
4395 (1+ org-self-insert-command-undo-counter))))))))
4398 "Regular expression matching exponentials as produced by calc.")
4400 (defun orgtbl-gather-send-defs ()
4401 "Gather a plist of :name, :transform, :params for each destination before
4402 a radio table."
4403 (save-excursion
4404 (goto-char (org-table-begin))
4405 (let (rtn)
4406 (beginning-of-line 0)
4407 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4408 (let ((name (org-no-properties (match-string 1)))
4409 (transform (intern (match-string 2)))
4410 (params (if (match-end 3)
4411 (read (concat "(" (match-string 3) ")")))))
4412 (push (list :name name :transform transform :params params)
4413 rtn)
4414 (beginning-of-line 0)))
4415 rtn)))
4417 (defun orgtbl-send-replace-tbl (name txt)
4418 "Find and replace table NAME with TXT."
4419 (save-excursion
4420 (goto-char (point-min))
4421 (unless (re-search-forward
4423 (user-error "Don't know where to insert translated table"))
4424 (goto-char (match-beginning 0))
4425 (beginning-of-line 2)
4426 (save-excursion
4427 (let ((beg (point)))
4428 (unless (re-search-forward
4429 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4430 (user-error "Cannot find end of insertion region"))
4431 (beginning-of-line 1)
4432 (delete-region beg (point))))
4435 ;;;###autoload
4436 (defun org-table-to-lisp (&optional txt)
4437 "Convert the table at point to a Lisp structure.
4438 The structure will be a list. Each item is either the symbol `hline'
4439 for a horizontal separator line, or a list of field values as strings.
4440 The table is taken from the parameter TXT, or from the buffer at point."
4441 (unless txt
4442 (unless (org-at-table-p)
4443 (user-error "No table at point")))
4444 (let* ((txt (or txt
4445 (buffer-substring-no-properties (org-table-begin)
4446 (org-table-end))))
4449 (mapcar
4450 (lambda (x)
4451 (if (string-match org-table-hline-regexp x)
4452 'hline
4454 lines)))
4456 (defun orgtbl-send-table (&optional maybe)
4457 "Send a transformed version of this table to the receiver position.
4458 With argument MAYBE, fail quietly if no transformation is defined for
4459 this table."
4460 (interactive)
4461 (catch 'exit
4462 (unless (org-at-table-p) (user-error "Not at a table"))
4463 ;; when non-interactive, we assume align has just happened.
4464 (when (org-called-interactively-p 'any) (org-table-align))
4465 (let ((dests (orgtbl-gather-send-defs))
4466 (txt (buffer-substring-no-properties (org-table-begin)
4467 (org-table-end)))
4468 (ntbl 0))
4469 (unless dests (if maybe (throw 'exit nil)
4470 (user-error "Don't know how to transform this table")))
4471 (dolist (dest dests)
4472 (let* ((name (plist-get dest :name))
4473 (transform (plist-get dest :transform))
4474 (params (plist-get dest :params))
4475 (skip (plist-get params :skip))
4476 (skipcols (plist-get params :skipcols))
4477 (no-escape (plist-get params :no-escape))
4478 beg
4479 (lines (org-table-clean-before-export
4480 (nthcdr (or skip 0)
4482 (i0 (if org-table-clean-did-remove-column 2 1))
4483 (lines (if no-escape lines
4484 (mapcar (lambda(l) (replace-regexp-in-string
4486 (table (mapcar
4487 (lambda (x)
4488 (if (string-match org-table-hline-regexp x)
4489 'hline
4490 (org-remove-by-index
4492 skipcols i0)))
4493 lines))
4494 (fun (if (= i0 2) 'cdr 'identity))
4495 (org-table-last-alignment
4496 (org-remove-by-index (funcall fun org-table-last-alignment)
4497 skipcols i0))
4498 (org-table-last-column-widths
4499 (org-remove-by-index (funcall fun org-table-last-column-widths)
4500 skipcols i0))
4501 (txt (if (fboundp transform)
4502 (funcall transform table params)
4503 (user-error "No such transformation function %s" transform))))
4504 (orgtbl-send-replace-tbl name txt))
4505 (setq ntbl (1+ ntbl)))
4506 (message "Table converted and installed at %d receiver location%s"
4507 ntbl (if (> ntbl 1) "s" ""))
4508 (if (> ntbl 0)
4509 ntbl
4510 nil))))
4512 (defun org-remove-by-index (list indices &optional i0)
4513 "Remove the elements in LIST with indices in INDICES.
4514 First element has index 0, or I0 if given."
4515 (if (not indices)
4516 list
4517 (if (integerp indices) (setq indices (list indices)))
4518 (setq i0 (1- (or i0 0)))
4519 (delq :rm (mapcar (lambda (x)
4520 (setq i0 (1+ i0))
4521 (if (memq i0 indices) :rm x))
4522 list))))
4524 (defun orgtbl-toggle-comment ()
4525 "Comment or uncomment the orgtbl at point."
4526 (interactive)
4527 (let* ((case-fold-search t)
4528 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4529 (re2 (concat "^" orgtbl-line-start-regexp))
4530 (commented (save-excursion (beginning-of-line 1)
4531 (cond ((looking-at re1) t)
4532 ((looking-at re2) nil)
4533 (t (user-error "Not at an org table")))))
4534 (re (if commented re1 re2))
4535 beg end)
4536 (save-excursion
4537 (beginning-of-line 1)
4538 (while (looking-at re) (beginning-of-line 0))
4539 (beginning-of-line 2)
4540 (setq beg (point))
4541 (while (looking-at re) (beginning-of-line 2))
4542 (setq end (point)))
4543 (comment-region beg end (if commented '(4) nil))))
4545 (defun orgtbl-insert-radio-table ()
4546 "Insert a radio table template appropriate for this major mode."
4547 (interactive)
4548 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4549 (txt (nth 1 e))
4550 name pos)
4551 (unless e (user-error "No radio table setup defined for %s" major-mode))
4552 (setq name (read-string "Table name: "))
4553 (while (string-match "%n" txt)
4554 (setq txt (replace-match name t t txt)))
4556 (setq pos (point))
4557 (insert txt)
4558 (goto-char pos)))
4560 ;; Dynamically bound input and output for table formatting.
4561 (defvar *orgtbl-table* nil
4562 "Carries the current table through formatting routines.")
4563 (defvar *orgtbl-rtn* nil
4564 "Formatting routines push the output lines here.")
4565 ;; Formatting parameters for the current table section.
4566 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4567 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4568 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4569 (defvar *orgtbl-fmt* nil "Format for each entry.")
4570 (defvar *orgtbl-efmt* nil "Format for numbers.")
4571 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4572 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4573 (defvar *orgtbl-lstart* nil "Text starting a row.")
4574 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4575 (defvar *orgtbl-lend* nil "Text ending a row.")
4576 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4578 (defsubst orgtbl-get-fmt (fmt i)
4579 "Retrieve the format from FMT corresponding to the Ith column."
4580 (if (and (not (functionp fmt)) (consp fmt))
4581 (plist-get fmt i)
4582 fmt))
4584 (defsubst orgtbl-apply-fmt (fmt &rest args)
4585 "Apply format FMT to arguments ARGS.
4586 When FMT is nil, return the first argument from ARGS."
4587 (cond ((functionp fmt) (apply fmt args))
4588 (fmt (apply 'format fmt args))
4589 (args (car args))
4590 (t args)))
4592 (defsubst orgtbl-eval-str (str)
4593 "If STR is a function, evaluate it with no arguments."
4594 (if (functionp str)
4595 (funcall str)
4596 str))
4598 (defun orgtbl-format-line (line)
4599 "Format LINE as a table row."
4600 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4601 (let* ((i 0)
4602 (line
4603 (mapcar
4604 (lambda (f)
4605 (setq i (1+ i))
4606 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4607 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4608 (orgtbl-apply-fmt efmt (match-string 1 f)
4609 (match-string 2 f))
4610 f)))
4611 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4612 *orgtbl-default-fmt*)
4613 f)))
4614 line)))
4615 (push (if *orgtbl-lfmt*
4616 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4617 (concat (orgtbl-eval-str *orgtbl-lstart*)
4618 (mapconcat 'identity line *orgtbl-sep*)
4619 (orgtbl-eval-str *orgtbl-lend*)))
4620 *orgtbl-rtn*))))
4622 (defun orgtbl-format-section (section-stopper)
4623 "Format lines until the first occurrence of SECTION-STOPPER."
4624 (let (prevline)
4625 (progn
4626 (while (not (eq (car *orgtbl-table*) section-stopper))
4627 (if prevline (orgtbl-format-line prevline))
4628 (setq prevline (pop *orgtbl-table*)))
4629 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4630 (*orgtbl-lend* *orgtbl-llend*)
4631 (*orgtbl-lfmt* *orgtbl-llfmt*))
4632 (orgtbl-format-line prevline))))))
4634 ;;;###autoload
4635 (defun orgtbl-to-generic (table params &optional backend)
4636 "Convert the orgtbl-mode TABLE to some other format.
4637 This generic routine can be used for many standard cases.
4638 TABLE is a list, each entry either the symbol `hline' for a horizontal
4639 separator line, or a list of fields for that line.
4640 PARAMS is a property list of parameters that can influence the conversion.
4641 A third optional argument BACKEND can be used to convert the content of
4642 the cells using a specific export back-end.
4644 For the generic converter, some parameters are obligatory: you need to
4645 specify either :lfmt, or all of (:lstart :lend :sep).
4647 Valid parameters are:
4649 :splice When set to t, return only table body lines, don't wrap
4650 them into :tstart and :tend. Default is nil. When :splice
4651 is non-nil, this also means that the exporter should not look
4652 for and interpret header and footer sections.
4654 :hline String to be inserted on horizontal separation lines.
4655 May be nil to ignore hlines.
4657 :sep Separator between two fields
4658 :remove-nil-lines Do not include lines that evaluate to nil.
4660 Each in the following group may be either a string or a function
4661 of no arguments returning a string:
4663 :tstart String to start the table. Ignored when :splice is t.
4664 :tend String to end the table. Ignored when :splice is t.
4665 :lstart String to start a new table line.
4666 :llstart String to start the last table line, defaults to :lstart.
4667 :lend String to end a table line
4668 :llend String to end the last table line, defaults to :lend.
4670 Each in the following group may be a string, a function of one
4671 argument (the field or line) returning a string, or a plist
4672 mapping columns to either of the above:
4674 :lfmt Format for entire line, with enough %s to capture all fields.
4675 If this is present, :lstart, :lend, and :sep are ignored.
4676 :llfmt Format for the entire last line, defaults to :lfmt.
4677 :fmt A format to be used to wrap the field, should contain
4678 %s for the original field value. For example, to wrap
4680 This may also be a property list with column numbers and
4682 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4683 Same as above, specific for the header lines in the table.
4684 All lines before the first hline are treated as header.
4685 If any of these is not present, the data line value is used.
4687 This may be either a string or a function of two arguments:
4689 :efmt Use this format to print numbers with exponentials.
4690 The format should have %s twice for inserting mantissa
4692 may also be a property list with column numbers and
4693 formats. :fmt will still be applied after :efmt.
4695 In addition to this, the parameters :skip and :skipcols are always handled
4696 directly by `orgtbl-send-table'. See manual."
4697 (let* ((splicep (plist-get params :splice))
4698 (hline (plist-get params :hline))
4699 (skipheadrule (plist-get params :skipheadrule))
4700 (remove-nil-linesp (plist-get params :remove-nil-lines))
4701 (remove-newlines (plist-get params :remove-newlines))
4702 (*orgtbl-hline* hline)
4703 (*orgtbl-table* table)
4704 (*orgtbl-sep* (plist-get params :sep))
4705 (*orgtbl-efmt* (plist-get params :efmt))
4706 (*orgtbl-lstart* (plist-get params :lstart))
4707 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4708 (*orgtbl-lend* (plist-get params :lend))
4709 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4710 (*orgtbl-lfmt* (plist-get params :lfmt))
4711 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4712 (*orgtbl-fmt* (plist-get params :fmt))
4713 *orgtbl-rtn*)
4714 ;; Convert cells content to backend BACKEND
4715 (when backend
4716 (setq *orgtbl-table*
4717 (mapcar
4718 (lambda(r)
4719 (if (listp r)
4720 (mapcar
4721 (lambda (c)
4722 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4723 r)
4724 r))
4725 *orgtbl-table*)))
4726 ;; Put header
4727 (unless splicep
4728 (when (plist-member params :tstart)
4729 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4730 (if tstart (push tstart *orgtbl-rtn*)))))
4731 ;; If we have a heading, format it and handle the trailing hline.
4732 (if (and (not splicep)
4733 (or (consp (car *orgtbl-table*))
4734 (consp (nth 1 *orgtbl-table*)))
4735 (memq 'hline (cdr *orgtbl-table*)))
4736 (progn
4737 (when (eq 'hline (car *orgtbl-table*))
4738 ;; There is a hline before the first data line
4739 (and hline (push hline *orgtbl-rtn*))
4740 (pop *orgtbl-table*))
4741 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4742 *orgtbl-lstart*))
4743 (*orgtbl-llstart* (or (plist-get params :hllstart)
4744 *orgtbl-llstart*))
4745 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4746 (*orgtbl-llend* (or (plist-get params :hllend)
4747 (plist-get params :hlend) *orgtbl-llend*))
4748 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4749 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4750 (plist-get params :hlfmt) *orgtbl-llfmt*))
4751 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4752 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4753 (orgtbl-format-section 'hline))
4754 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4755 (pop *orgtbl-table*)))
4756 ;; Now format the main section.
4757 (orgtbl-format-section nil)
4758 (unless splicep
4759 (when (plist-member params :tend)
4760 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4761 (if tend (push tend *orgtbl-rtn*)))))
4762 (mapconcat (if remove-newlines
4763 (lambda (tend)
4765 'identity)
4766 (nreverse (if remove-nil-linesp
4767 (remq nil *orgtbl-rtn*)
4770 ;;;###autoload
4771 (defun orgtbl-to-tsv (table params)
4772 "Convert the orgtbl-mode table to TAB separated material."
4774 ;;;###autoload
4775 (defun orgtbl-to-csv (table params)
4776 "Convert the orgtbl-mode table to CSV material.
4777 This does take care of the proper quoting of fields with comma or quotes."
4778 (orgtbl-to-generic table (org-combine-plists
4779 '(:sep "," :fmt org-quote-csv-field)
4780 params)))
4782 ;;;###autoload
4783 (defun orgtbl-to-latex (table params)
4784 "Convert the orgtbl-mode TABLE to LaTeX.
4785 TABLE is a list, each entry either the symbol `hline' for a horizontal
4786 separator line, or a list of fields for that line.
4787 PARAMS is a property list of parameters that can influence the conversion.
4788 Supports all parameters from `orgtbl-to-generic'. Most important for
4789 LaTeX are:
4791 :splice When set to t, return only table body lines, don't wrap
4792 them into a tabular environment. Default is nil.
4794 :fmt A format to be used to wrap the field, should contain %s for the
4795 original field value. For example, to wrap everything in dollars,
4798 The format may also be a function that formats its one argument.
4800 :efmt Format for transforming numbers with exponentials. The format
4801 should have %s twice for inserting mantissa and exponent, for
4803 This may also be a property list with column numbers and formats.
4804 The format may also be a function that formats its two arguments.
4806 :llend If you find too much space below the last line of a table,
4809 The general parameters :skip and :skipcols have already been applied when
4810 this function is called."
4811 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4812 org-table-last-alignment ""))
4813 (params2
4814 (list
4819 (require 'ox-latex)
4820 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4822 ;;;###autoload
4823 (defun orgtbl-to-html (table params)
4824 "Convert the orgtbl-mode TABLE to HTML.
4825 TABLE is a list, each entry either the symbol `hline' for a horizontal
4826 separator line, or a list of fields for that line.
4827 PARAMS is a property list of parameters that can influence the conversion.
4828 Currently this function recognizes the following parameters:
4830 :splice When set to t, return only table body lines, don't wrap
4831 them into a <table> environment. Default is nil.
4833 The general parameters :skip and :skipcols have already been applied when
4834 this function is called. The function does *not* use `orgtbl-to-generic',
4835 so you cannot specify parameters for it."
4836 (require 'ox-html)
4837 (let ((output (org-export-string-as
4838 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4839 (if (not (plist-get params :splice)) output
4840 (org-trim
4841 (replace-regexp-in-string
4845 ;;;###autoload
4846 (defun orgtbl-to-texinfo (table params)
4847 "Convert the orgtbl-mode TABLE to TeXInfo.
4848 TABLE is a list, each entry either the symbol `hline' for a horizontal
4849 separator line, or a list of fields for that line.
4850 PARAMS is a property list of parameters that can influence the conversion.
4851 Supports all parameters from `orgtbl-to-generic'. Most important for
4852 TeXInfo are:
4854 :splice nil/t When set to t, return only table body lines, don't wrap
4855 them into a multitable environment. Default is nil.
4857 :fmt fmt A format to be used to wrap the field, should contain
4858 %s for the original field value. For example, to wrap
4860 This may also be a property list with column numbers and
4862 Each format also may be a function that formats its one
4863 argument.
4866 are computed automatically from the width of the columns
4867 under org-mode.
4869 The general parameters :skip and :skipcols have already been applied when
4870 this function is called."
4871 (let* ((total (float (apply '+ org-table-last-column-widths)))
4872 (colfrac (or (plist-get params :cf)
4873 (mapconcat
4874 (lambda (x) (format "%.3f" (/ (float x) total)))
4875 org-table-last-column-widths " ")))
4876 (params2
4877 (list
4878 :tstart (concat "@multitable @columnfractions " colfrac)
4879 :tend "@end multitable"
4880 :lstart "@item " :lend "" :sep " @tab "
4881 :hlstart "@headitem ")))
4882 (require 'ox-texinfo)
4883 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4885 ;;;###autoload
4886 (defun orgtbl-to-orgtbl (table params)
4887 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4888 Useful when slicing one table into many. The :hline, :sep,
4889 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4890 and :tend suppress strings without splicing; they can be set to
4891 provide ORGTBL directives for the generated table."
4892 (let* ((params2
4893 (list
4894 :remove-newlines t
4895 :tstart nil :tend nil
4896 :hline "|---"
4897 :sep " | "
4898 :lstart "| "
4899 :lend " |"))
4900 (params (org-combine-plists params2 params)))
4901 (with-temp-buffer
4902 (insert (orgtbl-to-generic table params))
4903 (goto-char (point-min))
4904 (while (re-search-forward org-table-hline-regexp nil t)
4905 (org-table-align))
4906 (buffer-substring 1 (buffer-size)))))
4908 (defun orgtbl-to-table.el (table params)
4909 "Convert the orgtbl-mode TABLE into a table.el table."
4910 (with-temp-buffer
4911 (insert (orgtbl-to-orgtbl table params))
4912 (org-table-align)
4913 (replace-regexp-in-string
4914 "-|" "-+"
4915 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4917 (defun orgtbl-to-unicode (table params)
4918 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4919 You need the ascii-art-to-unicode.el package for this. You can download
4920 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4921 (with-temp-buffer
4922 (insert (orgtbl-to-table.el table params))
4923 (goto-char (point-min))
4924 (if (or (featurep 'ascii-art-to-unicode)
4925 (require 'ascii-art-to-unicode nil t))
4926 (aa2u)
4927 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4928 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4929 "Link to ascii-art-to-unicode.el") org-stored-links))
4930 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4931 (buffer-string)))
4933 (defun org-table-get-remote-range (name-or-id form)
4934 "Get a field value or a list of values in a range from table at ID.
4936 NAME-OR-ID may be the name of a table in the current file as set
4938 will then be used. Alternatively, it may be an ID referring to
4939 any entry, also in a different file. In this case, the first
4940 table in that entry will be referenced.
4944 The return value is either a single string for a single field, or a
4945 list of the fields in the rectangle."
4946 (save-match-data
4947 (let ((case-fold-search t) (id-loc nil)
4948 ;; Protect a bunch of variables from being overwritten
4949 ;; by the context of the remote table
4950 org-table-column-names org-table-column-name-regexp
4951 org-table-local-parameters org-table-named-field-locations
4952 org-table-current-line-types org-table-current-begin-line
4953 org-table-current-begin-pos org-table-dlines
4954 org-table-current-ncol
4955 org-table-hlines org-table-last-alignment
4956 org-table-last-column-widths org-table-last-alignment
4957 org-table-last-column-widths tbeg
4958 buffer loc)
4959 (setq form (org-table-convert-refs-to-rc form))
4960 (save-excursion
4961 (save-restriction
4962 (widen)
4963 (save-excursion
4964 (goto-char (point-min))
4965 (if (re-search-forward
4968 nil t)
4969 (setq buffer (current-buffer) loc (match-beginning 0))
4970 (setq id-loc (org-id-find name-or-id 'marker))
4971 (unless (and id-loc (markerp id-loc))
4973 (setq buffer (marker-buffer id-loc)
4974 loc (marker-position id-loc))
4975 (move-marker id-loc nil)))
4976 (with-current-buffer buffer
4977 (save-excursion
4978 (save-restriction
4979 (widen)
4980 (goto-char loc)
4981 (forward-char 1)
4983 (not (match-beginning 1)))
4984 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
4985 (setq tbeg (point-at-bol))
4986 (org-table-get-specials)
4987 (setq form (org-table-formula-substitute-names
4988 (org-table-formula-handle-first/last-rc form)))
4989 (if (and (string-match org-table-range-regexp form)
4990 (> (length (match-string 0 form)) 1))
4991 (save-match-data
4992 (org-table-get-range (match-string 0 form) tbeg 1))
4993 form)))))))))
4995 (defmacro org-define-lookup-function (mode)
4996 (let ((mode-str (symbol-name mode))
4997 (first-p (equal mode 'first))
4998 (all-p (equal mode 'all)))
4999 (let ((plural-str (if all-p "s" "")))
5000 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5001 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5002 If R-LIST is nil, return matching element%s of S-LIST.
5003 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5004 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5005 This function is generated by a call to the macro `org-define-lookup-function'."
5006 mode-str plural-str plural-str plural-str)
5007 (let ,(let ((lvars '((p (or predicate 'equal))
5008 (sl s-list)
5009 (rl (or r-list s-list))
5010 (ret nil))))
5011 (if first-p (add-to-list 'lvars '(match-p nil)))
5012 lvars)
5013 (while ,(if first-p '(and (not match-p) sl) 'sl)
5014 (progn
5015 (if (funcall p val (car sl))
5016 (progn
5017 ,(if first-p '(setq match-p t))
5018 (let ((rval (car rl)))
5019 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5020 (setq sl (cdr sl) rl (cdr rl))))
5021 ret)))))
5023 (org-define-lookup-function first)
5024 (org-define-lookup-function last)
5025 (org-define-lookup-function all)
5027 (provide 'org-table)
5029 ;; Local variables:
5030 ;; generated-autoload-file: "org-loaddefs.el"
5031 ;; End:
5033 ;;; org-table.el ends here