| blob | a3d1b4bdbbd31d864ee7e26be60821ec7f0d46df |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org-mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
51 "Hook for functions attaching to `C-c C-c', if the table is sent.
52 This can be used to add additional functionality after the table is sent
53 to the receiver position, otherwise, if table is not sent, the functions
57 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
58 In the optimized version, the table editor takes over all simple keys that
59 normally just insert a character. In tables, the characters are inserted
60 in a way to minimize disturbing the table structure (i.e. in overwrite mode
61 for empty fields). Outside tables, the correct binding of the keys is
62 restored.
64 The default for this option is t if the optimized version is also used in
65 Org-mode. See the variable `org-enable-table-editor' for details. Changing
66 this variable requires a restart of Emacs to become effective."
72 % END RECEIVE ORGTBL %n
74 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
75 | | |
78 @c END RECEIVE ORGTBL %n
79 @ignore
80 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
81 | | |
84 <!-- END RECEIVE ORGTBL %n -->
85 <!--
86 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
87 | | |
89 "Templates for radio tables in different major modes.
90 All occurrences of %n in a template will be replaced with the name of the
91 table, obtained by prompting the user."
98 "Settings for tables in Org-mode."
103 "The default size for newly created tables, Columns x Rows."
109 "Regular expression for recognizing numbers in table columns.
110 If a table column contains mostly numbers, it will be aligned to the
111 right. If not, it will be aligned to the left.
113 The default value of this option is a regular expression which allows
114 anything which looks remotely like a number as used in scientific
115 context. For example, all of the following will be considered a
116 number:
117 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
119 Other options offered by the customize interface are more restrictive."
137 "Fraction of numbers in a column required to make the column align right.
138 In a column all non-white fields are considered. If at least
139 this fraction of fields is matched by `org-table-number-regexp',
140 alignment to the right border applies."
145 "Behavior of tables during editing in Org-mode."
150 "Non-nil means automatically re-align table when pressing TAB or RETURN.
152 removal/insertion."
157 "Non-nil means automatically blank table field when starting to type into it.
158 This only happens when typing immediately after a field motion
159 command (TAB, S-TAB or RET).
160 Only relevant when `org-enable-table-editor' is equal to `optimized'."
165 "Non-nil means automatically exit the follow mode.
166 When nil, the follow mode will stay on and be active in any table
167 the cursor enters. Since the table follow filed mode messes with the
168 window configuration, it is not recommended to set this variable to nil,
169 except maybe locally in a special file that has mostly tables with long
170 fields."
176 "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."
248 "Format for fields which contain the result of a formula.
250 characters. Beware that modifying the display can prevent the
251 field from being used in another formula."
257 "Non-nil means TAB and RET evaluate a formula in current table field.
258 If the current field starts with an equal sign, it is assumed to be a formula
259 which should be evaluated as described in the manual and in the documentation
260 string of the command `org-table-eval-formula'. This feature requires the
261 Emacs calc package.
262 When this variable is nil, formula calculation is only available through
268 "Non-nil means interpret constants in formulas in tables.
269 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
270 by the value given in `org-table-formula-constants', or by a value obtained
271 from the `constants.el' package."
276 "Alist with constant names and values, for use in table formulas.
277 The car of each element is a name of a constant, without the `$' before it.
278 The cdr is the value as a string. For example, if you'd like to use the
279 speed of light in a formula, you would configure
283 and then use it in an equation like `$1*$c'.
285 Constants can also be defined on a per-file basis using a line like
287 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
294 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
295 Automatically means when TAB or RET or C-c C-c are pressed in the line."
300 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
305 "Non-nil means relative formula references may cross hlines.
306 Here are the allowed values:
308 nil Relative references may not cross hlines. They will reference the
309 field next to the hline instead. Coming from below, the reference
310 will be to the field below the hline. Coming from above, it will be
311 to the field above.
312 t Relative references may cross hlines.
313 error An attempt to cross a hline will throw an error.
315 It is probably good to never set this variable to nil, for the sake of
316 portability of tables."
324 "Options concerning table import and export in Org-mode."
329 "Default export parameters for `org-table-export'.
330 These can be overridden for a specific table by setting the
331 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
332 radio tables for the different export transformations and
333 available parameters."
371 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
372 ;; 1 2 3 4 5
383 "Is this a table line colgroup information?"
387 line)
389 nil
396 "Is this a table line with only alignment/width cookies?"
409 s))))
418 "Use the table.el package to insert a new table.
419 If there is already a table at point, convert between Org-mode tables
420 and table.el tables."
434 "Convert region to table, or create an empty table.
435 If there is an active region, convert it to a table, using the function
436 `org-table-convert-region'. See the documentation of that function
437 to learn how the prefix argument is interpreted to determine the field
438 separator.
439 If there is no such region, create an empty table with `org-table-create'."
446 "Query for a size and insert a table skeleton.
466 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
470 ;; Insert a hline after the first row.
478 "Convert region to a table.
479 The region goes from BEG0 to END0, but these borders will be moved
480 slightly, to make sure a beginning of line in the first line is included.
482 SEPARATOR specifies the field separator in the lines. It can have the
483 following values:
485 '(4) Use the comma as a field separator
486 '(16) Use a TAB as field separator
487 integer When a number, use that many spaces as field separator
488 nil When nil, the command tries to be smart and figure out the
489 separator in the following way:
490 - when each line contains a TAB, assume TAB-separated material
491 - when each line contains a comma, assume CSV material
492 - else, assume one or more SPACE characters as separator."
496 re)
503 ;; Get the right field separator
514 ;; parse the csv stuff
538 "Import FILE as a table.
539 The file is assumed to be tab-separated. Such files can be produced by most
540 spreadsheet and database applications. If no tabs (at least one per line)
541 are found, lines will be split on whitespace into fields."
553 "Export table to a file, with configurable format.
554 Such a file can be imported into a spreadsheet program like Excel.
555 FILE can be the output file name. If not given, it will be taken from
556 a TABLE_EXPORT_FILE property in the current entry or higher up in the
557 hierarchy, or the user will be prompted for a file name.
558 FORMAT can be an export format, of the same kind as it used when
559 `orgtbl-mode' sends a table in a different format. The default format can
560 be found in the variable `org-table-export-default-format', but the function
561 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
562 property, locally or anywhere up in the hierarchy."
574 buf deffmt-readable)
593 "Format: "
598 deffmt-readable)))
611 'hline
614 skipcols i0)))
615 lines))
619 skipcols i0))
622 skipcols i0)))
639 "Marker at the beginning of the table last aligned.
642 "Marker at the end of the table last aligned.
645 "List of flags for flushright alignment, from the last re-alignment.
648 "List of max width of fields in each column.
651 "Non-nil means debug table formulas.
664 "Align the table at point by aligning all vertical bars."
667 ;; Limits of table
670 ;; Current cursor position
676 column
678 rfmt hfmt
686 emptystrings links dates emph raise narrow
687 falign falign1 fmax f1 len c e space)
690 ;; Check if we have links or dates
702 ;; Make sure the link properties are right
704 ;; Make sure the date properties are right
709 ;; Check if we are narrowing any columns
712 org-format-transports-properties-p
717 ;; Get the rows
720 ;; Store the indentation of the first line
723 ;; Mark the hlines by setting the corresponding element to nil
724 ;; At the same time, we remove trailing space.
727 nil
730 l)))
731 lines))
732 ;; Get the data fields by splitting the lines.
737 ;; How many fields in the longest line?
744 ;; A list of empty strings to fill any short rows on output
746 ;; Check for special formatting.
750 ;; Check if there is an explicit width specified
760 ;; Find fields that are wider than fmax, and shorten them
766 'help-echo
767 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
775 xx)))))
776 ;; Get the maximum width for each column
778 lengths)
779 ;; Get the fraction of numbers, to decide about alignment of the column
785 nil
792 ;; Store the alignment of this table, for later editing of single fields
794 org-table-last-column-widths lengths)
796 ;; With invisible characters, `format' does not get the field width right
797 ;; So we need to make these fields wide by hand.
815 ;; Compute the formats needed for output of the table
828 hfmt))
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 matching dline (most likely te reference 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 "Transpose orgmode table at point and eliminate hlines.
1735 So a table like
1737 | 1 | 2 | 4 | 5 |
1738 |---+---+---+---|
1739 | a | b | c | d |
1740 | e | f | g | h |
1742 will be transposed as
1744 | 1 | a | e |
1745 | 2 | b | f |
1746 | 4 | c | g |
1747 | 5 | d | h |
1749 Note that horizontal lines disappeared."
1753 ;; remove 'hline from list
1762 "Wrap several fields in a column like a paragraph.
1763 This is useful if you'd like to spread the contents of a field over several
1764 lines, in order to keep the table compact.
1766 If there is an active region, and both point and mark are in the same column,
1767 the text in the column is wrapped to minimum width for the given number of
1768 lines. Generally, this makes the table more compact. A prefix ARG may be
1770 formats the selected text to two lines. If the region was longer than two
1771 lines, the remaining lines remain empty. A negative prefix argument reduces
1772 the current number of lines by that amount. The wrapped text is pasted back
1773 into the table. If you formatted it to more lines than it was before, fields
1774 further down in the table get overwritten - so you might need to make space in
1775 the table first.
1777 If there is no region, the current field is split at the cursor position and
1778 the text fragment to the right of the cursor is prepended to the field one
1779 line down.
1781 If there is no region, but you specify a prefix ARG, the current field gets
1782 blank, and the content is appended to the field above."
1786 ;; There is a region: fill as a paragraph
1790 nlines)
1797 arg)
1801 nil nlines)))
1805 ;; No region, split the current field at point
1809 ;; combine with field above
1819 ;; split field
1832 "Edit table field in a different window.
1833 This is mainly useful for fields that contain hidden parts.
1835 it can be edited in place."
1844 display t intangible t))
1857 p)
1873 intangible t))
1881 "Finish editing a table data field.
1882 Remove all newline characters, insert the result into the table, realign
1883 the table and kill the editing buffer."
1887 text)
1904 "Minor mode to make the table field editor window follow the cursor.
1905 When this mode is active, the field editor window will always show the
1906 current field. The mode exits automatically when the cursor leaves the
1907 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1908 nil " TblFollow" nil
1924 ;; We have left the table, exit the follow mode
1935 "Sum numbers in region of current table column.
1936 The result will be displayed in the echo area, and will be available
1939 If there is an active region, it is interpreted as a rectangle and all
1940 numbers in that rectangle will be summed. If there is no active
1941 region and point is located in a table column, sum all numbers in that
1942 column.
1944 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1945 numbers are assumed to be times as well (in decimal hours) and the
1946 numbers are added as such.
1948 If NLAST is a number, only the NLAST fields will actually be summed."
1975 items1)))
1982 s diff)
1990 sres))))
2013 "Return the formula active for the current field.
2014 Assumes that specials are in place.
2015 If KEY is given, return the key to this formula.
2019 org-table-named-field-locations)))
2033 "Read a formula from the minibuffer, offer stored formula as default.
2034 When NAMED is non-nil, look for a named equation."
2038 org-table-named-field-locations)))
2045 name
2046 ref)
2056 stored)
2058 equation)
2065 scol))
2067 'org-table-formula-history
2068 )))))
2069 mustsave)
2071 ;; remove formula
2078 ;; We set the column equation, delete the named one.
2080 mustsave t))
2086 eq))
2089 "Store the list of formulas below the current table."
2096 ;; don't overwrite TBLFM, we might use text properties to store stuff
2112 ;; Fake a high number to make sure this is sorted at the end.
2119 a)
2129 "Compare two formulas for sorting."
2135 "Return an alist with the stored formulas directly after current table."
2144 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2163 "Modify the equations after the table structure has been edited.
2165 For all numbers larger than LIMIT, shift them by DELTA."
2176 s n a)
2192 t t)))))))))
2195 "Get the column names and local parameters for this table."
2198 names name fields fields1 field cnt
2199 c v l line col types dlines hlines last-dline)
2201 org-table-local-parameters nil
2202 org-table-named-field-locations nil
2203 org-table-current-begin-line nil
2204 org-table-current-begin-pos nil
2205 org-table-current-line-types nil
2224 org-table-local-parameters))))
2240 ;; Analyse the line types
2244 l org-table-current-begin-line)
2261 al al2)
2273 If yes, store the formula and apply it."
2274 ;; We already know we are in a table. Get field will only return a formula
2275 ;; when appropriate. It might return a separator line, but no problem.
2278 named eq)
2289 "List of commands triggering the recalculation of a line.
2302 "Rotate the recalculation mark in the first column.
2303 If in any row, the first field is not consistent with a mark,
2304 insert a new column for the markers.
2305 When there is an active region, change all the lines in the region,
2306 after prompting for the marking character.
2307 After each change, a message will be displayed indicating the meaning
2308 of the new mark."
2323 epos new)
2330 newchar))
2363 "Recompute the current line if marked for it, and if we haven't just done it."
2383 org-tbl-calc-modes)
2386 suppress-align suppress-const
2387 suppress-store suppress-analysis)
2388 "Replace the table field value at the cursor by the result of a calculation.
2390 This function makes use of Dave Gillespie's Calc package, in my view the
2391 most exciting program ever written for GNU Emacs. So you need to have Calc
2392 installed in order to use this function.
2394 In a table, this command replaces the value in the current field with the
2396 formula, by storing it in a special line below the table. When called
2397 with a `C-u' prefix, the current field must be a named field, and the
2398 formula is installed as valid in only this specific field.
2400 When called with two `C-u' prefixes, insert the active equation
2401 for the field back into the current field, so that it can be
2403 to check the referenced fields.
2405 When called, the command first prompts for a formula, which is read in
2406 the minibuffer. Previously entered formulas are available through the
2407 history list, and the last used formula is offered as a default.
2408 These stored formulas are adapted correctly when moving, inserting, or
2409 deleting columns with the corresponding commands.
2411 The formula can be any algebraic expression understood by the Calc package.
2412 For details, see the Org-mode manual.
2414 This function can also be called from Lisp programs and offers
2415 additional arguments: EQUATION can be the formula to apply. If this
2416 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2417 used to speed-up recursive calls by by-passing unnecessary aligns.
2418 SUPPRESS-CONST suppresses the interpretation of constants in the
2419 formula, assuming that this has been done already outside the function.
2420 SUPPRESS-STORE means the formula should not be stored, either because
2421 it is already stored, or because it is a modified equation that should
2422 not overwrite the stored one."
2438 equation
2444 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2445 duration duration-output-format)
2446 ;; Parse the format string. Since we have a lot of modes, this is
2447 ;; a lot of work. However, I think calc still uses most of the time.
2460 'calc-float-format
2463 n))))
2467 duration-output-format nil
2471 duration-output-format org-table-duration-custom-format
2472 numbers t
2496 ;; replace fields with duration values if relevant
2500 fields)))
2504 fields)))
2510 ;; Insert row and column number of formula result field
2521 t t form)))
2523 ;; Check for old vertical references
2525 ;; Insert remote references
2537 rmtrng))
2538 keep-empty numbers lispp))
2539 t t form)))
2540 ;; Insert complex ranges
2548 ;; possibly handle durations
2553 formrg)
2554 keep-empty numbers lispp)))
2559 ;; Insert simple ranges
2568 keep-empty numbers lispp))
2569 t t form)))
2571 ;; Insert the references to fields in same row
2581 t t form)))
2601 Orig: %s
2602 $xyz-> %s
2603 @r$c-> %s
2635 prop value)))
2638 "Get a calc vector from a column, according to descriptor DESC.
2639 Optional arguments TBEG and COL can give the beginning of the table and
2640 the current column, to avoid unnecessary parsing.
2642 HIGHLIGHT means just highlight the range.
2644 When CORNERS-ONLY is set, only return the corners of the range as
2645 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2646 in the buffer and column1 and column2 are table column numbers."
2653 beg end c1 c2 r1 r2 rangep tmp)
2670 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2677 ;; just one field
2684 ;; A range, return a vector
2685 ;; First sort the numbers to get a regular rectangle
2689 ;; Only return the corners of the range
2691 ;; Copy the range values into a list
2705 ;; return string representation of calc vector
2710 "Analyze descriptor DESC and retrieve the corresponding line number.
2711 The cursor is currently in line CLINE, the table begins in line BLINE,
2712 and TABLE is a vector with line types."
2720 ;; 1 2 3 4 5 6
2740 nil hn cline desc)))
2743 rel on cline desc)))
2747 "FIXME: Needs more documentation."
2760 nil))
2761 t)))
2765 desc cline)
2766 i)))
2771 s))
2774 "Convert list ELEMENTS to something appropriate to insert into formula.
2775 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2776 NUMBERS indicates that everything should be converted to numbers.
2777 LISPP means to return something appropriate for a Lisp list."
2781 elements
2790 elements))))
2796 x
2802 elements
2806 "Recalculate the current table line by applying all stored formulas.
2807 With prefix arg ALL, do this for all lines in the table.
2808 With the prefix argument ALL is `(16)' \
2810 it is the symbol `iterate', recompute the table until it no longer changes.
2811 If NOALIGN is not nil, do not re-align the table after the computations
2812 are done. This is typically used internally to save time, if it is
2813 known that the table will be realigned a little later anyway."
2828 seen-fields lhs1
2830 ;; Insert constants in all formulas
2846 eqlist))
2847 ;; Split the equation list
2853 ;; Expand ranges in lhs of formulas
2856 ;; Get the correct line range to process
2862 ;; This is a table with marked lines, compute selected lines
2864 ;; Move forward to the first non-header line
2875 ;; First find the named fields, and mark them untouchable.
2876 ;; Also check if several field/range formulas try to set the same field.
2895 name)))
2905 ;; Now evaluate the column formulas, but skip fields covered by
2906 ;; field formulas
2910 ;; Unprotected line, recalculate
2922 ;; Now evaluate the field formulas
2936 ;; back to initial position
2944 "Recalculate the table until it does not change anymore.
2945 The maximum number of iterations is 10, but you can choose a different value
2946 with the prefix ARG."
2951 thistbl)
2965 ;;;###autoload
2967 "Recalculate all tables in the current buffer."
2974 ;;;###autoload
2976 "Iterate all tables in the buffer, to converge inter-table dependencies."
2981 c1
2998 "Expand list of formulas.
2999 If some of the RHS in the formulas are ranges or a row reference, expand
3000 them to individual field equations for each field."
3006 ;; This just refers to one fixed field
3009 ;; This just refers to one fixed named field
3031 "Replace @<, @>, $<, $> with first/last row/column of the table.
3032 So @< and $< will always be replaced with @1 and $1, respectively.
3033 The advantage of these special markers are that structure editing of
3034 the table will not change them, while @1 and $1 will be modified
3035 when a line/row is swapped out of that privileged position. So for
3036 formulas that use a range of rows or columns, it may often be better
3038 borders of the table using the @< @> $< $> makers."
3041 s start)
3046 org-table-current-ncol)
3050 len
3057 s)
3060 "Replace $const with values in string F."
3062 ;; First, check for column names
3067 ;; Parameters and constants
3069 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3079 f))
3082 "Find the value for a parameter or constant in a formula.
3083 Parameters get priority."
3114 map))
3121 "--"
3124 "--"
3125 "Shift Reference at Point"
3130 "-"
3131 "Change Test Row for Column Formulas"
3134 "--"
3139 org-table-overlay-coordinates)]
3140 "--"
3147 "Edit the formulas of the current table in a separate buffer."
3149 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3163 entry s type title)
3166 ;; Keep global-font-lock-mode from turning on font-lock-mode
3207 "Convert a formula from internal to user representation."
3210 s))
3213 "Convert a formula from user to internal representation."
3216 s))
3219 "Convert spreadsheet references from A7 to @7$28.
3220 Works for single references, but also for entire formulas and even the
3221 full TBLFM line."
3223 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3226 ;; format match, just advance
3231 ;; 3.e5 or something like this.
3234 ;; (member (match-string 1 s)
3235 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3236 )
3237 ;; function name, just advance
3247 t t s)))))
3248 s))
3251 "Convert spreadsheet references from to @7$28 to AB7.
3252 Works for single references, but also for entire formulas and even the
3253 full TBLFM line."
3260 t t s)))
3265 t nil s)))
3266 s)
3269 "Convert a base 26 number represented by letters into an integer.
3270 For example: AB -> 28."
3276 n))
3279 "Convert an integer into a base 26 number represented by letters.
3280 For example: 28 -> AB."
3285 s))
3288 "Convert a time string into numerical duration in seconds.
3289 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3290 If S is a string representing a number, keep this number."
3313 "Convert a number of seconds to a time string.
3314 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3315 minutes or seconds."
3327 "Convert all references in this buffer, using FUNCTION."
3337 "Convert all references in the buffer from B3 to @3$2 and back."
3347 "Shift the reference at point one row/hline up."
3351 "Shift the reference at point one row/hline down."
3355 "Shift the reference at point one field to the left."
3359 "Shift the reference at point one field to the right."
3370 ;; A B3-like reference
3376 ;; An internal reference
3382 "Re-match the group N, and replace it with the shifted reference."
3387 t t)))
3390 "Shift a reference part REF.
3391 If DECR is set, decrease the references row/column, else increase.
3392 If HLINE is set, this may be a hline reference, it certainly is not
3393 a translation reference."
3422 "Toggle the display of coordinates in the referenced table."
3431 "Parse the buffer for formula definitions and install them.
3432 With prefix ARG, apply the new formulas to the table."
3442 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3443 nil t)
3467 "Abort editing formulas, without installing the changes."
3478 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3519 "Show the location/value of the $ expression at point."
3528 var name e what match dest)
3533 "$1.."
3616 ;; column number
3644 org-table-fedit-scroll-down))))
3655 "Make sure the cursor is in a dataline in a table."
3664 p1 p2)))
3669 "Move cursor one line up in the window showing the table."
3674 "Move cursor one line down in the window showing the table."
3679 "Move the cursor in the window showing the table.
3680 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3705 "Add a new overlay."
3711 "Highlight rectangular region in a table."
3715 l1 c1 l2 c2 tmp)
3739 "Remove the rectangle overlays."
3750 "Add overlays to the table at point, to show row/column coordinates."
3779 "Toggle the display of Row/Column numbers in tables."
3791 "Toggle the formula debugger in tables."
3797 ;;; The orgtbl minor mode
3799 ;; Define a minor mode which can be used in other modes in order to
3800 ;; integrate the org-mode table editor.
3802 ;; This is really a hack, because the org-mode table editor uses several
3803 ;; keys which normally belong to the major mode, for example the TAB and
3804 ;; RET keys. Here is how it works: The minor mode defines all the keys
3805 ;; necessary to operate the table editor, but wraps the commands into a
3806 ;; function which tests if the cursor is currently inside a table. If that
3807 ;; is the case, the table editor command is executed. However, when any of
3808 ;; those keys is used outside a table, the function uses `key-binding' to
3809 ;; look up if the key has an associated command in another currently active
3810 ;; keymap (minor modes, major mode, global), and executes that command.
3811 ;; There might be problems if any of the keys used by the table editor is
3812 ;; otherwise used as a prefix key.
3814 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3815 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3816 ;; addresses this by checking explicitly for both bindings.
3818 ;; The optimized version (see variable `orgtbl-optimized') takes over
3819 ;; all keys which are bound to `self-insert-command' in the *global map*.
3820 ;; Some modes bind other commands to simple characters, for example
3821 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3822 ;; active, this binding is ignored inside tables and replaced with a
3823 ;; modified self-insert.
3829 ;;;###autoload
3831 "Unconditionally turn on `orgtbl-mode'."
3846 ;; Install it as a minor mode.
3850 ;;;###autoload
3852 "The `org-mode' table editor as a minor mode for use in other modes."
3857 ;; Exit without error, in case some hook functions calls this
3858 ;; by accident in org-mode.
3862 ;; Make sure we are first in minor-mode-map-alist
3864 ;; FIXME: maybe it should use emulation-mode-map-alists?
3871 auto-fill-inhibit-regexp)
3875 auto-fill-inhibit-regexp)
3876 orgtbl-line-start-regexp))
3894 "Remove all properties related to narrow-column invisibility."
3907 "Create a function for binding in the table minor mode.
3908 FUN is the command to call inside a table. N is used to create a unique
3909 command name. KEYS are keys that should be checked in for a command
3910 to execute outside of tables."
3916 "Outside of tables, run the binding of `"
3928 keys)
3932 "Error when there is no default binding for a table key."
3937 "Setup orgtbl keymaps."
3968 elt key fun cmd)
3976 ;; Special treatment needed for TAB and RET
3996 [(tab)] "\C-i")))
3998 (org-defkey orgtbl-mode-map [backtab]
4000 [backtab] [S-iso-lefttab] [(shift tab)]
4001 [(tab)] "\C-i"))
4003 (org-defkey orgtbl-mode-map "\M-\C-m"
4004 (orgtbl-make-binding 'org-table-wrap-region 105
4005 "\M-\C-m" [(meta return)]))
4006 (org-defkey orgtbl-mode-map [(meta return)]
4007 (orgtbl-make-binding 'org-table-wrap-region 106
4008 [(meta return)] "\M-\C-m"))
4010 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4011 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4013 (when orgtbl-optimized
4014 ;; If the user wants maximum table support, we need to hijack
4015 ;; some standard editing functions
4016 (org-remap orgtbl-mode-map
4017 'self-insert-command 'orgtbl-self-insert-command
4018 'delete-char 'org-delete-char
4019 'delete-backward-char 'org-delete-backward-char)
4020 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4021 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4022 '("OrgTbl"
4023 ["Create or convert" org-table-create-or-convert-from-region
4024 :active (not (org-at-table-p)) :keys "C-c |" ]
4025 "--"
4026 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4027 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4028 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4029 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4030 "--"
4031 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4032 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4033 ["Copy Field from Above"
4034 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4035 "--"
4036 ("Column"
4037 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4038 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4039 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4040 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4041 ("Row"
4042 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4043 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4044 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4045 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4046 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4047 "--"
4048 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4049 ("Rectangle"
4050 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4051 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4052 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4053 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4054 "--"
4055 ("Radio tables"
4056 ["Insert table template" orgtbl-insert-radio-table
4057 (assq major-mode orgtbl-radio-table-templates)]
4058 ["Comment/uncomment table" orgtbl-toggle-comment t])
4059 "--"
4060 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4061 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4062 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4063 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4064 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4065 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4066 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4067 ["Sum Column/Rectangle" org-table-sum
4068 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4069 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4070 ["Debug Formulas"
4071 org-table-toggle-formula-debugger :active (org-at-table-p)
4072 :keys "C-c {"
4073 :style toggle :selected org-table-formula-debug]
4074 ["Show Col/Row Numbers"
4075 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4076 :keys "C-c }"
4077 :style toggle :selected org-table-overlay-coordinates]
4078 ))
4079 t))
4081 (defun orgtbl-ctrl-c-ctrl-c (arg)
4082 "If the cursor is inside a table, realign the table.
4083 If it is a table to be sent away to a receiver, do it.
4084 With prefix arg, also recompute table."
4085 (interactive "P")
4086 (let ((case-fold-search t) (pos (point)) action consts-str consts cst const-str)
4087 (save-excursion
4088 (beginning-of-line 1)
4089 (setq action (cond
4093 (cond
4094 ((integerp action)
4095 (goto-char action)
4096 (org-table-maybe-eval-formula)
4097 (if arg
4098 (call-interactively 'org-table-recalculate)
4099 (org-table-maybe-recalculate-line))
4100 (call-interactively 'org-table-align)
4101 (when (orgtbl-send-table 'maybe)
4102 (run-hooks 'orgtbl-after-send-table-hook)))
4103 ((eq action 'recalc)
4104 (save-excursion
4105 (goto-char (point-min))
4107 (setq const-str (substring-no-properties (match-string 1)))
4109 (when consts
4110 (let (e)
4111 (while (setq e (pop consts))
4113 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4114 (setq org-table-formula-constants-local cst)))))
4115 (save-excursion
4116 (beginning-of-line 1)
4118 (if (org-at-table-p)
4119 (org-call-with-arg 'org-table-recalculate t))))
4120 (t (let (orgtbl-mode)
4121 (call-interactively (key-binding "\C-c\C-c")))))))
4123 (defun orgtbl-create-or-convert-from-region (arg)
4124 "Create table or convert region to table, if no conflicting binding.
4125 This installs the table binding `C-c |', but only if there is no
4126 conflicting binding to this key outside orgtbl-mode."
4127 (interactive "P")
4128 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4129 (if cmd
4130 (call-interactively cmd)
4131 (call-interactively 'org-table-create-or-convert-from-region))))
4133 (defun orgtbl-tab (arg)
4134 "Justification and field motion for `orgtbl-mode'."
4135 (interactive "P")
4136 (if arg (org-table-edit-field t)
4137 (org-table-justify-field-maybe)
4138 (org-table-next-field)))
4140 (defun orgtbl-ret ()
4141 "Justification and field motion for `orgtbl-mode'."
4142 (interactive)
4143 (if (bobp)
4144 (newline)
4145 (org-table-justify-field-maybe)
4146 (org-table-next-row)))
4148 (defun orgtbl-self-insert-command (N)
4149 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4150 If the cursor is in a table looking at whitespace, the whitespace is
4151 overwritten, and the table is not marked as requiring realignment."
4152 (interactive "p")
4153 (if (and (org-at-table-p)
4154 (or
4155 (and org-table-auto-blank-field
4156 (member last-command
4157 '(orgtbl-hijacker-command-100
4158 orgtbl-hijacker-command-101
4159 orgtbl-hijacker-command-102
4160 orgtbl-hijacker-command-103
4161 orgtbl-hijacker-command-104
4162 orgtbl-hijacker-command-105
4163 yas/expand))
4164 (org-table-blank-field))
4165 t)
4166 (eq N 1)
4168 (let (org-table-may-need-update)
4169 (goto-char (1- (match-end 0)))
4170 (backward-delete-char 1)
4171 (goto-char (match-beginning 0))
4172 (self-insert-command N))
4173 (setq org-table-may-need-update t)
4174 (let* (orgtbl-mode
4175 a
4176 (cmd (or (key-binding
4177 (or (and (listp function-key-map)
4178 (setq a (assoc last-input-event function-key-map))
4179 (cdr a))
4180 (vector last-input-event)))
4181 'self-insert-command)))
4182 (call-interactively cmd)
4183 (if (and org-self-insert-cluster-for-undo
4184 (eq cmd 'self-insert-command))
4185 (if (not (eq last-command 'orgtbl-self-insert-command))
4186 (setq org-self-insert-command-undo-counter 1)
4187 (if (>= org-self-insert-command-undo-counter 20)
4188 (setq org-self-insert-command-undo-counter 1)
4189 (and (> org-self-insert-command-undo-counter 0)
4190 buffer-undo-list
4191 (not (cadr buffer-undo-list)) ; remove nil entry
4192 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4193 (setq org-self-insert-command-undo-counter
4194 (1+ org-self-insert-command-undo-counter))))))))
4197 "Regular expression matching exponentials as produced by calc.")
4199 (defun orgtbl-export (table target)
4200 (require 'org-exp)
4201 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4203 org-table-last-alignment org-table-last-column-widths
4204 maxcol column)
4205 (if (not (fboundp func))
4206 (error "Cannot export orgtbl table to %s" target))
4207 (setq lines (org-table-clean-before-export lines))
4208 (setq table
4209 (mapcar
4210 (lambda (x)
4211 (if (string-match org-table-hline-regexp x)
4212 'hline
4214 lines))
4215 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4216 table)))
4217 (loop for i from (1- maxcol) downto 0 do
4218 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4219 (setq column (delq nil column))
4220 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4221 (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))
4222 (funcall func table nil)))
4224 (defun orgtbl-gather-send-defs ()
4225 "Gather a plist of :name, :transform, :params for each destination before
4226 a radio table."
4227 (save-excursion
4228 (goto-char (org-table-begin))
4229 (let (rtn)
4230 (beginning-of-line 0)
4231 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4232 (let ((name (org-no-properties (match-string 1)))
4233 (transform (intern (match-string 2)))
4234 (params (if (match-end 3)
4235 (read (concat "(" (match-string 3) ")")))))
4236 (push (list :name name :transform transform :params params)
4237 rtn)
4238 (beginning-of-line 0)))
4239 rtn)))
4241 (defun orgtbl-send-replace-tbl (name txt)
4242 "Find and replace table NAME with TXT."
4243 (save-excursion
4244 (goto-char (point-min))
4245 (unless (re-search-forward
4247 (error "Don't know where to insert translated table"))
4248 (goto-char (match-beginning 0))
4249 (beginning-of-line 2)
4250 (save-excursion
4251 (let ((beg (point)))
4252 (unless (re-search-forward
4253 (concat "END RECEIVE ORGTBL +" name) nil t)
4254 (error "Cannot find end of insertion region"))
4255 (beginning-of-line 1)
4256 (delete-region beg (point))))
4259 ;;;###autoload
4260 (defun org-table-to-lisp (&optional txt)
4261 "Convert the table at point to a Lisp structure.
4262 The structure will be a list. Each item is either the symbol `hline'
4263 for a horizontal separator line, or a list of field values as strings.
4264 The table is taken from the parameter TXT, or from the buffer at point."
4265 (unless txt
4266 (unless (org-at-table-p)
4267 (error "No table at point")))
4268 (let* ((txt (or txt
4269 (buffer-substring-no-properties (org-table-begin)
4270 (org-table-end))))
4273 (mapcar
4274 (lambda (x)
4275 (if (string-match org-table-hline-regexp x)
4276 'hline
4278 lines)))
4280 (defun orgtbl-send-table (&optional maybe)
4281 "Send a transformed version of this table to the receiver position.
4282 With argument MAYBE, fail quietly if no transformation is defined for
4283 this table."
4284 (interactive)
4285 (catch 'exit
4286 (unless (org-at-table-p) (error "Not at a table"))
4287 ;; when non-interactive, we assume align has just happened.
4288 (when (org-called-interactively-p 'any) (org-table-align))
4289 (let ((dests (orgtbl-gather-send-defs))
4290 (txt (buffer-substring-no-properties (org-table-begin)
4291 (org-table-end)))
4292 (ntbl 0))
4293 (unless dests (if maybe (throw 'exit nil)
4294 (error "Don't know how to transform this table")))
4295 (dolist (dest dests)
4296 (let* ((name (plist-get dest :name))
4297 (transform (plist-get dest :transform))
4298 (params (plist-get dest :params))
4299 (skip (plist-get params :skip))
4300 (skipcols (plist-get params :skipcols))
4301 (no-escape (plist-get params :no-escape))
4302 beg
4303 (lines (org-table-clean-before-export
4304 (nthcdr (or skip 0)
4306 (i0 (if org-table-clean-did-remove-column 2 1))
4307 (lines (if no-escape lines
4308 (mapcar (lambda(l) (replace-regexp-in-string
4310 (table (mapcar
4311 (lambda (x)
4312 (if (string-match org-table-hline-regexp x)
4313 'hline
4314 (org-remove-by-index
4316 skipcols i0)))
4317 lines))
4318 (fun (if (= i0 2) 'cdr 'identity))
4319 (org-table-last-alignment
4320 (org-remove-by-index (funcall fun org-table-last-alignment)
4321 skipcols i0))
4322 (org-table-last-column-widths
4323 (org-remove-by-index (funcall fun org-table-last-column-widths)
4324 skipcols i0))
4325 (txt (if (fboundp transform)
4326 (funcall transform table params)
4327 (error "No such transformation function %s" transform))))
4328 (orgtbl-send-replace-tbl name txt))
4329 (setq ntbl (1+ ntbl)))
4330 (message "Table converted and installed at %d receiver location%s"
4331 ntbl (if (> ntbl 1) "s" ""))
4332 (if (> ntbl 0)
4333 ntbl
4334 nil))))
4336 (defun org-remove-by-index (list indices &optional i0)
4337 "Remove the elements in LIST with indices in INDICES.
4338 First element has index 0, or I0 if given."
4339 (if (not indices)
4340 list
4341 (if (integerp indices) (setq indices (list indices)))
4342 (setq i0 (1- (or i0 0)))
4343 (delq :rm (mapcar (lambda (x)
4344 (setq i0 (1+ i0))
4345 (if (memq i0 indices) :rm x))
4346 list))))
4348 (defun orgtbl-toggle-comment ()
4349 "Comment or uncomment the orgtbl at point."
4350 (interactive)
4351 (let* ((case-fold-search t)
4352 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4353 (re2 (concat "^" orgtbl-line-start-regexp))
4354 (commented (save-excursion (beginning-of-line 1)
4355 (cond ((looking-at re1) t)
4356 ((looking-at re2) nil)
4357 (t (error "Not at an org table")))))
4358 (re (if commented re1 re2))
4359 beg end)
4360 (save-excursion
4361 (beginning-of-line 1)
4362 (while (looking-at re) (beginning-of-line 0))
4363 (beginning-of-line 2)
4364 (setq beg (point))
4365 (while (looking-at re) (beginning-of-line 2))
4366 (setq end (point)))
4367 (comment-region beg end (if commented '(4) nil))))
4369 (defun orgtbl-insert-radio-table ()
4370 "Insert a radio table template appropriate for this major mode."
4371 (interactive)
4372 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4373 (txt (nth 1 e))
4374 name pos)
4375 (unless e (error "No radio table setup defined for %s" major-mode))
4376 (setq name (read-string "Table name: "))
4377 (while (string-match "%n" txt)
4378 (setq txt (replace-match name t t txt)))
4380 (setq pos (point))
4381 (insert txt)
4382 (goto-char pos)))
4384 ;; Dynamically bound input and output for table formatting.
4385 (defvar *orgtbl-table* nil
4386 "Carries the current table through formatting routines.")
4387 (defvar *orgtbl-rtn* nil
4388 "Formatting routines push the output lines here.")
4389 ;; Formatting parameters for the current table section.
4390 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4391 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4392 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4393 (defvar *orgtbl-fmt* nil "Format for each entry.")
4394 (defvar *orgtbl-efmt* nil "Format for numbers.")
4395 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4396 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4397 (defvar *orgtbl-lstart* nil "Text starting a row.")
4398 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4399 (defvar *orgtbl-lend* nil "Text ending a row.")
4400 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4402 (defsubst orgtbl-get-fmt (fmt i)
4403 "Retrieve the format from FMT corresponding to the Ith column."
4404 (if (and (not (functionp fmt)) (consp fmt))
4405 (plist-get fmt i)
4406 fmt))
4408 (defsubst orgtbl-apply-fmt (fmt &rest args)
4409 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4410 (cond ((functionp fmt) (apply fmt args))
4411 (fmt (apply 'format fmt args))
4412 (args (car args))
4413 (t args)))
4415 (defsubst orgtbl-eval-str (str)
4416 "If STR is a function, evaluate it with no arguments."
4417 (if (functionp str)
4418 (funcall str)
4419 str))
4421 (defun orgtbl-format-line (line)
4422 "Format LINE as a table row."
4423 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4424 (let* ((i 0)
4425 (line
4426 (mapcar
4427 (lambda (f)
4428 (setq i (1+ i))
4429 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4430 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4431 (orgtbl-apply-fmt efmt (match-string 1 f)
4432 (match-string 2 f))
4433 f)))
4434 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4435 *orgtbl-default-fmt*)
4436 f)))
4437 line)))
4438 (push (if *orgtbl-lfmt*
4439 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4440 (concat (orgtbl-eval-str *orgtbl-lstart*)
4441 (mapconcat 'identity line *orgtbl-sep*)
4442 (orgtbl-eval-str *orgtbl-lend*)))
4443 *orgtbl-rtn*))))
4445 (defun orgtbl-format-section (section-stopper)
4446 "Format lines until the first occurrence of SECTION-STOPPER."
4447 (let (prevline)
4448 (progn
4449 (while (not (eq (car *orgtbl-table*) section-stopper))
4450 (if prevline (orgtbl-format-line prevline))
4451 (setq prevline (pop *orgtbl-table*)))
4452 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4453 (*orgtbl-lend* *orgtbl-llend*)
4454 (*orgtbl-lfmt* *orgtbl-llfmt*))
4455 (orgtbl-format-line prevline))))))
4457 (defun orgtbl-to-generic (table params)
4458 "Convert the orgtbl-mode TABLE to some other format.
4459 This generic routine can be used for many standard cases.
4460 TABLE is a list, each entry either the symbol `hline' for a horizontal
4461 separator line, or a list of fields for that line.
4462 PARAMS is a property list of parameters that can influence the conversion.
4463 For the generic converter, some parameters are obligatory: you need to
4464 specify either :lfmt, or all of (:lstart :lend :sep).
4466 Valid parameters are
4468 :splice When set to t, return only table body lines, don't wrap
4469 them into :tstart and :tend. Default is nil. When :splice
4470 is non-nil, this also means that the exporter should not look
4471 for and interpret header and footer sections.
4473 :hline String to be inserted on horizontal separation lines.
4474 May be nil to ignore hlines.
4476 :sep Separator between two fields
4477 :remove-nil-lines Do not include lines that evaluate to nil.
4480 Each in the following group may be either a string or a function
4481 of no arguments returning a string:
4482 :tstart String to start the table. Ignored when :splice is t.
4483 :tend String to end the table. Ignored when :splice is t.
4484 :lstart String to start a new table line.
4485 :llstart String to start the last table line, defaults to :lstart.
4486 :lend String to end a table line
4487 :llend String to end the last table line, defaults to :lend.
4489 Each in the following group may be a string, a function of one
4490 argument (the field or line) returning a string, or a plist
4491 mapping columns to either of the above:
4492 :lfmt Format for entire line, with enough %s to capture all fields.
4493 If this is present, :lstart, :lend, and :sep are ignored.
4494 :llfmt Format for the entire last line, defaults to :lfmt.
4495 :fmt A format to be used to wrap the field, should contain
4496 %s for the original field value. For example, to wrap
4498 This may also be a property list with column numbers and
4501 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4502 Same as above, specific for the header lines in the table.
4503 All lines before the first hline are treated as header.
4504 If any of these is not present, the data line value is used.
4506 This may be either a string or a function of two arguments:
4507 :efmt Use this format to print numbers with exponentials.
4508 The format should have %s twice for inserting mantissa
4510 may also be a property list with column numbers and
4511 formats. :fmt will still be applied after :efmt.
4513 In addition to this, the parameters :skip and :skipcols are always handled
4514 directly by `orgtbl-send-table'. See manual."
4515 (interactive)
4517 (let* ((splicep (plist-get params :splice))
4518 (hline (plist-get params :hline))
4519 (skipheadrule (plist-get params :skipheadrule))
4520 (remove-nil-linesp (plist-get params :remove-nil-lines))
4521 (remove-newlines (plist-get params :remove-newlines))
4522 (*orgtbl-hline* hline)
4523 (*orgtbl-table* table)
4524 (*orgtbl-sep* (plist-get params :sep))
4525 (*orgtbl-efmt* (plist-get params :efmt))
4526 (*orgtbl-lstart* (plist-get params :lstart))
4527 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4528 (*orgtbl-lend* (plist-get params :lend))
4529 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4530 (*orgtbl-lfmt* (plist-get params :lfmt))
4531 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4532 (*orgtbl-fmt* (plist-get params :fmt))
4533 *orgtbl-rtn*)
4535 ;; Put header
4536 (unless splicep
4537 (when (plist-member params :tstart)
4538 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4539 (if tstart (push tstart *orgtbl-rtn*)))))
4541 ;; Do we have a heading section? If so, format it and handle the
4542 ;; trailing hline.
4543 (if (and (not splicep)
4544 (or (consp (car *orgtbl-table*))
4545 (consp (nth 1 *orgtbl-table*)))
4546 (memq 'hline (cdr *orgtbl-table*)))
4547 (progn
4548 (when (eq 'hline (car *orgtbl-table*))
4549 ;; there is a hline before the first data line
4550 (and hline (push hline *orgtbl-rtn*))
4551 (pop *orgtbl-table*))
4552 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4553 *orgtbl-lstart*))
4554 (*orgtbl-llstart* (or (plist-get params :hllstart)
4555 *orgtbl-llstart*))
4556 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4557 (*orgtbl-llend* (or (plist-get params :hllend)
4558 (plist-get params :hlend) *orgtbl-llend*))
4559 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4560 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4561 (plist-get params :hlfmt) *orgtbl-llfmt*))
4562 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4563 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4564 (orgtbl-format-section 'hline))
4565 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4566 (pop *orgtbl-table*)))
4568 ;; Now format the main section.
4569 (orgtbl-format-section nil)
4571 (unless splicep
4572 (when (plist-member params :tend)
4573 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4574 (if tend (push tend *orgtbl-rtn*)))))
4576 (mapconcat (if remove-newlines
4577 (lambda (tend)
4579 'identity)
4580 (nreverse (if remove-nil-linesp
4581 (remq nil *orgtbl-rtn*)
4584 (defun orgtbl-to-tsv (table params)
4585 "Convert the orgtbl-mode table to TAB separated material."
4587 (defun orgtbl-to-csv (table params)
4588 "Convert the orgtbl-mode table to CSV material.
4589 This does take care of the proper quoting of fields with comma or quotes."
4590 (orgtbl-to-generic table (org-combine-plists
4591 '(:sep "," :fmt org-quote-csv-field)
4592 params)))
4594 (defun orgtbl-to-latex (table params)
4595 "Convert the orgtbl-mode TABLE to LaTeX.
4596 TABLE is a list, each entry either the symbol `hline' for a horizontal
4597 separator line, or a list of fields for that line.
4598 PARAMS is a property list of parameters that can influence the conversion.
4599 Supports all parameters from `orgtbl-to-generic'. Most important for
4600 LaTeX are:
4602 :splice When set to t, return only table body lines, don't wrap
4603 them into a tabular environment. Default is nil.
4605 :fmt A format to be used to wrap the field, should contain %s for the
4606 original field value. For example, to wrap everything in dollars,
4609 The format may also be a function that formats its one argument.
4611 :efmt Format for transforming numbers with exponentials. The format
4612 should have %s twice for inserting mantissa and exponent, for
4614 This may also be a property list with column numbers and formats.
4615 The format may also be a function that formats its two arguments.
4617 :llend If you find too much space below the last line of a table,
4620 The general parameters :skip and :skipcols have already been applied when
4621 this function is called."
4622 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4623 org-table-last-alignment ""))
4624 (params2
4625 (list
4630 (orgtbl-to-generic table (org-combine-plists params2 params))))
4632 (defun orgtbl-to-html (table params)
4633 "Convert the orgtbl-mode TABLE to HTML.
4634 TABLE is a list, each entry either the symbol `hline' for a horizontal
4635 separator line, or a list of fields for that line.
4636 PARAMS is a property list of parameters that can influence the conversion.
4637 Currently this function recognizes the following parameters:
4639 :splice When set to t, return only table body lines, don't wrap
4640 them into a <table> environment. Default is nil.
4642 The general parameters :skip and :skipcols have already been applied when
4643 this function is called. The function does *not* use `orgtbl-to-generic',
4644 so you cannot specify parameters for it."
4645 (let* ((splicep (plist-get params :splice))
4646 (html-table-tag org-export-html-table-tag)
4647 html)
4648 ;; Just call the formatter we already have
4649 ;; We need to make text lines for it, so put the fields back together.
4650 (setq html (org-format-org-table-html
4651 (mapcar
4652 (lambda (x)
4653 (if (eq x 'hline)
4654 "|----+----|"
4655 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4656 table)
4657 splicep))
4659 (setq html (replace-match "" t t html)))
4660 html))
4662 (defun orgtbl-to-texinfo (table params)
4663 "Convert the orgtbl-mode TABLE to TeXInfo.
4664 TABLE is a list, each entry either the symbol `hline' for a horizontal
4665 separator line, or a list of fields for that line.
4666 PARAMS is a property list of parameters that can influence the conversion.
4667 Supports all parameters from `orgtbl-to-generic'. Most important for
4668 TeXInfo are:
4670 :splice nil/t When set to t, return only table body lines, don't wrap
4671 them into a multitable environment. Default is nil.
4673 :fmt fmt A format to be used to wrap the field, should contain
4674 %s for the original field value. For example, to wrap
4676 This may also be a property list with column numbers and
4678 Each format also may be a function that formats its one
4679 argument.
4682 are computed automatically from the width of the columns
4683 under org-mode.
4685 The general parameters :skip and :skipcols have already been applied when
4686 this function is called."
4687 (let* ((total (float (apply '+ org-table-last-column-widths)))
4688 (colfrac (or (plist-get params :cf)
4689 (mapconcat
4690 (lambda (x) (format "%.3f" (/ (float x) total)))
4691 org-table-last-column-widths " ")))
4692 (params2
4693 (list
4694 :tstart (concat "@multitable @columnfractions " colfrac)
4695 :tend "@end multitable"
4696 :lstart "@item " :lend "" :sep " @tab "
4697 :hlstart "@headitem ")))
4698 (orgtbl-to-generic table (org-combine-plists params2 params))))
4700 (defun orgtbl-to-orgtbl (table params)
4701 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4702 Useful when slicing one table into many. The :hline, :sep,
4703 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4704 and :tend suppress strings without splicing; they can be set to
4705 provide ORGTBL directives for the generated table."
4706 (let* ((params2
4707 (list
4708 :remove-newlines t
4709 :tstart nil :tend nil
4710 :hline "|---"
4711 :sep " | "
4712 :lstart "| "
4713 :lend " |"))
4714 (params (org-combine-plists params2 params)))
4715 (orgtbl-to-generic table params)))
4717 (defun org-table-get-remote-range (name-or-id form)
4718 "Get a field value or a list of values in a range from table at ID.
4720 NAME-OR-ID may be the name of a table in the current file as set by
4722 will then be used. Alternatively, it may be an ID referring to
4723 any entry, also in a different file. In this case, the first table
4724 in that entry will be referenced.
4728 The return value is either a single string for a single field, or a
4729 list of the fields in the rectangle ."
4730 (save-match-data
4731 (let ((case-fold-search t) (id-loc nil)
4732 ;; Protect a bunch of variables from being overwritten
4733 ;; by the context of the remote table
4734 org-table-column-names org-table-column-name-regexp
4735 org-table-local-parameters org-table-named-field-locations
4736 org-table-current-line-types org-table-current-begin-line
4737 org-table-current-begin-pos org-table-dlines
4738 org-table-current-ncol
4739 org-table-hlines org-table-last-alignment
4740 org-table-last-column-widths org-table-last-alignment
4741 org-table-last-column-widths tbeg
4742 buffer loc)
4743 (setq form (org-table-convert-refs-to-rc form))
4744 (save-excursion
4745 (save-restriction
4746 (widen)
4747 (save-excursion
4748 (goto-char (point-min))
4749 (if (re-search-forward
4751 nil t)
4752 (setq buffer (current-buffer) loc (match-beginning 0))
4753 (setq id-loc (org-id-find name-or-id 'marker))
4754 (unless (and id-loc (markerp id-loc))
4756 (setq buffer (marker-buffer id-loc)
4757 loc (marker-position id-loc))
4758 (move-marker id-loc nil)))
4759 (with-current-buffer buffer
4760 (save-excursion
4761 (save-restriction
4762 (widen)
4763 (goto-char loc)
4764 (forward-char 1)
4766 (not (match-beginning 1)))
4767 (error "Cannot find a table at NAME or ID %s" name-or-id))
4768 (setq tbeg (point-at-bol))
4769 (org-table-get-specials)
4770 (setq form (org-table-formula-substitute-names
4771 (org-table-formula-handle-first/last-rc form)))
4772 (if (and (string-match org-table-range-regexp form)
4773 (> (length (match-string 0 form)) 1))
4774 (save-match-data
4775 (org-table-get-range (match-string 0 form) tbeg 1))
4776 form)))))))))
4778 (provide 'org-table)
4780 ;;; org-table.el ends here