| blob | 82d1e1309b1b28d26c62112f39f2b64b2055b4f9 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the table editor and spreadsheet for Org-mode.
31 ;; Watch out: Here we are talking about two different kind of tables.
32 ;; Most of the code is for the tables created with the Org-mode table editor.
33 ;; Sometimes, we talk about tables created and edited with the table.el
34 ;; Emacs package. We call the former org-type tables, and the latter
35 ;; table.el-type tables.
37 ;;; Code:
53 "Hook for functions attaching to `C-c C-c', if the table is sent.
54 This can be used to add additional functionality after the table is sent
55 to the receiver position, othewise, if table is not sent, the functions
59 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
60 In the optimized version, the table editor takes over all simple keys that
61 normally just insert a character. In tables, the characters are inserted
62 in a way to minimize disturbing the table structure (i.e. in overwrite mode
63 for empty fields). Outside tables, the correct binding of the keys is
64 restored.
66 The default for this option is t if the optimized version is also used in
67 Org-mode. See the variable `org-enable-table-editor' for details. Changing
68 this variable requires a restart of Emacs to become effective."
74 % END RECEIVE ORGTBL %n
76 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
77 | | |
80 @c END RECEIVE ORGTBL %n
81 @ignore
82 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
83 | | |
86 <!-- END RECEIVE ORGTBL %n -->
87 <!--
88 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
89 | | |
91 "Templates for radio tables in different major modes.
92 All occurrences of %n in a template will be replaced with the name of the
93 table, obtained by prompting the user."
100 "Settings for tables in Org-mode."
105 "The default size for newly created tables, Columns x Rows."
111 "Regular expression for recognizing numbers in table columns.
112 If a table column contains mostly numbers, it will be aligned to the
113 right. If not, it will be aligned to the left.
115 The default value of this option is a regular expression which allows
116 anything which looks remotely like a number as used in scientific
117 context. For example, all of the following will be considered a
118 number:
119 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
121 Other options offered by the customize interface are more restrictive."
139 "Fraction of numbers in a column required to make the column align right.
140 In a column all non-white fields are considered. If at least this
141 fraction of fields is matched by `org-table-number-fraction',
142 alignment to the right border applies."
147 "Behavior of tables during editing in Org-mode."
152 "Non-nil means automatically re-align table when pressing TAB or RETURN.
154 removal/insertion."
159 "Non-nil means automatically blank table field when starting to type into it.
160 This only happens when typing immediately after a field motion
161 command (TAB, S-TAB or RET).
162 Only relevant when `org-enable-table-editor' is equal to `optimized'."
167 "Non-nil means automatically exit the follow mode.
168 When nil, the follow mode will stay on and be active in any table
169 the cursor enters. Since the table follow filed mode messes with the
170 window configuration, it is not recommended to set this variable to nil,
171 except maybe locally in a special file that has mostly tables with long
172 fields."
177 "Whether the user should confirm when Org fixes formulas."
184 'safe-local-variable
188 "Non-nil means tab in the last column of a table with jump over a hline.
189 If a horizontal separator line is following the current line,
190 `org-table-next-field' can either create a new row before that line, or jump
191 over the line. When this option is nil, a new line will be created before
192 this line."
197 "Options concerning tables in Org-mode."
202 "Should org-mode work with table references like B3 instead of @3$2?
203 Possible values are:
204 nil never use them
205 from accept as input, do not present for editing
206 t accept as input and present for editing"
221 calc-angle-mode deg
222 calc-prefer-frac nil
223 calc-symbolic-mode nil
225 calc-display-working-message t
226 )
227 "List with Calc mode settings for use in `calc-eval' for table formulas.
228 The list must contain alternating symbols (Calc modes variables and values).
229 Don't remove any of the default settings, just change the values. Org-mode
230 relies on the variables to be present in the list."
235 "Format for the output of calc computations like $1+$2;t.
236 The default value is 'hours, and will output the results as a
237 number of hours. Other allowed values are 'seconds, 'minutes and
238 'days, and the output will be a fraction of seconds, minutes or
239 days."
247 "Non-nil means TAB and RET evaluate a formula in current table field.
248 If the current field starts with an equal sign, it is assumed to be a formula
249 which should be evaluated as described in the manual and in the documentation
250 string of the command `org-table-eval-formula'. This feature requires the
251 Emacs calc package.
252 When this variable is nil, formula calculation is only available through
258 "Non-nil means interpret constants in formulas in tables.
259 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
260 by the value given in `org-table-formula-constants', or by a value obtained
261 from the `constants.el' package."
266 "Alist with constant names and values, for use in table formulas.
267 The car of each element is a name of a constant, without the `$' before it.
268 The cdr is the value as a string. For example, if you'd like to use the
269 speed of light in a formula, you would configure
273 and then use it in an equation like `$1*$c'.
275 Constants can also be defined on a per-file basis using a line like
277 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
284 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
285 Automatically means when TAB or RET or C-c C-c are pressed in the line."
290 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
295 "Non-nil means relative formula references may cross hlines.
296 Here are the allowed values:
298 nil Relative references may not cross hlines. They will reference the
299 field next to the hline instead. Coming from below, the reference
300 will be to the field below the hline. Coming from above, it will be
301 to the field above.
302 t Relative references may cross hlines.
303 error An attempt to cross a hline will throw an error.
305 It is probably good to never set this variable to nil, for the sake of
306 portability of tables."
314 "Options concerning table import and export in Org-mode."
319 "Default export parameters for `org-table-export'.
320 These can be overridden for a specific table by setting the
321 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
322 radio tables for the different export transformations and
323 available parameters."
361 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
362 ;; 1 2 3 4 5
373 "Is this a table line colgroup information?"
377 line)
379 nil
386 "Is this a table line with only alignment/width cookies?"
399 s))))
408 "Use the table.el package to insert a new table.
409 If there is already a table at point, convert between Org-mode tables
410 and table.el tables."
424 "Convert region to table, or create an empty table.
425 If there is an active region, convert it to a table, using the function
426 `org-table-convert-region'. See the documentation of that function
427 to learn how the prefix argument is interpreted to determine the field
428 separator.
429 If there is no such region, create an empty table with `org-table-create'."
436 "Query for a size and insert a table skeleton.
456 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
460 ;; Insert a hline after the first row.
468 "Convert region to a table.
469 The region goes from BEG0 to END0, but these borders will be moved
470 slightly, to make sure a beginning of line in the first line is included.
472 SEPARATOR specifies the field separator in the lines. It can have the
473 following values:
475 '(4) Use the comma as a field separator
476 '(16) Use a TAB as field separator
477 integer When a number, use that many spaces as field separator
478 nil When nil, the command tries to be smart and figure out the
479 separator in the following way:
480 - when each line contains a TAB, assume TAB-separated material
481 - when each line contains a comma, assume CSV material
482 - else, assume one or more SPACE characters as separator."
486 re)
493 ;; Get the right field separator
504 ;; parse the csv stuff
528 "Import FILE as a table.
529 The file is assumed to be tab-separated. Such files can be produced by most
530 spreadsheet and database applications. If no tabs (at least one per line)
531 are found, lines will be split on whitespace into fields."
543 "Export table to a file, with configurable format.
544 Such a file can be imported into a spreadsheet program like Excel.
545 FILE can be the output file name. If not given, it will be taken from
546 a TABLE_EXPORT_FILE property in the current entry or higher up in the
547 hierarchy, or the user will be prompted for a file name.
548 FORMAT can be an export format, of the same kind as it used when
549 `orgtbl-mode' sends a table in a different format. The default format can
550 be found in the variable `org-table-export-default-format', but the function
551 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
552 property, locally or anywhere up in the hierarchy."
564 buf deffmt-readable)
583 "Format: "
588 deffmt-readable)))
601 'hline
604 skipcols i0)))
605 lines))
609 skipcols i0))
612 skipcols i0)))
629 "Marker at the beginning of the table last aligned.
632 "Marker at the end of the table last aligned.
635 "List of flags for flushright alignment, from the last re-alignment.
638 "List of max width of fields in each column.
641 "Non-nil means debug table formulas.
654 "Align the table at point by aligning all vertical bars."
657 ;; Limits of table
660 ;; Current cursor position
666 column
668 rfmt hfmt
676 emptystrings links dates emph raise narrow
677 falign falign1 fmax f1 len c e space)
680 ;; Check if we have links or dates
692 ;; Make sure the link properties are right
694 ;; Make sure the date properties are right
699 ;; Check if we are narrowing any columns
702 org-format-transports-properties-p
707 ;; Get the rows
710 ;; Store the indentation of the first line
713 ;; Mark the hlines by setting the corresponding element to nil
714 ;; At the same time, we remove trailing space.
717 nil
720 l)))
721 lines))
722 ;; Get the data fields by splitting the lines.
727 ;; How many fields in the longest line?
734 ;; A list of empty strings to fill any short rows on output
736 ;; Check for special formatting.
740 ;; Check if there is an explicit width specified
750 ;; Find fields that are wider than fmax, and shorten them
756 'help-echo
757 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
765 xx)))))
766 ;; Get the maximum width for each column
768 lengths)
769 ;; Get the fraction of numbers, to decide about alignment of the column
775 nil
782 ;; Store the alignment of this table, for later editing of single fields
784 org-table-last-column-widths lengths)
786 ;; With invisible characters, `format' does not get the field width right
787 ;; So we need to make these fields wide by hand.
805 ;; Compute the formats needed for output of the table
818 hfmt))
821 ;; This hack is for org-indent, to force redisplay of the
822 ;; line prefix of the first line. Apparently the redisplay
823 ;; is tied to the newline, which is, I think, a bug.
824 ;; To force this redisplay, we remove and re-insert the
825 ;; newline, so that the redisplay engine thinks it belongs
826 ;; to the changed text.
832 ;; Replace the old one
839 ;; Try to move to the old location
847 ))
850 "Find the beginning of the table and return its position.
851 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
855 org-table-border-regexp)
856 nil t))
863 "Find the end of the table and return its position.
864 With argument TABLE-TYPE, go to the end of a table.el-type table."
868 org-table-border-regexp)
869 nil t))
875 "Justify the current field, text to left, number to right.
876 Optional argument NEW may specify text to replace the current field content."
885 ;; This is not the same table, force a full re-align
891 l f n o e)
915 "Go to the next field in the current table, creating new lines as needed.
916 Before doing so, re-align the table if necessary."
921 org-table-may-need-update)
932 org-table-tab-jumps-over-hlines
944 "Go to the previous field in the table.
945 Before doing so, re-align the table if necessary."
950 org-table-may-need-update)
965 "Move to the end of the current table field.
966 If already at or after the end, move to the end of the next table field.
967 With numeric argument N, move N-1 fields forward first."
980 "Move to the beginning of the current table field.
981 If already at or before the beginning, move to the beginning of the
982 previous field.
983 With numeric argument N, move N-1 fields backward first."
997 "Go to the next row (same column) in the current table.
998 Before doing so, re-align the table if necessary."
1006 org-table-may-need-update)
1020 "Copy a field down in the current column.
1021 If the field at the cursor is empty, copy into it the content of
1022 the nearest non-empty field above. With argument N, use the Nth
1023 non-empty field. If the current field is not empty, it is copied
1024 down to the next row, and the cursor is moved with it.
1025 Therefore, repeating this command causes the column to be filled
1026 row-by-row.
1027 If the variable `org-table-copy-increment' is non-nil and the
1028 field is an integer or a timestamp, it will be incremented while
1029 copying. In the case of a timestamp, increment by one day."
1037 txt)
1049 beg t))
1072 "Is point inside a table data field?
1073 I.e. not on a hline or before the first or after the last column?
1074 This actually throws an error, so it aborts the current command."
1080 nil
1082 t))
1088 "Get the field in table line LINE, column COLUMN.
1089 If LINE is larger than the number of data lines in the table, the function
1090 returns nil. However, if COLUMN is too large, we will simply return an
1091 empty string.
1092 If LINE is nil, use the current line.
1093 If column is nil, use the current column."
1100 "Put VALUE into line LINE, column COLUMN.
1101 When ALIGN is set, also realign the table."
1110 "Return the index of the current data line."
1117 cnt))
1120 "Go to the Nth data line in the current table.
1121 Return t when the line exists, nil if it does not exist."
1129 "Blank the current table field or active region."
1146 "Return the value of the field in column N of current row.
1147 N defaults to current field.
1148 If REPLACE is a string, replace field with this value. The return value
1149 is always the old value."
1158 t t))
1160 val)
1164 "Show info about the current field, and highlight any reference at point."
1172 org-table-named-field-locations)))
1192 dline col
1194 dline col ref1
1196 ;; FIXME: formula info not correct if special table line
1206 "Find out which column we are in."
1216 cnt)))
1219 "Find out what table data line we are in.
1220 Only data lines count for this."
1232 cnt)))
1235 "Move the cursor to the Nth column in the current table line.
1236 With optional argument ON-DELIM, stop with point before the left delimiter
1237 of the field.
1238 If there are less than N fields, just go to after the last delimiter.
1239 However, when FORCE is non-nil, create new columns if necessary."
1249 t)))))
1257 "Insert a new column into the table."
1265 ;; Current cursor position
1271 nil
1285 "Find a data line in the current table, which is needed for column commands."
1288 t
1299 t
1304 "Turn a buffer line number into a data line number.
1305 If there is no data line in this line, return nil.
1306 If there is no matchin dline (most likely te refrence was a hline), the
1307 first dline below it is used. When ABOVE is non-nil, the one above is used."
1310 i)
1323 nil))
1326 "Delete a column from the table."
1335 ;; Current cursor position
1341 nil
1358 "Move column to the right."
1362 "Move column to the left."
1367 "Move the current column to the right. With arg LEFT, move to the left."
1377 ;; Current cursor position
1387 nil
1406 "Move table row down."
1410 "Move table row up."
1415 "Move the current table line down. With arg UP, move it up."
1424 txt hline2p)
1448 "Insert a new row above the current line into the table.
1449 With prefix ARG, insert below the current line."
1455 ;; Fix the first field if necessary
1469 "Insert a horizontal-line below the current line into the table.
1470 With prefix ABOVE, insert above the current line."
1492 "Insert a hline and move to the row below that line."
1506 In particular, this does handle wide and invisible characters."
1508 ;; It's a hline, just map the characters
1514 t t s)))
1515 s))
1518 "Delete the current row or horizontal line from the table."
1533 "Sort table lines according to the column at point.
1535 The position of point indicates the column to be used for
1536 sorting, and the range of lines is the range between the nearest
1537 horizontal separator lines, or the entire table of no such lines
1538 exist. If point is before the first column, you will be prompted
1539 for the sorting column. If there is an active region, the mark
1540 specifies the first line and the sorting column, while point
1541 should be in the last line to be included into the sorting.
1543 The command then prompts for the sorting type which can be
1544 alphabetically, numerically, or by time (as given in a time stamp
1545 in the field). Sorting in reverse order is also possible.
1547 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1549 If SORTING-TYPE is specified when this function is called from a Lisp
1550 program, no prompting will take place. SORTING-TYPE must be a character,
1551 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1552 should be done in reverse order."
1556 beg end bcol ecol tend tbeg column lns pos)
1601 x))
1614 "Copy region in table to the clipboard and blank all relevant fields.
1615 If there is no active region, use just the field at point."
1622 "Copy rectangular region in table to clipboard.
1623 A special clipboard is used which can only be accessed
1624 with `org-table-paste-rectangle'."
1628 current-prefix-arg))
1630 region cols
1656 org-table-clip))
1659 "Paste a rectangular region into a table.
1660 The upper right corner ends up in the current field. All involved fields
1661 will be overwritten. If the rectangle does not fit into the present table,
1662 the table is enlarged as needed. The process ignores horizontal separator
1663 lines."
1673 c cols field)
1689 "Convert from `org-mode' table to table.el and back.
1690 Obviously, this only works within limits. When an Org-mode table is
1691 converted to table.el, all horizontal separator lines get lost, because
1692 table.el uses these as cell boundaries and has no notion of horizontal lines.
1693 A table.el table can be converted to an Org-mode table only if it does not
1694 do row or column spanning. Multiline cells will become multiple cells.
1695 Beware, Org-mode does not test if the table can be successfully converted - it
1696 blindly applies a recipe that works for simple tables."
1700 ;; convert to Org-mode table
1709 ;; convert to table.el table
1712 ;; first, get rid of all horizontal lines
1716 ;; insert a hline before first
1720 ;; insert a hline after each line
1725 ;; replace "+" at beginning and ending of hlines
1734 "Wrap several fields in a column like a paragraph.
1735 This is useful if you'd like to spread the contents of a field over several
1736 lines, in order to keep the table compact.
1738 If there is an active region, and both point and mark are in the same column,
1739 the text in the column is wrapped to minimum width for the given number of
1740 lines. Generally, this makes the table more compact. A prefix ARG may be
1742 formats the selected text to two lines. If the region was longer than two
1743 lines, the remaining lines remain empty. A negative prefix argument reduces
1744 the current number of lines by that amount. The wrapped text is pasted back
1745 into the table. If you formatted it to more lines than it was before, fields
1746 further down in the table get overwritten - so you might need to make space in
1747 the table first.
1749 If there is no region, the current field is split at the cursor position and
1750 the text fragment to the right of the cursor is prepended to the field one
1751 line down.
1753 If there is no region, but you specify a prefix ARG, the current field gets
1754 blank, and the content is appended to the field above."
1758 ;; There is a region: fill as a paragraph
1762 nlines)
1769 arg)
1773 nil nlines)))
1777 ;; No region, split the current field at point
1781 ;; combine with field above
1791 ;; split field
1804 "Edit table field in a different window.
1805 This is mainly useful for fields that contain hidden parts.
1807 it can be edited in place."
1816 display t intangible t))
1829 p)
1845 intangible t))
1853 "Finish editing a table data field.
1854 Remove all newline characters, insert the result into the table, realign
1855 the table and kill the editing buffer."
1859 text)
1876 "Minor mode to make the table field editor window follow the cursor.
1877 When this mode is active, the field editor window will always show the
1878 current field. The mode exits automatically when the cursor leaves the
1879 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1880 nil " TblFollow" nil
1896 ;; We have left the table, exit the follow mode
1907 "Sum numbers in region of current table column.
1908 The result will be displayed in the echo area, and will be available
1911 If there is an active region, it is interpreted as a rectangle and all
1912 numbers in that rectangle will be summed. If there is no active
1913 region and point is located in a table column, sum all numbers in that
1914 column.
1916 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1917 numbers are assumed to be times as well (in decimal hours) and the
1918 numbers are added as such.
1920 If NLAST is a number, only the NLAST fields will actually be summed."
1947 items1)))
1954 s diff)
1962 sres))))
1985 "Return the formula active for the current field.
1986 Assumes that specials are in place.
1987 If KEY is given, return the key to this formula.
1991 org-table-named-field-locations)))
2005 "Read a formula from the minibuffer, offer stored formula as default.
2006 When NAMED is non-nil, look for a named equation."
2010 org-table-named-field-locations)))
2017 name
2018 ref)
2028 stored)
2030 equation)
2037 scol))
2039 'org-table-formula-history
2040 )))))
2041 mustsave)
2043 ;; remove formula
2050 ;; We set the column equation, delete the named one.
2052 mustsave t))
2058 eq))
2061 "Store the list of formulas below the current table."
2067 ;; don't overwrite TBLFM, we might use text properties to store stuff
2083 ;; Fake a high number to make sure this is sorted at the end.
2090 a)
2100 "Compare two formulas for sorting."
2106 "Return an alist with the stored formulas directly after current table."
2115 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2134 "Modify the equations after the table structure has been edited.
2136 For all numbers larger than LIMIT, shift them by DELTA."
2147 s n a)
2160 t t)))))))))
2163 "Get the column names and local parameters for this table."
2166 names name fields fields1 field cnt
2167 c v l line col types dlines hlines last-dline)
2169 org-table-local-parameters nil
2170 org-table-named-field-locations nil
2171 org-table-current-begin-line nil
2172 org-table-current-begin-pos nil
2173 org-table-current-line-types nil
2192 org-table-local-parameters))))
2208 ;; Analyse the line types
2212 l org-table-current-begin-line)
2229 al al2)
2241 If yes, store the formula and apply it."
2242 ;; We already know we are in a table. Get field will only return a formula
2243 ;; when appropriate. It might return a separator line, but no problem.
2246 named eq)
2257 "List of commands triggering the recalculation of a line.
2270 "Rotate the recalculation mark in the first column.
2271 If in any row, the first field is not consistent with a mark,
2272 insert a new column for the markers.
2273 When there is an active region, change all the lines in the region,
2274 after prompting for the marking character.
2275 After each change, a message will be displayed indicating the meaning
2276 of the new mark."
2291 epos new)
2298 newchar))
2331 "Recompute the current line if marked for it, and if we haven't just done it."
2351 modes)
2354 suppress-align suppress-const
2355 suppress-store suppress-analysis)
2356 "Replace the table field value at the cursor by the result of a calculation.
2358 This function makes use of Dave Gillespie's Calc package, in my view the
2359 most exciting program ever written for GNU Emacs. So you need to have Calc
2360 installed in order to use this function.
2362 In a table, this command replaces the value in the current field with the
2364 formula, by storing it in a special line below the table. When called
2365 with a `C-u' prefix, the current field must be a named field, and the
2366 formula is installed as valid in only this specific field.
2368 When called with two `C-u' prefixes, insert the active equation
2369 for the field back into the current field, so that it can be
2371 to check the referenced fields.
2373 When called, the command first prompts for a formula, which is read in
2374 the minibuffer. Previously entered formulas are available through the
2375 history list, and the last used formula is offered as a default.
2376 These stored formulas are adapted correctly when moving, inserting, or
2377 deleting columns with the corresponding commands.
2379 The formula can be any algebraic expression understood by the Calc package.
2380 For details, see the Org-mode manual.
2382 This function can also be called from Lisp programs and offers
2383 additional arguments: EQUATION can be the formula to apply. If this
2384 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2385 used to speed-up recursive calls by by-passing unnecessary aligns.
2386 SUPPRESS-CONST suppresses the interpretation of constants in the
2387 formula, assuming that this has been done already outside the function.
2388 SUPPRESS-STORE means the formula should not be stored, either because
2389 it is already stored, or because it is a modified equation that should
2390 not overwrite the stored one."
2406 equation
2412 n form form0 formrpl formrg bw fmt x ev orig c lispp literal duration)
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
2595 prop value)))
2598 "Get a calc vector from a column, according to descriptor DESC.
2599 Optional arguments TBEG and COL can give the beginning of the table and
2600 the current column, to avoid unnecessary parsing.
2602 HIGHLIGHT means just highlight the range.
2604 When CORNERS-ONLY is set, only return the corners of the range as
2605 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2606 in the buffer and column1 and column2 are table column numbers."
2613 beg end c1 c2 r1 r2 rangep tmp)
2630 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2637 ;; just one field
2644 ;; A range, return a vector
2645 ;; First sort the numbers to get a regular ractangle
2649 ;; Only return the corners of the range
2651 ;; Copy the range values into a list
2665 ;; return string representation of calc vector
2670 "Analyze descriptor DESC and retrieve the corresponding line number.
2671 The cursor is currently in line CLINE, the table begins in line BLINE,
2672 and TABLE is a vector with line types."
2680 ;; 1 2 3 4 5 6
2700 nil hn cline desc)))
2703 rel on cline desc)))
2707 "FIXME: Needs more documentation."
2720 nil))
2721 t)))
2725 desc cline)
2726 i)))
2731 s))
2734 "Convert list ELEMENTS to something appropriate to insert into formula.
2735 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2736 NUMBERS indicates that everything should be converted to numbers.
2737 LISPP means to return something appropriate for a Lisp list."
2741 elements
2750 elements))))
2756 x
2762 elements
2766 "Recalculate the current table line by applying all stored formulas.
2767 With prefix arg ALL, do this for all lines in the table.
2768 With the prefix argument ALL is `(16)' \
2770 it is the symbol `iterate', recompute the table until it no longer changes.
2771 If NOALIGN is not nil, do not re-align the table after the computations
2772 are done. This is typically used internally to save time, if it is
2773 known that the table will be realigned a little later anyway."
2788 seen-fields lhs1
2790 ;; Insert constants in all formulas
2806 eqlist))
2807 ;; Split the equation list
2813 ;; Expand ranges in lhs of formulas
2816 ;; Get the correct line range to process
2822 ;; This is a table with marked lines, compute selected lines
2824 ;; Move forward to the first non-header line
2835 ;; First find the named fields, and mark them untouchable.
2836 ;; Also check if several field/range formulas try to set the same field.
2855 name)))
2865 ;; Now evaluate the column formulas, but skip fields covered by
2866 ;; field formulas
2870 ;; Unprotected line, recalculate
2882 ;; Now evaluate the field formulas
2896 ;; back to initial position
2904 "Recalculate the table until it does not change anymore.
2905 The maximun number of iterations is 10, but you can chose a different value
2906 with the prefix ARG."
2911 thistbl)
2926 "Recalculate all tables in the current buffer."
2934 "Iterate all tables in the buffer, to converge inter-table dependencies."
2939 c1
2956 "Expand list of formulas.
2957 If some of the RHS in the formulas are ranges or a row reference, expand
2958 them to individual field equations for each field."
2964 ;; This just refers to one fixed field
2967 ;; This just refers to one fixed named field
2989 "Replace @<, @>, $<, $> with first/last row/column of the table.
2990 So @< and $< will always be replaced with @1 and $1, respectively.
2991 The advantage of these special markers are that structure editing of
2992 the table will not change them, while @1 and $1 will be modified
2993 when a line/row is swaped out of that privileged position. So for
2994 formulas that use a range of rows or columns, it may often be better
2996 borders of the table using the @< @> $< $> makers."
3001 org-table-current-ncol)
3005 len
3011 s)
3014 "Replace $const with values in string F."
3016 ;; First, check for column names
3021 ;; Parameters and constants
3023 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3033 f))
3036 "Find the value for a parameter or constant in a formula.
3037 Parameters get priority."
3068 map))
3075 "--"
3078 "--"
3079 "Shift Reference at Point"
3084 "-"
3085 "Change Test Row for Column Formulas"
3088 "--"
3093 org-table-overlay-coordinates)]
3094 "--"
3101 "Edit the formulas of the current table in a separate buffer."
3117 entry s type title)
3120 ;; Keep global-font-lock-mode from turning on font-lock-mode
3161 "Convert a formula from internal to user representation."
3164 s))
3167 "Convert a formula from user to internal representation."
3170 s))
3173 "Convert spreadsheet references from A7 to @7$28.
3174 Works for single references, but also for entire formulas and even the
3175 full TBLFM line."
3177 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3180 ;; format match, just advance
3185 ;; 3.e5 or something like this.
3188 ;; (member (match-string 1 s)
3189 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3190 )
3191 ;; function name, just advance
3201 t t s)))))
3202 s))
3205 "Convert spreadsheet references from to @7$28 to AB7.
3206 Works for single references, but also for entire formulas and even the
3207 full TBLFM line."
3214 t t s)))
3219 t nil s)))
3220 s)
3223 "Convert a base 26 number represented by letters into an integer.
3224 For example: AB -> 28."
3230 n))
3233 "Convert an integer into a base 26 number represented by letters.
3234 For example: 28 -> AB."
3239 s))
3242 "Convert a time string into numerical duration in seconds.
3243 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3244 If S is a string representing a number, keep this number."
3267 "Convert a number of seconds to a time string.
3268 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3269 minutes or seconds."
3281 "Convert all references in this buffer, using FUNCTION."
3291 "Convert all references in the buffer from B3 to @3$2 and back."
3301 "Shift the reference at point one row/hline up."
3305 "Shift the reference at point one row/hline down."
3309 "Shift the reference at point one field to the left."
3313 "Shift the reference at point one field to the right."
3324 ;; A B3-like reference
3330 ;; An internal reference
3336 "Re-match the group N, and replace it with the shifted reference."
3341 t t)))
3344 "Shift a reference part REF.
3345 If DECR is set, decrease the references row/column, else increase.
3346 If HLINE is set, this may be a hline reference, it certainly is not
3347 a translation reference."
3376 "Toggle the display of coordinates in the referenced table."
3385 "Parse the buffer for formula definitions and install them.
3386 With prefix ARG, apply the new formulas to the table."
3396 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3397 nil t)
3421 "Abort editing formulas, without installing the changes."
3432 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3473 "Show the location/value of the $ expression at point."
3482 var name e what match dest)
3487 "$1.."
3570 ;; column number
3598 org-table-fedit-scroll-down))))
3609 "Make sure the cursor is in a dataline in a table."
3618 p1 p2)))
3623 "Move cursor one line up in the window showing the table."
3628 "Move cursor one line down in the window showing the table."
3633 "Move the cursor in the window showing the table.
3634 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3659 "Add a new overlay."
3665 "Highlight rectangular region in a table."
3669 l1 c1 l2 c2 tmp)
3693 "Remove the rectangle overlays."
3704 "Add overlays to the table at point, to show row/column coordinates."
3733 "Toggle the display of Row/Column numbers in tables."
3745 "Toggle the formula debugger in tables."
3751 ;;; The orgtbl minor mode
3753 ;; Define a minor mode which can be used in other modes in order to
3754 ;; integrate the org-mode table editor.
3756 ;; This is really a hack, because the org-mode table editor uses several
3757 ;; keys which normally belong to the major mode, for example the TAB and
3758 ;; RET keys. Here is how it works: The minor mode defines all the keys
3759 ;; necessary to operate the table editor, but wraps the commands into a
3760 ;; function which tests if the cursor is currently inside a table. If that
3761 ;; is the case, the table editor command is executed. However, when any of
3762 ;; those keys is used outside a table, the function uses `key-binding' to
3763 ;; look up if the key has an associated command in another currently active
3764 ;; keymap (minor modes, major mode, global), and executes that command.
3765 ;; There might be problems if any of the keys used by the table editor is
3766 ;; otherwise used as a prefix key.
3768 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3769 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3770 ;; addresses this by checking explicitly for both bindings.
3772 ;; The optimized version (see variable `orgtbl-optimized') takes over
3773 ;; all keys which are bound to `self-insert-command' in the *global map*.
3774 ;; Some modes bind other commands to simple characters, for example
3775 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3776 ;; active, this binding is ignored inside tables and replaced with a
3777 ;; modified self-insert.
3783 ;;;###autoload
3785 "Unconditionally turn on `orgtbl-mode'."
3800 ;; Install it as a minor mode.
3804 ;;;###autoload
3806 "The `org-mode' table editor as a minor mode for use in other modes."
3811 ;; Exit without error, in case some hook functions calls this
3812 ;; by accident in org-mode.
3816 ;; Make sure we are first in minor-mode-map-alist
3818 ;; FIXME: maybe it should use emulation-mode-map-alists?
3825 auto-fill-inhibit-regexp)
3829 auto-fill-inhibit-regexp)
3830 orgtbl-line-start-regexp))
3848 "Remove all properties related to narrow-column invisibility."
3861 "Create a function for binding in the table minor mode.
3862 FUN is the command to call inside a table. N is used to create a unique
3863 command name. KEYS are keys that should be checked in for a command
3864 to execute outside of tables."
3870 "Outside of tables, run the binding of `"
3882 keys)
3886 "Error when there is no default binding for a table key."
3891 "Setup orgtbl keymaps."
3921 elt key fun cmd)
3929 ;; Special treatment needed for TAB and RET
3949 [(tab)] "\C-i")))
3951 (org-defkey orgtbl-mode-map [backtab]
3953 [backtab] [S-iso-lefttab] [(shift tab)]
3954 [(tab)] "\C-i"))
3956 (org-defkey orgtbl-mode-map "\M-\C-m"
3957 (orgtbl-make-binding 'org-table-wrap-region 105
3958 "\M-\C-m" [(meta return)]))
3959 (org-defkey orgtbl-mode-map [(meta return)]
3960 (orgtbl-make-binding 'org-table-wrap-region 106
3961 [(meta return)] "\M-\C-m"))
3963 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3964 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3966 (when orgtbl-optimized
3967 ;; If the user wants maximum table support, we need to hijack
3968 ;; some standard editing functions
3969 (org-remap orgtbl-mode-map
3970 'self-insert-command 'orgtbl-self-insert-command
3971 'delete-char 'org-delete-char
3972 'delete-backward-char 'org-delete-backward-char)
3973 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3974 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3975 '("OrgTbl"
3976 ["Create or convert" org-table-create-or-convert-from-region
3977 :active (not (org-at-table-p)) :keys "C-c |" ]
3978 "--"
3979 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3980 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3981 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3982 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3983 "--"
3984 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3985 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3986 ["Copy Field from Above"
3987 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3988 "--"
3989 ("Column"
3990 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3991 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3992 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3993 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3994 ("Row"
3995 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3996 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3997 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3998 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3999 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4000 "--"
4001 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4002 ("Rectangle"
4003 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4004 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4005 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4006 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4007 "--"
4008 ("Radio tables"
4009 ["Insert table template" orgtbl-insert-radio-table
4010 (assq major-mode orgtbl-radio-table-templates)]
4011 ["Comment/uncomment table" orgtbl-toggle-comment t])
4012 "--"
4013 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4014 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4015 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4016 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4017 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4018 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4019 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4020 ["Sum Column/Rectangle" org-table-sum
4021 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4022 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4023 ["Debug Formulas"
4024 org-table-toggle-formula-debugger :active (org-at-table-p)
4025 :keys "C-c {"
4026 :style toggle :selected org-table-formula-debug]
4027 ["Show Col/Row Numbers"
4028 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4029 :keys "C-c }"
4030 :style toggle :selected org-table-overlay-coordinates]
4031 ))
4032 t))
4034 (defun orgtbl-ctrl-c-ctrl-c (arg)
4035 "If the cursor is inside a table, realign the table.
4036 If it is a table to be sent away to a receiver, do it.
4037 With prefix arg, also recompute table."
4038 (interactive "P")
4039 (let ((pos (point)) action consts-str consts cst const-str)
4040 (save-excursion
4041 (beginning-of-line 1)
4042 (setq action (cond
4046 (cond
4047 ((integerp action)
4048 (goto-char action)
4049 (org-table-maybe-eval-formula)
4050 (if arg
4051 (call-interactively 'org-table-recalculate)
4052 (org-table-maybe-recalculate-line))
4053 (call-interactively 'org-table-align)
4054 (when (orgtbl-send-table 'maybe)
4055 (run-hooks 'orgtbl-after-send-table-hook)))
4056 ((eq action 'recalc)
4057 (save-excursion
4058 (goto-char (point-min))
4060 (setq const-str (substring-no-properties (match-string 1)))
4062 (when consts
4063 (let (e)
4064 (while (setq e (pop consts))
4066 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4067 (setq org-table-formula-constants-local cst)))))
4068 (save-excursion
4069 (beginning-of-line 1)
4071 (if (org-at-table-p)
4072 (org-call-with-arg 'org-table-recalculate t))))
4073 (t (let (orgtbl-mode)
4074 (call-interactively (key-binding "\C-c\C-c")))))))
4076 (defun orgtbl-create-or-convert-from-region (arg)
4077 "Create table or convert region to table, if no conflicting binding.
4078 This installs the table binding `C-c |', but only if there is no
4079 conflicting binding to this key outside orgtbl-mode."
4080 (interactive "P")
4081 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4082 (if cmd
4083 (call-interactively cmd)
4084 (call-interactively 'org-table-create-or-convert-from-region))))
4086 (defun orgtbl-tab (arg)
4087 "Justification and field motion for `orgtbl-mode'."
4088 (interactive "P")
4089 (if arg (org-table-edit-field t)
4090 (org-table-justify-field-maybe)
4091 (org-table-next-field)))
4093 (defun orgtbl-ret ()
4094 "Justification and field motion for `orgtbl-mode'."
4095 (interactive)
4096 (if (bobp)
4097 (newline)
4098 (org-table-justify-field-maybe)
4099 (org-table-next-row)))
4101 (defun orgtbl-self-insert-command (N)
4102 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4103 If the cursor is in a table looking at whitespace, the whitespace is
4104 overwritten, and the table is not marked as requiring realignment."
4105 (interactive "p")
4106 (if (and (org-at-table-p)
4107 (or
4108 (and org-table-auto-blank-field
4109 (member last-command
4110 '(orgtbl-hijacker-command-100
4111 orgtbl-hijacker-command-101
4112 orgtbl-hijacker-command-102
4113 orgtbl-hijacker-command-103
4114 orgtbl-hijacker-command-104
4115 orgtbl-hijacker-command-105
4116 yas/expand))
4117 (org-table-blank-field))
4118 t)
4119 (eq N 1)
4121 (let (org-table-may-need-update)
4122 (goto-char (1- (match-end 0)))
4123 (delete-char -1)
4124 (goto-char (match-beginning 0))
4125 (self-insert-command N))
4126 (setq org-table-may-need-update t)
4127 (let* (orgtbl-mode
4128 a
4129 (cmd (or (key-binding
4130 (or (and (listp function-key-map)
4131 (setq a (assoc last-input-event function-key-map))
4132 (cdr a))
4133 (vector last-input-event)))
4134 'self-insert-command)))
4135 (call-interactively cmd)
4136 (if (and org-self-insert-cluster-for-undo
4137 (eq cmd 'self-insert-command))
4138 (if (not (eq last-command 'orgtbl-self-insert-command))
4139 (setq org-self-insert-command-undo-counter 1)
4140 (if (>= org-self-insert-command-undo-counter 20)
4141 (setq org-self-insert-command-undo-counter 1)
4142 (and (> org-self-insert-command-undo-counter 0)
4143 buffer-undo-list
4144 (not (cadr buffer-undo-list)) ; remove nil entry
4145 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4146 (setq org-self-insert-command-undo-counter
4147 (1+ org-self-insert-command-undo-counter))))))))
4150 "Regular expression matching exponentials as produced by calc.")
4152 (defun orgtbl-export (table target)
4153 (require 'org-exp)
4154 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4156 org-table-last-alignment org-table-last-column-widths
4157 maxcol column)
4158 (if (not (fboundp func))
4159 (error "Cannot export orgtbl table to %s" target))
4160 (setq lines (org-table-clean-before-export lines))
4161 (setq table
4162 (mapcar
4163 (lambda (x)
4164 (if (string-match org-table-hline-regexp x)
4165 'hline
4167 lines))
4168 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4169 table)))
4170 (loop for i from (1- maxcol) downto 0 do
4171 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4172 (setq column (delq nil column))
4173 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4174 (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))
4175 (funcall func table nil)))
4177 (defun orgtbl-gather-send-defs ()
4178 "Gather a plist of :name, :transform, :params for each destination before
4179 a radio table."
4180 (save-excursion
4181 (goto-char (org-table-begin))
4182 (let (rtn)
4183 (beginning-of-line 0)
4184 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4185 (let ((name (org-no-properties (match-string 1)))
4186 (transform (intern (match-string 2)))
4187 (params (if (match-end 3)
4188 (read (concat "(" (match-string 3) ")")))))
4189 (push (list :name name :transform transform :params params)
4190 rtn)
4191 (beginning-of-line 0)))
4192 rtn)))
4194 (defun orgtbl-send-replace-tbl (name txt)
4195 "Find and replace table NAME with TXT."
4196 (save-excursion
4197 (goto-char (point-min))
4198 (unless (re-search-forward
4200 (error "Don't know where to insert translated table"))
4201 (goto-char (match-beginning 0))
4202 (beginning-of-line 2)
4203 (save-excursion
4204 (let ((beg (point)))
4205 (unless (re-search-forward
4206 (concat "END RECEIVE ORGTBL +" name) nil t)
4207 (error "Cannot find end of insertion region"))
4208 (beginning-of-line 1)
4209 (delete-region beg (point))))
4212 ;;;###autoload
4213 (defun org-table-to-lisp (&optional txt)
4214 "Convert the table at point to a Lisp structure.
4215 The structure will be a list. Each item is either the symbol `hline'
4216 for a horizontal separator line, or a list of field values as strings.
4217 The table is taken from the parameter TXT, or from the buffer at point."
4218 (unless txt
4219 (unless (org-at-table-p)
4220 (error "No table at point")))
4221 (let* ((txt (or txt
4222 (buffer-substring-no-properties (org-table-begin)
4223 (org-table-end))))
4226 (mapcar
4227 (lambda (x)
4228 (if (string-match org-table-hline-regexp x)
4229 'hline
4231 lines)))
4233 (defun orgtbl-send-table (&optional maybe)
4234 "Send a transformed version of this table to the receiver position.
4235 With argument MAYBE, fail quietly if no transformation is defined for
4236 this table."
4237 (interactive)
4238 (catch 'exit
4239 (unless (org-at-table-p) (error "Not at a table"))
4240 ;; when non-interactive, we assume align has just happened.
4241 (when (org-called-interactively-p 'any) (org-table-align))
4242 (let ((dests (orgtbl-gather-send-defs))
4243 (txt (buffer-substring-no-properties (org-table-begin)
4244 (org-table-end)))
4245 (ntbl 0))
4246 (unless dests (if maybe (throw 'exit nil)
4247 (error "Don't know how to transform this table")))
4248 (dolist (dest dests)
4249 (let* ((name (plist-get dest :name))
4250 (transform (plist-get dest :transform))
4251 (params (plist-get dest :params))
4252 (skip (plist-get params :skip))
4253 (skipcols (plist-get params :skipcols))
4254 beg
4255 (lines (org-table-clean-before-export
4256 (nthcdr (or skip 0)
4258 (i0 (if org-table-clean-did-remove-column 2 1))
4259 (table (mapcar
4260 (lambda (x)
4261 (if (string-match org-table-hline-regexp x)
4262 'hline
4263 (org-remove-by-index
4265 skipcols i0)))
4266 lines))
4267 (fun (if (= i0 2) 'cdr 'identity))
4268 (org-table-last-alignment
4269 (org-remove-by-index (funcall fun org-table-last-alignment)
4270 skipcols i0))
4271 (org-table-last-column-widths
4272 (org-remove-by-index (funcall fun org-table-last-column-widths)
4273 skipcols i0))
4274 (txt (if (fboundp transform)
4275 (funcall transform table params)
4276 (error "No such transformation function %s" transform))))
4277 (orgtbl-send-replace-tbl name txt))
4278 (setq ntbl (1+ ntbl)))
4279 (message "Table converted and installed at %d receiver location%s"
4280 ntbl (if (> ntbl 1) "s" ""))
4281 (if (> ntbl 0)
4282 ntbl
4283 nil))))
4285 (defun org-remove-by-index (list indices &optional i0)
4286 "Remove the elements in LIST with indices in INDICES.
4287 First element has index 0, or I0 if given."
4288 (if (not indices)
4289 list
4290 (if (integerp indices) (setq indices (list indices)))
4291 (setq i0 (1- (or i0 0)))
4292 (delq :rm (mapcar (lambda (x)
4293 (setq i0 (1+ i0))
4294 (if (memq i0 indices) :rm x))
4295 list))))
4297 (defun orgtbl-toggle-comment ()
4298 "Comment or uncomment the orgtbl at point."
4299 (interactive)
4300 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4301 (re2 (concat "^" orgtbl-line-start-regexp))
4302 (commented (save-excursion (beginning-of-line 1)
4303 (cond ((looking-at re1) t)
4304 ((looking-at re2) nil)
4305 (t (error "Not at an org table")))))
4306 (re (if commented re1 re2))
4307 beg end)
4308 (save-excursion
4309 (beginning-of-line 1)
4310 (while (looking-at re) (beginning-of-line 0))
4311 (beginning-of-line 2)
4312 (setq beg (point))
4313 (while (looking-at re) (beginning-of-line 2))
4314 (setq end (point)))
4315 (comment-region beg end (if commented '(4) nil))))
4317 (defun orgtbl-insert-radio-table ()
4318 "Insert a radio table template appropriate for this major mode."
4319 (interactive)
4320 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4321 (txt (nth 1 e))
4322 name pos)
4323 (unless e (error "No radio table setup defined for %s" major-mode))
4324 (setq name (read-string "Table name: "))
4325 (while (string-match "%n" txt)
4326 (setq txt (replace-match name t t txt)))
4328 (setq pos (point))
4329 (insert txt)
4330 (goto-char pos)))
4332 ;; Dynamically bound input and output for table formatting.
4333 (defvar *orgtbl-table* nil
4334 "Carries the current table through formatting routines.")
4335 (defvar *orgtbl-rtn* nil
4336 "Formatting routines push the output lines here.")
4337 ;; Formatting parameters for the current table section.
4338 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4339 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4340 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4341 (defvar *orgtbl-fmt* nil "Format for each entry.")
4342 (defvar *orgtbl-efmt* nil "Format for numbers.")
4343 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4344 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4345 (defvar *orgtbl-lstart* nil "Text starting a row.")
4346 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4347 (defvar *orgtbl-lend* nil "Text ending a row.")
4348 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4350 (defsubst orgtbl-get-fmt (fmt i)
4351 "Retrieve the format from FMT corresponding to the Ith column."
4352 (if (and (not (functionp fmt)) (consp fmt))
4353 (plist-get fmt i)
4354 fmt))
4356 (defsubst orgtbl-apply-fmt (fmt &rest args)
4357 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4358 (cond ((functionp fmt) (apply fmt args))
4359 (fmt (apply 'format fmt args))
4360 (args (car args))
4361 (t args)))
4363 (defsubst orgtbl-eval-str (str)
4364 "If STR is a function, evaluate it with no arguments."
4365 (if (functionp str)
4366 (funcall str)
4367 str))
4369 (defun orgtbl-format-line (line)
4370 "Format LINE as a table row."
4371 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4372 (let* ((i 0)
4373 (line
4374 (mapcar
4375 (lambda (f)
4376 (setq i (1+ i))
4377 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4378 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4379 (orgtbl-apply-fmt efmt (match-string 1 f)
4380 (match-string 2 f))
4381 f)))
4382 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4383 *orgtbl-default-fmt*)
4384 f)))
4385 line)))
4386 (push (if *orgtbl-lfmt*
4387 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4388 (concat (orgtbl-eval-str *orgtbl-lstart*)
4389 (mapconcat 'identity line *orgtbl-sep*)
4390 (orgtbl-eval-str *orgtbl-lend*)))
4391 *orgtbl-rtn*))))
4393 (defun orgtbl-format-section (section-stopper)
4394 "Format lines until the first occurrence of SECTION-STOPPER."
4395 (let (prevline)
4396 (progn
4397 (while (not (eq (car *orgtbl-table*) section-stopper))
4398 (if prevline (orgtbl-format-line prevline))
4399 (setq prevline (pop *orgtbl-table*)))
4400 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4401 (*orgtbl-lend* *orgtbl-llend*)
4402 (*orgtbl-lfmt* *orgtbl-llfmt*))
4403 (orgtbl-format-line prevline))))))
4405 (defun orgtbl-to-generic (table params)
4406 "Convert the orgtbl-mode TABLE to some other format.
4407 This generic routine can be used for many standard cases.
4408 TABLE is a list, each entry either the symbol `hline' for a horizontal
4409 separator line, or a list of fields for that line.
4410 PARAMS is a property list of parameters that can influence the conversion.
4411 For the generic converter, some parameters are obligatory: you need to
4412 specify either :lfmt, or all of (:lstart :lend :sep).
4414 Valid parameters are
4416 :splice When set to t, return only table body lines, don't wrap
4417 them into :tstart and :tend. Default is nil. When :splice
4418 is non-nil, this also means that the exporter should not look
4419 for and interpret header and footer sections.
4421 :hline String to be inserted on horizontal separation lines.
4422 May be nil to ignore hlines.
4424 :sep Separator between two fields
4425 :remove-nil-lines Do not include lines that evaluate to nil.
4428 Each in the following group may be either a string or a function
4429 of no arguments returning a string:
4430 :tstart String to start the table. Ignored when :splice is t.
4431 :tend String to end the table. Ignored when :splice is t.
4432 :lstart String to start a new table line.
4433 :llstart String to start the last table line, defaults to :lstart.
4434 :lend String to end a table line
4435 :llend String to end the last table line, defaults to :lend.
4437 Each in the following group may be a string, a function of one
4438 argument (the field or line) returning a string, or a plist
4439 mapping columns to either of the above:
4440 :lfmt Format for entire line, with enough %s to capture all fields.
4441 If this is present, :lstart, :lend, and :sep are ignored.
4442 :llfmt Format for the entire last line, defaults to :lfmt.
4443 :fmt A format to be used to wrap the field, should contain
4444 %s for the original field value. For example, to wrap
4446 This may also be a property list with column numbers and
4449 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4450 Same as above, specific for the header lines in the table.
4451 All lines before the first hline are treated as header.
4452 If any of these is not present, the data line value is used.
4454 This may be either a string or a function of two arguments:
4455 :efmt Use this format to print numbers with exponentials.
4456 The format should have %s twice for inserting mantissa
4458 may also be a property list with column numbers and
4459 formats. :fmt will still be applied after :efmt.
4461 In addition to this, the parameters :skip and :skipcols are always handled
4462 directly by `orgtbl-send-table'. See manual."
4463 (interactive)
4465 (let* ((splicep (plist-get params :splice))
4466 (hline (plist-get params :hline))
4467 (remove-nil-linesp (plist-get params :remove-nil-lines))
4468 (remove-newlines (plist-get params :remove-newlines))
4469 (*orgtbl-hline* hline)
4470 (*orgtbl-table* table)
4471 (*orgtbl-sep* (plist-get params :sep))
4472 (*orgtbl-efmt* (plist-get params :efmt))
4473 (*orgtbl-lstart* (plist-get params :lstart))
4474 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4475 (*orgtbl-lend* (plist-get params :lend))
4476 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4477 (*orgtbl-lfmt* (plist-get params :lfmt))
4478 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4479 (*orgtbl-fmt* (plist-get params :fmt))
4480 *orgtbl-rtn*)
4482 ;; Put header
4483 (unless splicep
4484 (when (plist-member params :tstart)
4485 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4486 (if tstart (push tstart *orgtbl-rtn*)))))
4488 ;; Do we have a heading section? If so, format it and handle the
4489 ;; trailing hline.
4490 (if (and (not splicep)
4491 (or (consp (car *orgtbl-table*))
4492 (consp (nth 1 *orgtbl-table*)))
4493 (memq 'hline (cdr *orgtbl-table*)))
4494 (progn
4495 (when (eq 'hline (car *orgtbl-table*))
4496 ;; there is a hline before the first data line
4497 (and hline (push hline *orgtbl-rtn*))
4498 (pop *orgtbl-table*))
4499 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4500 *orgtbl-lstart*))
4501 (*orgtbl-llstart* (or (plist-get params :hllstart)
4502 *orgtbl-llstart*))
4503 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4504 (*orgtbl-llend* (or (plist-get params :hllend)
4505 (plist-get params :hlend) *orgtbl-llend*))
4506 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4507 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4508 (plist-get params :hlfmt) *orgtbl-llfmt*))
4509 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4510 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4511 (orgtbl-format-section 'hline))
4512 (if hline (push hline *orgtbl-rtn*))
4513 (pop *orgtbl-table*)))
4515 ;; Now format the main section.
4516 (orgtbl-format-section nil)
4518 (unless splicep
4519 (when (plist-member params :tend)
4520 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4521 (if tend (push tend *orgtbl-rtn*)))))
4523 (mapconcat (if remove-newlines
4524 (lambda (tend)
4526 'identity)
4527 (nreverse (if remove-nil-linesp
4528 (remq nil *orgtbl-rtn*)
4531 (defun orgtbl-to-tsv (table params)
4532 "Convert the orgtbl-mode table to TAB separated material."
4534 (defun orgtbl-to-csv (table params)
4535 "Convert the orgtbl-mode table to CSV material.
4536 This does take care of the proper quoting of fields with comma or quotes."
4537 (orgtbl-to-generic table (org-combine-plists
4538 '(:sep "," :fmt org-quote-csv-field)
4539 params)))
4541 (defun orgtbl-to-latex (table params)
4542 "Convert the orgtbl-mode TABLE to LaTeX.
4543 TABLE is a list, each entry either the symbol `hline' for a horizontal
4544 separator line, or a list of fields for that line.
4545 PARAMS is a property list of parameters that can influence the conversion.
4546 Supports all parameters from `orgtbl-to-generic'. Most important for
4547 LaTeX are:
4549 :splice When set to t, return only table body lines, don't wrap
4550 them into a tabular environment. Default is nil.
4552 :fmt A format to be used to wrap the field, should contain %s for the
4553 original field value. For example, to wrap everything in dollars,
4556 The format may also be a function that formats its one argument.
4558 :efmt Format for transforming numbers with exponentials. The format
4559 should have %s twice for inserting mantissa and exponent, for
4561 This may also be a property list with column numbers and formats.
4562 The format may also be a function that formats its two arguments.
4564 :llend If you find too much space below the last line of a table,
4567 The general parameters :skip and :skipcols have already been applied when
4568 this function is called."
4569 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4570 org-table-last-alignment ""))
4571 (params2
4572 (list
4577 (orgtbl-to-generic table (org-combine-plists params2 params))))
4579 (defun orgtbl-to-html (table params)
4580 "Convert the orgtbl-mode TABLE to HTML.
4581 TABLE is a list, each entry either the symbol `hline' for a horizontal
4582 separator line, or a list of fields for that line.
4583 PARAMS is a property list of parameters that can influence the conversion.
4584 Currently this function recognizes the following parameters:
4586 :splice When set to t, return only table body lines, don't wrap
4587 them into a <table> environment. Default is nil.
4589 The general parameters :skip and :skipcols have already been applied when
4590 this function is called. The function does *not* use `orgtbl-to-generic',
4591 so you cannot specify parameters for it."
4592 (let* ((splicep (plist-get params :splice))
4593 (html-table-tag org-export-html-table-tag)
4594 html)
4595 ;; Just call the formatter we already have
4596 ;; We need to make text lines for it, so put the fields back together.
4597 (setq html (org-format-org-table-html
4598 (mapcar
4599 (lambda (x)
4600 (if (eq x 'hline)
4601 "|----+----|"
4602 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4603 table)
4604 splicep))
4606 (setq html (replace-match "" t t html)))
4607 html))
4609 (defun orgtbl-to-texinfo (table params)
4610 "Convert the orgtbl-mode TABLE to TeXInfo.
4611 TABLE is a list, each entry either the symbol `hline' for a horizontal
4612 separator line, or a list of fields for that line.
4613 PARAMS is a property list of parameters that can influence the conversion.
4614 Supports all parameters from `orgtbl-to-generic'. Most important for
4615 TeXInfo are:
4617 :splice nil/t When set to t, return only table body lines, don't wrap
4618 them into a multitable environment. Default is nil.
4620 :fmt fmt A format to be used to wrap the field, should contain
4621 %s for the original field value. For example, to wrap
4623 This may also be a property list with column numbers and
4625 Each format also may be a function that formats its one
4626 argument.
4629 are computed automatically from the width of the columns
4630 under org-mode.
4632 The general parameters :skip and :skipcols have already been applied when
4633 this function is called."
4634 (let* ((total (float (apply '+ org-table-last-column-widths)))
4635 (colfrac (or (plist-get params :cf)
4636 (mapconcat
4637 (lambda (x) (format "%.3f" (/ (float x) total)))
4638 org-table-last-column-widths " ")))
4639 (params2
4640 (list
4641 :tstart (concat "@multitable @columnfractions " colfrac)
4642 :tend "@end multitable"
4643 :lstart "@item " :lend "" :sep " @tab "
4644 :hlstart "@headitem ")))
4645 (orgtbl-to-generic table (org-combine-plists params2 params))))
4647 (defun orgtbl-to-orgtbl (table params)
4648 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4649 Useful when slicing one table into many. The :hline, :sep,
4650 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4651 and :tend suppress strings without splicing; they can be set to
4652 provide ORGTBL directives for the generated table."
4653 (let* ((params2
4654 (list
4655 :remove-newlines t
4656 :tstart nil :tend nil
4657 :hline "|---"
4658 :sep " | "
4659 :lstart "| "
4660 :lend " |"))
4661 (params (org-combine-plists params2 params)))
4662 (orgtbl-to-generic table params)))
4664 (defun org-table-get-remote-range (name-or-id form)
4665 "Get a field value or a list of values in a range from table at ID.
4667 NAME-OR-ID may be the name of a table in the current file as set by
4669 will then be used. Alternatively, it may be an ID referring to
4670 any entry, also in a different file. In this case, the first table
4671 in that entry will be referenced.
4675 The return value is either a single string for a single field, or a
4676 list of the fields in the rectangle ."
4677 (save-match-data
4678 (let ((id-loc nil)
4679 org-table-column-names org-table-column-name-regexp
4680 org-table-local-parameters org-table-named-field-locations
4681 org-table-current-line-types org-table-current-begin-line
4682 org-table-current-begin-pos org-table-dlines
4683 org-table-current-ncol
4684 org-table-hlines org-table-last-alignment
4685 org-table-last-column-widths org-table-last-alignment
4686 org-table-last-column-widths tbeg
4687 buffer loc)
4688 (setq form (org-table-convert-refs-to-rc form))
4689 (save-excursion
4690 (save-restriction
4691 (widen)
4692 (save-excursion
4693 (goto-char (point-min))
4694 (if (re-search-forward
4696 nil t)
4697 (setq buffer (current-buffer) loc (match-beginning 0))
4698 (setq id-loc (org-id-find name-or-id 'marker))
4699 (unless (and id-loc (markerp id-loc))
4701 (setq buffer (marker-buffer id-loc)
4702 loc (marker-position id-loc))
4703 (move-marker id-loc nil)))
4704 (with-current-buffer buffer
4705 (save-excursion
4706 (save-restriction
4707 (widen)
4708 (goto-char loc)
4709 (forward-char 1)
4711 (not (match-beginning 1)))
4712 (error "Cannot find a table at NAME or ID %s" name-or-id))
4713 (setq tbeg (point-at-bol))
4714 (org-table-get-specials)
4715 (setq form (org-table-formula-substitute-names form))
4716 (if (and (string-match org-table-range-regexp form)
4717 (> (length (match-string 0 form)) 1))
4718 (save-match-data
4719 (org-table-get-range (match-string 0 form) tbeg 1))
4720 form)))))))))
4722 (provide 'org-table)
4724 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4726 ;;; org-table.el ends here