| blob | d1609f94647e1e67b78c654526d0587e1c35a3a1 |
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."
457 lines))))
466 nil)
470 ;; remove the first column
473 lines))))
479 ;;;###autoload
481 "Use the table.el package to insert a new table.
482 If there is already a table at point, convert between Org-mode tables
483 and table.el tables."
496 ;;;###autoload
498 "Convert region to table, or create an empty table.
499 If there is an active region, convert it to a table, using the function
500 `org-table-convert-region'. See the documentation of that function
501 to learn how the prefix argument is interpreted to determine the field
502 separator.
503 If there is no such region, create an empty table with `org-table-create'."
509 ;;;###autoload
511 "Query for a size and insert a table skeleton.
531 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
535 ;; Insert a hline after the first row.
542 ;;;###autoload
544 "Convert region to a table.
545 The region goes from BEG0 to END0, but these borders will be moved
546 slightly, to make sure a beginning of line in the first line is included.
548 SEPARATOR specifies the field separator in the lines. It can have the
549 following values:
551 '(4) Use the comma as a field separator
552 '(16) Use a TAB as field separator
553 '(64) Prompt for a regular expression as field separator
554 integer When a number, use that many spaces as field separator
555 regexp When a regular expression, use it to match the separator
556 nil When nil, the command tries to be smart and figure out the
557 separator in the following way:
558 - when each line contains a TAB, assume TAB-separated material
559 - when each line contains a comma, assume CSV material
560 - else, assume one or more SPACE characters as separator."
564 re)
573 ;; Get the right field separator
584 ;; parse the csv stuff
609 ;;;###autoload
611 "Import FILE as a table.
612 The file is assumed to be tab-separated. Such files can be produced by most
613 spreadsheet and database applications. If no tabs (at least one per line)
614 are found, lines will be split on whitespace into fields."
625 ;;;###autoload
627 "Export table to a file, with configurable format.
628 Such a file can be imported into usual spreadsheet programs.
630 FILE can be the output file name. If not given, it will be taken
631 from a TABLE_EXPORT_FILE property in the current entry or higher
632 up in the hierarchy, or the user will be prompted for a file
633 name. FORMAT can be an export format, of the same kind as it
634 used when `orgtbl-mode' sends a table in a different format.
636 The command suggests a format depending on TABLE_EXPORT_FORMAT,
637 whether it is set locally or up in the hierarchy, then on the
638 extension of the given file name, and finally on the variable
639 `org-table-export-default-format'."
653 buf deffmt-readable fileext)
669 org-table-export-default-format))
687 'hline
690 skipcols i0)))
691 lines))
695 skipcols i0))
698 skipcols i0)))
715 "Marker at the beginning of the table last aligned.
718 "Marker at the end of the table last aligned.
721 "List of flags for flushright alignment, from the last re-alignment.
724 "List of max width of fields in each column.
727 "Non-nil means debug table formulas.
739 ;;;###autoload
741 "Align the table at point by aligning all vertical bars."
744 ;; Limits of table
747 ;; Current cursor position
753 column
755 rfmt hfmt
763 emptystrings links dates emph raise narrow
764 falign falign1 fmax f1 f2 len c e space)
767 ;; Check if we have links or dates
779 ;; Make sure the link properties are right
781 ;; Make sure the date properties are right
786 ;; Check if we are narrowing any columns
789 org-format-transports-properties-p
794 ;; Get the rows
797 ;; Store the indentation of the first line
800 ;; Mark the hlines by setting the corresponding element to nil
801 ;; At the same time, we remove trailing space.
804 nil
807 l)))
808 lines))
809 ;; Get the data fields by splitting the lines.
814 ;; How many fields in the longest line?
821 ;; A list of empty strings to fill any short rows on output
823 ;; Check for special formatting.
827 ;; Check if there is an explicit width specified
837 ;; Find fields that are wider than fmax, and shorten them
843 'help-echo
852 f2)
856 f1)
862 xx)))))
863 ;; Get the maximum width for each column
865 lengths)
866 ;; Get the fraction of numbers, to decide about alignment of the column
872 nil
879 ;; Store the alignment of this table, for later editing of single fields
881 org-table-last-column-widths lengths)
883 ;; With invisible characters, `format' does not get the field width right
884 ;; So we need to make these fields wide by hand.
902 ;; Compute the formats needed for output of the table
915 hfmt))
919 ;; Replace the old one
926 ;; Try to move to the old location
935 ))
937 ;;;###autoload
939 "Find the beginning of the table and return its position.
940 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
944 org-table-border-regexp)
945 nil t))
951 ;;;###autoload
953 "Find the end of the table and return its position.
954 With argument TABLE-TYPE, go to the end of a table.el-type table."
958 org-table-border-regexp)
959 nil t))
964 ;;;###autoload
966 "Justify the current field, text to left, number to right.
967 Optional argument NEW may specify text to replace the current field content."
976 ;; This is not the same table, force a full re-align
982 l f n o e)
1008 ;;;###autoload
1010 "Go to the next field in the current table, creating new lines as needed.
1011 Before doing so, re-align the table if necessary."
1016 org-table-may-need-update)
1027 org-table-tab-jumps-over-hlines
1038 ;;;###autoload
1040 "Go to the previous field in the table.
1041 Before doing so, re-align the table if necessary."
1046 org-table-may-need-update)
1061 "Move to the end of the current table field.
1062 If already at or after the end, move to the end of the next table field.
1063 With numeric argument N, move N-1 fields forward first."
1076 "Move to the beginning of the current table field.
1077 If already at or before the beginning, move to the beginning of the
1078 previous field.
1079 With numeric argument N, move N-1 fields backward first."
1092 ;;;###autoload
1094 "Go to the next row (same column) in the current table.
1095 Before doing so, re-align the table if necessary."
1103 org-table-may-need-update)
1116 ;;;###autoload
1118 "Copy the value of the current field one row below.
1120 If the field at the cursor is empty, copy the content of the
1121 nearest non-empty field above. With argument N, use the Nth
1122 non-empty field.
1124 If the current field is not empty, it is copied down to the next
1125 row, and the cursor is moved with it. Therefore, repeating this
1126 command causes the column to be filled row-by-row.
1128 If the variable `org-table-copy-increment' is non-nil and the
1129 field is an integer or a timestamp, it will be incremented while
1130 copying. By default, increment by the difference between the
1131 value in the current field and the one in the field above. To
1132 increment using a fixed integer, set `org-table-copy-increment'
1133 to a number. In the case of a timestamp, increment by days."
1145 txt txt-up inc)
1153 beg t))
1163 beg t))
1170 ;; Above field was not empty, go down to the next row
1203 "Is point inside a table data field?
1204 I.e. not on a hline or before the first or after the last column?
1205 This actually throws an error, so it aborts the current command."
1211 nil
1213 t))
1219 "Get the field in table line LINE, column COLUMN.
1220 If LINE is larger than the number of data lines in the table, the function
1221 returns nil. However, if COLUMN is too large, we will simply return an
1222 empty string.
1223 If LINE is nil, use the current line.
1224 If column is nil, use the current column."
1231 "Put VALUE into line LINE, column COLUMN.
1232 When ALIGN is set, also realign the table."
1241 "Return the index of the current data line."
1248 cnt))
1251 "Go to the Nth data line in the current table.
1252 Return t when the line exists, nil if it does not exist."
1259 ;;;###autoload
1261 "Blank the current table field or active region."
1278 "Return the value of the field in column N of current row.
1279 N defaults to current field.
1280 If REPLACE is a string, replace field with this value. The return value
1281 is always the old value."
1290 t t))
1292 val)
1295 ;;;###autoload
1297 "Show info about the current field, and highlight any reference at point."
1306 org-table-named-field-locations)))
1326 dline col
1328 dline col ref1
1330 ;; FIXME: formula info not correct if special table line
1340 "Find out which column we are in."
1350 cnt)))
1352 ;;;###autoload
1354 "Find out what table data line we are in.
1355 Only data lines count for this."
1367 cnt)))
1369 ;;;###autoload
1371 "Move the cursor to the Nth column in the current table line.
1372 With optional argument ON-DELIM, stop with point before the left delimiter
1373 of the field.
1374 If there are less than N fields, just go to after the last delimiter.
1375 However, when FORCE is non-nil, create new columns if necessary."
1385 t)))))
1392 ;;;###autoload
1394 "Insert a new column into the table."
1402 ;; Current cursor position
1408 nil
1422 "Find a data line in the current table, which is needed for column commands."
1425 t
1436 t
1441 "Turn a buffer line number into a data line number.
1442 If there is no data line in this line, return nil.
1443 If there is no matching dline (most likely te reference was a hline), the
1444 first dline below it is used. When ABOVE is non-nil, the one above is used."
1447 i)
1460 nil))
1462 ;;;###autoload
1464 "Delete a column from the table."
1473 ;; Current cursor position
1479 nil
1495 ;;;###autoload
1497 "Move column to the right."
1500 ;;;###autoload
1502 "Move column to the left."
1506 ;;;###autoload
1508 "Move the current column to the right. With arg LEFT, move to the left."
1518 ;; Current cursor position
1528 nil
1546 ;;;###autoload
1548 "Move table row down."
1551 ;;;###autoload
1553 "Move table row up."
1557 ;;;###autoload
1559 "Move the current table line down. With arg UP, move it up."
1568 txt hline2p)
1591 ;;;###autoload
1593 "Insert a new row above the current line into the table.
1594 With prefix ARG, insert below the current line."
1600 ;; Fix the first field if necessary
1613 ;;;###autoload
1615 "Insert a horizontal-line below the current line into the table.
1616 With prefix ABOVE, insert above the current line."
1637 ;;;###autoload
1639 "Insert a hline and move to the row below that line."
1653 In particular, this does handle wide and invisible characters."
1655 ;; It's a hline, just map the characters
1661 t t s)))
1662 s))
1664 ;;;###autoload
1666 "Delete the current row or horizontal line from the table."
1680 ;;;###autoload
1682 "Sort table lines according to the column at point.
1684 The position of point indicates the column to be used for
1685 sorting, and the range of lines is the range between the nearest
1686 horizontal separator lines, or the entire table of no such lines
1687 exist. If point is before the first column, you will be prompted
1688 for the sorting column. If there is an active region, the mark
1689 specifies the first line and the sorting column, while point
1690 should be in the last line to be included into the sorting.
1692 The command then prompts for the sorting type which can be
1693 alphabetically, numerically, or by time (as given in a time stamp
1694 in the field, or as a HH:MM value). Sorting in reverse order is
1695 also possible.
1697 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1699 If SORTING-TYPE is specified when this function is called from a Lisp
1700 program, no prompting will take place. SORTING-TYPE must be a character,
1701 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1702 should be done in reverse order."
1707 beg end bcol ecol tend tbeg column lns pos)
1752 x))
1766 ;;;###autoload
1768 "Copy region in table to the clipboard and blank all relevant fields.
1769 If there is no active region, use just the field at point."
1775 ;;;###autoload
1777 "Copy rectangular region in table to clipboard.
1778 A special clipboard is used which can only be accessed
1779 with `org-table-paste-rectangle'."
1783 current-prefix-arg))
1785 region cols
1811 org-table-clip))
1813 ;;;###autoload
1815 "Paste a rectangular region into a table.
1816 The upper right corner ends up in the current field. All involved fields
1817 will be overwritten. If the rectangle does not fit into the present table,
1818 the table is enlarged as needed. The process ignores horizontal separator
1819 lines."
1829 c cols field)
1844 ;;;###autoload
1846 "Convert from `org-mode' table to table.el and back.
1847 Obviously, this only works within limits. When an Org-mode table is
1848 converted to table.el, all horizontal separator lines get lost, because
1849 table.el uses these as cell boundaries and has no notion of horizontal lines.
1850 A table.el table can be converted to an Org-mode table only if it does not
1851 do row or column spanning. Multiline cells will become multiple cells.
1852 Beware, Org-mode does not test if the table can be successfully converted - it
1853 blindly applies a recipe that works for simple tables."
1857 ;; convert to Org-mode table
1866 ;; convert to table.el table
1869 ;; first, get rid of all horizontal lines
1873 ;; insert a hline before first
1877 ;; insert a hline after each line
1882 ;; replace "+" at beginning and ending of hlines
1891 "Transpose Org table at point and eliminate hlines.
1892 So a table like
1894 | 1 | 2 | 4 | 5 |
1895 |---+---+---+---|
1896 | a | b | c | d |
1897 | e | f | g | h |
1899 will be transposed as
1901 | 1 | a | e |
1902 | 2 | b | f |
1903 | 4 | c | g |
1904 | 5 | d | h |
1906 Note that horizontal lines disappear."
1918 table)))
1932 ;;;###autoload
1934 "Wrap several fields in a column like a paragraph.
1935 This is useful if you'd like to spread the contents of a field over several
1936 lines, in order to keep the table compact.
1938 If there is an active region, and both point and mark are in the same column,
1939 the text in the column is wrapped to minimum width for the given number of
1940 lines. Generally, this makes the table more compact. A prefix ARG may be
1942 formats the selected text to two lines. If the region was longer than two
1943 lines, the remaining lines remain empty. A negative prefix argument reduces
1944 the current number of lines by that amount. The wrapped text is pasted back
1945 into the table. If you formatted it to more lines than it was before, fields
1946 further down in the table get overwritten - so you might need to make space in
1947 the table first.
1949 If there is no region, the current field is split at the cursor position and
1950 the text fragment to the right of the cursor is prepended to the field one
1951 line down.
1953 If there is no region, but you specify a prefix ARG, the current field gets
1954 blank, and the content is appended to the field above."
1958 ;; There is a region: fill as a paragraph
1962 nlines)
1969 arg)
1973 nil nlines)))
1977 ;; No region, split the current field at point
1981 ;; combine with field above
1991 ;; split field
2003 ;;;###autoload
2005 "Edit table field in a different window.
2006 This is mainly useful for fields that contain hidden parts.
2008 it can be edited in place."
2017 display t intangible t))
2030 p)
2046 intangible t))
2054 "Finish editing a table data field.
2055 Remove all newline characters, insert the result into the table, realign
2056 the table and kill the editing buffer."
2060 text)
2077 "Minor mode to make the table field editor window follow the cursor.
2078 When this mode is active, the field editor window will always show the
2079 current field. The mode exits automatically when the cursor leaves the
2080 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2081 nil " TblFollow" nil
2097 ;; We have left the table, exit the follow mode
2107 ;;;###autoload
2109 "Sum numbers in region of current table column.
2110 The result will be displayed in the echo area, and will be available
2113 If there is an active region, it is interpreted as a rectangle and all
2114 numbers in that rectangle will be summed. If there is no active
2115 region and point is located in a table column, sum all numbers in that
2116 column.
2118 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2119 numbers are assumed to be times as well (in decimal hours) and the
2120 numbers are added as such.
2122 If NLAST is a number, only the NLAST fields will actually be summed."
2149 items1)))
2156 s diff)
2164 sres))))
2187 "Return the formula active for the current field.
2188 Assumes that specials are in place.
2189 If KEY is given, return the key to this formula.
2193 org-table-named-field-locations)))
2207 "Read a formula from the minibuffer, offer stored formula as default.
2208 When NAMED is non-nil, look for a named equation."
2212 org-table-named-field-locations)))
2219 name
2220 ref)
2230 stored)
2232 equation)
2239 scol))
2241 'org-table-formula-history
2242 )))))
2243 mustsave)
2245 ;; remove formula
2252 ;; We set the column equation, delete the named one.
2254 mustsave t))
2260 eq))
2263 "Store the list of formulas below the current table."
2270 ;; don't overwrite TBLFM, we might use text properties to store stuff
2286 ;; Fake a high number to make sure this is sorted at the end.
2293 a)
2303 "Compare two formulas for sorting."
2308 ;;;###autoload
2310 "Return an alist with the stored formulas directly after current table."
2319 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2338 "Modify the equations after the table structure has been edited.
2340 For all numbers larger than LIMIT, shift them by DELTA."
2352 s n a)
2358 "Change makes TBLFM term %s invalid, use undo to recover"
2374 "Get the column names and local parameters for this table."
2377 names name fields fields1 field cnt
2378 c v l line col types dlines hlines last-dline)
2380 org-table-local-parameters nil
2381 org-table-named-field-locations nil
2382 org-table-current-begin-line nil
2383 org-table-current-begin-pos nil
2384 org-table-current-line-types nil
2403 org-table-local-parameters))))
2419 ;; Analyse the line types
2423 l org-table-current-begin-line)
2440 al al2)
2450 ;;;###autoload
2453 If yes, store the formula and apply it."
2454 ;; We already know we are in a table. Get field will only return a formula
2455 ;; when appropriate. It might return a separator line, but no problem.
2458 named eq)
2469 "List of commands triggering the recalculation of a line.
2481 ;;;###autoload
2483 "Rotate the recalculation mark in the first column.
2484 If in any row, the first field is not consistent with a mark,
2485 insert a new column for the markers.
2486 When there is an active region, change all the lines in the region,
2487 after prompting for the marking character.
2488 After each change, a message will be displayed indicating the meaning
2489 of the new mark."
2504 epos new)
2511 newchar))
2543 ;;;###autoload
2545 "Recompute the current line if marked for it, and if we haven't just done it."
2565 org-tbl-calc-modes)
2567 ;;;###autoload
2569 suppress-align suppress-const
2570 suppress-store suppress-analysis)
2571 "Replace the table field value at the cursor by the result of a calculation.
2573 This function makes use of Dave Gillespie's Calc package, in my view the
2574 most exciting program ever written for GNU Emacs. So you need to have Calc
2575 installed in order to use this function.
2577 In a table, this command replaces the value in the current field with the
2579 formula, by storing it in a special line below the table. When called
2580 with a `C-u' prefix, the current field must be a named field, and the
2581 formula is installed as valid in only this specific field.
2583 When called with two `C-u' prefixes, insert the active equation
2584 for the field back into the current field, so that it can be
2586 to check the referenced fields.
2588 When called, the command first prompts for a formula, which is read in
2589 the minibuffer. Previously entered formulas are available through the
2590 history list, and the last used formula is offered as a default.
2591 These stored formulas are adapted correctly when moving, inserting, or
2592 deleting columns with the corresponding commands.
2594 The formula can be any algebraic expression understood by the Calc package.
2595 For details, see the Org-mode manual.
2597 This function can also be called from Lisp programs and offers
2598 additional arguments: EQUATION can be the formula to apply. If this
2599 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2600 used to speed-up recursive calls by by-passing unnecessary aligns.
2601 SUPPRESS-CONST suppresses the interpretation of constants in the
2602 formula, assuming that this has been done already outside the function.
2603 SUPPRESS-STORE means the formula should not be stored, either because
2604 it is already stored, or because it is a modified equation that should
2605 not overwrite the stored one."
2621 equation
2627 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2628 duration duration-output-format)
2629 ;; Parse the format string. Since we have a lot of modes, this is
2630 ;; a lot of work. However, I think calc still uses most of the time.
2643 'calc-float-format
2646 n))))
2650 duration-output-format nil
2654 duration-output-format org-table-duration-custom-format
2655 numbers t
2678 ;; replace fields with duration values if relevant
2682 fields)))
2688 x))
2689 fields)))
2695 ;; Insert row and column number of formula result field
2706 t t form)))
2708 ;; Check for old vertical references
2710 ;; Insert remote references
2723 rmtrng))
2724 keep-empty numbers lispp))
2725 t t form)))
2726 ;; Insert complex ranges
2734 ;; possibly handle durations
2739 formrg)
2740 keep-empty numbers lispp)))
2745 ;; Insert simple ranges
2754 keep-empty numbers lispp))
2755 t t form)))
2757 ;; Insert the references to fields in same row
2764 x keep-empty numbers lispp)))
2782 ;; Use <...> time-stamps so that Calc can handle them
2785 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2796 form
2803 duration-output-format)
2804 ev)))
2809 Orig: %s
2810 $xyz-> %s
2811 @r$c-> %s
2843 prop value)))
2846 "Get a calc vector from a column, according to descriptor DESC.
2847 Optional arguments TBEG and COL can give the beginning of the table and
2848 the current column, to avoid unnecessary parsing.
2850 HIGHLIGHT means just highlight the range.
2852 When CORNERS-ONLY is set, only return the corners of the range as
2853 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2854 in the buffer and column1 and column2 are table column numbers."
2861 beg end c1 c2 r1 r2 rangep tmp)
2878 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2885 ;; just one field
2892 ;; A range, return a vector
2893 ;; First sort the numbers to get a regular rectangle
2897 ;; Only return the corners of the range
2899 ;; Copy the range values into a list
2913 ;; return string representation of calc vector
2918 "Analyze descriptor DESC and retrieve the corresponding line number.
2919 The cursor is currently in line CLINE, the table begins in line BLINE,
2920 and TABLE is a vector with line types."
2928 ;; 1 2 3 4 5 6
2948 nil hn cline desc)))
2951 rel on cline desc)))
2955 "FIXME: Needs more documentation."
2968 nil))
2969 t)))
2973 desc cline)
2974 i)))
2979 s))
2982 "Convert list ELEMENTS to something appropriate to insert into formula.
2983 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2984 NUMBERS indicates that everything should be converted to numbers.
2985 LISPP non-nil means to return something appropriate for a Lisp
2986 list, 'literal is for the format specifier L."
2987 ;; Calc nan (not a number) is used for the conversion of the empty
2988 ;; field to a reference for several reasons: (i) It is accepted in a
2989 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2990 ;; (ii) In a single field (not in range) it can be distinguished
2991 ;; from "(nan)" which is the reference made from a single field
2992 ;; containing "nan".
2994 ;; field reference
2997 elements
2999 ""
3008 ;; range reference
3013 elements))))
3019 x
3027 x)
3029 elements
3032 ;;;###autoload
3034 "Set `org-table-formula-constants-local' in the current buffer."
3050 ;;;###autoload
3052 "Recalculate the current table line by applying all stored formulas.
3053 With prefix arg ALL, do this for all lines in the table.
3054 With the prefix argument ALL is `(16)' \
3056 it is the symbol `iterate', recompute the table until it no longer changes.
3057 If NOALIGN is not nil, do not re-align the table after the computations
3058 are done. This is typically used internally to save time, if it is
3059 known that the table will be realigned a little later anyway."
3074 seen-fields lhs1
3076 ;; Insert constants in all formulas
3094 eqlist))
3095 ;; Split the equation list
3101 ;; Expand ranges in lhs of formulas
3104 ;; Get the correct line range to process
3110 ;; This is a table with marked lines, compute selected lines
3112 ;; Move forward to the first non-header line
3123 ;; First find the named fields, and mark them untouchable.
3124 ;; Also check if several field/range formulas try to set the same field.
3143 name)))
3153 ;; Now evaluate the column formulas, but skip fields covered by
3154 ;; field formulas
3158 ;; Unprotected line, recalculate
3170 ;; Now evaluate the field formulas
3184 ;; back to initial position
3191 ;;;###autoload
3193 "Recalculate the table until it does not change anymore.
3194 The maximum number of iterations is 10, but you can choose a different value
3195 with the prefix ARG."
3200 thistbl)
3214 ;;;###autoload
3216 "Recalculate all tables in the current buffer."
3223 ;;;###autoload
3225 "Iterate all tables in the buffer, to converge inter-table dependencies."
3230 c1)
3246 "Apply the #+TBLFM in the line at point to the table."
3252 s e)
3254 ;; Insert a temporary formula at right after the table
3259 ;; Recalculate the table
3265 ;; delete the formula inserted temporarily
3269 "Find the beginning of the TBLFM lines and return its position.
3270 Return nil when the beginning of TBLFM line was not found."
3274 org-table-TBLFM-begin-regexp
3275 nil t))
3279 "Expand list of formulas.
3280 If some of the RHS in the formulas are ranges or a row reference, expand
3281 them to individual field equations for each field."
3287 ;; This just refers to one fixed field
3290 ;; This just refers to one fixed named field
3312 "Replace @<, @>, $<, $> with first/last row/column of the table.
3313 So @< and $< will always be replaced with @1 and $1, respectively.
3314 The advantage of these special markers are that structure editing of
3315 the table will not change them, while @1 and $1 will be modified
3316 when a line/row is swapped out of that privileged position. So for
3317 formulas that use a range of rows or columns, it may often be better
3319 borders of the table using the @< @> $< $> makers."
3322 s start)
3327 org-table-current-ncol)
3331 len
3338 s)
3341 "Replace $const with values in string F."
3343 ;; First, check for column names
3348 ;; Parameters and constants
3350 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3360 f))
3363 "Find the value for a parameter or constant in a formula.
3364 Parameters get priority."
3395 map))
3402 "--"
3405 "--"
3406 "Shift Reference at Point"
3411 "-"
3412 "Change Test Row for Column Formulas"
3415 "--"
3420 org-table-overlay-coordinates)]
3421 "--"
3427 ;;;###autoload
3429 "Edit the formulas of the current table in a separate buffer."
3431 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3445 entry s type title)
3448 ;; Keep global-font-lock-mode from turning on font-lock-mode
3489 "Convert a formula from internal to user representation."
3492 s))
3495 "Convert a formula from user to internal representation."
3498 s))
3501 "Convert spreadsheet references from A7 to @7$28.
3502 Works for single references, but also for entire formulas and even the
3503 full TBLFM line."
3505 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3508 ;; format match, just advance
3513 ;; 3.e5 or something like this.
3516 ;; (member (match-string 1 s)
3517 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3518 )
3519 ;; function name, just advance
3529 t t s)))))
3530 s))
3533 "Convert spreadsheet references from to @7$28 to AB7.
3534 Works for single references, but also for entire formulas and even the
3535 full TBLFM line."
3542 t t s)))
3547 t nil s)))
3548 s)
3551 "Convert a base 26 number represented by letters into an integer.
3552 For example: AB -> 28."
3558 n))
3561 "Convert an integer into a base 26 number represented by letters.
3562 For example: 28 -> AB."
3567 s))
3570 "Convert a time string into numerical duration in seconds.
3571 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3572 If S is a string representing a number, keep this number."
3574 s
3597 "Convert a number of seconds to a time string.
3598 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3599 minutes or seconds."
3614 "Convert all references in this buffer, using FUNCTION."
3624 "Convert all references in the buffer from B3 to @3$2 and back."
3634 "Shift the reference at point one row/hline up."
3638 "Shift the reference at point one row/hline down."
3642 "Shift the reference at point one field to the left."
3646 "Shift the reference at point one field to the right."
3657 ;; A B3-like reference
3663 ;; An internal reference
3669 "Re-match the group N, and replace it with the shifted reference."
3674 t t)))
3677 "Shift a reference part REF.
3678 If DECR is set, decrease the references row/column, else increase.
3679 If HLINE is set, this may be a hline reference, it certainly is not
3680 a translation reference."
3709 "Toggle the display of coordinates in the referenced table."
3718 "Parse the buffer for formula definitions and install them.
3719 With prefix ARG, apply the new formulas to the table."
3729 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3730 nil t)
3754 "Abort editing formulas, without installing the changes."
3765 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3806 "Show the location/value of the $ expression at point."
3815 var name e what match dest)
3820 "$1.."
3903 ;; column number
3931 org-table-fedit-scroll-down))))
3943 "Make sure the cursor is in a dataline in a table."
3952 p1 p2)))
3957 "Move cursor one line up in the window showing the table."
3962 "Move cursor one line down in the window showing the table."
3967 "Move the cursor in the window showing the table.
3968 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3993 "Add a new overlay."
3999 "Highlight rectangular region in a table."
4003 l1 c1 l2 c2 tmp)
4027 "Remove the rectangle overlays."
4038 "Add overlays to the table at point, to show row/column coordinates."
4066 ;;;###autoload
4068 "Toggle the display of Row/Column numbers in tables."
4079 ;;;###autoload
4081 "Toggle the formula debugger in tables."
4087 ;;; The orgtbl minor mode
4089 ;; Define a minor mode which can be used in other modes in order to
4090 ;; integrate the org-mode table editor.
4092 ;; This is really a hack, because the org-mode table editor uses several
4093 ;; keys which normally belong to the major mode, for example the TAB and
4094 ;; RET keys. Here is how it works: The minor mode defines all the keys
4095 ;; necessary to operate the table editor, but wraps the commands into a
4096 ;; function which tests if the cursor is currently inside a table. If that
4097 ;; is the case, the table editor command is executed. However, when any of
4098 ;; those keys is used outside a table, the function uses `key-binding' to
4099 ;; look up if the key has an associated command in another currently active
4100 ;; keymap (minor modes, major mode, global), and executes that command.
4101 ;; There might be problems if any of the keys used by the table editor is
4102 ;; otherwise used as a prefix key.
4104 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4105 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4106 ;; addresses this by checking explicitly for both bindings.
4108 ;; The optimized version (see variable `orgtbl-optimized') takes over
4109 ;; all keys which are bound to `self-insert-command' in the *global map*.
4110 ;; Some modes bind other commands to simple characters, for example
4111 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4112 ;; active, this binding is ignored inside tables and replaced with a
4113 ;; modified self-insert.
4131 ;; Install it as a minor mode.
4135 ;;;###autoload
4137 "The `org-mode' table editor as a minor mode for use in other modes."
4142 ;; Exit without error, in case some hook functions calls this
4143 ;; by accident in org-mode.
4147 ;; Make sure we are first in minor-mode-map-alist
4149 ;; FIXME: maybe it should use emulation-mode-map-alists?
4156 auto-fill-inhibit-regexp)
4160 auto-fill-inhibit-regexp)
4161 orgtbl-line-start-regexp))
4179 "Remove all properties related to narrow-column invisibility."
4192 "Create a function for binding in the table minor mode.
4193 FUN is the command to call inside a table. N is used to create a unique
4194 command name. KEYS are keys that should be checked in for a command
4195 to execute outside of tables."
4201 "Outside of tables, run the binding of `"
4213 keys)
4217 "Error when there is no default binding for a table key."
4222 "Setup orgtbl keymaps."
4253 elt key fun cmd)
4261 ;; Special treatment needed for TAB and RET
4281 [(tab)] "\C-i")))
4283 (org-defkey orgtbl-mode-map [backtab]
4285 [backtab] [S-iso-lefttab] [(shift tab)]
4286 [(tab)] "\C-i"))
4288 (org-defkey orgtbl-mode-map "\M-\C-m"
4289 (orgtbl-make-binding 'org-table-wrap-region 105
4290 "\M-\C-m" [(meta return)]))
4291 (org-defkey orgtbl-mode-map [(meta return)]
4292 (orgtbl-make-binding 'org-table-wrap-region 106
4293 [(meta return)] "\M-\C-m"))
4295 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4296 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4298 (when orgtbl-optimized
4299 ;; If the user wants maximum table support, we need to hijack
4300 ;; some standard editing functions
4301 (org-remap orgtbl-mode-map
4302 'self-insert-command 'orgtbl-self-insert-command
4303 'delete-char 'org-delete-char
4304 'delete-backward-char 'org-delete-backward-char)
4305 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4306 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4307 '("OrgTbl"
4308 ["Create or convert" org-table-create-or-convert-from-region
4309 :active (not (org-at-table-p)) :keys "C-c |" ]
4310 "--"
4311 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4312 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4313 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4314 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4315 "--"
4316 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4317 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4318 ["Copy Field from Above"
4319 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4320 "--"
4321 ("Column"
4322 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4323 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4324 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4325 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4326 ("Row"
4327 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4328 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4329 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4330 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4331 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4332 "--"
4333 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4334 ("Rectangle"
4335 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4336 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4337 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4338 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4339 "--"
4340 ("Radio tables"
4341 ["Insert table template" orgtbl-insert-radio-table
4342 (assq major-mode orgtbl-radio-table-templates)]
4343 ["Comment/uncomment table" orgtbl-toggle-comment t])
4344 "--"
4345 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4346 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4347 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4348 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4349 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4350 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4351 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4352 ["Sum Column/Rectangle" org-table-sum
4353 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4354 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4355 ["Debug Formulas"
4356 org-table-toggle-formula-debugger :active (org-at-table-p)
4357 :keys "C-c {"
4358 :style toggle :selected org-table-formula-debug]
4359 ["Show Col/Row Numbers"
4360 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4361 :keys "C-c }"
4362 :style toggle :selected org-table-overlay-coordinates]
4363 ))
4364 t))
4366 (defun orgtbl-ctrl-c-ctrl-c (arg)
4367 "If the cursor is inside a table, realign the table.
4368 If it is a table to be sent away to a receiver, do it.
4369 With prefix arg, also recompute table."
4370 (interactive "P")
4371 (let ((case-fold-search t) (pos (point)) action)
4372 (save-excursion
4373 (beginning-of-line 1)
4374 (setq action (cond
4378 (cond
4379 ((integerp action)
4380 (goto-char action)
4381 (org-table-maybe-eval-formula)
4382 (if arg
4383 (call-interactively 'org-table-recalculate)
4384 (org-table-maybe-recalculate-line))
4385 (call-interactively 'org-table-align)
4386 (when (orgtbl-send-table 'maybe)
4387 (run-hooks 'orgtbl-after-send-table-hook)))
4388 ((eq action 'recalc)
4389 (org-table-set-constants)
4390 (save-excursion
4391 (beginning-of-line 1)
4393 (if (org-at-table-p)
4394 (org-call-with-arg 'org-table-recalculate t))))
4395 (t (let (orgtbl-mode)
4396 (call-interactively (key-binding "\C-c\C-c")))))))
4398 (defun orgtbl-create-or-convert-from-region (arg)
4399 "Create table or convert region to table, if no conflicting binding.
4400 This installs the table binding `C-c |', but only if there is no
4401 conflicting binding to this key outside orgtbl-mode."
4402 (interactive "P")
4403 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4404 (if cmd
4405 (call-interactively cmd)
4406 (call-interactively 'org-table-create-or-convert-from-region))))
4408 (defun orgtbl-tab (arg)
4409 "Justification and field motion for `orgtbl-mode'."
4410 (interactive "P")
4411 (if arg (org-table-edit-field t)
4412 (org-table-justify-field-maybe)
4413 (org-table-next-field)))
4415 (defun orgtbl-ret ()
4416 "Justification and field motion for `orgtbl-mode'."
4417 (interactive)
4418 (if (bobp)
4419 (newline)
4420 (org-table-justify-field-maybe)
4421 (org-table-next-row)))
4423 (defun orgtbl-self-insert-command (N)
4424 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4425 If the cursor is in a table looking at whitespace, the whitespace is
4426 overwritten, and the table is not marked as requiring realignment."
4427 (interactive "p")
4428 (if (and (org-at-table-p)
4429 (or
4430 (and org-table-auto-blank-field
4431 (member last-command
4432 '(orgtbl-hijacker-command-100
4433 orgtbl-hijacker-command-101
4434 orgtbl-hijacker-command-102
4435 orgtbl-hijacker-command-103
4436 orgtbl-hijacker-command-104
4437 orgtbl-hijacker-command-105
4438 yas/expand))
4439 (org-table-blank-field))
4440 t)
4441 (eq N 1)
4443 (let (org-table-may-need-update)
4444 (goto-char (1- (match-end 0)))
4445 (org-delete-backward-char 1)
4446 (goto-char (match-beginning 0))
4447 (self-insert-command N))
4448 (setq org-table-may-need-update t)
4449 (let* (orgtbl-mode
4450 a
4451 (cmd (or (key-binding
4452 (or (and (listp function-key-map)
4453 (setq a (assoc last-input-event function-key-map))
4454 (cdr a))
4455 (vector last-input-event)))
4456 'self-insert-command)))
4457 (call-interactively cmd)
4458 (if (and org-self-insert-cluster-for-undo
4459 (eq cmd 'self-insert-command))
4460 (if (not (eq last-command 'orgtbl-self-insert-command))
4461 (setq org-self-insert-command-undo-counter 1)
4462 (if (>= org-self-insert-command-undo-counter 20)
4463 (setq org-self-insert-command-undo-counter 1)
4464 (and (> org-self-insert-command-undo-counter 0)
4465 buffer-undo-list
4466 (not (cadr buffer-undo-list)) ; remove nil entry
4467 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4468 (setq org-self-insert-command-undo-counter
4469 (1+ org-self-insert-command-undo-counter))))))))
4472 "Regular expression matching exponentials as produced by calc.")
4474 (defun orgtbl-gather-send-defs ()
4475 "Gather a plist of :name, :transform, :params for each destination before
4476 a radio table."
4477 (save-excursion
4478 (goto-char (org-table-begin))
4479 (let (rtn)
4480 (beginning-of-line 0)
4481 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4482 (let ((name (org-no-properties (match-string 1)))
4483 (transform (intern (match-string 2)))
4484 (params (if (match-end 3)
4485 (read (concat "(" (match-string 3) ")")))))
4486 (push (list :name name :transform transform :params params)
4487 rtn)
4488 (beginning-of-line 0)))
4489 rtn)))
4491 (defun orgtbl-send-replace-tbl (name txt)
4492 "Find and replace table NAME with TXT."
4493 (save-excursion
4494 (goto-char (point-min))
4495 (unless (re-search-forward
4497 (user-error "Don't know where to insert translated table"))
4498 (goto-char (match-beginning 0))
4499 (beginning-of-line 2)
4500 (save-excursion
4501 (let ((beg (point)))
4502 (unless (re-search-forward
4503 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4504 (user-error "Cannot find end of insertion region"))
4505 (beginning-of-line 1)
4506 (delete-region beg (point))))
4509 ;;;###autoload
4510 (defun org-table-to-lisp (&optional txt)
4511 "Convert the table at point to a Lisp structure.
4512 The structure will be a list. Each item is either the symbol `hline'
4513 for a horizontal separator line, or a list of field values as strings.
4514 The table is taken from the parameter TXT, or from the buffer at point."
4515 (unless txt
4516 (unless (org-at-table-p)
4517 (user-error "No table at point")))
4518 (let* ((txt (or txt
4519 (buffer-substring-no-properties (org-table-begin)
4520 (org-table-end))))
4523 (mapcar
4524 (lambda (x)
4525 (if (string-match org-table-hline-regexp x)
4526 'hline
4528 lines)))
4530 (defun orgtbl-send-table (&optional maybe)
4531 "Send a transformed version of this table to the receiver position.
4532 With argument MAYBE, fail quietly if no transformation is defined for
4533 this table."
4534 (interactive)
4535 (catch 'exit
4536 (unless (org-at-table-p) (user-error "Not at a table"))
4537 ;; when non-interactive, we assume align has just happened.
4538 (when (org-called-interactively-p 'any) (org-table-align))
4539 (let ((dests (orgtbl-gather-send-defs))
4540 (txt (buffer-substring-no-properties (org-table-begin)
4541 (org-table-end)))
4542 (ntbl 0))
4543 (unless dests (if maybe (throw 'exit nil)
4544 (user-error "Don't know how to transform this table")))
4545 (dolist (dest dests)
4546 (let* ((name (plist-get dest :name))
4547 (transform (plist-get dest :transform))
4548 (params (plist-get dest :params))
4549 (skip (plist-get params :skip))
4550 (skipcols (plist-get params :skipcols))
4551 (no-escape (plist-get params :no-escape))
4552 beg
4553 (lines (org-table-clean-before-export
4554 (nthcdr (or skip 0)
4556 (i0 (if org-table-clean-did-remove-column 2 1))
4557 (lines (if no-escape lines
4558 (mapcar (lambda(l) (replace-regexp-in-string
4560 (table (mapcar
4561 (lambda (x)
4562 (if (string-match org-table-hline-regexp x)
4563 'hline
4564 (org-remove-by-index
4566 skipcols i0)))
4567 lines))
4568 (fun (if (= i0 2) 'cdr 'identity))
4569 (org-table-last-alignment
4570 (org-remove-by-index (funcall fun org-table-last-alignment)
4571 skipcols i0))
4572 (org-table-last-column-widths
4573 (org-remove-by-index (funcall fun org-table-last-column-widths)
4574 skipcols i0))
4575 (txt (if (fboundp transform)
4576 (funcall transform table params)
4577 (user-error "No such transformation function %s" transform))))
4578 (orgtbl-send-replace-tbl name txt))
4579 (setq ntbl (1+ ntbl)))
4580 (message "Table converted and installed at %d receiver location%s"
4581 ntbl (if (> ntbl 1) "s" ""))
4582 (if (> ntbl 0)
4583 ntbl
4584 nil))))
4586 (defun org-remove-by-index (list indices &optional i0)
4587 "Remove the elements in LIST with indices in INDICES.
4588 First element has index 0, or I0 if given."
4589 (if (not indices)
4590 list
4591 (if (integerp indices) (setq indices (list indices)))
4592 (setq i0 (1- (or i0 0)))
4593 (delq :rm (mapcar (lambda (x)
4594 (setq i0 (1+ i0))
4595 (if (memq i0 indices) :rm x))
4596 list))))
4598 (defun orgtbl-toggle-comment ()
4599 "Comment or uncomment the orgtbl at point."
4600 (interactive)
4601 (let* ((case-fold-search t)
4602 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4603 (re2 (concat "^" orgtbl-line-start-regexp))
4604 (commented (save-excursion (beginning-of-line 1)
4605 (cond ((looking-at re1) t)
4606 ((looking-at re2) nil)
4607 (t (user-error "Not at an org table")))))
4608 (re (if commented re1 re2))
4609 beg end)
4610 (save-excursion
4611 (beginning-of-line 1)
4612 (while (looking-at re) (beginning-of-line 0))
4613 (beginning-of-line 2)
4614 (setq beg (point))
4615 (while (looking-at re) (beginning-of-line 2))
4616 (setq end (point)))
4617 (comment-region beg end (if commented '(4) nil))))
4619 (defun orgtbl-insert-radio-table ()
4620 "Insert a radio table template appropriate for this major mode."
4621 (interactive)
4622 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4623 (txt (nth 1 e))
4624 name pos)
4625 (unless e (user-error "No radio table setup defined for %s" major-mode))
4626 (setq name (read-string "Table name: "))
4627 (while (string-match "%n" txt)
4628 (setq txt (replace-match name t t txt)))
4630 (setq pos (point))
4631 (insert txt)
4632 (goto-char pos)))
4634 ;; Dynamically bound input and output for table formatting.
4635 (defvar *orgtbl-table* nil
4636 "Carries the current table through formatting routines.")
4637 (defvar *orgtbl-rtn* nil
4638 "Formatting routines push the output lines here.")
4639 ;; Formatting parameters for the current table section.
4640 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4641 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4642 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4643 (defvar *orgtbl-fmt* nil "Format for each entry.")
4644 (defvar *orgtbl-efmt* nil "Format for numbers.")
4645 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4646 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4647 (defvar *orgtbl-lstart* nil "Text starting a row.")
4648 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4649 (defvar *orgtbl-lend* nil "Text ending a row.")
4650 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4652 (defsubst orgtbl-get-fmt (fmt i)
4653 "Retrieve the format from FMT corresponding to the Ith column."
4654 (if (and (not (functionp fmt)) (consp fmt))
4655 (plist-get fmt i)
4656 fmt))
4658 (defsubst orgtbl-apply-fmt (fmt &rest args)
4659 "Apply format FMT to arguments ARGS.
4660 When FMT is nil, return the first argument from ARGS."
4661 (cond ((functionp fmt) (apply fmt args))
4662 (fmt (apply 'format fmt args))
4663 (args (car args))
4664 (t args)))
4666 (defsubst orgtbl-eval-str (str)
4667 "If STR is a function, evaluate it with no arguments."
4668 (if (functionp str)
4669 (funcall str)
4670 str))
4672 (defun orgtbl-format-line (line)
4673 "Format LINE as a table row."
4674 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4675 (let* ((i 0)
4676 (line
4677 (mapcar
4678 (lambda (f)
4679 (setq i (1+ i))
4680 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4681 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4682 (orgtbl-apply-fmt efmt (match-string 1 f)
4683 (match-string 2 f))
4684 f)))
4685 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4686 *orgtbl-default-fmt*)
4687 f)))
4688 line)))
4689 (push (if *orgtbl-lfmt*
4690 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4691 (concat (orgtbl-eval-str *orgtbl-lstart*)
4692 (mapconcat 'identity line *orgtbl-sep*)
4693 (orgtbl-eval-str *orgtbl-lend*)))
4694 *orgtbl-rtn*))))
4696 (defun orgtbl-format-section (section-stopper)
4697 "Format lines until the first occurrence of SECTION-STOPPER."
4698 (let (prevline)
4699 (progn
4700 (while (not (eq (car *orgtbl-table*) section-stopper))
4701 (if prevline (orgtbl-format-line prevline))
4702 (setq prevline (pop *orgtbl-table*)))
4703 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4704 (*orgtbl-lend* *orgtbl-llend*)
4705 (*orgtbl-lfmt* *orgtbl-llfmt*))
4706 (orgtbl-format-line prevline))))))
4708 ;;;###autoload
4709 (defun orgtbl-to-generic (table params &optional backend)
4710 "Convert the orgtbl-mode TABLE to some other format.
4711 This generic routine can be used for many standard cases.
4712 TABLE is a list, each entry either the symbol `hline' for a horizontal
4713 separator line, or a list of fields for that line.
4714 PARAMS is a property list of parameters that can influence the conversion.
4715 A third optional argument BACKEND can be used to convert the content of
4716 the cells using a specific export back-end.
4718 For the generic converter, some parameters are obligatory: you need to
4719 specify either :lfmt, or all of (:lstart :lend :sep).
4721 Valid parameters are:
4723 :splice When set to t, return only table body lines, don't wrap
4724 them into :tstart and :tend. Default is nil. When :splice
4725 is non-nil, this also means that the exporter should not look
4726 for and interpret header and footer sections.
4728 :hline String to be inserted on horizontal separation lines.
4729 May be nil to ignore hlines.
4731 :sep Separator between two fields
4732 :remove-nil-lines Do not include lines that evaluate to nil.
4734 Each in the following group may be either a string or a function
4735 of no arguments returning a string:
4737 :tstart String to start the table. Ignored when :splice is t.
4738 :tend String to end the table. Ignored when :splice is t.
4739 :lstart String to start a new table line.
4740 :llstart String to start the last table line, defaults to :lstart.
4741 :lend String to end a table line
4742 :llend String to end the last table line, defaults to :lend.
4744 Each in the following group may be a string, a function of one
4745 argument (the field or line) returning a string, or a plist
4746 mapping columns to either of the above:
4748 :lfmt Format for entire line, with enough %s to capture all fields.
4749 If this is present, :lstart, :lend, and :sep are ignored.
4750 :llfmt Format for the entire last line, defaults to :lfmt.
4751 :fmt A format to be used to wrap the field, should contain
4752 %s for the original field value. For example, to wrap
4754 This may also be a property list with column numbers and
4756 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4757 Same as above, specific for the header lines in the table.
4758 All lines before the first hline are treated as header.
4759 If any of these is not present, the data line value is used.
4761 This may be either a string or a function of two arguments:
4763 :efmt Use this format to print numbers with exponentials.
4764 The format should have %s twice for inserting mantissa
4766 may also be a property list with column numbers and
4767 formats. :fmt will still be applied after :efmt.
4769 In addition to this, the parameters :skip and :skipcols are always handled
4770 directly by `orgtbl-send-table'. See manual."
4771 (let* ((splicep (plist-get params :splice))
4772 (hline (plist-get params :hline))
4773 (skipheadrule (plist-get params :skipheadrule))
4774 (remove-nil-linesp (plist-get params :remove-nil-lines))
4775 (remove-newlines (plist-get params :remove-newlines))
4776 (*orgtbl-hline* hline)
4777 (*orgtbl-table* table)
4778 (*orgtbl-sep* (plist-get params :sep))
4779 (*orgtbl-efmt* (plist-get params :efmt))
4780 (*orgtbl-lstart* (plist-get params :lstart))
4781 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4782 (*orgtbl-lend* (plist-get params :lend))
4783 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4784 (*orgtbl-lfmt* (plist-get params :lfmt))
4785 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4786 (*orgtbl-fmt* (plist-get params :fmt))
4787 *orgtbl-rtn*)
4788 ;; Convert cells content to backend BACKEND
4789 (when backend
4790 (setq *orgtbl-table*
4791 (mapcar
4792 (lambda(r)
4793 (if (listp r)
4794 (mapcar
4795 (lambda (c)
4796 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4797 r)
4798 r))
4799 *orgtbl-table*)))
4800 ;; Put header
4801 (unless splicep
4802 (when (plist-member params :tstart)
4803 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4804 (if tstart (push tstart *orgtbl-rtn*)))))
4805 ;; If we have a heading, format it and handle the trailing hline.
4806 (if (and (not splicep)
4807 (or (consp (car *orgtbl-table*))
4808 (consp (nth 1 *orgtbl-table*)))
4809 (memq 'hline (cdr *orgtbl-table*)))
4810 (progn
4811 (when (eq 'hline (car *orgtbl-table*))
4812 ;; There is a hline before the first data line
4813 (and hline (push hline *orgtbl-rtn*))
4814 (pop *orgtbl-table*))
4815 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4816 *orgtbl-lstart*))
4817 (*orgtbl-llstart* (or (plist-get params :hllstart)
4818 *orgtbl-llstart*))
4819 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4820 (*orgtbl-llend* (or (plist-get params :hllend)
4821 (plist-get params :hlend) *orgtbl-llend*))
4822 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4823 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4824 (plist-get params :hlfmt) *orgtbl-llfmt*))
4825 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4826 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4827 (orgtbl-format-section 'hline))
4828 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4829 (pop *orgtbl-table*)))
4830 ;; Now format the main section.
4831 (orgtbl-format-section nil)
4832 (unless splicep
4833 (when (plist-member params :tend)
4834 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4835 (if tend (push tend *orgtbl-rtn*)))))
4836 (mapconcat (if remove-newlines
4837 (lambda (tend)
4839 'identity)
4840 (nreverse (if remove-nil-linesp
4841 (remq nil *orgtbl-rtn*)
4844 ;;;###autoload
4845 (defun orgtbl-to-tsv (table params)
4846 "Convert the orgtbl-mode table to TAB separated material."
4848 ;;;###autoload
4849 (defun orgtbl-to-csv (table params)
4850 "Convert the orgtbl-mode table to CSV material.
4851 This does take care of the proper quoting of fields with comma or quotes."
4852 (orgtbl-to-generic table (org-combine-plists
4853 '(:sep "," :fmt org-quote-csv-field)
4854 params)))
4856 ;;;###autoload
4857 (defun orgtbl-to-latex (table params)
4858 "Convert the orgtbl-mode TABLE to LaTeX.
4859 TABLE is a list, each entry either the symbol `hline' for a horizontal
4860 separator line, or a list of fields for that line.
4861 PARAMS is a property list of parameters that can influence the conversion.
4862 Supports all parameters from `orgtbl-to-generic'. Most important for
4863 LaTeX are:
4865 :splice When set to t, return only table body lines, don't wrap
4866 them into a tabular environment. Default is nil.
4868 :fmt A format to be used to wrap the field, should contain %s for the
4869 original field value. For example, to wrap everything in dollars,
4872 The format may also be a function that formats its one argument.
4874 :efmt Format for transforming numbers with exponentials. The format
4875 should have %s twice for inserting mantissa and exponent, for
4877 This may also be a property list with column numbers and formats.
4878 The format may also be a function that formats its two arguments.
4880 :llend If you find too much space below the last line of a table,
4883 The general parameters :skip and :skipcols have already been applied when
4884 this function is called."
4885 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4886 org-table-last-alignment ""))
4887 (params2
4888 (list
4893 (require 'ox-latex)
4894 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4896 ;;;###autoload
4897 (defun orgtbl-to-html (table params)
4898 "Convert the orgtbl-mode TABLE to HTML.
4899 TABLE is a list, each entry either the symbol `hline' for a horizontal
4900 separator line, or a list of fields for that line.
4901 PARAMS is a property list of parameters that can influence the conversion.
4902 Currently this function recognizes the following parameters:
4904 :splice When set to t, return only table body lines, don't wrap
4905 them into a <table> environment. Default is nil.
4907 The general parameters :skip and :skipcols have already been applied when
4908 this function is called. The function does *not* use `orgtbl-to-generic',
4909 so you cannot specify parameters for it."
4910 (require 'ox-html)
4911 (let ((output (org-export-string-as
4912 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4913 (if (not (plist-get params :splice)) output
4914 (org-trim
4915 (replace-regexp-in-string
4919 ;;;###autoload
4920 (defun orgtbl-to-texinfo (table params)
4921 "Convert the orgtbl-mode TABLE to TeXInfo.
4922 TABLE is a list, each entry either the symbol `hline' for a horizontal
4923 separator line, or a list of fields for that line.
4924 PARAMS is a property list of parameters that can influence the conversion.
4925 Supports all parameters from `orgtbl-to-generic'. Most important for
4926 TeXInfo are:
4928 :splice nil/t When set to t, return only table body lines, don't wrap
4929 them into a multitable environment. Default is nil.
4931 :fmt fmt A format to be used to wrap the field, should contain
4932 %s for the original field value. For example, to wrap
4934 This may also be a property list with column numbers and
4936 Each format also may be a function that formats its one
4937 argument.
4940 are computed automatically from the width of the columns
4941 under org-mode.
4943 The general parameters :skip and :skipcols have already been applied when
4944 this function is called."
4945 (let* ((total (float (apply '+ org-table-last-column-widths)))
4946 (colfrac (or (plist-get params :cf)
4947 (mapconcat
4948 (lambda (x) (format "%.3f" (/ (float x) total)))
4949 org-table-last-column-widths " ")))
4950 (params2
4951 (list
4952 :tstart (concat "@multitable @columnfractions " colfrac)
4953 :tend "@end multitable"
4954 :lstart "@item " :lend "" :sep " @tab "
4955 :hlstart "@headitem ")))
4956 (require 'ox-texinfo)
4957 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4959 ;;;###autoload
4960 (defun orgtbl-to-orgtbl (table params)
4961 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4962 Useful when slicing one table into many. The :hline, :sep,
4963 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4964 and :tend suppress strings without splicing; they can be set to
4965 provide ORGTBL directives for the generated table."
4966 (let* ((params2
4967 (list
4968 :remove-newlines t
4969 :tstart nil :tend nil
4970 :hline "|---"
4971 :sep " | "
4972 :lstart "| "
4973 :lend " |"))
4974 (params (org-combine-plists params2 params)))
4975 (with-temp-buffer
4976 (insert (orgtbl-to-generic table params))
4977 (goto-char (point-min))
4978 (while (re-search-forward org-table-hline-regexp nil t)
4979 (org-table-align))
4980 (buffer-substring 1 (buffer-size)))))
4982 (defun orgtbl-to-table.el (table params)
4983 "Convert the orgtbl-mode TABLE into a table.el table."
4984 (with-temp-buffer
4985 (insert (orgtbl-to-orgtbl table params))
4986 (org-table-align)
4987 (replace-regexp-in-string
4988 "-|" "-+"
4989 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4991 (defun orgtbl-to-unicode (table params)
4992 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4993 You need the ascii-art-to-unicode.el package for this. You can download
4994 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4995 (with-temp-buffer
4996 (insert (orgtbl-to-table.el table params))
4997 (goto-char (point-min))
4998 (if (or (featurep 'ascii-art-to-unicode)
4999 (require 'ascii-art-to-unicode nil t))
5000 (aa2u)
5001 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
5002 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
5003 "Link to ascii-art-to-unicode.el") org-stored-links))
5004 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
5005 (buffer-string)))
5007 (defun org-table-get-remote-range (name-or-id form)
5008 "Get a field value or a list of values in a range from table at ID.
5010 NAME-OR-ID may be the name of a table in the current file as set
5012 will then be used. Alternatively, it may be an ID referring to
5013 any entry, also in a different file. In this case, the first
5014 table in that entry will be referenced.
5018 The return value is either a single string for a single field, or a
5019 list of the fields in the rectangle."
5020 (save-match-data
5021 (let ((case-fold-search t) (id-loc nil)
5022 ;; Protect a bunch of variables from being overwritten
5023 ;; by the context of the remote table
5024 org-table-column-names org-table-column-name-regexp
5025 org-table-local-parameters org-table-named-field-locations
5026 org-table-current-line-types org-table-current-begin-line
5027 org-table-current-begin-pos org-table-dlines
5028 org-table-current-ncol
5029 org-table-hlines org-table-last-alignment
5030 org-table-last-column-widths org-table-last-alignment
5031 org-table-last-column-widths tbeg
5032 buffer loc)
5033 (setq form (org-table-convert-refs-to-rc form))
5034 (save-excursion
5035 (save-restriction
5036 (widen)
5037 (save-excursion
5038 (goto-char (point-min))
5039 (if (re-search-forward
5042 nil t)
5043 (setq buffer (current-buffer) loc (match-beginning 0))
5044 (setq id-loc (org-id-find name-or-id 'marker))
5045 (unless (and id-loc (markerp id-loc))
5047 (setq buffer (marker-buffer id-loc)
5048 loc (marker-position id-loc))
5049 (move-marker id-loc nil)))
5050 (with-current-buffer buffer
5051 (save-excursion
5052 (save-restriction
5053 (widen)
5054 (goto-char loc)
5055 (forward-char 1)
5057 (not (match-beginning 1)))
5058 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5059 (setq tbeg (point-at-bol))
5060 (org-table-get-specials)
5061 (setq form (org-table-formula-substitute-names
5062 (org-table-formula-handle-first/last-rc form)))
5063 (if (and (string-match org-table-range-regexp form)
5064 (> (length (match-string 0 form)) 1))
5065 (save-match-data
5066 (org-table-get-range (match-string 0 form) tbeg 1))
5067 form)))))))))
5069 (defun org-table-remote-reference-indirection (form)
5070 "Return formula with table remote references substituted by indirection.
5072 This indirection works only with the format @ROW$COLUMN. The
5074 distinguished from a plain table name or ID."
5075 (let ((start 0))
5076 (while (string-match (concat
5077 ;; Same as in `org-table-eval-formula'.
5079 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5081 ;; Same as in `org-table-eval-formula'.
5083 form
5084 start)
5085 ;; The position of the character as far as possible to the right
5086 ;; that will not be replaced and particularly not be shifted by
5087 ;; `replace-match'.
5088 (setq start (match-beginning 1))
5089 ;; Substitute the remote reference with the value found in the
5090 ;; field.
5091 (setq form
5092 (replace-match
5093 (save-match-data
5094 (org-table-get-range (org-table-formula-handle-first/last-rc
5095 (match-string 1 form))))
5096 t t form 1))))
5097 form)
5099 (defmacro org-define-lookup-function (mode)
5100 (let ((mode-str (symbol-name mode))
5101 (first-p (equal mode 'first))
5102 (all-p (equal mode 'all)))
5103 (let ((plural-str (if all-p "s" "")))
5104 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5105 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5106 If R-LIST is nil, return matching element%s of S-LIST.
5107 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5108 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5109 This function is generated by a call to the macro `org-define-lookup-function'."
5110 mode-str plural-str plural-str plural-str)
5111 (let ,(let ((lvars '((p (or predicate 'equal))
5112 (sl s-list)
5113 (rl (or r-list s-list))
5114 (ret nil))))
5115 (if first-p (add-to-list 'lvars '(match-p nil)))
5116 lvars)
5117 (while ,(if first-p '(and (not match-p) sl) 'sl)
5118 (progn
5119 (if (funcall p val (car sl))
5120 (progn
5121 ,(if first-p '(setq match-p t))
5122 (let ((rval (car rl)))
5123 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5124 (setq sl (cdr sl) rl (cdr rl))))
5125 ret)))))
5127 (org-define-lookup-function first)
5128 (org-define-lookup-function last)
5129 (org-define-lookup-function all)
5131 (provide 'org-table)
5133 ;; Local variables:
5134 ;; generated-autoload-file: "org-loaddefs.el"
5135 ;; End:
5137 ;;; org-table.el ends here