| blob | f48322358bf580edec38aa0d6aff829fd7106a39 |
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.6
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:
53 "Hook for functions attaching to `C-c C-c', if the table is sent.
54 This can be used to add additional functionality after the table is sent
55 to the receiver position, othewise, if table is not sent, the functions
59 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
60 In the optimized version, the table editor takes over all simple keys that
61 normally just insert a character. In tables, the characters are inserted
62 in a way to minimize disturbing the table structure (i.e. in overwrite mode
63 for empty fields). Outside tables, the correct binding of the keys is
64 restored.
66 The default for this option is t if the optimized version is also used in
67 Org-mode. See the variable `org-enable-table-editor' for details. Changing
68 this variable requires a restart of Emacs to become effective."
74 % END RECEIVE ORGTBL %n
76 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
77 | | |
80 @c END RECEIVE ORGTBL %n
81 @ignore
82 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
83 | | |
86 <!-- END RECEIVE ORGTBL %n -->
87 <!--
88 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
89 | | |
91 "Templates for radio tables in different major modes.
92 All occurrences of %n in a template will be replaced with the name of the
93 table, obtained by prompting the user."
100 "Settings for tables in Org-mode."
105 "The default size for newly created tables, Columns x Rows."
111 "Regular expression for recognizing numbers in table columns.
112 If a table column contains mostly numbers, it will be aligned to the
113 right. If not, it will be aligned to the left.
115 The default value of this option is a regular expression which allows
116 anything which looks remotely like a number as used in scientific
117 context. For example, all of the following will be considered a
118 number:
119 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
121 Other options offered by the customize interface are more restrictive."
139 "Fraction of numbers in a column required to make the column align right.
140 In a column all non-white fields are considered. If at least this
141 fraction of fields is matched by `org-table-number-fraction',
142 alignment to the right border applies."
147 "Behavior of tables during editing in Org-mode."
152 "Non-nil means automatically re-align table when pressing TAB or RETURN.
154 removal/insertion."
159 "Non-nil means automatically blank table field when starting to type into it.
160 This only happens when typing immediately after a field motion
161 command (TAB, S-TAB or RET).
162 Only relevant when `org-enable-table-editor' is equal to `optimized'."
167 "Non-nil means automatically exit the follow mode.
168 When nil, the follow mode will stay on and be active in any table
169 the cursor enters. Since the table follow filed mode messes with the
170 window configuration, it is not recommended to set this variable to nil,
171 except maybe locally in a special file that has mostly tables with long
172 fields."
177 "Whether the user should confirm when Org fixes formulas."
184 'safe-local-variable
188 "Non-nil means tab in the last column of a table with jump over a hline.
189 If a horizontal separator line is following the current line,
190 `org-table-next-field' can either create a new row before that line, or jump
191 over the line. When this option is nil, a new line will be created before
192 this line."
197 "Options concerning tables in Org-mode."
202 "Should org-mode work with table references like B3 instead of @3$2?
203 Possible values are:
204 nil never use them
205 from accept as input, do not present for editing
206 t accept as input and present for editing"
221 calc-angle-mode deg
222 calc-prefer-frac nil
223 calc-symbolic-mode nil
225 calc-display-working-message t
226 )
227 "List with Calc mode settings for use in `calc-eval' for table formulas.
228 The list must contain alternating symbols (Calc modes variables and values).
229 Don't remove any of the default settings, just change the values. Org-mode
230 relies on the variables to be present in the list."
235 "Non-nil means TAB and RET evaluate a formula in current table field.
236 If the current field starts with an equal sign, it is assumed to be a formula
237 which should be evaluated as described in the manual and in the documentation
238 string of the command `org-table-eval-formula'. This feature requires the
239 Emacs calc package.
240 When this variable is nil, formula calculation is only available through
246 "Non-nil means interpret constants in formulas in tables.
247 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
248 by the value given in `org-table-formula-constants', or by a value obtained
249 from the `constants.el' package."
254 "Alist with constant names and values, for use in table formulas.
255 The car of each element is a name of a constant, without the `$' before it.
256 The cdr is the value as a string. For example, if you'd like to use the
257 speed of light in a formula, you would configure
261 and then use it in an equation like `$1*$c'.
263 Constants can also be defined on a per-file basis using a line like
265 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
272 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
273 Automatically means when TAB or RET or C-c C-c are pressed in the line."
278 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
283 "Non-nil means relative formula references may cross hlines.
284 Here are the allowed values:
286 nil Relative references may not cross hlines. They will reference the
287 field next to the hline instead. Coming from below, the reference
288 will be to the field below the hline. Coming from above, it will be
289 to the field above.
290 t Relative references may cross hlines.
291 error An attempt to cross a hline will throw an error.
293 It is probably good to never set this variable to nil, for the sake of
294 portability of tables."
302 "Options concerning table import and export in Org-mode."
307 "Default export parameters for `org-table-export'.
308 These can be overridden for a specific table by setting the
309 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
310 radio tables for the different export transformations and
311 available parameters."
349 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
350 ;; 1 2 3 4 5
361 "Is this a table line colgroup information?"
365 line)
367 nil
374 "Is this a table line with only alignment/width cookies?"
387 s))))
396 "Use the table.el package to insert a new table.
397 If there is already a table at point, convert between Org-mode tables
398 and table.el tables."
412 "Convert region to table, or create an empty table.
413 If there is an active region, convert it to a table, using the function
414 `org-table-convert-region'. See the documentation of that function
415 to learn how the prefix argument is interpreted to determine the field
416 separator.
417 If there is no such region, create an empty table with `org-table-create'."
424 "Query for a size and insert a table skeleton.
444 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
448 ;; Insert a hline after the first row.
456 "Convert region to a table.
457 The region goes from BEG0 to END0, but these borders will be moved
458 slightly, to make sure a beginning of line in the first line is included.
460 SEPARATOR specifies the field separator in the lines. It can have the
461 following values:
463 '(4) Use the comma as a field separator
464 '(16) Use a TAB as field separator
465 integer When a number, use that many spaces as field separator
466 nil When nil, the command tries to be smart and figure out the
467 separator in the following way:
468 - when each line contains a TAB, assume TAB-separated material
469 - when each line contains a comma, assume CSV material
470 - else, assume one or more SPACE characters as separator."
474 re)
481 ;; Get the right field separator
492 ;; parse the csv stuff
516 "Import FILE as a table.
517 The file is assumed to be tab-separated. Such files can be produced by most
518 spreadsheet and database applications. If no tabs (at least one per line)
519 are found, lines will be split on whitespace into fields."
531 "Export table to a file, with configurable format.
532 Such a file can be imported into a spreadsheet program like Excel.
533 FILE can be the output file name. If not given, it will be taken from
534 a TABLE_EXPORT_FILE property in the current entry or higher up in the
535 hierarchy, or the user will be prompted for a file name.
536 FORMAT can be an export format, of the same kind as it used when
537 `orgtbl-mode' sends a table in a different format. The default format can
538 be found in the variable `org-table-export-default-format', but the function
539 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
540 property, locally or anywhere up in the hierarchy."
552 buf deffmt-readable)
571 "Format: "
576 deffmt-readable)))
589 'hline
592 skipcols i0)))
593 lines))
597 skipcols i0))
600 skipcols i0)))
617 "Marker at the beginning of the table last aligned.
620 "Marker at the end of the table last aligned.
623 "List of flags for flushright alignment, from the last re-alignment.
626 "List of max width of fields in each column.
629 "Non-nil means debug table formulas.
642 "Align the table at point by aligning all vertical bars."
645 ;; Limits of table
648 ;; Current cursor position
654 column
656 rfmt hfmt
664 emptystrings links dates emph raise narrow
665 falign falign1 fmax f1 len c e space)
668 ;; Check if we have links or dates
680 ;; Make sure the link properties are right
682 ;; Make sure the date properties are right
687 ;; Check if we are narrowing any columns
690 org-format-transports-properties-p
695 ;; Get the rows
698 ;; Store the indentation of the first line
701 ;; Mark the hlines by setting the corresponding element to nil
702 ;; At the same time, we remove trailing space.
705 nil
708 l)))
709 lines))
710 ;; Get the data fields by splitting the lines.
715 ;; How many fields in the longest line?
722 ;; A list of empty strings to fill any short rows on output
724 ;; Check for special formatting.
728 ;; Check if there is an explicit width specified
738 ;; Find fields that are wider than fmax, and shorten them
744 'help-echo
745 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
753 xx)))))
754 ;; Get the maximum width for each column
756 lengths)
757 ;; Get the fraction of numbers, to decide about alignment of the column
763 nil
770 ;; Store the alignment of this table, for later editing of single fields
772 org-table-last-column-widths lengths)
774 ;; With invisible characters, `format' does not get the field width right
775 ;; So we need to make these fields wide by hand.
793 ;; Compute the formats needed for output of the table
806 hfmt))
809 ;; This hack is for org-indent, to force redisplay of the
810 ;; line prefix of the first line. Apparently the redisplay
811 ;; is tied to the newline, which is, I think, a bug.
812 ;; To force this redisplay, we remove and re-insert the
813 ;; newline, so that the redisplay engine thinks it belongs
814 ;; to the changed text.
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))
1811 p)
1827 intangible t))
1835 "Finish editing a table data field.
1836 Remove all newline characters, insert the result into the table, realign
1837 the table and kill the editing buffer."
1841 text)
1858 "Minor mode to make the table field editor window follow the cursor.
1859 When this mode is active, the field editor window will always show the
1860 current field. The mode exits automatically when the cursor leaves the
1861 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1862 nil " TblFollow" nil
1878 ;; We have left the table, exit the follow mode
1889 "Sum numbers in region of current table column.
1890 The result will be displayed in the echo area, and will be available
1893 If there is an active region, it is interpreted as a rectangle and all
1894 numbers in that rectangle will be summed. If there is no active
1895 region and point is located in a table column, sum all numbers in that
1896 column.
1898 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1899 numbers are assumed to be times as well (in decimal hours) and the
1900 numbers are added as such.
1902 If NLAST is a number, only the NLAST fields will actually be summed."
1929 items1)))
1936 s diff)
1944 sres))))
1967 "Return the formula active for the current field.
1968 Assumes that specials are in place.
1969 If KEY is given, return the key to this formula.
1973 org-table-named-field-locations)))
1987 "Read a formula from the minibuffer, offer stored formula as default.
1988 When NAMED is non-nil, look for a named equation."
1992 org-table-named-field-locations)))
1999 name
2000 ref)
2010 stored)
2012 equation)
2019 scol))
2021 'org-table-formula-history
2022 )))))
2023 mustsave)
2025 ;; remove formula
2032 ;; We set the column equation, delete the named one.
2034 mustsave t))
2040 eq))
2043 "Store the list of formulas below the current table."
2049 ;; don't overwrite TBLFM, we might use text properties to store stuff
2065 ;; Fake a high number to make sure this is sorted at the end.
2072 a)
2082 "Compare two formulas for sorting."
2088 "Return an alist with the stored formulas directly after current table."
2097 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2116 "Modify the equations after the table structure has been edited.
2118 For all numbers larger than LIMIT, shift them by DELTA."
2129 s n a)
2142 t t)))))))))
2145 "Get the column names and local parameters for this table."
2148 names name fields fields1 field cnt
2149 c v l line col types dlines hlines last-dline)
2151 org-table-local-parameters nil
2152 org-table-named-field-locations nil
2153 org-table-current-begin-line nil
2154 org-table-current-begin-pos nil
2155 org-table-current-line-types nil
2174 org-table-local-parameters))))
2190 ;; Analyse the line types
2194 l org-table-current-begin-line)
2211 al al2)
2223 If yes, store the formula and apply it."
2224 ;; We already know we are in a table. Get field will only return a formula
2225 ;; when appropriate. It might return a separator line, but no problem.
2228 named eq)
2239 "List of commands triggering the recalculation of a line.
2252 "Rotate the recalculation mark in the first column.
2253 If in any row, the first field is not consistent with a mark,
2254 insert a new column for the markers.
2255 When there is an active region, change all the lines in the region,
2256 after prompting for the marking character.
2257 After each change, a message will be displayed indicating the meaning
2258 of the new mark."
2273 epos new)
2280 newchar))
2313 "Recompute the current line if marked for it, and if we haven't just done it."
2333 modes)
2336 suppress-align suppress-const
2337 suppress-store suppress-analysis)
2338 "Replace the table field value at the cursor by the result of a calculation.
2340 This function makes use of Dave Gillespie's Calc package, in my view the
2341 most exciting program ever written for GNU Emacs. So you need to have Calc
2342 installed in order to use this function.
2344 In a table, this command replaces the value in the current field with the
2346 formula, by storing it in a special line below the table. When called
2347 with a `C-u' prefix, the current field must be a named field, and the
2348 formula is installed as valid in only this specific field.
2350 When called with two `C-u' prefixes, insert the active equation
2351 for the field back into the current field, so that it can be
2353 to check the referenced fields.
2355 When called, the command first prompts for a formula, which is read in
2356 the minibuffer. Previously entered formulas are available through the
2357 history list, and the last used formula is offered as a default.
2358 These stored formulas are adapted correctly when moving, inserting, or
2359 deleting columns with the corresponding commands.
2361 The formula can be any algebraic expression understood by the Calc package.
2362 For details, see the Org-mode manual.
2364 This function can also be called from Lisp programs and offers
2365 additional arguments: EQUATION can be the formula to apply. If this
2366 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2367 used to speed-up recursive calls by by-passing unnecessary aligns.
2368 SUPPRESS-CONST suppresses the interpretation of constants in the
2369 formula, assuming that this has been done already outside the function.
2370 SUPPRESS-STORE means the formula should not be stored, either because
2371 it is already stored, or because it is a modified equation that should
2372 not overwrite the stored one."
2388 equation
2394 n form form0 formrpl bw fmt x ev orig c lispp literal duration)
2395 ;; Parse the format string. Since we have a lot of modes, this is
2396 ;; a lot of work. However, I think calc still uses most of the time.
2408 'calc-float-format
2411 n))))
2445 fields)))
2451 ;; Insert row and column number of formula result field
2462 t t form)))
2464 ;; Check for old vertical references
2466 ;; Insert remote references
2474 keep-empty numbers lispp))
2475 t t form)))
2476 ;; Insert complex ranges
2483 keep-empty numbers lispp)))
2488 ;; Insert simple ranges
2497 keep-empty numbers lispp))
2498 t t form)))
2500 ;; Insert the references to fields in same row
2510 t t form)))
2529 Orig: %s
2530 $xyz-> %s
2531 @r$c-> %s
2562 prop value)))
2565 "Get a calc vector from a column, according to descriptor DESC.
2566 Optional arguments TBEG and COL can give the beginning of the table and
2567 the current column, to avoid unnecessary parsing.
2569 HIGHLIGHT means just highlight the range.
2571 When CORNERS-ONLY is set, only return the corners of the range as
2572 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2573 in the buffer and column1 and column2 are table column numbers."
2580 beg end c1 c2 r1 r2 rangep tmp)
2597 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2604 ;; just one field
2611 ;; A range, return a vector
2612 ;; First sort the numbers to get a regular ractangle
2616 ;; Only return the corners of the range
2618 ;; Copy the range values into a list
2632 ;; return string representation of calc vector
2637 "Analyze descriptor DESC and retrieve the corresponding line number.
2638 The cursor is currently in line CLINE, the table begins in line BLINE,
2639 and TABLE is a vector with line types."
2647 ;; 1 2 3 4 5 6
2667 nil hn cline desc)))
2670 rel on cline desc)))
2674 "FIXME: Needs more documentation."
2687 nil))
2688 t)))
2692 desc cline)
2693 i)))
2698 s))
2701 "Convert list ELEMENTS to something appropriate to insert into formula.
2702 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2703 NUMBERS indicates that everything should be converted to numbers.
2704 LISPP means to return something appropriate for a Lisp list."
2708 elements
2717 elements))))
2723 x
2729 elements
2733 "Recalculate the current table line by applying all stored formulas.
2734 With prefix arg ALL, do this for all lines in the table.
2735 With the prefix argument ALL is `(16)' \
2737 it is the symbol `iterate', recompute the table until it no longer changes.
2738 If NOALIGN is not nil, do not re-align the table after the computations
2739 are done. This is typically used internally to save time, if it is
2740 known that the table will be realigned a little later anyway."
2755 seen-fields lhs1
2757 ;; Insert constants in all formulas
2773 eqlist))
2774 ;; Split the equation list
2780 ;; Expand ranges in lhs of formulas
2783 ;; Get the correct line range to process
2789 ;; This is a table with marked lines, compute selected lines
2791 ;; Move forward to the first non-header line
2802 ;; First find the named fields, and mark them untouchable.
2803 ;; Also check if several field/range formulas try to set the same field.
2822 name)))
2832 ;; Now evaluate the column formulas, but skip fields covered by
2833 ;; field formulas
2837 ;; Unprotected line, recalculate
2849 ;; Now evaluate the field formulas
2863 ;; back to initial position
2871 "Recalculate the table until it does not change anymore.
2872 The maximun number of iterations is 10, but you can chose a different value
2873 with the prefix ARG."
2878 thistbl)
2893 "Recalculate all tables in the current buffer."
2901 "Iterate all tables in the buffer, to converge inter-table dependencies."
2906 c1
2923 "Expand list of formulas.
2924 If some of the RHS in the formulas are ranges or a row reference, expand
2925 them to individual field equations for each field."
2931 ;; This just refers to one fixed field
2934 ;; This just refers to one fixed named field
2956 "Replace @<, @>, $<, $> with first/last row/column of the table.
2957 So @< and $< will always be replaced with @1 and $1, respectively.
2958 The advantage of these special markers are that structure editing of
2959 the table will not change them, while @1 and $1 will be modified
2960 when a line/row is swaped out of that privileged position. So for
2961 formulas that use a range of rows or columns, it may often be better
2963 borders of the table using the @< @> $< $> makers."
2968 org-table-current-ncol)
2972 len
2978 s)
2981 "Replace $const with values in string F."
2983 ;; First, check for column names
2988 ;; Parameters and constants
2990 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3000 f))
3003 "Find the value for a parameter or constant in a formula.
3004 Parameters get priority."
3035 map))
3042 "--"
3045 "--"
3046 "Shift Reference at Point"
3051 "-"
3052 "Change Test Row for Column Formulas"
3055 "--"
3060 org-table-overlay-coordinates)]
3061 "--"
3068 "Edit the formulas of the current table in a separate buffer."
3084 entry s type title)
3087 ;; Keep global-font-lock-mode from turning on font-lock-mode
3128 "Convert a formula from internal to user representation."
3131 s))
3134 "Convert a formula from user to internal representation."
3137 s))
3140 "Convert spreadsheet references from A7 to @7$28.
3141 Works for single references, but also for entire formulas and even the
3142 full TBLFM line."
3144 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3147 ;; format match, just advance
3152 ;; 3.e5 or something like this.
3155 ;; (member (match-string 1 s)
3156 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3157 )
3158 ;; function name, just advance
3168 t t s)))))
3169 s))
3172 "Convert spreadsheet references from to @7$28 to AB7.
3173 Works for single references, but also for entire formulas and even the
3174 full TBLFM line."
3181 t t s)))
3186 t nil s)))
3187 s)
3190 "Convert a base 26 number represented by letters into an integer.
3191 For example: AB -> 28."
3197 n))
3200 "Convert an integer into a base 26 number represented by letters.
3201 For example: 28 -> AB."
3206 s))
3209 "Convert a time string into numerical duration in seconds.
3210 S must be a string matching either -?HH:MM:SS or -?HH:MM."
3232 "Convert a number of seconds to a time string."
3236 "Convert all references in this buffer, using FUNCTION."
3246 "Convert all references in the buffer from B3 to @3$2 and back."
3256 "Shift the reference at point one row/hline up."
3260 "Shift the reference at point one row/hline down."
3264 "Shift the reference at point one field to the left."
3268 "Shift the reference at point one field to the right."
3279 ;; A B3-like reference
3285 ;; An internal reference
3291 "Re-match the group N, and replace it with the shifted reference."
3296 t t)))
3299 "Shift a reference part REF.
3300 If DECR is set, decrease the references row/column, else increase.
3301 If HLINE is set, this may be a hline reference, it certainly is not
3302 a translation reference."
3331 "Toggle the display of coordinates in the referenced table."
3340 "Parse the buffer for formula definitions and install them.
3341 With prefix ARG, apply the new formulas to the table."
3351 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3352 nil t)
3376 "Abort editing formulas, without installing the changes."
3387 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3428 "Show the location/value of the $ expression at point."
3437 var name e what match dest)
3442 "$1.."
3525 ;; column number
3553 org-table-fedit-scroll-down))))
3564 "Make sure the cursor is in a dataline in a table."
3573 p1 p2)))
3578 "Move cursor one line up in the window showing the table."
3583 "Move cursor one line down in the window showing the table."
3588 "Move the cursor in the window showing the table.
3589 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3614 "Add a new overlay."
3620 "Highlight rectangular region in a table."
3624 l1 c1 l2 c2 tmp)
3648 "Remove the rectangle overlays."
3659 "Add overlays to the table at point, to show row/column coordinates."
3688 "Toggle the display of Row/Column numbers in tables."
3700 "Toggle the formula debugger in tables."
3706 ;;; The orgtbl minor mode
3708 ;; Define a minor mode which can be used in other modes in order to
3709 ;; integrate the org-mode table editor.
3711 ;; This is really a hack, because the org-mode table editor uses several
3712 ;; keys which normally belong to the major mode, for example the TAB and
3713 ;; RET keys. Here is how it works: The minor mode defines all the keys
3714 ;; necessary to operate the table editor, but wraps the commands into a
3715 ;; function which tests if the cursor is currently inside a table. If that
3716 ;; is the case, the table editor command is executed. However, when any of
3717 ;; those keys is used outside a table, the function uses `key-binding' to
3718 ;; look up if the key has an associated command in another currently active
3719 ;; keymap (minor modes, major mode, global), and executes that command.
3720 ;; There might be problems if any of the keys used by the table editor is
3721 ;; otherwise used as a prefix key.
3723 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3724 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3725 ;; addresses this by checking explicitly for both bindings.
3727 ;; The optimized version (see variable `orgtbl-optimized') takes over
3728 ;; all keys which are bound to `self-insert-command' in the *global map*.
3729 ;; Some modes bind other commands to simple characters, for example
3730 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3731 ;; active, this binding is ignored inside tables and replaced with a
3732 ;; modified self-insert.
3738 ;;;###autoload
3740 "Unconditionally turn on `orgtbl-mode'."
3755 ;; Install it as a minor mode.
3759 ;;;###autoload
3761 "The `org-mode' table editor as a minor mode for use in other modes."
3766 ;; Exit without error, in case some hook functions calls this
3767 ;; by accident in org-mode.
3771 ;; Make sure we are first in minor-mode-map-alist
3773 ;; FIXME: maybe it should use emulation-mode-map-alists?
3780 auto-fill-inhibit-regexp)
3784 auto-fill-inhibit-regexp)
3785 orgtbl-line-start-regexp))
3803 "Remove all properties related to narrow-column invisibility."
3816 "Create a function for binding in the table minor mode.
3817 FUN is the command to call inside a table. N is used to create a unique
3818 command name. KEYS are keys that should be checked in for a command
3819 to execute outside of tables."
3825 "Outside of tables, run the binding of `"
3837 keys)
3841 "Error when there is no default binding for a table key."
3846 "Setup orgtbl keymaps."
3876 elt key fun cmd)
3884 ;; Special treatment needed for TAB and RET
3904 [(tab)] "\C-i")))
3906 (org-defkey orgtbl-mode-map [backtab]
3908 [backtab] [S-iso-lefttab] [(shift tab)]
3909 [(tab)] "\C-i"))
3911 (org-defkey orgtbl-mode-map "\M-\C-m"
3912 (orgtbl-make-binding 'org-table-wrap-region 105
3913 "\M-\C-m" [(meta return)]))
3914 (org-defkey orgtbl-mode-map [(meta return)]
3915 (orgtbl-make-binding 'org-table-wrap-region 106
3916 [(meta return)] "\M-\C-m"))
3918 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3919 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3921 (when orgtbl-optimized
3922 ;; If the user wants maximum table support, we need to hijack
3923 ;; some standard editing functions
3924 (org-remap orgtbl-mode-map
3925 'self-insert-command 'orgtbl-self-insert-command
3926 'delete-char 'org-delete-char
3927 'delete-backward-char 'org-delete-backward-char)
3928 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3929 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3930 '("OrgTbl"
3931 ["Create or convert" org-table-create-or-convert-from-region
3932 :active (not (org-at-table-p)) :keys "C-c |" ]
3933 "--"
3934 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3935 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3936 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3937 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3938 "--"
3939 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3940 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3941 ["Copy Field from Above"
3942 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3943 "--"
3944 ("Column"
3945 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3946 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3947 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3948 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3949 ("Row"
3950 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3951 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3952 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3953 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3954 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3955 "--"
3956 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3957 ("Rectangle"
3958 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3959 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3960 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3961 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3962 "--"
3963 ("Radio tables"
3964 ["Insert table template" orgtbl-insert-radio-table
3965 (assq major-mode orgtbl-radio-table-templates)]
3966 ["Comment/uncomment table" orgtbl-toggle-comment t])
3967 "--"
3968 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3969 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3970 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3971 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3972 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3973 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3974 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3975 ["Sum Column/Rectangle" org-table-sum
3976 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3977 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3978 ["Debug Formulas"
3979 org-table-toggle-formula-debugger :active (org-at-table-p)
3980 :keys "C-c {"
3981 :style toggle :selected org-table-formula-debug]
3982 ["Show Col/Row Numbers"
3983 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3984 :keys "C-c }"
3985 :style toggle :selected org-table-overlay-coordinates]
3986 ))
3987 t))
3989 (defun orgtbl-ctrl-c-ctrl-c (arg)
3990 "If the cursor is inside a table, realign the table.
3991 If it is a table to be sent away to a receiver, do it.
3992 With prefix arg, also recompute table."
3993 (interactive "P")
3994 (let ((pos (point)) action consts-str consts cst const-str)
3995 (save-excursion
3996 (beginning-of-line 1)
3997 (setq action (cond
4001 (cond
4002 ((integerp action)
4003 (goto-char action)
4004 (org-table-maybe-eval-formula)
4005 (if arg
4006 (call-interactively 'org-table-recalculate)
4007 (org-table-maybe-recalculate-line))
4008 (call-interactively 'org-table-align)
4009 (when (orgtbl-send-table 'maybe)
4010 (run-hooks 'orgtbl-after-send-table-hook)))
4011 ((eq action 'recalc)
4012 (save-excursion
4013 (goto-char (point-min))
4015 (setq const-str (substring-no-properties (match-string 1)))
4017 (when consts
4018 (let (e)
4019 (while (setq e (pop consts))
4021 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4022 (setq org-table-formula-constants-local cst)))))
4023 (save-excursion
4024 (beginning-of-line 1)
4026 (if (org-at-table-p)
4027 (org-call-with-arg 'org-table-recalculate t))))
4028 (t (let (orgtbl-mode)
4029 (call-interactively (key-binding "\C-c\C-c")))))))
4031 (defun orgtbl-create-or-convert-from-region (arg)
4032 "Create table or convert region to table, if no conflicting binding.
4033 This installs the table binding `C-c |', but only if there is no
4034 conflicting binding to this key outside orgtbl-mode."
4035 (interactive "P")
4036 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4037 (if cmd
4038 (call-interactively cmd)
4039 (call-interactively 'org-table-create-or-convert-from-region))))
4041 (defun orgtbl-tab (arg)
4042 "Justification and field motion for `orgtbl-mode'."
4043 (interactive "P")
4044 (if arg (org-table-edit-field t)
4045 (org-table-justify-field-maybe)
4046 (org-table-next-field)))
4048 (defun orgtbl-ret ()
4049 "Justification and field motion for `orgtbl-mode'."
4050 (interactive)
4051 (if (bobp)
4052 (newline)
4053 (org-table-justify-field-maybe)
4054 (org-table-next-row)))
4056 (defun orgtbl-self-insert-command (N)
4057 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4058 If the cursor is in a table looking at whitespace, the whitespace is
4059 overwritten, and the table is not marked as requiring realignment."
4060 (interactive "p")
4061 (if (and (org-at-table-p)
4062 (or
4063 (and org-table-auto-blank-field
4064 (member last-command
4065 '(orgtbl-hijacker-command-100
4066 orgtbl-hijacker-command-101
4067 orgtbl-hijacker-command-102
4068 orgtbl-hijacker-command-103
4069 orgtbl-hijacker-command-104
4070 orgtbl-hijacker-command-105
4071 yas/expand))
4072 (org-table-blank-field))
4073 t)
4074 (eq N 1)
4076 (let (org-table-may-need-update)
4077 (goto-char (1- (match-end 0)))
4078 (delete-char -1)
4079 (goto-char (match-beginning 0))
4080 (self-insert-command N))
4081 (setq org-table-may-need-update t)
4082 (let* (orgtbl-mode
4083 a
4084 (cmd (or (key-binding
4085 (or (and (listp function-key-map)
4086 (setq a (assoc last-input-event function-key-map))
4087 (cdr a))
4088 (vector last-input-event)))
4089 'self-insert-command)))
4090 (call-interactively cmd)
4091 (if (and org-self-insert-cluster-for-undo
4092 (eq cmd 'self-insert-command))
4093 (if (not (eq last-command 'orgtbl-self-insert-command))
4094 (setq org-self-insert-command-undo-counter 1)
4095 (if (>= org-self-insert-command-undo-counter 20)
4096 (setq org-self-insert-command-undo-counter 1)
4097 (and (> org-self-insert-command-undo-counter 0)
4098 buffer-undo-list
4099 (not (cadr buffer-undo-list)) ; remove nil entry
4100 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4101 (setq org-self-insert-command-undo-counter
4102 (1+ org-self-insert-command-undo-counter))))))))
4105 "Regular expression matching exponentials as produced by calc.")
4107 (defun orgtbl-export (table target)
4108 (require 'org-exp)
4109 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4111 org-table-last-alignment org-table-last-column-widths
4112 maxcol column)
4113 (if (not (fboundp func))
4114 (error "Cannot export orgtbl table to %s" target))
4115 (setq lines (org-table-clean-before-export lines))
4116 (setq table
4117 (mapcar
4118 (lambda (x)
4119 (if (string-match org-table-hline-regexp x)
4120 'hline
4122 lines))
4123 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4124 table)))
4125 (loop for i from (1- maxcol) downto 0 do
4126 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4127 (setq column (delq nil column))
4128 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4129 (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))
4130 (funcall func table nil)))
4132 (defun orgtbl-gather-send-defs ()
4133 "Gather a plist of :name, :transform, :params for each destination before
4134 a radio table."
4135 (save-excursion
4136 (goto-char (org-table-begin))
4137 (let (rtn)
4138 (beginning-of-line 0)
4139 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4140 (let ((name (org-no-properties (match-string 1)))
4141 (transform (intern (match-string 2)))
4142 (params (if (match-end 3)
4143 (read (concat "(" (match-string 3) ")")))))
4144 (push (list :name name :transform transform :params params)
4145 rtn)
4146 (beginning-of-line 0)))
4147 rtn)))
4149 (defun orgtbl-send-replace-tbl (name txt)
4150 "Find and replace table NAME with TXT."
4151 (save-excursion
4152 (goto-char (point-min))
4153 (unless (re-search-forward
4155 (error "Don't know where to insert translated table"))
4156 (goto-char (match-beginning 0))
4157 (beginning-of-line 2)
4158 (save-excursion
4159 (let ((beg (point)))
4160 (unless (re-search-forward
4161 (concat "END RECEIVE ORGTBL +" name) nil t)
4162 (error "Cannot find end of insertion region"))
4163 (beginning-of-line 1)
4164 (delete-region beg (point))))
4167 ;;;###autoload
4168 (defun org-table-to-lisp (&optional txt)
4169 "Convert the table at point to a Lisp structure.
4170 The structure will be a list. Each item is either the symbol `hline'
4171 for a horizontal separator line, or a list of field values as strings.
4172 The table is taken from the parameter TXT, or from the buffer at point."
4173 (unless txt
4174 (unless (org-at-table-p)
4175 (error "No table at point")))
4176 (let* ((txt (or txt
4177 (buffer-substring-no-properties (org-table-begin)
4178 (org-table-end))))
4181 (mapcar
4182 (lambda (x)
4183 (if (string-match org-table-hline-regexp x)
4184 'hline
4186 lines)))
4188 (defun orgtbl-send-table (&optional maybe)
4189 "Send a transformed version of this table to the receiver position.
4190 With argument MAYBE, fail quietly if no transformation is defined for
4191 this table."
4192 (interactive)
4193 (catch 'exit
4194 (unless (org-at-table-p) (error "Not at a table"))
4195 ;; when non-interactive, we assume align has just happened.
4196 (when (org-called-interactively-p 'any) (org-table-align))
4197 (let ((dests (orgtbl-gather-send-defs))
4198 (txt (buffer-substring-no-properties (org-table-begin)
4199 (org-table-end)))
4200 (ntbl 0))
4201 (unless dests (if maybe (throw 'exit nil)
4202 (error "Don't know how to transform this table")))
4203 (dolist (dest dests)
4204 (let* ((name (plist-get dest :name))
4205 (transform (plist-get dest :transform))
4206 (params (plist-get dest :params))
4207 (skip (plist-get params :skip))
4208 (skipcols (plist-get params :skipcols))
4209 beg
4210 (lines (org-table-clean-before-export
4211 (nthcdr (or skip 0)
4213 (i0 (if org-table-clean-did-remove-column 2 1))
4214 (table (mapcar
4215 (lambda (x)
4216 (if (string-match org-table-hline-regexp x)
4217 'hline
4218 (org-remove-by-index
4220 skipcols i0)))
4221 lines))
4222 (fun (if (= i0 2) 'cdr 'identity))
4223 (org-table-last-alignment
4224 (org-remove-by-index (funcall fun org-table-last-alignment)
4225 skipcols i0))
4226 (org-table-last-column-widths
4227 (org-remove-by-index (funcall fun org-table-last-column-widths)
4228 skipcols i0))
4229 (txt (if (fboundp transform)
4230 (funcall transform table params)
4231 (error "No such transformation function %s" transform))))
4232 (orgtbl-send-replace-tbl name txt))
4233 (setq ntbl (1+ ntbl)))
4234 (message "Table converted and installed at %d receiver location%s"
4235 ntbl (if (> ntbl 1) "s" ""))
4236 (if (> ntbl 0)
4237 ntbl
4238 nil))))
4240 (defun org-remove-by-index (list indices &optional i0)
4241 "Remove the elements in LIST with indices in INDICES.
4242 First element has index 0, or I0 if given."
4243 (if (not indices)
4244 list
4245 (if (integerp indices) (setq indices (list indices)))
4246 (setq i0 (1- (or i0 0)))
4247 (delq :rm (mapcar (lambda (x)
4248 (setq i0 (1+ i0))
4249 (if (memq i0 indices) :rm x))
4250 list))))
4252 (defun orgtbl-toggle-comment ()
4253 "Comment or uncomment the orgtbl at point."
4254 (interactive)
4255 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4256 (re2 (concat "^" orgtbl-line-start-regexp))
4257 (commented (save-excursion (beginning-of-line 1)
4258 (cond ((looking-at re1) t)
4259 ((looking-at re2) nil)
4260 (t (error "Not at an org table")))))
4261 (re (if commented re1 re2))
4262 beg end)
4263 (save-excursion
4264 (beginning-of-line 1)
4265 (while (looking-at re) (beginning-of-line 0))
4266 (beginning-of-line 2)
4267 (setq beg (point))
4268 (while (looking-at re) (beginning-of-line 2))
4269 (setq end (point)))
4270 (comment-region beg end (if commented '(4) nil))))
4272 (defun orgtbl-insert-radio-table ()
4273 "Insert a radio table template appropriate for this major mode."
4274 (interactive)
4275 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4276 (txt (nth 1 e))
4277 name pos)
4278 (unless e (error "No radio table setup defined for %s" major-mode))
4279 (setq name (read-string "Table name: "))
4280 (while (string-match "%n" txt)
4281 (setq txt (replace-match name t t txt)))
4283 (setq pos (point))
4284 (insert txt)
4285 (goto-char pos)))
4287 ;; Dynamically bound input and output for table formatting.
4288 (defvar *orgtbl-table* nil
4289 "Carries the current table through formatting routines.")
4290 (defvar *orgtbl-rtn* nil
4291 "Formatting routines push the output lines here.")
4292 ;; Formatting parameters for the current table section.
4293 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4294 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4295 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4296 (defvar *orgtbl-fmt* nil "Format for each entry.")
4297 (defvar *orgtbl-efmt* nil "Format for numbers.")
4298 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4299 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4300 (defvar *orgtbl-lstart* nil "Text starting a row.")
4301 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4302 (defvar *orgtbl-lend* nil "Text ending a row.")
4303 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4305 (defsubst orgtbl-get-fmt (fmt i)
4306 "Retrieve the format from FMT corresponding to the Ith column."
4307 (if (and (not (functionp fmt)) (consp fmt))
4308 (plist-get fmt i)
4309 fmt))
4311 (defsubst orgtbl-apply-fmt (fmt &rest args)
4312 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4313 (cond ((functionp fmt) (apply fmt args))
4314 (fmt (apply 'format fmt args))
4315 (args (car args))
4316 (t args)))
4318 (defsubst orgtbl-eval-str (str)
4319 "If STR is a function, evaluate it with no arguments."
4320 (if (functionp str)
4321 (funcall str)
4322 str))
4324 (defun orgtbl-format-line (line)
4325 "Format LINE as a table row."
4326 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4327 (let* ((i 0)
4328 (line
4329 (mapcar
4330 (lambda (f)
4331 (setq i (1+ i))
4332 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4333 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4334 (orgtbl-apply-fmt efmt (match-string 1 f)
4335 (match-string 2 f))
4336 f)))
4337 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4338 *orgtbl-default-fmt*)
4339 f)))
4340 line)))
4341 (push (if *orgtbl-lfmt*
4342 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4343 (concat (orgtbl-eval-str *orgtbl-lstart*)
4344 (mapconcat 'identity line *orgtbl-sep*)
4345 (orgtbl-eval-str *orgtbl-lend*)))
4346 *orgtbl-rtn*))))
4348 (defun orgtbl-format-section (section-stopper)
4349 "Format lines until the first occurrence of SECTION-STOPPER."
4350 (let (prevline)
4351 (progn
4352 (while (not (eq (car *orgtbl-table*) section-stopper))
4353 (if prevline (orgtbl-format-line prevline))
4354 (setq prevline (pop *orgtbl-table*)))
4355 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4356 (*orgtbl-lend* *orgtbl-llend*)
4357 (*orgtbl-lfmt* *orgtbl-llfmt*))
4358 (orgtbl-format-line prevline))))))
4360 (defun orgtbl-to-generic (table params)
4361 "Convert the orgtbl-mode TABLE to some other format.
4362 This generic routine can be used for many standard cases.
4363 TABLE is a list, each entry either the symbol `hline' for a horizontal
4364 separator line, or a list of fields for that line.
4365 PARAMS is a property list of parameters that can influence the conversion.
4366 For the generic converter, some parameters are obligatory: you need to
4367 specify either :lfmt, or all of (:lstart :lend :sep).
4369 Valid parameters are
4371 :splice When set to t, return only table body lines, don't wrap
4372 them into :tstart and :tend. Default is nil. When :splice
4373 is non-nil, this also means that the exporter should not look
4374 for and interpret header and footer sections.
4376 :hline String to be inserted on horizontal separation lines.
4377 May be nil to ignore hlines.
4379 :sep Separator between two fields
4380 :remove-nil-lines Do not include lines that evaluate to nil.
4383 Each in the following group may be either a string or a function
4384 of no arguments returning a string:
4385 :tstart String to start the table. Ignored when :splice is t.
4386 :tend String to end the table. Ignored when :splice is t.
4387 :lstart String to start a new table line.
4388 :llstart String to start the last table line, defaults to :lstart.
4389 :lend String to end a table line
4390 :llend String to end the last table line, defaults to :lend.
4392 Each in the following group may be a string, a function of one
4393 argument (the field or line) returning a string, or a plist
4394 mapping columns to either of the above:
4395 :lfmt Format for entire line, with enough %s to capture all fields.
4396 If this is present, :lstart, :lend, and :sep are ignored.
4397 :llfmt Format for the entire last line, defaults to :lfmt.
4398 :fmt A format to be used to wrap the field, should contain
4399 %s for the original field value. For example, to wrap
4401 This may also be a property list with column numbers and
4404 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4405 Same as above, specific for the header lines in the table.
4406 All lines before the first hline are treated as header.
4407 If any of these is not present, the data line value is used.
4409 This may be either a string or a function of two arguments:
4410 :efmt Use this format to print numbers with exponentials.
4411 The format should have %s twice for inserting mantissa
4413 may also be a property list with column numbers and
4414 formats. :fmt will still be applied after :efmt.
4416 In addition to this, the parameters :skip and :skipcols are always handled
4417 directly by `orgtbl-send-table'. See manual."
4418 (interactive)
4420 (let* ((splicep (plist-get params :splice))
4421 (hline (plist-get params :hline))
4422 (remove-nil-linesp (plist-get params :remove-nil-lines))
4423 (remove-newlines (plist-get params :remove-newlines))
4424 (*orgtbl-hline* hline)
4425 (*orgtbl-table* table)
4426 (*orgtbl-sep* (plist-get params :sep))
4427 (*orgtbl-efmt* (plist-get params :efmt))
4428 (*orgtbl-lstart* (plist-get params :lstart))
4429 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4430 (*orgtbl-lend* (plist-get params :lend))
4431 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4432 (*orgtbl-lfmt* (plist-get params :lfmt))
4433 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4434 (*orgtbl-fmt* (plist-get params :fmt))
4435 *orgtbl-rtn*)
4437 ;; Put header
4438 (unless splicep
4439 (when (plist-member params :tstart)
4440 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4441 (if tstart (push tstart *orgtbl-rtn*)))))
4443 ;; Do we have a heading section? If so, format it and handle the
4444 ;; trailing hline.
4445 (if (and (not splicep)
4446 (or (consp (car *orgtbl-table*))
4447 (consp (nth 1 *orgtbl-table*)))
4448 (memq 'hline (cdr *orgtbl-table*)))
4449 (progn
4450 (when (eq 'hline (car *orgtbl-table*))
4451 ;; there is a hline before the first data line
4452 (and hline (push hline *orgtbl-rtn*))
4453 (pop *orgtbl-table*))
4454 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4455 *orgtbl-lstart*))
4456 (*orgtbl-llstart* (or (plist-get params :hllstart)
4457 *orgtbl-llstart*))
4458 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4459 (*orgtbl-llend* (or (plist-get params :hllend)
4460 (plist-get params :hlend) *orgtbl-llend*))
4461 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4462 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4463 (plist-get params :hlfmt) *orgtbl-llfmt*))
4464 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4465 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4466 (orgtbl-format-section 'hline))
4467 (if hline (push hline *orgtbl-rtn*))
4468 (pop *orgtbl-table*)))
4470 ;; Now format the main section.
4471 (orgtbl-format-section nil)
4473 (unless splicep
4474 (when (plist-member params :tend)
4475 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4476 (if tend (push tend *orgtbl-rtn*)))))
4478 (mapconcat (if remove-newlines
4479 (lambda (tend)
4481 'identity)
4482 (nreverse (if remove-nil-linesp
4483 (remq nil *orgtbl-rtn*)
4486 (defun orgtbl-to-tsv (table params)
4487 "Convert the orgtbl-mode table to TAB separated material."
4489 (defun orgtbl-to-csv (table params)
4490 "Convert the orgtbl-mode table to CSV material.
4491 This does take care of the proper quoting of fields with comma or quotes."
4492 (orgtbl-to-generic table (org-combine-plists
4493 '(:sep "," :fmt org-quote-csv-field)
4494 params)))
4496 (defun orgtbl-to-latex (table params)
4497 "Convert the orgtbl-mode TABLE to LaTeX.
4498 TABLE is a list, each entry either the symbol `hline' for a horizontal
4499 separator line, or a list of fields for that line.
4500 PARAMS is a property list of parameters that can influence the conversion.
4501 Supports all parameters from `orgtbl-to-generic'. Most important for
4502 LaTeX are:
4504 :splice When set to t, return only table body lines, don't wrap
4505 them into a tabular environment. Default is nil.
4507 :fmt A format to be used to wrap the field, should contain %s for the
4508 original field value. For example, to wrap everything in dollars,
4511 The format may also be a function that formats its one argument.
4513 :efmt Format for transforming numbers with exponentials. The format
4514 should have %s twice for inserting mantissa and exponent, for
4516 This may also be a property list with column numbers and formats.
4517 The format may also be a function that formats its two arguments.
4519 :llend If you find too much space below the last line of a table,
4522 The general parameters :skip and :skipcols have already been applied when
4523 this function is called."
4524 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4525 org-table-last-alignment ""))
4526 (params2
4527 (list
4532 (orgtbl-to-generic table (org-combine-plists params2 params))))
4534 (defun orgtbl-to-html (table params)
4535 "Convert the orgtbl-mode TABLE to HTML.
4536 TABLE is a list, each entry either the symbol `hline' for a horizontal
4537 separator line, or a list of fields for that line.
4538 PARAMS is a property list of parameters that can influence the conversion.
4539 Currently this function recognizes the following parameters:
4541 :splice When set to t, return only table body lines, don't wrap
4542 them into a <table> environment. Default is nil.
4544 The general parameters :skip and :skipcols have already been applied when
4545 this function is called. The function does *not* use `orgtbl-to-generic',
4546 so you cannot specify parameters for it."
4547 (let* ((splicep (plist-get params :splice))
4548 (html-table-tag org-export-html-table-tag)
4549 html)
4550 ;; Just call the formatter we already have
4551 ;; We need to make text lines for it, so put the fields back together.
4552 (setq html (org-format-org-table-html
4553 (mapcar
4554 (lambda (x)
4555 (if (eq x 'hline)
4556 "|----+----|"
4557 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4558 table)
4559 splicep))
4561 (setq html (replace-match "" t t html)))
4562 html))
4564 (defun orgtbl-to-texinfo (table params)
4565 "Convert the orgtbl-mode TABLE to TeXInfo.
4566 TABLE is a list, each entry either the symbol `hline' for a horizontal
4567 separator line, or a list of fields for that line.
4568 PARAMS is a property list of parameters that can influence the conversion.
4569 Supports all parameters from `orgtbl-to-generic'. Most important for
4570 TeXInfo are:
4572 :splice nil/t When set to t, return only table body lines, don't wrap
4573 them into a multitable environment. Default is nil.
4575 :fmt fmt A format to be used to wrap the field, should contain
4576 %s for the original field value. For example, to wrap
4578 This may also be a property list with column numbers and
4580 Each format also may be a function that formats its one
4581 argument.
4584 are computed automatically from the width of the columns
4585 under org-mode.
4587 The general parameters :skip and :skipcols have already been applied when
4588 this function is called."
4589 (let* ((total (float (apply '+ org-table-last-column-widths)))
4590 (colfrac (or (plist-get params :cf)
4591 (mapconcat
4592 (lambda (x) (format "%.3f" (/ (float x) total)))
4593 org-table-last-column-widths " ")))
4594 (params2
4595 (list
4596 :tstart (concat "@multitable @columnfractions " colfrac)
4597 :tend "@end multitable"
4598 :lstart "@item " :lend "" :sep " @tab "
4599 :hlstart "@headitem ")))
4600 (orgtbl-to-generic table (org-combine-plists params2 params))))
4602 (defun orgtbl-to-orgtbl (table params)
4603 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4604 Useful when slicing one table into many. The :hline, :sep,
4605 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4606 and :tend suppress strings without splicing; they can be set to
4607 provide ORGTBL directives for the generated table."
4608 (let* ((params2
4609 (list
4610 :remove-newlines t
4611 :tstart nil :tend nil
4612 :hline "|---"
4613 :sep " | "
4614 :lstart "| "
4615 :lend " |"))
4616 (params (org-combine-plists params2 params)))
4617 (orgtbl-to-generic table params)))
4619 (defun org-table-get-remote-range (name-or-id form)
4620 "Get a field value or a list of values in a range from table at ID.
4622 NAME-OR-ID may be the name of a table in the current file as set by
4624 will then be used. Alternatively, it may be an ID referring to
4625 any entry, also in a different file. In this case, the first table
4626 in that entry will be referenced.
4630 The return value is either a single string for a single field, or a
4631 list of the fields in the rectangle ."
4632 (save-match-data
4633 (let ((id-loc nil)
4634 org-table-column-names org-table-column-name-regexp
4635 org-table-local-parameters org-table-named-field-locations
4636 org-table-current-line-types org-table-current-begin-line
4637 org-table-current-begin-pos org-table-dlines
4638 org-table-current-ncol
4639 org-table-hlines org-table-last-alignment
4640 org-table-last-column-widths org-table-last-alignment
4641 org-table-last-column-widths tbeg
4642 buffer loc)
4643 (setq form (org-table-convert-refs-to-rc form))
4644 (save-excursion
4645 (save-restriction
4646 (widen)
4647 (save-excursion
4648 (goto-char (point-min))
4649 (if (re-search-forward
4651 nil t)
4652 (setq buffer (current-buffer) loc (match-beginning 0))
4653 (setq id-loc (org-id-find name-or-id 'marker))
4654 (unless (and id-loc (markerp id-loc))
4656 (setq buffer (marker-buffer id-loc)
4657 loc (marker-position id-loc))
4658 (move-marker id-loc nil)))
4659 (with-current-buffer buffer
4660 (save-excursion
4661 (save-restriction
4662 (widen)
4663 (goto-char loc)
4664 (forward-char 1)
4666 (not (match-beginning 1)))
4667 (error "Cannot find a table at NAME or ID %s" name-or-id))
4668 (setq tbeg (point-at-bol))
4669 (org-table-get-specials)
4670 (setq form (org-table-formula-substitute-names form))
4671 (if (and (string-match org-table-range-regexp form)
4672 (> (length (match-string 0 form)) 1))
4673 (save-match-data
4674 (org-table-get-range (match-string 0 form) tbeg 1))
4675 form)))))))))
4677 (provide 'org-table)
4679 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4681 ;;; org-table.el ends here