| blob | 30c4ddd0aac41400b827f2d417dfdc53cd1e492e |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.5
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the table editor and spreadsheet for Org-mode.
31 ;; Watch out: Here we are talking about two different kind of tables.
32 ;; Most of the code is for the tables created with the Org-mode table editor.
33 ;; Sometimes, we talk about tables created and edited with the table.el
34 ;; Emacs package. We call the former org-type tables, and the latter
35 ;; table.el-type tables.
37 ;;; Code:
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 "Non-nil means TAB and RET evaluate a formula in current table field.
235 If the current field starts with an equal sign, it is assumed to be a formula
236 which should be evaluated as described in the manual and in the documentation
237 string of the command `org-table-eval-formula'. This feature requires the
238 Emacs calc package.
239 When this variable is nil, formula calculation is only available through
245 "Non-nil means interpret constants in formulas in tables.
246 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
247 by the value given in `org-table-formula-constants', or by a value obtained
248 from the `constants.el' package."
253 "Alist with constant names and values, for use in table formulas.
254 The car of each element is a name of a constant, without the `$' before it.
255 The cdr is the value as a string. For example, if you'd like to use the
256 speed of light in a formula, you would configure
260 and then use it in an equation like `$1*$c'.
262 Constants can also be defined on a per-file basis using a line like
264 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
271 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
272 Automatically means when TAB or RET or C-c C-c are pressed in the line."
277 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
282 "Non-nil means relative formula references may cross hlines.
283 Here are the allowed values:
285 nil Relative references may not cross hlines. They will reference the
286 field next to the hline instead. Coming from below, the reference
287 will be to the field below the hline. Coming from above, it will be
288 to the field above.
289 t Relative references may cross hlines.
290 error An attempt to cross a hline will throw an error.
292 It is probably good to never set this variable to nil, for the sake of
293 portability of tables."
301 "Options concerning table import and export in Org-mode."
306 "Default export parameters for `org-table-export'.
307 These can be overridden for a specific table by setting the
308 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
309 radio tables for the different export transformations and
310 available parameters."
348 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
349 ;; 1 2 3 4 5
360 "Is this a table line colgroup information?"
364 line)
366 nil
373 "Is this a table line with only alignment/width cookies?"
386 s))))
395 "Use the table.el package to insert a new table.
396 If there is already a table at point, convert between Org-mode tables
397 and table.el tables."
411 "Convert region to table, or create an empty table.
412 If there is an active region, convert it to a table, using the function
413 `org-table-convert-region'. See the documentation of that function
414 to learn how the prefix argument is interpreted to determine the field
415 separator.
416 If there is no such region, create an empty table with `org-table-create'."
423 "Query for a size and insert a table skeleton.
443 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
447 ;; Insert a hline after the first row.
455 "Convert region to a table.
456 The region goes from BEG0 to END0, but these borders will be moved
457 slightly, to make sure a beginning of line in the first line is included.
459 SEPARATOR specifies the field separator in the lines. It can have the
460 following values:
462 '(4) Use the comma as a field separator
463 '(16) Use a TAB as field separator
464 integer When a number, use that many spaces as field separator
465 nil When nil, the command tries to be smart and figure out the
466 separator in the following way:
467 - when each line contains a TAB, assume TAB-separated material
468 - when each line contains a comma, assume CSV material
469 - else, assume one or more SPACE characters as separator."
473 re)
480 ;; Get the right field separator
491 ;; parse the csv stuff
515 "Import FILE as a table.
516 The file is assumed to be tab-separated. Such files can be produced by most
517 spreadsheet and database applications. If no tabs (at least one per line)
518 are found, lines will be split on whitespace into fields."
530 "Export table to a file, with configurable format.
531 Such a file can be imported into a spreadsheet program like Excel.
532 FILE can be the output file name. If not given, it will be taken from
533 a TABLE_EXPORT_FILE property in the current entry or higher up in the
534 hierarchy, or the user will be prompted for a file name.
535 FORMAT can be an export format, of the same kind as it used when
536 `orgtbl-mode' sends a table in a different format. The default format can
537 be found in the variable `org-table-export-default-format', but the function
538 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
539 property, locally or anywhere up in the hierarchy."
551 buf deffmt-readable)
570 "Format: "
575 deffmt-readable)))
588 'hline
591 skipcols i0)))
592 lines))
596 skipcols i0))
599 skipcols i0)))
616 "Marker at the beginning of the table last aligned.
619 "Marker at the end of the table last aligned.
622 "List of flags for flushright alignment, from the last re-alignment.
625 "List of max width of fields in each column.
628 "Non-nil means debug table formulas.
641 "Align the table at point by aligning all vertical bars."
644 ;; Limits of table
647 ;; Current cursor position
653 column
655 rfmt hfmt
663 emptystrings links dates emph raise narrow
664 falign falign1 fmax f1 len c e space)
667 ;; Check if we have links or dates
679 ;; Make sure the link properties are right
681 ;; Make sure the date properties are right
686 ;; Check if we are narrowing any columns
689 org-format-transports-properties-p
694 ;; Get the rows
697 ;; Store the indentation of the first line
700 ;; Mark the hlines by setting the corresponding element to nil
701 ;; At the same time, we remove trailing space.
704 nil
707 l)))
708 lines))
709 ;; Get the data fields by splitting the lines.
714 ;; How many fields in the longest line?
721 ;; A list of empty strings to fill any short rows on output
723 ;; Check for special formatting.
727 ;; Check if there is an explicit width specified
737 ;; Find fields that are wider than fmax, and shorten them
743 'help-echo
744 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
752 xx)))))
753 ;; Get the maximum width for each column
755 lengths)
756 ;; Get the fraction of numbers, to decide about alignment of the column
762 nil
769 ;; Store the alignment of this table, for later editing of single fields
771 org-table-last-column-widths lengths)
773 ;; With invisible characters, `format' does not get the field width right
774 ;; So we need to make these fields wide by hand.
792 ;; Compute the formats needed for output of the table
805 hfmt))
808 ;; This hack is for org-indent, to force redisplay of the
809 ;; line prefix of the first line. Apparently the redisplay
810 ;; is tied to the newline, which is, I think, a bug.
811 ;; To force this redisplay, we remove and re-insert the
812 ;; newline, so that the redisplay engine thinks it belongs
813 ;; to the changed text.
819 ;; Replace the old one
826 ;; Try to move to the old location
834 ))
837 "Find the beginning of the table and return its position.
838 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
842 org-table-border-regexp)
843 nil t))
850 "Find the end of the table and return its position.
851 With argument TABLE-TYPE, go to the end of a table.el-type table."
855 org-table-border-regexp)
856 nil t))
862 "Justify the current field, text to left, number to right.
863 Optional argument NEW may specify text to replace the current field content."
872 ;; This is not the same table, force a full re-align
878 l f n o e)
902 "Go to the next field in the current table, creating new lines as needed.
903 Before doing so, re-align the table if necessary."
908 org-table-may-need-update)
919 org-table-tab-jumps-over-hlines
931 "Go to the previous field in the table.
932 Before doing so, re-align the table if necessary."
937 org-table-may-need-update)
952 "Move to the end of the current table field.
953 If already at or after the end, move to the end of the next table field.
954 With numeric argument N, move N-1 fields forward first."
967 "Move to the beginning of the current table field.
968 If already at or before the beginning, move to the beginning of the
969 previous field.
970 With numeric argument N, move N-1 fields backward first."
984 "Go to the next row (same column) in the current table.
985 Before doing so, re-align the table if necessary."
993 org-table-may-need-update)
1007 "Copy a field down in the current column.
1008 If the field at the cursor is empty, copy into it the content of
1009 the nearest non-empty field above. With argument N, use the Nth
1010 non-empty field. If the current field is not empty, it is copied
1011 down to the next row, and the cursor is moved with it.
1012 Therefore, repeating this command causes the column to be filled
1013 row-by-row.
1014 If the variable `org-table-copy-increment' is non-nil and the
1015 field is an integer or a timestamp, it will be incremented while
1016 copying. In the case of a timestamp, increment by one day."
1024 txt)
1036 beg t))
1059 "Is point inside a table data field?
1060 I.e. not on a hline or before the first or after the last column?
1061 This actually throws an error, so it aborts the current command."
1067 nil
1069 t))
1075 "Get the field in table line LINE, column COLUMN.
1076 If LINE is larger than the number of data lines in the table, the function
1077 returns nil. However, if COLUMN is too large, we will simply return an
1078 empty string.
1079 If LINE is nil, use the current line.
1080 If column is nil, use the current column."
1087 "Put VALUE into line LINE, column COLUMN.
1088 When ALIGN is set, also realign the table."
1097 "Return the index of the current data line."
1104 cnt))
1107 "Go to the Nth data line in the current table.
1108 Return t when the line exists, nil if it does not exist."
1116 "Blank the current table field or active region."
1133 "Return the value of the field in column N of current row.
1134 N defaults to current field.
1135 If REPLACE is a string, replace field with this value. The return value
1136 is always the old value."
1145 t t))
1147 val)
1151 "Show info about the current field, and highlight any reference at point."
1159 org-table-named-field-locations)))
1179 dline col
1181 dline col ref1
1183 ;; FIXME: formula info not correct if special table line
1193 "Find out which column we are in."
1202 cnt)))
1205 "Find out what table data line we are in.
1206 Only data lines count for this."
1216 cnt)))
1219 "Move the cursor to the Nth column in the current table line.
1220 With optional argument ON-DELIM, stop with point before the left delimiter
1221 of the field.
1222 If there are less than N fields, just go to after the last delimiter.
1223 However, when FORCE is non-nil, create new columns if necessary."
1233 t)))))
1241 "Insert a new column into the table."
1249 ;; Current cursor position
1255 nil
1269 "Find a data line in the current table, which is needed for column commands."
1272 t
1283 t
1288 "Turn a buffer line number into a data line number.
1289 If there is no data line in this line, return nil.
1290 If there is no matchin dline (most likely te refrence was a hline), the
1291 first dline below it is used. When ABOVE is non-nil, the one above is used."
1294 i)
1307 nil))
1310 "Delete a column from the table."
1319 ;; Current cursor position
1325 nil
1342 "Move column to the right."
1346 "Move column to the left."
1351 "Move the current column to the right. With arg LEFT, move to the left."
1361 ;; Current cursor position
1371 nil
1390 "Move table row down."
1394 "Move table row up."
1399 "Move the current table line down. With arg UP, move it up."
1408 txt hline2p)
1432 "Insert a new row above the current line into the table.
1433 With prefix ARG, insert below the current line."
1439 ;; Fix the first field if necessary
1453 "Insert a horizontal-line below the current line into the table.
1454 With prefix ABOVE, insert above the current line."
1476 "Insert a hline and move to the row below that line."
1490 In particular, this does handle wide and invisible characters."
1492 ;; It's a hline, just map the characters
1498 t t s)))
1499 s))
1502 "Delete the current row or horizontal line from the table."
1517 "Sort table lines according to the column at point.
1519 The position of point indicates the column to be used for
1520 sorting, and the range of lines is the range between the nearest
1521 horizontal separator lines, or the entire table of no such lines
1522 exist. If point is before the first column, you will be prompted
1523 for the sorting column. If there is an active region, the mark
1524 specifies the first line and the sorting column, while point
1525 should be in the last line to be included into the sorting.
1527 The command then prompts for the sorting type which can be
1528 alphabetically, numerically, or by time (as given in a time stamp
1529 in the field). Sorting in reverse order is also possible.
1531 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1533 If SORTING-TYPE is specified when this function is called from a Lisp
1534 program, no prompting will take place. SORTING-TYPE must be a character,
1535 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1536 should be done in reverse order."
1540 beg end bcol ecol tend tbeg column lns pos)
1585 x))
1598 "Copy region in table to the clipboard and blank all relevant fields.
1599 If there is no active region, use just the field at point."
1606 "Copy rectangular region in table to clipboard.
1607 A special clipboard is used which can only be accessed
1608 with `org-table-paste-rectangle'."
1612 current-prefix-arg))
1614 region cols
1640 org-table-clip))
1643 "Paste a rectangular region into a table.
1644 The upper right corner ends up in the current field. All involved fields
1645 will be overwritten. If the rectangle does not fit into the present table,
1646 the table is enlarged as needed. The process ignores horizontal separator
1647 lines."
1657 c cols field)
1673 "Convert from `org-mode' table to table.el and back.
1674 Obviously, this only works within limits. When an Org-mode table is
1675 converted to table.el, all horizontal separator lines get lost, because
1676 table.el uses these as cell boundaries and has no notion of horizontal lines.
1677 A table.el table can be converted to an Org-mode table only if it does not
1678 do row or column spanning. Multiline cells will become multiple cells.
1679 Beware, Org-mode does not test if the table can be successfully converted - it
1680 blindly applies a recipe that works for simple tables."
1684 ;; convert to Org-mode table
1693 ;; convert to table.el table
1696 ;; first, get rid of all horizontal lines
1700 ;; insert a hline before first
1704 ;; insert a hline after each line
1709 ;; replace "+" at beginning and ending of hlines
1718 "Wrap several fields in a column like a paragraph.
1719 This is useful if you'd like to spread the contents of a field over several
1720 lines, in order to keep the table compact.
1722 If there is an active region, and both point and mark are in the same column,
1723 the text in the column is wrapped to minimum width for the given number of
1724 lines. Generally, this makes the table more compact. A prefix ARG may be
1726 formats the selected text to two lines. If the region was longer than two
1727 lines, the remaining lines remain empty. A negative prefix argument reduces
1728 the current number of lines by that amount. The wrapped text is pasted back
1729 into the table. If you formatted it to more lines than it was before, fields
1730 further down in the table get overwritten - so you might need to make space in
1731 the table first.
1733 If there is no region, the current field is split at the cursor position and
1734 the text fragment to the right of the cursor is prepended to the field one
1735 line down.
1737 If there is no region, but you specify a prefix ARG, the current field gets
1738 blank, and the content is appended to the field above."
1742 ;; There is a region: fill as a paragraph
1746 nlines)
1753 arg)
1757 nil nlines)))
1761 ;; No region, split the current field at point
1765 ;; combine with field above
1775 ;; split field
1788 "Edit table field in a different window.
1789 This is mainly useful for fields that contain hidden parts.
1791 it can be edited in place."
1800 display t intangible t))
1807 p)
1823 intangible t))
1831 "Finish editing a table data field.
1832 Remove all newline characters, insert the result into the table, realign
1833 the table and kill the editing buffer."
1837 text)
1854 "Minor mode to make the table field editor window follow the cursor.
1855 When this mode is active, the field editor window will always show the
1856 current field. The mode exits automatically when the cursor leaves the
1857 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1858 nil " TblFollow" nil
1874 ;; We have left the table, exit the follow mode
1885 "Sum numbers in region of current table column.
1886 The result will be displayed in the echo area, and will be available
1889 If there is an active region, it is interpreted as a rectangle and all
1890 numbers in that rectangle will be summed. If there is no active
1891 region and point is located in a table column, sum all numbers in that
1892 column.
1894 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1895 numbers are assumed to be times as well (in decimal hours) and the
1896 numbers are added as such.
1898 If NLAST is a number, only the NLAST fields will actually be summed."
1925 items1)))
1932 s diff)
1940 sres))))
1963 "Return the formula active for the current field.
1964 Assumes that specials are in place.
1965 If KEY is given, return the key to this formula.
1969 org-table-named-field-locations)))
1983 "Read a formula from the minibuffer, offer stored formula as default.
1984 When NAMED is non-nil, look for a named equation."
1988 org-table-named-field-locations)))
1995 name
1996 ref)
2006 stored)
2008 equation)
2015 scol))
2017 'org-table-formula-history
2018 )))))
2019 mustsave)
2021 ;; remove formula
2028 ;; We set the column equation, delete the named one.
2030 mustsave t))
2036 eq))
2039 "Store the list of formulas below the current table."
2045 ;; don't overwrite TBLFM, we might use text properties to store stuff
2061 ;; Fake a high number to make sure this is sorted at the end.
2068 a)
2078 "Compare two formulas for sorting."
2084 "Return an alist with the stored formulas directly after current table."
2093 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2112 "Modify the equations after the table structure has been edited.
2114 For all numbers larger than LIMIT, shift them by DELTA."
2125 s n a)
2138 t t)))))))))
2141 "Get the column names and local parameters for this table."
2144 names name fields fields1 field cnt
2145 c v l line col types dlines hlines last-dline)
2147 org-table-local-parameters nil
2148 org-table-named-field-locations nil
2149 org-table-current-begin-line nil
2150 org-table-current-begin-pos nil
2151 org-table-current-line-types nil
2170 org-table-local-parameters))))
2186 ;; Analyse the line types
2190 l org-table-current-begin-line)
2207 al al2)
2219 If yes, store the formula and apply it."
2220 ;; We already know we are in a table. Get field will only return a formula
2221 ;; when appropriate. It might return a separator line, but no problem.
2224 named eq)
2235 "List of commands triggering the recalculation of a line.
2248 "Rotate the recalculation mark in the first column.
2249 If in any row, the first field is not consistent with a mark,
2250 insert a new column for the markers.
2251 When there is an active region, change all the lines in the region,
2252 after prompting for the marking character.
2253 After each change, a message will be displayed indicating the meaning
2254 of the new mark."
2269 epos new)
2276 newchar))
2308 "Recompute the current line if marked for it, and if we haven't just done it."
2328 modes)
2331 suppress-align suppress-const
2332 suppress-store suppress-analysis)
2333 "Replace the table field value at the cursor by the result of a calculation.
2335 This function makes use of Dave Gillespie's Calc package, in my view the
2336 most exciting program ever written for GNU Emacs. So you need to have Calc
2337 installed in order to use this function.
2339 In a table, this command replaces the value in the current field with the
2341 formula, by storing it in a special line below the table. When called
2342 with a `C-u' prefix, the current field must be a named field, and the
2343 formula is installed as valid in only this specific field.
2345 When called with two `C-u' prefixes, insert the active equation
2346 for the field back into the current field, so that it can be
2348 to check the referenced fields.
2350 When called, the command first prompts for a formula, which is read in
2351 the minibuffer. Previously entered formulas are available through the
2352 history list, and the last used formula is offered as a default.
2353 These stored formulas are adapted correctly when moving, inserting, or
2354 deleting columns with the corresponding commands.
2356 The formula can be any algebraic expression understood by the Calc package.
2357 For details, see the Org-mode manual.
2359 This function can also be called from Lisp programs and offers
2360 additional arguments: EQUATION can be the formula to apply. If this
2361 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2362 used to speed-up recursive calls by by-passing unnecessary aligns.
2363 SUPPRESS-CONST suppresses the interpretation of constants in the
2364 formula, assuming that this has been done already outside the function.
2365 SUPPRESS-STORE means the formula should not be stored, either because
2366 it is already stored, or because it is a modified equation that should
2367 not overwrite the stored one."
2383 equation
2389 n form form0 bw fmt x ev orig c lispp literal)
2390 ;; Parse the format string. Since we have a lot of modes, this is
2391 ;; a lot of work. However, I think calc still uses most of the time.
2403 'calc-float-format
2406 n))))
2433 fields)))
2439 ;; Insert row and column number of formula result field
2450 t t form)))
2452 ;; Check for old vertical references
2454 ;; Insert remote references
2462 keep-empty numbers lispp))
2463 t t form)))
2464 ;; Insert complex ranges
2472 keep-empty numbers lispp))
2473 t t form)))
2474 ;; Insert simple ranges
2483 keep-empty numbers lispp))
2484 t t form)))
2486 ;; Insert the references to fields in same row
2496 t t form)))
2511 Orig: %s
2512 $xyz-> %s
2513 @r$c-> %s
2544 prop value)))
2547 "Get a calc vector from a column, according to descriptor DESC.
2548 Optional arguments TBEG and COL can give the beginning of the table and
2549 the current column, to avoid unnecessary parsing.
2551 HIGHLIGHT means just highlight the range.
2553 When CORNERS-ONLY is set, only return the corners of the range as
2554 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2555 in the buffer and column1 and column2 are table column numbers."
2562 beg end c1 c2 r1 r2 rangep tmp)
2579 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2586 ;; just one field
2593 ;; A range, return a vector
2594 ;; First sort the numbers to get a regular ractangle
2598 ;; Only return the corners of the range
2600 ;; Copy the range values into a list
2614 ;; return string representation of calc vector
2619 "Analyze descriptor DESC and retrieve the corresponding line number.
2620 The cursor is currently in line CLINE, the table begins in line BLINE,
2621 and TABLE is a vector with line types."
2629 ;; 1 2 3 4 5 6
2649 nil hn cline desc)))
2652 rel on cline desc)))
2656 "FIXME: Needs more documentation."
2669 nil))
2670 t)))
2674 desc cline)
2675 i)))
2680 s))
2683 "Convert list ELEMENTS to something appropriate to insert into formula.
2684 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2685 NUMBERS indicates that everything should be converted to numbers.
2686 LISPP means to return something appropriate for a Lisp list."
2690 elements
2699 elements))))
2705 x
2711 elements
2715 "Recalculate the current table line by applying all stored formulas.
2716 With prefix arg ALL, do this for all lines in the table.
2717 With the prefix argument ALL is `(16)' \
2719 it is the symbol `iterate', recompute the table until it no longer changes.
2720 If NOALIGN is not nil, do not re-align the table after the computations
2721 are done. This is typically used internally to save time, if it is
2722 known that the table will be realigned a little later anyway."
2737 seen-fields lhs1
2739 ;; Insert constants in all formulas
2755 eqlist))
2756 ;; Split the equation list
2762 ;; Expand ranges in lhs of formulas
2765 ;; Get the correct line range to process
2771 ;; This is a table with marked lines, compute selected lines
2773 ;; Move forward to the first non-header line
2784 ;; First find the named fields, and mark them untouchable.
2785 ;; Also check if several field/range formulas try to set the same field.
2804 name)))
2814 ;; Now evaluate the column formulas, but skip fields covered by
2815 ;; field formulas
2819 ;; Unprotected line, recalculate
2831 ;; Now evaluate the field formulas
2845 ;; back to initial position
2853 "Recalculate the table until it does not change anymore.
2854 The maximun number of iterations is 10, but you can chose a different value
2855 with the prefix ARG."
2860 thistbl)
2875 "Recalculate all tables in the current buffer."
2883 "Iterate all tables in the buffer, to converge inter-table dependencies."
2888 c1
2905 "Expand list of formulas.
2906 If some of the RHS in the formulas are ranges or a row reference, expand
2907 them to individual field equations for each field."
2913 ;; This just refers to one fixed field
2916 ;; This just refers to one fixed named field
2938 "Replace @<, @>, $<, $> with first/last row/column of the table.
2939 So @< and $< will always be replaced with @1 and $1, respectively.
2940 The advantage of these special markers are that structure editing of
2941 the table will not change them, while @1 and $1 will be modified
2942 when a line/row is swaped out of that privileged position. So for
2943 formulas that use a range of rows or columns, it may often be better
2945 borders of the table using the @< @> $< $> makers."
2950 org-table-current-ncol)
2954 len
2960 s)
2963 "Replace $const with values in string F."
2965 ;; First, check for column names
2970 ;; Parameters and constants
2972 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2982 f))
2985 "Find the value for a parameter or constant in a formula.
2986 Parameters get priority."
3017 map))
3024 "--"
3027 "--"
3028 "Shift Reference at Point"
3033 "-"
3034 "Change Test Row for Column Formulas"
3037 "--"
3042 org-table-overlay-coordinates)]
3043 "--"
3050 "Edit the formulas of the current table in a separate buffer."
3066 entry s type title)
3069 ;; Keep global-font-lock-mode from turning on font-lock-mode
3110 "Convert a formula from internal to user representation."
3113 s))
3116 "Convert a formula from user to internal representation."
3119 s))
3122 "Convert spreadsheet references from A7 to @7$28.
3123 Works for single references, but also for entire formulas and even the
3124 full TBLFM line."
3126 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3129 ;; format match, just advance
3134 ;; 3.e5 or something like this.
3137 ;; (member (match-string 1 s)
3138 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3139 )
3140 ;; function name, just advance
3150 t t s)))))
3151 s))
3154 "Convert spreadsheet references from to @7$28 to AB7.
3155 Works for single references, but also for entire formulas and even the
3156 full TBLFM line."
3163 t t s)))
3168 t nil s)))
3169 s)
3172 "Convert a base 26 number represented by letters into an integer.
3173 For example: AB -> 28."
3179 n))
3182 "Convert an integer into a base 26 number represented by letters.
3183 For example: 28 -> AB."
3188 s))
3191 "Convert all references in this buffer, using FUNCTION."
3201 "Convert all references in the buffer from B3 to @3$2 and back."
3211 "Shift the reference at point one row/hline up."
3215 "Shift the reference at point one row/hline down."
3219 "Shift the reference at point one field to the left."
3223 "Shift the reference at point one field to the right."
3234 ;; A B3-like reference
3240 ;; An internal reference
3246 "Re-match the group N, and replace it with the shifted reference."
3251 t t)))
3254 "Shift a reference part REF.
3255 If DECR is set, decrease the references row/column, else increase.
3256 If HLINE is set, this may be a hline reference, it certainly is not
3257 a translation reference."
3286 "Toggle the display of coordinates in the referenced table."
3295 "Parse the buffer for formula definitions and install them.
3296 With prefix ARG, apply the new formulas to the table."
3306 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3307 nil t)
3331 "Abort editing formulas, without installing the changes."
3342 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3383 "Show the location/value of the $ expression at point."
3392 var name e what match dest)
3397 "$1.."
3480 ;; column number
3508 org-table-fedit-scroll-down))))
3519 "Make sure the cursor is in a dataline in a table."
3528 p1 p2)))
3533 "Move cursor one line up in the window showing the table."
3538 "Move cursor one line down in the window showing the table."
3543 "Move the cursor in the window showing the table.
3544 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3569 "Add a new overlay."
3575 "Highlight rectangular region in a table."
3579 l1 c1 l2 c2 tmp)
3603 "Remove the rectangle overlays."
3614 "Add overlays to the table at point, to show row/column coordinates."
3643 "Toggle the display of Row/Column numbers in tables."
3655 "Toggle the formula debugger in tables."
3661 ;;; The orgtbl minor mode
3663 ;; Define a minor mode which can be used in other modes in order to
3664 ;; integrate the org-mode table editor.
3666 ;; This is really a hack, because the org-mode table editor uses several
3667 ;; keys which normally belong to the major mode, for example the TAB and
3668 ;; RET keys. Here is how it works: The minor mode defines all the keys
3669 ;; necessary to operate the table editor, but wraps the commands into a
3670 ;; function which tests if the cursor is currently inside a table. If that
3671 ;; is the case, the table editor command is executed. However, when any of
3672 ;; those keys is used outside a table, the function uses `key-binding' to
3673 ;; look up if the key has an associated command in another currently active
3674 ;; keymap (minor modes, major mode, global), and executes that command.
3675 ;; There might be problems if any of the keys used by the table editor is
3676 ;; otherwise used as a prefix key.
3678 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3679 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3680 ;; addresses this by checking explicitly for both bindings.
3682 ;; The optimized version (see variable `orgtbl-optimized') takes over
3683 ;; all keys which are bound to `self-insert-command' in the *global map*.
3684 ;; Some modes bind other commands to simple characters, for example
3685 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3686 ;; active, this binding is ignored inside tables and replaced with a
3687 ;; modified self-insert.
3693 ;;;###autoload
3695 "Unconditionally turn on `orgtbl-mode'."
3710 ;; Install it as a minor mode.
3714 ;;;###autoload
3716 "The `org-mode' table editor as a minor mode for use in other modes."
3721 ;; Exit without error, in case some hook functions calls this
3722 ;; by accident in org-mode.
3726 ;; Make sure we are first in minor-mode-map-alist
3728 ;; FIXME: maybe it should use emulation-mode-map-alists?
3735 auto-fill-inhibit-regexp)
3739 auto-fill-inhibit-regexp)
3740 orgtbl-line-start-regexp))
3758 "Remove all properties related to narrow-column invisibility."
3771 "Create a function for binding in the table minor mode.
3772 FUN is the command to call inside a table. N is used to create a unique
3773 command name. KEYS are keys that should be checked in for a command
3774 to execute outside of tables."
3780 "Outside of tables, run the binding of `"
3792 keys)
3796 "Error when there is no default binding for a table key."
3801 "Setup orgtbl keymaps."
3831 elt key fun cmd)
3839 ;; Special treatment needed for TAB and RET
3859 [(tab)] "\C-i")))
3861 (org-defkey orgtbl-mode-map [backtab]
3863 [backtab] [S-iso-lefttab] [(shift tab)]
3864 [(tab)] "\C-i"))
3866 (org-defkey orgtbl-mode-map "\M-\C-m"
3867 (orgtbl-make-binding 'org-table-wrap-region 105
3868 "\M-\C-m" [(meta return)]))
3869 (org-defkey orgtbl-mode-map [(meta return)]
3870 (orgtbl-make-binding 'org-table-wrap-region 106
3871 [(meta return)] "\M-\C-m"))
3873 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3874 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3876 (when orgtbl-optimized
3877 ;; If the user wants maximum table support, we need to hijack
3878 ;; some standard editing functions
3879 (org-remap orgtbl-mode-map
3880 'self-insert-command 'orgtbl-self-insert-command
3881 'delete-char 'org-delete-char
3882 'delete-backward-char 'org-delete-backward-char)
3883 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3884 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3885 '("OrgTbl"
3886 ["Create or convert" org-table-create-or-convert-from-region
3887 :active (not (org-at-table-p)) :keys "C-c |" ]
3888 "--"
3889 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3890 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3891 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3892 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3893 "--"
3894 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3895 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3896 ["Copy Field from Above"
3897 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3898 "--"
3899 ("Column"
3900 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3901 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3902 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3903 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3904 ("Row"
3905 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3906 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3907 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3908 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3909 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3910 "--"
3911 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3912 ("Rectangle"
3913 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3914 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3915 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3916 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3917 "--"
3918 ("Radio tables"
3919 ["Insert table template" orgtbl-insert-radio-table
3920 (assq major-mode orgtbl-radio-table-templates)]
3921 ["Comment/uncomment table" orgtbl-toggle-comment t])
3922 "--"
3923 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3924 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3925 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3926 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3927 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3928 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3929 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3930 ["Sum Column/Rectangle" org-table-sum
3931 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3932 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3933 ["Debug Formulas"
3934 org-table-toggle-formula-debugger :active (org-at-table-p)
3935 :keys "C-c {"
3936 :style toggle :selected org-table-formula-debug]
3937 ["Show Col/Row Numbers"
3938 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3939 :keys "C-c }"
3940 :style toggle :selected org-table-overlay-coordinates]
3941 ))
3942 t))
3944 (defun orgtbl-ctrl-c-ctrl-c (arg)
3945 "If the cursor is inside a table, realign the table.
3946 If it is a table to be sent away to a receiver, do it.
3947 With prefix arg, also recompute table."
3948 (interactive "P")
3949 (let ((pos (point)) action consts-str consts cst const-str)
3950 (save-excursion
3951 (beginning-of-line 1)
3952 (setq action (cond
3956 (cond
3957 ((integerp action)
3958 (goto-char action)
3959 (org-table-maybe-eval-formula)
3960 (if arg
3961 (call-interactively 'org-table-recalculate)
3962 (org-table-maybe-recalculate-line))
3963 (call-interactively 'org-table-align)
3964 (when (orgtbl-send-table 'maybe)
3965 (run-hooks 'orgtbl-after-send-table-hook)))
3966 ((eq action 'recalc)
3967 (save-excursion
3968 (goto-char (point-min))
3970 (setq const-str (substring-no-properties (match-string 1)))
3972 (when consts
3973 (let (e)
3974 (while (setq e (pop consts))
3976 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
3977 (setq org-table-formula-constants-local cst)))))
3978 (save-excursion
3979 (beginning-of-line 1)
3981 (if (org-at-table-p)
3982 (org-call-with-arg 'org-table-recalculate t))))
3983 (t (let (orgtbl-mode)
3984 (call-interactively (key-binding "\C-c\C-c")))))))
3986 (defun orgtbl-create-or-convert-from-region (arg)
3987 "Create table or convert region to table, if no conflicting binding.
3988 This installs the table binding `C-c |', but only if there is no
3989 conflicting binding to this key outside orgtbl-mode."
3990 (interactive "P")
3991 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3992 (if cmd
3993 (call-interactively cmd)
3994 (call-interactively 'org-table-create-or-convert-from-region))))
3996 (defun orgtbl-tab (arg)
3997 "Justification and field motion for `orgtbl-mode'."
3998 (interactive "P")
3999 (if arg (org-table-edit-field t)
4000 (org-table-justify-field-maybe)
4001 (org-table-next-field)))
4003 (defun orgtbl-ret ()
4004 "Justification and field motion for `orgtbl-mode'."
4005 (interactive)
4006 (if (bobp)
4007 (newline)
4008 (org-table-justify-field-maybe)
4009 (org-table-next-row)))
4011 (defun orgtbl-self-insert-command (N)
4012 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4013 If the cursor is in a table looking at whitespace, the whitespace is
4014 overwritten, and the table is not marked as requiring realignment."
4015 (interactive "p")
4016 (if (and (org-at-table-p)
4017 (or
4018 (and org-table-auto-blank-field
4019 (member last-command
4020 '(orgtbl-hijacker-command-100
4021 orgtbl-hijacker-command-101
4022 orgtbl-hijacker-command-102
4023 orgtbl-hijacker-command-103
4024 orgtbl-hijacker-command-104
4025 orgtbl-hijacker-command-105
4026 yas/expand))
4027 (org-table-blank-field))
4028 t)
4029 (eq N 1)
4031 (let (org-table-may-need-update)
4032 (goto-char (1- (match-end 0)))
4033 (delete-backward-char 1)
4034 (goto-char (match-beginning 0))
4035 (self-insert-command N))
4036 (setq org-table-may-need-update t)
4037 (let* (orgtbl-mode
4038 a
4039 (cmd (or (key-binding
4040 (or (and (listp function-key-map)
4041 (setq a (assoc last-input-event function-key-map))
4042 (cdr a))
4043 (vector last-input-event)))
4044 'self-insert-command)))
4045 (call-interactively cmd)
4046 (if (and org-self-insert-cluster-for-undo
4047 (eq cmd 'self-insert-command))
4048 (if (not (eq last-command 'orgtbl-self-insert-command))
4049 (setq org-self-insert-command-undo-counter 1)
4050 (if (>= org-self-insert-command-undo-counter 20)
4051 (setq org-self-insert-command-undo-counter 1)
4052 (and (> org-self-insert-command-undo-counter 0)
4053 buffer-undo-list
4054 (not (cadr buffer-undo-list)) ; remove nil entry
4055 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4056 (setq org-self-insert-command-undo-counter
4057 (1+ org-self-insert-command-undo-counter))))))))
4060 "Regular expression matching exponentials as produced by calc.")
4062 (defun orgtbl-export (table target)
4063 (require 'org-exp)
4064 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4066 org-table-last-alignment org-table-last-column-widths
4067 maxcol column)
4068 (if (not (fboundp func))
4069 (error "Cannot export orgtbl table to %s" target))
4070 (setq lines (org-table-clean-before-export lines))
4071 (setq table
4072 (mapcar
4073 (lambda (x)
4074 (if (string-match org-table-hline-regexp x)
4075 'hline
4077 lines))
4078 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4079 table)))
4080 (loop for i from (1- maxcol) downto 0 do
4081 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4082 (setq column (delq nil column))
4083 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4084 (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))
4085 (funcall func table nil)))
4087 (defun orgtbl-gather-send-defs ()
4088 "Gather a plist of :name, :transform, :params for each destination before
4089 a radio table."
4090 (save-excursion
4091 (goto-char (org-table-begin))
4092 (let (rtn)
4093 (beginning-of-line 0)
4094 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4095 (let ((name (org-no-properties (match-string 1)))
4096 (transform (intern (match-string 2)))
4097 (params (if (match-end 3)
4098 (read (concat "(" (match-string 3) ")")))))
4099 (push (list :name name :transform transform :params params)
4100 rtn)
4101 (beginning-of-line 0)))
4102 rtn)))
4104 (defun orgtbl-send-replace-tbl (name txt)
4105 "Find and replace table NAME with TXT."
4106 (save-excursion
4107 (goto-char (point-min))
4108 (unless (re-search-forward
4110 (error "Don't know where to insert translated table"))
4111 (goto-char (match-beginning 0))
4112 (beginning-of-line 2)
4113 (save-excursion
4114 (let ((beg (point)))
4115 (unless (re-search-forward
4116 (concat "END RECEIVE ORGTBL +" name) nil t)
4117 (error "Cannot find end of insertion region"))
4118 (beginning-of-line 1)
4119 (delete-region beg (point))))
4122 ;;;###autoload
4123 (defun org-table-to-lisp (&optional txt)
4124 "Convert the table at point to a Lisp structure.
4125 The structure will be a list. Each item is either the symbol `hline'
4126 for a horizontal separator line, or a list of field values as strings.
4127 The table is taken from the parameter TXT, or from the buffer at point."
4128 (unless txt
4129 (unless (org-at-table-p)
4130 (error "No table at point")))
4131 (let* ((txt (or txt
4132 (buffer-substring-no-properties (org-table-begin)
4133 (org-table-end))))
4136 (mapcar
4137 (lambda (x)
4138 (if (string-match org-table-hline-regexp x)
4139 'hline
4141 lines)))
4143 (defun orgtbl-send-table (&optional maybe)
4144 "Send a transformed version of this table to the receiver position.
4145 With argument MAYBE, fail quietly if no transformation is defined for
4146 this table."
4147 (interactive)
4148 (catch 'exit
4149 (unless (org-at-table-p) (error "Not at a table"))
4150 ;; when non-interactive, we assume align has just happened.
4151 (when (interactive-p) (org-table-align))
4152 (let ((dests (orgtbl-gather-send-defs))
4153 (txt (buffer-substring-no-properties (org-table-begin)
4154 (org-table-end)))
4155 (ntbl 0))
4156 (unless dests (if maybe (throw 'exit nil)
4157 (error "Don't know how to transform this table")))
4158 (dolist (dest dests)
4159 (let* ((name (plist-get dest :name))
4160 (transform (plist-get dest :transform))
4161 (params (plist-get dest :params))
4162 (skip (plist-get params :skip))
4163 (skipcols (plist-get params :skipcols))
4164 beg
4165 (lines (org-table-clean-before-export
4166 (nthcdr (or skip 0)
4168 (i0 (if org-table-clean-did-remove-column 2 1))
4169 (table (mapcar
4170 (lambda (x)
4171 (if (string-match org-table-hline-regexp x)
4172 'hline
4173 (org-remove-by-index
4175 skipcols i0)))
4176 lines))
4177 (fun (if (= i0 2) 'cdr 'identity))
4178 (org-table-last-alignment
4179 (org-remove-by-index (funcall fun org-table-last-alignment)
4180 skipcols i0))
4181 (org-table-last-column-widths
4182 (org-remove-by-index (funcall fun org-table-last-column-widths)
4183 skipcols i0))
4184 (txt (if (fboundp transform)
4185 (funcall transform table params)
4186 (error "No such transformation function %s" transform))))
4187 (orgtbl-send-replace-tbl name txt))
4188 (setq ntbl (1+ ntbl)))
4189 (message "Table converted and installed at %d receiver location%s"
4190 ntbl (if (> ntbl 1) "s" ""))
4191 (if (> ntbl 0)
4192 ntbl
4193 nil))))
4195 (defun org-remove-by-index (list indices &optional i0)
4196 "Remove the elements in LIST with indices in INDICES.
4197 First element has index 0, or I0 if given."
4198 (if (not indices)
4199 list
4200 (if (integerp indices) (setq indices (list indices)))
4201 (setq i0 (1- (or i0 0)))
4202 (delq :rm (mapcar (lambda (x)
4203 (setq i0 (1+ i0))
4204 (if (memq i0 indices) :rm x))
4205 list))))
4207 (defun orgtbl-toggle-comment ()
4208 "Comment or uncomment the orgtbl at point."
4209 (interactive)
4210 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4211 (re2 (concat "^" orgtbl-line-start-regexp))
4212 (commented (save-excursion (beginning-of-line 1)
4213 (cond ((looking-at re1) t)
4214 ((looking-at re2) nil)
4215 (t (error "Not at an org table")))))
4216 (re (if commented re1 re2))
4217 beg end)
4218 (save-excursion
4219 (beginning-of-line 1)
4220 (while (looking-at re) (beginning-of-line 0))
4221 (beginning-of-line 2)
4222 (setq beg (point))
4223 (while (looking-at re) (beginning-of-line 2))
4224 (setq end (point)))
4225 (comment-region beg end (if commented '(4) nil))))
4227 (defun orgtbl-insert-radio-table ()
4228 "Insert a radio table template appropriate for this major mode."
4229 (interactive)
4230 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4231 (txt (nth 1 e))
4232 name pos)
4233 (unless e (error "No radio table setup defined for %s" major-mode))
4234 (setq name (read-string "Table name: "))
4235 (while (string-match "%n" txt)
4236 (setq txt (replace-match name t t txt)))
4238 (setq pos (point))
4239 (insert txt)
4240 (goto-char pos)))
4242 ;; Dynamically bound input and output for table formatting.
4243 (defvar *orgtbl-table* nil
4244 "Carries the current table through formatting routines.")
4245 (defvar *orgtbl-rtn* nil
4246 "Formatting routines push the output lines here.")
4247 ;; Formatting parameters for the current table section.
4248 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4249 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4250 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4251 (defvar *orgtbl-fmt* nil "Format for each entry.")
4252 (defvar *orgtbl-efmt* nil "Format for numbers.")
4253 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4254 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4255 (defvar *orgtbl-lstart* nil "Text starting a row.")
4256 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4257 (defvar *orgtbl-lend* nil "Text ending a row.")
4258 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4260 (defsubst orgtbl-get-fmt (fmt i)
4261 "Retrieve the format from FMT corresponding to the Ith column."
4262 (if (and (not (functionp fmt)) (consp fmt))
4263 (plist-get fmt i)
4264 fmt))
4266 (defsubst orgtbl-apply-fmt (fmt &rest args)
4267 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4268 (cond ((functionp fmt) (apply fmt args))
4269 (fmt (apply 'format fmt args))
4270 (args (car args))
4271 (t args)))
4273 (defsubst orgtbl-eval-str (str)
4274 "If STR is a function, evaluate it with no arguments."
4275 (if (functionp str)
4276 (funcall str)
4277 str))
4279 (defun orgtbl-format-line (line)
4280 "Format LINE as a table row."
4281 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4282 (let* ((i 0)
4283 (line
4284 (mapcar
4285 (lambda (f)
4286 (setq i (1+ i))
4287 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4288 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4289 (orgtbl-apply-fmt efmt (match-string 1 f)
4290 (match-string 2 f))
4291 f)))
4292 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4293 *orgtbl-default-fmt*)
4294 f)))
4295 line)))
4296 (push (if *orgtbl-lfmt*
4297 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4298 (concat (orgtbl-eval-str *orgtbl-lstart*)
4299 (mapconcat 'identity line *orgtbl-sep*)
4300 (orgtbl-eval-str *orgtbl-lend*)))
4301 *orgtbl-rtn*))))
4303 (defun orgtbl-format-section (section-stopper)
4304 "Format lines until the first occurrence of SECTION-STOPPER."
4305 (let (prevline)
4306 (progn
4307 (while (not (eq (car *orgtbl-table*) section-stopper))
4308 (if prevline (orgtbl-format-line prevline))
4309 (setq prevline (pop *orgtbl-table*)))
4310 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4311 (*orgtbl-lend* *orgtbl-llend*)
4312 (*orgtbl-lfmt* *orgtbl-llfmt*))
4313 (orgtbl-format-line prevline))))))
4315 (defun orgtbl-to-generic (table params)
4316 "Convert the orgtbl-mode TABLE to some other format.
4317 This generic routine can be used for many standard cases.
4318 TABLE is a list, each entry either the symbol `hline' for a horizontal
4319 separator line, or a list of fields for that line.
4320 PARAMS is a property list of parameters that can influence the conversion.
4321 For the generic converter, some parameters are obligatory: you need to
4322 specify either :lfmt, or all of (:lstart :lend :sep).
4324 Valid parameters are
4326 :splice When set to t, return only table body lines, don't wrap
4327 them into :tstart and :tend. Default is nil. When :splice
4328 is non-nil, this also means that the exporter should not look
4329 for and interpret header and footer sections.
4331 :hline String to be inserted on horizontal separation lines.
4332 May be nil to ignore hlines.
4334 :sep Separator between two fields
4335 :remove-nil-lines Do not include lines that evaluate to nil.
4338 Each in the following group may be either a string or a function
4339 of no arguments returning a string:
4340 :tstart String to start the table. Ignored when :splice is t.
4341 :tend String to end the table. Ignored when :splice is t.
4342 :lstart String to start a new table line.
4343 :llstart String to start the last table line, defaults to :lstart.
4344 :lend String to end a table line
4345 :llend String to end the last table line, defaults to :lend.
4347 Each in the following group may be a string, a function of one
4348 argument (the field or line) returning a string, or a plist
4349 mapping columns to either of the above:
4350 :lfmt Format for entire line, with enough %s to capture all fields.
4351 If this is present, :lstart, :lend, and :sep are ignored.
4352 :llfmt Format for the entire last line, defaults to :lfmt.
4353 :fmt A format to be used to wrap the field, should contain
4354 %s for the original field value. For example, to wrap
4356 This may also be a property list with column numbers and
4359 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4360 Same as above, specific for the header lines in the table.
4361 All lines before the first hline are treated as header.
4362 If any of these is not present, the data line value is used.
4364 This may be either a string or a function of two arguments:
4365 :efmt Use this format to print numbers with exponentials.
4366 The format should have %s twice for inserting mantissa
4368 may also be a property list with column numbers and
4369 formats. :fmt will still be applied after :efmt.
4371 In addition to this, the parameters :skip and :skipcols are always handled
4372 directly by `orgtbl-send-table'. See manual."
4373 (interactive)
4375 (let* ((splicep (plist-get params :splice))
4376 (hline (plist-get params :hline))
4377 (remove-nil-linesp (plist-get params :remove-nil-lines))
4378 (remove-newlines (plist-get params :remove-newlines))
4379 (*orgtbl-hline* hline)
4380 (*orgtbl-table* table)
4381 (*orgtbl-sep* (plist-get params :sep))
4382 (*orgtbl-efmt* (plist-get params :efmt))
4383 (*orgtbl-lstart* (plist-get params :lstart))
4384 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4385 (*orgtbl-lend* (plist-get params :lend))
4386 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4387 (*orgtbl-lfmt* (plist-get params :lfmt))
4388 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4389 (*orgtbl-fmt* (plist-get params :fmt))
4390 *orgtbl-rtn*)
4392 ;; Put header
4393 (unless splicep
4394 (when (plist-member params :tstart)
4395 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4396 (if tstart (push tstart *orgtbl-rtn*)))))
4398 ;; Do we have a heading section? If so, format it and handle the
4399 ;; trailing hline.
4400 (if (and (not splicep)
4401 (or (consp (car *orgtbl-table*))
4402 (consp (nth 1 *orgtbl-table*)))
4403 (memq 'hline (cdr *orgtbl-table*)))
4404 (progn
4405 (when (eq 'hline (car *orgtbl-table*))
4406 ;; there is a hline before the first data line
4407 (and hline (push hline *orgtbl-rtn*))
4408 (pop *orgtbl-table*))
4409 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4410 *orgtbl-lstart*))
4411 (*orgtbl-llstart* (or (plist-get params :hllstart)
4412 *orgtbl-llstart*))
4413 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4414 (*orgtbl-llend* (or (plist-get params :hllend)
4415 (plist-get params :hlend) *orgtbl-llend*))
4416 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4417 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4418 (plist-get params :hlfmt) *orgtbl-llfmt*))
4419 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4420 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4421 (orgtbl-format-section 'hline))
4422 (if hline (push hline *orgtbl-rtn*))
4423 (pop *orgtbl-table*)))
4425 ;; Now format the main section.
4426 (orgtbl-format-section nil)
4428 (unless splicep
4429 (when (plist-member params :tend)
4430 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4431 (if tend (push tend *orgtbl-rtn*)))))
4433 (mapconcat (if remove-newlines
4434 (lambda (tend)
4436 'identity)
4437 (nreverse (if remove-nil-linesp
4438 (remq nil *orgtbl-rtn*)
4441 (defun orgtbl-to-tsv (table params)
4442 "Convert the orgtbl-mode table to TAB separated material."
4444 (defun orgtbl-to-csv (table params)
4445 "Convert the orgtbl-mode table to CSV material.
4446 This does take care of the proper quoting of fields with comma or quotes."
4447 (orgtbl-to-generic table (org-combine-plists
4448 '(:sep "," :fmt org-quote-csv-field)
4449 params)))
4451 (defun orgtbl-to-latex (table params)
4452 "Convert the orgtbl-mode TABLE to LaTeX.
4453 TABLE is a list, each entry either the symbol `hline' for a horizontal
4454 separator line, or a list of fields for that line.
4455 PARAMS is a property list of parameters that can influence the conversion.
4456 Supports all parameters from `orgtbl-to-generic'. Most important for
4457 LaTeX are:
4459 :splice When set to t, return only table body lines, don't wrap
4460 them into a tabular environment. Default is nil.
4462 :fmt A format to be used to wrap the field, should contain %s for the
4463 original field value. For example, to wrap everything in dollars,
4466 The format may also be a function that formats its one argument.
4468 :efmt Format for transforming numbers with exponentials. The format
4469 should have %s twice for inserting mantissa and exponent, for
4471 This may also be a property list with column numbers and formats.
4472 The format may also be a function that formats its two arguments.
4474 :llend If you find too much space below the last line of a table,
4477 The general parameters :skip and :skipcols have already been applied when
4478 this function is called."
4479 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4480 org-table-last-alignment ""))
4481 (params2
4482 (list
4487 (orgtbl-to-generic table (org-combine-plists params2 params))))
4489 (defun orgtbl-to-html (table params)
4490 "Convert the orgtbl-mode TABLE to HTML.
4491 TABLE is a list, each entry either the symbol `hline' for a horizontal
4492 separator line, or a list of fields for that line.
4493 PARAMS is a property list of parameters that can influence the conversion.
4494 Currently this function recognizes the following parameters:
4496 :splice When set to t, return only table body lines, don't wrap
4497 them into a <table> environment. Default is nil.
4499 The general parameters :skip and :skipcols have already been applied when
4500 this function is called. The function does *not* use `orgtbl-to-generic',
4501 so you cannot specify parameters for it."
4502 (let* ((splicep (plist-get params :splice))
4503 (html-table-tag org-export-html-table-tag)
4504 html)
4505 ;; Just call the formatter we already have
4506 ;; We need to make text lines for it, so put the fields back together.
4507 (setq html (org-format-org-table-html
4508 (mapcar
4509 (lambda (x)
4510 (if (eq x 'hline)
4511 "|----+----|"
4512 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4513 table)
4514 splicep))
4516 (setq html (replace-match "" t t html)))
4517 html))
4519 (defun orgtbl-to-texinfo (table params)
4520 "Convert the orgtbl-mode TABLE to TeXInfo.
4521 TABLE is a list, each entry either the symbol `hline' for a horizontal
4522 separator line, or a list of fields for that line.
4523 PARAMS is a property list of parameters that can influence the conversion.
4524 Supports all parameters from `orgtbl-to-generic'. Most important for
4525 TeXInfo are:
4527 :splice nil/t When set to t, return only table body lines, don't wrap
4528 them into a multitable environment. Default is nil.
4530 :fmt fmt A format to be used to wrap the field, should contain
4531 %s for the original field value. For example, to wrap
4533 This may also be a property list with column numbers and
4535 Each format also may be a function that formats its one
4536 argument.
4539 are computed automatically from the width of the columns
4540 under org-mode.
4542 The general parameters :skip and :skipcols have already been applied when
4543 this function is called."
4544 (let* ((total (float (apply '+ org-table-last-column-widths)))
4545 (colfrac (or (plist-get params :cf)
4546 (mapconcat
4547 (lambda (x) (format "%.3f" (/ (float x) total)))
4548 org-table-last-column-widths " ")))
4549 (params2
4550 (list
4551 :tstart (concat "@multitable @columnfractions " colfrac)
4552 :tend "@end multitable"
4553 :lstart "@item " :lend "" :sep " @tab "
4554 :hlstart "@headitem ")))
4555 (orgtbl-to-generic table (org-combine-plists params2 params))))
4557 (defun orgtbl-to-orgtbl (table params)
4558 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4559 Useful when slicing one table into many. The :hline, :sep,
4560 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4561 and :tend suppress strings without splicing; they can be set to
4562 provide ORGTBL directives for the generated table."
4563 (let* ((params2
4564 (list
4565 :remove-newlines t
4566 :tstart nil :tend nil
4567 :hline "|---"
4568 :sep " | "
4569 :lstart "| "
4570 :lend " |"))
4571 (params (org-combine-plists params2 params)))
4572 (orgtbl-to-generic table params)))
4574 (defun org-table-get-remote-range (name-or-id form)
4575 "Get a field value or a list of values in a range from table at ID.
4577 NAME-OR-ID may be the name of a table in the current file as set by
4579 will then be used. Alternatively, it may be an ID referring to
4580 any entry, also in a different file. In this case, the first table
4581 in that entry will be referenced.
4585 The return value is either a single string for a single field, or a
4586 list of the fields in the rectangle ."
4587 (save-match-data
4588 (let ((id-loc nil)
4589 org-table-column-names org-table-column-name-regexp
4590 org-table-local-parameters org-table-named-field-locations
4591 org-table-current-line-types org-table-current-begin-line
4592 org-table-current-begin-pos org-table-dlines
4593 org-table-current-ncol
4594 org-table-hlines org-table-last-alignment
4595 org-table-last-column-widths org-table-last-alignment
4596 org-table-last-column-widths tbeg
4597 buffer loc)
4598 (setq form (org-table-convert-refs-to-rc form))
4599 (save-excursion
4600 (save-restriction
4601 (widen)
4602 (save-excursion
4603 (goto-char (point-min))
4604 (if (re-search-forward
4606 nil t)
4607 (setq buffer (current-buffer) loc (match-beginning 0))
4608 (setq id-loc (org-id-find name-or-id 'marker))
4609 (unless (and id-loc (markerp id-loc))
4611 (setq buffer (marker-buffer id-loc)
4612 loc (marker-position id-loc))
4613 (move-marker id-loc nil)))
4614 (with-current-buffer buffer
4615 (save-excursion
4616 (save-restriction
4617 (widen)
4618 (goto-char loc)
4619 (forward-char 1)
4621 (not (match-beginning 1)))
4622 (error "Cannot find a table at NAME or ID %s" name-or-id))
4623 (setq tbeg (point-at-bol))
4624 (org-table-get-specials)
4625 (setq form (org-table-formula-substitute-names form))
4626 (if (and (string-match org-table-range-regexp form)
4627 (> (length (match-string 0 form)) 1))
4628 (save-match-data
4629 (org-table-get-range (match-string 0 form) tbeg 1))
4630 form)))))))))
4632 (provide 'org-table)
4634 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4636 ;;; org-table.el ends here