| blob | afe6e3a3932675ff9c3e029a21cf41b19799ad5c |
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:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, otherwise, if table is not sent, the functions
60 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
61 In the optimized version, the table editor takes over all simple keys that
62 normally just insert a character. In tables, the characters are inserted
63 in a way to minimize disturbing the table structure (i.e. in overwrite mode
64 for empty fields). Outside tables, the correct binding of the keys is
65 restored.
67 The default for this option is t if the optimized version is also used in
68 Org-mode. See the variable `org-enable-table-editor' for details. Changing
69 this variable requires a restart of Emacs to become effective."
75 % END RECEIVE ORGTBL %n
77 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
78 | | |
81 @c END RECEIVE ORGTBL %n
82 @ignore
83 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
84 | | |
87 <!-- END RECEIVE ORGTBL %n -->
88 <!--
89 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
90 | | |
93 #+ END RECEIVE ORGTBL %n
95 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
96 | | |
98 "Templates for radio tables in different major modes.
99 Each template must define lines that will be treated as a comment and that
102 insertion of the template. The transformed table will later be inserted
103 between these lines.
105 The template should also contain a minimal table in a multiline comment.
106 If multiline comments are not possible in the buffer language,
107 you can pack it into a string that will not be used when the code
108 is compiled or executed. Above the table will you need a line with
110 convert the table into a data structure useful in the
111 language of the buffer. Check the manual for the section on
113 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
115 All occurrences of %n in a template will be replaced with the name of the
116 table, obtained by prompting the user."
123 "Settings for tables in Org-mode."
128 "The default size for newly created tables, Columns x Rows."
133 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
134 "Regular expression for recognizing numbers in table columns.
135 If a table column contains mostly numbers, it will be aligned to the
136 right. If not, it will be aligned to the left.
138 The default value of this option is a regular expression which allows
139 anything which looks remotely like a number as used in scientific
140 context. For example, all of the following will be considered a
141 number:
142 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
144 Other options offered by the customize interface are more restrictive."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
159 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
160 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
164 "Fraction of numbers in a column required to make the column align right.
165 In a column all non-white fields are considered. If at least
166 this fraction of fields is matched by `org-table-number-regexp',
167 alignment to the right border applies."
172 "Behavior of tables during editing in Org-mode."
177 "Non-nil means automatically re-align table when pressing TAB or RETURN.
179 removal/insertion."
184 "Non-nil means automatically blank table field when starting to type into it.
185 This only happens when typing immediately after a field motion
186 command (TAB, S-TAB or RET).
187 Only relevant when `org-enable-table-editor' is equal to `optimized'."
192 "Non-nil means automatically exit the follow mode.
193 When nil, the follow mode will stay on and be active in any table
194 the cursor enters. Since the table follow filed mode messes with the
195 window configuration, it is not recommended to set this variable to nil,
196 except maybe locally in a special file that has mostly tables with long
197 fields."
203 "Whether the user should confirm when Org fixes formulas."
211 'safe-local-variable
215 "Non-nil means tab in the last column of a table with jump over a hline.
216 If a horizontal separator line is following the current line,
217 `org-table-next-field' can either create a new row before that line, or jump
218 over the line. When this option is nil, a new line will be created before
219 this line."
224 "Options concerning tables in Org-mode."
229 "Should org-mode work with table references like B3 instead of @3$2?
230 Possible values are:
231 nil never use them
232 from accept as input, do not present for editing
233 t accept as input and present for editing"
253 calc-angle-mode deg
254 calc-prefer-frac nil
255 calc-symbolic-mode nil
257 calc-display-working-message t
258 )
259 "List with Calc mode settings for use in `calc-eval' for table formulas.
260 The list must contain alternating symbols (Calc modes variables and values).
261 Don't remove any of the default settings, just change the values. Org-mode
262 relies on the variables to be present in the list."
267 "Format for the output of calc computations like $1+$2;t.
268 The default value is 'hours, and will output the results as a
269 number of hours. Other allowed values are 'seconds, 'minutes and
270 'days, and the output will be a fraction of seconds, minutes or
271 days."
280 "Format for fields which contain the result of a formula.
282 characters. Beware that modifying the display can prevent the
283 field from being used in another formula."
289 "Non-nil means TAB and RET evaluate a formula in current table field.
290 If the current field starts with an equal sign, it is assumed to be a formula
291 which should be evaluated as described in the manual and in the documentation
292 string of the command `org-table-eval-formula'. This feature requires the
293 Emacs calc package.
294 When this variable is nil, formula calculation is only available through
300 "Non-nil means interpret constants in formulas in tables.
301 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
302 by the value given in `org-table-formula-constants', or by a value obtained
303 from the `constants.el' package."
308 "Alist with constant names and values, for use in table formulas.
309 The car of each element is a name of a constant, without the `$' before it.
310 The cdr is the value as a string. For example, if you'd like to use the
311 speed of light in a formula, you would configure
315 and then use it in an equation like `$1*$c'.
317 Constants can also be defined on a per-file basis using a line like
319 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
326 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
327 Automatically means when TAB or RET or C-c C-c are pressed in the line."
332 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
337 "Non-nil means relative formula references may cross hlines.
338 Here are the allowed values:
340 nil Relative references may not cross hlines. They will reference the
341 field next to the hline instead. Coming from below, the reference
342 will be to the field below the hline. Coming from above, it will be
343 to the field above.
344 t Relative references may cross hlines.
345 error An attempt to cross a hline will throw an error.
347 It is probably good to never set this variable to nil, for the sake of
348 portability of tables."
356 "Options concerning table import and export in Org-mode."
361 "Default export parameters for `org-table-export'.
362 These can be overridden for a specific table by setting the
363 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
364 radio tables for the different export transformations and
365 available parameters."
403 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
404 ;; 1 2 3 4 5
415 "Is this a table line colgroup information?"
419 line)
421 nil
428 "Is this a table line with only alignment/width cookies?"
441 s))))
447 "Check if the table has a marking column.
448 If yes remove the column and the special lines."
461 lines))))
470 nil)
474 ;; remove the first column
477 lines))))
483 ;;;###autoload
485 "Use the table.el package to insert a new table.
486 If there is already a table at point, convert between Org-mode tables
487 and table.el tables."
500 ;;;###autoload
502 "Convert region to table, or create an empty table.
503 If there is an active region, convert it to a table, using the function
504 `org-table-convert-region'. See the documentation of that function
505 to learn how the prefix argument is interpreted to determine the field
506 separator.
507 If there is no such region, create an empty table with `org-table-create'."
513 ;;;###autoload
515 "Query for a size and insert a table skeleton.
535 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
539 ;; Insert a hline after the first row.
546 ;;;###autoload
548 "Convert region to a table.
549 The region goes from BEG0 to END0, but these borders will be moved
550 slightly, to make sure a beginning of line in the first line is included.
552 SEPARATOR specifies the field separator in the lines. It can have the
553 following values:
555 '(4) Use the comma as a field separator
556 '(16) Use a TAB as field separator
557 '(64) Prompt for a regular expression as field separator
558 integer When a number, use that many spaces as field separator
559 regexp When a regular expression, use it to match the separator
560 nil When nil, the command tries to be smart and figure out the
561 separator in the following way:
562 - when each line contains a TAB, assume TAB-separated material
563 - when each line contains a comma, assume CSV material
564 - else, assume one or more SPACE characters as separator."
568 re)
577 ;; Get the right field separator
588 ;; parse the csv stuff
613 ;;;###autoload
615 "Import FILE as a table.
616 The file is assumed to be tab-separated. Such files can be produced by most
617 spreadsheet and database applications. If no tabs (at least one per line)
618 are found, lines will be split on whitespace into fields."
629 ;;;###autoload
631 "Export table to a file, with configurable format.
632 Such a file can be imported into usual spreadsheet programs.
634 FILE can be the output file name. If not given, it will be taken
635 from a TABLE_EXPORT_FILE property in the current entry or higher
636 up in the hierarchy, or the user will be prompted for a file
637 name. FORMAT can be an export format, of the same kind as it
638 used when `orgtbl-mode' sends a table in a different format.
640 The command suggests a format depending on TABLE_EXPORT_FORMAT,
641 whether it is set locally or up in the hierarchy, then on the
642 extension of the given file name, and finally on the variable
643 `org-table-export-default-format'."
657 buf deffmt-readable fileext)
673 org-table-export-default-format))
691 'hline
694 skipcols i0)))
695 lines))
699 skipcols i0))
702 skipcols i0)))
719 "Marker at the beginning of the table last aligned.
722 "Marker at the end of the table last aligned.
725 "List of flags for flushright alignment, from the last re-alignment.
728 "List of max width of fields in each column.
731 "Non-nil means debug table formulas.
743 ;;;###autoload
745 "Align the table at point by aligning all vertical bars."
748 ;; Limits of table
751 ;; Current cursor position
757 column
759 rfmt hfmt
767 emptystrings links dates emph raise narrow
768 falign falign1 fmax f1 len c e space)
771 ;; Check if we have links or dates
783 ;; Make sure the link properties are right
785 ;; Make sure the date properties are right
790 ;; Check if we are narrowing any columns
793 org-format-transports-properties-p
798 ;; Get the rows
801 ;; Store the indentation of the first line
804 ;; Mark the hlines by setting the corresponding element to nil
805 ;; At the same time, we remove trailing space.
808 nil
811 l)))
812 lines))
813 ;; Get the data fields by splitting the lines.
818 ;; How many fields in the longest line?
825 ;; A list of empty strings to fill any short rows on output
827 ;; Check for special formatting.
831 ;; Check if there is an explicit width specified
841 ;; Find fields that are wider than fmax, and shorten them
847 'help-echo
848 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
856 xx)))))
857 ;; Get the maximum width for each column
859 lengths)
860 ;; Get the fraction of numbers, to decide about alignment of the column
866 nil
873 ;; Store the alignment of this table, for later editing of single fields
875 org-table-last-column-widths lengths)
877 ;; With invisible characters, `format' does not get the field width right
878 ;; So we need to make these fields wide by hand.
896 ;; Compute the formats needed for output of the table
909 hfmt))
913 ;; Replace the old one
920 ;; Try to move to the old location
929 ))
931 ;;;###autoload
933 "Find the beginning of the table and return its position.
934 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
938 org-table-border-regexp)
939 nil t))
945 ;;;###autoload
947 "Find the end of the table and return its position.
948 With argument TABLE-TYPE, go to the end of a table.el-type table."
952 org-table-border-regexp)
953 nil t))
958 ;;;###autoload
960 "Justify the current field, text to left, number to right.
961 Optional argument NEW may specify text to replace the current field content."
970 ;; This is not the same table, force a full re-align
976 l f n o e)
999 ;;;###autoload
1001 "Go to the next field in the current table, creating new lines as needed.
1002 Before doing so, re-align the table if necessary."
1007 org-table-may-need-update)
1018 org-table-tab-jumps-over-hlines
1029 ;;;###autoload
1031 "Go to the previous field in the table.
1032 Before doing so, re-align the table if necessary."
1037 org-table-may-need-update)
1052 "Move to the end of the current table field.
1053 If already at or after the end, move to the end of the next table field.
1054 With numeric argument N, move N-1 fields forward first."
1067 "Move to the beginning of the current table field.
1068 If already at or before the beginning, move to the beginning of the
1069 previous field.
1070 With numeric argument N, move N-1 fields backward first."
1083 ;;;###autoload
1085 "Go to the next row (same column) in the current table.
1086 Before doing so, re-align the table if necessary."
1094 org-table-may-need-update)
1107 ;;;###autoload
1109 "Copy the value of the current field one row below.
1111 If the field at the cursor is empty, copy the content of the
1112 nearest non-empty field above. With argument N, use the Nth
1113 non-empty field.
1115 If the current field is not empty, it is copied down to the next
1116 row, and the cursor is moved with it. Therefore, repeating this
1117 command causes the column to be filled row-by-row.
1119 If the variable `org-table-copy-increment' is non-nil and the
1120 field is an integer or a timestamp, it will be incremented while
1121 copying. By default, increment by the difference between the
1122 value in the current field and the one in the field above. To
1123 increment using a fixed integer, set `org-table-copy-increment'
1124 to a number. In the case of a timestamp, increment by days."
1136 txt txt-up inc)
1144 beg t))
1154 beg t))
1161 ;; Above field was not empty, go down to the next row
1191 "Is point inside a table data field?
1192 I.e. not on a hline or before the first or after the last column?
1193 This actually throws an error, so it aborts the current command."
1199 nil
1201 t))
1207 "Get the field in table line LINE, column COLUMN.
1208 If LINE is larger than the number of data lines in the table, the function
1209 returns nil. However, if COLUMN is too large, we will simply return an
1210 empty string.
1211 If LINE is nil, use the current line.
1212 If column is nil, use the current column."
1219 "Put VALUE into line LINE, column COLUMN.
1220 When ALIGN is set, also realign the table."
1229 "Return the index of the current data line."
1236 cnt))
1239 "Go to the Nth data line in the current table.
1240 Return t when the line exists, nil if it does not exist."
1247 ;;;###autoload
1249 "Blank the current table field or active region."
1266 "Return the value of the field in column N of current row.
1267 N defaults to current field.
1268 If REPLACE is a string, replace field with this value. The return value
1269 is always the old value."
1278 t t))
1280 val)
1283 ;;;###autoload
1285 "Show info about the current field, and highlight any reference at point."
1294 org-table-named-field-locations)))
1314 dline col
1316 dline col ref1
1318 ;; FIXME: formula info not correct if special table line
1328 "Find out which column we are in."
1338 cnt)))
1340 ;;;###autoload
1342 "Find out what table data line we are in.
1343 Only data lines count for this."
1355 cnt)))
1357 ;;;###autoload
1359 "Move the cursor to the Nth column in the current table line.
1360 With optional argument ON-DELIM, stop with point before the left delimiter
1361 of the field.
1362 If there are less than N fields, just go to after the last delimiter.
1363 However, when FORCE is non-nil, create new columns if necessary."
1373 t)))))
1380 ;;;###autoload
1382 "Insert a new column into the table."
1390 ;; Current cursor position
1396 nil
1410 "Find a data line in the current table, which is needed for column commands."
1413 t
1424 t
1429 "Turn a buffer line number into a data line number.
1430 If there is no data line in this line, return nil.
1431 If there is no matching dline (most likely te reference was a hline), the
1432 first dline below it is used. When ABOVE is non-nil, the one above is used."
1435 i)
1448 nil))
1450 ;;;###autoload
1452 "Delete a column from the table."
1461 ;; Current cursor position
1467 nil
1483 ;;;###autoload
1485 "Move column to the right."
1488 ;;;###autoload
1490 "Move column to the left."
1494 ;;;###autoload
1496 "Move the current column to the right. With arg LEFT, move to the left."
1506 ;; Current cursor position
1516 nil
1534 ;;;###autoload
1536 "Move table row down."
1539 ;;;###autoload
1541 "Move table row up."
1545 ;;;###autoload
1547 "Move the current table line down. With arg UP, move it up."
1556 txt hline2p)
1579 ;;;###autoload
1581 "Insert a new row above the current line into the table.
1582 With prefix ARG, insert below the current line."
1588 ;; Fix the first field if necessary
1601 ;;;###autoload
1603 "Insert a horizontal-line below the current line into the table.
1604 With prefix ABOVE, insert above the current line."
1625 ;;;###autoload
1627 "Insert a hline and move to the row below that line."
1641 In particular, this does handle wide and invisible characters."
1643 ;; It's a hline, just map the characters
1649 t t s)))
1650 s))
1652 ;;;###autoload
1654 "Delete the current row or horizontal line from the table."
1668 ;;;###autoload
1670 "Sort table lines according to the column at point.
1672 The position of point indicates the column to be used for
1673 sorting, and the range of lines is the range between the nearest
1674 horizontal separator lines, or the entire table of no such lines
1675 exist. If point is before the first column, you will be prompted
1676 for the sorting column. If there is an active region, the mark
1677 specifies the first line and the sorting column, while point
1678 should be in the last line to be included into the sorting.
1680 The command then prompts for the sorting type which can be
1681 alphabetically, numerically, or by time (as given in a time stamp
1682 in the field, or as a HH:MM value). Sorting in reverse order is
1683 also possible.
1685 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1687 If SORTING-TYPE is specified when this function is called from a Lisp
1688 program, no prompting will take place. SORTING-TYPE must be a character,
1689 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1690 should be done in reverse order."
1695 beg end bcol ecol tend tbeg column lns pos)
1740 x))
1754 ;;;###autoload
1756 "Copy region in table to the clipboard and blank all relevant fields.
1757 If there is no active region, use just the field at point."
1763 ;;;###autoload
1765 "Copy rectangular region in table to clipboard.
1766 A special clipboard is used which can only be accessed
1767 with `org-table-paste-rectangle'."
1771 current-prefix-arg))
1773 region cols
1799 org-table-clip))
1801 ;;;###autoload
1803 "Paste a rectangular region into a table.
1804 The upper right corner ends up in the current field. All involved fields
1805 will be overwritten. If the rectangle does not fit into the present table,
1806 the table is enlarged as needed. The process ignores horizontal separator
1807 lines."
1817 c cols field)
1832 ;;;###autoload
1834 "Convert from `org-mode' table to table.el and back.
1835 Obviously, this only works within limits. When an Org-mode table is
1836 converted to table.el, all horizontal separator lines get lost, because
1837 table.el uses these as cell boundaries and has no notion of horizontal lines.
1838 A table.el table can be converted to an Org-mode table only if it does not
1839 do row or column spanning. Multiline cells will become multiple cells.
1840 Beware, Org-mode does not test if the table can be successfully converted - it
1841 blindly applies a recipe that works for simple tables."
1845 ;; convert to Org-mode table
1854 ;; convert to table.el table
1857 ;; first, get rid of all horizontal lines
1861 ;; insert a hline before first
1865 ;; insert a hline after each line
1870 ;; replace "+" at beginning and ending of hlines
1879 "Transpose Org table at point and eliminate hlines.
1880 So a table like
1882 | 1 | 2 | 4 | 5 |
1883 |---+---+---+---|
1884 | a | b | c | d |
1885 | e | f | g | h |
1887 will be transposed as
1889 | 1 | a | e |
1890 | 2 | b | f |
1891 | 4 | c | g |
1892 | 5 | d | h |
1894 Note that horizontal lines disappear."
1906 table)))
1920 ;;;###autoload
1922 "Wrap several fields in a column like a paragraph.
1923 This is useful if you'd like to spread the contents of a field over several
1924 lines, in order to keep the table compact.
1926 If there is an active region, and both point and mark are in the same column,
1927 the text in the column is wrapped to minimum width for the given number of
1928 lines. Generally, this makes the table more compact. A prefix ARG may be
1930 formats the selected text to two lines. If the region was longer than two
1931 lines, the remaining lines remain empty. A negative prefix argument reduces
1932 the current number of lines by that amount. The wrapped text is pasted back
1933 into the table. If you formatted it to more lines than it was before, fields
1934 further down in the table get overwritten - so you might need to make space in
1935 the table first.
1937 If there is no region, the current field is split at the cursor position and
1938 the text fragment to the right of the cursor is prepended to the field one
1939 line down.
1941 If there is no region, but you specify a prefix ARG, the current field gets
1942 blank, and the content is appended to the field above."
1946 ;; There is a region: fill as a paragraph
1950 nlines)
1957 arg)
1961 nil nlines)))
1965 ;; No region, split the current field at point
1969 ;; combine with field above
1979 ;; split field
1991 ;;;###autoload
1993 "Edit table field in a different window.
1994 This is mainly useful for fields that contain hidden parts.
1996 it can be edited in place."
2005 display t intangible t))
2018 p)
2034 intangible t))
2042 "Finish editing a table data field.
2043 Remove all newline characters, insert the result into the table, realign
2044 the table and kill the editing buffer."
2048 text)
2065 "Minor mode to make the table field editor window follow the cursor.
2066 When this mode is active, the field editor window will always show the
2067 current field. The mode exits automatically when the cursor leaves the
2068 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2069 nil " TblFollow" nil
2085 ;; We have left the table, exit the follow mode
2095 ;;;###autoload
2097 "Sum numbers in region of current table column.
2098 The result will be displayed in the echo area, and will be available
2101 If there is an active region, it is interpreted as a rectangle and all
2102 numbers in that rectangle will be summed. If there is no active
2103 region and point is located in a table column, sum all numbers in that
2104 column.
2106 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2107 numbers are assumed to be times as well (in decimal hours) and the
2108 numbers are added as such.
2110 If NLAST is a number, only the NLAST fields will actually be summed."
2137 items1)))
2144 s diff)
2152 sres))))
2175 "Return the formula active for the current field.
2176 Assumes that specials are in place.
2177 If KEY is given, return the key to this formula.
2181 org-table-named-field-locations)))
2195 "Read a formula from the minibuffer, offer stored formula as default.
2196 When NAMED is non-nil, look for a named equation."
2200 org-table-named-field-locations)))
2207 name
2208 ref)
2218 stored)
2220 equation)
2227 scol))
2229 'org-table-formula-history
2230 )))))
2231 mustsave)
2233 ;; remove formula
2240 ;; We set the column equation, delete the named one.
2242 mustsave t))
2248 eq))
2251 "Store the list of formulas below the current table."
2258 ;; don't overwrite TBLFM, we might use text properties to store stuff
2274 ;; Fake a high number to make sure this is sorted at the end.
2281 a)
2291 "Compare two formulas for sorting."
2296 ;;;###autoload
2298 "Return an alist with the stored formulas directly after current table."
2307 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2326 "Modify the equations after the table structure has been edited.
2328 For all numbers larger than LIMIT, shift them by DELTA."
2340 s n a)
2346 "Change makes TBLFM term %s invalid, use undo to recover"
2362 "Get the column names and local parameters for this table."
2365 names name fields fields1 field cnt
2366 c v l line col types dlines hlines last-dline)
2368 org-table-local-parameters nil
2369 org-table-named-field-locations nil
2370 org-table-current-begin-line nil
2371 org-table-current-begin-pos nil
2372 org-table-current-line-types nil
2391 org-table-local-parameters))))
2407 ;; Analyse the line types
2411 l org-table-current-begin-line)
2428 al al2)
2438 ;;;###autoload
2441 If yes, store the formula and apply it."
2442 ;; We already know we are in a table. Get field will only return a formula
2443 ;; when appropriate. It might return a separator line, but no problem.
2446 named eq)
2457 "List of commands triggering the recalculation of a line.
2469 ;;;###autoload
2471 "Rotate the recalculation mark in the first column.
2472 If in any row, the first field is not consistent with a mark,
2473 insert a new column for the markers.
2474 When there is an active region, change all the lines in the region,
2475 after prompting for the marking character.
2476 After each change, a message will be displayed indicating the meaning
2477 of the new mark."
2492 epos new)
2499 newchar))
2531 ;;;###autoload
2533 "Recompute the current line if marked for it, and if we haven't just done it."
2553 org-tbl-calc-modes)
2555 ;;;###autoload
2557 suppress-align suppress-const
2558 suppress-store suppress-analysis)
2559 "Replace the table field value at the cursor by the result of a calculation.
2561 This function makes use of Dave Gillespie's Calc package, in my view the
2562 most exciting program ever written for GNU Emacs. So you need to have Calc
2563 installed in order to use this function.
2565 In a table, this command replaces the value in the current field with the
2567 formula, by storing it in a special line below the table. When called
2568 with a `C-u' prefix, the current field must be a named field, and the
2569 formula is installed as valid in only this specific field.
2571 When called with two `C-u' prefixes, insert the active equation
2572 for the field back into the current field, so that it can be
2574 to check the referenced fields.
2576 When called, the command first prompts for a formula, which is read in
2577 the minibuffer. Previously entered formulas are available through the
2578 history list, and the last used formula is offered as a default.
2579 These stored formulas are adapted correctly when moving, inserting, or
2580 deleting columns with the corresponding commands.
2582 The formula can be any algebraic expression understood by the Calc package.
2583 For details, see the Org-mode manual.
2585 This function can also be called from Lisp programs and offers
2586 additional arguments: EQUATION can be the formula to apply. If this
2587 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2588 used to speed-up recursive calls by by-passing unnecessary aligns.
2589 SUPPRESS-CONST suppresses the interpretation of constants in the
2590 formula, assuming that this has been done already outside the function.
2591 SUPPRESS-STORE means the formula should not be stored, either because
2592 it is already stored, or because it is a modified equation that should
2593 not overwrite the stored one."
2609 equation
2615 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2616 duration duration-output-format)
2617 ;; Parse the format string. Since we have a lot of modes, this is
2618 ;; a lot of work. However, I think calc still uses most of the time.
2631 'calc-float-format
2634 n))))
2638 duration-output-format nil
2642 duration-output-format org-table-duration-custom-format
2643 numbers t
2666 ;; replace fields with duration values if relevant
2670 fields)))
2676 x))
2677 fields)))
2683 ;; Insert row and column number of formula result field
2694 t t form)))
2696 ;; Check for old vertical references
2698 ;; Insert remote references
2711 rmtrng))
2712 keep-empty numbers lispp))
2713 t t form)))
2714 ;; Insert complex ranges
2722 ;; possibly handle durations
2727 formrg)
2728 keep-empty numbers lispp)))
2733 ;; Insert simple ranges
2742 keep-empty numbers lispp))
2743 t t form)))
2745 ;; Insert the references to fields in same row
2755 x keep-empty numbers lispp))
2756 t t form)))
2768 ;; Use <...> time-stamps so that Calc can handle them
2771 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2782 form
2789 duration-output-format)
2790 ev)))
2795 Orig: %s
2796 $xyz-> %s
2797 @r$c-> %s
2829 prop value)))
2832 "Get a calc vector from a column, according to descriptor DESC.
2833 Optional arguments TBEG and COL can give the beginning of the table and
2834 the current column, to avoid unnecessary parsing.
2836 HIGHLIGHT means just highlight the range.
2838 When CORNERS-ONLY is set, only return the corners of the range as
2839 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2840 in the buffer and column1 and column2 are table column numbers."
2847 beg end c1 c2 r1 r2 rangep tmp)
2864 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2871 ;; just one field
2878 ;; A range, return a vector
2879 ;; First sort the numbers to get a regular rectangle
2883 ;; Only return the corners of the range
2885 ;; Copy the range values into a list
2899 ;; return string representation of calc vector
2904 "Analyze descriptor DESC and retrieve the corresponding line number.
2905 The cursor is currently in line CLINE, the table begins in line BLINE,
2906 and TABLE is a vector with line types."
2914 ;; 1 2 3 4 5 6
2934 nil hn cline desc)))
2937 rel on cline desc)))
2941 "FIXME: Needs more documentation."
2954 nil))
2955 t)))
2959 desc cline)
2960 i)))
2965 s))
2968 "Convert list ELEMENTS to something appropriate to insert into formula.
2969 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2970 NUMBERS indicates that everything should be converted to numbers.
2971 LISPP non-nil means to return something appropriate for a Lisp
2972 list, 'literal is for the format specifier L."
2973 ;; Calc nan (not a number) is used for the conversion of the empty
2974 ;; field to a reference for several reasons: (i) It is accepted in a
2975 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2976 ;; (ii) In a single field (not in range) it can be distinguished
2977 ;; from "(nan)" which is the reference made from a single field
2978 ;; containing "nan".
2980 ;; field reference
2983 elements
2985 ""
2994 ;; range reference
2999 elements))))
3005 x
3013 x)
3015 elements
3018 ;;;###autoload
3020 "Set `org-table-formula-constants-local' in the current buffer."
3036 ;;;###autoload
3038 "Recalculate the current table line by applying all stored formulas.
3039 With prefix arg ALL, do this for all lines in the table.
3040 With the prefix argument ALL is `(16)' \
3042 it is the symbol `iterate', recompute the table until it no longer changes.
3043 If NOALIGN is not nil, do not re-align the table after the computations
3044 are done. This is typically used internally to save time, if it is
3045 known that the table will be realigned a little later anyway."
3060 seen-fields lhs1
3062 ;; Insert constants in all formulas
3080 eqlist))
3081 ;; Split the equation list
3087 ;; Expand ranges in lhs of formulas
3090 ;; Get the correct line range to process
3096 ;; This is a table with marked lines, compute selected lines
3098 ;; Move forward to the first non-header line
3109 ;; First find the named fields, and mark them untouchable.
3110 ;; Also check if several field/range formulas try to set the same field.
3129 name)))
3139 ;; Now evaluate the column formulas, but skip fields covered by
3140 ;; field formulas
3144 ;; Unprotected line, recalculate
3156 ;; Now evaluate the field formulas
3170 ;; back to initial position
3177 ;;;###autoload
3179 "Recalculate the table until it does not change anymore.
3180 The maximum number of iterations is 10, but you can choose a different value
3181 with the prefix ARG."
3186 thistbl)
3200 ;;;###autoload
3202 "Recalculate all tables in the current buffer."
3209 ;;;###autoload
3211 "Iterate all tables in the buffer, to converge inter-table dependencies."
3216 c1)
3232 "Apply the #+TBLFM in the line at point to the table."
3238 s e)
3240 ;; Insert a temporary formula at right after the table
3245 ;; Recalculate the table
3251 ;; delete the formula inserted temporarily
3255 "Find the beginning of the TBLFM lines and return its position.
3256 Return nil when the beginning of TBLFM line was not found."
3260 org-table-TBLFM-begin-regexp
3261 nil t))
3265 "Expand list of formulas.
3266 If some of the RHS in the formulas are ranges or a row reference, expand
3267 them to individual field equations for each field."
3273 ;; This just refers to one fixed field
3276 ;; This just refers to one fixed named field
3298 "Replace @<, @>, $<, $> with first/last row/column of the table.
3299 So @< and $< will always be replaced with @1 and $1, respectively.
3300 The advantage of these special markers are that structure editing of
3301 the table will not change them, while @1 and $1 will be modified
3302 when a line/row is swapped out of that privileged position. So for
3303 formulas that use a range of rows or columns, it may often be better
3305 borders of the table using the @< @> $< $> makers."
3308 s start)
3313 org-table-current-ncol)
3317 len
3324 s)
3327 "Replace $const with values in string F."
3329 ;; First, check for column names
3334 ;; Parameters and constants
3336 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3346 f))
3349 "Find the value for a parameter or constant in a formula.
3350 Parameters get priority."
3381 map))
3388 "--"
3391 "--"
3392 "Shift Reference at Point"
3397 "-"
3398 "Change Test Row for Column Formulas"
3401 "--"
3406 org-table-overlay-coordinates)]
3407 "--"
3413 ;;;###autoload
3415 "Edit the formulas of the current table in a separate buffer."
3417 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3431 entry s type title)
3434 ;; Keep global-font-lock-mode from turning on font-lock-mode
3475 "Convert a formula from internal to user representation."
3478 s))
3481 "Convert a formula from user to internal representation."
3484 s))
3487 "Convert spreadsheet references from A7 to @7$28.
3488 Works for single references, but also for entire formulas and even the
3489 full TBLFM line."
3491 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3494 ;; format match, just advance
3499 ;; 3.e5 or something like this.
3502 ;; (member (match-string 1 s)
3503 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3504 )
3505 ;; function name, just advance
3515 t t s)))))
3516 s))
3519 "Convert spreadsheet references from to @7$28 to AB7.
3520 Works for single references, but also for entire formulas and even the
3521 full TBLFM line."
3528 t t s)))
3533 t nil s)))
3534 s)
3537 "Convert a base 26 number represented by letters into an integer.
3538 For example: AB -> 28."
3544 n))
3547 "Convert an integer into a base 26 number represented by letters.
3548 For example: 28 -> AB."
3553 s))
3556 "Convert a time string into numerical duration in seconds.
3557 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3558 If S is a string representing a number, keep this number."
3560 s
3583 "Convert a number of seconds to a time string.
3584 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3585 minutes or seconds."
3600 "Convert all references in this buffer, using FUNCTION."
3610 "Convert all references in the buffer from B3 to @3$2 and back."
3620 "Shift the reference at point one row/hline up."
3624 "Shift the reference at point one row/hline down."
3628 "Shift the reference at point one field to the left."
3632 "Shift the reference at point one field to the right."
3643 ;; A B3-like reference
3649 ;; An internal reference
3655 "Re-match the group N, and replace it with the shifted reference."
3660 t t)))
3663 "Shift a reference part REF.
3664 If DECR is set, decrease the references row/column, else increase.
3665 If HLINE is set, this may be a hline reference, it certainly is not
3666 a translation reference."
3695 "Toggle the display of coordinates in the referenced table."
3704 "Parse the buffer for formula definitions and install them.
3705 With prefix ARG, apply the new formulas to the table."
3715 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3716 nil t)
3740 "Abort editing formulas, without installing the changes."
3751 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3792 "Show the location/value of the $ expression at point."
3801 var name e what match dest)
3806 "$1.."
3889 ;; column number
3917 org-table-fedit-scroll-down))))
3928 "Make sure the cursor is in a dataline in a table."
3937 p1 p2)))
3942 "Move cursor one line up in the window showing the table."
3947 "Move cursor one line down in the window showing the table."
3952 "Move the cursor in the window showing the table.
3953 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3978 "Add a new overlay."
3984 "Highlight rectangular region in a table."
3988 l1 c1 l2 c2 tmp)
4012 "Remove the rectangle overlays."
4023 "Add overlays to the table at point, to show row/column coordinates."
4051 ;;;###autoload
4053 "Toggle the display of Row/Column numbers in tables."
4064 ;;;###autoload
4066 "Toggle the formula debugger in tables."
4072 ;;; The orgtbl minor mode
4074 ;; Define a minor mode which can be used in other modes in order to
4075 ;; integrate the org-mode table editor.
4077 ;; This is really a hack, because the org-mode table editor uses several
4078 ;; keys which normally belong to the major mode, for example the TAB and
4079 ;; RET keys. Here is how it works: The minor mode defines all the keys
4080 ;; necessary to operate the table editor, but wraps the commands into a
4081 ;; function which tests if the cursor is currently inside a table. If that
4082 ;; is the case, the table editor command is executed. However, when any of
4083 ;; those keys is used outside a table, the function uses `key-binding' to
4084 ;; look up if the key has an associated command in another currently active
4085 ;; keymap (minor modes, major mode, global), and executes that command.
4086 ;; There might be problems if any of the keys used by the table editor is
4087 ;; otherwise used as a prefix key.
4089 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4090 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4091 ;; addresses this by checking explicitly for both bindings.
4093 ;; The optimized version (see variable `orgtbl-optimized') takes over
4094 ;; all keys which are bound to `self-insert-command' in the *global map*.
4095 ;; Some modes bind other commands to simple characters, for example
4096 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4097 ;; active, this binding is ignored inside tables and replaced with a
4098 ;; modified self-insert.
4116 ;; Install it as a minor mode.
4120 ;;;###autoload
4122 "The `org-mode' table editor as a minor mode for use in other modes."
4127 ;; Exit without error, in case some hook functions calls this
4128 ;; by accident in org-mode.
4132 ;; Make sure we are first in minor-mode-map-alist
4134 ;; FIXME: maybe it should use emulation-mode-map-alists?
4141 auto-fill-inhibit-regexp)
4145 auto-fill-inhibit-regexp)
4146 orgtbl-line-start-regexp))
4164 "Remove all properties related to narrow-column invisibility."
4177 "Create a function for binding in the table minor mode.
4178 FUN is the command to call inside a table. N is used to create a unique
4179 command name. KEYS are keys that should be checked in for a command
4180 to execute outside of tables."
4186 "Outside of tables, run the binding of `"
4198 keys)
4202 "Error when there is no default binding for a table key."
4207 "Setup orgtbl keymaps."
4238 elt key fun cmd)
4246 ;; Special treatment needed for TAB and RET
4266 [(tab)] "\C-i")))
4268 (org-defkey orgtbl-mode-map [backtab]
4270 [backtab] [S-iso-lefttab] [(shift tab)]
4271 [(tab)] "\C-i"))
4273 (org-defkey orgtbl-mode-map "\M-\C-m"
4274 (orgtbl-make-binding 'org-table-wrap-region 105
4275 "\M-\C-m" [(meta return)]))
4276 (org-defkey orgtbl-mode-map [(meta return)]
4277 (orgtbl-make-binding 'org-table-wrap-region 106
4278 [(meta return)] "\M-\C-m"))
4280 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4281 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4283 (when orgtbl-optimized
4284 ;; If the user wants maximum table support, we need to hijack
4285 ;; some standard editing functions
4286 (org-remap orgtbl-mode-map
4287 'self-insert-command 'orgtbl-self-insert-command
4288 'delete-char 'org-delete-char
4289 'delete-backward-char 'org-delete-backward-char)
4290 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4291 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4292 '("OrgTbl"
4293 ["Create or convert" org-table-create-or-convert-from-region
4294 :active (not (org-at-table-p)) :keys "C-c |" ]
4295 "--"
4296 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4297 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4298 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4299 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4300 "--"
4301 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4302 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4303 ["Copy Field from Above"
4304 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4305 "--"
4306 ("Column"
4307 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4308 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4309 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4310 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4311 ("Row"
4312 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4313 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4314 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4315 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4316 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4317 "--"
4318 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4319 ("Rectangle"
4320 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4321 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4322 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4323 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4324 "--"
4325 ("Radio tables"
4326 ["Insert table template" orgtbl-insert-radio-table
4327 (assq major-mode orgtbl-radio-table-templates)]
4328 ["Comment/uncomment table" orgtbl-toggle-comment t])
4329 "--"
4330 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4331 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4332 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4333 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4334 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4335 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4336 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4337 ["Sum Column/Rectangle" org-table-sum
4338 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4339 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4340 ["Debug Formulas"
4341 org-table-toggle-formula-debugger :active (org-at-table-p)
4342 :keys "C-c {"
4343 :style toggle :selected org-table-formula-debug]
4344 ["Show Col/Row Numbers"
4345 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4346 :keys "C-c }"
4347 :style toggle :selected org-table-overlay-coordinates]
4348 ))
4349 t))
4351 (defun orgtbl-ctrl-c-ctrl-c (arg)
4352 "If the cursor is inside a table, realign the table.
4353 If it is a table to be sent away to a receiver, do it.
4354 With prefix arg, also recompute table."
4355 (interactive "P")
4356 (let ((case-fold-search t) (pos (point)) action)
4357 (save-excursion
4358 (beginning-of-line 1)
4359 (setq action (cond
4363 (cond
4364 ((integerp action)
4365 (goto-char action)
4366 (org-table-maybe-eval-formula)
4367 (if arg
4368 (call-interactively 'org-table-recalculate)
4369 (org-table-maybe-recalculate-line))
4370 (call-interactively 'org-table-align)
4371 (when (orgtbl-send-table 'maybe)
4372 (run-hooks 'orgtbl-after-send-table-hook)))
4373 ((eq action 'recalc)
4374 (org-table-set-constants)
4375 (save-excursion
4376 (beginning-of-line 1)
4378 (if (org-at-table-p)
4379 (org-call-with-arg 'org-table-recalculate t))))
4380 (t (let (orgtbl-mode)
4381 (call-interactively (key-binding "\C-c\C-c")))))))
4383 (defun orgtbl-create-or-convert-from-region (arg)
4384 "Create table or convert region to table, if no conflicting binding.
4385 This installs the table binding `C-c |', but only if there is no
4386 conflicting binding to this key outside orgtbl-mode."
4387 (interactive "P")
4388 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4389 (if cmd
4390 (call-interactively cmd)
4391 (call-interactively 'org-table-create-or-convert-from-region))))
4393 (defun orgtbl-tab (arg)
4394 "Justification and field motion for `orgtbl-mode'."
4395 (interactive "P")
4396 (if arg (org-table-edit-field t)
4397 (org-table-justify-field-maybe)
4398 (org-table-next-field)))
4400 (defun orgtbl-ret ()
4401 "Justification and field motion for `orgtbl-mode'."
4402 (interactive)
4403 (if (bobp)
4404 (newline)
4405 (org-table-justify-field-maybe)
4406 (org-table-next-row)))
4408 (defun orgtbl-self-insert-command (N)
4409 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4410 If the cursor is in a table looking at whitespace, the whitespace is
4411 overwritten, and the table is not marked as requiring realignment."
4412 (interactive "p")
4413 (if (and (org-at-table-p)
4414 (or
4415 (and org-table-auto-blank-field
4416 (member last-command
4417 '(orgtbl-hijacker-command-100
4418 orgtbl-hijacker-command-101
4419 orgtbl-hijacker-command-102
4420 orgtbl-hijacker-command-103
4421 orgtbl-hijacker-command-104
4422 orgtbl-hijacker-command-105
4423 yas/expand))
4424 (org-table-blank-field))
4425 t)
4426 (eq N 1)
4428 (let (org-table-may-need-update)
4429 (goto-char (1- (match-end 0)))
4430 (org-delete-backward-char 1)
4431 (goto-char (match-beginning 0))
4432 (self-insert-command N))
4433 (setq org-table-may-need-update t)
4434 (let* (orgtbl-mode
4435 a
4436 (cmd (or (key-binding
4437 (or (and (listp function-key-map)
4438 (setq a (assoc last-input-event function-key-map))
4439 (cdr a))
4440 (vector last-input-event)))
4441 'self-insert-command)))
4442 (call-interactively cmd)
4443 (if (and org-self-insert-cluster-for-undo
4444 (eq cmd 'self-insert-command))
4445 (if (not (eq last-command 'orgtbl-self-insert-command))
4446 (setq org-self-insert-command-undo-counter 1)
4447 (if (>= org-self-insert-command-undo-counter 20)
4448 (setq org-self-insert-command-undo-counter 1)
4449 (and (> org-self-insert-command-undo-counter 0)
4450 buffer-undo-list
4451 (not (cadr buffer-undo-list)) ; remove nil entry
4452 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4453 (setq org-self-insert-command-undo-counter
4454 (1+ org-self-insert-command-undo-counter))))))))
4457 "Regular expression matching exponentials as produced by calc.")
4459 (defun orgtbl-gather-send-defs ()
4460 "Gather a plist of :name, :transform, :params for each destination before
4461 a radio table."
4462 (save-excursion
4463 (goto-char (org-table-begin))
4464 (let (rtn)
4465 (beginning-of-line 0)
4466 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4467 (let ((name (org-no-properties (match-string 1)))
4468 (transform (intern (match-string 2)))
4469 (params (if (match-end 3)
4470 (read (concat "(" (match-string 3) ")")))))
4471 (push (list :name name :transform transform :params params)
4472 rtn)
4473 (beginning-of-line 0)))
4474 rtn)))
4476 (defun orgtbl-send-replace-tbl (name txt)
4477 "Find and replace table NAME with TXT."
4478 (save-excursion
4479 (goto-char (point-min))
4480 (unless (re-search-forward
4482 (user-error "Don't know where to insert translated table"))
4483 (goto-char (match-beginning 0))
4484 (beginning-of-line 2)
4485 (save-excursion
4486 (let ((beg (point)))
4487 (unless (re-search-forward
4488 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4489 (user-error "Cannot find end of insertion region"))
4490 (beginning-of-line 1)
4491 (delete-region beg (point))))
4494 ;;;###autoload
4495 (defun org-table-to-lisp (&optional txt)
4496 "Convert the table at point to a Lisp structure.
4497 The structure will be a list. Each item is either the symbol `hline'
4498 for a horizontal separator line, or a list of field values as strings.
4499 The table is taken from the parameter TXT, or from the buffer at point."
4500 (unless txt
4501 (unless (org-at-table-p)
4502 (user-error "No table at point")))
4503 (let* ((txt (or txt
4504 (buffer-substring-no-properties (org-table-begin)
4505 (org-table-end))))
4508 (mapcar
4509 (lambda (x)
4510 (if (string-match org-table-hline-regexp x)
4511 'hline
4513 lines)))
4515 (defun orgtbl-send-table (&optional maybe)
4516 "Send a transformed version of this table to the receiver position.
4517 With argument MAYBE, fail quietly if no transformation is defined for
4518 this table."
4519 (interactive)
4520 (catch 'exit
4521 (unless (org-at-table-p) (user-error "Not at a table"))
4522 ;; when non-interactive, we assume align has just happened.
4523 (when (org-called-interactively-p 'any) (org-table-align))
4524 (let ((dests (orgtbl-gather-send-defs))
4525 (txt (buffer-substring-no-properties (org-table-begin)
4526 (org-table-end)))
4527 (ntbl 0))
4528 (unless dests (if maybe (throw 'exit nil)
4529 (user-error "Don't know how to transform this table")))
4530 (dolist (dest dests)
4531 (let* ((name (plist-get dest :name))
4532 (transform (plist-get dest :transform))
4533 (params (plist-get dest :params))
4534 (skip (plist-get params :skip))
4535 (skipcols (plist-get params :skipcols))
4536 (no-escape (plist-get params :no-escape))
4537 beg
4538 (lines (org-table-clean-before-export
4539 (nthcdr (or skip 0)
4541 (i0 (if org-table-clean-did-remove-column 2 1))
4542 (lines (if no-escape lines
4543 (mapcar (lambda(l) (replace-regexp-in-string
4545 (table (mapcar
4546 (lambda (x)
4547 (if (string-match org-table-hline-regexp x)
4548 'hline
4549 (org-remove-by-index
4551 skipcols i0)))
4552 lines))
4553 (fun (if (= i0 2) 'cdr 'identity))
4554 (org-table-last-alignment
4555 (org-remove-by-index (funcall fun org-table-last-alignment)
4556 skipcols i0))
4557 (org-table-last-column-widths
4558 (org-remove-by-index (funcall fun org-table-last-column-widths)
4559 skipcols i0))
4560 (txt (if (fboundp transform)
4561 (funcall transform table params)
4562 (user-error "No such transformation function %s" transform))))
4563 (orgtbl-send-replace-tbl name txt))
4564 (setq ntbl (1+ ntbl)))
4565 (message "Table converted and installed at %d receiver location%s"
4566 ntbl (if (> ntbl 1) "s" ""))
4567 (if (> ntbl 0)
4568 ntbl
4569 nil))))
4571 (defun org-remove-by-index (list indices &optional i0)
4572 "Remove the elements in LIST with indices in INDICES.
4573 First element has index 0, or I0 if given."
4574 (if (not indices)
4575 list
4576 (if (integerp indices) (setq indices (list indices)))
4577 (setq i0 (1- (or i0 0)))
4578 (delq :rm (mapcar (lambda (x)
4579 (setq i0 (1+ i0))
4580 (if (memq i0 indices) :rm x))
4581 list))))
4583 (defun orgtbl-toggle-comment ()
4584 "Comment or uncomment the orgtbl at point."
4585 (interactive)
4586 (let* ((case-fold-search t)
4587 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4588 (re2 (concat "^" orgtbl-line-start-regexp))
4589 (commented (save-excursion (beginning-of-line 1)
4590 (cond ((looking-at re1) t)
4591 ((looking-at re2) nil)
4592 (t (user-error "Not at an org table")))))
4593 (re (if commented re1 re2))
4594 beg end)
4595 (save-excursion
4596 (beginning-of-line 1)
4597 (while (looking-at re) (beginning-of-line 0))
4598 (beginning-of-line 2)
4599 (setq beg (point))
4600 (while (looking-at re) (beginning-of-line 2))
4601 (setq end (point)))
4602 (comment-region beg end (if commented '(4) nil))))
4604 (defun orgtbl-insert-radio-table ()
4605 "Insert a radio table template appropriate for this major mode."
4606 (interactive)
4607 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4608 (txt (nth 1 e))
4609 name pos)
4610 (unless e (user-error "No radio table setup defined for %s" major-mode))
4611 (setq name (read-string "Table name: "))
4612 (while (string-match "%n" txt)
4613 (setq txt (replace-match name t t txt)))
4615 (setq pos (point))
4616 (insert txt)
4617 (goto-char pos)))
4619 ;; Dynamically bound input and output for table formatting.
4620 (defvar *orgtbl-table* nil
4621 "Carries the current table through formatting routines.")
4622 (defvar *orgtbl-rtn* nil
4623 "Formatting routines push the output lines here.")
4624 ;; Formatting parameters for the current table section.
4625 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4626 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4627 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4628 (defvar *orgtbl-fmt* nil "Format for each entry.")
4629 (defvar *orgtbl-efmt* nil "Format for numbers.")
4630 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4631 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4632 (defvar *orgtbl-lstart* nil "Text starting a row.")
4633 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4634 (defvar *orgtbl-lend* nil "Text ending a row.")
4635 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4637 (defsubst orgtbl-get-fmt (fmt i)
4638 "Retrieve the format from FMT corresponding to the Ith column."
4639 (if (and (not (functionp fmt)) (consp fmt))
4640 (plist-get fmt i)
4641 fmt))
4643 (defsubst orgtbl-apply-fmt (fmt &rest args)
4644 "Apply format FMT to arguments ARGS.
4645 When FMT is nil, return the first argument from ARGS."
4646 (cond ((functionp fmt) (apply fmt args))
4647 (fmt (apply 'format fmt args))
4648 (args (car args))
4649 (t args)))
4651 (defsubst orgtbl-eval-str (str)
4652 "If STR is a function, evaluate it with no arguments."
4653 (if (functionp str)
4654 (funcall str)
4655 str))
4657 (defun orgtbl-format-line (line)
4658 "Format LINE as a table row."
4659 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4660 (let* ((i 0)
4661 (line
4662 (mapcar
4663 (lambda (f)
4664 (setq i (1+ i))
4665 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4666 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4667 (orgtbl-apply-fmt efmt (match-string 1 f)
4668 (match-string 2 f))
4669 f)))
4670 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4671 *orgtbl-default-fmt*)
4672 f)))
4673 line)))
4674 (push (if *orgtbl-lfmt*
4675 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4676 (concat (orgtbl-eval-str *orgtbl-lstart*)
4677 (mapconcat 'identity line *orgtbl-sep*)
4678 (orgtbl-eval-str *orgtbl-lend*)))
4679 *orgtbl-rtn*))))
4681 (defun orgtbl-format-section (section-stopper)
4682 "Format lines until the first occurrence of SECTION-STOPPER."
4683 (let (prevline)
4684 (progn
4685 (while (not (eq (car *orgtbl-table*) section-stopper))
4686 (if prevline (orgtbl-format-line prevline))
4687 (setq prevline (pop *orgtbl-table*)))
4688 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4689 (*orgtbl-lend* *orgtbl-llend*)
4690 (*orgtbl-lfmt* *orgtbl-llfmt*))
4691 (orgtbl-format-line prevline))))))
4693 ;;;###autoload
4694 (defun orgtbl-to-generic (table params &optional backend)
4695 "Convert the orgtbl-mode TABLE to some other format.
4696 This generic routine can be used for many standard cases.
4697 TABLE is a list, each entry either the symbol `hline' for a horizontal
4698 separator line, or a list of fields for that line.
4699 PARAMS is a property list of parameters that can influence the conversion.
4700 A third optional argument BACKEND can be used to convert the content of
4701 the cells using a specific export back-end.
4703 For the generic converter, some parameters are obligatory: you need to
4704 specify either :lfmt, or all of (:lstart :lend :sep).
4706 Valid parameters are:
4708 :splice When set to t, return only table body lines, don't wrap
4709 them into :tstart and :tend. Default is nil. When :splice
4710 is non-nil, this also means that the exporter should not look
4711 for and interpret header and footer sections.
4713 :hline String to be inserted on horizontal separation lines.
4714 May be nil to ignore hlines.
4716 :sep Separator between two fields
4717 :remove-nil-lines Do not include lines that evaluate to nil.
4719 Each in the following group may be either a string or a function
4720 of no arguments returning a string:
4722 :tstart String to start the table. Ignored when :splice is t.
4723 :tend String to end the table. Ignored when :splice is t.
4724 :lstart String to start a new table line.
4725 :llstart String to start the last table line, defaults to :lstart.
4726 :lend String to end a table line
4727 :llend String to end the last table line, defaults to :lend.
4729 Each in the following group may be a string, a function of one
4730 argument (the field or line) returning a string, or a plist
4731 mapping columns to either of the above:
4733 :lfmt Format for entire line, with enough %s to capture all fields.
4734 If this is present, :lstart, :lend, and :sep are ignored.
4735 :llfmt Format for the entire last line, defaults to :lfmt.
4736 :fmt A format to be used to wrap the field, should contain
4737 %s for the original field value. For example, to wrap
4739 This may also be a property list with column numbers and
4741 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4742 Same as above, specific for the header lines in the table.
4743 All lines before the first hline are treated as header.
4744 If any of these is not present, the data line value is used.
4746 This may be either a string or a function of two arguments:
4748 :efmt Use this format to print numbers with exponentials.
4749 The format should have %s twice for inserting mantissa
4751 may also be a property list with column numbers and
4752 formats. :fmt will still be applied after :efmt.
4754 In addition to this, the parameters :skip and :skipcols are always handled
4755 directly by `orgtbl-send-table'. See manual."
4756 (let* ((splicep (plist-get params :splice))
4757 (hline (plist-get params :hline))
4758 (skipheadrule (plist-get params :skipheadrule))
4759 (remove-nil-linesp (plist-get params :remove-nil-lines))
4760 (remove-newlines (plist-get params :remove-newlines))
4761 (*orgtbl-hline* hline)
4762 (*orgtbl-table* table)
4763 (*orgtbl-sep* (plist-get params :sep))
4764 (*orgtbl-efmt* (plist-get params :efmt))
4765 (*orgtbl-lstart* (plist-get params :lstart))
4766 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4767 (*orgtbl-lend* (plist-get params :lend))
4768 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4769 (*orgtbl-lfmt* (plist-get params :lfmt))
4770 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4771 (*orgtbl-fmt* (plist-get params :fmt))
4772 *orgtbl-rtn*)
4773 ;; Convert cells content to backend BACKEND
4774 (when backend
4775 (setq *orgtbl-table*
4776 (mapcar
4777 (lambda(r)
4778 (if (listp r)
4779 (mapcar
4780 (lambda (c)
4781 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4782 r)
4783 r))
4784 *orgtbl-table*)))
4785 ;; Put header
4786 (unless splicep
4787 (when (plist-member params :tstart)
4788 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4789 (if tstart (push tstart *orgtbl-rtn*)))))
4790 ;; If we have a heading, format it and handle the trailing hline.
4791 (if (and (not splicep)
4792 (or (consp (car *orgtbl-table*))
4793 (consp (nth 1 *orgtbl-table*)))
4794 (memq 'hline (cdr *orgtbl-table*)))
4795 (progn
4796 (when (eq 'hline (car *orgtbl-table*))
4797 ;; There is a hline before the first data line
4798 (and hline (push hline *orgtbl-rtn*))
4799 (pop *orgtbl-table*))
4800 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4801 *orgtbl-lstart*))
4802 (*orgtbl-llstart* (or (plist-get params :hllstart)
4803 *orgtbl-llstart*))
4804 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4805 (*orgtbl-llend* (or (plist-get params :hllend)
4806 (plist-get params :hlend) *orgtbl-llend*))
4807 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4808 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4809 (plist-get params :hlfmt) *orgtbl-llfmt*))
4810 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4811 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4812 (orgtbl-format-section 'hline))
4813 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4814 (pop *orgtbl-table*)))
4815 ;; Now format the main section.
4816 (orgtbl-format-section nil)
4817 (unless splicep
4818 (when (plist-member params :tend)
4819 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4820 (if tend (push tend *orgtbl-rtn*)))))
4821 (mapconcat (if remove-newlines
4822 (lambda (tend)
4824 'identity)
4825 (nreverse (if remove-nil-linesp
4826 (remq nil *orgtbl-rtn*)
4829 ;;;###autoload
4830 (defun orgtbl-to-tsv (table params)
4831 "Convert the orgtbl-mode table to TAB separated material."
4833 ;;;###autoload
4834 (defun orgtbl-to-csv (table params)
4835 "Convert the orgtbl-mode table to CSV material.
4836 This does take care of the proper quoting of fields with comma or quotes."
4837 (orgtbl-to-generic table (org-combine-plists
4838 '(:sep "," :fmt org-quote-csv-field)
4839 params)))
4841 ;;;###autoload
4842 (defun orgtbl-to-latex (table params)
4843 "Convert the orgtbl-mode TABLE to LaTeX.
4844 TABLE is a list, each entry either the symbol `hline' for a horizontal
4845 separator line, or a list of fields for that line.
4846 PARAMS is a property list of parameters that can influence the conversion.
4847 Supports all parameters from `orgtbl-to-generic'. Most important for
4848 LaTeX are:
4850 :splice When set to t, return only table body lines, don't wrap
4851 them into a tabular environment. Default is nil.
4853 :fmt A format to be used to wrap the field, should contain %s for the
4854 original field value. For example, to wrap everything in dollars,
4857 The format may also be a function that formats its one argument.
4859 :efmt Format for transforming numbers with exponentials. The format
4860 should have %s twice for inserting mantissa and exponent, for
4862 This may also be a property list with column numbers and formats.
4863 The format may also be a function that formats its two arguments.
4865 :llend If you find too much space below the last line of a table,
4868 The general parameters :skip and :skipcols have already been applied when
4869 this function is called."
4870 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4871 org-table-last-alignment ""))
4872 (params2
4873 (list
4878 (require 'ox-latex)
4879 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4881 ;;;###autoload
4882 (defun orgtbl-to-html (table params)
4883 "Convert the orgtbl-mode TABLE to HTML.
4884 TABLE is a list, each entry either the symbol `hline' for a horizontal
4885 separator line, or a list of fields for that line.
4886 PARAMS is a property list of parameters that can influence the conversion.
4887 Currently this function recognizes the following parameters:
4889 :splice When set to t, return only table body lines, don't wrap
4890 them into a <table> environment. Default is nil.
4892 The general parameters :skip and :skipcols have already been applied when
4893 this function is called. The function does *not* use `orgtbl-to-generic',
4894 so you cannot specify parameters for it."
4895 (require 'ox-html)
4896 (let ((output (org-export-string-as
4897 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4898 (if (not (plist-get params :splice)) output
4899 (org-trim
4900 (replace-regexp-in-string
4904 ;;;###autoload
4905 (defun orgtbl-to-texinfo (table params)
4906 "Convert the orgtbl-mode TABLE to TeXInfo.
4907 TABLE is a list, each entry either the symbol `hline' for a horizontal
4908 separator line, or a list of fields for that line.
4909 PARAMS is a property list of parameters that can influence the conversion.
4910 Supports all parameters from `orgtbl-to-generic'. Most important for
4911 TeXInfo are:
4913 :splice nil/t When set to t, return only table body lines, don't wrap
4914 them into a multitable environment. Default is nil.
4916 :fmt fmt A format to be used to wrap the field, should contain
4917 %s for the original field value. For example, to wrap
4919 This may also be a property list with column numbers and
4921 Each format also may be a function that formats its one
4922 argument.
4925 are computed automatically from the width of the columns
4926 under org-mode.
4928 The general parameters :skip and :skipcols have already been applied when
4929 this function is called."
4930 (let* ((total (float (apply '+ org-table-last-column-widths)))
4931 (colfrac (or (plist-get params :cf)
4932 (mapconcat
4933 (lambda (x) (format "%.3f" (/ (float x) total)))
4934 org-table-last-column-widths " ")))
4935 (params2
4936 (list
4937 :tstart (concat "@multitable @columnfractions " colfrac)
4938 :tend "@end multitable"
4939 :lstart "@item " :lend "" :sep " @tab "
4940 :hlstart "@headitem ")))
4941 (require 'ox-texinfo)
4942 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4944 ;;;###autoload
4945 (defun orgtbl-to-orgtbl (table params)
4946 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4947 Useful when slicing one table into many. The :hline, :sep,
4948 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4949 and :tend suppress strings without splicing; they can be set to
4950 provide ORGTBL directives for the generated table."
4951 (let* ((params2
4952 (list
4953 :remove-newlines t
4954 :tstart nil :tend nil
4955 :hline "|---"
4956 :sep " | "
4957 :lstart "| "
4958 :lend " |"))
4959 (params (org-combine-plists params2 params)))
4960 (with-temp-buffer
4961 (insert (orgtbl-to-generic table params))
4962 (goto-char (point-min))
4963 (while (re-search-forward org-table-hline-regexp nil t)
4964 (org-table-align))
4965 (buffer-substring 1 (buffer-size)))))
4967 (defun orgtbl-to-table.el (table params)
4968 "Convert the orgtbl-mode TABLE into a table.el table."
4969 (with-temp-buffer
4970 (insert (orgtbl-to-orgtbl table params))
4971 (org-table-align)
4972 (replace-regexp-in-string
4973 "-|" "-+"
4974 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4976 (defun orgtbl-to-unicode (table params)
4977 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4978 You need the ascii-art-to-unicode.el package for this. You can download
4979 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4980 (with-temp-buffer
4981 (insert (orgtbl-to-table.el table params))
4982 (goto-char (point-min))
4983 (if (or (featurep 'ascii-art-to-unicode)
4984 (require 'ascii-art-to-unicode nil t))
4985 (aa2u)
4986 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4987 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4988 "Link to ascii-art-to-unicode.el") org-stored-links))
4989 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4990 (buffer-string)))
4992 (defun org-table-get-remote-range (name-or-id form)
4993 "Get a field value or a list of values in a range from table at ID.
4995 NAME-OR-ID may be the name of a table in the current file as set
4997 will then be used. Alternatively, it may be an ID referring to
4998 any entry, also in a different file. In this case, the first
4999 table in that entry will be referenced.
5003 The return value is either a single string for a single field, or a
5004 list of the fields in the rectangle."
5005 (save-match-data
5006 (let ((case-fold-search t) (id-loc nil)
5007 ;; Protect a bunch of variables from being overwritten
5008 ;; by the context of the remote table
5009 org-table-column-names org-table-column-name-regexp
5010 org-table-local-parameters org-table-named-field-locations
5011 org-table-current-line-types org-table-current-begin-line
5012 org-table-current-begin-pos org-table-dlines
5013 org-table-current-ncol
5014 org-table-hlines org-table-last-alignment
5015 org-table-last-column-widths org-table-last-alignment
5016 org-table-last-column-widths tbeg
5017 buffer loc)
5018 (setq form (org-table-convert-refs-to-rc form))
5019 (save-excursion
5020 (save-restriction
5021 (widen)
5022 (save-excursion
5023 (goto-char (point-min))
5024 (if (re-search-forward
5027 nil t)
5028 (setq buffer (current-buffer) loc (match-beginning 0))
5029 (setq id-loc (org-id-find name-or-id 'marker))
5030 (unless (and id-loc (markerp id-loc))
5032 (setq buffer (marker-buffer id-loc)
5033 loc (marker-position id-loc))
5034 (move-marker id-loc nil)))
5035 (with-current-buffer buffer
5036 (save-excursion
5037 (save-restriction
5038 (widen)
5039 (goto-char loc)
5040 (forward-char 1)
5042 (not (match-beginning 1)))
5043 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5044 (setq tbeg (point-at-bol))
5045 (org-table-get-specials)
5046 (setq form (org-table-formula-substitute-names
5047 (org-table-formula-handle-first/last-rc form)))
5048 (if (and (string-match org-table-range-regexp form)
5049 (> (length (match-string 0 form)) 1))
5050 (save-match-data
5051 (org-table-get-range (match-string 0 form) tbeg 1))
5052 form)))))))))
5054 (defun org-table-remote-reference-indirection (form)
5055 "Return formula with table remote references substituted by indirection.
5057 This indirection works only with the format @ROW$COLUMN. The
5059 distinguished from a plain table name or ID."
5060 (let ((start 0))
5061 (while (string-match (concat
5062 ;; Same as in `org-table-eval-formula'.
5064 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5066 ;; Same as in `org-table-eval-formula'.
5068 form
5069 start)
5070 ;; The position of the character as far as possible to the right
5071 ;; that will not be replaced and particularly not be shifted by
5072 ;; `replace-match'.
5073 (setq start (match-beginning 1))
5074 ;; Substitute the remote reference with the value found in the
5075 ;; field.
5076 (setq form
5077 (replace-match
5078 (save-match-data
5079 (org-table-get-range (org-table-formula-handle-first/last-rc
5080 (match-string 1 form))))
5081 t t form 1))))
5082 form)
5084 (defmacro org-define-lookup-function (mode)
5085 (let ((mode-str (symbol-name mode))
5086 (first-p (equal mode 'first))
5087 (all-p (equal mode 'all)))
5088 (let ((plural-str (if all-p "s" "")))
5089 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5090 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5091 If R-LIST is nil, return matching element%s of S-LIST.
5092 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5093 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5094 This function is generated by a call to the macro `org-define-lookup-function'."
5095 mode-str plural-str plural-str plural-str)
5096 (let ,(let ((lvars '((p (or predicate 'equal))
5097 (sl s-list)
5098 (rl (or r-list s-list))
5099 (ret nil))))
5100 (if first-p (add-to-list 'lvars '(match-p nil)))
5101 lvars)
5102 (while ,(if first-p '(and (not match-p) sl) 'sl)
5103 (progn
5104 (if (funcall p val (car sl))
5105 (progn
5106 ,(if first-p '(setq match-p t))
5107 (let ((rval (car rl)))
5108 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5109 (setq sl (cdr sl) rl (cdr rl))))
5110 ret)))))
5112 (org-define-lookup-function first)
5113 (org-define-lookup-function last)
5114 (org-define-lookup-function all)
5116 (provide 'org-table)
5118 ;; Local variables:
5119 ;; generated-autoload-file: "org-loaddefs.el"
5120 ;; End:
5122 ;;; org-table.el ends here