| blob | 10c18df411e6a73149531c9b96adff630dceed75 |
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 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org-mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
51 "Hook for functions attaching to `C-c C-c', if the table is sent.
52 This can be used to add additional functionality after the table is sent
53 to the receiver position, othewise, if table is not sent, the functions
57 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
58 In the optimized version, the table editor takes over all simple keys that
59 normally just insert a character. In tables, the characters are inserted
60 in a way to minimize disturbing the table structure (i.e. in overwrite mode
61 for empty fields). Outside tables, the correct binding of the keys is
62 restored.
64 The default for this option is t if the optimized version is also used in
65 Org-mode. See the variable `org-enable-table-editor' for details. Changing
66 this variable requires a restart of Emacs to become effective."
72 % END RECEIVE ORGTBL %n
74 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
75 | | |
78 @c END RECEIVE ORGTBL %n
79 @ignore
80 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
81 | | |
84 <!-- END RECEIVE ORGTBL %n -->
85 <!--
86 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
87 | | |
89 "Templates for radio tables in different major modes.
90 All occurrences of %n in a template will be replaced with the name of the
91 table, obtained by prompting the user."
98 "Settings for tables in Org-mode."
103 "The default size for newly created tables, Columns x Rows."
109 "Regular expression for recognizing numbers in table columns.
110 If a table column contains mostly numbers, it will be aligned to the
111 right. If not, it will be aligned to the left.
113 The default value of this option is a regular expression which allows
114 anything which looks remotely like a number as used in scientific
115 context. For example, all of the following will be considered a
116 number:
117 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
119 Other options offered by the customize interface are more restrictive."
137 "Fraction of numbers in a column required to make the column align right.
138 In a column all non-white fields are considered. If at least this
139 fraction of fields is matched by `org-table-number-fraction',
140 alignment to the right border applies."
145 "Behavior of tables during editing in Org-mode."
150 "Non-nil means automatically re-align table when pressing TAB or RETURN.
152 removal/insertion."
157 "Non-nil means automatically blank table field when starting to type into it.
158 This only happens when typing immediately after a field motion
159 command (TAB, S-TAB or RET).
160 Only relevant when `org-enable-table-editor' is equal to `optimized'."
165 "Non-nil means automatically exit the follow mode.
166 When nil, the follow mode will stay on and be active in any table
167 the cursor enters. Since the table follow filed mode messes with the
168 window configuration, it is not recommended to set this variable to nil,
169 except maybe locally in a special file that has mostly tables with long
170 fields."
175 "Whether the user should confirm when Org fixes formulas."
182 'safe-local-variable
186 "Non-nil means tab in the last column of a table with jump over a hline.
187 If a horizontal separator line is following the current line,
188 `org-table-next-field' can either create a new row before that line, or jump
189 over the line. When this option is nil, a new line will be created before
190 this line."
195 "Options concerning tables in Org-mode."
200 "Should org-mode work with table references like B3 instead of @3$2?
201 Possible values are:
202 nil never use them
203 from accept as input, do not present for editing
204 t accept as input and present for editing"
219 calc-angle-mode deg
220 calc-prefer-frac nil
221 calc-symbolic-mode nil
223 calc-display-working-message t
224 )
225 "List with Calc mode settings for use in `calc-eval' for table formulas.
226 The list must contain alternating symbols (Calc modes variables and values).
227 Don't remove any of the default settings, just change the values. Org-mode
228 relies on the variables to be present in the list."
233 "Format for the output of calc computations like $1+$2;t.
234 The default value is 'hours, and will output the results as a
235 number of hours. Other allowed values are 'seconds, 'minutes and
236 'days, and the output will be a fraction of seconds, minutes or
237 days."
245 "Non-nil means TAB and RET evaluate a formula in current table field.
246 If the current field starts with an equal sign, it is assumed to be a formula
247 which should be evaluated as described in the manual and in the documentation
248 string of the command `org-table-eval-formula'. This feature requires the
249 Emacs calc package.
250 When this variable is nil, formula calculation is only available through
256 "Non-nil means interpret constants in formulas in tables.
257 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
258 by the value given in `org-table-formula-constants', or by a value obtained
259 from the `constants.el' package."
264 "Alist with constant names and values, for use in table formulas.
265 The car of each element is a name of a constant, without the `$' before it.
266 The cdr is the value as a string. For example, if you'd like to use the
267 speed of light in a formula, you would configure
271 and then use it in an equation like `$1*$c'.
273 Constants can also be defined on a per-file basis using a line like
275 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
282 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
283 Automatically means when TAB or RET or C-c C-c are pressed in the line."
288 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
293 "Non-nil means relative formula references may cross hlines.
294 Here are the allowed values:
296 nil Relative references may not cross hlines. They will reference the
297 field next to the hline instead. Coming from below, the reference
298 will be to the field below the hline. Coming from above, it will be
299 to the field above.
300 t Relative references may cross hlines.
301 error An attempt to cross a hline will throw an error.
303 It is probably good to never set this variable to nil, for the sake of
304 portability of tables."
312 "Options concerning table import and export in Org-mode."
317 "Default export parameters for `org-table-export'.
318 These can be overridden for a specific table by setting the
319 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
320 radio tables for the different export transformations and
321 available parameters."
359 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
360 ;; 1 2 3 4 5
371 "Is this a table line colgroup information?"
375 line)
377 nil
384 "Is this a table line with only alignment/width cookies?"
397 s))))
406 "Use the table.el package to insert a new table.
407 If there is already a table at point, convert between Org-mode tables
408 and table.el tables."
422 "Convert region to table, or create an empty table.
423 If there is an active region, convert it to a table, using the function
424 `org-table-convert-region'. See the documentation of that function
425 to learn how the prefix argument is interpreted to determine the field
426 separator.
427 If there is no such region, create an empty table with `org-table-create'."
434 "Query for a size and insert a table skeleton.
454 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
458 ;; Insert a hline after the first row.
466 "Convert region to a table.
467 The region goes from BEG0 to END0, but these borders will be moved
468 slightly, to make sure a beginning of line in the first line is included.
470 SEPARATOR specifies the field separator in the lines. It can have the
471 following values:
473 '(4) Use the comma as a field separator
474 '(16) Use a TAB as field separator
475 integer When a number, use that many spaces as field separator
476 nil When nil, the command tries to be smart and figure out the
477 separator in the following way:
478 - when each line contains a TAB, assume TAB-separated material
479 - when each line contains a comma, assume CSV material
480 - else, assume one or more SPACE characters as separator."
484 re)
491 ;; Get the right field separator
502 ;; parse the csv stuff
526 "Import FILE as a table.
527 The file is assumed to be tab-separated. Such files can be produced by most
528 spreadsheet and database applications. If no tabs (at least one per line)
529 are found, lines will be split on whitespace into fields."
541 "Export table to a file, with configurable format.
542 Such a file can be imported into a spreadsheet program like Excel.
543 FILE can be the output file name. If not given, it will be taken from
544 a TABLE_EXPORT_FILE property in the current entry or higher up in the
545 hierarchy, or the user will be prompted for a file name.
546 FORMAT can be an export format, of the same kind as it used when
547 `orgtbl-mode' sends a table in a different format. The default format can
548 be found in the variable `org-table-export-default-format', but the function
549 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
550 property, locally or anywhere up in the hierarchy."
562 buf deffmt-readable)
581 "Format: "
586 deffmt-readable)))
599 'hline
602 skipcols i0)))
603 lines))
607 skipcols i0))
610 skipcols i0)))
627 "Marker at the beginning of the table last aligned.
630 "Marker at the end of the table last aligned.
633 "List of flags for flushright alignment, from the last re-alignment.
636 "List of max width of fields in each column.
639 "Non-nil means debug table formulas.
652 "Align the table at point by aligning all vertical bars."
655 ;; Limits of table
658 ;; Current cursor position
664 column
666 rfmt hfmt
674 emptystrings links dates emph raise narrow
675 falign falign1 fmax f1 len c e space)
678 ;; Check if we have links or dates
690 ;; Make sure the link properties are right
692 ;; Make sure the date properties are right
697 ;; Check if we are narrowing any columns
700 org-format-transports-properties-p
705 ;; Get the rows
708 ;; Store the indentation of the first line
711 ;; Mark the hlines by setting the corresponding element to nil
712 ;; At the same time, we remove trailing space.
715 nil
718 l)))
719 lines))
720 ;; Get the data fields by splitting the lines.
725 ;; How many fields in the longest line?
732 ;; A list of empty strings to fill any short rows on output
734 ;; Check for special formatting.
738 ;; Check if there is an explicit width specified
748 ;; Find fields that are wider than fmax, and shorten them
754 'help-echo
755 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
763 xx)))))
764 ;; Get the maximum width for each column
766 lengths)
767 ;; Get the fraction of numbers, to decide about alignment of the column
773 nil
780 ;; Store the alignment of this table, for later editing of single fields
782 org-table-last-column-widths lengths)
784 ;; With invisible characters, `format' does not get the field width right
785 ;; So we need to make these fields wide by hand.
803 ;; Compute the formats needed for output of the table
816 hfmt))
820 ;; Replace the old one
827 ;; Try to move to the old location
835 ))
838 "Find the beginning of the table and return its position.
839 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
843 org-table-border-regexp)
844 nil t))
851 "Find the end of the table and return its position.
852 With argument TABLE-TYPE, go to the end of a table.el-type table."
856 org-table-border-regexp)
857 nil t))
863 "Justify the current field, text to left, number to right.
864 Optional argument NEW may specify text to replace the current field content."
873 ;; This is not the same table, force a full re-align
879 l f n o e)
903 "Go to the next field in the current table, creating new lines as needed.
904 Before doing so, re-align the table if necessary."
909 org-table-may-need-update)
920 org-table-tab-jumps-over-hlines
932 "Go to the previous field in the table.
933 Before doing so, re-align the table if necessary."
938 org-table-may-need-update)
953 "Move to the end of the current table field.
954 If already at or after the end, move to the end of the next table field.
955 With numeric argument N, move N-1 fields forward first."
968 "Move to the beginning of the current table field.
969 If already at or before the beginning, move to the beginning of the
970 previous field.
971 With numeric argument N, move N-1 fields backward first."
985 "Go to the next row (same column) in the current table.
986 Before doing so, re-align the table if necessary."
994 org-table-may-need-update)
1008 "Copy a field down in the current column.
1009 If the field at the cursor is empty, copy into it the content of
1010 the nearest non-empty field above. With argument N, use the Nth
1011 non-empty field. If the current field is not empty, it is copied
1012 down to the next row, and the cursor is moved with it.
1013 Therefore, repeating this command causes the column to be filled
1014 row-by-row.
1015 If the variable `org-table-copy-increment' is non-nil and the
1016 field is an integer or a timestamp, it will be incremented while
1017 copying. In the case of a timestamp, increment by one day."
1025 txt)
1037 beg t))
1060 "Is point inside a table data field?
1061 I.e. not on a hline or before the first or after the last column?
1062 This actually throws an error, so it aborts the current command."
1068 nil
1070 t))
1076 "Get the field in table line LINE, column COLUMN.
1077 If LINE is larger than the number of data lines in the table, the function
1078 returns nil. However, if COLUMN is too large, we will simply return an
1079 empty string.
1080 If LINE is nil, use the current line.
1081 If column is nil, use the current column."
1088 "Put VALUE into line LINE, column COLUMN.
1089 When ALIGN is set, also realign the table."
1098 "Return the index of the current data line."
1105 cnt))
1108 "Go to the Nth data line in the current table.
1109 Return t when the line exists, nil if it does not exist."
1117 "Blank the current table field or active region."
1134 "Return the value of the field in column N of current row.
1135 N defaults to current field.
1136 If REPLACE is a string, replace field with this value. The return value
1137 is always the old value."
1146 t t))
1148 val)
1152 "Show info about the current field, and highlight any reference at point."
1160 org-table-named-field-locations)))
1180 dline col
1182 dline col ref1
1184 ;; FIXME: formula info not correct if special table line
1194 "Find out which column we are in."
1204 cnt)))
1207 "Find out what table data line we are in.
1208 Only data lines count for this."
1220 cnt)))
1223 "Move the cursor to the Nth column in the current table line.
1224 With optional argument ON-DELIM, stop with point before the left delimiter
1225 of the field.
1226 If there are less than N fields, just go to after the last delimiter.
1227 However, when FORCE is non-nil, create new columns if necessary."
1237 t)))))
1245 "Insert a new column into the table."
1253 ;; Current cursor position
1259 nil
1273 "Find a data line in the current table, which is needed for column commands."
1276 t
1287 t
1292 "Turn a buffer line number into a data line number.
1293 If there is no data line in this line, return nil.
1294 If there is no matchin dline (most likely te refrence was a hline), the
1295 first dline below it is used. When ABOVE is non-nil, the one above is used."
1298 i)
1311 nil))
1314 "Delete a column from the table."
1323 ;; Current cursor position
1329 nil
1346 "Move column to the right."
1350 "Move column to the left."
1355 "Move the current column to the right. With arg LEFT, move to the left."
1365 ;; Current cursor position
1375 nil
1394 "Move table row down."
1398 "Move table row up."
1403 "Move the current table line down. With arg UP, move it up."
1412 txt hline2p)
1436 "Insert a new row above the current line into the table.
1437 With prefix ARG, insert below the current line."
1443 ;; Fix the first field if necessary
1457 "Insert a horizontal-line below the current line into the table.
1458 With prefix ABOVE, insert above the current line."
1480 "Insert a hline and move to the row below that line."
1494 In particular, this does handle wide and invisible characters."
1496 ;; It's a hline, just map the characters
1502 t t s)))
1503 s))
1506 "Delete the current row or horizontal line from the table."
1521 "Sort table lines according to the column at point.
1523 The position of point indicates the column to be used for
1524 sorting, and the range of lines is the range between the nearest
1525 horizontal separator lines, or the entire table of no such lines
1526 exist. If point is before the first column, you will be prompted
1527 for the sorting column. If there is an active region, the mark
1528 specifies the first line and the sorting column, while point
1529 should be in the last line to be included into the sorting.
1531 The command then prompts for the sorting type which can be
1532 alphabetically, numerically, or by time (as given in a time stamp
1533 in the field). Sorting in reverse order is also possible.
1535 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1537 If SORTING-TYPE is specified when this function is called from a Lisp
1538 program, no prompting will take place. SORTING-TYPE must be a character,
1539 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1540 should be done in reverse order."
1544 beg end bcol ecol tend tbeg column lns pos)
1589 x))
1602 "Copy region in table to the clipboard and blank all relevant fields.
1603 If there is no active region, use just the field at point."
1610 "Copy rectangular region in table to clipboard.
1611 A special clipboard is used which can only be accessed
1612 with `org-table-paste-rectangle'."
1616 current-prefix-arg))
1618 region cols
1644 org-table-clip))
1647 "Paste a rectangular region into a table.
1648 The upper right corner ends up in the current field. All involved fields
1649 will be overwritten. If the rectangle does not fit into the present table,
1650 the table is enlarged as needed. The process ignores horizontal separator
1651 lines."
1661 c cols field)
1677 "Convert from `org-mode' table to table.el and back.
1678 Obviously, this only works within limits. When an Org-mode table is
1679 converted to table.el, all horizontal separator lines get lost, because
1680 table.el uses these as cell boundaries and has no notion of horizontal lines.
1681 A table.el table can be converted to an Org-mode table only if it does not
1682 do row or column spanning. Multiline cells will become multiple cells.
1683 Beware, Org-mode does not test if the table can be successfully converted - it
1684 blindly applies a recipe that works for simple tables."
1688 ;; convert to Org-mode table
1697 ;; convert to table.el table
1700 ;; first, get rid of all horizontal lines
1704 ;; insert a hline before first
1708 ;; insert a hline after each line
1713 ;; replace "+" at beginning and ending of hlines
1722 "Wrap several fields in a column like a paragraph.
1723 This is useful if you'd like to spread the contents of a field over several
1724 lines, in order to keep the table compact.
1726 If there is an active region, and both point and mark are in the same column,
1727 the text in the column is wrapped to minimum width for the given number of
1728 lines. Generally, this makes the table more compact. A prefix ARG may be
1730 formats the selected text to two lines. If the region was longer than two
1731 lines, the remaining lines remain empty. A negative prefix argument reduces
1732 the current number of lines by that amount. The wrapped text is pasted back
1733 into the table. If you formatted it to more lines than it was before, fields
1734 further down in the table get overwritten - so you might need to make space in
1735 the table first.
1737 If there is no region, the current field is split at the cursor position and
1738 the text fragment to the right of the cursor is prepended to the field one
1739 line down.
1741 If there is no region, but you specify a prefix ARG, the current field gets
1742 blank, and the content is appended to the field above."
1746 ;; There is a region: fill as a paragraph
1750 nlines)
1757 arg)
1761 nil nlines)))
1765 ;; No region, split the current field at point
1769 ;; combine with field above
1779 ;; split field
1792 "Edit table field in a different window.
1793 This is mainly useful for fields that contain hidden parts.
1795 it can be edited in place."
1804 display t intangible t))
1817 p)
1833 intangible t))
1841 "Finish editing a table data field.
1842 Remove all newline characters, insert the result into the table, realign
1843 the table and kill the editing buffer."
1847 text)
1864 "Minor mode to make the table field editor window follow the cursor.
1865 When this mode is active, the field editor window will always show the
1866 current field. The mode exits automatically when the cursor leaves the
1867 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1868 nil " TblFollow" nil
1884 ;; We have left the table, exit the follow mode
1895 "Sum numbers in region of current table column.
1896 The result will be displayed in the echo area, and will be available
1899 If there is an active region, it is interpreted as a rectangle and all
1900 numbers in that rectangle will be summed. If there is no active
1901 region and point is located in a table column, sum all numbers in that
1902 column.
1904 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1905 numbers are assumed to be times as well (in decimal hours) and the
1906 numbers are added as such.
1908 If NLAST is a number, only the NLAST fields will actually be summed."
1935 items1)))
1942 s diff)
1950 sres))))
1973 "Return the formula active for the current field.
1974 Assumes that specials are in place.
1975 If KEY is given, return the key to this formula.
1979 org-table-named-field-locations)))
1993 "Read a formula from the minibuffer, offer stored formula as default.
1994 When NAMED is non-nil, look for a named equation."
1998 org-table-named-field-locations)))
2005 name
2006 ref)
2016 stored)
2018 equation)
2025 scol))
2027 'org-table-formula-history
2028 )))))
2029 mustsave)
2031 ;; remove formula
2038 ;; We set the column equation, delete the named one.
2040 mustsave t))
2046 eq))
2049 "Store the list of formulas below the current table."
2055 ;; don't overwrite TBLFM, we might use text properties to store stuff
2071 ;; Fake a high number to make sure this is sorted at the end.
2078 a)
2088 "Compare two formulas for sorting."
2094 "Return an alist with the stored formulas directly after current table."
2103 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2122 "Modify the equations after the table structure has been edited.
2124 For all numbers larger than LIMIT, shift them by DELTA."
2135 s n a)
2151 t t)))))))))
2154 "Get the column names and local parameters for this table."
2157 names name fields fields1 field cnt
2158 c v l line col types dlines hlines last-dline)
2160 org-table-local-parameters nil
2161 org-table-named-field-locations nil
2162 org-table-current-begin-line nil
2163 org-table-current-begin-pos nil
2164 org-table-current-line-types nil
2183 org-table-local-parameters))))
2199 ;; Analyse the line types
2203 l org-table-current-begin-line)
2220 al al2)
2232 If yes, store the formula and apply it."
2233 ;; We already know we are in a table. Get field will only return a formula
2234 ;; when appropriate. It might return a separator line, but no problem.
2237 named eq)
2248 "List of commands triggering the recalculation of a line.
2261 "Rotate the recalculation mark in the first column.
2262 If in any row, the first field is not consistent with a mark,
2263 insert a new column for the markers.
2264 When there is an active region, change all the lines in the region,
2265 after prompting for the marking character.
2266 After each change, a message will be displayed indicating the meaning
2267 of the new mark."
2282 epos new)
2289 newchar))
2322 "Recompute the current line if marked for it, and if we haven't just done it."
2342 modes)
2345 suppress-align suppress-const
2346 suppress-store suppress-analysis)
2347 "Replace the table field value at the cursor by the result of a calculation.
2349 This function makes use of Dave Gillespie's Calc package, in my view the
2350 most exciting program ever written for GNU Emacs. So you need to have Calc
2351 installed in order to use this function.
2353 In a table, this command replaces the value in the current field with the
2355 formula, by storing it in a special line below the table. When called
2356 with a `C-u' prefix, the current field must be a named field, and the
2357 formula is installed as valid in only this specific field.
2359 When called with two `C-u' prefixes, insert the active equation
2360 for the field back into the current field, so that it can be
2362 to check the referenced fields.
2364 When called, the command first prompts for a formula, which is read in
2365 the minibuffer. Previously entered formulas are available through the
2366 history list, and the last used formula is offered as a default.
2367 These stored formulas are adapted correctly when moving, inserting, or
2368 deleting columns with the corresponding commands.
2370 The formula can be any algebraic expression understood by the Calc package.
2371 For details, see the Org-mode manual.
2373 This function can also be called from Lisp programs and offers
2374 additional arguments: EQUATION can be the formula to apply. If this
2375 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2376 used to speed-up recursive calls by by-passing unnecessary aligns.
2377 SUPPRESS-CONST suppresses the interpretation of constants in the
2378 formula, assuming that this has been done already outside the function.
2379 SUPPRESS-STORE means the formula should not be stored, either because
2380 it is already stored, or because it is a modified equation that should
2381 not overwrite the stored one."
2397 equation
2403 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2404 duration duration-output-format)
2405 ;; Parse the format string. Since we have a lot of modes, this is
2406 ;; a lot of work. However, I think calc still uses most of the time.
2418 'calc-float-format
2421 n))))
2425 duration-output-format nil
2429 duration-output-format org-table-duration-custom-format
2430 numbers t
2454 ;; replace fields with duration values if relevant
2458 fields)))
2462 fields)))
2468 ;; Insert row and column number of formula result field
2479 t t form)))
2481 ;; Check for old vertical references
2483 ;; Insert remote references
2491 keep-empty numbers lispp))
2492 t t form)))
2493 ;; Insert complex ranges
2501 ;; possibly handle durations
2506 formrg)
2507 keep-empty numbers lispp)))
2512 ;; Insert simple ranges
2521 keep-empty numbers lispp))
2522 t t form)))
2524 ;; Insert the references to fields in same row
2534 t t form)))
2554 Orig: %s
2555 $xyz-> %s
2556 @r$c-> %s
2587 prop value)))
2590 "Get a calc vector from a column, according to descriptor DESC.
2591 Optional arguments TBEG and COL can give the beginning of the table and
2592 the current column, to avoid unnecessary parsing.
2594 HIGHLIGHT means just highlight the range.
2596 When CORNERS-ONLY is set, only return the corners of the range as
2597 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2598 in the buffer and column1 and column2 are table column numbers."
2605 beg end c1 c2 r1 r2 rangep tmp)
2622 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2629 ;; just one field
2636 ;; A range, return a vector
2637 ;; First sort the numbers to get a regular ractangle
2641 ;; Only return the corners of the range
2643 ;; Copy the range values into a list
2657 ;; return string representation of calc vector
2662 "Analyze descriptor DESC and retrieve the corresponding line number.
2663 The cursor is currently in line CLINE, the table begins in line BLINE,
2664 and TABLE is a vector with line types."
2672 ;; 1 2 3 4 5 6
2692 nil hn cline desc)))
2695 rel on cline desc)))
2699 "FIXME: Needs more documentation."
2712 nil))
2713 t)))
2717 desc cline)
2718 i)))
2723 s))
2726 "Convert list ELEMENTS to something appropriate to insert into formula.
2727 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2728 NUMBERS indicates that everything should be converted to numbers.
2729 LISPP means to return something appropriate for a Lisp list."
2733 elements
2742 elements))))
2748 x
2754 elements
2758 "Recalculate the current table line by applying all stored formulas.
2759 With prefix arg ALL, do this for all lines in the table.
2760 With the prefix argument ALL is `(16)' \
2762 it is the symbol `iterate', recompute the table until it no longer changes.
2763 If NOALIGN is not nil, do not re-align the table after the computations
2764 are done. This is typically used internally to save time, if it is
2765 known that the table will be realigned a little later anyway."
2780 seen-fields lhs1
2782 ;; Insert constants in all formulas
2798 eqlist))
2799 ;; Split the equation list
2805 ;; Expand ranges in lhs of formulas
2808 ;; Get the correct line range to process
2814 ;; This is a table with marked lines, compute selected lines
2816 ;; Move forward to the first non-header line
2827 ;; First find the named fields, and mark them untouchable.
2828 ;; Also check if several field/range formulas try to set the same field.
2847 name)))
2857 ;; Now evaluate the column formulas, but skip fields covered by
2858 ;; field formulas
2862 ;; Unprotected line, recalculate
2874 ;; Now evaluate the field formulas
2888 ;; back to initial position
2896 "Recalculate the table until it does not change anymore.
2897 The maximun number of iterations is 10, but you can chose a different value
2898 with the prefix ARG."
2903 thistbl)
2918 "Recalculate all tables in the current buffer."
2926 "Iterate all tables in the buffer, to converge inter-table dependencies."
2931 c1
2948 "Expand list of formulas.
2949 If some of the RHS in the formulas are ranges or a row reference, expand
2950 them to individual field equations for each field."
2956 ;; This just refers to one fixed field
2959 ;; This just refers to one fixed named field
2981 "Replace @<, @>, $<, $> with first/last row/column of the table.
2982 So @< and $< will always be replaced with @1 and $1, respectively.
2983 The advantage of these special markers are that structure editing of
2984 the table will not change them, while @1 and $1 will be modified
2985 when a line/row is swaped out of that privileged position. So for
2986 formulas that use a range of rows or columns, it may often be better
2988 borders of the table using the @< @> $< $> makers."
2991 s start)
2996 org-table-current-ncol)
3000 len
3007 s)
3010 "Replace $const with values in string F."
3012 ;; First, check for column names
3017 ;; Parameters and constants
3019 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3029 f))
3032 "Find the value for a parameter or constant in a formula.
3033 Parameters get priority."
3064 map))
3071 "--"
3074 "--"
3075 "Shift Reference at Point"
3080 "-"
3081 "Change Test Row for Column Formulas"
3084 "--"
3089 org-table-overlay-coordinates)]
3090 "--"
3097 "Edit the formulas of the current table in a separate buffer."
3113 entry s type title)
3116 ;; Keep global-font-lock-mode from turning on font-lock-mode
3157 "Convert a formula from internal to user representation."
3160 s))
3163 "Convert a formula from user to internal representation."
3166 s))
3169 "Convert spreadsheet references from A7 to @7$28.
3170 Works for single references, but also for entire formulas and even the
3171 full TBLFM line."
3173 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3176 ;; format match, just advance
3181 ;; 3.e5 or something like this.
3184 ;; (member (match-string 1 s)
3185 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3186 )
3187 ;; function name, just advance
3197 t t s)))))
3198 s))
3201 "Convert spreadsheet references from to @7$28 to AB7.
3202 Works for single references, but also for entire formulas and even the
3203 full TBLFM line."
3210 t t s)))
3215 t nil s)))
3216 s)
3219 "Convert a base 26 number represented by letters into an integer.
3220 For example: AB -> 28."
3226 n))
3229 "Convert an integer into a base 26 number represented by letters.
3230 For example: 28 -> AB."
3235 s))
3238 "Convert a time string into numerical duration in seconds.
3239 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3240 If S is a string representing a number, keep this number."
3263 "Convert a number of seconds to a time string.
3264 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3265 minutes or seconds."
3277 "Convert all references in this buffer, using FUNCTION."
3287 "Convert all references in the buffer from B3 to @3$2 and back."
3297 "Shift the reference at point one row/hline up."
3301 "Shift the reference at point one row/hline down."
3305 "Shift the reference at point one field to the left."
3309 "Shift the reference at point one field to the right."
3320 ;; A B3-like reference
3326 ;; An internal reference
3332 "Re-match the group N, and replace it with the shifted reference."
3337 t t)))
3340 "Shift a reference part REF.
3341 If DECR is set, decrease the references row/column, else increase.
3342 If HLINE is set, this may be a hline reference, it certainly is not
3343 a translation reference."
3372 "Toggle the display of coordinates in the referenced table."
3381 "Parse the buffer for formula definitions and install them.
3382 With prefix ARG, apply the new formulas to the table."
3392 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3393 nil t)
3417 "Abort editing formulas, without installing the changes."
3428 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3469 "Show the location/value of the $ expression at point."
3478 var name e what match dest)
3483 "$1.."
3566 ;; column number
3594 org-table-fedit-scroll-down))))
3605 "Make sure the cursor is in a dataline in a table."
3614 p1 p2)))
3619 "Move cursor one line up in the window showing the table."
3624 "Move cursor one line down in the window showing the table."
3629 "Move the cursor in the window showing the table.
3630 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3655 "Add a new overlay."
3661 "Highlight rectangular region in a table."
3665 l1 c1 l2 c2 tmp)
3689 "Remove the rectangle overlays."
3700 "Add overlays to the table at point, to show row/column coordinates."
3729 "Toggle the display of Row/Column numbers in tables."
3741 "Toggle the formula debugger in tables."
3747 ;;; The orgtbl minor mode
3749 ;; Define a minor mode which can be used in other modes in order to
3750 ;; integrate the org-mode table editor.
3752 ;; This is really a hack, because the org-mode table editor uses several
3753 ;; keys which normally belong to the major mode, for example the TAB and
3754 ;; RET keys. Here is how it works: The minor mode defines all the keys
3755 ;; necessary to operate the table editor, but wraps the commands into a
3756 ;; function which tests if the cursor is currently inside a table. If that
3757 ;; is the case, the table editor command is executed. However, when any of
3758 ;; those keys is used outside a table, the function uses `key-binding' to
3759 ;; look up if the key has an associated command in another currently active
3760 ;; keymap (minor modes, major mode, global), and executes that command.
3761 ;; There might be problems if any of the keys used by the table editor is
3762 ;; otherwise used as a prefix key.
3764 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3765 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3766 ;; addresses this by checking explicitly for both bindings.
3768 ;; The optimized version (see variable `orgtbl-optimized') takes over
3769 ;; all keys which are bound to `self-insert-command' in the *global map*.
3770 ;; Some modes bind other commands to simple characters, for example
3771 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3772 ;; active, this binding is ignored inside tables and replaced with a
3773 ;; modified self-insert.
3779 ;;;###autoload
3781 "Unconditionally turn on `orgtbl-mode'."
3796 ;; Install it as a minor mode.
3800 ;;;###autoload
3802 "The `org-mode' table editor as a minor mode for use in other modes."
3807 ;; Exit without error, in case some hook functions calls this
3808 ;; by accident in org-mode.
3812 ;; Make sure we are first in minor-mode-map-alist
3814 ;; FIXME: maybe it should use emulation-mode-map-alists?
3821 auto-fill-inhibit-regexp)
3825 auto-fill-inhibit-regexp)
3826 orgtbl-line-start-regexp))
3844 "Remove all properties related to narrow-column invisibility."
3857 "Create a function for binding in the table minor mode.
3858 FUN is the command to call inside a table. N is used to create a unique
3859 command name. KEYS are keys that should be checked in for a command
3860 to execute outside of tables."
3866 "Outside of tables, run the binding of `"
3878 keys)
3882 "Error when there is no default binding for a table key."
3887 "Setup orgtbl keymaps."
3918 elt key fun cmd)
3926 ;; Special treatment needed for TAB and RET
3946 [(tab)] "\C-i")))
3948 (org-defkey orgtbl-mode-map [backtab]
3950 [backtab] [S-iso-lefttab] [(shift tab)]
3951 [(tab)] "\C-i"))
3953 (org-defkey orgtbl-mode-map "\M-\C-m"
3954 (orgtbl-make-binding 'org-table-wrap-region 105
3955 "\M-\C-m" [(meta return)]))
3956 (org-defkey orgtbl-mode-map [(meta return)]
3957 (orgtbl-make-binding 'org-table-wrap-region 106
3958 [(meta return)] "\M-\C-m"))
3960 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3961 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3963 (when orgtbl-optimized
3964 ;; If the user wants maximum table support, we need to hijack
3965 ;; some standard editing functions
3966 (org-remap orgtbl-mode-map
3967 'self-insert-command 'orgtbl-self-insert-command
3968 'delete-char 'org-delete-char
3969 'delete-backward-char 'org-delete-backward-char)
3970 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3971 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3972 '("OrgTbl"
3973 ["Create or convert" org-table-create-or-convert-from-region
3974 :active (not (org-at-table-p)) :keys "C-c |" ]
3975 "--"
3976 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3977 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3978 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3979 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3980 "--"
3981 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3982 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3983 ["Copy Field from Above"
3984 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3985 "--"
3986 ("Column"
3987 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3988 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3989 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3990 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3991 ("Row"
3992 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3993 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3994 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3995 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3996 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3997 "--"
3998 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3999 ("Rectangle"
4000 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4001 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4002 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4003 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4004 "--"
4005 ("Radio tables"
4006 ["Insert table template" orgtbl-insert-radio-table
4007 (assq major-mode orgtbl-radio-table-templates)]
4008 ["Comment/uncomment table" orgtbl-toggle-comment t])
4009 "--"
4010 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4011 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4012 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4013 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4014 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4015 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4016 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4017 ["Sum Column/Rectangle" org-table-sum
4018 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4019 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4020 ["Debug Formulas"
4021 org-table-toggle-formula-debugger :active (org-at-table-p)
4022 :keys "C-c {"
4023 :style toggle :selected org-table-formula-debug]
4024 ["Show Col/Row Numbers"
4025 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4026 :keys "C-c }"
4027 :style toggle :selected org-table-overlay-coordinates]
4028 ))
4029 t))
4031 (defun orgtbl-ctrl-c-ctrl-c (arg)
4032 "If the cursor is inside a table, realign the table.
4033 If it is a table to be sent away to a receiver, do it.
4034 With prefix arg, also recompute table."
4035 (interactive "P")
4036 (let ((pos (point)) action consts-str consts cst const-str)
4037 (save-excursion
4038 (beginning-of-line 1)
4039 (setq action (cond
4043 (cond
4044 ((integerp action)
4045 (goto-char action)
4046 (org-table-maybe-eval-formula)
4047 (if arg
4048 (call-interactively 'org-table-recalculate)
4049 (org-table-maybe-recalculate-line))
4050 (call-interactively 'org-table-align)
4051 (when (orgtbl-send-table 'maybe)
4052 (run-hooks 'orgtbl-after-send-table-hook)))
4053 ((eq action 'recalc)
4054 (save-excursion
4055 (goto-char (point-min))
4057 (setq const-str (substring-no-properties (match-string 1)))
4059 (when consts
4060 (let (e)
4061 (while (setq e (pop consts))
4063 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4064 (setq org-table-formula-constants-local cst)))))
4065 (save-excursion
4066 (beginning-of-line 1)
4068 (if (org-at-table-p)
4069 (org-call-with-arg 'org-table-recalculate t))))
4070 (t (let (orgtbl-mode)
4071 (call-interactively (key-binding "\C-c\C-c")))))))
4073 (defun orgtbl-create-or-convert-from-region (arg)
4074 "Create table or convert region to table, if no conflicting binding.
4075 This installs the table binding `C-c |', but only if there is no
4076 conflicting binding to this key outside orgtbl-mode."
4077 (interactive "P")
4078 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4079 (if cmd
4080 (call-interactively cmd)
4081 (call-interactively 'org-table-create-or-convert-from-region))))
4083 (defun orgtbl-tab (arg)
4084 "Justification and field motion for `orgtbl-mode'."
4085 (interactive "P")
4086 (if arg (org-table-edit-field t)
4087 (org-table-justify-field-maybe)
4088 (org-table-next-field)))
4090 (defun orgtbl-ret ()
4091 "Justification and field motion for `orgtbl-mode'."
4092 (interactive)
4093 (if (bobp)
4094 (newline)
4095 (org-table-justify-field-maybe)
4096 (org-table-next-row)))
4098 (defun orgtbl-self-insert-command (N)
4099 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4100 If the cursor is in a table looking at whitespace, the whitespace is
4101 overwritten, and the table is not marked as requiring realignment."
4102 (interactive "p")
4103 (if (and (org-at-table-p)
4104 (or
4105 (and org-table-auto-blank-field
4106 (member last-command
4107 '(orgtbl-hijacker-command-100
4108 orgtbl-hijacker-command-101
4109 orgtbl-hijacker-command-102
4110 orgtbl-hijacker-command-103
4111 orgtbl-hijacker-command-104
4112 orgtbl-hijacker-command-105
4113 yas/expand))
4114 (org-table-blank-field))
4115 t)
4116 (eq N 1)
4118 (let (org-table-may-need-update)
4119 (goto-char (1- (match-end 0)))
4120 (delete-char -1)
4121 (goto-char (match-beginning 0))
4122 (self-insert-command N))
4123 (setq org-table-may-need-update t)
4124 (let* (orgtbl-mode
4125 a
4126 (cmd (or (key-binding
4127 (or (and (listp function-key-map)
4128 (setq a (assoc last-input-event function-key-map))
4129 (cdr a))
4130 (vector last-input-event)))
4131 'self-insert-command)))
4132 (call-interactively cmd)
4133 (if (and org-self-insert-cluster-for-undo
4134 (eq cmd 'self-insert-command))
4135 (if (not (eq last-command 'orgtbl-self-insert-command))
4136 (setq org-self-insert-command-undo-counter 1)
4137 (if (>= org-self-insert-command-undo-counter 20)
4138 (setq org-self-insert-command-undo-counter 1)
4139 (and (> org-self-insert-command-undo-counter 0)
4140 buffer-undo-list
4141 (not (cadr buffer-undo-list)) ; remove nil entry
4142 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4143 (setq org-self-insert-command-undo-counter
4144 (1+ org-self-insert-command-undo-counter))))))))
4147 "Regular expression matching exponentials as produced by calc.")
4149 (defun orgtbl-export (table target)
4150 (require 'org-exp)
4151 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4153 org-table-last-alignment org-table-last-column-widths
4154 maxcol column)
4155 (if (not (fboundp func))
4156 (error "Cannot export orgtbl table to %s" target))
4157 (setq lines (org-table-clean-before-export lines))
4158 (setq table
4159 (mapcar
4160 (lambda (x)
4161 (if (string-match org-table-hline-regexp x)
4162 'hline
4164 lines))
4165 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4166 table)))
4167 (loop for i from (1- maxcol) downto 0 do
4168 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4169 (setq column (delq nil column))
4170 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4171 (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))
4172 (funcall func table nil)))
4174 (defun orgtbl-gather-send-defs ()
4175 "Gather a plist of :name, :transform, :params for each destination before
4176 a radio table."
4177 (save-excursion
4178 (goto-char (org-table-begin))
4179 (let (rtn)
4180 (beginning-of-line 0)
4181 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4182 (let ((name (org-no-properties (match-string 1)))
4183 (transform (intern (match-string 2)))
4184 (params (if (match-end 3)
4185 (read (concat "(" (match-string 3) ")")))))
4186 (push (list :name name :transform transform :params params)
4187 rtn)
4188 (beginning-of-line 0)))
4189 rtn)))
4191 (defun orgtbl-send-replace-tbl (name txt)
4192 "Find and replace table NAME with TXT."
4193 (save-excursion
4194 (goto-char (point-min))
4195 (unless (re-search-forward
4197 (error "Don't know where to insert translated table"))
4198 (goto-char (match-beginning 0))
4199 (beginning-of-line 2)
4200 (save-excursion
4201 (let ((beg (point)))
4202 (unless (re-search-forward
4203 (concat "END RECEIVE ORGTBL +" name) nil t)
4204 (error "Cannot find end of insertion region"))
4205 (beginning-of-line 1)
4206 (delete-region beg (point))))
4209 ;;;###autoload
4210 (defun org-table-to-lisp (&optional txt)
4211 "Convert the table at point to a Lisp structure.
4212 The structure will be a list. Each item is either the symbol `hline'
4213 for a horizontal separator line, or a list of field values as strings.
4214 The table is taken from the parameter TXT, or from the buffer at point."
4215 (unless txt
4216 (unless (org-at-table-p)
4217 (error "No table at point")))
4218 (let* ((txt (or txt
4219 (buffer-substring-no-properties (org-table-begin)
4220 (org-table-end))))
4223 (mapcar
4224 (lambda (x)
4225 (if (string-match org-table-hline-regexp x)
4226 'hline
4228 lines)))
4230 (defun orgtbl-send-table (&optional maybe)
4231 "Send a transformed version of this table to the receiver position.
4232 With argument MAYBE, fail quietly if no transformation is defined for
4233 this table."
4234 (interactive)
4235 (catch 'exit
4236 (unless (org-at-table-p) (error "Not at a table"))
4237 ;; when non-interactive, we assume align has just happened.
4238 (when (org-called-interactively-p 'any) (org-table-align))
4239 (let ((dests (orgtbl-gather-send-defs))
4240 (txt (buffer-substring-no-properties (org-table-begin)
4241 (org-table-end)))
4242 (ntbl 0))
4243 (unless dests (if maybe (throw 'exit nil)
4244 (error "Don't know how to transform this table")))
4245 (dolist (dest dests)
4246 (let* ((name (plist-get dest :name))
4247 (transform (plist-get dest :transform))
4248 (params (plist-get dest :params))
4249 (skip (plist-get params :skip))
4250 (skipcols (plist-get params :skipcols))
4251 beg
4252 (lines (org-table-clean-before-export
4253 (nthcdr (or skip 0)
4255 (i0 (if org-table-clean-did-remove-column 2 1))
4256 (table (mapcar
4257 (lambda (x)
4258 (if (string-match org-table-hline-regexp x)
4259 'hline
4260 (org-remove-by-index
4262 skipcols i0)))
4263 lines))
4264 (fun (if (= i0 2) 'cdr 'identity))
4265 (org-table-last-alignment
4266 (org-remove-by-index (funcall fun org-table-last-alignment)
4267 skipcols i0))
4268 (org-table-last-column-widths
4269 (org-remove-by-index (funcall fun org-table-last-column-widths)
4270 skipcols i0))
4271 (txt (if (fboundp transform)
4272 (funcall transform table params)
4273 (error "No such transformation function %s" transform))))
4274 (orgtbl-send-replace-tbl name txt))
4275 (setq ntbl (1+ ntbl)))
4276 (message "Table converted and installed at %d receiver location%s"
4277 ntbl (if (> ntbl 1) "s" ""))
4278 (if (> ntbl 0)
4279 ntbl
4280 nil))))
4282 (defun org-remove-by-index (list indices &optional i0)
4283 "Remove the elements in LIST with indices in INDICES.
4284 First element has index 0, or I0 if given."
4285 (if (not indices)
4286 list
4287 (if (integerp indices) (setq indices (list indices)))
4288 (setq i0 (1- (or i0 0)))
4289 (delq :rm (mapcar (lambda (x)
4290 (setq i0 (1+ i0))
4291 (if (memq i0 indices) :rm x))
4292 list))))
4294 (defun orgtbl-toggle-comment ()
4295 "Comment or uncomment the orgtbl at point."
4296 (interactive)
4297 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4298 (re2 (concat "^" orgtbl-line-start-regexp))
4299 (commented (save-excursion (beginning-of-line 1)
4300 (cond ((looking-at re1) t)
4301 ((looking-at re2) nil)
4302 (t (error "Not at an org table")))))
4303 (re (if commented re1 re2))
4304 beg end)
4305 (save-excursion
4306 (beginning-of-line 1)
4307 (while (looking-at re) (beginning-of-line 0))
4308 (beginning-of-line 2)
4309 (setq beg (point))
4310 (while (looking-at re) (beginning-of-line 2))
4311 (setq end (point)))
4312 (comment-region beg end (if commented '(4) nil))))
4314 (defun orgtbl-insert-radio-table ()
4315 "Insert a radio table template appropriate for this major mode."
4316 (interactive)
4317 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4318 (txt (nth 1 e))
4319 name pos)
4320 (unless e (error "No radio table setup defined for %s" major-mode))
4321 (setq name (read-string "Table name: "))
4322 (while (string-match "%n" txt)
4323 (setq txt (replace-match name t t txt)))
4325 (setq pos (point))
4326 (insert txt)
4327 (goto-char pos)))
4329 ;; Dynamically bound input and output for table formatting.
4330 (defvar *orgtbl-table* nil
4331 "Carries the current table through formatting routines.")
4332 (defvar *orgtbl-rtn* nil
4333 "Formatting routines push the output lines here.")
4334 ;; Formatting parameters for the current table section.
4335 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4336 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4337 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4338 (defvar *orgtbl-fmt* nil "Format for each entry.")
4339 (defvar *orgtbl-efmt* nil "Format for numbers.")
4340 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4341 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4342 (defvar *orgtbl-lstart* nil "Text starting a row.")
4343 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4344 (defvar *orgtbl-lend* nil "Text ending a row.")
4345 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4347 (defsubst orgtbl-get-fmt (fmt i)
4348 "Retrieve the format from FMT corresponding to the Ith column."
4349 (if (and (not (functionp fmt)) (consp fmt))
4350 (plist-get fmt i)
4351 fmt))
4353 (defsubst orgtbl-apply-fmt (fmt &rest args)
4354 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4355 (cond ((functionp fmt) (apply fmt args))
4356 (fmt (apply 'format fmt args))
4357 (args (car args))
4358 (t args)))
4360 (defsubst orgtbl-eval-str (str)
4361 "If STR is a function, evaluate it with no arguments."
4362 (if (functionp str)
4363 (funcall str)
4364 str))
4366 (defun orgtbl-format-line (line)
4367 "Format LINE as a table row."
4368 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4369 (let* ((i 0)
4370 (line
4371 (mapcar
4372 (lambda (f)
4373 (setq i (1+ i))
4374 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4375 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4376 (orgtbl-apply-fmt efmt (match-string 1 f)
4377 (match-string 2 f))
4378 f)))
4379 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4380 *orgtbl-default-fmt*)
4381 f)))
4382 line)))
4383 (push (if *orgtbl-lfmt*
4384 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4385 (concat (orgtbl-eval-str *orgtbl-lstart*)
4386 (mapconcat 'identity line *orgtbl-sep*)
4387 (orgtbl-eval-str *orgtbl-lend*)))
4388 *orgtbl-rtn*))))
4390 (defun orgtbl-format-section (section-stopper)
4391 "Format lines until the first occurrence of SECTION-STOPPER."
4392 (let (prevline)
4393 (progn
4394 (while (not (eq (car *orgtbl-table*) section-stopper))
4395 (if prevline (orgtbl-format-line prevline))
4396 (setq prevline (pop *orgtbl-table*)))
4397 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4398 (*orgtbl-lend* *orgtbl-llend*)
4399 (*orgtbl-lfmt* *orgtbl-llfmt*))
4400 (orgtbl-format-line prevline))))))
4402 (defun orgtbl-to-generic (table params)
4403 "Convert the orgtbl-mode TABLE to some other format.
4404 This generic routine can be used for many standard cases.
4405 TABLE is a list, each entry either the symbol `hline' for a horizontal
4406 separator line, or a list of fields for that line.
4407 PARAMS is a property list of parameters that can influence the conversion.
4408 For the generic converter, some parameters are obligatory: you need to
4409 specify either :lfmt, or all of (:lstart :lend :sep).
4411 Valid parameters are
4413 :splice When set to t, return only table body lines, don't wrap
4414 them into :tstart and :tend. Default is nil. When :splice
4415 is non-nil, this also means that the exporter should not look
4416 for and interpret header and footer sections.
4418 :hline String to be inserted on horizontal separation lines.
4419 May be nil to ignore hlines.
4421 :sep Separator between two fields
4422 :remove-nil-lines Do not include lines that evaluate to nil.
4425 Each in the following group may be either a string or a function
4426 of no arguments returning a string:
4427 :tstart String to start the table. Ignored when :splice is t.
4428 :tend String to end the table. Ignored when :splice is t.
4429 :lstart String to start a new table line.
4430 :llstart String to start the last table line, defaults to :lstart.
4431 :lend String to end a table line
4432 :llend String to end the last table line, defaults to :lend.
4434 Each in the following group may be a string, a function of one
4435 argument (the field or line) returning a string, or a plist
4436 mapping columns to either of the above:
4437 :lfmt Format for entire line, with enough %s to capture all fields.
4438 If this is present, :lstart, :lend, and :sep are ignored.
4439 :llfmt Format for the entire last line, defaults to :lfmt.
4440 :fmt A format to be used to wrap the field, should contain
4441 %s for the original field value. For example, to wrap
4443 This may also be a property list with column numbers and
4446 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4447 Same as above, specific for the header lines in the table.
4448 All lines before the first hline are treated as header.
4449 If any of these is not present, the data line value is used.
4451 This may be either a string or a function of two arguments:
4452 :efmt Use this format to print numbers with exponentials.
4453 The format should have %s twice for inserting mantissa
4455 may also be a property list with column numbers and
4456 formats. :fmt will still be applied after :efmt.
4458 In addition to this, the parameters :skip and :skipcols are always handled
4459 directly by `orgtbl-send-table'. See manual."
4460 (interactive)
4462 (let* ((splicep (plist-get params :splice))
4463 (hline (plist-get params :hline))
4464 (remove-nil-linesp (plist-get params :remove-nil-lines))
4465 (remove-newlines (plist-get params :remove-newlines))
4466 (*orgtbl-hline* hline)
4467 (*orgtbl-table* table)
4468 (*orgtbl-sep* (plist-get params :sep))
4469 (*orgtbl-efmt* (plist-get params :efmt))
4470 (*orgtbl-lstart* (plist-get params :lstart))
4471 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4472 (*orgtbl-lend* (plist-get params :lend))
4473 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4474 (*orgtbl-lfmt* (plist-get params :lfmt))
4475 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4476 (*orgtbl-fmt* (plist-get params :fmt))
4477 *orgtbl-rtn*)
4479 ;; Put header
4480 (unless splicep
4481 (when (plist-member params :tstart)
4482 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4483 (if tstart (push tstart *orgtbl-rtn*)))))
4485 ;; Do we have a heading section? If so, format it and handle the
4486 ;; trailing hline.
4487 (if (and (not splicep)
4488 (or (consp (car *orgtbl-table*))
4489 (consp (nth 1 *orgtbl-table*)))
4490 (memq 'hline (cdr *orgtbl-table*)))
4491 (progn
4492 (when (eq 'hline (car *orgtbl-table*))
4493 ;; there is a hline before the first data line
4494 (and hline (push hline *orgtbl-rtn*))
4495 (pop *orgtbl-table*))
4496 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4497 *orgtbl-lstart*))
4498 (*orgtbl-llstart* (or (plist-get params :hllstart)
4499 *orgtbl-llstart*))
4500 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4501 (*orgtbl-llend* (or (plist-get params :hllend)
4502 (plist-get params :hlend) *orgtbl-llend*))
4503 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4504 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4505 (plist-get params :hlfmt) *orgtbl-llfmt*))
4506 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4507 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4508 (orgtbl-format-section 'hline))
4509 (if hline (push hline *orgtbl-rtn*))
4510 (pop *orgtbl-table*)))
4512 ;; Now format the main section.
4513 (orgtbl-format-section nil)
4515 (unless splicep
4516 (when (plist-member params :tend)
4517 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4518 (if tend (push tend *orgtbl-rtn*)))))
4520 (mapconcat (if remove-newlines
4521 (lambda (tend)
4523 'identity)
4524 (nreverse (if remove-nil-linesp
4525 (remq nil *orgtbl-rtn*)
4528 (defun orgtbl-to-tsv (table params)
4529 "Convert the orgtbl-mode table to TAB separated material."
4531 (defun orgtbl-to-csv (table params)
4532 "Convert the orgtbl-mode table to CSV material.
4533 This does take care of the proper quoting of fields with comma or quotes."
4534 (orgtbl-to-generic table (org-combine-plists
4535 '(:sep "," :fmt org-quote-csv-field)
4536 params)))
4538 (defun orgtbl-to-latex (table params)
4539 "Convert the orgtbl-mode TABLE to LaTeX.
4540 TABLE is a list, each entry either the symbol `hline' for a horizontal
4541 separator line, or a list of fields for that line.
4542 PARAMS is a property list of parameters that can influence the conversion.
4543 Supports all parameters from `orgtbl-to-generic'. Most important for
4544 LaTeX are:
4546 :splice When set to t, return only table body lines, don't wrap
4547 them into a tabular environment. Default is nil.
4549 :fmt A format to be used to wrap the field, should contain %s for the
4550 original field value. For example, to wrap everything in dollars,
4553 The format may also be a function that formats its one argument.
4555 :efmt Format for transforming numbers with exponentials. The format
4556 should have %s twice for inserting mantissa and exponent, for
4558 This may also be a property list with column numbers and formats.
4559 The format may also be a function that formats its two arguments.
4561 :llend If you find too much space below the last line of a table,
4564 The general parameters :skip and :skipcols have already been applied when
4565 this function is called."
4566 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4567 org-table-last-alignment ""))
4568 (params2
4569 (list
4574 (orgtbl-to-generic table (org-combine-plists params2 params))))
4576 (defun orgtbl-to-html (table params)
4577 "Convert the orgtbl-mode TABLE to HTML.
4578 TABLE is a list, each entry either the symbol `hline' for a horizontal
4579 separator line, or a list of fields for that line.
4580 PARAMS is a property list of parameters that can influence the conversion.
4581 Currently this function recognizes the following parameters:
4583 :splice When set to t, return only table body lines, don't wrap
4584 them into a <table> environment. Default is nil.
4586 The general parameters :skip and :skipcols have already been applied when
4587 this function is called. The function does *not* use `orgtbl-to-generic',
4588 so you cannot specify parameters for it."
4589 (let* ((splicep (plist-get params :splice))
4590 (html-table-tag org-export-html-table-tag)
4591 html)
4592 ;; Just call the formatter we already have
4593 ;; We need to make text lines for it, so put the fields back together.
4594 (setq html (org-format-org-table-html
4595 (mapcar
4596 (lambda (x)
4597 (if (eq x 'hline)
4598 "|----+----|"
4599 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4600 table)
4601 splicep))
4603 (setq html (replace-match "" t t html)))
4604 html))
4606 (defun orgtbl-to-texinfo (table params)
4607 "Convert the orgtbl-mode TABLE to TeXInfo.
4608 TABLE is a list, each entry either the symbol `hline' for a horizontal
4609 separator line, or a list of fields for that line.
4610 PARAMS is a property list of parameters that can influence the conversion.
4611 Supports all parameters from `orgtbl-to-generic'. Most important for
4612 TeXInfo are:
4614 :splice nil/t When set to t, return only table body lines, don't wrap
4615 them into a multitable environment. Default is nil.
4617 :fmt fmt A format to be used to wrap the field, should contain
4618 %s for the original field value. For example, to wrap
4620 This may also be a property list with column numbers and
4622 Each format also may be a function that formats its one
4623 argument.
4626 are computed automatically from the width of the columns
4627 under org-mode.
4629 The general parameters :skip and :skipcols have already been applied when
4630 this function is called."
4631 (let* ((total (float (apply '+ org-table-last-column-widths)))
4632 (colfrac (or (plist-get params :cf)
4633 (mapconcat
4634 (lambda (x) (format "%.3f" (/ (float x) total)))
4635 org-table-last-column-widths " ")))
4636 (params2
4637 (list
4638 :tstart (concat "@multitable @columnfractions " colfrac)
4639 :tend "@end multitable"
4640 :lstart "@item " :lend "" :sep " @tab "
4641 :hlstart "@headitem ")))
4642 (orgtbl-to-generic table (org-combine-plists params2 params))))
4644 (defun orgtbl-to-orgtbl (table params)
4645 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4646 Useful when slicing one table into many. The :hline, :sep,
4647 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4648 and :tend suppress strings without splicing; they can be set to
4649 provide ORGTBL directives for the generated table."
4650 (let* ((params2
4651 (list
4652 :remove-newlines t
4653 :tstart nil :tend nil
4654 :hline "|---"
4655 :sep " | "
4656 :lstart "| "
4657 :lend " |"))
4658 (params (org-combine-plists params2 params)))
4659 (orgtbl-to-generic table params)))
4661 (defun org-table-get-remote-range (name-or-id form)
4662 "Get a field value or a list of values in a range from table at ID.
4664 NAME-OR-ID may be the name of a table in the current file as set by
4666 will then be used. Alternatively, it may be an ID referring to
4667 any entry, also in a different file. In this case, the first table
4668 in that entry will be referenced.
4672 The return value is either a single string for a single field, or a
4673 list of the fields in the rectangle ."
4674 (save-match-data
4675 (let ((id-loc nil)
4676 ;; Protect a bunch of variables from being overwritten
4677 ;; by the context of the remote table
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
4715 (org-table-formula-handle-first/last-rc form)))
4716 (if (and (string-match org-table-range-regexp form)
4717 (> (length (match-string 0 form)) 1))
4718 (save-match-data
4719 (org-table-get-range (match-string 0 form) tbeg 1))
4720 form)))))))))
4722 (provide 'org-table)
4724 ;;; org-table.el ends here