| blob | 5eeaf6199f4f951ae9c7976053df20aed9e2645c |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 7.7
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the table editor and spreadsheet for Org-mode.
30 ;; Watch out: Here we are talking about two different kind of tables.
31 ;; Most of the code is for the tables created with the Org-mode table editor.
32 ;; Sometimes, we talk about tables created and edited with the table.el
33 ;; Emacs package. We call the former org-type tables, and the latter
34 ;; table.el-type tables.
36 ;;; 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, othewise, 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 | | |
90 "Templates for radio tables in different major modes.
91 All occurrences of %n in a template will be replaced with the name of the
92 table, obtained by prompting the user."
99 "Settings for tables in Org-mode."
104 "The default size for newly created tables, Columns x Rows."
110 "Regular expression for recognizing numbers in table columns.
111 If a table column contains mostly numbers, it will be aligned to the
112 right. If not, it will be aligned to the left.
114 The default value of this option is a regular expression which allows
115 anything which looks remotely like a number as used in scientific
116 context. For example, all of the following will be considered a
117 number:
118 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
120 Other options offered by the customize interface are more restrictive."
138 "Fraction of numbers in a column required to make the column align right.
139 In a column all non-white fields are considered. If at least this
140 fraction of fields is matched by `org-table-number-fraction',
141 alignment to the right border applies."
146 "Behavior of tables during editing in Org-mode."
151 "Non-nil means automatically re-align table when pressing TAB or RETURN.
153 removal/insertion."
158 "Non-nil means automatically blank table field when starting to type into it.
159 This only happens when typing immediately after a field motion
160 command (TAB, S-TAB or RET).
161 Only relevant when `org-enable-table-editor' is equal to `optimized'."
166 "Non-nil means automatically exit the follow mode.
167 When nil, the follow mode will stay on and be active in any table
168 the cursor enters. Since the table follow filed mode messes with the
169 window configuration, it is not recommended to set this variable to nil,
170 except maybe locally in a special file that has mostly tables with long
171 fields."
176 "Whether the user should confirm when Org fixes formulas."
183 'safe-local-variable
187 "Non-nil means tab in the last column of a table with jump over a hline.
188 If a horizontal separator line is following the current line,
189 `org-table-next-field' can either create a new row before that line, or jump
190 over the line. When this option is nil, a new line will be created before
191 this line."
196 "Options concerning tables in Org-mode."
201 "Should org-mode work with table references like B3 instead of @3$2?
202 Possible values are:
203 nil never use them
204 from accept as input, do not present for editing
205 t accept as input and present for editing"
220 calc-angle-mode deg
221 calc-prefer-frac nil
222 calc-symbolic-mode nil
224 calc-display-working-message t
225 )
226 "List with Calc mode settings for use in `calc-eval' for table formulas.
227 The list must contain alternating symbols (Calc modes variables and values).
228 Don't remove any of the default settings, just change the values. Org-mode
229 relies on the variables to be present in the list."
234 "Format for the output of calc computations like $1+$2;t.
235 The default value is 'hours, and will output the results as a
236 number of hours. Other allowed values are 'seconds, 'minutes and
237 'days, and the output will be a fraction of seconds, minutes or
238 days."
246 "Non-nil means TAB and RET evaluate a formula in current table field.
247 If the current field starts with an equal sign, it is assumed to be a formula
248 which should be evaluated as described in the manual and in the documentation
249 string of the command `org-table-eval-formula'. This feature requires the
250 Emacs calc package.
251 When this variable is nil, formula calculation is only available through
257 "Non-nil means interpret constants in formulas in tables.
258 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
259 by the value given in `org-table-formula-constants', or by a value obtained
260 from the `constants.el' package."
265 "Alist with constant names and values, for use in table formulas.
266 The car of each element is a name of a constant, without the `$' before it.
267 The cdr is the value as a string. For example, if you'd like to use the
268 speed of light in a formula, you would configure
272 and then use it in an equation like `$1*$c'.
274 Constants can also be defined on a per-file basis using a line like
276 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
283 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
284 Automatically means when TAB or RET or C-c C-c are pressed in the line."
289 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
294 "Non-nil means relative formula references may cross hlines.
295 Here are the allowed values:
297 nil Relative references may not cross hlines. They will reference the
298 field next to the hline instead. Coming from below, the reference
299 will be to the field below the hline. Coming from above, it will be
300 to the field above.
301 t Relative references may cross hlines.
302 error An attempt to cross a hline will throw an error.
304 It is probably good to never set this variable to nil, for the sake of
305 portability of tables."
313 "Options concerning table import and export in Org-mode."
318 "Default export parameters for `org-table-export'.
319 These can be overridden for a specific table by setting the
320 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
321 radio tables for the different export transformations and
322 available parameters."
360 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
361 ;; 1 2 3 4 5
372 "Is this a table line colgroup information?"
376 line)
378 nil
385 "Is this a table line with only alignment/width cookies?"
398 s))))
407 "Use the table.el package to insert a new table.
408 If there is already a table at point, convert between Org-mode tables
409 and table.el tables."
423 "Convert region to table, or create an empty table.
424 If there is an active region, convert it to a table, using the function
425 `org-table-convert-region'. See the documentation of that function
426 to learn how the prefix argument is interpreted to determine the field
427 separator.
428 If there is no such region, create an empty table with `org-table-create'."
435 "Query for a size and insert a table skeleton.
455 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
459 ;; Insert a hline after the first row.
467 "Convert region to a table.
468 The region goes from BEG0 to END0, but these borders will be moved
469 slightly, to make sure a beginning of line in the first line is included.
471 SEPARATOR specifies the field separator in the lines. It can have the
472 following values:
474 '(4) Use the comma as a field separator
475 '(16) Use a TAB as field separator
476 integer When a number, use that many spaces as field separator
477 nil When nil, the command tries to be smart and figure out the
478 separator in the following way:
479 - when each line contains a TAB, assume TAB-separated material
480 - when each line contains a comma, assume CSV material
481 - else, assume one or more SPACE characters as separator."
485 re)
492 ;; Get the right field separator
503 ;; parse the csv stuff
527 "Import FILE as a table.
528 The file is assumed to be tab-separated. Such files can be produced by most
529 spreadsheet and database applications. If no tabs (at least one per line)
530 are found, lines will be split on whitespace into fields."
542 "Export table to a file, with configurable format.
543 Such a file can be imported into a spreadsheet program like Excel.
544 FILE can be the output file name. If not given, it will be taken from
545 a TABLE_EXPORT_FILE property in the current entry or higher up in the
546 hierarchy, or the user will be prompted for a file name.
547 FORMAT can be an export format, of the same kind as it used when
548 `orgtbl-mode' sends a table in a different format. The default format can
549 be found in the variable `org-table-export-default-format', but the function
550 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
551 property, locally or anywhere up in the hierarchy."
563 buf deffmt-readable)
582 "Format: "
587 deffmt-readable)))
600 'hline
603 skipcols i0)))
604 lines))
608 skipcols i0))
611 skipcols i0)))
628 "Marker at the beginning of the table last aligned.
631 "Marker at the end of the table last aligned.
634 "List of flags for flushright alignment, from the last re-alignment.
637 "List of max width of fields in each column.
640 "Non-nil means debug table formulas.
653 "Align the table at point by aligning all vertical bars."
656 ;; Limits of table
659 ;; Current cursor position
665 column
667 rfmt hfmt
675 emptystrings links dates emph raise narrow
676 falign falign1 fmax f1 len c e space)
679 ;; Check if we have links or dates
691 ;; Make sure the link properties are right
693 ;; Make sure the date properties are right
698 ;; Check if we are narrowing any columns
701 org-format-transports-properties-p
706 ;; Get the rows
709 ;; Store the indentation of the first line
712 ;; Mark the hlines by setting the corresponding element to nil
713 ;; At the same time, we remove trailing space.
716 nil
719 l)))
720 lines))
721 ;; Get the data fields by splitting the lines.
726 ;; How many fields in the longest line?
733 ;; A list of empty strings to fill any short rows on output
735 ;; Check for special formatting.
739 ;; Check if there is an explicit width specified
749 ;; Find fields that are wider than fmax, and shorten them
755 'help-echo
756 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
764 xx)))))
765 ;; Get the maximum width for each column
767 lengths)
768 ;; Get the fraction of numbers, to decide about alignment of the column
774 nil
781 ;; Store the alignment of this table, for later editing of single fields
783 org-table-last-column-widths lengths)
785 ;; With invisible characters, `format' does not get the field width right
786 ;; So we need to make these fields wide by hand.
804 ;; Compute the formats needed for output of the table
817 hfmt))
820 ;; This hack is for org-indent, to force redisplay of the
821 ;; line prefix of the first line. Apparently the redisplay
822 ;; is tied to the newline, which is, I think, a bug.
823 ;; To force this redisplay, we remove and re-insert the
824 ;; newline, so that the redisplay engine thinks it belongs
825 ;; to the changed text.
831 ;; Replace the old one
838 ;; Try to move to the old location
846 ))
849 "Find the beginning of the table and return its position.
850 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
854 org-table-border-regexp)
855 nil t))
862 "Find the end of the table and return its position.
863 With argument TABLE-TYPE, go to the end of a table.el-type table."
867 org-table-border-regexp)
868 nil t))
874 "Justify the current field, text to left, number to right.
875 Optional argument NEW may specify text to replace the current field content."
884 ;; This is not the same table, force a full re-align
890 l f n o e)
914 "Go to the next field in the current table, creating new lines as needed.
915 Before doing so, re-align the table if necessary."
920 org-table-may-need-update)
931 org-table-tab-jumps-over-hlines
943 "Go to the previous field in the table.
944 Before doing so, re-align the table if necessary."
949 org-table-may-need-update)
964 "Move to the end of the current table field.
965 If already at or after the end, move to the end of the next table field.
966 With numeric argument N, move N-1 fields forward first."
979 "Move to the beginning of the current table field.
980 If already at or before the beginning, move to the beginning of the
981 previous field.
982 With numeric argument N, move N-1 fields backward first."
996 "Go to the next row (same column) in the current table.
997 Before doing so, re-align the table if necessary."
1005 org-table-may-need-update)
1019 "Copy a field down in the current column.
1020 If the field at the cursor is empty, copy into it the content of
1021 the nearest non-empty field above. With argument N, use the Nth
1022 non-empty field. If the current field is not empty, it is copied
1023 down to the next row, and the cursor is moved with it.
1024 Therefore, repeating this command causes the column to be filled
1025 row-by-row.
1026 If the variable `org-table-copy-increment' is non-nil and the
1027 field is an integer or a timestamp, it will be incremented while
1028 copying. In the case of a timestamp, increment by one day."
1036 txt)
1048 beg t))
1071 "Is point inside a table data field?
1072 I.e. not on a hline or before the first or after the last column?
1073 This actually throws an error, so it aborts the current command."
1079 nil
1081 t))
1087 "Get the field in table line LINE, column COLUMN.
1088 If LINE is larger than the number of data lines in the table, the function
1089 returns nil. However, if COLUMN is too large, we will simply return an
1090 empty string.
1091 If LINE is nil, use the current line.
1092 If column is nil, use the current column."
1099 "Put VALUE into line LINE, column COLUMN.
1100 When ALIGN is set, also realign the table."
1109 "Return the index of the current data line."
1116 cnt))
1119 "Go to the Nth data line in the current table.
1120 Return t when the line exists, nil if it does not exist."
1128 "Blank the current table field or active region."
1145 "Return the value of the field in column N of current row.
1146 N defaults to current field.
1147 If REPLACE is a string, replace field with this value. The return value
1148 is always the old value."
1157 t t))
1159 val)
1163 "Show info about the current field, and highlight any reference at point."
1171 org-table-named-field-locations)))
1191 dline col
1193 dline col ref1
1195 ;; FIXME: formula info not correct if special table line
1205 "Find out which column we are in."
1215 cnt)))
1218 "Find out what table data line we are in.
1219 Only data lines count for this."
1231 cnt)))
1234 "Move the cursor to the Nth column in the current table line.
1235 With optional argument ON-DELIM, stop with point before the left delimiter
1236 of the field.
1237 If there are less than N fields, just go to after the last delimiter.
1238 However, when FORCE is non-nil, create new columns if necessary."
1248 t)))))
1256 "Insert a new column into the table."
1264 ;; Current cursor position
1270 nil
1284 "Find a data line in the current table, which is needed for column commands."
1287 t
1298 t
1303 "Turn a buffer line number into a data line number.
1304 If there is no data line in this line, return nil.
1305 If there is no matching dline (most likely te refrence was a hline), the
1306 first dline below it is used. When ABOVE is non-nil, the one above is used."
1309 i)
1322 nil))
1325 "Delete a column from the table."
1334 ;; Current cursor position
1340 nil
1357 "Move column to the right."
1361 "Move column to the left."
1366 "Move the current column to the right. With arg LEFT, move to the left."
1376 ;; Current cursor position
1386 nil
1405 "Move table row down."
1409 "Move table row up."
1414 "Move the current table line down. With arg UP, move it up."
1423 txt hline2p)
1447 "Insert a new row above the current line into the table.
1448 With prefix ARG, insert below the current line."
1454 ;; Fix the first field if necessary
1468 "Insert a horizontal-line below the current line into the table.
1469 With prefix ABOVE, insert above the current line."
1491 "Insert a hline and move to the row below that line."
1505 In particular, this does handle wide and invisible characters."
1507 ;; It's a hline, just map the characters
1513 t t s)))
1514 s))
1517 "Delete the current row or horizontal line from the table."
1532 "Sort table lines according to the column at point.
1534 The position of point indicates the column to be used for
1535 sorting, and the range of lines is the range between the nearest
1536 horizontal separator lines, or the entire table of no such lines
1537 exist. If point is before the first column, you will be prompted
1538 for the sorting column. If there is an active region, the mark
1539 specifies the first line and the sorting column, while point
1540 should be in the last line to be included into the sorting.
1542 The command then prompts for the sorting type which can be
1543 alphabetically, numerically, or by time (as given in a time stamp
1544 in the field). Sorting in reverse order is also possible.
1546 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1548 If SORTING-TYPE is specified when this function is called from a Lisp
1549 program, no prompting will take place. SORTING-TYPE must be a character,
1550 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1551 should be done in reverse order."
1555 beg end bcol ecol tend tbeg column lns pos)
1600 x))
1613 "Copy region in table to the clipboard and blank all relevant fields.
1614 If there is no active region, use just the field at point."
1621 "Copy rectangular region in table to clipboard.
1622 A special clipboard is used which can only be accessed
1623 with `org-table-paste-rectangle'."
1627 current-prefix-arg))
1629 region cols
1655 org-table-clip))
1658 "Paste a rectangular region into a table.
1659 The upper right corner ends up in the current field. All involved fields
1660 will be overwritten. If the rectangle does not fit into the present table,
1661 the table is enlarged as needed. The process ignores horizontal separator
1662 lines."
1672 c cols field)
1688 "Convert from `org-mode' table to table.el and back.
1689 Obviously, this only works within limits. When an Org-mode table is
1690 converted to table.el, all horizontal separator lines get lost, because
1691 table.el uses these as cell boundaries and has no notion of horizontal lines.
1692 A table.el table can be converted to an Org-mode table only if it does not
1693 do row or column spanning. Multiline cells will become multiple cells.
1694 Beware, Org-mode does not test if the table can be successfully converted - it
1695 blindly applies a recipe that works for simple tables."
1699 ;; convert to Org-mode table
1708 ;; convert to table.el table
1711 ;; first, get rid of all horizontal lines
1715 ;; insert a hline before first
1719 ;; insert a hline after each line
1724 ;; replace "+" at beginning and ending of hlines
1733 "Wrap several fields in a column like a paragraph.
1734 This is useful if you'd like to spread the contents of a field over several
1735 lines, in order to keep the table compact.
1737 If there is an active region, and both point and mark are in the same column,
1738 the text in the column is wrapped to minimum width for the given number of
1739 lines. Generally, this makes the table more compact. A prefix ARG may be
1741 formats the selected text to two lines. If the region was longer than two
1742 lines, the remaining lines remain empty. A negative prefix argument reduces
1743 the current number of lines by that amount. The wrapped text is pasted back
1744 into the table. If you formatted it to more lines than it was before, fields
1745 further down in the table get overwritten - so you might need to make space in
1746 the table first.
1748 If there is no region, the current field is split at the cursor position and
1749 the text fragment to the right of the cursor is prepended to the field one
1750 line down.
1752 If there is no region, but you specify a prefix ARG, the current field gets
1753 blank, and the content is appended to the field above."
1757 ;; There is a region: fill as a paragraph
1761 nlines)
1768 arg)
1772 nil nlines)))
1776 ;; No region, split the current field at point
1780 ;; combine with field above
1790 ;; split field
1803 "Edit table field in a different window.
1804 This is mainly useful for fields that contain hidden parts.
1806 it can be edited in place."
1815 display t intangible t))
1828 p)
1844 intangible t))
1852 "Finish editing a table data field.
1853 Remove all newline characters, insert the result into the table, realign
1854 the table and kill the editing buffer."
1858 text)
1875 "Minor mode to make the table field editor window follow the cursor.
1876 When this mode is active, the field editor window will always show the
1877 current field. The mode exits automatically when the cursor leaves the
1878 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1879 nil " TblFollow" nil
1895 ;; We have left the table, exit the follow mode
1906 "Sum numbers in region of current table column.
1907 The result will be displayed in the echo area, and will be available
1910 If there is an active region, it is interpreted as a rectangle and all
1911 numbers in that rectangle will be summed. If there is no active
1912 region and point is located in a table column, sum all numbers in that
1913 column.
1915 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1916 numbers are assumed to be times as well (in decimal hours) and the
1917 numbers are added as such.
1919 If NLAST is a number, only the NLAST fields will actually be summed."
1946 items1)))
1953 s diff)
1961 sres))))
1984 "Return the formula active for the current field.
1985 Assumes that specials are in place.
1986 If KEY is given, return the key to this formula.
1990 org-table-named-field-locations)))
2004 "Read a formula from the minibuffer, offer stored formula as default.
2005 When NAMED is non-nil, look for a named equation."
2009 org-table-named-field-locations)))
2016 name
2017 ref)
2027 stored)
2029 equation)
2036 scol))
2038 'org-table-formula-history
2039 )))))
2040 mustsave)
2042 ;; remove formula
2049 ;; We set the column equation, delete the named one.
2051 mustsave t))
2057 eq))
2060 "Store the list of formulas below the current table."
2066 ;; don't overwrite TBLFM, we might use text properties to store stuff
2082 ;; Fake a high number to make sure this is sorted at the end.
2089 a)
2099 "Compare two formulas for sorting."
2105 "Return an alist with the stored formulas directly after current table."
2114 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2133 "Modify the equations after the table structure has been edited.
2135 For all numbers larger than LIMIT, shift them by DELTA."
2146 s n a)
2159 t t)))))))))
2162 "Get the column names and local parameters for this table."
2165 names name fields fields1 field cnt
2166 c v l line col types dlines hlines last-dline)
2168 org-table-local-parameters nil
2169 org-table-named-field-locations nil
2170 org-table-current-begin-line nil
2171 org-table-current-begin-pos nil
2172 org-table-current-line-types nil
2191 org-table-local-parameters))))
2207 ;; Analyze the line types
2211 l org-table-current-begin-line)
2228 al al2)
2240 If yes, store the formula and apply it."
2241 ;; We already know we are in a table. Get field will only return a formula
2242 ;; when appropriate. It might return a separator line, but no problem.
2245 named eq)
2256 "List of commands triggering the recalculation of a line.
2269 "Rotate the recalculation mark in the first column.
2270 If in any row, the first field is not consistent with a mark,
2271 insert a new column for the markers.
2272 When there is an active region, change all the lines in the region,
2273 after prompting for the marking character.
2274 After each change, a message will be displayed indicating the meaning
2275 of the new mark."
2290 epos new)
2297 newchar))
2330 "Recompute the current line if marked for it, and if we haven't just done it."
2350 modes)
2353 suppress-align suppress-const
2354 suppress-store suppress-analysis)
2355 "Replace the table field value at the cursor by the result of a calculation.
2357 This function makes use of Dave Gillespie's Calc package, in my view the
2358 most exciting program ever written for GNU Emacs. So you need to have Calc
2359 installed in order to use this function.
2361 In a table, this command replaces the value in the current field with the
2363 formula, by storing it in a special line below the table. When called
2364 with a `C-u' prefix, the current field must be a named field, and the
2365 formula is installed as valid in only this specific field.
2367 When called with two `C-u' prefixes, insert the active equation
2368 for the field back into the current field, so that it can be
2370 to check the referenced fields.
2372 When called, the command first prompts for a formula, which is read in
2373 the minibuffer. Previously entered formulas are available through the
2374 history list, and the last used formula is offered as a default.
2375 These stored formulas are adapted correctly when moving, inserting, or
2376 deleting columns with the corresponding commands.
2378 The formula can be any algebraic expression understood by the Calc package.
2379 For details, see the Org-mode manual.
2381 This function can also be called from Lisp programs and offers
2382 additional arguments: EQUATION can be the formula to apply. If this
2383 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2384 used to speed-up recursive calls by by-passing unnecessary aligns.
2385 SUPPRESS-CONST suppresses the interpretation of constants in the
2386 formula, assuming that this has been done already outside the function.
2387 SUPPRESS-STORE means the formula should not be stored, either because
2388 it is already stored, or because it is a modified equation that should
2389 not overwrite the stored one."
2405 equation
2411 n form form0 formrpl formrg bw fmt x ev orig c lispp literal duration)
2412 ;; Parse the format string. Since we have a lot of modes, this is
2413 ;; a lot of work. However, I think calc still uses most of the time.
2425 'calc-float-format
2428 n))))
2432 duration-output-format nil
2436 duration-output-format org-table-duration-custom-format
2437 numbers t
2461 ;; replace fields with duration values if relevant
2465 fields)))
2469 fields)))
2475 ;; Insert row and column number of formula result field
2486 t t form)))
2488 ;; Check for old vertical references
2490 ;; Insert remote references
2498 keep-empty numbers lispp))
2499 t t form)))
2500 ;; Insert complex ranges
2508 ;; possibly handle durations
2513 formrg)
2514 keep-empty numbers lispp)))
2519 ;; Insert simple ranges
2528 keep-empty numbers lispp))
2529 t t form)))
2531 ;; Insert the references to fields in same row
2541 t t form)))
2561 Orig: %s
2562 $xyz-> %s
2563 @r$c-> %s
2594 prop value)))
2597 "Get a calc vector from a column, according to descriptor DESC.
2598 Optional arguments TBEG and COL can give the beginning of the table and
2599 the current column, to avoid unnecessary parsing.
2601 HIGHLIGHT means just highlight the range.
2603 When CORNERS-ONLY is set, only return the corners of the range as
2604 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2605 in the buffer and column1 and column2 are table column numbers."
2612 beg end c1 c2 r1 r2 rangep tmp)
2629 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2636 ;; just one field
2643 ;; A range, return a vector
2644 ;; First sort the numbers to get a regular ractangle
2648 ;; Only return the corners of the range
2650 ;; Copy the range values into a list
2664 ;; return string representation of calc vector
2669 "Analyze descriptor DESC and retrieve the corresponding line number.
2670 The cursor is currently in line CLINE, the table begins in line BLINE,
2671 and TABLE is a vector with line types."
2679 ;; 1 2 3 4 5 6
2699 nil hn cline desc)))
2702 rel on cline desc)))
2706 "FIXME: Needs more documentation."
2719 nil))
2720 t)))
2724 desc cline)
2725 i)))
2730 s))
2733 "Convert list ELEMENTS to something appropriate to insert into formula.
2734 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2735 NUMBERS indicates that everything should be converted to numbers.
2736 LISPP means to return something appropriate for a Lisp list."
2740 elements
2749 elements))))
2755 x
2761 elements
2765 "Recalculate the current table line by applying all stored formulas.
2766 With prefix arg ALL, do this for all lines in the table.
2767 With the prefix argument ALL is `(16)' \
2769 it is the symbol `iterate', recompute the table until it no longer changes.
2770 If NOALIGN is not nil, do not re-align the table after the computations
2771 are done. This is typically used internally to save time, if it is
2772 known that the table will be realigned a little later anyway."
2787 seen-fields lhs1
2789 ;; Insert constants in all formulas
2805 eqlist))
2806 ;; Split the equation list
2812 ;; Expand ranges in lhs of formulas
2815 ;; Get the correct line range to process
2821 ;; This is a table with marked lines, compute selected lines
2823 ;; Move forward to the first non-header line
2834 ;; First find the named fields, and mark them untouchable.
2835 ;; Also check if several field/range formulas try to set the same field.
2854 name)))
2864 ;; Now evaluate the column formulas, but skip fields covered by
2865 ;; field formulas
2869 ;; Unprotected line, recalculate
2881 ;; Now evaluate the field formulas
2895 ;; back to initial position
2903 "Recalculate the table until it does not change anymore.
2904 The maximum number of iterations is 10, but you can chose a different value
2905 with the prefix ARG."
2910 thistbl)
2925 "Recalculate all tables in the current buffer."
2933 "Iterate all tables in the buffer, to converge inter-table dependencies."
2938 c1
2955 "Expand list of formulas.
2956 If some of the RHS in the formulas are ranges or a row reference, expand
2957 them to individual field equations for each field."
2963 ;; This just refers to one fixed field
2966 ;; This just refers to one fixed named field
2988 "Replace @<, @>, $<, $> with first/last row/column of the table.
2989 So @< and $< will always be replaced with @1 and $1, respectively.
2990 The advantage of these special markers are that structure editing of
2991 the table will not change them, while @1 and $1 will be modified
2992 when a line/row is swaped out of that privileged position. So for
2993 formulas that use a range of rows or columns, it may often be better
2995 borders of the table using the @< @> $< $> makers."
3000 org-table-current-ncol)
3004 len
3010 s)
3013 "Replace $const with values in string F."
3015 ;; First, check for column names
3020 ;; Parameters and constants
3022 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3032 f))
3035 "Find the value for a parameter or constant in a formula.
3036 Parameters get priority."
3067 map))
3074 "--"
3077 "--"
3078 "Shift Reference at Point"
3083 "-"
3084 "Change Test Row for Column Formulas"
3087 "--"
3092 org-table-overlay-coordinates)]
3093 "--"
3100 "Edit the formulas of the current table in a separate buffer."
3116 entry s type title)
3119 ;; Keep global-font-lock-mode from turning on font-lock-mode
3160 "Convert a formula from internal to user representation."
3163 s))
3166 "Convert a formula from user to internal representation."
3169 s))
3172 "Convert spreadsheet references from A7 to @7$28.
3173 Works for single references, but also for entire formulas and even the
3174 full TBLFM line."
3176 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3179 ;; format match, just advance
3184 ;; 3.e5 or something like this.
3187 ;; (member (match-string 1 s)
3188 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3189 )
3190 ;; function name, just advance
3200 t t s)))))
3201 s))
3204 "Convert spreadsheet references from to @7$28 to AB7.
3205 Works for single references, but also for entire formulas and even the
3206 full TBLFM line."
3213 t t s)))
3218 t nil s)))
3219 s)
3222 "Convert a base 26 number represented by letters into an integer.
3223 For example: AB -> 28."
3229 n))
3232 "Convert an integer into a base 26 number represented by letters.
3233 For example: 28 -> AB."
3238 s))
3241 "Convert a time string into numerical duration in seconds.
3242 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3243 If S is a string representing a number, keep this number."
3266 "Convert a number of seconds to a time string.
3267 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3268 minutes or seconds."
3280 "Convert all references in this buffer, using FUNCTION."
3290 "Convert all references in the buffer from B3 to @3$2 and back."
3300 "Shift the reference at point one row/hline up."
3304 "Shift the reference at point one row/hline down."
3308 "Shift the reference at point one field to the left."
3312 "Shift the reference at point one field to the right."
3323 ;; A B3-like reference
3329 ;; An internal reference
3335 "Re-match the group N, and replace it with the shifted reference."
3340 t t)))
3343 "Shift a reference part REF.
3344 If DECR is set, decrease the references row/column, else increase.
3345 If HLINE is set, this may be a hline reference, it certainly is not
3346 a translation reference."
3375 "Toggle the display of coordinates in the referenced table."
3384 "Parse the buffer for formula definitions and install them.
3385 With prefix ARG, apply the new formulas to the table."
3395 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3396 nil t)
3420 "Abort editing formulas, without installing the changes."
3431 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3472 "Show the location/value of the $ expression at point."
3481 var name e what match dest)
3486 "$1.."
3569 ;; column number
3597 org-table-fedit-scroll-down))))
3608 "Make sure the cursor is in a dataline in a table."
3617 p1 p2)))
3622 "Move cursor one line up in the window showing the table."
3627 "Move cursor one line down in the window showing the table."
3632 "Move the cursor in the window showing the table.
3633 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3658 "Add a new overlay."
3664 "Highlight rectangular region in a table."
3668 l1 c1 l2 c2 tmp)
3692 "Remove the rectangle overlays."
3703 "Add overlays to the table at point, to show row/column coordinates."
3732 "Toggle the display of Row/Column numbers in tables."
3744 "Toggle the formula debugger in tables."
3750 ;;; The orgtbl minor mode
3752 ;; Define a minor mode which can be used in other modes in order to
3753 ;; integrate the org-mode table editor.
3755 ;; This is really a hack, because the org-mode table editor uses several
3756 ;; keys which normally belong to the major mode, for example the TAB and
3757 ;; RET keys. Here is how it works: The minor mode defines all the keys
3758 ;; necessary to operate the table editor, but wraps the commands into a
3759 ;; function which tests if the cursor is currently inside a table. If that
3760 ;; is the case, the table editor command is executed. However, when any of
3761 ;; those keys is used outside a table, the function uses `key-binding' to
3762 ;; look up if the key has an associated command in another currently active
3763 ;; keymap (minor modes, major mode, global), and executes that command.
3764 ;; There might be problems if any of the keys used by the table editor is
3765 ;; otherwise used as a prefix key.
3767 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3768 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3769 ;; addresses this by checking explicitly for both bindings.
3771 ;; The optimized version (see variable `orgtbl-optimized') takes over
3772 ;; all keys which are bound to `self-insert-command' in the *global map*.
3773 ;; Some modes bind other commands to simple characters, for example
3774 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3775 ;; active, this binding is ignored inside tables and replaced with a
3776 ;; modified self-insert.
3782 ;;;###autoload
3784 "Unconditionally turn on `orgtbl-mode'."
3799 ;; Install it as a minor mode.
3803 ;;;###autoload
3805 "The `org-mode' table editor as a minor mode for use in other modes."
3810 ;; Exit without error, in case some hook functions calls this
3811 ;; by accident in org-mode.
3815 ;; Make sure we are first in minor-mode-map-alist
3817 ;; FIXME: maybe it should use emulation-mode-map-alists?
3824 auto-fill-inhibit-regexp)
3828 auto-fill-inhibit-regexp)
3829 orgtbl-line-start-regexp))
3847 "Remove all properties related to narrow-column invisibility."
3860 "Create a function for binding in the table minor mode.
3861 FUN is the command to call inside a table. N is used to create a unique
3862 command name. KEYS are keys that should be checked in for a command
3863 to execute outside of tables."
3869 "Outside of tables, run the binding of `"
3881 keys)
3885 "Error when there is no default binding for a table key."
3890 "Setup orgtbl keymaps."
3920 elt key fun cmd)
3928 ;; Special treatment needed for TAB and RET
3948 [(tab)] "\C-i")))
3950 (org-defkey orgtbl-mode-map [backtab]
3952 [backtab] [S-iso-lefttab] [(shift tab)]
3953 [(tab)] "\C-i"))
3955 (org-defkey orgtbl-mode-map "\M-\C-m"
3956 (orgtbl-make-binding 'org-table-wrap-region 105
3957 "\M-\C-m" [(meta return)]))
3958 (org-defkey orgtbl-mode-map [(meta return)]
3959 (orgtbl-make-binding 'org-table-wrap-region 106
3960 [(meta return)] "\M-\C-m"))
3962 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3963 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3965 (when orgtbl-optimized
3966 ;; If the user wants maximum table support, we need to hijack
3967 ;; some standard editing functions
3968 (org-remap orgtbl-mode-map
3969 'self-insert-command 'orgtbl-self-insert-command
3970 'delete-char 'org-delete-char
3971 'delete-backward-char 'org-delete-backward-char)
3972 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3973 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3974 '("OrgTbl"
3975 ["Create or convert" org-table-create-or-convert-from-region
3976 :active (not (org-at-table-p)) :keys "C-c |" ]
3977 "--"
3978 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3979 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3980 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3981 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3982 "--"
3983 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3984 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3985 ["Copy Field from Above"
3986 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3987 "--"
3988 ("Column"
3989 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3990 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3991 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3992 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3993 ("Row"
3994 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3995 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3996 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3997 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3998 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3999 "--"
4000 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4001 ("Rectangle"
4002 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4003 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4004 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4005 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4006 "--"
4007 ("Radio tables"
4008 ["Insert table template" orgtbl-insert-radio-table
4009 (assq major-mode orgtbl-radio-table-templates)]
4010 ["Comment/uncomment table" orgtbl-toggle-comment t])
4011 "--"
4012 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4013 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4014 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4015 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4016 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4017 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4018 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4019 ["Sum Column/Rectangle" org-table-sum
4020 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4021 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4022 ["Debug Formulas"
4023 org-table-toggle-formula-debugger :active (org-at-table-p)
4024 :keys "C-c {"
4025 :style toggle :selected org-table-formula-debug]
4026 ["Show Col/Row Numbers"
4027 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4028 :keys "C-c }"
4029 :style toggle :selected org-table-overlay-coordinates]
4030 ))
4031 t))
4033 (defun orgtbl-ctrl-c-ctrl-c (arg)
4034 "If the cursor is inside a table, realign the table.
4035 If it is a table to be sent away to a receiver, do it.
4036 With prefix arg, also recompute table."
4037 (interactive "P")
4038 (let ((pos (point)) action consts-str consts cst const-str)
4039 (save-excursion
4040 (beginning-of-line 1)
4041 (setq action (cond
4045 (cond
4046 ((integerp action)
4047 (goto-char action)
4048 (org-table-maybe-eval-formula)
4049 (if arg
4050 (call-interactively 'org-table-recalculate)
4051 (org-table-maybe-recalculate-line))
4052 (call-interactively 'org-table-align)
4053 (when (orgtbl-send-table 'maybe)
4054 (run-hooks 'orgtbl-after-send-table-hook)))
4055 ((eq action 'recalc)
4056 (save-excursion
4057 (goto-char (point-min))
4059 (setq const-str (substring-no-properties (match-string 1)))
4061 (when consts
4062 (let (e)
4063 (while (setq e (pop consts))
4065 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4066 (setq org-table-formula-constants-local cst)))))
4067 (save-excursion
4068 (beginning-of-line 1)
4070 (if (org-at-table-p)
4071 (org-call-with-arg 'org-table-recalculate t))))
4072 (t (let (orgtbl-mode)
4073 (call-interactively (key-binding "\C-c\C-c")))))))
4075 (defun orgtbl-create-or-convert-from-region (arg)
4076 "Create table or convert region to table, if no conflicting binding.
4077 This installs the table binding `C-c |', but only if there is no
4078 conflicting binding to this key outside orgtbl-mode."
4079 (interactive "P")
4080 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4081 (if cmd
4082 (call-interactively cmd)
4083 (call-interactively 'org-table-create-or-convert-from-region))))
4085 (defun orgtbl-tab (arg)
4086 "Justification and field motion for `orgtbl-mode'."
4087 (interactive "P")
4088 (if arg (org-table-edit-field t)
4089 (org-table-justify-field-maybe)
4090 (org-table-next-field)))
4092 (defun orgtbl-ret ()
4093 "Justification and field motion for `orgtbl-mode'."
4094 (interactive)
4095 (if (bobp)
4096 (newline)
4097 (org-table-justify-field-maybe)
4098 (org-table-next-row)))
4100 (defun orgtbl-self-insert-command (N)
4101 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4102 If the cursor is in a table looking at whitespace, the whitespace is
4103 overwritten, and the table is not marked as requiring realignment."
4104 (interactive "p")
4105 (if (and (org-at-table-p)
4106 (or
4107 (and org-table-auto-blank-field
4108 (member last-command
4109 '(orgtbl-hijacker-command-100
4110 orgtbl-hijacker-command-101
4111 orgtbl-hijacker-command-102
4112 orgtbl-hijacker-command-103
4113 orgtbl-hijacker-command-104
4114 orgtbl-hijacker-command-105
4115 yas/expand))
4116 (org-table-blank-field))
4117 t)
4118 (eq N 1)
4120 (let (org-table-may-need-update)
4121 (goto-char (1- (match-end 0)))
4122 (delete-char -1)
4123 (goto-char (match-beginning 0))
4124 (self-insert-command N))
4125 (setq org-table-may-need-update t)
4126 (let* (orgtbl-mode
4127 a
4128 (cmd (or (key-binding
4129 (or (and (listp function-key-map)
4130 (setq a (assoc last-input-event function-key-map))
4131 (cdr a))
4132 (vector last-input-event)))
4133 'self-insert-command)))
4134 (call-interactively cmd)
4135 (if (and org-self-insert-cluster-for-undo
4136 (eq cmd 'self-insert-command))
4137 (if (not (eq last-command 'orgtbl-self-insert-command))
4138 (setq org-self-insert-command-undo-counter 1)
4139 (if (>= org-self-insert-command-undo-counter 20)
4140 (setq org-self-insert-command-undo-counter 1)
4141 (and (> org-self-insert-command-undo-counter 0)
4142 buffer-undo-list
4143 (not (cadr buffer-undo-list)) ; remove nil entry
4144 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4145 (setq org-self-insert-command-undo-counter
4146 (1+ org-self-insert-command-undo-counter))))))))
4149 "Regular expression matching exponentials as produced by calc.")
4151 (defun orgtbl-export (table target)
4152 (require 'org-exp)
4153 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4155 org-table-last-alignment org-table-last-column-widths
4156 maxcol column)
4157 (if (not (fboundp func))
4158 (error "Cannot export orgtbl table to %s" target))
4159 (setq lines (org-table-clean-before-export lines))
4160 (setq table
4161 (mapcar
4162 (lambda (x)
4163 (if (string-match org-table-hline-regexp x)
4164 'hline
4166 lines))
4167 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4168 table)))
4169 (loop for i from (1- maxcol) downto 0 do
4170 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4171 (setq column (delq nil column))
4172 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4173 (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))
4174 (funcall func table nil)))
4176 (defun orgtbl-gather-send-defs ()
4177 "Gather a plist of :name, :transform, :params for each destination before
4178 a radio table."
4179 (save-excursion
4180 (goto-char (org-table-begin))
4181 (let (rtn)
4182 (beginning-of-line 0)
4183 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4184 (let ((name (org-no-properties (match-string 1)))
4185 (transform (intern (match-string 2)))
4186 (params (if (match-end 3)
4187 (read (concat "(" (match-string 3) ")")))))
4188 (push (list :name name :transform transform :params params)
4189 rtn)
4190 (beginning-of-line 0)))
4191 rtn)))
4193 (defun orgtbl-send-replace-tbl (name txt)
4194 "Find and replace table NAME with TXT."
4195 (save-excursion
4196 (goto-char (point-min))
4197 (unless (re-search-forward
4199 (error "Don't know where to insert translated table"))
4200 (goto-char (match-beginning 0))
4201 (beginning-of-line 2)
4202 (save-excursion
4203 (let ((beg (point)))
4204 (unless (re-search-forward
4205 (concat "END RECEIVE ORGTBL +" name) nil t)
4206 (error "Cannot find end of insertion region"))
4207 (beginning-of-line 1)
4208 (delete-region beg (point))))
4211 ;;;###autoload
4212 (defun org-table-to-lisp (&optional txt)
4213 "Convert the table at point to a Lisp structure.
4214 The structure will be a list. Each item is either the symbol `hline'
4215 for a horizontal separator line, or a list of field values as strings.
4216 The table is taken from the parameter TXT, or from the buffer at point."
4217 (unless txt
4218 (unless (org-at-table-p)
4219 (error "No table at point")))
4220 (let* ((txt (or txt
4221 (buffer-substring-no-properties (org-table-begin)
4222 (org-table-end))))
4225 (mapcar
4226 (lambda (x)
4227 (if (string-match org-table-hline-regexp x)
4228 'hline
4230 lines)))
4232 (defun orgtbl-send-table (&optional maybe)
4233 "Send a transformed version of this table to the receiver position.
4234 With argument MAYBE, fail quietly if no transformation is defined for
4235 this table."
4236 (interactive)
4237 (catch 'exit
4238 (unless (org-at-table-p) (error "Not at a table"))
4239 ;; when non-interactive, we assume align has just happened.
4240 (when (org-called-interactively-p 'any) (org-table-align))
4241 (let ((dests (orgtbl-gather-send-defs))
4242 (txt (buffer-substring-no-properties (org-table-begin)
4243 (org-table-end)))
4244 (ntbl 0))
4245 (unless dests (if maybe (throw 'exit nil)
4246 (error "Don't know how to transform this table")))
4247 (dolist (dest dests)
4248 (let* ((name (plist-get dest :name))
4249 (transform (plist-get dest :transform))
4250 (params (plist-get dest :params))
4251 (skip (plist-get params :skip))
4252 (skipcols (plist-get params :skipcols))
4253 beg
4254 (lines (org-table-clean-before-export
4255 (nthcdr (or skip 0)
4257 (i0 (if org-table-clean-did-remove-column 2 1))
4258 (table (mapcar
4259 (lambda (x)
4260 (if (string-match org-table-hline-regexp x)
4261 'hline
4262 (org-remove-by-index
4264 skipcols i0)))
4265 lines))
4266 (fun (if (= i0 2) 'cdr 'identity))
4267 (org-table-last-alignment
4268 (org-remove-by-index (funcall fun org-table-last-alignment)
4269 skipcols i0))
4270 (org-table-last-column-widths
4271 (org-remove-by-index (funcall fun org-table-last-column-widths)
4272 skipcols i0))
4273 (txt (if (fboundp transform)
4274 (funcall transform table params)
4275 (error "No such transformation function %s" transform))))
4276 (orgtbl-send-replace-tbl name txt))
4277 (setq ntbl (1+ ntbl)))
4278 (message "Table converted and installed at %d receiver location%s"
4279 ntbl (if (> ntbl 1) "s" ""))
4280 (if (> ntbl 0)
4281 ntbl
4282 nil))))
4284 (defun org-remove-by-index (list indices &optional i0)
4285 "Remove the elements in LIST with indices in INDICES.
4286 First element has index 0, or I0 if given."
4287 (if (not indices)
4288 list
4289 (if (integerp indices) (setq indices (list indices)))
4290 (setq i0 (1- (or i0 0)))
4291 (delq :rm (mapcar (lambda (x)
4292 (setq i0 (1+ i0))
4293 (if (memq i0 indices) :rm x))
4294 list))))
4296 (defun orgtbl-toggle-comment ()
4297 "Comment or uncomment the orgtbl at point."
4298 (interactive)
4299 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4300 (re2 (concat "^" orgtbl-line-start-regexp))
4301 (commented (save-excursion (beginning-of-line 1)
4302 (cond ((looking-at re1) t)
4303 ((looking-at re2) nil)
4304 (t (error "Not at an org table")))))
4305 (re (if commented re1 re2))
4306 beg end)
4307 (save-excursion
4308 (beginning-of-line 1)
4309 (while (looking-at re) (beginning-of-line 0))
4310 (beginning-of-line 2)
4311 (setq beg (point))
4312 (while (looking-at re) (beginning-of-line 2))
4313 (setq end (point)))
4314 (comment-region beg end (if commented '(4) nil))))
4316 (defun orgtbl-insert-radio-table ()
4317 "Insert a radio table template appropriate for this major mode."
4318 (interactive)
4319 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4320 (txt (nth 1 e))
4321 name pos)
4322 (unless e (error "No radio table setup defined for %s" major-mode))
4323 (setq name (read-string "Table name: "))
4324 (while (string-match "%n" txt)
4325 (setq txt (replace-match name t t txt)))
4327 (setq pos (point))
4328 (insert txt)
4329 (goto-char pos)))
4331 ;; Dynamically bound input and output for table formatting.
4332 (defvar *orgtbl-table* nil
4333 "Carries the current table through formatting routines.")
4334 (defvar *orgtbl-rtn* nil
4335 "Formatting routines push the output lines here.")
4336 ;; Formatting parameters for the current table section.
4337 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4338 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4339 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4340 (defvar *orgtbl-fmt* nil "Format for each entry.")
4341 (defvar *orgtbl-efmt* nil "Format for numbers.")
4342 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4343 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4344 (defvar *orgtbl-lstart* nil "Text starting a row.")
4345 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4346 (defvar *orgtbl-lend* nil "Text ending a row.")
4347 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4349 (defsubst orgtbl-get-fmt (fmt i)
4350 "Retrieve the format from FMT corresponding to the Ith column."
4351 (if (and (not (functionp fmt)) (consp fmt))
4352 (plist-get fmt i)
4353 fmt))
4355 (defsubst orgtbl-apply-fmt (fmt &rest args)
4356 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4357 (cond ((functionp fmt) (apply fmt args))
4358 (fmt (apply 'format fmt args))
4359 (args (car args))
4360 (t args)))
4362 (defsubst orgtbl-eval-str (str)
4363 "If STR is a function, evaluate it with no arguments."
4364 (if (functionp str)
4365 (funcall str)
4366 str))
4368 (defun orgtbl-format-line (line)
4369 "Format LINE as a table row."
4370 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4371 (let* ((i 0)
4372 (line
4373 (mapcar
4374 (lambda (f)
4375 (setq i (1+ i))
4376 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4377 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4378 (orgtbl-apply-fmt efmt (match-string 1 f)
4379 (match-string 2 f))
4380 f)))
4381 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4382 *orgtbl-default-fmt*)
4383 f)))
4384 line)))
4385 (push (if *orgtbl-lfmt*
4386 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4387 (concat (orgtbl-eval-str *orgtbl-lstart*)
4388 (mapconcat 'identity line *orgtbl-sep*)
4389 (orgtbl-eval-str *orgtbl-lend*)))
4390 *orgtbl-rtn*))))
4392 (defun orgtbl-format-section (section-stopper)
4393 "Format lines until the first occurrence of SECTION-STOPPER."
4394 (let (prevline)
4395 (progn
4396 (while (not (eq (car *orgtbl-table*) section-stopper))
4397 (if prevline (orgtbl-format-line prevline))
4398 (setq prevline (pop *orgtbl-table*)))
4399 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4400 (*orgtbl-lend* *orgtbl-llend*)
4401 (*orgtbl-lfmt* *orgtbl-llfmt*))
4402 (orgtbl-format-line prevline))))))
4404 (defun orgtbl-to-generic (table params)
4405 "Convert the orgtbl-mode TABLE to some other format.
4406 This generic routine can be used for many standard cases.
4407 TABLE is a list, each entry either the symbol `hline' for a horizontal
4408 separator line, or a list of fields for that line.
4409 PARAMS is a property list of parameters that can influence the conversion.
4410 For the generic converter, some parameters are obligatory: you need to
4411 specify either :lfmt, or all of (:lstart :lend :sep).
4413 Valid parameters are
4415 :splice When set to t, return only table body lines, don't wrap
4416 them into :tstart and :tend. Default is nil. When :splice
4417 is non-nil, this also means that the exporter should not look
4418 for and interpret header and footer sections.
4420 :hline String to be inserted on horizontal separation lines.
4421 May be nil to ignore hlines.
4423 :sep Separator between two fields
4424 :remove-nil-lines Do not include lines that evaluate to nil.
4427 Each in the following group may be either a string or a function
4428 of no arguments returning a string:
4429 :tstart String to start the table. Ignored when :splice is t.
4430 :tend String to end the table. Ignored when :splice is t.
4431 :lstart String to start a new table line.
4432 :llstart String to start the last table line, defaults to :lstart.
4433 :lend String to end a table line
4434 :llend String to end the last table line, defaults to :lend.
4436 Each in the following group may be a string, a function of one
4437 argument (the field or line) returning a string, or a plist
4438 mapping columns to either of the above:
4439 :lfmt Format for entire line, with enough %s to capture all fields.
4440 If this is present, :lstart, :lend, and :sep are ignored.
4441 :llfmt Format for the entire last line, defaults to :lfmt.
4442 :fmt A format to be used to wrap the field, should contain
4443 %s for the original field value. For example, to wrap
4445 This may also be a property list with column numbers and
4448 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4449 Same as above, specific for the header lines in the table.
4450 All lines before the first hline are treated as header.
4451 If any of these is not present, the data line value is used.
4453 This may be either a string or a function of two arguments:
4454 :efmt Use this format to print numbers with exponentials.
4455 The format should have %s twice for inserting mantissa
4457 may also be a property list with column numbers and
4458 formats. :fmt will still be applied after :efmt.
4460 In addition to this, the parameters :skip and :skipcols are always handled
4461 directly by `orgtbl-send-table'. See manual."
4462 (interactive)
4464 (let* ((splicep (plist-get params :splice))
4465 (hline (plist-get params :hline))
4466 (remove-nil-linesp (plist-get params :remove-nil-lines))
4467 (remove-newlines (plist-get params :remove-newlines))
4468 (*orgtbl-hline* hline)
4469 (*orgtbl-table* table)
4470 (*orgtbl-sep* (plist-get params :sep))
4471 (*orgtbl-efmt* (plist-get params :efmt))
4472 (*orgtbl-lstart* (plist-get params :lstart))
4473 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4474 (*orgtbl-lend* (plist-get params :lend))
4475 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4476 (*orgtbl-lfmt* (plist-get params :lfmt))
4477 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4478 (*orgtbl-fmt* (plist-get params :fmt))
4479 *orgtbl-rtn*)
4481 ;; Put header
4482 (unless splicep
4483 (when (plist-member params :tstart)
4484 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4485 (if tstart (push tstart *orgtbl-rtn*)))))
4487 ;; Do we have a heading section? If so, format it and handle the
4488 ;; trailing hline.
4489 (if (and (not splicep)
4490 (or (consp (car *orgtbl-table*))
4491 (consp (nth 1 *orgtbl-table*)))
4492 (memq 'hline (cdr *orgtbl-table*)))
4493 (progn
4494 (when (eq 'hline (car *orgtbl-table*))
4495 ;; there is a hline before the first data line
4496 (and hline (push hline *orgtbl-rtn*))
4497 (pop *orgtbl-table*))
4498 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4499 *orgtbl-lstart*))
4500 (*orgtbl-llstart* (or (plist-get params :hllstart)
4501 *orgtbl-llstart*))
4502 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4503 (*orgtbl-llend* (or (plist-get params :hllend)
4504 (plist-get params :hlend) *orgtbl-llend*))
4505 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4506 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4507 (plist-get params :hlfmt) *orgtbl-llfmt*))
4508 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4509 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4510 (orgtbl-format-section 'hline))
4511 (if hline (push hline *orgtbl-rtn*))
4512 (pop *orgtbl-table*)))
4514 ;; Now format the main section.
4515 (orgtbl-format-section nil)
4517 (unless splicep
4518 (when (plist-member params :tend)
4519 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4520 (if tend (push tend *orgtbl-rtn*)))))
4522 (mapconcat (if remove-newlines
4523 (lambda (tend)
4525 'identity)
4526 (nreverse (if remove-nil-linesp
4527 (remq nil *orgtbl-rtn*)
4530 (defun orgtbl-to-tsv (table params)
4531 "Convert the orgtbl-mode table to TAB separated material."
4533 (defun orgtbl-to-csv (table params)
4534 "Convert the orgtbl-mode table to CSV material.
4535 This does take care of the proper quoting of fields with comma or quotes."
4536 (orgtbl-to-generic table (org-combine-plists
4537 '(:sep "," :fmt org-quote-csv-field)
4538 params)))
4540 (defun orgtbl-to-latex (table params)
4541 "Convert the orgtbl-mode TABLE to LaTeX.
4542 TABLE is a list, each entry either the symbol `hline' for a horizontal
4543 separator line, or a list of fields for that line.
4544 PARAMS is a property list of parameters that can influence the conversion.
4545 Supports all parameters from `orgtbl-to-generic'. Most important for
4546 LaTeX are:
4548 :splice When set to t, return only table body lines, don't wrap
4549 them into a tabular environment. Default is nil.
4551 :fmt A format to be used to wrap the field, should contain %s for the
4552 original field value. For example, to wrap everything in dollars,
4555 The format may also be a function that formats its one argument.
4557 :efmt Format for transforming numbers with exponentials. The format
4558 should have %s twice for inserting mantissa and exponent, for
4560 This may also be a property list with column numbers and formats.
4561 The format may also be a function that formats its two arguments.
4563 :llend If you find too much space below the last line of a table,
4566 The general parameters :skip and :skipcols have already been applied when
4567 this function is called."
4568 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4569 org-table-last-alignment ""))
4570 (params2
4571 (list
4576 (orgtbl-to-generic table (org-combine-plists params2 params))))
4578 (defun orgtbl-to-html (table params)
4579 "Convert the orgtbl-mode TABLE to HTML.
4580 TABLE is a list, each entry either the symbol `hline' for a horizontal
4581 separator line, or a list of fields for that line.
4582 PARAMS is a property list of parameters that can influence the conversion.
4583 Currently this function recognizes the following parameters:
4585 :splice When set to t, return only table body lines, don't wrap
4586 them into a <table> environment. Default is nil.
4588 The general parameters :skip and :skipcols have already been applied when
4589 this function is called. The function does *not* use `orgtbl-to-generic',
4590 so you cannot specify parameters for it."
4591 (let* ((splicep (plist-get params :splice))
4592 (html-table-tag org-export-html-table-tag)
4593 html)
4594 ;; Just call the formatter we already have
4595 ;; We need to make text lines for it, so put the fields back together.
4596 (setq html (org-format-org-table-html
4597 (mapcar
4598 (lambda (x)
4599 (if (eq x 'hline)
4600 "|----+----|"
4601 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4602 table)
4603 splicep))
4605 (setq html (replace-match "" t t html)))
4606 html))
4608 (defun orgtbl-to-texinfo (table params)
4609 "Convert the orgtbl-mode TABLE to TeXInfo.
4610 TABLE is a list, each entry either the symbol `hline' for a horizontal
4611 separator line, or a list of fields for that line.
4612 PARAMS is a property list of parameters that can influence the conversion.
4613 Supports all parameters from `orgtbl-to-generic'. Most important for
4614 TeXInfo are:
4616 :splice nil/t When set to t, return only table body lines, don't wrap
4617 them into a multitable environment. Default is nil.
4619 :fmt fmt A format to be used to wrap the field, should contain
4620 %s for the original field value. For example, to wrap
4622 This may also be a property list with column numbers and
4624 Each format also may be a function that formats its one
4625 argument.
4628 are computed automatically from the width of the columns
4629 under org-mode.
4631 The general parameters :skip and :skipcols have already been applied when
4632 this function is called."
4633 (let* ((total (float (apply '+ org-table-last-column-widths)))
4634 (colfrac (or (plist-get params :cf)
4635 (mapconcat
4636 (lambda (x) (format "%.3f" (/ (float x) total)))
4637 org-table-last-column-widths " ")))
4638 (params2
4639 (list
4640 :tstart (concat "@multitable @columnfractions " colfrac)
4641 :tend "@end multitable"
4642 :lstart "@item " :lend "" :sep " @tab "
4643 :hlstart "@headitem ")))
4644 (orgtbl-to-generic table (org-combine-plists params2 params))))
4646 (defun orgtbl-to-orgtbl (table params)
4647 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4648 Useful when slicing one table into many. The :hline, :sep,
4649 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4650 and :tend suppress strings without splicing; they can be set to
4651 provide ORGTBL directives for the generated table."
4652 (let* ((params2
4653 (list
4654 :remove-newlines t
4655 :tstart nil :tend nil
4656 :hline "|---"
4657 :sep " | "
4658 :lstart "| "
4659 :lend " |"))
4660 (params (org-combine-plists params2 params)))
4661 (orgtbl-to-generic table params)))
4663 (defun org-table-get-remote-range (name-or-id form)
4664 "Get a field value or a list of values in a range from table at ID.
4666 NAME-OR-ID may be the name of a table in the current file as set by
4668 will then be used. Alternatively, it may be an ID referring to
4669 any entry, also in a different file. In this case, the first table
4670 in that entry will be referenced.
4674 The return value is either a single string for a single field, or a
4675 list of the fields in the rectangle ."
4676 (save-match-data
4677 (let ((id-loc nil)
4678 org-table-column-names org-table-column-name-regexp
4679 org-table-local-parameters org-table-named-field-locations
4680 org-table-current-line-types org-table-current-begin-line
4681 org-table-current-begin-pos org-table-dlines
4682 org-table-current-ncol
4683 org-table-hlines org-table-last-alignment
4684 org-table-last-column-widths org-table-last-alignment
4685 org-table-last-column-widths tbeg
4686 buffer loc)
4687 (setq form (org-table-convert-refs-to-rc form))
4688 (save-excursion
4689 (save-restriction
4690 (widen)
4691 (save-excursion
4692 (goto-char (point-min))
4693 (if (re-search-forward
4695 nil t)
4696 (setq buffer (current-buffer) loc (match-beginning 0))
4697 (setq id-loc (org-id-find name-or-id 'marker))
4698 (unless (and id-loc (markerp id-loc))
4700 (setq buffer (marker-buffer id-loc)
4701 loc (marker-position id-loc))
4702 (move-marker id-loc nil)))
4703 (with-current-buffer buffer
4704 (save-excursion
4705 (save-restriction
4706 (widen)
4707 (goto-char loc)
4708 (forward-char 1)
4710 (not (match-beginning 1)))
4711 (error "Cannot find a table at NAME or ID %s" name-or-id))
4712 (setq tbeg (point-at-bol))
4713 (org-table-get-specials)
4714 (setq form (org-table-formula-substitute-names form))
4715 (if (and (string-match org-table-range-regexp form)
4716 (> (length (match-string 0 form)) 1))
4717 (save-match-data
4718 (org-table-get-range (match-string 0 form) tbeg 1))
4719 form)))))))))
4721 (provide 'org-table)
4725 ;;; org-table.el ends here