| blob | 3eb63b6e53ce12331def516eff8175694948ed1a |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org-mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, otherwise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
91 #+ END RECEIVE ORGTBL %n
93 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
94 | | |
96 "Templates for radio tables in different major modes.
97 All occurrences of %n in a template will be replaced with the name of the
98 table, obtained by prompting the user."
105 "Settings for tables in Org-mode."
110 "The default size for newly created tables, Columns x Rows."
116 "Regular expression for recognizing numbers in table columns.
117 If a table column contains mostly numbers, it will be aligned to the
118 right. If not, it will be aligned to the left.
120 The default value of this option is a regular expression which allows
121 anything which looks remotely like a number as used in scientific
122 context. For example, all of the following will be considered a
123 number:
124 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
126 Other options offered by the customize interface are more restrictive."
146 "Fraction of numbers in a column required to make the column align right.
147 In a column all non-white fields are considered. If at least
148 this fraction of fields is matched by `org-table-number-regexp',
149 alignment to the right border applies."
154 "Behavior of tables during editing in Org-mode."
159 "Non-nil means automatically re-align table when pressing TAB or RETURN.
161 removal/insertion."
166 "Non-nil means automatically blank table field when starting to type into it.
167 This only happens when typing immediately after a field motion
168 command (TAB, S-TAB or RET).
169 Only relevant when `org-enable-table-editor' is equal to `optimized'."
174 "Non-nil means automatically exit the follow mode.
175 When nil, the follow mode will stay on and be active in any table
176 the cursor enters. Since the table follow filed mode messes with the
177 window configuration, it is not recommended to set this variable to nil,
178 except maybe locally in a special file that has mostly tables with long
179 fields."
185 "Whether the user should confirm when Org fixes formulas."
193 'safe-local-variable
197 "Non-nil means tab in the last column of a table with jump over a hline.
198 If a horizontal separator line is following the current line,
199 `org-table-next-field' can either create a new row before that line, or jump
200 over the line. When this option is nil, a new line will be created before
201 this line."
206 "Options concerning tables in Org-mode."
211 "Should org-mode work with table references like B3 instead of @3$2?
212 Possible values are:
213 nil never use them
214 from accept as input, do not present for editing
215 t accept as input and present for editing"
230 calc-angle-mode deg
231 calc-prefer-frac nil
232 calc-symbolic-mode nil
234 calc-display-working-message t
235 )
236 "List with Calc mode settings for use in `calc-eval' for table formulas.
237 The list must contain alternating symbols (Calc modes variables and values).
238 Don't remove any of the default settings, just change the values. Org-mode
239 relies on the variables to be present in the list."
244 "Format for the output of calc computations like $1+$2;t.
245 The default value is 'hours, and will output the results as a
246 number of hours. Other allowed values are 'seconds, 'minutes and
247 'days, and the output will be a fraction of seconds, minutes or
248 days."
257 "Format for fields which contain the result of a formula.
259 characters. Beware that modifying the display can prevent the
260 field from being used in another formula."
266 "Non-nil means TAB and RET evaluate a formula in current table field.
267 If the current field starts with an equal sign, it is assumed to be a formula
268 which should be evaluated as described in the manual and in the documentation
269 string of the command `org-table-eval-formula'. This feature requires the
270 Emacs calc package.
271 When this variable is nil, formula calculation is only available through
277 "Non-nil means interpret constants in formulas in tables.
278 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
279 by the value given in `org-table-formula-constants', or by a value obtained
280 from the `constants.el' package."
285 "Alist with constant names and values, for use in table formulas.
286 The car of each element is a name of a constant, without the `$' before it.
287 The cdr is the value as a string. For example, if you'd like to use the
288 speed of light in a formula, you would configure
292 and then use it in an equation like `$1*$c'.
294 Constants can also be defined on a per-file basis using a line like
296 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
303 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
304 Automatically means when TAB or RET or C-c C-c are pressed in the line."
309 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
314 "Non-nil means relative formula references may cross hlines.
315 Here are the allowed values:
317 nil Relative references may not cross hlines. They will reference the
318 field next to the hline instead. Coming from below, the reference
319 will be to the field below the hline. Coming from above, it will be
320 to the field above.
321 t Relative references may cross hlines.
322 error An attempt to cross a hline will throw an error.
324 It is probably good to never set this variable to nil, for the sake of
325 portability of tables."
333 "Options concerning table import and export in Org-mode."
338 "Default export parameters for `org-table-export'.
339 These can be overridden for a specific table by setting the
340 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
341 radio tables for the different export transformations and
342 available parameters."
380 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
381 ;; 1 2 3 4 5
392 "Is this a table line colgroup information?"
396 line)
398 nil
405 "Is this a table line with only alignment/width cookies?"
418 s))))
427 "Use the table.el package to insert a new table.
428 If there is already a table at point, convert between Org-mode tables
429 and table.el tables."
443 "Convert region to table, or create an empty table.
444 If there is an active region, convert it to a table, using the function
445 `org-table-convert-region'. See the documentation of that function
446 to learn how the prefix argument is interpreted to determine the field
447 separator.
448 If there is no such region, create an empty table with `org-table-create'."
455 "Query for a size and insert a table skeleton.
475 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
479 ;; Insert a hline after the first row.
487 "Convert region to a table.
488 The region goes from BEG0 to END0, but these borders will be moved
489 slightly, to make sure a beginning of line in the first line is included.
491 SEPARATOR specifies the field separator in the lines. It can have the
492 following values:
494 '(4) Use the comma as a field separator
495 '(16) Use a TAB as field separator
496 integer When a number, use that many spaces as field separator
497 nil When nil, the command tries to be smart and figure out the
498 separator in the following way:
499 - when each line contains a TAB, assume TAB-separated material
500 - when each line contains a comma, assume CSV material
501 - else, assume one or more SPACE characters as separator."
505 re)
512 ;; Get the right field separator
523 ;; parse the csv stuff
547 "Import FILE as a table.
548 The file is assumed to be tab-separated. Such files can be produced by most
549 spreadsheet and database applications. If no tabs (at least one per line)
550 are found, lines will be split on whitespace into fields."
562 "Export table to a file, with configurable format.
563 Such a file can be imported into usual spreadsheet programs.
565 FILE can be the output file name. If not given, it will be taken
566 from a TABLE_EXPORT_FILE property in the current entry or higher
567 up in the hierarchy, or the user will be prompted for a file
568 name. FORMAT can be an export format, of the same kind as it
569 used when `orgtbl-mode' sends a table in a different format.
571 The command suggests a format depending on TABLE_EXPORT_FORMAT,
572 whether it is set locally or up in the hierarchy, then on the
573 extension of the given file name, and finally on the variable
574 `org-table-export-default-format'."
590 buf deffmt-readable fileext)
606 org-table-export-default-format))
624 'hline
627 skipcols i0)))
628 lines))
632 skipcols i0))
635 skipcols i0)))
652 "Marker at the beginning of the table last aligned.
655 "Marker at the end of the table last aligned.
658 "List of flags for flushright alignment, from the last re-alignment.
661 "List of max width of fields in each column.
664 "Non-nil means debug table formulas.
677 "Align the table at point by aligning all vertical bars."
680 ;; Limits of table
683 ;; Current cursor position
689 column
691 rfmt hfmt
699 emptystrings links dates emph raise narrow
700 falign falign1 fmax f1 len c e space)
703 ;; Check if we have links or dates
715 ;; Make sure the link properties are right
717 ;; Make sure the date properties are right
722 ;; Check if we are narrowing any columns
725 org-format-transports-properties-p
730 ;; Get the rows
733 ;; Store the indentation of the first line
736 ;; Mark the hlines by setting the corresponding element to nil
737 ;; At the same time, we remove trailing space.
740 nil
743 l)))
744 lines))
745 ;; Get the data fields by splitting the lines.
750 ;; How many fields in the longest line?
757 ;; A list of empty strings to fill any short rows on output
759 ;; Check for special formatting.
763 ;; Check if there is an explicit width specified
773 ;; Find fields that are wider than fmax, and shorten them
779 'help-echo
780 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
788 xx)))))
789 ;; Get the maximum width for each column
791 lengths)
792 ;; Get the fraction of numbers, to decide about alignment of the column
798 nil
805 ;; Store the alignment of this table, for later editing of single fields
807 org-table-last-column-widths lengths)
809 ;; With invisible characters, `format' does not get the field width right
810 ;; So we need to make these fields wide by hand.
828 ;; Compute the formats needed for output of the table
841 hfmt))
845 ;; Replace the old one
852 ;; Try to move to the old location
860 ))
863 "Find the beginning of the table and return its position.
864 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
868 org-table-border-regexp)
869 nil t))
876 "Find the end of the table and return its position.
877 With argument TABLE-TYPE, go to the end of a table.el-type table."
881 org-table-border-regexp)
882 nil t))
888 "Justify the current field, text to left, number to right.
889 Optional argument NEW may specify text to replace the current field content."
898 ;; This is not the same table, force a full re-align
904 l f n o e)
928 "Go to the next field in the current table, creating new lines as needed.
929 Before doing so, re-align the table if necessary."
934 org-table-may-need-update)
945 org-table-tab-jumps-over-hlines
957 "Go to the previous field in the table.
958 Before doing so, re-align the table if necessary."
963 org-table-may-need-update)
978 "Move to the end of the current table field.
979 If already at or after the end, move to the end of the next table field.
980 With numeric argument N, move N-1 fields forward first."
993 "Move to the beginning of the current table field.
994 If already at or before the beginning, move to the beginning of the
995 previous field.
996 With numeric argument N, move N-1 fields backward first."
1010 "Go to the next row (same column) in the current table.
1011 Before doing so, re-align the table if necessary."
1019 org-table-may-need-update)
1033 "Copy a field down in the current column.
1034 If the field at the cursor is empty, copy into it the content of
1035 the nearest non-empty field above. With argument N, use the Nth
1036 non-empty field. If the current field is not empty, it is copied
1037 down to the next row, and the cursor is moved with it.
1038 Therefore, repeating this command causes the column to be filled
1039 row-by-row.
1040 If the variable `org-table-copy-increment' is non-nil and the
1041 field is an integer or a timestamp, it will be incremented while
1042 copying. In the case of a timestamp, increment by one day."
1050 txt)
1062 beg t))
1085 "Is point inside a table data field?
1086 I.e. not on a hline or before the first or after the last column?
1087 This actually throws an error, so it aborts the current command."
1093 nil
1095 t))
1101 "Get the field in table line LINE, column COLUMN.
1102 If LINE is larger than the number of data lines in the table, the function
1103 returns nil. However, if COLUMN is too large, we will simply return an
1104 empty string.
1105 If LINE is nil, use the current line.
1106 If column is nil, use the current column."
1113 "Put VALUE into line LINE, column COLUMN.
1114 When ALIGN is set, also realign the table."
1123 "Return the index of the current data line."
1130 cnt))
1133 "Go to the Nth data line in the current table.
1134 Return t when the line exists, nil if it does not exist."
1142 "Blank the current table field or active region."
1159 "Return the value of the field in column N of current row.
1160 N defaults to current field.
1161 If REPLACE is a string, replace field with this value. The return value
1162 is always the old value."
1171 t t))
1173 val)
1177 "Show info about the current field, and highlight any reference at point."
1185 org-table-named-field-locations)))
1205 dline col
1207 dline col ref1
1209 ;; FIXME: formula info not correct if special table line
1219 "Find out which column we are in."
1229 cnt)))
1232 "Find out what table data line we are in.
1233 Only data lines count for this."
1245 cnt)))
1248 "Move the cursor to the Nth column in the current table line.
1249 With optional argument ON-DELIM, stop with point before the left delimiter
1250 of the field.
1251 If there are less than N fields, just go to after the last delimiter.
1252 However, when FORCE is non-nil, create new columns if necessary."
1262 t)))))
1270 "Insert a new column into the table."
1278 ;; Current cursor position
1284 nil
1298 "Find a data line in the current table, which is needed for column commands."
1301 t
1312 t
1317 "Turn a buffer line number into a data line number.
1318 If there is no data line in this line, return nil.
1319 If there is no matching dline (most likely te reference was a hline), the
1320 first dline below it is used. When ABOVE is non-nil, the one above is used."
1323 i)
1336 nil))
1339 "Delete a column from the table."
1348 ;; Current cursor position
1354 nil
1371 "Move column to the right."
1375 "Move column to the left."
1380 "Move the current column to the right. With arg LEFT, move to the left."
1390 ;; Current cursor position
1400 nil
1419 "Move table row down."
1423 "Move table row up."
1428 "Move the current table line down. With arg UP, move it up."
1437 txt hline2p)
1461 "Insert a new row above the current line into the table.
1462 With prefix ARG, insert below the current line."
1468 ;; Fix the first field if necessary
1482 "Insert a horizontal-line below the current line into the table.
1483 With prefix ABOVE, insert above the current line."
1505 "Insert a hline and move to the row below that line."
1519 In particular, this does handle wide and invisible characters."
1521 ;; It's a hline, just map the characters
1527 t t s)))
1528 s))
1531 "Delete the current row or horizontal line from the table."
1546 "Sort table lines according to the column at point.
1548 The position of point indicates the column to be used for
1549 sorting, and the range of lines is the range between the nearest
1550 horizontal separator lines, or the entire table of no such lines
1551 exist. If point is before the first column, you will be prompted
1552 for the sorting column. If there is an active region, the mark
1553 specifies the first line and the sorting column, while point
1554 should be in the last line to be included into the sorting.
1556 The command then prompts for the sorting type which can be
1557 alphabetically, numerically, or by time (as given in a time stamp
1558 in the field). Sorting in reverse order is also possible.
1560 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1562 If SORTING-TYPE is specified when this function is called from a Lisp
1563 program, no prompting will take place. SORTING-TYPE must be a character,
1564 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1565 should be done in reverse order."
1569 beg end bcol ecol tend tbeg column lns pos)
1614 x))
1627 "Copy region in table to the clipboard and blank all relevant fields.
1628 If there is no active region, use just the field at point."
1635 "Copy rectangular region in table to clipboard.
1636 A special clipboard is used which can only be accessed
1637 with `org-table-paste-rectangle'."
1641 current-prefix-arg))
1643 region cols
1669 org-table-clip))
1672 "Paste a rectangular region into a table.
1673 The upper right corner ends up in the current field. All involved fields
1674 will be overwritten. If the rectangle does not fit into the present table,
1675 the table is enlarged as needed. The process ignores horizontal separator
1676 lines."
1686 c cols field)
1702 "Convert from `org-mode' table to table.el and back.
1703 Obviously, this only works within limits. When an Org-mode table is
1704 converted to table.el, all horizontal separator lines get lost, because
1705 table.el uses these as cell boundaries and has no notion of horizontal lines.
1706 A table.el table can be converted to an Org-mode table only if it does not
1707 do row or column spanning. Multiline cells will become multiple cells.
1708 Beware, Org-mode does not test if the table can be successfully converted - it
1709 blindly applies a recipe that works for simple tables."
1713 ;; convert to Org-mode table
1722 ;; convert to table.el table
1725 ;; first, get rid of all horizontal lines
1729 ;; insert a hline before first
1733 ;; insert a hline after each line
1738 ;; replace "+" at beginning and ending of hlines
1747 "Transpose orgmode table at point and eliminate hlines.
1748 So a table like
1750 | 1 | 2 | 4 | 5 |
1751 |---+---+---+---|
1752 | a | b | c | d |
1753 | e | f | g | h |
1755 will be transposed as
1757 | 1 | a | e |
1758 | 2 | b | f |
1759 | 4 | c | g |
1760 | 5 | d | h |
1762 Note that horizontal lines disappeared."
1766 ;; remove 'hline from list
1775 "Wrap several fields in a column like a paragraph.
1776 This is useful if you'd like to spread the contents of a field over several
1777 lines, in order to keep the table compact.
1779 If there is an active region, and both point and mark are in the same column,
1780 the text in the column is wrapped to minimum width for the given number of
1781 lines. Generally, this makes the table more compact. A prefix ARG may be
1783 formats the selected text to two lines. If the region was longer than two
1784 lines, the remaining lines remain empty. A negative prefix argument reduces
1785 the current number of lines by that amount. The wrapped text is pasted back
1786 into the table. If you formatted it to more lines than it was before, fields
1787 further down in the table get overwritten - so you might need to make space in
1788 the table first.
1790 If there is no region, the current field is split at the cursor position and
1791 the text fragment to the right of the cursor is prepended to the field one
1792 line down.
1794 If there is no region, but you specify a prefix ARG, the current field gets
1795 blank, and the content is appended to the field above."
1799 ;; There is a region: fill as a paragraph
1803 nlines)
1810 arg)
1814 nil nlines)))
1818 ;; No region, split the current field at point
1822 ;; combine with field above
1832 ;; split field
1845 "Edit table field in a different window.
1846 This is mainly useful for fields that contain hidden parts.
1848 it can be edited in place."
1857 display t intangible t))
1870 p)
1886 intangible t))
1894 "Finish editing a table data field.
1895 Remove all newline characters, insert the result into the table, realign
1896 the table and kill the editing buffer."
1900 text)
1917 "Minor mode to make the table field editor window follow the cursor.
1918 When this mode is active, the field editor window will always show the
1919 current field. The mode exits automatically when the cursor leaves the
1920 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1921 nil " TblFollow" nil
1937 ;; We have left the table, exit the follow mode
1948 "Sum numbers in region of current table column.
1949 The result will be displayed in the echo area, and will be available
1952 If there is an active region, it is interpreted as a rectangle and all
1953 numbers in that rectangle will be summed. If there is no active
1954 region and point is located in a table column, sum all numbers in that
1955 column.
1957 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1958 numbers are assumed to be times as well (in decimal hours) and the
1959 numbers are added as such.
1961 If NLAST is a number, only the NLAST fields will actually be summed."
1988 items1)))
1995 s diff)
2003 sres))))
2026 "Return the formula active for the current field.
2027 Assumes that specials are in place.
2028 If KEY is given, return the key to this formula.
2032 org-table-named-field-locations)))
2046 "Read a formula from the minibuffer, offer stored formula as default.
2047 When NAMED is non-nil, look for a named equation."
2051 org-table-named-field-locations)))
2058 name
2059 ref)
2069 stored)
2071 equation)
2078 scol))
2080 'org-table-formula-history
2081 )))))
2082 mustsave)
2084 ;; remove formula
2091 ;; We set the column equation, delete the named one.
2093 mustsave t))
2099 eq))
2102 "Store the list of formulas below the current table."
2109 ;; don't overwrite TBLFM, we might use text properties to store stuff
2125 ;; Fake a high number to make sure this is sorted at the end.
2132 a)
2142 "Compare two formulas for sorting."
2148 "Return an alist with the stored formulas directly after current table."
2157 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2176 "Modify the equations after the table structure has been edited.
2178 For all numbers larger than LIMIT, shift them by DELTA."
2190 s n a)
2210 "Get the column names and local parameters for this table."
2213 names name fields fields1 field cnt
2214 c v l line col types dlines hlines last-dline)
2216 org-table-local-parameters nil
2217 org-table-named-field-locations nil
2218 org-table-current-begin-line nil
2219 org-table-current-begin-pos nil
2220 org-table-current-line-types nil
2239 org-table-local-parameters))))
2255 ;; Analyse the line types
2259 l org-table-current-begin-line)
2276 al al2)
2288 If yes, store the formula and apply it."
2289 ;; We already know we are in a table. Get field will only return a formula
2290 ;; when appropriate. It might return a separator line, but no problem.
2293 named eq)
2304 "List of commands triggering the recalculation of a line.
2317 "Rotate the recalculation mark in the first column.
2318 If in any row, the first field is not consistent with a mark,
2319 insert a new column for the markers.
2320 When there is an active region, change all the lines in the region,
2321 after prompting for the marking character.
2322 After each change, a message will be displayed indicating the meaning
2323 of the new mark."
2338 epos new)
2345 newchar))
2378 "Recompute the current line if marked for it, and if we haven't just done it."
2398 org-tbl-calc-modes)
2401 suppress-align suppress-const
2402 suppress-store suppress-analysis)
2403 "Replace the table field value at the cursor by the result of a calculation.
2405 This function makes use of Dave Gillespie's Calc package, in my view the
2406 most exciting program ever written for GNU Emacs. So you need to have Calc
2407 installed in order to use this function.
2409 In a table, this command replaces the value in the current field with the
2411 formula, by storing it in a special line below the table. When called
2412 with a `C-u' prefix, the current field must be a named field, and the
2413 formula is installed as valid in only this specific field.
2415 When called with two `C-u' prefixes, insert the active equation
2416 for the field back into the current field, so that it can be
2418 to check the referenced fields.
2420 When called, the command first prompts for a formula, which is read in
2421 the minibuffer. Previously entered formulas are available through the
2422 history list, and the last used formula is offered as a default.
2423 These stored formulas are adapted correctly when moving, inserting, or
2424 deleting columns with the corresponding commands.
2426 The formula can be any algebraic expression understood by the Calc package.
2427 For details, see the Org-mode manual.
2429 This function can also be called from Lisp programs and offers
2430 additional arguments: EQUATION can be the formula to apply. If this
2431 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2432 used to speed-up recursive calls by by-passing unnecessary aligns.
2433 SUPPRESS-CONST suppresses the interpretation of constants in the
2434 formula, assuming that this has been done already outside the function.
2435 SUPPRESS-STORE means the formula should not be stored, either because
2436 it is already stored, or because it is a modified equation that should
2437 not overwrite the stored one."
2453 equation
2459 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2460 duration duration-output-format)
2461 ;; Parse the format string. Since we have a lot of modes, this is
2462 ;; a lot of work. However, I think calc still uses most of the time.
2475 'calc-float-format
2478 n))))
2482 duration-output-format nil
2486 duration-output-format org-table-duration-custom-format
2487 numbers t
2510 ;; replace fields with duration values if relevant
2514 fields)))
2518 fields)))
2524 ;; Insert row and column number of formula result field
2535 t t form)))
2537 ;; Check for old vertical references
2539 ;; Insert remote references
2551 rmtrng))
2552 keep-empty numbers lispp))
2553 t t form)))
2554 ;; Insert complex ranges
2562 ;; possibly handle durations
2567 formrg)
2568 keep-empty numbers lispp)))
2573 ;; Insert simple ranges
2582 keep-empty numbers lispp))
2583 t t form)))
2585 ;; Insert the references to fields in same row
2595 t t form)))
2607 ;; "Inactivate" time-stamps so that Calc can handle them
2610 form
2616 duration-output-format)
2617 ev)))
2622 Orig: %s
2623 $xyz-> %s
2624 @r$c-> %s
2656 prop value)))
2659 "Get a calc vector from a column, according to descriptor DESC.
2660 Optional arguments TBEG and COL can give the beginning of the table and
2661 the current column, to avoid unnecessary parsing.
2663 HIGHLIGHT means just highlight the range.
2665 When CORNERS-ONLY is set, only return the corners of the range as
2666 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2667 in the buffer and column1 and column2 are table column numbers."
2674 beg end c1 c2 r1 r2 rangep tmp)
2691 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2698 ;; just one field
2705 ;; A range, return a vector
2706 ;; First sort the numbers to get a regular rectangle
2710 ;; Only return the corners of the range
2712 ;; Copy the range values into a list
2726 ;; return string representation of calc vector
2731 "Analyze descriptor DESC and retrieve the corresponding line number.
2732 The cursor is currently in line CLINE, the table begins in line BLINE,
2733 and TABLE is a vector with line types."
2741 ;; 1 2 3 4 5 6
2761 nil hn cline desc)))
2764 rel on cline desc)))
2768 "FIXME: Needs more documentation."
2781 nil))
2782 t)))
2786 desc cline)
2787 i)))
2792 s))
2795 "Convert list ELEMENTS to something appropriate to insert into formula.
2796 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2797 NUMBERS indicates that everything should be converted to numbers.
2798 LISPP means to return something appropriate for a Lisp list."
2802 elements
2811 elements))))
2817 x
2823 elements
2827 "Recalculate the current table line by applying all stored formulas.
2828 With prefix arg ALL, do this for all lines in the table.
2829 With the prefix argument ALL is `(16)' \
2831 it is the symbol `iterate', recompute the table until it no longer changes.
2832 If NOALIGN is not nil, do not re-align the table after the computations
2833 are done. This is typically used internally to save time, if it is
2834 known that the table will be realigned a little later anyway."
2849 seen-fields lhs1
2851 ;; Insert constants in all formulas
2867 eqlist))
2868 ;; Split the equation list
2874 ;; Expand ranges in lhs of formulas
2877 ;; Get the correct line range to process
2883 ;; This is a table with marked lines, compute selected lines
2885 ;; Move forward to the first non-header line
2896 ;; First find the named fields, and mark them untouchable.
2897 ;; Also check if several field/range formulas try to set the same field.
2916 name)))
2926 ;; Now evaluate the column formulas, but skip fields covered by
2927 ;; field formulas
2931 ;; Unprotected line, recalculate
2943 ;; Now evaluate the field formulas
2957 ;; back to initial position
2965 "Recalculate the table until it does not change anymore.
2966 The maximum number of iterations is 10, but you can choose a different value
2967 with the prefix ARG."
2972 thistbl)
2986 ;;;###autoload
2988 "Recalculate all tables in the current buffer."
2995 ;;;###autoload
2997 "Iterate all tables in the buffer, to converge inter-table dependencies."
3002 c1
3019 "Expand list of formulas.
3020 If some of the RHS in the formulas are ranges or a row reference, expand
3021 them to individual field equations for each field."
3027 ;; This just refers to one fixed field
3030 ;; This just refers to one fixed named field
3052 "Replace @<, @>, $<, $> with first/last row/column of the table.
3053 So @< and $< will always be replaced with @1 and $1, respectively.
3054 The advantage of these special markers are that structure editing of
3055 the table will not change them, while @1 and $1 will be modified
3056 when a line/row is swapped out of that privileged position. So for
3057 formulas that use a range of rows or columns, it may often be better
3059 borders of the table using the @< @> $< $> makers."
3062 s start)
3067 org-table-current-ncol)
3071 len
3078 s)
3081 "Replace $const with values in string F."
3083 ;; First, check for column names
3088 ;; Parameters and constants
3090 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3100 f))
3103 "Find the value for a parameter or constant in a formula.
3104 Parameters get priority."
3135 map))
3142 "--"
3145 "--"
3146 "Shift Reference at Point"
3151 "-"
3152 "Change Test Row for Column Formulas"
3155 "--"
3160 org-table-overlay-coordinates)]
3161 "--"
3168 "Edit the formulas of the current table in a separate buffer."
3170 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3184 entry s type title)
3187 ;; Keep global-font-lock-mode from turning on font-lock-mode
3228 "Convert a formula from internal to user representation."
3231 s))
3234 "Convert a formula from user to internal representation."
3237 s))
3240 "Convert spreadsheet references from A7 to @7$28.
3241 Works for single references, but also for entire formulas and even the
3242 full TBLFM line."
3244 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3247 ;; format match, just advance
3252 ;; 3.e5 or something like this.
3255 ;; (member (match-string 1 s)
3256 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3257 )
3258 ;; function name, just advance
3268 t t s)))))
3269 s))
3272 "Convert spreadsheet references from to @7$28 to AB7.
3273 Works for single references, but also for entire formulas and even the
3274 full TBLFM line."
3281 t t s)))
3286 t nil s)))
3287 s)
3290 "Convert a base 26 number represented by letters into an integer.
3291 For example: AB -> 28."
3297 n))
3300 "Convert an integer into a base 26 number represented by letters.
3301 For example: 28 -> AB."
3306 s))
3309 "Convert a time string into numerical duration in seconds.
3310 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3311 If S is a string representing a number, keep this number."
3313 s
3336 "Convert a number of seconds to a time string.
3337 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3338 minutes or seconds."
3353 "Convert all references in this buffer, using FUNCTION."
3363 "Convert all references in the buffer from B3 to @3$2 and back."
3373 "Shift the reference at point one row/hline up."
3377 "Shift the reference at point one row/hline down."
3381 "Shift the reference at point one field to the left."
3385 "Shift the reference at point one field to the right."
3396 ;; A B3-like reference
3402 ;; An internal reference
3408 "Re-match the group N, and replace it with the shifted reference."
3413 t t)))
3416 "Shift a reference part REF.
3417 If DECR is set, decrease the references row/column, else increase.
3418 If HLINE is set, this may be a hline reference, it certainly is not
3419 a translation reference."
3448 "Toggle the display of coordinates in the referenced table."
3457 "Parse the buffer for formula definitions and install them.
3458 With prefix ARG, apply the new formulas to the table."
3468 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3469 nil t)
3493 "Abort editing formulas, without installing the changes."
3504 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3545 "Show the location/value of the $ expression at point."
3554 var name e what match dest)
3559 "$1.."
3642 ;; column number
3670 org-table-fedit-scroll-down))))
3681 "Make sure the cursor is in a dataline in a table."
3690 p1 p2)))
3695 "Move cursor one line up in the window showing the table."
3700 "Move cursor one line down in the window showing the table."
3705 "Move the cursor in the window showing the table.
3706 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3731 "Add a new overlay."
3737 "Highlight rectangular region in a table."
3741 l1 c1 l2 c2 tmp)
3765 "Remove the rectangle overlays."
3776 "Add overlays to the table at point, to show row/column coordinates."
3805 "Toggle the display of Row/Column numbers in tables."
3817 "Toggle the formula debugger in tables."
3823 ;;; The orgtbl minor mode
3825 ;; Define a minor mode which can be used in other modes in order to
3826 ;; integrate the org-mode table editor.
3828 ;; This is really a hack, because the org-mode table editor uses several
3829 ;; keys which normally belong to the major mode, for example the TAB and
3830 ;; RET keys. Here is how it works: The minor mode defines all the keys
3831 ;; necessary to operate the table editor, but wraps the commands into a
3832 ;; function which tests if the cursor is currently inside a table. If that
3833 ;; is the case, the table editor command is executed. However, when any of
3834 ;; those keys is used outside a table, the function uses `key-binding' to
3835 ;; look up if the key has an associated command in another currently active
3836 ;; keymap (minor modes, major mode, global), and executes that command.
3837 ;; There might be problems if any of the keys used by the table editor is
3838 ;; otherwise used as a prefix key.
3840 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3841 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3842 ;; addresses this by checking explicitly for both bindings.
3844 ;; The optimized version (see variable `orgtbl-optimized') takes over
3845 ;; all keys which are bound to `self-insert-command' in the *global map*.
3846 ;; Some modes bind other commands to simple characters, for example
3847 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3848 ;; active, this binding is ignored inside tables and replaced with a
3849 ;; modified self-insert.
3855 ;;;###autoload
3857 "Unconditionally turn on `orgtbl-mode'."
3872 ;; Install it as a minor mode.
3876 ;;;###autoload
3878 "The `org-mode' table editor as a minor mode for use in other modes."
3883 ;; Exit without error, in case some hook functions calls this
3884 ;; by accident in org-mode.
3888 ;; Make sure we are first in minor-mode-map-alist
3890 ;; FIXME: maybe it should use emulation-mode-map-alists?
3897 auto-fill-inhibit-regexp)
3901 auto-fill-inhibit-regexp)
3902 orgtbl-line-start-regexp))
3920 "Remove all properties related to narrow-column invisibility."
3933 "Create a function for binding in the table minor mode.
3934 FUN is the command to call inside a table. N is used to create a unique
3935 command name. KEYS are keys that should be checked in for a command
3936 to execute outside of tables."
3942 "Outside of tables, run the binding of `"
3954 keys)
3958 "Error when there is no default binding for a table key."
3963 "Setup orgtbl keymaps."
3994 elt key fun cmd)
4002 ;; Special treatment needed for TAB and RET
4022 [(tab)] "\C-i")))
4024 (org-defkey orgtbl-mode-map [backtab]
4026 [backtab] [S-iso-lefttab] [(shift tab)]
4027 [(tab)] "\C-i"))
4029 (org-defkey orgtbl-mode-map "\M-\C-m"
4030 (orgtbl-make-binding 'org-table-wrap-region 105
4031 "\M-\C-m" [(meta return)]))
4032 (org-defkey orgtbl-mode-map [(meta return)]
4033 (orgtbl-make-binding 'org-table-wrap-region 106
4034 [(meta return)] "\M-\C-m"))
4036 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4037 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4039 (when orgtbl-optimized
4040 ;; If the user wants maximum table support, we need to hijack
4041 ;; some standard editing functions
4042 (org-remap orgtbl-mode-map
4043 'self-insert-command 'orgtbl-self-insert-command
4044 'delete-char 'org-delete-char
4045 'delete-backward-char 'org-delete-backward-char)
4046 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4047 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4048 '("OrgTbl"
4049 ["Create or convert" org-table-create-or-convert-from-region
4050 :active (not (org-at-table-p)) :keys "C-c |" ]
4051 "--"
4052 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4053 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4054 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4055 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4056 "--"
4057 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4058 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4059 ["Copy Field from Above"
4060 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4061 "--"
4062 ("Column"
4063 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4064 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4065 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4066 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4067 ("Row"
4068 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4069 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4070 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4071 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4072 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4073 "--"
4074 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4075 ("Rectangle"
4076 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4077 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4078 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4079 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4080 "--"
4081 ("Radio tables"
4082 ["Insert table template" orgtbl-insert-radio-table
4083 (assq major-mode orgtbl-radio-table-templates)]
4084 ["Comment/uncomment table" orgtbl-toggle-comment t])
4085 "--"
4086 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4087 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4088 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4089 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4090 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4091 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4092 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4093 ["Sum Column/Rectangle" org-table-sum
4094 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4095 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4096 ["Debug Formulas"
4097 org-table-toggle-formula-debugger :active (org-at-table-p)
4098 :keys "C-c {"
4099 :style toggle :selected org-table-formula-debug]
4100 ["Show Col/Row Numbers"
4101 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4102 :keys "C-c }"
4103 :style toggle :selected org-table-overlay-coordinates]
4104 ))
4105 t))
4107 (defun orgtbl-ctrl-c-ctrl-c (arg)
4108 "If the cursor is inside a table, realign the table.
4109 If it is a table to be sent away to a receiver, do it.
4110 With prefix arg, also recompute table."
4111 (interactive "P")
4112 (let ((case-fold-search t) (pos (point)) action consts-str consts cst const-str)
4113 (save-excursion
4114 (beginning-of-line 1)
4115 (setq action (cond
4119 (cond
4120 ((integerp action)
4121 (goto-char action)
4122 (org-table-maybe-eval-formula)
4123 (if arg
4124 (call-interactively 'org-table-recalculate)
4125 (org-table-maybe-recalculate-line))
4126 (call-interactively 'org-table-align)
4127 (when (orgtbl-send-table 'maybe)
4128 (run-hooks 'orgtbl-after-send-table-hook)))
4129 ((eq action 'recalc)
4130 (save-excursion
4131 (goto-char (point-min))
4133 (setq const-str (substring-no-properties (match-string 1)))
4135 (when consts
4136 (let (e)
4137 (while (setq e (pop consts))
4139 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4140 (setq org-table-formula-constants-local cst)))))
4141 (save-excursion
4142 (beginning-of-line 1)
4144 (if (org-at-table-p)
4145 (org-call-with-arg 'org-table-recalculate t))))
4146 (t (let (orgtbl-mode)
4147 (call-interactively (key-binding "\C-c\C-c")))))))
4149 (defun orgtbl-create-or-convert-from-region (arg)
4150 "Create table or convert region to table, if no conflicting binding.
4151 This installs the table binding `C-c |', but only if there is no
4152 conflicting binding to this key outside orgtbl-mode."
4153 (interactive "P")
4154 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4155 (if cmd
4156 (call-interactively cmd)
4157 (call-interactively 'org-table-create-or-convert-from-region))))
4159 (defun orgtbl-tab (arg)
4160 "Justification and field motion for `orgtbl-mode'."
4161 (interactive "P")
4162 (if arg (org-table-edit-field t)
4163 (org-table-justify-field-maybe)
4164 (org-table-next-field)))
4166 (defun orgtbl-ret ()
4167 "Justification and field motion for `orgtbl-mode'."
4168 (interactive)
4169 (if (bobp)
4170 (newline)
4171 (org-table-justify-field-maybe)
4172 (org-table-next-row)))
4174 (defun orgtbl-self-insert-command (N)
4175 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4176 If the cursor is in a table looking at whitespace, the whitespace is
4177 overwritten, and the table is not marked as requiring realignment."
4178 (interactive "p")
4179 (if (and (org-at-table-p)
4180 (or
4181 (and org-table-auto-blank-field
4182 (member last-command
4183 '(orgtbl-hijacker-command-100
4184 orgtbl-hijacker-command-101
4185 orgtbl-hijacker-command-102
4186 orgtbl-hijacker-command-103
4187 orgtbl-hijacker-command-104
4188 orgtbl-hijacker-command-105
4189 yas/expand))
4190 (org-table-blank-field))
4191 t)
4192 (eq N 1)
4194 (let (org-table-may-need-update)
4195 (goto-char (1- (match-end 0)))
4196 (backward-delete-char 1)
4197 (goto-char (match-beginning 0))
4198 (self-insert-command N))
4199 (setq org-table-may-need-update t)
4200 (let* (orgtbl-mode
4201 a
4202 (cmd (or (key-binding
4203 (or (and (listp function-key-map)
4204 (setq a (assoc last-input-event function-key-map))
4205 (cdr a))
4206 (vector last-input-event)))
4207 'self-insert-command)))
4208 (call-interactively cmd)
4209 (if (and org-self-insert-cluster-for-undo
4210 (eq cmd 'self-insert-command))
4211 (if (not (eq last-command 'orgtbl-self-insert-command))
4212 (setq org-self-insert-command-undo-counter 1)
4213 (if (>= org-self-insert-command-undo-counter 20)
4214 (setq org-self-insert-command-undo-counter 1)
4215 (and (> org-self-insert-command-undo-counter 0)
4216 buffer-undo-list
4217 (not (cadr buffer-undo-list)) ; remove nil entry
4218 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4219 (setq org-self-insert-command-undo-counter
4220 (1+ org-self-insert-command-undo-counter))))))))
4223 "Regular expression matching exponentials as produced by calc.")
4225 (defun orgtbl-export (table target)
4226 (require 'org-exp)
4227 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4229 org-table-last-alignment org-table-last-column-widths
4230 maxcol column)
4231 (if (not (fboundp func))
4232 (error "Cannot export orgtbl table to %s" target))
4233 (setq lines (org-table-clean-before-export lines))
4234 (setq table
4235 (mapcar
4236 (lambda (x)
4237 (if (string-match org-table-hline-regexp x)
4238 'hline
4240 lines))
4241 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4242 table)))
4243 (loop for i from (1- maxcol) downto 0 do
4244 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4245 (setq column (delq nil column))
4246 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4247 (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))
4248 (funcall func table nil)))
4250 (defun orgtbl-gather-send-defs ()
4251 "Gather a plist of :name, :transform, :params for each destination before
4252 a radio table."
4253 (save-excursion
4254 (goto-char (org-table-begin))
4255 (let (rtn)
4256 (beginning-of-line 0)
4257 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4258 (let ((name (org-no-properties (match-string 1)))
4259 (transform (intern (match-string 2)))
4260 (params (if (match-end 3)
4261 (read (concat "(" (match-string 3) ")")))))
4262 (push (list :name name :transform transform :params params)
4263 rtn)
4264 (beginning-of-line 0)))
4265 rtn)))
4267 (defun orgtbl-send-replace-tbl (name txt)
4268 "Find and replace table NAME with TXT."
4269 (save-excursion
4270 (goto-char (point-min))
4271 (unless (re-search-forward
4273 (error "Don't know where to insert translated table"))
4274 (goto-char (match-beginning 0))
4275 (beginning-of-line 2)
4276 (save-excursion
4277 (let ((beg (point)))
4278 (unless (re-search-forward
4279 (concat "END RECEIVE ORGTBL +" name) nil t)
4280 (error "Cannot find end of insertion region"))
4281 (beginning-of-line 1)
4282 (delete-region beg (point))))
4285 ;;;###autoload
4286 (defun org-table-to-lisp (&optional txt)
4287 "Convert the table at point to a Lisp structure.
4288 The structure will be a list. Each item is either the symbol `hline'
4289 for a horizontal separator line, or a list of field values as strings.
4290 The table is taken from the parameter TXT, or from the buffer at point."
4291 (unless txt
4292 (unless (org-at-table-p)
4293 (error "No table at point")))
4294 (let* ((txt (or txt
4295 (buffer-substring-no-properties (org-table-begin)
4296 (org-table-end))))
4299 (mapcar
4300 (lambda (x)
4301 (if (string-match org-table-hline-regexp x)
4302 'hline
4304 lines)))
4306 (defun orgtbl-send-table (&optional maybe)
4307 "Send a transformed version of this table to the receiver position.
4308 With argument MAYBE, fail quietly if no transformation is defined for
4309 this table."
4310 (interactive)
4311 (catch 'exit
4312 (unless (org-at-table-p) (error "Not at a table"))
4313 ;; when non-interactive, we assume align has just happened.
4314 (when (org-called-interactively-p 'any) (org-table-align))
4315 (let ((dests (orgtbl-gather-send-defs))
4316 (txt (buffer-substring-no-properties (org-table-begin)
4317 (org-table-end)))
4318 (ntbl 0))
4319 (unless dests (if maybe (throw 'exit nil)
4320 (error "Don't know how to transform this table")))
4321 (dolist (dest dests)
4322 (let* ((name (plist-get dest :name))
4323 (transform (plist-get dest :transform))
4324 (params (plist-get dest :params))
4325 (skip (plist-get params :skip))
4326 (skipcols (plist-get params :skipcols))
4327 (no-escape (plist-get params :no-escape))
4328 beg
4329 (lines (org-table-clean-before-export
4330 (nthcdr (or skip 0)
4332 (i0 (if org-table-clean-did-remove-column 2 1))
4333 (lines (if no-escape lines
4334 (mapcar (lambda(l) (replace-regexp-in-string
4336 (table (mapcar
4337 (lambda (x)
4338 (if (string-match org-table-hline-regexp x)
4339 'hline
4340 (org-remove-by-index
4342 skipcols i0)))
4343 lines))
4344 (fun (if (= i0 2) 'cdr 'identity))
4345 (org-table-last-alignment
4346 (org-remove-by-index (funcall fun org-table-last-alignment)
4347 skipcols i0))
4348 (org-table-last-column-widths
4349 (org-remove-by-index (funcall fun org-table-last-column-widths)
4350 skipcols i0))
4351 (txt (if (fboundp transform)
4352 (funcall transform table params)
4353 (error "No such transformation function %s" transform))))
4354 (orgtbl-send-replace-tbl name txt))
4355 (setq ntbl (1+ ntbl)))
4356 (message "Table converted and installed at %d receiver location%s"
4357 ntbl (if (> ntbl 1) "s" ""))
4358 (if (> ntbl 0)
4359 ntbl
4360 nil))))
4362 (defun org-remove-by-index (list indices &optional i0)
4363 "Remove the elements in LIST with indices in INDICES.
4364 First element has index 0, or I0 if given."
4365 (if (not indices)
4366 list
4367 (if (integerp indices) (setq indices (list indices)))
4368 (setq i0 (1- (or i0 0)))
4369 (delq :rm (mapcar (lambda (x)
4370 (setq i0 (1+ i0))
4371 (if (memq i0 indices) :rm x))
4372 list))))
4374 (defun orgtbl-toggle-comment ()
4375 "Comment or uncomment the orgtbl at point."
4376 (interactive)
4377 (let* ((case-fold-search t)
4378 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4379 (re2 (concat "^" orgtbl-line-start-regexp))
4380 (commented (save-excursion (beginning-of-line 1)
4381 (cond ((looking-at re1) t)
4382 ((looking-at re2) nil)
4383 (t (error "Not at an org table")))))
4384 (re (if commented re1 re2))
4385 beg end)
4386 (save-excursion
4387 (beginning-of-line 1)
4388 (while (looking-at re) (beginning-of-line 0))
4389 (beginning-of-line 2)
4390 (setq beg (point))
4391 (while (looking-at re) (beginning-of-line 2))
4392 (setq end (point)))
4393 (comment-region beg end (if commented '(4) nil))))
4395 (defun orgtbl-insert-radio-table ()
4396 "Insert a radio table template appropriate for this major mode."
4397 (interactive)
4398 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4399 (txt (nth 1 e))
4400 name pos)
4401 (unless e (error "No radio table setup defined for %s" major-mode))
4402 (setq name (read-string "Table name: "))
4403 (while (string-match "%n" txt)
4404 (setq txt (replace-match name t t txt)))
4406 (setq pos (point))
4407 (insert txt)
4408 (goto-char pos)))
4410 ;; Dynamically bound input and output for table formatting.
4411 (defvar *orgtbl-table* nil
4412 "Carries the current table through formatting routines.")
4413 (defvar *orgtbl-rtn* nil
4414 "Formatting routines push the output lines here.")
4415 ;; Formatting parameters for the current table section.
4416 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4417 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4418 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4419 (defvar *orgtbl-fmt* nil "Format for each entry.")
4420 (defvar *orgtbl-efmt* nil "Format for numbers.")
4421 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4422 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4423 (defvar *orgtbl-lstart* nil "Text starting a row.")
4424 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4425 (defvar *orgtbl-lend* nil "Text ending a row.")
4426 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4428 (defsubst orgtbl-get-fmt (fmt i)
4429 "Retrieve the format from FMT corresponding to the Ith column."
4430 (if (and (not (functionp fmt)) (consp fmt))
4431 (plist-get fmt i)
4432 fmt))
4434 (defsubst orgtbl-apply-fmt (fmt &rest args)
4435 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4436 (cond ((functionp fmt) (apply fmt args))
4437 (fmt (apply 'format fmt args))
4438 (args (car args))
4439 (t args)))
4441 (defsubst orgtbl-eval-str (str)
4442 "If STR is a function, evaluate it with no arguments."
4443 (if (functionp str)
4444 (funcall str)
4445 str))
4447 (defun orgtbl-format-line (line)
4448 "Format LINE as a table row."
4449 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4450 (let* ((i 0)
4451 (line
4452 (mapcar
4453 (lambda (f)
4454 (setq i (1+ i))
4455 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4456 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4457 (orgtbl-apply-fmt efmt (match-string 1 f)
4458 (match-string 2 f))
4459 f)))
4460 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4461 *orgtbl-default-fmt*)
4462 f)))
4463 line)))
4464 (push (if *orgtbl-lfmt*
4465 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4466 (concat (orgtbl-eval-str *orgtbl-lstart*)
4467 (mapconcat 'identity line *orgtbl-sep*)
4468 (orgtbl-eval-str *orgtbl-lend*)))
4469 *orgtbl-rtn*))))
4471 (defun orgtbl-format-section (section-stopper)
4472 "Format lines until the first occurrence of SECTION-STOPPER."
4473 (let (prevline)
4474 (progn
4475 (while (not (eq (car *orgtbl-table*) section-stopper))
4476 (if prevline (orgtbl-format-line prevline))
4477 (setq prevline (pop *orgtbl-table*)))
4478 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4479 (*orgtbl-lend* *orgtbl-llend*)
4480 (*orgtbl-lfmt* *orgtbl-llfmt*))
4481 (orgtbl-format-line prevline))))))
4483 (defun orgtbl-to-generic (table params)
4484 "Convert the orgtbl-mode TABLE to some other format.
4485 This generic routine can be used for many standard cases.
4486 TABLE is a list, each entry either the symbol `hline' for a horizontal
4487 separator line, or a list of fields for that line.
4488 PARAMS is a property list of parameters that can influence the conversion.
4489 For the generic converter, some parameters are obligatory: you need to
4490 specify either :lfmt, or all of (:lstart :lend :sep).
4492 Valid parameters are:
4494 :splice When set to t, return only table body lines, don't wrap
4495 them into :tstart and :tend. Default is nil. When :splice
4496 is non-nil, this also means that the exporter should not look
4497 for and interpret header and footer sections.
4499 :hline String to be inserted on horizontal separation lines.
4500 May be nil to ignore hlines.
4502 :sep Separator between two fields
4503 :remove-nil-lines Do not include lines that evaluate to nil.
4505 Each in the following group may be either a string or a function
4506 of no arguments returning a string:
4508 :tstart String to start the table. Ignored when :splice is t.
4509 :tend String to end the table. Ignored when :splice is t.
4510 :lstart String to start a new table line.
4511 :llstart String to start the last table line, defaults to :lstart.
4512 :lend String to end a table line
4513 :llend String to end the last table line, defaults to :lend.
4515 Each in the following group may be a string, a function of one
4516 argument (the field or line) returning a string, or a plist
4517 mapping columns to either of the above:
4519 :lfmt Format for entire line, with enough %s to capture all fields.
4520 If this is present, :lstart, :lend, and :sep are ignored.
4521 :llfmt Format for the entire last line, defaults to :lfmt.
4522 :fmt A format to be used to wrap the field, should contain
4523 %s for the original field value. For example, to wrap
4525 This may also be a property list with column numbers and
4527 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4528 Same as above, specific for the header lines in the table.
4529 All lines before the first hline are treated as header.
4530 If any of these is not present, the data line value is used.
4532 This may be either a string or a function of two arguments:
4534 :efmt Use this format to print numbers with exponentials.
4535 The format should have %s twice for inserting mantissa
4537 may also be a property list with column numbers and
4538 formats. :fmt will still be applied after :efmt.
4540 In addition to this, the parameters :skip and :skipcols are always handled
4541 directly by `orgtbl-send-table'. See manual."
4542 (let* ((splicep (plist-get params :splice))
4543 (hline (plist-get params :hline))
4544 (skipheadrule (plist-get params :skipheadrule))
4545 (remove-nil-linesp (plist-get params :remove-nil-lines))
4546 (remove-newlines (plist-get params :remove-newlines))
4547 (*orgtbl-hline* hline)
4548 (*orgtbl-table* table)
4549 (*orgtbl-sep* (plist-get params :sep))
4550 (*orgtbl-efmt* (plist-get params :efmt))
4551 (*orgtbl-lstart* (plist-get params :lstart))
4552 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4553 (*orgtbl-lend* (plist-get params :lend))
4554 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4555 (*orgtbl-lfmt* (plist-get params :lfmt))
4556 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4557 (*orgtbl-fmt* (plist-get params :fmt))
4558 *orgtbl-rtn*)
4560 ;; Put header
4561 (unless splicep
4562 (when (plist-member params :tstart)
4563 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4564 (if tstart (push tstart *orgtbl-rtn*)))))
4566 ;; Do we have a heading section? If so, format it and handle the
4567 ;; trailing hline.
4568 (if (and (not splicep)
4569 (or (consp (car *orgtbl-table*))
4570 (consp (nth 1 *orgtbl-table*)))
4571 (memq 'hline (cdr *orgtbl-table*)))
4572 (progn
4573 (when (eq 'hline (car *orgtbl-table*))
4574 ;; there is a hline before the first data line
4575 (and hline (push hline *orgtbl-rtn*))
4576 (pop *orgtbl-table*))
4577 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4578 *orgtbl-lstart*))
4579 (*orgtbl-llstart* (or (plist-get params :hllstart)
4580 *orgtbl-llstart*))
4581 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4582 (*orgtbl-llend* (or (plist-get params :hllend)
4583 (plist-get params :hlend) *orgtbl-llend*))
4584 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4585 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4586 (plist-get params :hlfmt) *orgtbl-llfmt*))
4587 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4588 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4589 (orgtbl-format-section 'hline))
4590 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4591 (pop *orgtbl-table*)))
4593 ;; Now format the main section.
4594 (orgtbl-format-section nil)
4596 (unless splicep
4597 (when (plist-member params :tend)
4598 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4599 (if tend (push tend *orgtbl-rtn*)))))
4601 (mapconcat (if remove-newlines
4602 (lambda (tend)
4604 'identity)
4605 (nreverse (if remove-nil-linesp
4606 (remq nil *orgtbl-rtn*)
4609 (defun orgtbl-to-tsv (table params)
4610 "Convert the orgtbl-mode table to TAB separated material."
4612 (defun orgtbl-to-csv (table params)
4613 "Convert the orgtbl-mode table to CSV material.
4614 This does take care of the proper quoting of fields with comma or quotes."
4615 (orgtbl-to-generic table (org-combine-plists
4616 '(:sep "," :fmt org-quote-csv-field)
4617 params)))
4619 (defun orgtbl-to-latex (table params)
4620 "Convert the orgtbl-mode TABLE to LaTeX.
4621 TABLE is a list, each entry either the symbol `hline' for a horizontal
4622 separator line, or a list of fields for that line.
4623 PARAMS is a property list of parameters that can influence the conversion.
4624 Supports all parameters from `orgtbl-to-generic'. Most important for
4625 LaTeX are:
4627 :splice When set to t, return only table body lines, don't wrap
4628 them into a tabular environment. Default is nil.
4630 :fmt A format to be used to wrap the field, should contain %s for the
4631 original field value. For example, to wrap everything in dollars,
4634 The format may also be a function that formats its one argument.
4636 :efmt Format for transforming numbers with exponentials. The format
4637 should have %s twice for inserting mantissa and exponent, for
4639 This may also be a property list with column numbers and formats.
4640 The format may also be a function that formats its two arguments.
4642 :llend If you find too much space below the last line of a table,
4645 The general parameters :skip and :skipcols have already been applied when
4646 this function is called."
4647 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4648 org-table-last-alignment ""))
4649 (params2
4650 (list
4655 (orgtbl-to-generic table (org-combine-plists params2 params))))
4657 (defun orgtbl-to-html (table params)
4658 "Convert the orgtbl-mode TABLE to HTML.
4659 TABLE is a list, each entry either the symbol `hline' for a horizontal
4660 separator line, or a list of fields for that line.
4661 PARAMS is a property list of parameters that can influence the conversion.
4662 Currently this function recognizes the following parameters:
4664 :splice When set to t, return only table body lines, don't wrap
4665 them into a <table> environment. Default is nil.
4667 The general parameters :skip and :skipcols have already been applied when
4668 this function is called. The function does *not* use `orgtbl-to-generic',
4669 so you cannot specify parameters for it."
4670 (let* ((splicep (plist-get params :splice))
4671 (html-table-tag org-export-html-table-tag)
4672 html)
4673 ;; Just call the formatter we already have
4674 ;; We need to make text lines for it, so put the fields back together.
4675 (setq html (org-format-org-table-html
4676 (mapcar
4677 (lambda (x)
4678 (if (eq x 'hline)
4679 "|----+----|"
4680 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4681 table)
4682 splicep))
4684 (setq html (replace-match "" t t html)))
4685 html))
4687 (defun orgtbl-to-texinfo (table params)
4688 "Convert the orgtbl-mode TABLE to TeXInfo.
4689 TABLE is a list, each entry either the symbol `hline' for a horizontal
4690 separator line, or a list of fields for that line.
4691 PARAMS is a property list of parameters that can influence the conversion.
4692 Supports all parameters from `orgtbl-to-generic'. Most important for
4693 TeXInfo are:
4695 :splice nil/t When set to t, return only table body lines, don't wrap
4696 them into a multitable environment. Default is nil.
4698 :fmt fmt A format to be used to wrap the field, should contain
4699 %s for the original field value. For example, to wrap
4701 This may also be a property list with column numbers and
4703 Each format also may be a function that formats its one
4704 argument.
4707 are computed automatically from the width of the columns
4708 under org-mode.
4710 The general parameters :skip and :skipcols have already been applied when
4711 this function is called."
4712 (let* ((total (float (apply '+ org-table-last-column-widths)))
4713 (colfrac (or (plist-get params :cf)
4714 (mapconcat
4715 (lambda (x) (format "%.3f" (/ (float x) total)))
4716 org-table-last-column-widths " ")))
4717 (params2
4718 (list
4719 :tstart (concat "@multitable @columnfractions " colfrac)
4720 :tend "@end multitable"
4721 :lstart "@item " :lend "" :sep " @tab "
4722 :hlstart "@headitem ")))
4723 (orgtbl-to-generic table (org-combine-plists params2 params))))
4725 (defun orgtbl-to-orgtbl (table params)
4726 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4727 Useful when slicing one table into many. The :hline, :sep,
4728 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4729 and :tend suppress strings without splicing; they can be set to
4730 provide ORGTBL directives for the generated table."
4731 (let* ((params2
4732 (list
4733 :remove-newlines t
4734 :tstart nil :tend nil
4735 :hline "|---"
4736 :sep " | "
4737 :lstart "| "
4738 :lend " |"))
4739 (params (org-combine-plists params2 params)))
4740 (with-temp-buffer
4741 (insert (orgtbl-to-generic table params))
4742 (goto-char (point-min))
4743 (while (re-search-forward org-table-hline-regexp nil t)
4744 (org-table-align))
4745 (buffer-substring 1 (buffer-size)))))
4747 (defun orgtbl-to-table.el (table params)
4748 "Convert the orgtbl-mode TABLE into a table.el table."
4749 (with-temp-buffer
4750 (insert (orgtbl-to-orgtbl table params))
4751 (org-table-align)
4752 (replace-regexp-in-string
4753 "-|" "-+"
4754 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4756 (defun orgtbl-to-unicode (table params)
4757 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4758 You need the ascii-art-to-unicode.el package for this. You can download
4759 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4760 (with-temp-buffer
4761 (insert (orgtbl-to-table.el table params))
4762 (goto-char (point-min))
4763 (if (or (featurep 'ascii-art-to-unicode)
4764 (require 'ascii-art-to-unicode nil t))
4765 (aa2u)
4766 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4767 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4768 "Link to ascii-art-to-unicode.el") org-stored-links))
4769 (error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4770 (buffer-string)))
4772 (defun org-table-get-remote-range (name-or-id form)
4773 "Get a field value or a list of values in a range from table at ID.
4775 NAME-OR-ID may be the name of a table in the current file as set by
4777 will then be used. Alternatively, it may be an ID referring to
4778 any entry, also in a different file. In this case, the first table
4779 in that entry will be referenced.
4783 The return value is either a single string for a single field, or a
4784 list of the fields in the rectangle ."
4785 (save-match-data
4786 (let ((case-fold-search t) (id-loc nil)
4787 ;; Protect a bunch of variables from being overwritten
4788 ;; by the context of the remote table
4789 org-table-column-names org-table-column-name-regexp
4790 org-table-local-parameters org-table-named-field-locations
4791 org-table-current-line-types org-table-current-begin-line
4792 org-table-current-begin-pos org-table-dlines
4793 org-table-current-ncol
4794 org-table-hlines org-table-last-alignment
4795 org-table-last-column-widths org-table-last-alignment
4796 org-table-last-column-widths tbeg
4797 buffer loc)
4798 (setq form (org-table-convert-refs-to-rc form))
4799 (save-excursion
4800 (save-restriction
4801 (widen)
4802 (save-excursion
4803 (goto-char (point-min))
4804 (if (re-search-forward
4806 nil t)
4807 (setq buffer (current-buffer) loc (match-beginning 0))
4808 (setq id-loc (org-id-find name-or-id 'marker))
4809 (unless (and id-loc (markerp id-loc))
4811 (setq buffer (marker-buffer id-loc)
4812 loc (marker-position id-loc))
4813 (move-marker id-loc nil)))
4814 (with-current-buffer buffer
4815 (save-excursion
4816 (save-restriction
4817 (widen)
4818 (goto-char loc)
4819 (forward-char 1)
4821 (not (match-beginning 1)))
4822 (error "Cannot find a table at NAME or ID %s" name-or-id))
4823 (setq tbeg (point-at-bol))
4824 (org-table-get-specials)
4825 (setq form (org-table-formula-substitute-names
4826 (org-table-formula-handle-first/last-rc form)))
4827 (if (and (string-match org-table-range-regexp form)
4828 (> (length (match-string 0 form)) 1))
4829 (save-match-data
4830 (org-table-get-range (match-string 0 form) tbeg 1))
4831 form)))))))))
4833 (provide 'org-table)
4835 ;;; org-table.el ends here