| blob | 6ea072751335d1bce893d1f615b15c0fd0e6a0d2 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2011 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 "Wrap several fields in a column like a paragraph.
1731 This is useful if you'd like to spread the contents of a field over several
1732 lines, in order to keep the table compact.
1734 If there is an active region, and both point and mark are in the same column,
1735 the text in the column is wrapped to minimum width for the given number of
1736 lines. Generally, this makes the table more compact. A prefix ARG may be
1738 formats the selected text to two lines. If the region was longer than two
1739 lines, the remaining lines remain empty. A negative prefix argument reduces
1740 the current number of lines by that amount. The wrapped text is pasted back
1741 into the table. If you formatted it to more lines than it was before, fields
1742 further down in the table get overwritten - so you might need to make space in
1743 the table first.
1745 If there is no region, the current field is split at the cursor position and
1746 the text fragment to the right of the cursor is prepended to the field one
1747 line down.
1749 If there is no region, but you specify a prefix ARG, the current field gets
1750 blank, and the content is appended to the field above."
1754 ;; There is a region: fill as a paragraph
1758 nlines)
1765 arg)
1769 nil nlines)))
1773 ;; No region, split the current field at point
1777 ;; combine with field above
1787 ;; split field
1800 "Edit table field in a different window.
1801 This is mainly useful for fields that contain hidden parts.
1803 it can be edited in place."
1812 display t intangible t))
1825 p)
1841 intangible t))
1849 "Finish editing a table data field.
1850 Remove all newline characters, insert the result into the table, realign
1851 the table and kill the editing buffer."
1855 text)
1872 "Minor mode to make the table field editor window follow the cursor.
1873 When this mode is active, the field editor window will always show the
1874 current field. The mode exits automatically when the cursor leaves the
1875 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1876 nil " TblFollow" nil
1892 ;; We have left the table, exit the follow mode
1903 "Sum numbers in region of current table column.
1904 The result will be displayed in the echo area, and will be available
1907 If there is an active region, it is interpreted as a rectangle and all
1908 numbers in that rectangle will be summed. If there is no active
1909 region and point is located in a table column, sum all numbers in that
1910 column.
1912 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1913 numbers are assumed to be times as well (in decimal hours) and the
1914 numbers are added as such.
1916 If NLAST is a number, only the NLAST fields will actually be summed."
1943 items1)))
1950 s diff)
1958 sres))))
1981 "Return the formula active for the current field.
1982 Assumes that specials are in place.
1983 If KEY is given, return the key to this formula.
1987 org-table-named-field-locations)))
2001 "Read a formula from the minibuffer, offer stored formula as default.
2002 When NAMED is non-nil, look for a named equation."
2006 org-table-named-field-locations)))
2013 name
2014 ref)
2024 stored)
2026 equation)
2033 scol))
2035 'org-table-formula-history
2036 )))))
2037 mustsave)
2039 ;; remove formula
2046 ;; We set the column equation, delete the named one.
2048 mustsave t))
2054 eq))
2057 "Store the list of formulas below the current table."
2063 ;; don't overwrite TBLFM, we might use text properties to store stuff
2079 ;; Fake a high number to make sure this is sorted at the end.
2086 a)
2096 "Compare two formulas for sorting."
2102 "Return an alist with the stored formulas directly after current table."
2111 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2130 "Modify the equations after the table structure has been edited.
2132 For all numbers larger than LIMIT, shift them by DELTA."
2143 s n a)
2159 t t)))))))))
2162 "Get the column names and local parameters for this table."
2165 names name fields fields1 field cnt
2166 c v l line col types dlines hlines last-dline)
2168 org-table-local-parameters nil
2169 org-table-named-field-locations nil
2170 org-table-current-begin-line nil
2171 org-table-current-begin-pos nil
2172 org-table-current-line-types nil
2191 org-table-local-parameters))))
2207 ;; Analyse the line types
2211 l org-table-current-begin-line)
2228 al al2)
2240 If yes, store the formula and apply it."
2241 ;; We already know we are in a table. Get field will only return a formula
2242 ;; when appropriate. It might return a separator line, but no problem.
2245 named eq)
2256 "List of commands triggering the recalculation of a line.
2269 "Rotate the recalculation mark in the first column.
2270 If in any row, the first field is not consistent with a mark,
2271 insert a new column for the markers.
2272 When there is an active region, change all the lines in the region,
2273 after prompting for the marking character.
2274 After each change, a message will be displayed indicating the meaning
2275 of the new mark."
2290 epos new)
2297 newchar))
2330 "Recompute the current line if marked for it, and if we haven't just done it."
2350 modes)
2353 suppress-align suppress-const
2354 suppress-store suppress-analysis)
2355 "Replace the table field value at the cursor by the result of a calculation.
2357 This function makes use of Dave Gillespie's Calc package, in my view the
2358 most exciting program ever written for GNU Emacs. So you need to have Calc
2359 installed in order to use this function.
2361 In a table, this command replaces the value in the current field with the
2363 formula, by storing it in a special line below the table. When called
2364 with a `C-u' prefix, the current field must be a named field, and the
2365 formula is installed as valid in only this specific field.
2367 When called with two `C-u' prefixes, insert the active equation
2368 for the field back into the current field, so that it can be
2370 to check the referenced fields.
2372 When called, the command first prompts for a formula, which is read in
2373 the minibuffer. Previously entered formulas are available through the
2374 history list, and the last used formula is offered as a default.
2375 These stored formulas are adapted correctly when moving, inserting, or
2376 deleting columns with the corresponding commands.
2378 The formula can be any algebraic expression understood by the Calc package.
2379 For details, see the Org-mode manual.
2381 This function can also be called from Lisp programs and offers
2382 additional arguments: EQUATION can be the formula to apply. If this
2383 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2384 used to speed-up recursive calls by by-passing unnecessary aligns.
2385 SUPPRESS-CONST suppresses the interpretation of constants in the
2386 formula, assuming that this has been done already outside the function.
2387 SUPPRESS-STORE means the formula should not be stored, either because
2388 it is already stored, or because it is a modified equation that should
2389 not overwrite the stored one."
2405 equation
2411 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2412 duration duration-output-format)
2413 ;; Parse the format string. Since we have a lot of modes, this is
2414 ;; a lot of work. However, I think calc still uses most of the time.
2426 'calc-float-format
2429 n))))
2433 duration-output-format nil
2437 duration-output-format org-table-duration-custom-format
2438 numbers t
2462 ;; replace fields with duration values if relevant
2466 fields)))
2470 fields)))
2476 ;; Insert row and column number of formula result field
2487 t t form)))
2489 ;; Check for old vertical references
2491 ;; Insert remote references
2499 keep-empty numbers lispp))
2500 t t form)))
2501 ;; Insert complex ranges
2509 ;; possibly handle durations
2514 formrg)
2515 keep-empty numbers lispp)))
2520 ;; Insert simple ranges
2529 keep-empty numbers lispp))
2530 t t form)))
2532 ;; Insert the references to fields in same row
2542 t t form)))
2562 Orig: %s
2563 $xyz-> %s
2564 @r$c-> %s
2596 prop value)))
2599 "Get a calc vector from a column, according to descriptor DESC.
2600 Optional arguments TBEG and COL can give the beginning of the table and
2601 the current column, to avoid unnecessary parsing.
2603 HIGHLIGHT means just highlight the range.
2605 When CORNERS-ONLY is set, only return the corners of the range as
2606 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2607 in the buffer and column1 and column2 are table column numbers."
2614 beg end c1 c2 r1 r2 rangep tmp)
2631 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2638 ;; just one field
2645 ;; A range, return a vector
2646 ;; First sort the numbers to get a regular ractangle
2650 ;; Only return the corners of the range
2652 ;; Copy the range values into a list
2666 ;; return string representation of calc vector
2671 "Analyze descriptor DESC and retrieve the corresponding line number.
2672 The cursor is currently in line CLINE, the table begins in line BLINE,
2673 and TABLE is a vector with line types."
2681 ;; 1 2 3 4 5 6
2701 nil hn cline desc)))
2704 rel on cline desc)))
2708 "FIXME: Needs more documentation."
2721 nil))
2722 t)))
2726 desc cline)
2727 i)))
2732 s))
2735 "Convert list ELEMENTS to something appropriate to insert into formula.
2736 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2737 NUMBERS indicates that everything should be converted to numbers.
2738 LISPP means to return something appropriate for a Lisp list."
2742 elements
2751 elements))))
2757 x
2763 elements
2767 "Recalculate the current table line by applying all stored formulas.
2768 With prefix arg ALL, do this for all lines in the table.
2769 With the prefix argument ALL is `(16)' \
2771 it is the symbol `iterate', recompute the table until it no longer changes.
2772 If NOALIGN is not nil, do not re-align the table after the computations
2773 are done. This is typically used internally to save time, if it is
2774 known that the table will be realigned a little later anyway."
2789 seen-fields lhs1
2791 ;; Insert constants in all formulas
2807 eqlist))
2808 ;; Split the equation list
2814 ;; Expand ranges in lhs of formulas
2817 ;; Get the correct line range to process
2823 ;; This is a table with marked lines, compute selected lines
2825 ;; Move forward to the first non-header line
2836 ;; First find the named fields, and mark them untouchable.
2837 ;; Also check if several field/range formulas try to set the same field.
2856 name)))
2866 ;; Now evaluate the column formulas, but skip fields covered by
2867 ;; field formulas
2871 ;; Unprotected line, recalculate
2883 ;; Now evaluate the field formulas
2897 ;; back to initial position
2905 "Recalculate the table until it does not change anymore.
2906 The maximun number of iterations is 10, but you can chose a different value
2907 with the prefix ARG."
2912 thistbl)
2927 "Recalculate all tables in the current buffer."
2935 "Iterate all tables in the buffer, to converge inter-table dependencies."
2940 c1
2957 "Expand list of formulas.
2958 If some of the RHS in the formulas are ranges or a row reference, expand
2959 them to individual field equations for each field."
2965 ;; This just refers to one fixed field
2968 ;; This just refers to one fixed named field
2990 "Replace @<, @>, $<, $> with first/last row/column of the table.
2991 So @< and $< will always be replaced with @1 and $1, respectively.
2992 The advantage of these special markers are that structure editing of
2993 the table will not change them, while @1 and $1 will be modified
2994 when a line/row is swaped out of that privileged position. So for
2995 formulas that use a range of rows or columns, it may often be better
2997 borders of the table using the @< @> $< $> makers."
3000 s start)
3005 org-table-current-ncol)
3009 len
3016 s)
3019 "Replace $const with values in string F."
3021 ;; First, check for column names
3026 ;; Parameters and constants
3028 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3038 f))
3041 "Find the value for a parameter or constant in a formula.
3042 Parameters get priority."
3073 map))
3080 "--"
3083 "--"
3084 "Shift Reference at Point"
3089 "-"
3090 "Change Test Row for Column Formulas"
3093 "--"
3098 org-table-overlay-coordinates)]
3099 "--"
3106 "Edit the formulas of the current table in a separate buffer."
3122 entry s type title)
3125 ;; Keep global-font-lock-mode from turning on font-lock-mode
3166 "Convert a formula from internal to user representation."
3169 s))
3172 "Convert a formula from user to internal representation."
3175 s))
3178 "Convert spreadsheet references from A7 to @7$28.
3179 Works for single references, but also for entire formulas and even the
3180 full TBLFM line."
3182 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3185 ;; format match, just advance
3190 ;; 3.e5 or something like this.
3193 ;; (member (match-string 1 s)
3194 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3195 )
3196 ;; function name, just advance
3206 t t s)))))
3207 s))
3210 "Convert spreadsheet references from to @7$28 to AB7.
3211 Works for single references, but also for entire formulas and even the
3212 full TBLFM line."
3219 t t s)))
3224 t nil s)))
3225 s)
3228 "Convert a base 26 number represented by letters into an integer.
3229 For example: AB -> 28."
3235 n))
3238 "Convert an integer into a base 26 number represented by letters.
3239 For example: 28 -> AB."
3244 s))
3247 "Convert a time string into numerical duration in seconds.
3248 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3249 If S is a string representing a number, keep this number."
3272 "Convert a number of seconds to a time string.
3273 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3274 minutes or seconds."
3286 "Convert all references in this buffer, using FUNCTION."
3296 "Convert all references in the buffer from B3 to @3$2 and back."
3306 "Shift the reference at point one row/hline up."
3310 "Shift the reference at point one row/hline down."
3314 "Shift the reference at point one field to the left."
3318 "Shift the reference at point one field to the right."
3329 ;; A B3-like reference
3335 ;; An internal reference
3341 "Re-match the group N, and replace it with the shifted reference."
3346 t t)))
3349 "Shift a reference part REF.
3350 If DECR is set, decrease the references row/column, else increase.
3351 If HLINE is set, this may be a hline reference, it certainly is not
3352 a translation reference."
3381 "Toggle the display of coordinates in the referenced table."
3390 "Parse the buffer for formula definitions and install them.
3391 With prefix ARG, apply the new formulas to the table."
3401 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3402 nil t)
3426 "Abort editing formulas, without installing the changes."
3437 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3478 "Show the location/value of the $ expression at point."
3487 var name e what match dest)
3492 "$1.."
3575 ;; column number
3603 org-table-fedit-scroll-down))))
3614 "Make sure the cursor is in a dataline in a table."
3623 p1 p2)))
3628 "Move cursor one line up in the window showing the table."
3633 "Move cursor one line down in the window showing the table."
3638 "Move the cursor in the window showing the table.
3639 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3664 "Add a new overlay."
3670 "Highlight rectangular region in a table."
3674 l1 c1 l2 c2 tmp)
3698 "Remove the rectangle overlays."
3709 "Add overlays to the table at point, to show row/column coordinates."
3738 "Toggle the display of Row/Column numbers in tables."
3750 "Toggle the formula debugger in tables."
3756 ;;; The orgtbl minor mode
3758 ;; Define a minor mode which can be used in other modes in order to
3759 ;; integrate the org-mode table editor.
3761 ;; This is really a hack, because the org-mode table editor uses several
3762 ;; keys which normally belong to the major mode, for example the TAB and
3763 ;; RET keys. Here is how it works: The minor mode defines all the keys
3764 ;; necessary to operate the table editor, but wraps the commands into a
3765 ;; function which tests if the cursor is currently inside a table. If that
3766 ;; is the case, the table editor command is executed. However, when any of
3767 ;; those keys is used outside a table, the function uses `key-binding' to
3768 ;; look up if the key has an associated command in another currently active
3769 ;; keymap (minor modes, major mode, global), and executes that command.
3770 ;; There might be problems if any of the keys used by the table editor is
3771 ;; otherwise used as a prefix key.
3773 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3774 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3775 ;; addresses this by checking explicitly for both bindings.
3777 ;; The optimized version (see variable `orgtbl-optimized') takes over
3778 ;; all keys which are bound to `self-insert-command' in the *global map*.
3779 ;; Some modes bind other commands to simple characters, for example
3780 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3781 ;; active, this binding is ignored inside tables and replaced with a
3782 ;; modified self-insert.
3788 ;;;###autoload
3790 "Unconditionally turn on `orgtbl-mode'."
3805 ;; Install it as a minor mode.
3809 ;;;###autoload
3811 "The `org-mode' table editor as a minor mode for use in other modes."
3816 ;; Exit without error, in case some hook functions calls this
3817 ;; by accident in org-mode.
3821 ;; Make sure we are first in minor-mode-map-alist
3823 ;; FIXME: maybe it should use emulation-mode-map-alists?
3830 auto-fill-inhibit-regexp)
3834 auto-fill-inhibit-regexp)
3835 orgtbl-line-start-regexp))
3853 "Remove all properties related to narrow-column invisibility."
3866 "Create a function for binding in the table minor mode.
3867 FUN is the command to call inside a table. N is used to create a unique
3868 command name. KEYS are keys that should be checked in for a command
3869 to execute outside of tables."
3875 "Outside of tables, run the binding of `"
3887 keys)
3891 "Error when there is no default binding for a table key."
3896 "Setup orgtbl keymaps."
3927 elt key fun cmd)
3935 ;; Special treatment needed for TAB and RET
3955 [(tab)] "\C-i")))
3957 (org-defkey orgtbl-mode-map [backtab]
3959 [backtab] [S-iso-lefttab] [(shift tab)]
3960 [(tab)] "\C-i"))
3962 (org-defkey orgtbl-mode-map "\M-\C-m"
3963 (orgtbl-make-binding 'org-table-wrap-region 105
3964 "\M-\C-m" [(meta return)]))
3965 (org-defkey orgtbl-mode-map [(meta return)]
3966 (orgtbl-make-binding 'org-table-wrap-region 106
3967 [(meta return)] "\M-\C-m"))
3969 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3970 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3972 (when orgtbl-optimized
3973 ;; If the user wants maximum table support, we need to hijack
3974 ;; some standard editing functions
3975 (org-remap orgtbl-mode-map
3976 'self-insert-command 'orgtbl-self-insert-command
3977 'delete-char 'org-delete-char
3978 'delete-backward-char 'org-delete-backward-char)
3979 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3980 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3981 '("OrgTbl"
3982 ["Create or convert" org-table-create-or-convert-from-region
3983 :active (not (org-at-table-p)) :keys "C-c |" ]
3984 "--"
3985 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3986 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3987 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3988 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3989 "--"
3990 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3991 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3992 ["Copy Field from Above"
3993 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3994 "--"
3995 ("Column"
3996 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3997 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3998 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3999 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4000 ("Row"
4001 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4002 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4003 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4004 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4005 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4006 "--"
4007 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4008 ("Rectangle"
4009 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4010 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4011 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4012 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4013 "--"
4014 ("Radio tables"
4015 ["Insert table template" orgtbl-insert-radio-table
4016 (assq major-mode orgtbl-radio-table-templates)]
4017 ["Comment/uncomment table" orgtbl-toggle-comment t])
4018 "--"
4019 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4020 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4021 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4022 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4023 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4024 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4025 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4026 ["Sum Column/Rectangle" org-table-sum
4027 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4028 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4029 ["Debug Formulas"
4030 org-table-toggle-formula-debugger :active (org-at-table-p)
4031 :keys "C-c {"
4032 :style toggle :selected org-table-formula-debug]
4033 ["Show Col/Row Numbers"
4034 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4035 :keys "C-c }"
4036 :style toggle :selected org-table-overlay-coordinates]
4037 ))
4038 t))
4040 (defun orgtbl-ctrl-c-ctrl-c (arg)
4041 "If the cursor is inside a table, realign the table.
4042 If it is a table to be sent away to a receiver, do it.
4043 With prefix arg, also recompute table."
4044 (interactive "P")
4045 (let ((pos (point)) action consts-str consts cst const-str)
4046 (save-excursion
4047 (beginning-of-line 1)
4048 (setq action (cond
4052 (cond
4053 ((integerp action)
4054 (goto-char action)
4055 (org-table-maybe-eval-formula)
4056 (if arg
4057 (call-interactively 'org-table-recalculate)
4058 (org-table-maybe-recalculate-line))
4059 (call-interactively 'org-table-align)
4060 (when (orgtbl-send-table 'maybe)
4061 (run-hooks 'orgtbl-after-send-table-hook)))
4062 ((eq action 'recalc)
4063 (save-excursion
4064 (goto-char (point-min))
4066 (setq const-str (substring-no-properties (match-string 1)))
4068 (when consts
4069 (let (e)
4070 (while (setq e (pop consts))
4072 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4073 (setq org-table-formula-constants-local cst)))))
4074 (save-excursion
4075 (beginning-of-line 1)
4077 (if (org-at-table-p)
4078 (org-call-with-arg 'org-table-recalculate t))))
4079 (t (let (orgtbl-mode)
4080 (call-interactively (key-binding "\C-c\C-c")))))))
4082 (defun orgtbl-create-or-convert-from-region (arg)
4083 "Create table or convert region to table, if no conflicting binding.
4084 This installs the table binding `C-c |', but only if there is no
4085 conflicting binding to this key outside orgtbl-mode."
4086 (interactive "P")
4087 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4088 (if cmd
4089 (call-interactively cmd)
4090 (call-interactively 'org-table-create-or-convert-from-region))))
4092 (defun orgtbl-tab (arg)
4093 "Justification and field motion for `orgtbl-mode'."
4094 (interactive "P")
4095 (if arg (org-table-edit-field t)
4096 (org-table-justify-field-maybe)
4097 (org-table-next-field)))
4099 (defun orgtbl-ret ()
4100 "Justification and field motion for `orgtbl-mode'."
4101 (interactive)
4102 (if (bobp)
4103 (newline)
4104 (org-table-justify-field-maybe)
4105 (org-table-next-row)))
4107 (defun orgtbl-self-insert-command (N)
4108 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4109 If the cursor is in a table looking at whitespace, the whitespace is
4110 overwritten, and the table is not marked as requiring realignment."
4111 (interactive "p")
4112 (if (and (org-at-table-p)
4113 (or
4114 (and org-table-auto-blank-field
4115 (member last-command
4116 '(orgtbl-hijacker-command-100
4117 orgtbl-hijacker-command-101
4118 orgtbl-hijacker-command-102
4119 orgtbl-hijacker-command-103
4120 orgtbl-hijacker-command-104
4121 orgtbl-hijacker-command-105
4122 yas/expand))
4123 (org-table-blank-field))
4124 t)
4125 (eq N 1)
4127 (let (org-table-may-need-update)
4128 (goto-char (1- (match-end 0)))
4129 (delete-char -1)
4130 (goto-char (match-beginning 0))
4131 (self-insert-command N))
4132 (setq org-table-may-need-update t)
4133 (let* (orgtbl-mode
4134 a
4135 (cmd (or (key-binding
4136 (or (and (listp function-key-map)
4137 (setq a (assoc last-input-event function-key-map))
4138 (cdr a))
4139 (vector last-input-event)))
4140 'self-insert-command)))
4141 (call-interactively cmd)
4142 (if (and org-self-insert-cluster-for-undo
4143 (eq cmd 'self-insert-command))
4144 (if (not (eq last-command 'orgtbl-self-insert-command))
4145 (setq org-self-insert-command-undo-counter 1)
4146 (if (>= org-self-insert-command-undo-counter 20)
4147 (setq org-self-insert-command-undo-counter 1)
4148 (and (> org-self-insert-command-undo-counter 0)
4149 buffer-undo-list
4150 (not (cadr buffer-undo-list)) ; remove nil entry
4151 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4152 (setq org-self-insert-command-undo-counter
4153 (1+ org-self-insert-command-undo-counter))))))))
4156 "Regular expression matching exponentials as produced by calc.")
4158 (defun orgtbl-export (table target)
4159 (require 'org-exp)
4160 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4162 org-table-last-alignment org-table-last-column-widths
4163 maxcol column)
4164 (if (not (fboundp func))
4165 (error "Cannot export orgtbl table to %s" target))
4166 (setq lines (org-table-clean-before-export lines))
4167 (setq table
4168 (mapcar
4169 (lambda (x)
4170 (if (string-match org-table-hline-regexp x)
4171 'hline
4173 lines))
4174 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4175 table)))
4176 (loop for i from (1- maxcol) downto 0 do
4177 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4178 (setq column (delq nil column))
4179 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4180 (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))
4181 (funcall func table nil)))
4183 (defun orgtbl-gather-send-defs ()
4184 "Gather a plist of :name, :transform, :params for each destination before
4185 a radio table."
4186 (save-excursion
4187 (goto-char (org-table-begin))
4188 (let (rtn)
4189 (beginning-of-line 0)
4190 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4191 (let ((name (org-no-properties (match-string 1)))
4192 (transform (intern (match-string 2)))
4193 (params (if (match-end 3)
4194 (read (concat "(" (match-string 3) ")")))))
4195 (push (list :name name :transform transform :params params)
4196 rtn)
4197 (beginning-of-line 0)))
4198 rtn)))
4200 (defun orgtbl-send-replace-tbl (name txt)
4201 "Find and replace table NAME with TXT."
4202 (save-excursion
4203 (goto-char (point-min))
4204 (unless (re-search-forward
4206 (error "Don't know where to insert translated table"))
4207 (goto-char (match-beginning 0))
4208 (beginning-of-line 2)
4209 (save-excursion
4210 (let ((beg (point)))
4211 (unless (re-search-forward
4212 (concat "END RECEIVE ORGTBL +" name) nil t)
4213 (error "Cannot find end of insertion region"))
4214 (beginning-of-line 1)
4215 (delete-region beg (point))))
4218 ;;;###autoload
4219 (defun org-table-to-lisp (&optional txt)
4220 "Convert the table at point to a Lisp structure.
4221 The structure will be a list. Each item is either the symbol `hline'
4222 for a horizontal separator line, or a list of field values as strings.
4223 The table is taken from the parameter TXT, or from the buffer at point."
4224 (unless txt
4225 (unless (org-at-table-p)
4226 (error "No table at point")))
4227 (let* ((txt (or txt
4228 (buffer-substring-no-properties (org-table-begin)
4229 (org-table-end))))
4232 (mapcar
4233 (lambda (x)
4234 (if (string-match org-table-hline-regexp x)
4235 'hline
4237 lines)))
4239 (defun orgtbl-send-table (&optional maybe)
4240 "Send a transformed version of this table to the receiver position.
4241 With argument MAYBE, fail quietly if no transformation is defined for
4242 this table."
4243 (interactive)
4244 (catch 'exit
4245 (unless (org-at-table-p) (error "Not at a table"))
4246 ;; when non-interactive, we assume align has just happened.
4247 (when (org-called-interactively-p 'any) (org-table-align))
4248 (let ((dests (orgtbl-gather-send-defs))
4249 (txt (buffer-substring-no-properties (org-table-begin)
4250 (org-table-end)))
4251 (ntbl 0))
4252 (unless dests (if maybe (throw 'exit nil)
4253 (error "Don't know how to transform this table")))
4254 (dolist (dest dests)
4255 (let* ((name (plist-get dest :name))
4256 (transform (plist-get dest :transform))
4257 (params (plist-get dest :params))
4258 (skip (plist-get params :skip))
4259 (skipcols (plist-get params :skipcols))
4260 beg
4261 (lines (org-table-clean-before-export
4262 (nthcdr (or skip 0)
4264 (i0 (if org-table-clean-did-remove-column 2 1))
4265 (table (mapcar
4266 (lambda (x)
4267 (if (string-match org-table-hline-regexp x)
4268 'hline
4269 (org-remove-by-index
4271 skipcols i0)))
4272 lines))
4273 (fun (if (= i0 2) 'cdr 'identity))
4274 (org-table-last-alignment
4275 (org-remove-by-index (funcall fun org-table-last-alignment)
4276 skipcols i0))
4277 (org-table-last-column-widths
4278 (org-remove-by-index (funcall fun org-table-last-column-widths)
4279 skipcols i0))
4280 (txt (if (fboundp transform)
4281 (funcall transform table params)
4282 (error "No such transformation function %s" transform))))
4283 (orgtbl-send-replace-tbl name txt))
4284 (setq ntbl (1+ ntbl)))
4285 (message "Table converted and installed at %d receiver location%s"
4286 ntbl (if (> ntbl 1) "s" ""))
4287 (if (> ntbl 0)
4288 ntbl
4289 nil))))
4291 (defun org-remove-by-index (list indices &optional i0)
4292 "Remove the elements in LIST with indices in INDICES.
4293 First element has index 0, or I0 if given."
4294 (if (not indices)
4295 list
4296 (if (integerp indices) (setq indices (list indices)))
4297 (setq i0 (1- (or i0 0)))
4298 (delq :rm (mapcar (lambda (x)
4299 (setq i0 (1+ i0))
4300 (if (memq i0 indices) :rm x))
4301 list))))
4303 (defun orgtbl-toggle-comment ()
4304 "Comment or uncomment the orgtbl at point."
4305 (interactive)
4306 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4307 (re2 (concat "^" orgtbl-line-start-regexp))
4308 (commented (save-excursion (beginning-of-line 1)
4309 (cond ((looking-at re1) t)
4310 ((looking-at re2) nil)
4311 (t (error "Not at an org table")))))
4312 (re (if commented re1 re2))
4313 beg end)
4314 (save-excursion
4315 (beginning-of-line 1)
4316 (while (looking-at re) (beginning-of-line 0))
4317 (beginning-of-line 2)
4318 (setq beg (point))
4319 (while (looking-at re) (beginning-of-line 2))
4320 (setq end (point)))
4321 (comment-region beg end (if commented '(4) nil))))
4323 (defun orgtbl-insert-radio-table ()
4324 "Insert a radio table template appropriate for this major mode."
4325 (interactive)
4326 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4327 (txt (nth 1 e))
4328 name pos)
4329 (unless e (error "No radio table setup defined for %s" major-mode))
4330 (setq name (read-string "Table name: "))
4331 (while (string-match "%n" txt)
4332 (setq txt (replace-match name t t txt)))
4334 (setq pos (point))
4335 (insert txt)
4336 (goto-char pos)))
4338 ;; Dynamically bound input and output for table formatting.
4339 (defvar *orgtbl-table* nil
4340 "Carries the current table through formatting routines.")
4341 (defvar *orgtbl-rtn* nil
4342 "Formatting routines push the output lines here.")
4343 ;; Formatting parameters for the current table section.
4344 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4345 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4346 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4347 (defvar *orgtbl-fmt* nil "Format for each entry.")
4348 (defvar *orgtbl-efmt* nil "Format for numbers.")
4349 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4350 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4351 (defvar *orgtbl-lstart* nil "Text starting a row.")
4352 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4353 (defvar *orgtbl-lend* nil "Text ending a row.")
4354 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4356 (defsubst orgtbl-get-fmt (fmt i)
4357 "Retrieve the format from FMT corresponding to the Ith column."
4358 (if (and (not (functionp fmt)) (consp fmt))
4359 (plist-get fmt i)
4360 fmt))
4362 (defsubst orgtbl-apply-fmt (fmt &rest args)
4363 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4364 (cond ((functionp fmt) (apply fmt args))
4365 (fmt (apply 'format fmt args))
4366 (args (car args))
4367 (t args)))
4369 (defsubst orgtbl-eval-str (str)
4370 "If STR is a function, evaluate it with no arguments."
4371 (if (functionp str)
4372 (funcall str)
4373 str))
4375 (defun orgtbl-format-line (line)
4376 "Format LINE as a table row."
4377 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4378 (let* ((i 0)
4379 (line
4380 (mapcar
4381 (lambda (f)
4382 (setq i (1+ i))
4383 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4384 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4385 (orgtbl-apply-fmt efmt (match-string 1 f)
4386 (match-string 2 f))
4387 f)))
4388 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4389 *orgtbl-default-fmt*)
4390 f)))
4391 line)))
4392 (push (if *orgtbl-lfmt*
4393 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4394 (concat (orgtbl-eval-str *orgtbl-lstart*)
4395 (mapconcat 'identity line *orgtbl-sep*)
4396 (orgtbl-eval-str *orgtbl-lend*)))
4397 *orgtbl-rtn*))))
4399 (defun orgtbl-format-section (section-stopper)
4400 "Format lines until the first occurrence of SECTION-STOPPER."
4401 (let (prevline)
4402 (progn
4403 (while (not (eq (car *orgtbl-table*) section-stopper))
4404 (if prevline (orgtbl-format-line prevline))
4405 (setq prevline (pop *orgtbl-table*)))
4406 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4407 (*orgtbl-lend* *orgtbl-llend*)
4408 (*orgtbl-lfmt* *orgtbl-llfmt*))
4409 (orgtbl-format-line prevline))))))
4411 (defun orgtbl-to-generic (table params)
4412 "Convert the orgtbl-mode TABLE to some other format.
4413 This generic routine can be used for many standard cases.
4414 TABLE is a list, each entry either the symbol `hline' for a horizontal
4415 separator line, or a list of fields for that line.
4416 PARAMS is a property list of parameters that can influence the conversion.
4417 For the generic converter, some parameters are obligatory: you need to
4418 specify either :lfmt, or all of (:lstart :lend :sep).
4420 Valid parameters are
4422 :splice When set to t, return only table body lines, don't wrap
4423 them into :tstart and :tend. Default is nil. When :splice
4424 is non-nil, this also means that the exporter should not look
4425 for and interpret header and footer sections.
4427 :hline String to be inserted on horizontal separation lines.
4428 May be nil to ignore hlines.
4430 :sep Separator between two fields
4431 :remove-nil-lines Do not include lines that evaluate to nil.
4434 Each in the following group may be either a string or a function
4435 of no arguments returning a string:
4436 :tstart String to start the table. Ignored when :splice is t.
4437 :tend String to end the table. Ignored when :splice is t.
4438 :lstart String to start a new table line.
4439 :llstart String to start the last table line, defaults to :lstart.
4440 :lend String to end a table line
4441 :llend String to end the last table line, defaults to :lend.
4443 Each in the following group may be a string, a function of one
4444 argument (the field or line) returning a string, or a plist
4445 mapping columns to either of the above:
4446 :lfmt Format for entire line, with enough %s to capture all fields.
4447 If this is present, :lstart, :lend, and :sep are ignored.
4448 :llfmt Format for the entire last line, defaults to :lfmt.
4449 :fmt A format to be used to wrap the field, should contain
4450 %s for the original field value. For example, to wrap
4452 This may also be a property list with column numbers and
4455 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4456 Same as above, specific for the header lines in the table.
4457 All lines before the first hline are treated as header.
4458 If any of these is not present, the data line value is used.
4460 This may be either a string or a function of two arguments:
4461 :efmt Use this format to print numbers with exponentials.
4462 The format should have %s twice for inserting mantissa
4464 may also be a property list with column numbers and
4465 formats. :fmt will still be applied after :efmt.
4467 In addition to this, the parameters :skip and :skipcols are always handled
4468 directly by `orgtbl-send-table'. See manual."
4469 (interactive)
4471 (let* ((splicep (plist-get params :splice))
4472 (hline (plist-get params :hline))
4473 (remove-nil-linesp (plist-get params :remove-nil-lines))
4474 (remove-newlines (plist-get params :remove-newlines))
4475 (*orgtbl-hline* hline)
4476 (*orgtbl-table* table)
4477 (*orgtbl-sep* (plist-get params :sep))
4478 (*orgtbl-efmt* (plist-get params :efmt))
4479 (*orgtbl-lstart* (plist-get params :lstart))
4480 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4481 (*orgtbl-lend* (plist-get params :lend))
4482 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4483 (*orgtbl-lfmt* (plist-get params :lfmt))
4484 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4485 (*orgtbl-fmt* (plist-get params :fmt))
4486 *orgtbl-rtn*)
4488 ;; Put header
4489 (unless splicep
4490 (when (plist-member params :tstart)
4491 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4492 (if tstart (push tstart *orgtbl-rtn*)))))
4494 ;; Do we have a heading section? If so, format it and handle the
4495 ;; trailing hline.
4496 (if (and (not splicep)
4497 (or (consp (car *orgtbl-table*))
4498 (consp (nth 1 *orgtbl-table*)))
4499 (memq 'hline (cdr *orgtbl-table*)))
4500 (progn
4501 (when (eq 'hline (car *orgtbl-table*))
4502 ;; there is a hline before the first data line
4503 (and hline (push hline *orgtbl-rtn*))
4504 (pop *orgtbl-table*))
4505 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4506 *orgtbl-lstart*))
4507 (*orgtbl-llstart* (or (plist-get params :hllstart)
4508 *orgtbl-llstart*))
4509 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4510 (*orgtbl-llend* (or (plist-get params :hllend)
4511 (plist-get params :hlend) *orgtbl-llend*))
4512 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4513 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4514 (plist-get params :hlfmt) *orgtbl-llfmt*))
4515 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4516 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4517 (orgtbl-format-section 'hline))
4518 (if hline (push hline *orgtbl-rtn*))
4519 (pop *orgtbl-table*)))
4521 ;; Now format the main section.
4522 (orgtbl-format-section nil)
4524 (unless splicep
4525 (when (plist-member params :tend)
4526 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4527 (if tend (push tend *orgtbl-rtn*)))))
4529 (mapconcat (if remove-newlines
4530 (lambda (tend)
4532 'identity)
4533 (nreverse (if remove-nil-linesp
4534 (remq nil *orgtbl-rtn*)
4537 (defun orgtbl-to-tsv (table params)
4538 "Convert the orgtbl-mode table to TAB separated material."
4540 (defun orgtbl-to-csv (table params)
4541 "Convert the orgtbl-mode table to CSV material.
4542 This does take care of the proper quoting of fields with comma or quotes."
4543 (orgtbl-to-generic table (org-combine-plists
4544 '(:sep "," :fmt org-quote-csv-field)
4545 params)))
4547 (defun orgtbl-to-latex (table params)
4548 "Convert the orgtbl-mode TABLE to LaTeX.
4549 TABLE is a list, each entry either the symbol `hline' for a horizontal
4550 separator line, or a list of fields for that line.
4551 PARAMS is a property list of parameters that can influence the conversion.
4552 Supports all parameters from `orgtbl-to-generic'. Most important for
4553 LaTeX are:
4555 :splice When set to t, return only table body lines, don't wrap
4556 them into a tabular environment. Default is nil.
4558 :fmt A format to be used to wrap the field, should contain %s for the
4559 original field value. For example, to wrap everything in dollars,
4562 The format may also be a function that formats its one argument.
4564 :efmt Format for transforming numbers with exponentials. The format
4565 should have %s twice for inserting mantissa and exponent, for
4567 This may also be a property list with column numbers and formats.
4568 The format may also be a function that formats its two arguments.
4570 :llend If you find too much space below the last line of a table,
4573 The general parameters :skip and :skipcols have already been applied when
4574 this function is called."
4575 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4576 org-table-last-alignment ""))
4577 (params2
4578 (list
4583 (orgtbl-to-generic table (org-combine-plists params2 params))))
4585 (defun orgtbl-to-html (table params)
4586 "Convert the orgtbl-mode TABLE to HTML.
4587 TABLE is a list, each entry either the symbol `hline' for a horizontal
4588 separator line, or a list of fields for that line.
4589 PARAMS is a property list of parameters that can influence the conversion.
4590 Currently this function recognizes the following parameters:
4592 :splice When set to t, return only table body lines, don't wrap
4593 them into a <table> environment. Default is nil.
4595 The general parameters :skip and :skipcols have already been applied when
4596 this function is called. The function does *not* use `orgtbl-to-generic',
4597 so you cannot specify parameters for it."
4598 (let* ((splicep (plist-get params :splice))
4599 (html-table-tag org-export-html-table-tag)
4600 html)
4601 ;; Just call the formatter we already have
4602 ;; We need to make text lines for it, so put the fields back together.
4603 (setq html (org-format-org-table-html
4604 (mapcar
4605 (lambda (x)
4606 (if (eq x 'hline)
4607 "|----+----|"
4608 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4609 table)
4610 splicep))
4612 (setq html (replace-match "" t t html)))
4613 html))
4615 (defun orgtbl-to-texinfo (table params)
4616 "Convert the orgtbl-mode TABLE to TeXInfo.
4617 TABLE is a list, each entry either the symbol `hline' for a horizontal
4618 separator line, or a list of fields for that line.
4619 PARAMS is a property list of parameters that can influence the conversion.
4620 Supports all parameters from `orgtbl-to-generic'. Most important for
4621 TeXInfo are:
4623 :splice nil/t When set to t, return only table body lines, don't wrap
4624 them into a multitable environment. Default is nil.
4626 :fmt fmt A format to be used to wrap the field, should contain
4627 %s for the original field value. For example, to wrap
4629 This may also be a property list with column numbers and
4631 Each format also may be a function that formats its one
4632 argument.
4635 are computed automatically from the width of the columns
4636 under org-mode.
4638 The general parameters :skip and :skipcols have already been applied when
4639 this function is called."
4640 (let* ((total (float (apply '+ org-table-last-column-widths)))
4641 (colfrac (or (plist-get params :cf)
4642 (mapconcat
4643 (lambda (x) (format "%.3f" (/ (float x) total)))
4644 org-table-last-column-widths " ")))
4645 (params2
4646 (list
4647 :tstart (concat "@multitable @columnfractions " colfrac)
4648 :tend "@end multitable"
4649 :lstart "@item " :lend "" :sep " @tab "
4650 :hlstart "@headitem ")))
4651 (orgtbl-to-generic table (org-combine-plists params2 params))))
4653 (defun orgtbl-to-orgtbl (table params)
4654 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4655 Useful when slicing one table into many. The :hline, :sep,
4656 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4657 and :tend suppress strings without splicing; they can be set to
4658 provide ORGTBL directives for the generated table."
4659 (let* ((params2
4660 (list
4661 :remove-newlines t
4662 :tstart nil :tend nil
4663 :hline "|---"
4664 :sep " | "
4665 :lstart "| "
4666 :lend " |"))
4667 (params (org-combine-plists params2 params)))
4668 (orgtbl-to-generic table params)))
4670 (defun org-table-get-remote-range (name-or-id form)
4671 "Get a field value or a list of values in a range from table at ID.
4673 NAME-OR-ID may be the name of a table in the current file as set by
4675 will then be used. Alternatively, it may be an ID referring to
4676 any entry, also in a different file. In this case, the first table
4677 in that entry will be referenced.
4681 The return value is either a single string for a single field, or a
4682 list of the fields in the rectangle ."
4683 (save-match-data
4684 (let ((id-loc nil)
4685 ;; Protect a bunch of variables from being overwritten
4686 ;; by the context of the remote table
4687 org-table-column-names org-table-column-name-regexp
4688 org-table-local-parameters org-table-named-field-locations
4689 org-table-current-line-types org-table-current-begin-line
4690 org-table-current-begin-pos org-table-dlines
4691 org-table-current-ncol
4692 org-table-hlines org-table-last-alignment
4693 org-table-last-column-widths org-table-last-alignment
4694 org-table-last-column-widths tbeg
4695 buffer loc)
4696 (setq form (org-table-convert-refs-to-rc form))
4697 (save-excursion
4698 (save-restriction
4699 (widen)
4700 (save-excursion
4701 (goto-char (point-min))
4702 (if (re-search-forward
4704 nil t)
4705 (setq buffer (current-buffer) loc (match-beginning 0))
4706 (setq id-loc (org-id-find name-or-id 'marker))
4707 (unless (and id-loc (markerp id-loc))
4709 (setq buffer (marker-buffer id-loc)
4710 loc (marker-position id-loc))
4711 (move-marker id-loc nil)))
4712 (with-current-buffer buffer
4713 (save-excursion
4714 (save-restriction
4715 (widen)
4716 (goto-char loc)
4717 (forward-char 1)
4719 (not (match-beginning 1)))
4720 (error "Cannot find a table at NAME or ID %s" name-or-id))
4721 (setq tbeg (point-at-bol))
4722 (org-table-get-specials)
4723 (setq form (org-table-formula-substitute-names
4724 (org-table-formula-handle-first/last-rc form)))
4725 (if (and (string-match org-table-range-regexp form)
4726 (> (length (match-string 0 form)) 1))
4727 (save-match-data
4728 (org-table-get-range (match-string 0 form) tbeg 1))
4729 form)))))))))
4731 (provide 'org-table)
4733 ;;; org-table.el ends here