| blob | 8c658804bced6d789c833ee03e7b51229838df41 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org-mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, otherwise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
91 #+ END RECEIVE ORGTBL %n
93 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
94 | | |
96 "Templates for radio tables in different major modes.
97 All occurrences of %n in a template will be replaced with the name of the
98 table, obtained by prompting the user."
105 "Settings for tables in Org-mode."
110 "The default size for newly created tables, Columns x Rows."
116 "Regular expression for recognizing numbers in table columns.
117 If a table column contains mostly numbers, it will be aligned to the
118 right. If not, it will be aligned to the left.
120 The default value of this option is a regular expression which allows
121 anything which looks remotely like a number as used in scientific
122 context. For example, all of the following will be considered a
123 number:
125 12 12.2 12,2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
127 Other options offered by the customize interface are more restrictive."
145 "Fraction of numbers in a column required to make the column align right.
146 In a column all non-white fields are considered. If at least
147 this fraction of fields is matched by `org-table-number-regexp',
148 alignment to the right border applies."
153 "Behavior of tables during editing in Org-mode."
158 "Non-nil means automatically re-align table when pressing TAB or RETURN.
160 removal/insertion."
165 "Non-nil means automatically blank table field when starting to type into it.
166 This only happens when typing immediately after a field motion
167 command (TAB, S-TAB or RET).
168 Only relevant when `org-enable-table-editor' is equal to `optimized'."
173 "Non-nil means automatically exit the follow mode.
174 When nil, the follow mode will stay on and be active in any table
175 the cursor enters. Since the table follow filed mode messes with the
176 window configuration, it is not recommended to set this variable to nil,
177 except maybe locally in a special file that has mostly tables with long
178 fields."
184 "Whether the user should confirm when Org fixes formulas."
192 'safe-local-variable
196 "Non-nil means tab in the last column of a table with jump over a hline.
197 If a horizontal separator line is following the current line,
198 `org-table-next-field' can either create a new row before that line, or jump
199 over the line. When this option is nil, a new line will be created before
200 this line."
205 "Options concerning tables in Org-mode."
210 "Should org-mode work with table references like B3 instead of @3$2?
211 Possible values are:
212 nil never use them
213 from accept as input, do not present for editing
214 t accept as input and present for editing"
229 calc-angle-mode deg
230 calc-prefer-frac nil
231 calc-symbolic-mode nil
233 calc-display-working-message t
234 )
235 "List with Calc mode settings for use in `calc-eval' for table formulas.
236 The list must contain alternating symbols (Calc modes variables and values).
237 Don't remove any of the default settings, just change the values. Org-mode
238 relies on the variables to be present in the list."
243 "Format for the output of calc computations like $1+$2;t.
244 The default value is 'hours, and will output the results as a
245 number of hours. Other allowed values are 'seconds, 'minutes and
246 'days, and the output will be a fraction of seconds, minutes or
247 days."
256 "Format for fields which contain the result of a formula.
258 characters. Beware that modifying the display can prevent the
259 field from being used in another formula."
265 "Non-nil means TAB and RET evaluate a formula in current table field.
266 If the current field starts with an equal sign, it is assumed to be a formula
267 which should be evaluated as described in the manual and in the documentation
268 string of the command `org-table-eval-formula'. This feature requires the
269 Emacs calc package.
270 When this variable is nil, formula calculation is only available through
276 "Non-nil means interpret constants in formulas in tables.
277 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
278 by the value given in `org-table-formula-constants', or by a value obtained
279 from the `constants.el' package."
284 "Alist with constant names and values, for use in table formulas.
285 The car of each element is a name of a constant, without the `$' before it.
286 The cdr is the value as a string. For example, if you'd like to use the
287 speed of light in a formula, you would configure
291 and then use it in an equation like `$1*$c'.
293 Constants can also be defined on a per-file basis using a line like
295 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
302 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
303 Automatically means when TAB or RET or C-c C-c are pressed in the line."
308 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
313 "Non-nil means relative formula references may cross hlines.
314 Here are the allowed values:
316 nil Relative references may not cross hlines. They will reference the
317 field next to the hline instead. Coming from below, the reference
318 will be to the field below the hline. Coming from above, it will be
319 to the field above.
320 t Relative references may cross hlines.
321 error An attempt to cross a hline will throw an error.
323 It is probably good to never set this variable to nil, for the sake of
324 portability of tables."
332 "Options concerning table import and export in Org-mode."
337 "Default export parameters for `org-table-export'.
338 These can be overridden for a specific table by setting the
339 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
340 radio tables for the different export transformations and
341 available parameters."
379 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
380 ;; 1 2 3 4 5
391 "Is this a table line colgroup information?"
395 line)
397 nil
404 "Is this a table line with only alignment/width cookies?"
417 s))))
426 "Use the table.el package to insert a new table.
427 If there is already a table at point, convert between Org-mode tables
428 and table.el tables."
442 "Convert region to table, or create an empty table.
443 If there is an active region, convert it to a table, using the function
444 `org-table-convert-region'. See the documentation of that function
445 to learn how the prefix argument is interpreted to determine the field
446 separator.
447 If there is no such region, create an empty table with `org-table-create'."
454 "Query for a size and insert a table skeleton.
474 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
478 ;; Insert a hline after the first row.
486 "Convert region to a table.
487 The region goes from BEG0 to END0, but these borders will be moved
488 slightly, to make sure a beginning of line in the first line is included.
490 SEPARATOR specifies the field separator in the lines. It can have the
491 following values:
493 '(4) Use the comma as a field separator
494 '(16) Use a TAB as field separator
495 integer When a number, use that many spaces as field separator
496 nil When nil, the command tries to be smart and figure out the
497 separator in the following way:
498 - when each line contains a TAB, assume TAB-separated material
499 - when each line contains a comma, assume CSV material
500 - else, assume one or more SPACE characters as separator."
504 re)
511 ;; Get the right field separator
522 ;; parse the csv stuff
546 "Import FILE as a table.
547 The file is assumed to be tab-separated. Such files can be produced by most
548 spreadsheet and database applications. If no tabs (at least one per line)
549 are found, lines will be split on whitespace into fields."
561 "Export table to a file, with configurable format.
562 Such a file can be imported into usual spreadsheet programs.
564 FILE can be the output file name. If not given, it will be taken
565 from a TABLE_EXPORT_FILE property in the current entry or higher
566 up in the hierarchy, or the user will be prompted for a file
567 name. FORMAT can be an export format, of the same kind as it
568 used when `orgtbl-mode' sends a table in a different format.
570 The command suggests a format depending on TABLE_EXPORT_FORMAT,
571 whether it is set locally or up in the hierarchy, then on the
572 extension of the given file name, and finally on the variable
573 `org-table-export-default-format'."
589 buf deffmt-readable fileext)
605 org-table-export-default-format))
623 'hline
626 skipcols i0)))
627 lines))
631 skipcols i0))
634 skipcols i0)))
651 "Marker at the beginning of the table last aligned.
654 "Marker at the end of the table last aligned.
657 "List of flags for flushright alignment, from the last re-alignment.
660 "List of max width of fields in each column.
663 "Non-nil means debug table formulas.
676 "Align the table at point by aligning all vertical bars."
679 ;; Limits of table
682 ;; Current cursor position
688 column
690 rfmt hfmt
698 emptystrings links dates emph raise narrow
699 falign falign1 fmax f1 len c e space)
702 ;; Check if we have links or dates
714 ;; Make sure the link properties are right
716 ;; Make sure the date properties are right
721 ;; Check if we are narrowing any columns
724 org-format-transports-properties-p
729 ;; Get the rows
732 ;; Store the indentation of the first line
735 ;; Mark the hlines by setting the corresponding element to nil
736 ;; At the same time, we remove trailing space.
739 nil
742 l)))
743 lines))
744 ;; Get the data fields by splitting the lines.
749 ;; How many fields in the longest line?
756 ;; A list of empty strings to fill any short rows on output
758 ;; Check for special formatting.
762 ;; Check if there is an explicit width specified
772 ;; Find fields that are wider than fmax, and shorten them
778 'help-echo
779 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
787 xx)))))
788 ;; Get the maximum width for each column
790 lengths)
791 ;; Get the fraction of numbers, to decide about alignment of the column
797 nil
804 ;; Store the alignment of this table, for later editing of single fields
806 org-table-last-column-widths lengths)
808 ;; With invisible characters, `format' does not get the field width right
809 ;; So we need to make these fields wide by hand.
827 ;; Compute the formats needed for output of the table
840 hfmt))
844 ;; Replace the old one
851 ;; Try to move to the old location
859 ))
862 "Find the beginning of the table and return its position.
863 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
867 org-table-border-regexp)
868 nil t))
875 "Find the end of the table and return its position.
876 With argument TABLE-TYPE, go to the end of a table.el-type table."
880 org-table-border-regexp)
881 nil t))
887 "Justify the current field, text to left, number to right.
888 Optional argument NEW may specify text to replace the current field content."
897 ;; This is not the same table, force a full re-align
903 l f n o e)
927 "Go to the next field in the current table, creating new lines as needed.
928 Before doing so, re-align the table if necessary."
933 org-table-may-need-update)
944 org-table-tab-jumps-over-hlines
956 "Go to the previous field in the table.
957 Before doing so, re-align the table if necessary."
962 org-table-may-need-update)
977 "Move to the end of the current table field.
978 If already at or after the end, move to the end of the next table field.
979 With numeric argument N, move N-1 fields forward first."
992 "Move to the beginning of the current table field.
993 If already at or before the beginning, move to the beginning of the
994 previous field.
995 With numeric argument N, move N-1 fields backward first."
1009 "Go to the next row (same column) in the current table.
1010 Before doing so, re-align the table if necessary."
1018 org-table-may-need-update)
1032 "Copy a field down in the current column.
1033 If the field at the cursor is empty, copy into it the content of
1034 the nearest non-empty field above. With argument N, use the Nth
1035 non-empty field. If the current field is not empty, it is copied
1036 down to the next row, and the cursor is moved with it.
1037 Therefore, repeating this command causes the column to be filled
1038 row-by-row.
1039 If the variable `org-table-copy-increment' is non-nil and the
1040 field is an integer or a timestamp, it will be incremented while
1041 copying. In the case of a timestamp, increment by one day."
1049 txt)
1061 beg t))
1084 "Is point inside a table data field?
1085 I.e. not on a hline or before the first or after the last column?
1086 This actually throws an error, so it aborts the current command."
1092 nil
1094 t))
1100 "Get the field in table line LINE, column COLUMN.
1101 If LINE is larger than the number of data lines in the table, the function
1102 returns nil. However, if COLUMN is too large, we will simply return an
1103 empty string.
1104 If LINE is nil, use the current line.
1105 If column is nil, use the current column."
1112 "Put VALUE into line LINE, column COLUMN.
1113 When ALIGN is set, also realign the table."
1122 "Return the index of the current data line."
1129 cnt))
1132 "Go to the Nth data line in the current table.
1133 Return t when the line exists, nil if it does not exist."
1141 "Blank the current table field or active region."
1158 "Return the value of the field in column N of current row.
1159 N defaults to current field.
1160 If REPLACE is a string, replace field with this value. The return value
1161 is always the old value."
1170 t t))
1172 val)
1176 "Show info about the current field, and highlight any reference at point."
1184 org-table-named-field-locations)))
1204 dline col
1206 dline col ref1
1208 ;; FIXME: formula info not correct if special table line
1218 "Find out which column we are in."
1228 cnt)))
1231 "Find out what table data line we are in.
1232 Only data lines count for this."
1244 cnt)))
1247 "Move the cursor to the Nth column in the current table line.
1248 With optional argument ON-DELIM, stop with point before the left delimiter
1249 of the field.
1250 If there are less than N fields, just go to after the last delimiter.
1251 However, when FORCE is non-nil, create new columns if necessary."
1261 t)))))
1269 "Insert a new column into the table."
1277 ;; Current cursor position
1283 nil
1297 "Find a data line in the current table, which is needed for column commands."
1300 t
1311 t
1316 "Turn a buffer line number into a data line number.
1317 If there is no data line in this line, return nil.
1318 If there is no matching dline (most likely te reference was a hline), the
1319 first dline below it is used. When ABOVE is non-nil, the one above is used."
1322 i)
1335 nil))
1338 "Delete a column from the table."
1347 ;; Current cursor position
1353 nil
1370 "Move column to the right."
1374 "Move column to the left."
1379 "Move the current column to the right. With arg LEFT, move to the left."
1389 ;; Current cursor position
1399 nil
1418 "Move table row down."
1422 "Move table row up."
1427 "Move the current table line down. With arg UP, move it up."
1436 txt hline2p)
1460 "Insert a new row above the current line into the table.
1461 With prefix ARG, insert below the current line."
1467 ;; Fix the first field if necessary
1481 "Insert a horizontal-line below the current line into the table.
1482 With prefix ABOVE, insert above the current line."
1504 "Insert a hline and move to the row below that line."
1518 In particular, this does handle wide and invisible characters."
1520 ;; It's a hline, just map the characters
1526 t t s)))
1527 s))
1530 "Delete the current row or horizontal line from the table."
1545 "Sort table lines according to the column at point.
1547 The position of point indicates the column to be used for
1548 sorting, and the range of lines is the range between the nearest
1549 horizontal separator lines, or the entire table of no such lines
1550 exist. If point is before the first column, you will be prompted
1551 for the sorting column. If there is an active region, the mark
1552 specifies the first line and the sorting column, while point
1553 should be in the last line to be included into the sorting.
1555 The command then prompts for the sorting type which can be
1556 alphabetically, numerically, or by time (as given in a time stamp
1557 in the field). Sorting in reverse order is also possible.
1559 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1561 If SORTING-TYPE is specified when this function is called from a Lisp
1562 program, no prompting will take place. SORTING-TYPE must be a character,
1563 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1564 should be done in reverse order."
1568 beg end bcol ecol tend tbeg column lns pos)
1613 x))
1626 "Copy region in table to the clipboard and blank all relevant fields.
1627 If there is no active region, use just the field at point."
1634 "Copy rectangular region in table to clipboard.
1635 A special clipboard is used which can only be accessed
1636 with `org-table-paste-rectangle'."
1640 current-prefix-arg))
1642 region cols
1668 org-table-clip))
1671 "Paste a rectangular region into a table.
1672 The upper right corner ends up in the current field. All involved fields
1673 will be overwritten. If the rectangle does not fit into the present table,
1674 the table is enlarged as needed. The process ignores horizontal separator
1675 lines."
1685 c cols field)
1701 "Convert from `org-mode' table to table.el and back.
1702 Obviously, this only works within limits. When an Org-mode table is
1703 converted to table.el, all horizontal separator lines get lost, because
1704 table.el uses these as cell boundaries and has no notion of horizontal lines.
1705 A table.el table can be converted to an Org-mode table only if it does not
1706 do row or column spanning. Multiline cells will become multiple cells.
1707 Beware, Org-mode does not test if the table can be successfully converted - it
1708 blindly applies a recipe that works for simple tables."
1712 ;; convert to Org-mode table
1721 ;; convert to table.el table
1724 ;; first, get rid of all horizontal lines
1728 ;; insert a hline before first
1732 ;; insert a hline after each line
1737 ;; replace "+" at beginning and ending of hlines
1746 "Transpose orgmode table at point and eliminate hlines.
1747 So a table like
1749 | 1 | 2 | 4 | 5 |
1750 |---+---+---+---|
1751 | a | b | c | d |
1752 | e | f | g | h |
1754 will be transposed as
1756 | 1 | a | e |
1757 | 2 | b | f |
1758 | 4 | c | g |
1759 | 5 | d | h |
1761 Note that horizontal lines disappeared."
1765 ;; remove 'hline from list
1774 "Wrap several fields in a column like a paragraph.
1775 This is useful if you'd like to spread the contents of a field over several
1776 lines, in order to keep the table compact.
1778 If there is an active region, and both point and mark are in the same column,
1779 the text in the column is wrapped to minimum width for the given number of
1780 lines. Generally, this makes the table more compact. A prefix ARG may be
1782 formats the selected text to two lines. If the region was longer than two
1783 lines, the remaining lines remain empty. A negative prefix argument reduces
1784 the current number of lines by that amount. The wrapped text is pasted back
1785 into the table. If you formatted it to more lines than it was before, fields
1786 further down in the table get overwritten - so you might need to make space in
1787 the table first.
1789 If there is no region, the current field is split at the cursor position and
1790 the text fragment to the right of the cursor is prepended to the field one
1791 line down.
1793 If there is no region, but you specify a prefix ARG, the current field gets
1794 blank, and the content is appended to the field above."
1798 ;; There is a region: fill as a paragraph
1802 nlines)
1809 arg)
1813 nil nlines)))
1817 ;; No region, split the current field at point
1821 ;; combine with field above
1831 ;; split field
1844 "Edit table field in a different window.
1845 This is mainly useful for fields that contain hidden parts.
1847 it can be edited in place."
1856 display t intangible t))
1869 p)
1885 intangible t))
1893 "Finish editing a table data field.
1894 Remove all newline characters, insert the result into the table, realign
1895 the table and kill the editing buffer."
1899 text)
1916 "Minor mode to make the table field editor window follow the cursor.
1917 When this mode is active, the field editor window will always show the
1918 current field. The mode exits automatically when the cursor leaves the
1919 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
1920 nil " TblFollow" nil
1936 ;; We have left the table, exit the follow mode
1947 "Sum numbers in region of current table column.
1948 The result will be displayed in the echo area, and will be available
1951 If there is an active region, it is interpreted as a rectangle and all
1952 numbers in that rectangle will be summed. If there is no active
1953 region and point is located in a table column, sum all numbers in that
1954 column.
1956 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1957 numbers are assumed to be times as well (in decimal hours) and the
1958 numbers are added as such.
1960 If NLAST is a number, only the NLAST fields will actually be summed."
1987 items1)))
1994 s diff)
2002 sres))))
2025 "Return the formula active for the current field.
2026 Assumes that specials are in place.
2027 If KEY is given, return the key to this formula.
2031 org-table-named-field-locations)))
2045 "Read a formula from the minibuffer, offer stored formula as default.
2046 When NAMED is non-nil, look for a named equation."
2050 org-table-named-field-locations)))
2057 name
2058 ref)
2068 stored)
2070 equation)
2077 scol))
2079 'org-table-formula-history
2080 )))))
2081 mustsave)
2083 ;; remove formula
2090 ;; We set the column equation, delete the named one.
2092 mustsave t))
2098 eq))
2101 "Store the list of formulas below the current table."
2108 ;; don't overwrite TBLFM, we might use text properties to store stuff
2124 ;; Fake a high number to make sure this is sorted at the end.
2131 a)
2141 "Compare two formulas for sorting."
2147 "Return an alist with the stored formulas directly after current table."
2156 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2175 "Modify the equations after the table structure has been edited.
2177 For all numbers larger than LIMIT, shift them by DELTA."
2188 s n a)
2204 t t)))))))))
2207 "Get the column names and local parameters for this table."
2210 names name fields fields1 field cnt
2211 c v l line col types dlines hlines last-dline)
2213 org-table-local-parameters nil
2214 org-table-named-field-locations nil
2215 org-table-current-begin-line nil
2216 org-table-current-begin-pos nil
2217 org-table-current-line-types nil
2236 org-table-local-parameters))))
2252 ;; Analyse the line types
2256 l org-table-current-begin-line)
2273 al al2)
2285 If yes, store the formula and apply it."
2286 ;; We already know we are in a table. Get field will only return a formula
2287 ;; when appropriate. It might return a separator line, but no problem.
2290 named eq)
2301 "List of commands triggering the recalculation of a line.
2314 "Rotate the recalculation mark in the first column.
2315 If in any row, the first field is not consistent with a mark,
2316 insert a new column for the markers.
2317 When there is an active region, change all the lines in the region,
2318 after prompting for the marking character.
2319 After each change, a message will be displayed indicating the meaning
2320 of the new mark."
2335 epos new)
2342 newchar))
2375 "Recompute the current line if marked for it, and if we haven't just done it."
2395 org-tbl-calc-modes)
2398 suppress-align suppress-const
2399 suppress-store suppress-analysis)
2400 "Replace the table field value at the cursor by the result of a calculation.
2402 This function makes use of Dave Gillespie's Calc package, in my view the
2403 most exciting program ever written for GNU Emacs. So you need to have Calc
2404 installed in order to use this function.
2406 In a table, this command replaces the value in the current field with the
2408 formula, by storing it in a special line below the table. When called
2409 with a `C-u' prefix, the current field must be a named field, and the
2410 formula is installed as valid in only this specific field.
2412 When called with two `C-u' prefixes, insert the active equation
2413 for the field back into the current field, so that it can be
2415 to check the referenced fields.
2417 When called, the command first prompts for a formula, which is read in
2418 the minibuffer. Previously entered formulas are available through the
2419 history list, and the last used formula is offered as a default.
2420 These stored formulas are adapted correctly when moving, inserting, or
2421 deleting columns with the corresponding commands.
2423 The formula can be any algebraic expression understood by the Calc package.
2424 For details, see the Org-mode manual.
2426 This function can also be called from Lisp programs and offers
2427 additional arguments: EQUATION can be the formula to apply. If this
2428 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2429 used to speed-up recursive calls by by-passing unnecessary aligns.
2430 SUPPRESS-CONST suppresses the interpretation of constants in the
2431 formula, assuming that this has been done already outside the function.
2432 SUPPRESS-STORE means the formula should not be stored, either because
2433 it is already stored, or because it is a modified equation that should
2434 not overwrite the stored one."
2450 equation
2456 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2457 duration duration-output-format)
2458 ;; Parse the format string. Since we have a lot of modes, this is
2459 ;; a lot of work. However, I think calc still uses most of the time.
2472 'calc-float-format
2475 n))))
2479 duration-output-format nil
2483 duration-output-format org-table-duration-custom-format
2484 numbers t
2507 ;; replace fields with duration values if relevant
2511 fields)))
2515 fields)))
2521 ;; Insert row and column number of formula result field
2532 t t form)))
2534 ;; Check for old vertical references
2536 ;; Insert remote references
2548 rmtrng))
2549 keep-empty numbers lispp))
2550 t t form)))
2551 ;; Insert complex ranges
2559 ;; possibly handle durations
2564 formrg)
2565 keep-empty numbers lispp)))
2570 ;; Insert simple ranges
2579 keep-empty numbers lispp))
2580 t t form)))
2582 ;; Insert the references to fields in same row
2592 t t form)))
2605 form
2611 duration-output-format)
2612 ev)))
2617 Orig: %s
2618 $xyz-> %s
2619 @r$c-> %s
2651 prop value)))
2654 "Get a calc vector from a column, according to descriptor DESC.
2655 Optional arguments TBEG and COL can give the beginning of the table and
2656 the current column, to avoid unnecessary parsing.
2658 HIGHLIGHT means just highlight the range.
2660 When CORNERS-ONLY is set, only return the corners of the range as
2661 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2662 in the buffer and column1 and column2 are table column numbers."
2669 beg end c1 c2 r1 r2 rangep tmp)
2686 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2693 ;; just one field
2700 ;; A range, return a vector
2701 ;; First sort the numbers to get a regular rectangle
2705 ;; Only return the corners of the range
2707 ;; Copy the range values into a list
2721 ;; return string representation of calc vector
2726 "Analyze descriptor DESC and retrieve the corresponding line number.
2727 The cursor is currently in line CLINE, the table begins in line BLINE,
2728 and TABLE is a vector with line types."
2736 ;; 1 2 3 4 5 6
2756 nil hn cline desc)))
2759 rel on cline desc)))
2763 "FIXME: Needs more documentation."
2776 nil))
2777 t)))
2781 desc cline)
2782 i)))
2787 s))
2790 "Convert list ELEMENTS to something appropriate to insert into formula.
2791 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2792 NUMBERS indicates that everything should be converted to numbers.
2793 LISPP means to return something appropriate for a Lisp list."
2797 elements
2806 elements))))
2812 x
2818 elements
2822 "Recalculate the current table line by applying all stored formulas.
2823 With prefix arg ALL, do this for all lines in the table.
2824 With the prefix argument ALL is `(16)' \
2826 it is the symbol `iterate', recompute the table until it no longer changes.
2827 If NOALIGN is not nil, do not re-align the table after the computations
2828 are done. This is typically used internally to save time, if it is
2829 known that the table will be realigned a little later anyway."
2844 seen-fields lhs1
2846 ;; Insert constants in all formulas
2862 eqlist))
2863 ;; Split the equation list
2869 ;; Expand ranges in lhs of formulas
2872 ;; Get the correct line range to process
2878 ;; This is a table with marked lines, compute selected lines
2880 ;; Move forward to the first non-header line
2891 ;; First find the named fields, and mark them untouchable.
2892 ;; Also check if several field/range formulas try to set the same field.
2911 name)))
2921 ;; Now evaluate the column formulas, but skip fields covered by
2922 ;; field formulas
2926 ;; Unprotected line, recalculate
2938 ;; Now evaluate the field formulas
2952 ;; back to initial position
2960 "Recalculate the table until it does not change anymore.
2961 The maximum number of iterations is 10, but you can choose a different value
2962 with the prefix ARG."
2967 thistbl)
2981 ;;;###autoload
2983 "Recalculate all tables in the current buffer."
2990 ;;;###autoload
2992 "Iterate all tables in the buffer, to converge inter-table dependencies."
2997 c1
3014 "Expand list of formulas.
3015 If some of the RHS in the formulas are ranges or a row reference, expand
3016 them to individual field equations for each field."
3022 ;; This just refers to one fixed field
3025 ;; This just refers to one fixed named field
3047 "Replace @<, @>, $<, $> with first/last row/column of the table.
3048 So @< and $< will always be replaced with @1 and $1, respectively.
3049 The advantage of these special markers are that structure editing of
3050 the table will not change them, while @1 and $1 will be modified
3051 when a line/row is swapped out of that privileged position. So for
3052 formulas that use a range of rows or columns, it may often be better
3054 borders of the table using the @< @> $< $> makers."
3057 s start)
3062 org-table-current-ncol)
3066 len
3073 s)
3076 "Replace $const with values in string F."
3078 ;; First, check for column names
3083 ;; Parameters and constants
3085 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3095 f))
3098 "Find the value for a parameter or constant in a formula.
3099 Parameters get priority."
3130 map))
3137 "--"
3140 "--"
3141 "Shift Reference at Point"
3146 "-"
3147 "Change Test Row for Column Formulas"
3150 "--"
3155 org-table-overlay-coordinates)]
3156 "--"
3163 "Edit the formulas of the current table in a separate buffer."
3165 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3179 entry s type title)
3182 ;; Keep global-font-lock-mode from turning on font-lock-mode
3223 "Convert a formula from internal to user representation."
3226 s))
3229 "Convert a formula from user to internal representation."
3232 s))
3235 "Convert spreadsheet references from A7 to @7$28.
3236 Works for single references, but also for entire formulas and even the
3237 full TBLFM line."
3239 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3242 ;; format match, just advance
3247 ;; 3.e5 or something like this.
3250 ;; (member (match-string 1 s)
3251 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3252 )
3253 ;; function name, just advance
3263 t t s)))))
3264 s))
3267 "Convert spreadsheet references from to @7$28 to AB7.
3268 Works for single references, but also for entire formulas and even the
3269 full TBLFM line."
3276 t t s)))
3281 t nil s)))
3282 s)
3285 "Convert a base 26 number represented by letters into an integer.
3286 For example: AB -> 28."
3292 n))
3295 "Convert an integer into a base 26 number represented by letters.
3296 For example: 28 -> AB."
3301 s))
3304 "Convert a time string into numerical duration in seconds.
3305 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3306 If S is a string representing a number, keep this number."
3308 s
3331 "Convert a number of seconds to a time string.
3332 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3333 minutes or seconds."
3348 "Convert all references in this buffer, using FUNCTION."
3358 "Convert all references in the buffer from B3 to @3$2 and back."
3368 "Shift the reference at point one row/hline up."
3372 "Shift the reference at point one row/hline down."
3376 "Shift the reference at point one field to the left."
3380 "Shift the reference at point one field to the right."
3391 ;; A B3-like reference
3397 ;; An internal reference
3403 "Re-match the group N, and replace it with the shifted reference."
3408 t t)))
3411 "Shift a reference part REF.
3412 If DECR is set, decrease the references row/column, else increase.
3413 If HLINE is set, this may be a hline reference, it certainly is not
3414 a translation reference."
3443 "Toggle the display of coordinates in the referenced table."
3452 "Parse the buffer for formula definitions and install them.
3453 With prefix ARG, apply the new formulas to the table."
3463 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3464 nil t)
3488 "Abort editing formulas, without installing the changes."
3499 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3540 "Show the location/value of the $ expression at point."
3549 var name e what match dest)
3554 "$1.."
3637 ;; column number
3665 org-table-fedit-scroll-down))))
3676 "Make sure the cursor is in a dataline in a table."
3685 p1 p2)))
3690 "Move cursor one line up in the window showing the table."
3695 "Move cursor one line down in the window showing the table."
3700 "Move the cursor in the window showing the table.
3701 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3726 "Add a new overlay."
3732 "Highlight rectangular region in a table."
3736 l1 c1 l2 c2 tmp)
3760 "Remove the rectangle overlays."
3771 "Add overlays to the table at point, to show row/column coordinates."
3800 "Toggle the display of Row/Column numbers in tables."
3812 "Toggle the formula debugger in tables."
3818 ;;; The orgtbl minor mode
3820 ;; Define a minor mode which can be used in other modes in order to
3821 ;; integrate the org-mode table editor.
3823 ;; This is really a hack, because the org-mode table editor uses several
3824 ;; keys which normally belong to the major mode, for example the TAB and
3825 ;; RET keys. Here is how it works: The minor mode defines all the keys
3826 ;; necessary to operate the table editor, but wraps the commands into a
3827 ;; function which tests if the cursor is currently inside a table. If that
3828 ;; is the case, the table editor command is executed. However, when any of
3829 ;; those keys is used outside a table, the function uses `key-binding' to
3830 ;; look up if the key has an associated command in another currently active
3831 ;; keymap (minor modes, major mode, global), and executes that command.
3832 ;; There might be problems if any of the keys used by the table editor is
3833 ;; otherwise used as a prefix key.
3835 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3836 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3837 ;; addresses this by checking explicitly for both bindings.
3839 ;; The optimized version (see variable `orgtbl-optimized') takes over
3840 ;; all keys which are bound to `self-insert-command' in the *global map*.
3841 ;; Some modes bind other commands to simple characters, for example
3842 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3843 ;; active, this binding is ignored inside tables and replaced with a
3844 ;; modified self-insert.
3850 ;;;###autoload
3852 "Unconditionally turn on `orgtbl-mode'."
3867 ;; Install it as a minor mode.
3871 ;;;###autoload
3873 "The `org-mode' table editor as a minor mode for use in other modes."
3878 ;; Exit without error, in case some hook functions calls this
3879 ;; by accident in org-mode.
3883 ;; Make sure we are first in minor-mode-map-alist
3885 ;; FIXME: maybe it should use emulation-mode-map-alists?
3892 auto-fill-inhibit-regexp)
3896 auto-fill-inhibit-regexp)
3897 orgtbl-line-start-regexp))
3915 "Remove all properties related to narrow-column invisibility."
3928 "Create a function for binding in the table minor mode.
3929 FUN is the command to call inside a table. N is used to create a unique
3930 command name. KEYS are keys that should be checked in for a command
3931 to execute outside of tables."
3937 "Outside of tables, run the binding of `"
3949 keys)
3953 "Error when there is no default binding for a table key."
3958 "Setup orgtbl keymaps."
3989 elt key fun cmd)
3997 ;; Special treatment needed for TAB and RET
4017 [(tab)] "\C-i")))
4019 (org-defkey orgtbl-mode-map [backtab]
4021 [backtab] [S-iso-lefttab] [(shift tab)]
4022 [(tab)] "\C-i"))
4024 (org-defkey orgtbl-mode-map "\M-\C-m"
4025 (orgtbl-make-binding 'org-table-wrap-region 105
4026 "\M-\C-m" [(meta return)]))
4027 (org-defkey orgtbl-mode-map [(meta return)]
4028 (orgtbl-make-binding 'org-table-wrap-region 106
4029 [(meta return)] "\M-\C-m"))
4031 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4032 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4034 (when orgtbl-optimized
4035 ;; If the user wants maximum table support, we need to hijack
4036 ;; some standard editing functions
4037 (org-remap orgtbl-mode-map
4038 'self-insert-command 'orgtbl-self-insert-command
4039 'delete-char 'org-delete-char
4040 'delete-backward-char 'org-delete-backward-char)
4041 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4042 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4043 '("OrgTbl"
4044 ["Create or convert" org-table-create-or-convert-from-region
4045 :active (not (org-at-table-p)) :keys "C-c |" ]
4046 "--"
4047 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4048 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4049 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4050 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4051 "--"
4052 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4053 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4054 ["Copy Field from Above"
4055 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4056 "--"
4057 ("Column"
4058 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4059 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4060 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4061 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4062 ("Row"
4063 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4064 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4065 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4066 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4067 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4068 "--"
4069 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4070 ("Rectangle"
4071 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4072 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4073 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4074 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4075 "--"
4076 ("Radio tables"
4077 ["Insert table template" orgtbl-insert-radio-table
4078 (assq major-mode orgtbl-radio-table-templates)]
4079 ["Comment/uncomment table" orgtbl-toggle-comment t])
4080 "--"
4081 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4082 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4083 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4084 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4085 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4086 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4087 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4088 ["Sum Column/Rectangle" org-table-sum
4089 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4090 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4091 ["Debug Formulas"
4092 org-table-toggle-formula-debugger :active (org-at-table-p)
4093 :keys "C-c {"
4094 :style toggle :selected org-table-formula-debug]
4095 ["Show Col/Row Numbers"
4096 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4097 :keys "C-c }"
4098 :style toggle :selected org-table-overlay-coordinates]
4099 ))
4100 t))
4102 (defun orgtbl-ctrl-c-ctrl-c (arg)
4103 "If the cursor is inside a table, realign the table.
4104 If it is a table to be sent away to a receiver, do it.
4105 With prefix arg, also recompute table."
4106 (interactive "P")
4107 (let ((case-fold-search t) (pos (point)) action consts-str consts cst const-str)
4108 (save-excursion
4109 (beginning-of-line 1)
4110 (setq action (cond
4114 (cond
4115 ((integerp action)
4116 (goto-char action)
4117 (org-table-maybe-eval-formula)
4118 (if arg
4119 (call-interactively 'org-table-recalculate)
4120 (org-table-maybe-recalculate-line))
4121 (call-interactively 'org-table-align)
4122 (when (orgtbl-send-table 'maybe)
4123 (run-hooks 'orgtbl-after-send-table-hook)))
4124 ((eq action 'recalc)
4125 (save-excursion
4126 (goto-char (point-min))
4128 (setq const-str (substring-no-properties (match-string 1)))
4130 (when consts
4131 (let (e)
4132 (while (setq e (pop consts))
4134 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4135 (setq org-table-formula-constants-local cst)))))
4136 (save-excursion
4137 (beginning-of-line 1)
4139 (if (org-at-table-p)
4140 (org-call-with-arg 'org-table-recalculate t))))
4141 (t (let (orgtbl-mode)
4142 (call-interactively (key-binding "\C-c\C-c")))))))
4144 (defun orgtbl-create-or-convert-from-region (arg)
4145 "Create table or convert region to table, if no conflicting binding.
4146 This installs the table binding `C-c |', but only if there is no
4147 conflicting binding to this key outside orgtbl-mode."
4148 (interactive "P")
4149 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4150 (if cmd
4151 (call-interactively cmd)
4152 (call-interactively 'org-table-create-or-convert-from-region))))
4154 (defun orgtbl-tab (arg)
4155 "Justification and field motion for `orgtbl-mode'."
4156 (interactive "P")
4157 (if arg (org-table-edit-field t)
4158 (org-table-justify-field-maybe)
4159 (org-table-next-field)))
4161 (defun orgtbl-ret ()
4162 "Justification and field motion for `orgtbl-mode'."
4163 (interactive)
4164 (if (bobp)
4165 (newline)
4166 (org-table-justify-field-maybe)
4167 (org-table-next-row)))
4169 (defun orgtbl-self-insert-command (N)
4170 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4171 If the cursor is in a table looking at whitespace, the whitespace is
4172 overwritten, and the table is not marked as requiring realignment."
4173 (interactive "p")
4174 (if (and (org-at-table-p)
4175 (or
4176 (and org-table-auto-blank-field
4177 (member last-command
4178 '(orgtbl-hijacker-command-100
4179 orgtbl-hijacker-command-101
4180 orgtbl-hijacker-command-102
4181 orgtbl-hijacker-command-103
4182 orgtbl-hijacker-command-104
4183 orgtbl-hijacker-command-105
4184 yas/expand))
4185 (org-table-blank-field))
4186 t)
4187 (eq N 1)
4189 (let (org-table-may-need-update)
4190 (goto-char (1- (match-end 0)))
4191 (backward-delete-char 1)
4192 (goto-char (match-beginning 0))
4193 (self-insert-command N))
4194 (setq org-table-may-need-update t)
4195 (let* (orgtbl-mode
4196 a
4197 (cmd (or (key-binding
4198 (or (and (listp function-key-map)
4199 (setq a (assoc last-input-event function-key-map))
4200 (cdr a))
4201 (vector last-input-event)))
4202 'self-insert-command)))
4203 (call-interactively cmd)
4204 (if (and org-self-insert-cluster-for-undo
4205 (eq cmd 'self-insert-command))
4206 (if (not (eq last-command 'orgtbl-self-insert-command))
4207 (setq org-self-insert-command-undo-counter 1)
4208 (if (>= org-self-insert-command-undo-counter 20)
4209 (setq org-self-insert-command-undo-counter 1)
4210 (and (> org-self-insert-command-undo-counter 0)
4211 buffer-undo-list
4212 (not (cadr buffer-undo-list)) ; remove nil entry
4213 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4214 (setq org-self-insert-command-undo-counter
4215 (1+ org-self-insert-command-undo-counter))))))))
4218 "Regular expression matching exponentials as produced by calc.")
4220 (defun orgtbl-export (table target)
4221 (require 'org-exp)
4222 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4224 org-table-last-alignment org-table-last-column-widths
4225 maxcol column)
4226 (if (not (fboundp func))
4227 (error "Cannot export orgtbl table to %s" target))
4228 (setq lines (org-table-clean-before-export lines))
4229 (setq table
4230 (mapcar
4231 (lambda (x)
4232 (if (string-match org-table-hline-regexp x)
4233 'hline
4235 lines))
4236 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4237 table)))
4238 (loop for i from (1- maxcol) downto 0 do
4239 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4240 (setq column (delq nil column))
4241 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4242 (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))
4243 (funcall func table nil)))
4245 (defun orgtbl-gather-send-defs ()
4246 "Gather a plist of :name, :transform, :params for each destination before
4247 a radio table."
4248 (save-excursion
4249 (goto-char (org-table-begin))
4250 (let (rtn)
4251 (beginning-of-line 0)
4252 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4253 (let ((name (org-no-properties (match-string 1)))
4254 (transform (intern (match-string 2)))
4255 (params (if (match-end 3)
4256 (read (concat "(" (match-string 3) ")")))))
4257 (push (list :name name :transform transform :params params)
4258 rtn)
4259 (beginning-of-line 0)))
4260 rtn)))
4262 (defun orgtbl-send-replace-tbl (name txt)
4263 "Find and replace table NAME with TXT."
4264 (save-excursion
4265 (goto-char (point-min))
4266 (unless (re-search-forward
4268 (error "Don't know where to insert translated table"))
4269 (goto-char (match-beginning 0))
4270 (beginning-of-line 2)
4271 (save-excursion
4272 (let ((beg (point)))
4273 (unless (re-search-forward
4274 (concat "END RECEIVE ORGTBL +" name) nil t)
4275 (error "Cannot find end of insertion region"))
4276 (beginning-of-line 1)
4277 (delete-region beg (point))))
4280 ;;;###autoload
4281 (defun org-table-to-lisp (&optional txt)
4282 "Convert the table at point to a Lisp structure.
4283 The structure will be a list. Each item is either the symbol `hline'
4284 for a horizontal separator line, or a list of field values as strings.
4285 The table is taken from the parameter TXT, or from the buffer at point."
4286 (unless txt
4287 (unless (org-at-table-p)
4288 (error "No table at point")))
4289 (let* ((txt (or txt
4290 (buffer-substring-no-properties (org-table-begin)
4291 (org-table-end))))
4294 (mapcar
4295 (lambda (x)
4296 (if (string-match org-table-hline-regexp x)
4297 'hline
4299 lines)))
4301 (defun orgtbl-send-table (&optional maybe)
4302 "Send a transformed version of this table to the receiver position.
4303 With argument MAYBE, fail quietly if no transformation is defined for
4304 this table."
4305 (interactive)
4306 (catch 'exit
4307 (unless (org-at-table-p) (error "Not at a table"))
4308 ;; when non-interactive, we assume align has just happened.
4309 (when (org-called-interactively-p 'any) (org-table-align))
4310 (let ((dests (orgtbl-gather-send-defs))
4311 (txt (buffer-substring-no-properties (org-table-begin)
4312 (org-table-end)))
4313 (ntbl 0))
4314 (unless dests (if maybe (throw 'exit nil)
4315 (error "Don't know how to transform this table")))
4316 (dolist (dest dests)
4317 (let* ((name (plist-get dest :name))
4318 (transform (plist-get dest :transform))
4319 (params (plist-get dest :params))
4320 (skip (plist-get params :skip))
4321 (skipcols (plist-get params :skipcols))
4322 (no-escape (plist-get params :no-escape))
4323 beg
4324 (lines (org-table-clean-before-export
4325 (nthcdr (or skip 0)
4327 (i0 (if org-table-clean-did-remove-column 2 1))
4328 (lines (if no-escape lines
4329 (mapcar (lambda(l) (replace-regexp-in-string
4331 (table (mapcar
4332 (lambda (x)
4333 (if (string-match org-table-hline-regexp x)
4334 'hline
4335 (org-remove-by-index
4337 skipcols i0)))
4338 lines))
4339 (fun (if (= i0 2) 'cdr 'identity))
4340 (org-table-last-alignment
4341 (org-remove-by-index (funcall fun org-table-last-alignment)
4342 skipcols i0))
4343 (org-table-last-column-widths
4344 (org-remove-by-index (funcall fun org-table-last-column-widths)
4345 skipcols i0))
4346 (txt (if (fboundp transform)
4347 (funcall transform table params)
4348 (error "No such transformation function %s" transform))))
4349 (orgtbl-send-replace-tbl name txt))
4350 (setq ntbl (1+ ntbl)))
4351 (message "Table converted and installed at %d receiver location%s"
4352 ntbl (if (> ntbl 1) "s" ""))
4353 (if (> ntbl 0)
4354 ntbl
4355 nil))))
4357 (defun org-remove-by-index (list indices &optional i0)
4358 "Remove the elements in LIST with indices in INDICES.
4359 First element has index 0, or I0 if given."
4360 (if (not indices)
4361 list
4362 (if (integerp indices) (setq indices (list indices)))
4363 (setq i0 (1- (or i0 0)))
4364 (delq :rm (mapcar (lambda (x)
4365 (setq i0 (1+ i0))
4366 (if (memq i0 indices) :rm x))
4367 list))))
4369 (defun orgtbl-toggle-comment ()
4370 "Comment or uncomment the orgtbl at point."
4371 (interactive)
4372 (let* ((case-fold-search t)
4373 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4374 (re2 (concat "^" orgtbl-line-start-regexp))
4375 (commented (save-excursion (beginning-of-line 1)
4376 (cond ((looking-at re1) t)
4377 ((looking-at re2) nil)
4378 (t (error "Not at an org table")))))
4379 (re (if commented re1 re2))
4380 beg end)
4381 (save-excursion
4382 (beginning-of-line 1)
4383 (while (looking-at re) (beginning-of-line 0))
4384 (beginning-of-line 2)
4385 (setq beg (point))
4386 (while (looking-at re) (beginning-of-line 2))
4387 (setq end (point)))
4388 (comment-region beg end (if commented '(4) nil))))
4390 (defun orgtbl-insert-radio-table ()
4391 "Insert a radio table template appropriate for this major mode."
4392 (interactive)
4393 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4394 (txt (nth 1 e))
4395 name pos)
4396 (unless e (error "No radio table setup defined for %s" major-mode))
4397 (setq name (read-string "Table name: "))
4398 (while (string-match "%n" txt)
4399 (setq txt (replace-match name t t txt)))
4401 (setq pos (point))
4402 (insert txt)
4403 (goto-char pos)))
4405 ;; Dynamically bound input and output for table formatting.
4406 (defvar *orgtbl-table* nil
4407 "Carries the current table through formatting routines.")
4408 (defvar *orgtbl-rtn* nil
4409 "Formatting routines push the output lines here.")
4410 ;; Formatting parameters for the current table section.
4411 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4412 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4413 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4414 (defvar *orgtbl-fmt* nil "Format for each entry.")
4415 (defvar *orgtbl-efmt* nil "Format for numbers.")
4416 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4417 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4418 (defvar *orgtbl-lstart* nil "Text starting a row.")
4419 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4420 (defvar *orgtbl-lend* nil "Text ending a row.")
4421 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4423 (defsubst orgtbl-get-fmt (fmt i)
4424 "Retrieve the format from FMT corresponding to the Ith column."
4425 (if (and (not (functionp fmt)) (consp fmt))
4426 (plist-get fmt i)
4427 fmt))
4429 (defsubst orgtbl-apply-fmt (fmt &rest args)
4430 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4431 (cond ((functionp fmt) (apply fmt args))
4432 (fmt (apply 'format fmt args))
4433 (args (car args))
4434 (t args)))
4436 (defsubst orgtbl-eval-str (str)
4437 "If STR is a function, evaluate it with no arguments."
4438 (if (functionp str)
4439 (funcall str)
4440 str))
4442 (defun orgtbl-format-line (line)
4443 "Format LINE as a table row."
4444 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4445 (let* ((i 0)
4446 (line
4447 (mapcar
4448 (lambda (f)
4449 (setq i (1+ i))
4450 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4451 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4452 (orgtbl-apply-fmt efmt (match-string 1 f)
4453 (match-string 2 f))
4454 f)))
4455 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4456 *orgtbl-default-fmt*)
4457 f)))
4458 line)))
4459 (push (if *orgtbl-lfmt*
4460 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4461 (concat (orgtbl-eval-str *orgtbl-lstart*)
4462 (mapconcat 'identity line *orgtbl-sep*)
4463 (orgtbl-eval-str *orgtbl-lend*)))
4464 *orgtbl-rtn*))))
4466 (defun orgtbl-format-section (section-stopper)
4467 "Format lines until the first occurrence of SECTION-STOPPER."
4468 (let (prevline)
4469 (progn
4470 (while (not (eq (car *orgtbl-table*) section-stopper))
4471 (if prevline (orgtbl-format-line prevline))
4472 (setq prevline (pop *orgtbl-table*)))
4473 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4474 (*orgtbl-lend* *orgtbl-llend*)
4475 (*orgtbl-lfmt* *orgtbl-llfmt*))
4476 (orgtbl-format-line prevline))))))
4478 (defun orgtbl-to-generic (table params)
4479 "Convert the orgtbl-mode TABLE to some other format.
4480 This generic routine can be used for many standard cases.
4481 TABLE is a list, each entry either the symbol `hline' for a horizontal
4482 separator line, or a list of fields for that line.
4483 PARAMS is a property list of parameters that can influence the conversion.
4484 For the generic converter, some parameters are obligatory: you need to
4485 specify either :lfmt, or all of (:lstart :lend :sep).
4487 Valid parameters are:
4489 :splice When set to t, return only table body lines, don't wrap
4490 them into :tstart and :tend. Default is nil. When :splice
4491 is non-nil, this also means that the exporter should not look
4492 for and interpret header and footer sections.
4494 :hline String to be inserted on horizontal separation lines.
4495 May be nil to ignore hlines.
4497 :sep Separator between two fields
4498 :remove-nil-lines Do not include lines that evaluate to nil.
4500 Each in the following group may be either a string or a function
4501 of no arguments returning a string:
4503 :tstart String to start the table. Ignored when :splice is t.
4504 :tend String to end the table. Ignored when :splice is t.
4505 :lstart String to start a new table line.
4506 :llstart String to start the last table line, defaults to :lstart.
4507 :lend String to end a table line
4508 :llend String to end the last table line, defaults to :lend.
4510 Each in the following group may be a string, a function of one
4511 argument (the field or line) returning a string, or a plist
4512 mapping columns to either of the above:
4514 :lfmt Format for entire line, with enough %s to capture all fields.
4515 If this is present, :lstart, :lend, and :sep are ignored.
4516 :llfmt Format for the entire last line, defaults to :lfmt.
4517 :fmt A format to be used to wrap the field, should contain
4518 %s for the original field value. For example, to wrap
4520 This may also be a property list with column numbers and
4522 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4523 Same as above, specific for the header lines in the table.
4524 All lines before the first hline are treated as header.
4525 If any of these is not present, the data line value is used.
4527 This may be either a string or a function of two arguments:
4529 :efmt Use this format to print numbers with exponentials.
4530 The format should have %s twice for inserting mantissa
4532 may also be a property list with column numbers and
4533 formats. :fmt will still be applied after :efmt.
4535 In addition to this, the parameters :skip and :skipcols are always handled
4536 directly by `orgtbl-send-table'. See manual."
4537 (let* ((splicep (plist-get params :splice))
4538 (hline (plist-get params :hline))
4539 (skipheadrule (plist-get params :skipheadrule))
4540 (remove-nil-linesp (plist-get params :remove-nil-lines))
4541 (remove-newlines (plist-get params :remove-newlines))
4542 (*orgtbl-hline* hline)
4543 (*orgtbl-table* table)
4544 (*orgtbl-sep* (plist-get params :sep))
4545 (*orgtbl-efmt* (plist-get params :efmt))
4546 (*orgtbl-lstart* (plist-get params :lstart))
4547 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4548 (*orgtbl-lend* (plist-get params :lend))
4549 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4550 (*orgtbl-lfmt* (plist-get params :lfmt))
4551 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4552 (*orgtbl-fmt* (plist-get params :fmt))
4553 *orgtbl-rtn*)
4555 ;; Put header
4556 (unless splicep
4557 (when (plist-member params :tstart)
4558 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4559 (if tstart (push tstart *orgtbl-rtn*)))))
4561 ;; Do we have a heading section? If so, format it and handle the
4562 ;; trailing hline.
4563 (if (and (not splicep)
4564 (or (consp (car *orgtbl-table*))
4565 (consp (nth 1 *orgtbl-table*)))
4566 (memq 'hline (cdr *orgtbl-table*)))
4567 (progn
4568 (when (eq 'hline (car *orgtbl-table*))
4569 ;; there is a hline before the first data line
4570 (and hline (push hline *orgtbl-rtn*))
4571 (pop *orgtbl-table*))
4572 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4573 *orgtbl-lstart*))
4574 (*orgtbl-llstart* (or (plist-get params :hllstart)
4575 *orgtbl-llstart*))
4576 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4577 (*orgtbl-llend* (or (plist-get params :hllend)
4578 (plist-get params :hlend) *orgtbl-llend*))
4579 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4580 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4581 (plist-get params :hlfmt) *orgtbl-llfmt*))
4582 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4583 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4584 (orgtbl-format-section 'hline))
4585 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4586 (pop *orgtbl-table*)))
4588 ;; Now format the main section.
4589 (orgtbl-format-section nil)
4591 (unless splicep
4592 (when (plist-member params :tend)
4593 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4594 (if tend (push tend *orgtbl-rtn*)))))
4596 (mapconcat (if remove-newlines
4597 (lambda (tend)
4599 'identity)
4600 (nreverse (if remove-nil-linesp
4601 (remq nil *orgtbl-rtn*)
4604 (defun orgtbl-to-tsv (table params)
4605 "Convert the orgtbl-mode table to TAB separated material."
4607 (defun orgtbl-to-csv (table params)
4608 "Convert the orgtbl-mode table to CSV material.
4609 This does take care of the proper quoting of fields with comma or quotes."
4610 (orgtbl-to-generic table (org-combine-plists
4611 '(:sep "," :fmt org-quote-csv-field)
4612 params)))
4614 (defun orgtbl-to-latex (table params)
4615 "Convert the orgtbl-mode TABLE to LaTeX.
4616 TABLE is a list, each entry either the symbol `hline' for a horizontal
4617 separator line, or a list of fields for that line.
4618 PARAMS is a property list of parameters that can influence the conversion.
4619 Supports all parameters from `orgtbl-to-generic'. Most important for
4620 LaTeX are:
4622 :splice When set to t, return only table body lines, don't wrap
4623 them into a tabular environment. Default is nil.
4625 :fmt A format to be used to wrap the field, should contain %s for the
4626 original field value. For example, to wrap everything in dollars,
4629 The format may also be a function that formats its one argument.
4631 :efmt Format for transforming numbers with exponentials. The format
4632 should have %s twice for inserting mantissa and exponent, for
4634 This may also be a property list with column numbers and formats.
4635 The format may also be a function that formats its two arguments.
4637 :llend If you find too much space below the last line of a table,
4640 The general parameters :skip and :skipcols have already been applied when
4641 this function is called."
4642 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4643 org-table-last-alignment ""))
4644 (params2
4645 (list
4650 (orgtbl-to-generic table (org-combine-plists params2 params))))
4652 (defun orgtbl-to-html (table params)
4653 "Convert the orgtbl-mode TABLE to HTML.
4654 TABLE is a list, each entry either the symbol `hline' for a horizontal
4655 separator line, or a list of fields for that line.
4656 PARAMS is a property list of parameters that can influence the conversion.
4657 Currently this function recognizes the following parameters:
4659 :splice When set to t, return only table body lines, don't wrap
4660 them into a <table> environment. Default is nil.
4662 The general parameters :skip and :skipcols have already been applied when
4663 this function is called. The function does *not* use `orgtbl-to-generic',
4664 so you cannot specify parameters for it."
4665 (let* ((splicep (plist-get params :splice))
4666 (html-table-tag org-export-html-table-tag)
4667 html)
4668 ;; Just call the formatter we already have
4669 ;; We need to make text lines for it, so put the fields back together.
4670 (setq html (org-format-org-table-html
4671 (mapcar
4672 (lambda (x)
4673 (if (eq x 'hline)
4674 "|----+----|"
4675 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4676 table)
4677 splicep))
4679 (setq html (replace-match "" t t html)))
4680 html))
4682 (defun orgtbl-to-texinfo (table params)
4683 "Convert the orgtbl-mode TABLE to TeXInfo.
4684 TABLE is a list, each entry either the symbol `hline' for a horizontal
4685 separator line, or a list of fields for that line.
4686 PARAMS is a property list of parameters that can influence the conversion.
4687 Supports all parameters from `orgtbl-to-generic'. Most important for
4688 TeXInfo are:
4690 :splice nil/t When set to t, return only table body lines, don't wrap
4691 them into a multitable environment. Default is nil.
4693 :fmt fmt A format to be used to wrap the field, should contain
4694 %s for the original field value. For example, to wrap
4696 This may also be a property list with column numbers and
4698 Each format also may be a function that formats its one
4699 argument.
4702 are computed automatically from the width of the columns
4703 under org-mode.
4705 The general parameters :skip and :skipcols have already been applied when
4706 this function is called."
4707 (let* ((total (float (apply '+ org-table-last-column-widths)))
4708 (colfrac (or (plist-get params :cf)
4709 (mapconcat
4710 (lambda (x) (format "%.3f" (/ (float x) total)))
4711 org-table-last-column-widths " ")))
4712 (params2
4713 (list
4714 :tstart (concat "@multitable @columnfractions " colfrac)
4715 :tend "@end multitable"
4716 :lstart "@item " :lend "" :sep " @tab "
4717 :hlstart "@headitem ")))
4718 (orgtbl-to-generic table (org-combine-plists params2 params))))
4720 (defun orgtbl-to-orgtbl (table params)
4721 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4722 Useful when slicing one table into many. The :hline, :sep,
4723 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4724 and :tend suppress strings without splicing; they can be set to
4725 provide ORGTBL directives for the generated table."
4726 (let* ((params2
4727 (list
4728 :remove-newlines t
4729 :tstart nil :tend nil
4730 :hline "|---"
4731 :sep " | "
4732 :lstart "| "
4733 :lend " |"))
4734 (params (org-combine-plists params2 params)))
4735 (with-temp-buffer
4736 (insert (orgtbl-to-generic table params))
4737 (goto-char (point-min))
4738 (while (re-search-forward org-table-hline-regexp nil t)
4739 (org-table-align))
4740 (buffer-substring 1 (buffer-size)))))
4742 (defun orgtbl-to-table.el (table params)
4743 "Convert the orgtbl-mode TABLE into a table.el table."
4744 (with-temp-buffer
4745 (insert (orgtbl-to-orgtbl table params))
4746 (org-table-align)
4747 (replace-regexp-in-string
4748 "-|" "-+"
4749 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4751 (defun orgtbl-to-unicode (table params)
4752 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4753 You need the ascii-art-to-unicode.el package for this. You can download
4754 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4755 (with-temp-buffer
4756 (insert (orgtbl-to-table.el table params))
4757 (goto-char (point-min))
4758 (if (or (featurep 'ascii-art-to-unicode)
4759 (require 'ascii-art-to-unicode nil t))
4760 (aa2u)
4761 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4762 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4763 "Link to ascii-art-to-unicode.el") org-stored-links))
4764 (error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4765 (buffer-string)))
4767 (defun org-table-get-remote-range (name-or-id form)
4768 "Get a field value or a list of values in a range from table at ID.
4770 NAME-OR-ID may be the name of a table in the current file as set by
4772 will then be used. Alternatively, it may be an ID referring to
4773 any entry, also in a different file. In this case, the first table
4774 in that entry will be referenced.
4778 The return value is either a single string for a single field, or a
4779 list of the fields in the rectangle ."
4780 (save-match-data
4781 (let ((case-fold-search t) (id-loc nil)
4782 ;; Protect a bunch of variables from being overwritten
4783 ;; by the context of the remote table
4784 org-table-column-names org-table-column-name-regexp
4785 org-table-local-parameters org-table-named-field-locations
4786 org-table-current-line-types org-table-current-begin-line
4787 org-table-current-begin-pos org-table-dlines
4788 org-table-current-ncol
4789 org-table-hlines org-table-last-alignment
4790 org-table-last-column-widths org-table-last-alignment
4791 org-table-last-column-widths tbeg
4792 buffer loc)
4793 (setq form (org-table-convert-refs-to-rc form))
4794 (save-excursion
4795 (save-restriction
4796 (widen)
4797 (save-excursion
4798 (goto-char (point-min))
4799 (if (re-search-forward
4801 nil t)
4802 (setq buffer (current-buffer) loc (match-beginning 0))
4803 (setq id-loc (org-id-find name-or-id 'marker))
4804 (unless (and id-loc (markerp id-loc))
4806 (setq buffer (marker-buffer id-loc)
4807 loc (marker-position id-loc))
4808 (move-marker id-loc nil)))
4809 (with-current-buffer buffer
4810 (save-excursion
4811 (save-restriction
4812 (widen)
4813 (goto-char loc)
4814 (forward-char 1)
4816 (not (match-beginning 1)))
4817 (error "Cannot find a table at NAME or ID %s" name-or-id))
4818 (setq tbeg (point-at-bol))
4819 (org-table-get-specials)
4820 (setq form (org-table-formula-substitute-names
4821 (org-table-formula-handle-first/last-rc form)))
4822 (if (and (string-match org-table-range-regexp form)
4823 (> (length (match-string 0 form)) 1))
4824 (save-match-data
4825 (org-table-get-range (match-string 0 form) tbeg 1))
4826 form)))))))))
4828 (provide 'org-table)
4830 ;;; org-table.el ends here