| blob | 33309f61e70924d1756fc3e258e92f8dd76855c6 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2012 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:
51 "Hook for functions attaching to `C-c C-c', if the table is sent.
52 This can be used to add additional functionality after the table is sent
53 to the receiver position, othewise, if table is not sent, the functions
57 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
58 In the optimized version, the table editor takes over all simple keys that
59 normally just insert a character. In tables, the characters are inserted
60 in a way to minimize disturbing the table structure (i.e. in overwrite mode
61 for empty fields). Outside tables, the correct binding of the keys is
62 restored.
64 The default for this option is t if the optimized version is also used in
65 Org-mode. See the variable `org-enable-table-editor' for details. Changing
66 this variable requires a restart of Emacs to become effective."
72 % END RECEIVE ORGTBL %n
74 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
75 | | |
78 @c END RECEIVE ORGTBL %n
79 @ignore
80 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
81 | | |
84 <!-- END RECEIVE ORGTBL %n -->
85 <!--
86 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
87 | | |
89 "Templates for radio tables in different major modes.
90 All occurrences of %n in a template will be replaced with the name of the
91 table, obtained by prompting the user."
98 "Settings for tables in Org-mode."
103 "The default size for newly created tables, Columns x Rows."
109 "Regular expression for recognizing numbers in table columns.
110 If a table column contains mostly numbers, it will be aligned to the
111 right. If not, it will be aligned to the left.
113 The default value of this option is a regular expression which allows
114 anything which looks remotely like a number as used in scientific
115 context. For example, all of the following will be considered a
116 number:
117 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
119 Other options offered by the customize interface are more restrictive."
137 "Fraction of numbers in a column required to make the column align right.
138 In a column all non-white fields are considered. If at least this
139 fraction of fields is matched by `org-table-number-fraction',
140 alignment to the right border applies."
145 "Behavior of tables during editing in Org-mode."
150 "Non-nil means automatically re-align table when pressing TAB or RETURN.
152 removal/insertion."
157 "Non-nil means automatically blank table field when starting to type into it.
158 This only happens when typing immediately after a field motion
159 command (TAB, S-TAB or RET).
160 Only relevant when `org-enable-table-editor' is equal to `optimized'."
165 "Non-nil means automatically exit the follow mode.
166 When nil, the follow mode will stay on and be active in any table
167 the cursor enters. Since the table follow filed mode messes with the
168 window configuration, it is not recommended to set this variable to nil,
169 except maybe locally in a special file that has mostly tables with long
170 fields."
175 "Whether the user should confirm when Org fixes formulas."
182 'safe-local-variable
186 "Non-nil means tab in the last column of a table with jump over a hline.
187 If a horizontal separator line is following the current line,
188 `org-table-next-field' can either create a new row before that line, or jump
189 over the line. When this option is nil, a new line will be created before
190 this line."
195 "Options concerning tables in Org-mode."
200 "Should org-mode work with table references like B3 instead of @3$2?
201 Possible values are:
202 nil never use them
203 from accept as input, do not present for editing
204 t accept as input and present for editing"
219 calc-angle-mode deg
220 calc-prefer-frac nil
221 calc-symbolic-mode nil
223 calc-display-working-message t
224 )
225 "List with Calc mode settings for use in `calc-eval' for table formulas.
226 The list must contain alternating symbols (Calc modes variables and values).
227 Don't remove any of the default settings, just change the values. Org-mode
228 relies on the variables to be present in the list."
233 "Format for the output of calc computations like $1+$2;t.
234 The default value is 'hours, and will output the results as a
235 number of hours. Other allowed values are 'seconds, 'minutes and
236 'days, and the output will be a fraction of seconds, minutes or
237 days."
245 "Format for fields which contain the result of a formula.
247 characters. Beware that modifying the display can prevent the
248 field from being used in another formula."
253 "Non-nil means TAB and RET evaluate a formula in current table field.
254 If the current field starts with an equal sign, it is assumed to be a formula
255 which should be evaluated as described in the manual and in the documentation
256 string of the command `org-table-eval-formula'. This feature requires the
257 Emacs calc package.
258 When this variable is nil, formula calculation is only available through
264 "Non-nil means interpret constants in formulas in tables.
265 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
266 by the value given in `org-table-formula-constants', or by a value obtained
267 from the `constants.el' package."
272 "Alist with constant names and values, for use in table formulas.
273 The car of each element is a name of a constant, without the `$' before it.
274 The cdr is the value as a string. For example, if you'd like to use the
275 speed of light in a formula, you would configure
279 and then use it in an equation like `$1*$c'.
281 Constants can also be defined on a per-file basis using a line like
283 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
290 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
291 Automatically means when TAB or RET or C-c C-c are pressed in the line."
296 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
301 "Non-nil means relative formula references may cross hlines.
302 Here are the allowed values:
304 nil Relative references may not cross hlines. They will reference the
305 field next to the hline instead. Coming from below, the reference
306 will be to the field below the hline. Coming from above, it will be
307 to the field above.
308 t Relative references may cross hlines.
309 error An attempt to cross a hline will throw an error.
311 It is probably good to never set this variable to nil, for the sake of
312 portability of tables."
320 "Options concerning table import and export in Org-mode."
325 "Default export parameters for `org-table-export'.
326 These can be overridden for a specific table by setting the
327 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
328 radio tables for the different export transformations and
329 available parameters."
367 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
368 ;; 1 2 3 4 5
379 "Is this a table line colgroup information?"
383 line)
385 nil
392 "Is this a table line with only alignment/width cookies?"
405 s))))
414 "Use the table.el package to insert a new table.
415 If there is already a table at point, convert between Org-mode tables
416 and table.el tables."
430 "Convert region to table, or create an empty table.
431 If there is an active region, convert it to a table, using the function
432 `org-table-convert-region'. See the documentation of that function
433 to learn how the prefix argument is interpreted to determine the field
434 separator.
435 If there is no such region, create an empty table with `org-table-create'."
442 "Query for a size and insert a table skeleton.
462 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
466 ;; Insert a hline after the first row.
474 "Convert region to a table.
475 The region goes from BEG0 to END0, but these borders will be moved
476 slightly, to make sure a beginning of line in the first line is included.
478 SEPARATOR specifies the field separator in the lines. It can have the
479 following values:
481 '(4) Use the comma as a field separator
482 '(16) Use a TAB as field separator
483 integer When a number, use that many spaces as field separator
484 nil When nil, the command tries to be smart and figure out the
485 separator in the following way:
486 - when each line contains a TAB, assume TAB-separated material
487 - when each line contains a comma, assume CSV material
488 - else, assume one or more SPACE characters as separator."
492 re)
499 ;; Get the right field separator
510 ;; parse the csv stuff
534 "Import FILE as a table.
535 The file is assumed to be tab-separated. Such files can be produced by most
536 spreadsheet and database applications. If no tabs (at least one per line)
537 are found, lines will be split on whitespace into fields."
549 "Export table to a file, with configurable format.
550 Such a file can be imported into a spreadsheet program like Excel.
551 FILE can be the output file name. If not given, it will be taken from
552 a TABLE_EXPORT_FILE property in the current entry or higher up in the
553 hierarchy, or the user will be prompted for a file name.
554 FORMAT can be an export format, of the same kind as it used when
555 `orgtbl-mode' sends a table in a different format. The default format can
556 be found in the variable `org-table-export-default-format', but the function
557 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
558 property, locally or anywhere up in the hierarchy."
570 buf deffmt-readable)
589 "Format: "
594 deffmt-readable)))
607 'hline
610 skipcols i0)))
611 lines))
615 skipcols i0))
618 skipcols i0)))
635 "Marker at the beginning of the table last aligned.
638 "Marker at the end of the table last aligned.
641 "List of flags for flushright alignment, from the last re-alignment.
644 "List of max width of fields in each column.
647 "Non-nil means debug table formulas.
660 "Align the table at point by aligning all vertical bars."
663 ;; Limits of table
666 ;; Current cursor position
672 column
674 rfmt hfmt
682 emptystrings links dates emph raise narrow
683 falign falign1 fmax f1 len c e space)
686 ;; Check if we have links or dates
698 ;; Make sure the link properties are right
700 ;; Make sure the date properties are right
705 ;; Check if we are narrowing any columns
708 org-format-transports-properties-p
713 ;; Get the rows
716 ;; Store the indentation of the first line
719 ;; Mark the hlines by setting the corresponding element to nil
720 ;; At the same time, we remove trailing space.
723 nil
726 l)))
727 lines))
728 ;; Get the data fields by splitting the lines.
733 ;; How many fields in the longest line?
740 ;; A list of empty strings to fill any short rows on output
742 ;; Check for special formatting.
746 ;; Check if there is an explicit width specified
756 ;; Find fields that are wider than fmax, and shorten them
762 'help-echo
763 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
771 xx)))))
772 ;; Get the maximum width for each column
774 lengths)
775 ;; Get the fraction of numbers, to decide about alignment of the column
781 nil
788 ;; Store the alignment of this table, for later editing of single fields
790 org-table-last-column-widths lengths)
792 ;; With invisible characters, `format' does not get the field width right
793 ;; So we need to make these fields wide by hand.
811 ;; Compute the formats needed for output of the table
824 hfmt))
828 ;; Replace the old one
835 ;; Try to move to the old location
843 ))
846 "Find the beginning of the table and return its position.
847 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
851 org-table-border-regexp)
852 nil t))
859 "Find the end of the table and return its position.
860 With argument TABLE-TYPE, go to the end of a table.el-type table."
864 org-table-border-regexp)
865 nil t))
871 "Justify the current field, text to left, number to right.
872 Optional argument NEW may specify text to replace the current field content."
881 ;; This is not the same table, force a full re-align
887 l f n o e)
911 "Go to the next field in the current table, creating new lines as needed.
912 Before doing so, re-align the table if necessary."
917 org-table-may-need-update)
928 org-table-tab-jumps-over-hlines
940 "Go to the previous field in the table.
941 Before doing so, re-align the table if necessary."
946 org-table-may-need-update)
961 "Move to the end of the current table field.
962 If already at or after the end, move to the end of the next table field.
963 With numeric argument N, move N-1 fields forward first."
976 "Move to the beginning of the current table field.
977 If already at or before the beginning, move to the beginning of the
978 previous field.
979 With numeric argument N, move N-1 fields backward first."
993 "Go to the next row (same column) in the current table.
994 Before doing so, re-align the table if necessary."
1002 org-table-may-need-update)
1016 "Copy a field down in the current column.
1017 If the field at the cursor is empty, copy into it the content of
1018 the nearest non-empty field above. With argument N, use the Nth
1019 non-empty field. If the current field is not empty, it is copied
1020 down to the next row, and the cursor is moved with it.
1021 Therefore, repeating this command causes the column to be filled
1022 row-by-row.
1023 If the variable `org-table-copy-increment' is non-nil and the
1024 field is an integer or a timestamp, it will be incremented while
1025 copying. In the case of a timestamp, increment by one day."
1033 txt)
1045 beg t))
1068 "Is point inside a table data field?
1069 I.e. not on a hline or before the first or after the last column?
1070 This actually throws an error, so it aborts the current command."
1076 nil
1078 t))
1084 "Get the field in table line LINE, column COLUMN.
1085 If LINE is larger than the number of data lines in the table, the function
1086 returns nil. However, if COLUMN is too large, we will simply return an
1087 empty string.
1088 If LINE is nil, use the current line.
1089 If column is nil, use the current column."
1096 "Put VALUE into line LINE, column COLUMN.
1097 When ALIGN is set, also realign the table."
1106 "Return the index of the current data line."
1113 cnt))
1116 "Go to the Nth data line in the current table.
1117 Return t when the line exists, nil if it does not exist."
1125 "Blank the current table field or active region."
1142 "Return the value of the field in column N of current row.
1143 N defaults to current field.
1144 If REPLACE is a string, replace field with this value. The return value
1145 is always the old value."
1154 t t))
1156 val)
1160 "Show info about the current field, and highlight any reference at point."
1168 org-table-named-field-locations)))
1188 dline col
1190 dline col ref1
1192 ;; FIXME: formula info not correct if special table line
1202 "Find out which column we are in."
1212 cnt)))
1215 "Find out what table data line we are in.
1216 Only data lines count for this."
1228 cnt)))
1231 "Move the cursor to the Nth column in the current table line.
1232 With optional argument ON-DELIM, stop with point before the left delimiter
1233 of the field.
1234 If there are less than N fields, just go to after the last delimiter.
1235 However, when FORCE is non-nil, create new columns if necessary."
1245 t)))))
1253 "Insert a new column into the table."
1261 ;; Current cursor position
1267 nil
1281 "Find a data line in the current table, which is needed for column commands."
1284 t
1295 t
1300 "Turn a buffer line number into a data line number.
1301 If there is no data line in this line, return nil.
1302 If there is no matchin dline (most likely te refrence was a hline), the
1303 first dline below it is used. When ABOVE is non-nil, the one above is used."
1306 i)
1319 nil))
1322 "Delete a column from the table."
1331 ;; Current cursor position
1337 nil
1354 "Move column to the right."
1358 "Move column to the left."
1363 "Move the current column to the right. With arg LEFT, move to the left."
1373 ;; Current cursor position
1383 nil
1402 "Move table row down."
1406 "Move table row up."
1411 "Move the current table line down. With arg UP, move it up."
1420 txt hline2p)
1444 "Insert a new row above the current line into the table.
1445 With prefix ARG, insert below the current line."
1451 ;; Fix the first field if necessary
1465 "Insert a horizontal-line below the current line into the table.
1466 With prefix ABOVE, insert above the current line."
1488 "Insert a hline and move to the row below that line."
1502 In particular, this does handle wide and invisible characters."
1504 ;; It's a hline, just map the characters
1510 t t s)))
1511 s))
1514 "Delete the current row or horizontal line from the table."
1529 "Sort table lines according to the column at point.
1531 The position of point indicates the column to be used for
1532 sorting, and the range of lines is the range between the nearest
1533 horizontal separator lines, or the entire table of no such lines
1534 exist. If point is before the first column, you will be prompted
1535 for the sorting column. If there is an active region, the mark
1536 specifies the first line and the sorting column, while point
1537 should be in the last line to be included into the sorting.
1539 The command then prompts for the sorting type which can be
1540 alphabetically, numerically, or by time (as given in a time stamp
1541 in the field). Sorting in reverse order is also possible.
1543 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1545 If SORTING-TYPE is specified when this function is called from a Lisp
1546 program, no prompting will take place. SORTING-TYPE must be a character,
1547 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1548 should be done in reverse order."
1552 beg end bcol ecol tend tbeg column lns pos)
1597 x))
1610 "Copy region in table to the clipboard and blank all relevant fields.
1611 If there is no active region, use just the field at point."
1618 "Copy rectangular region in table to clipboard.
1619 A special clipboard is used which can only be accessed
1620 with `org-table-paste-rectangle'."
1624 current-prefix-arg))
1626 region cols
1652 org-table-clip))
1655 "Paste a rectangular region into a table.
1656 The upper right corner ends up in the current field. All involved fields
1657 will be overwritten. If the rectangle does not fit into the present table,
1658 the table is enlarged as needed. The process ignores horizontal separator
1659 lines."
1669 c cols field)
1685 "Convert from `org-mode' table to table.el and back.
1686 Obviously, this only works within limits. When an Org-mode table is
1687 converted to table.el, all horizontal separator lines get lost, because
1688 table.el uses these as cell boundaries and has no notion of horizontal lines.
1689 A table.el table can be converted to an Org-mode table only if it does not
1690 do row or column spanning. Multiline cells will become multiple cells.
1691 Beware, Org-mode does not test if the table can be successfully converted - it
1692 blindly applies a recipe that works for simple tables."
1696 ;; convert to Org-mode table
1705 ;; convert to table.el table
1708 ;; first, get rid of all horizontal lines
1712 ;; insert a hline before first
1716 ;; insert a hline after each line
1721 ;; replace "+" at beginning and ending of hlines
1730 "Transpose orgmode table at point and eliminate hlines.
1731 So a table like
1733 | 1 | 2 | 4 | 5 |
1734 |---+---+---+---|
1735 | a | b | c | d |
1736 | e | f | g | h |
1738 will be transposed as
1740 | 1 | a | e |
1741 | 2 | b | f |
1742 | 4 | c | g |
1743 | 5 | d | h |
1745 Note that horizontal lines disappeared."
1749 ;; remove 'hline from list
1758 "Wrap several fields in a column like a paragraph.
1759 This is useful if you'd like to spread the contents of a field over several
1760 lines, in order to keep the table compact.
1762 If there is an active region, and both point and mark are in the same column,
1763 the text in the column is wrapped to minimum width for the given number of
1764 lines. Generally, this makes the table more compact. A prefix ARG may be
1766 formats the selected text to two lines. If the region was longer than two
1767 lines, the remaining lines remain empty. A negative prefix argument reduces
1768 the current number of lines by that amount. The wrapped text is pasted back
1769 into the table. If you formatted it to more lines than it was before, fields
1770 further down in the table get overwritten - so you might need to make space in
1771 the table first.
1773 If there is no region, the current field is split at the cursor position and
1774 the text fragment to the right of the cursor is prepended to the field one
1775 line down.
1777 If there is no region, but you specify a prefix ARG, the current field gets
1778 blank, and the content is appended to the field above."
1782 ;; There is a region: fill as a paragraph
1786 nlines)
1793 arg)
1797 nil nlines)))
1801 ;; No region, split the current field at point
1805 ;; combine with field above
1815 ;; split field
1828 "Edit table field in a different window.
1829 This is mainly useful for fields that contain hidden parts.
1831 it can be edited in place."
1840 display t intangible t))
1853 p)
1869 intangible t))
1877 "Finish editing a table data field.
1878 Remove all newline characters, insert the result into the table, realign
1879 the table and kill the editing buffer."
1883 text)
1900 "Minor mode to make the table field editor window follow the cursor.
1901 When this mode is active, the field editor window will always show the
1902 current field. The mode exits automatically when the cursor leaves the
1903 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1904 nil " TblFollow" nil
1920 ;; We have left the table, exit the follow mode
1931 "Sum numbers in region of current table column.
1932 The result will be displayed in the echo area, and will be available
1935 If there is an active region, it is interpreted as a rectangle and all
1936 numbers in that rectangle will be summed. If there is no active
1937 region and point is located in a table column, sum all numbers in that
1938 column.
1940 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1941 numbers are assumed to be times as well (in decimal hours) and the
1942 numbers are added as such.
1944 If NLAST is a number, only the NLAST fields will actually be summed."
1971 items1)))
1978 s diff)
1986 sres))))
2009 "Return the formula active for the current field.
2010 Assumes that specials are in place.
2011 If KEY is given, return the key to this formula.
2015 org-table-named-field-locations)))
2029 "Read a formula from the minibuffer, offer stored formula as default.
2030 When NAMED is non-nil, look for a named equation."
2034 org-table-named-field-locations)))
2041 name
2042 ref)
2052 stored)
2054 equation)
2061 scol))
2063 'org-table-formula-history
2064 )))))
2065 mustsave)
2067 ;; remove formula
2074 ;; We set the column equation, delete the named one.
2076 mustsave t))
2082 eq))
2085 "Store the list of formulas below the current table."
2091 ;; don't overwrite TBLFM, we might use text properties to store stuff
2107 ;; Fake a high number to make sure this is sorted at the end.
2114 a)
2124 "Compare two formulas for sorting."
2130 "Return an alist with the stored formulas directly after current table."
2139 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2158 "Modify the equations after the table structure has been edited.
2160 For all numbers larger than LIMIT, shift them by DELTA."
2171 s n a)
2187 t t)))))))))
2190 "Get the column names and local parameters for this table."
2193 names name fields fields1 field cnt
2194 c v l line col types dlines hlines last-dline)
2196 org-table-local-parameters nil
2197 org-table-named-field-locations nil
2198 org-table-current-begin-line nil
2199 org-table-current-begin-pos nil
2200 org-table-current-line-types nil
2219 org-table-local-parameters))))
2235 ;; Analyse the line types
2239 l org-table-current-begin-line)
2256 al al2)
2268 If yes, store the formula and apply it."
2269 ;; We already know we are in a table. Get field will only return a formula
2270 ;; when appropriate. It might return a separator line, but no problem.
2273 named eq)
2284 "List of commands triggering the recalculation of a line.
2297 "Rotate the recalculation mark in the first column.
2298 If in any row, the first field is not consistent with a mark,
2299 insert a new column for the markers.
2300 When there is an active region, change all the lines in the region,
2301 after prompting for the marking character.
2302 After each change, a message will be displayed indicating the meaning
2303 of the new mark."
2318 epos new)
2325 newchar))
2358 "Recompute the current line if marked for it, and if we haven't just done it."
2378 modes)
2381 suppress-align suppress-const
2382 suppress-store suppress-analysis)
2383 "Replace the table field value at the cursor by the result of a calculation.
2385 This function makes use of Dave Gillespie's Calc package, in my view the
2386 most exciting program ever written for GNU Emacs. So you need to have Calc
2387 installed in order to use this function.
2389 In a table, this command replaces the value in the current field with the
2391 formula, by storing it in a special line below the table. When called
2392 with a `C-u' prefix, the current field must be a named field, and the
2393 formula is installed as valid in only this specific field.
2395 When called with two `C-u' prefixes, insert the active equation
2396 for the field back into the current field, so that it can be
2398 to check the referenced fields.
2400 When called, the command first prompts for a formula, which is read in
2401 the minibuffer. Previously entered formulas are available through the
2402 history list, and the last used formula is offered as a default.
2403 These stored formulas are adapted correctly when moving, inserting, or
2404 deleting columns with the corresponding commands.
2406 The formula can be any algebraic expression understood by the Calc package.
2407 For details, see the Org-mode manual.
2409 This function can also be called from Lisp programs and offers
2410 additional arguments: EQUATION can be the formula to apply. If this
2411 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2412 used to speed-up recursive calls by by-passing unnecessary aligns.
2413 SUPPRESS-CONST suppresses the interpretation of constants in the
2414 formula, assuming that this has been done already outside the function.
2415 SUPPRESS-STORE means the formula should not be stored, either because
2416 it is already stored, or because it is a modified equation that should
2417 not overwrite the stored one."
2433 equation
2439 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2440 duration duration-output-format)
2441 ;; Parse the format string. Since we have a lot of modes, this is
2442 ;; a lot of work. However, I think calc still uses most of the time.
2454 'calc-float-format
2457 n))))
2461 duration-output-format nil
2465 duration-output-format org-table-duration-custom-format
2466 numbers t
2490 ;; replace fields with duration values if relevant
2494 fields)))
2498 fields)))
2504 ;; Insert row and column number of formula result field
2515 t t form)))
2517 ;; Check for old vertical references
2519 ;; Insert remote references
2527 keep-empty numbers lispp))
2528 t t form)))
2529 ;; Insert complex ranges
2537 ;; possibly handle durations
2542 formrg)
2543 keep-empty numbers lispp)))
2548 ;; Insert simple ranges
2557 keep-empty numbers lispp))
2558 t t form)))
2560 ;; Insert the references to fields in same row
2570 t t form)))
2590 Orig: %s
2591 $xyz-> %s
2592 @r$c-> %s
2624 prop value)))
2627 "Get a calc vector from a column, according to descriptor DESC.
2628 Optional arguments TBEG and COL can give the beginning of the table and
2629 the current column, to avoid unnecessary parsing.
2631 HIGHLIGHT means just highlight the range.
2633 When CORNERS-ONLY is set, only return the corners of the range as
2634 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2635 in the buffer and column1 and column2 are table column numbers."
2642 beg end c1 c2 r1 r2 rangep tmp)
2659 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2666 ;; just one field
2673 ;; A range, return a vector
2674 ;; First sort the numbers to get a regular ractangle
2678 ;; Only return the corners of the range
2680 ;; Copy the range values into a list
2694 ;; return string representation of calc vector
2699 "Analyze descriptor DESC and retrieve the corresponding line number.
2700 The cursor is currently in line CLINE, the table begins in line BLINE,
2701 and TABLE is a vector with line types."
2709 ;; 1 2 3 4 5 6
2729 nil hn cline desc)))
2732 rel on cline desc)))
2736 "FIXME: Needs more documentation."
2749 nil))
2750 t)))
2754 desc cline)
2755 i)))
2760 s))
2763 "Convert list ELEMENTS to something appropriate to insert into formula.
2764 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2765 NUMBERS indicates that everything should be converted to numbers.
2766 LISPP means to return something appropriate for a Lisp list."
2770 elements
2779 elements))))
2785 x
2791 elements
2795 "Recalculate the current table line by applying all stored formulas.
2796 With prefix arg ALL, do this for all lines in the table.
2797 With the prefix argument ALL is `(16)' \
2799 it is the symbol `iterate', recompute the table until it no longer changes.
2800 If NOALIGN is not nil, do not re-align the table after the computations
2801 are done. This is typically used internally to save time, if it is
2802 known that the table will be realigned a little later anyway."
2817 seen-fields lhs1
2819 ;; Insert constants in all formulas
2835 eqlist))
2836 ;; Split the equation list
2842 ;; Expand ranges in lhs of formulas
2845 ;; Get the correct line range to process
2851 ;; This is a table with marked lines, compute selected lines
2853 ;; Move forward to the first non-header line
2864 ;; First find the named fields, and mark them untouchable.
2865 ;; Also check if several field/range formulas try to set the same field.
2884 name)))
2894 ;; Now evaluate the column formulas, but skip fields covered by
2895 ;; field formulas
2899 ;; Unprotected line, recalculate
2911 ;; Now evaluate the field formulas
2925 ;; back to initial position
2933 "Recalculate the table until it does not change anymore.
2934 The maximun number of iterations is 10, but you can chose a different value
2935 with the prefix ARG."
2940 thistbl)
2955 "Recalculate all tables in the current buffer."
2963 "Iterate all tables in the buffer, to converge inter-table dependencies."
2968 c1
2985 "Expand list of formulas.
2986 If some of the RHS in the formulas are ranges or a row reference, expand
2987 them to individual field equations for each field."
2993 ;; This just refers to one fixed field
2996 ;; This just refers to one fixed named field
3018 "Replace @<, @>, $<, $> with first/last row/column of the table.
3019 So @< and $< will always be replaced with @1 and $1, respectively.
3020 The advantage of these special markers are that structure editing of
3021 the table will not change them, while @1 and $1 will be modified
3022 when a line/row is swapped out of that privileged position. So for
3023 formulas that use a range of rows or columns, it may often be better
3025 borders of the table using the @< @> $< $> makers."
3028 s start)
3033 org-table-current-ncol)
3037 len
3044 s)
3047 "Replace $const with values in string F."
3049 ;; First, check for column names
3054 ;; Parameters and constants
3056 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3066 f))
3069 "Find the value for a parameter or constant in a formula.
3070 Parameters get priority."
3101 map))
3108 "--"
3111 "--"
3112 "Shift Reference at Point"
3117 "-"
3118 "Change Test Row for Column Formulas"
3121 "--"
3126 org-table-overlay-coordinates)]
3127 "--"
3134 "Edit the formulas of the current table in a separate buffer."
3150 entry s type title)
3153 ;; Keep global-font-lock-mode from turning on font-lock-mode
3194 "Convert a formula from internal to user representation."
3197 s))
3200 "Convert a formula from user to internal representation."
3203 s))
3206 "Convert spreadsheet references from A7 to @7$28.
3207 Works for single references, but also for entire formulas and even the
3208 full TBLFM line."
3210 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3213 ;; format match, just advance
3218 ;; 3.e5 or something like this.
3221 ;; (member (match-string 1 s)
3222 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3223 )
3224 ;; function name, just advance
3234 t t s)))))
3235 s))
3238 "Convert spreadsheet references from to @7$28 to AB7.
3239 Works for single references, but also for entire formulas and even the
3240 full TBLFM line."
3247 t t s)))
3252 t nil s)))
3253 s)
3256 "Convert a base 26 number represented by letters into an integer.
3257 For example: AB -> 28."
3263 n))
3266 "Convert an integer into a base 26 number represented by letters.
3267 For example: 28 -> AB."
3272 s))
3275 "Convert a time string into numerical duration in seconds.
3276 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3277 If S is a string representing a number, keep this number."
3300 "Convert a number of seconds to a time string.
3301 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3302 minutes or seconds."
3314 "Convert all references in this buffer, using FUNCTION."
3324 "Convert all references in the buffer from B3 to @3$2 and back."
3334 "Shift the reference at point one row/hline up."
3338 "Shift the reference at point one row/hline down."
3342 "Shift the reference at point one field to the left."
3346 "Shift the reference at point one field to the right."
3357 ;; A B3-like reference
3363 ;; An internal reference
3369 "Re-match the group N, and replace it with the shifted reference."
3374 t t)))
3377 "Shift a reference part REF.
3378 If DECR is set, decrease the references row/column, else increase.
3379 If HLINE is set, this may be a hline reference, it certainly is not
3380 a translation reference."
3409 "Toggle the display of coordinates in the referenced table."
3418 "Parse the buffer for formula definitions and install them.
3419 With prefix ARG, apply the new formulas to the table."
3429 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3430 nil t)
3454 "Abort editing formulas, without installing the changes."
3465 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3506 "Show the location/value of the $ expression at point."
3515 var name e what match dest)
3520 "$1.."
3603 ;; column number
3631 org-table-fedit-scroll-down))))
3642 "Make sure the cursor is in a dataline in a table."
3651 p1 p2)))
3656 "Move cursor one line up in the window showing the table."
3661 "Move cursor one line down in the window showing the table."
3666 "Move the cursor in the window showing the table.
3667 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3692 "Add a new overlay."
3698 "Highlight rectangular region in a table."
3702 l1 c1 l2 c2 tmp)
3726 "Remove the rectangle overlays."
3737 "Add overlays to the table at point, to show row/column coordinates."
3766 "Toggle the display of Row/Column numbers in tables."
3778 "Toggle the formula debugger in tables."
3784 ;;; The orgtbl minor mode
3786 ;; Define a minor mode which can be used in other modes in order to
3787 ;; integrate the org-mode table editor.
3789 ;; This is really a hack, because the org-mode table editor uses several
3790 ;; keys which normally belong to the major mode, for example the TAB and
3791 ;; RET keys. Here is how it works: The minor mode defines all the keys
3792 ;; necessary to operate the table editor, but wraps the commands into a
3793 ;; function which tests if the cursor is currently inside a table. If that
3794 ;; is the case, the table editor command is executed. However, when any of
3795 ;; those keys is used outside a table, the function uses `key-binding' to
3796 ;; look up if the key has an associated command in another currently active
3797 ;; keymap (minor modes, major mode, global), and executes that command.
3798 ;; There might be problems if any of the keys used by the table editor is
3799 ;; otherwise used as a prefix key.
3801 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3802 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3803 ;; addresses this by checking explicitly for both bindings.
3805 ;; The optimized version (see variable `orgtbl-optimized') takes over
3806 ;; all keys which are bound to `self-insert-command' in the *global map*.
3807 ;; Some modes bind other commands to simple characters, for example
3808 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3809 ;; active, this binding is ignored inside tables and replaced with a
3810 ;; modified self-insert.
3816 ;;;###autoload
3818 "Unconditionally turn on `orgtbl-mode'."
3833 ;; Install it as a minor mode.
3837 ;;;###autoload
3839 "The `org-mode' table editor as a minor mode for use in other modes."
3844 ;; Exit without error, in case some hook functions calls this
3845 ;; by accident in org-mode.
3849 ;; Make sure we are first in minor-mode-map-alist
3851 ;; FIXME: maybe it should use emulation-mode-map-alists?
3858 auto-fill-inhibit-regexp)
3862 auto-fill-inhibit-regexp)
3863 orgtbl-line-start-regexp))
3881 "Remove all properties related to narrow-column invisibility."
3894 "Create a function for binding in the table minor mode.
3895 FUN is the command to call inside a table. N is used to create a unique
3896 command name. KEYS are keys that should be checked in for a command
3897 to execute outside of tables."
3903 "Outside of tables, run the binding of `"
3915 keys)
3919 "Error when there is no default binding for a table key."
3924 "Setup orgtbl keymaps."
3955 elt key fun cmd)
3963 ;; Special treatment needed for TAB and RET
3983 [(tab)] "\C-i")))
3985 (org-defkey orgtbl-mode-map [backtab]
3987 [backtab] [S-iso-lefttab] [(shift tab)]
3988 [(tab)] "\C-i"))
3990 (org-defkey orgtbl-mode-map "\M-\C-m"
3991 (orgtbl-make-binding 'org-table-wrap-region 105
3992 "\M-\C-m" [(meta return)]))
3993 (org-defkey orgtbl-mode-map [(meta return)]
3994 (orgtbl-make-binding 'org-table-wrap-region 106
3995 [(meta return)] "\M-\C-m"))
3997 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3998 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4000 (when orgtbl-optimized
4001 ;; If the user wants maximum table support, we need to hijack
4002 ;; some standard editing functions
4003 (org-remap orgtbl-mode-map
4004 'self-insert-command 'orgtbl-self-insert-command
4005 'delete-char 'org-delete-char
4006 'delete-backward-char 'org-delete-backward-char)
4007 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4008 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4009 '("OrgTbl"
4010 ["Create or convert" org-table-create-or-convert-from-region
4011 :active (not (org-at-table-p)) :keys "C-c |" ]
4012 "--"
4013 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4014 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4015 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4016 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4017 "--"
4018 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4019 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4020 ["Copy Field from Above"
4021 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4022 "--"
4023 ("Column"
4024 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4025 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4026 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4027 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4028 ("Row"
4029 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4030 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4031 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4032 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4033 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4034 "--"
4035 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4036 ("Rectangle"
4037 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4038 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4039 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4040 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4041 "--"
4042 ("Radio tables"
4043 ["Insert table template" orgtbl-insert-radio-table
4044 (assq major-mode orgtbl-radio-table-templates)]
4045 ["Comment/uncomment table" orgtbl-toggle-comment t])
4046 "--"
4047 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4048 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4049 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4050 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4051 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4052 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4053 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4054 ["Sum Column/Rectangle" org-table-sum
4055 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4056 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4057 ["Debug Formulas"
4058 org-table-toggle-formula-debugger :active (org-at-table-p)
4059 :keys "C-c {"
4060 :style toggle :selected org-table-formula-debug]
4061 ["Show Col/Row Numbers"
4062 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4063 :keys "C-c }"
4064 :style toggle :selected org-table-overlay-coordinates]
4065 ))
4066 t))
4068 (defun orgtbl-ctrl-c-ctrl-c (arg)
4069 "If the cursor is inside a table, realign the table.
4070 If it is a table to be sent away to a receiver, do it.
4071 With prefix arg, also recompute table."
4072 (interactive "P")
4073 (let ((pos (point)) action consts-str consts cst const-str)
4074 (save-excursion
4075 (beginning-of-line 1)
4076 (setq action (cond
4080 (cond
4081 ((integerp action)
4082 (goto-char action)
4083 (org-table-maybe-eval-formula)
4084 (if arg
4085 (call-interactively 'org-table-recalculate)
4086 (org-table-maybe-recalculate-line))
4087 (call-interactively 'org-table-align)
4088 (when (orgtbl-send-table 'maybe)
4089 (run-hooks 'orgtbl-after-send-table-hook)))
4090 ((eq action 'recalc)
4091 (save-excursion
4092 (goto-char (point-min))
4094 (setq const-str (substring-no-properties (match-string 1)))
4096 (when consts
4097 (let (e)
4098 (while (setq e (pop consts))
4100 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4101 (setq org-table-formula-constants-local cst)))))
4102 (save-excursion
4103 (beginning-of-line 1)
4105 (if (org-at-table-p)
4106 (org-call-with-arg 'org-table-recalculate t))))
4107 (t (let (orgtbl-mode)
4108 (call-interactively (key-binding "\C-c\C-c")))))))
4110 (defun orgtbl-create-or-convert-from-region (arg)
4111 "Create table or convert region to table, if no conflicting binding.
4112 This installs the table binding `C-c |', but only if there is no
4113 conflicting binding to this key outside orgtbl-mode."
4114 (interactive "P")
4115 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4116 (if cmd
4117 (call-interactively cmd)
4118 (call-interactively 'org-table-create-or-convert-from-region))))
4120 (defun orgtbl-tab (arg)
4121 "Justification and field motion for `orgtbl-mode'."
4122 (interactive "P")
4123 (if arg (org-table-edit-field t)
4124 (org-table-justify-field-maybe)
4125 (org-table-next-field)))
4127 (defun orgtbl-ret ()
4128 "Justification and field motion for `orgtbl-mode'."
4129 (interactive)
4130 (if (bobp)
4131 (newline)
4132 (org-table-justify-field-maybe)
4133 (org-table-next-row)))
4135 (defun orgtbl-self-insert-command (N)
4136 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4137 If the cursor is in a table looking at whitespace, the whitespace is
4138 overwritten, and the table is not marked as requiring realignment."
4139 (interactive "p")
4140 (if (and (org-at-table-p)
4141 (or
4142 (and org-table-auto-blank-field
4143 (member last-command
4144 '(orgtbl-hijacker-command-100
4145 orgtbl-hijacker-command-101
4146 orgtbl-hijacker-command-102
4147 orgtbl-hijacker-command-103
4148 orgtbl-hijacker-command-104
4149 orgtbl-hijacker-command-105
4150 yas/expand))
4151 (org-table-blank-field))
4152 t)
4153 (eq N 1)
4155 (let (org-table-may-need-update)
4156 (goto-char (1- (match-end 0)))
4157 (delete-char -1)
4158 (goto-char (match-beginning 0))
4159 (self-insert-command N))
4160 (setq org-table-may-need-update t)
4161 (let* (orgtbl-mode
4162 a
4163 (cmd (or (key-binding
4164 (or (and (listp function-key-map)
4165 (setq a (assoc last-input-event function-key-map))
4166 (cdr a))
4167 (vector last-input-event)))
4168 'self-insert-command)))
4169 (call-interactively cmd)
4170 (if (and org-self-insert-cluster-for-undo
4171 (eq cmd 'self-insert-command))
4172 (if (not (eq last-command 'orgtbl-self-insert-command))
4173 (setq org-self-insert-command-undo-counter 1)
4174 (if (>= org-self-insert-command-undo-counter 20)
4175 (setq org-self-insert-command-undo-counter 1)
4176 (and (> org-self-insert-command-undo-counter 0)
4177 buffer-undo-list
4178 (not (cadr buffer-undo-list)) ; remove nil entry
4179 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4180 (setq org-self-insert-command-undo-counter
4181 (1+ org-self-insert-command-undo-counter))))))))
4184 "Regular expression matching exponentials as produced by calc.")
4186 (defun orgtbl-export (table target)
4187 (require 'org-exp)
4188 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4190 org-table-last-alignment org-table-last-column-widths
4191 maxcol column)
4192 (if (not (fboundp func))
4193 (error "Cannot export orgtbl table to %s" target))
4194 (setq lines (org-table-clean-before-export lines))
4195 (setq table
4196 (mapcar
4197 (lambda (x)
4198 (if (string-match org-table-hline-regexp x)
4199 'hline
4201 lines))
4202 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4203 table)))
4204 (loop for i from (1- maxcol) downto 0 do
4205 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4206 (setq column (delq nil column))
4207 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4208 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
4209 (funcall func table nil)))
4211 (defun orgtbl-gather-send-defs ()
4212 "Gather a plist of :name, :transform, :params for each destination before
4213 a radio table."
4214 (save-excursion
4215 (goto-char (org-table-begin))
4216 (let (rtn)
4217 (beginning-of-line 0)
4218 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4219 (let ((name (org-no-properties (match-string 1)))
4220 (transform (intern (match-string 2)))
4221 (params (if (match-end 3)
4222 (read (concat "(" (match-string 3) ")")))))
4223 (push (list :name name :transform transform :params params)
4224 rtn)
4225 (beginning-of-line 0)))
4226 rtn)))
4228 (defun orgtbl-send-replace-tbl (name txt)
4229 "Find and replace table NAME with TXT."
4230 (save-excursion
4231 (goto-char (point-min))
4232 (unless (re-search-forward
4234 (error "Don't know where to insert translated table"))
4235 (goto-char (match-beginning 0))
4236 (beginning-of-line 2)
4237 (save-excursion
4238 (let ((beg (point)))
4239 (unless (re-search-forward
4240 (concat "END RECEIVE ORGTBL +" name) nil t)
4241 (error "Cannot find end of insertion region"))
4242 (beginning-of-line 1)
4243 (delete-region beg (point))))
4246 ;;;###autoload
4247 (defun org-table-to-lisp (&optional txt)
4248 "Convert the table at point to a Lisp structure.
4249 The structure will be a list. Each item is either the symbol `hline'
4250 for a horizontal separator line, or a list of field values as strings.
4251 The table is taken from the parameter TXT, or from the buffer at point."
4252 (unless txt
4253 (unless (org-at-table-p)
4254 (error "No table at point")))
4255 (let* ((txt (or txt
4256 (buffer-substring-no-properties (org-table-begin)
4257 (org-table-end))))
4260 (mapcar
4261 (lambda (x)
4262 (if (string-match org-table-hline-regexp x)
4263 'hline
4265 lines)))
4267 (defun orgtbl-send-table (&optional maybe)
4268 "Send a transformed version of this table to the receiver position.
4269 With argument MAYBE, fail quietly if no transformation is defined for
4270 this table."
4271 (interactive)
4272 (catch 'exit
4273 (unless (org-at-table-p) (error "Not at a table"))
4274 ;; when non-interactive, we assume align has just happened.
4275 (when (org-called-interactively-p 'any) (org-table-align))
4276 (let ((dests (orgtbl-gather-send-defs))
4277 (txt (buffer-substring-no-properties (org-table-begin)
4278 (org-table-end)))
4279 (ntbl 0))
4280 (unless dests (if maybe (throw 'exit nil)
4281 (error "Don't know how to transform this table")))
4282 (dolist (dest dests)
4283 (let* ((name (plist-get dest :name))
4284 (transform (plist-get dest :transform))
4285 (params (plist-get dest :params))
4286 (skip (plist-get params :skip))
4287 (skipcols (plist-get params :skipcols))
4288 beg
4289 (lines (org-table-clean-before-export
4290 (nthcdr (or skip 0)
4292 (i0 (if org-table-clean-did-remove-column 2 1))
4293 (table (mapcar
4294 (lambda (x)
4295 (if (string-match org-table-hline-regexp x)
4296 'hline
4297 (org-remove-by-index
4299 skipcols i0)))
4300 lines))
4301 (fun (if (= i0 2) 'cdr 'identity))
4302 (org-table-last-alignment
4303 (org-remove-by-index (funcall fun org-table-last-alignment)
4304 skipcols i0))
4305 (org-table-last-column-widths
4306 (org-remove-by-index (funcall fun org-table-last-column-widths)
4307 skipcols i0))
4308 (txt (if (fboundp transform)
4309 (funcall transform table params)
4310 (error "No such transformation function %s" transform))))
4311 (orgtbl-send-replace-tbl name txt))
4312 (setq ntbl (1+ ntbl)))
4313 (message "Table converted and installed at %d receiver location%s"
4314 ntbl (if (> ntbl 1) "s" ""))
4315 (if (> ntbl 0)
4316 ntbl
4317 nil))))
4319 (defun org-remove-by-index (list indices &optional i0)
4320 "Remove the elements in LIST with indices in INDICES.
4321 First element has index 0, or I0 if given."
4322 (if (not indices)
4323 list
4324 (if (integerp indices) (setq indices (list indices)))
4325 (setq i0 (1- (or i0 0)))
4326 (delq :rm (mapcar (lambda (x)
4327 (setq i0 (1+ i0))
4328 (if (memq i0 indices) :rm x))
4329 list))))
4331 (defun orgtbl-toggle-comment ()
4332 "Comment or uncomment the orgtbl at point."
4333 (interactive)
4334 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4335 (re2 (concat "^" orgtbl-line-start-regexp))
4336 (commented (save-excursion (beginning-of-line 1)
4337 (cond ((looking-at re1) t)
4338 ((looking-at re2) nil)
4339 (t (error "Not at an org table")))))
4340 (re (if commented re1 re2))
4341 beg end)
4342 (save-excursion
4343 (beginning-of-line 1)
4344 (while (looking-at re) (beginning-of-line 0))
4345 (beginning-of-line 2)
4346 (setq beg (point))
4347 (while (looking-at re) (beginning-of-line 2))
4348 (setq end (point)))
4349 (comment-region beg end (if commented '(4) nil))))
4351 (defun orgtbl-insert-radio-table ()
4352 "Insert a radio table template appropriate for this major mode."
4353 (interactive)
4354 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4355 (txt (nth 1 e))
4356 name pos)
4357 (unless e (error "No radio table setup defined for %s" major-mode))
4358 (setq name (read-string "Table name: "))
4359 (while (string-match "%n" txt)
4360 (setq txt (replace-match name t t txt)))
4362 (setq pos (point))
4363 (insert txt)
4364 (goto-char pos)))
4366 ;; Dynamically bound input and output for table formatting.
4367 (defvar *orgtbl-table* nil
4368 "Carries the current table through formatting routines.")
4369 (defvar *orgtbl-rtn* nil
4370 "Formatting routines push the output lines here.")
4371 ;; Formatting parameters for the current table section.
4372 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4373 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4374 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4375 (defvar *orgtbl-fmt* nil "Format for each entry.")
4376 (defvar *orgtbl-efmt* nil "Format for numbers.")
4377 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4378 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4379 (defvar *orgtbl-lstart* nil "Text starting a row.")
4380 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4381 (defvar *orgtbl-lend* nil "Text ending a row.")
4382 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4384 (defsubst orgtbl-get-fmt (fmt i)
4385 "Retrieve the format from FMT corresponding to the Ith column."
4386 (if (and (not (functionp fmt)) (consp fmt))
4387 (plist-get fmt i)
4388 fmt))
4390 (defsubst orgtbl-apply-fmt (fmt &rest args)
4391 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4392 (cond ((functionp fmt) (apply fmt args))
4393 (fmt (apply 'format fmt args))
4394 (args (car args))
4395 (t args)))
4397 (defsubst orgtbl-eval-str (str)
4398 "If STR is a function, evaluate it with no arguments."
4399 (if (functionp str)
4400 (funcall str)
4401 str))
4403 (defun orgtbl-format-line (line)
4404 "Format LINE as a table row."
4405 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4406 (let* ((i 0)
4407 (line
4408 (mapcar
4409 (lambda (f)
4410 (setq i (1+ i))
4411 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4412 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4413 (orgtbl-apply-fmt efmt (match-string 1 f)
4414 (match-string 2 f))
4415 f)))
4416 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4417 *orgtbl-default-fmt*)
4418 f)))
4419 line)))
4420 (push (if *orgtbl-lfmt*
4421 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4422 (concat (orgtbl-eval-str *orgtbl-lstart*)
4423 (mapconcat 'identity line *orgtbl-sep*)
4424 (orgtbl-eval-str *orgtbl-lend*)))
4425 *orgtbl-rtn*))))
4427 (defun orgtbl-format-section (section-stopper)
4428 "Format lines until the first occurrence of SECTION-STOPPER."
4429 (let (prevline)
4430 (progn
4431 (while (not (eq (car *orgtbl-table*) section-stopper))
4432 (if prevline (orgtbl-format-line prevline))
4433 (setq prevline (pop *orgtbl-table*)))
4434 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4435 (*orgtbl-lend* *orgtbl-llend*)
4436 (*orgtbl-lfmt* *orgtbl-llfmt*))
4437 (orgtbl-format-line prevline))))))
4439 (defun orgtbl-to-generic (table params)
4440 "Convert the orgtbl-mode TABLE to some other format.
4441 This generic routine can be used for many standard cases.
4442 TABLE is a list, each entry either the symbol `hline' for a horizontal
4443 separator line, or a list of fields for that line.
4444 PARAMS is a property list of parameters that can influence the conversion.
4445 For the generic converter, some parameters are obligatory: you need to
4446 specify either :lfmt, or all of (:lstart :lend :sep).
4448 Valid parameters are
4450 :splice When set to t, return only table body lines, don't wrap
4451 them into :tstart and :tend. Default is nil. When :splice
4452 is non-nil, this also means that the exporter should not look
4453 for and interpret header and footer sections.
4455 :hline String to be inserted on horizontal separation lines.
4456 May be nil to ignore hlines.
4458 :sep Separator between two fields
4459 :remove-nil-lines Do not include lines that evaluate to nil.
4462 Each in the following group may be either a string or a function
4463 of no arguments returning a string:
4464 :tstart String to start the table. Ignored when :splice is t.
4465 :tend String to end the table. Ignored when :splice is t.
4466 :lstart String to start a new table line.
4467 :llstart String to start the last table line, defaults to :lstart.
4468 :lend String to end a table line
4469 :llend String to end the last table line, defaults to :lend.
4471 Each in the following group may be a string, a function of one
4472 argument (the field or line) returning a string, or a plist
4473 mapping columns to either of the above:
4474 :lfmt Format for entire line, with enough %s to capture all fields.
4475 If this is present, :lstart, :lend, and :sep are ignored.
4476 :llfmt Format for the entire last line, defaults to :lfmt.
4477 :fmt A format to be used to wrap the field, should contain
4478 %s for the original field value. For example, to wrap
4480 This may also be a property list with column numbers and
4483 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4484 Same as above, specific for the header lines in the table.
4485 All lines before the first hline are treated as header.
4486 If any of these is not present, the data line value is used.
4488 This may be either a string or a function of two arguments:
4489 :efmt Use this format to print numbers with exponentials.
4490 The format should have %s twice for inserting mantissa
4492 may also be a property list with column numbers and
4493 formats. :fmt will still be applied after :efmt.
4495 In addition to this, the parameters :skip and :skipcols are always handled
4496 directly by `orgtbl-send-table'. See manual."
4497 (interactive)
4499 (let* ((splicep (plist-get params :splice))
4500 (hline (plist-get params :hline))
4501 (remove-nil-linesp (plist-get params :remove-nil-lines))
4502 (remove-newlines (plist-get params :remove-newlines))
4503 (*orgtbl-hline* hline)
4504 (*orgtbl-table* table)
4505 (*orgtbl-sep* (plist-get params :sep))
4506 (*orgtbl-efmt* (plist-get params :efmt))
4507 (*orgtbl-lstart* (plist-get params :lstart))
4508 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4509 (*orgtbl-lend* (plist-get params :lend))
4510 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4511 (*orgtbl-lfmt* (plist-get params :lfmt))
4512 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4513 (*orgtbl-fmt* (plist-get params :fmt))
4514 *orgtbl-rtn*)
4516 ;; Put header
4517 (unless splicep
4518 (when (plist-member params :tstart)
4519 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4520 (if tstart (push tstart *orgtbl-rtn*)))))
4522 ;; Do we have a heading section? If so, format it and handle the
4523 ;; trailing hline.
4524 (if (and (not splicep)
4525 (or (consp (car *orgtbl-table*))
4526 (consp (nth 1 *orgtbl-table*)))
4527 (memq 'hline (cdr *orgtbl-table*)))
4528 (progn
4529 (when (eq 'hline (car *orgtbl-table*))
4530 ;; there is a hline before the first data line
4531 (and hline (push hline *orgtbl-rtn*))
4532 (pop *orgtbl-table*))
4533 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4534 *orgtbl-lstart*))
4535 (*orgtbl-llstart* (or (plist-get params :hllstart)
4536 *orgtbl-llstart*))
4537 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4538 (*orgtbl-llend* (or (plist-get params :hllend)
4539 (plist-get params :hlend) *orgtbl-llend*))
4540 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4541 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4542 (plist-get params :hlfmt) *orgtbl-llfmt*))
4543 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4544 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4545 (orgtbl-format-section 'hline))
4546 (if hline (push hline *orgtbl-rtn*))
4547 (pop *orgtbl-table*)))
4549 ;; Now format the main section.
4550 (orgtbl-format-section nil)
4552 (unless splicep
4553 (when (plist-member params :tend)
4554 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4555 (if tend (push tend *orgtbl-rtn*)))))
4557 (mapconcat (if remove-newlines
4558 (lambda (tend)
4560 'identity)
4561 (nreverse (if remove-nil-linesp
4562 (remq nil *orgtbl-rtn*)
4565 (defun orgtbl-to-tsv (table params)
4566 "Convert the orgtbl-mode table to TAB separated material."
4568 (defun orgtbl-to-csv (table params)
4569 "Convert the orgtbl-mode table to CSV material.
4570 This does take care of the proper quoting of fields with comma or quotes."
4571 (orgtbl-to-generic table (org-combine-plists
4572 '(:sep "," :fmt org-quote-csv-field)
4573 params)))
4575 (defun orgtbl-to-latex (table params)
4576 "Convert the orgtbl-mode TABLE to LaTeX.
4577 TABLE is a list, each entry either the symbol `hline' for a horizontal
4578 separator line, or a list of fields for that line.
4579 PARAMS is a property list of parameters that can influence the conversion.
4580 Supports all parameters from `orgtbl-to-generic'. Most important for
4581 LaTeX are:
4583 :splice When set to t, return only table body lines, don't wrap
4584 them into a tabular environment. Default is nil.
4586 :fmt A format to be used to wrap the field, should contain %s for the
4587 original field value. For example, to wrap everything in dollars,
4590 The format may also be a function that formats its one argument.
4592 :efmt Format for transforming numbers with exponentials. The format
4593 should have %s twice for inserting mantissa and exponent, for
4595 This may also be a property list with column numbers and formats.
4596 The format may also be a function that formats its two arguments.
4598 :llend If you find too much space below the last line of a table,
4601 The general parameters :skip and :skipcols have already been applied when
4602 this function is called."
4603 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4604 org-table-last-alignment ""))
4605 (params2
4606 (list
4611 (orgtbl-to-generic table (org-combine-plists params2 params))))
4613 (defun orgtbl-to-html (table params)
4614 "Convert the orgtbl-mode TABLE to HTML.
4615 TABLE is a list, each entry either the symbol `hline' for a horizontal
4616 separator line, or a list of fields for that line.
4617 PARAMS is a property list of parameters that can influence the conversion.
4618 Currently this function recognizes the following parameters:
4620 :splice When set to t, return only table body lines, don't wrap
4621 them into a <table> environment. Default is nil.
4623 The general parameters :skip and :skipcols have already been applied when
4624 this function is called. The function does *not* use `orgtbl-to-generic',
4625 so you cannot specify parameters for it."
4626 (let* ((splicep (plist-get params :splice))
4627 (html-table-tag org-export-html-table-tag)
4628 html)
4629 ;; Just call the formatter we already have
4630 ;; We need to make text lines for it, so put the fields back together.
4631 (setq html (org-format-org-table-html
4632 (mapcar
4633 (lambda (x)
4634 (if (eq x 'hline)
4635 "|----+----|"
4636 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4637 table)
4638 splicep))
4640 (setq html (replace-match "" t t html)))
4641 html))
4643 (defun orgtbl-to-texinfo (table params)
4644 "Convert the orgtbl-mode TABLE to TeXInfo.
4645 TABLE is a list, each entry either the symbol `hline' for a horizontal
4646 separator line, or a list of fields for that line.
4647 PARAMS is a property list of parameters that can influence the conversion.
4648 Supports all parameters from `orgtbl-to-generic'. Most important for
4649 TeXInfo are:
4651 :splice nil/t When set to t, return only table body lines, don't wrap
4652 them into a multitable environment. Default is nil.
4654 :fmt fmt A format to be used to wrap the field, should contain
4655 %s for the original field value. For example, to wrap
4657 This may also be a property list with column numbers and
4659 Each format also may be a function that formats its one
4660 argument.
4663 are computed automatically from the width of the columns
4664 under org-mode.
4666 The general parameters :skip and :skipcols have already been applied when
4667 this function is called."
4668 (let* ((total (float (apply '+ org-table-last-column-widths)))
4669 (colfrac (or (plist-get params :cf)
4670 (mapconcat
4671 (lambda (x) (format "%.3f" (/ (float x) total)))
4672 org-table-last-column-widths " ")))
4673 (params2
4674 (list
4675 :tstart (concat "@multitable @columnfractions " colfrac)
4676 :tend "@end multitable"
4677 :lstart "@item " :lend "" :sep " @tab "
4678 :hlstart "@headitem ")))
4679 (orgtbl-to-generic table (org-combine-plists params2 params))))
4681 (defun orgtbl-to-orgtbl (table params)
4682 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4683 Useful when slicing one table into many. The :hline, :sep,
4684 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4685 and :tend suppress strings without splicing; they can be set to
4686 provide ORGTBL directives for the generated table."
4687 (let* ((params2
4688 (list
4689 :remove-newlines t
4690 :tstart nil :tend nil
4691 :hline "|---"
4692 :sep " | "
4693 :lstart "| "
4694 :lend " |"))
4695 (params (org-combine-plists params2 params)))
4696 (orgtbl-to-generic table params)))
4698 (defun org-table-get-remote-range (name-or-id form)
4699 "Get a field value or a list of values in a range from table at ID.
4701 NAME-OR-ID may be the name of a table in the current file as set by
4703 will then be used. Alternatively, it may be an ID referring to
4704 any entry, also in a different file. In this case, the first table
4705 in that entry will be referenced.
4709 The return value is either a single string for a single field, or a
4710 list of the fields in the rectangle ."
4711 (save-match-data
4712 (let ((id-loc nil)
4713 ;; Protect a bunch of variables from being overwritten
4714 ;; by the context of the remote table
4715 org-table-column-names org-table-column-name-regexp
4716 org-table-local-parameters org-table-named-field-locations
4717 org-table-current-line-types org-table-current-begin-line
4718 org-table-current-begin-pos org-table-dlines
4719 org-table-current-ncol
4720 org-table-hlines org-table-last-alignment
4721 org-table-last-column-widths org-table-last-alignment
4722 org-table-last-column-widths tbeg
4723 buffer loc)
4724 (setq form (org-table-convert-refs-to-rc form))
4725 (save-excursion
4726 (save-restriction
4727 (widen)
4728 (save-excursion
4729 (goto-char (point-min))
4730 (if (re-search-forward
4732 nil t)
4733 (setq buffer (current-buffer) loc (match-beginning 0))
4734 (setq id-loc (org-id-find name-or-id 'marker))
4735 (unless (and id-loc (markerp id-loc))
4737 (setq buffer (marker-buffer id-loc)
4738 loc (marker-position id-loc))
4739 (move-marker id-loc nil)))
4740 (with-current-buffer buffer
4741 (save-excursion
4742 (save-restriction
4743 (widen)
4744 (goto-char loc)
4745 (forward-char 1)
4747 (not (match-beginning 1)))
4748 (error "Cannot find a table at NAME or ID %s" name-or-id))
4749 (setq tbeg (point-at-bol))
4750 (org-table-get-specials)
4751 (setq form (org-table-formula-substitute-names
4752 (org-table-formula-handle-first/last-rc form)))
4753 (if (and (string-match org-table-range-regexp form)
4754 (> (length (match-string 0 form)) 1))
4755 (save-match-data
4756 (org-table-get-range (match-string 0 form) tbeg 1))
4757 form)))))))))
4759 (provide 'org-table)
4761 ;;; org-table.el ends here