| blob | cbee75c1f1eca0352472449ab5b7a9e701caa44e |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
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: 6.30c
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the table editor and spreadsheet for Org-mode.
31 ;; Watch out: Here we are talking about two different kind of tables.
32 ;; Most of the code is for the tables created with the Org-mode table editor.
33 ;; Sometimes, we talk about tables created and edited with the table.el
34 ;; Emacs package. We call the former org-type tables, and the latter
35 ;; table.el-type tables.
37 ;;; Code:
52 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
53 In the optimized version, the table editor takes over all simple keys that
54 normally just insert a character. In tables, the characters are inserted
55 in a way to minimize disturbing the table structure (i.e. in overwrite mode
56 for empty fields). Outside tables, the correct binding of the keys is
57 restored.
59 The default for this option is t if the optimized version is also used in
60 Org-mode. See the variable `org-enable-table-editor' for details. Changing
61 this variable requires a restart of Emacs to become effective."
67 % END RECEIVE ORGTBL %n
69 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
70 | | |
73 @c END RECEIVE ORGTBL %n
74 @ignore
75 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
76 | | |
79 <!-- END RECEIVE ORGTBL %n -->
80 <!--
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
84 "Templates for radio tables in different major modes.
85 All occurrences of %n in a template will be replaced with the name of the
86 table, obtained by prompting the user."
93 "Settings for tables in Org-mode."
98 "The default size for newly created tables, Columns x Rows."
104 "Regular expression for recognizing numbers in table columns.
105 If a table column contains mostly numbers, it will be aligned to the
106 right. If not, it will be aligned to the left.
108 The default value of this option is a regular expression which allows
109 anything which looks remotely like a number as used in scientific
110 context. For example, all of the following will be considered a
111 number:
112 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
114 Other options offered by the customize interface are more restrictive."
132 "Fraction of numbers in a column required to make the column align right.
133 In a column all non-white fields are considered. If at least this
134 fraction of fields is matched by `org-table-number-fraction',
135 alignment to the right border applies."
140 "Behavior of tables during editing in Org-mode."
145 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
147 removal/insertion."
152 "Non-nil means, automatically blank table field when starting to type into it.
153 This only happens when typing immediately after a field motion
154 command (TAB, S-TAB or RET).
155 Only relevant when `org-enable-table-editor' is equal to `optimized'."
160 "Non-nil means, tab in the last column of a table with jump over a hline.
161 If a horizontal separator line is following the current line,
162 `org-table-next-field' can either create a new row before that line, or jump
163 over the line. When this option is nil, a new line will be created before
164 this line."
169 "Options concerning tables in Org-mode."
174 "Should org-mode work with table references like B3 instead of @3$2?
175 Possible values are:
176 nil never use them
177 from accept as input, do not present for editing
178 t: accept as input and present for editing"
193 calc-angle-mode deg
194 calc-prefer-frac nil
195 calc-symbolic-mode nil
197 calc-display-working-message t
198 )
199 "List with Calc mode settings for use in calc-eval for table formulas.
200 The list must contain alternating symbols (Calc modes variables and values).
201 Don't remove any of the default settings, just change the values. Org-mode
202 relies on the variables to be present in the list."
207 "Non-nil means, TAB and RET evaluate a formula in current table field.
208 If the current field starts with an equal sign, it is assumed to be a formula
209 which should be evaluated as described in the manual and in the documentation
210 string of the command `org-table-eval-formula'. This feature requires the
211 Emacs calc package.
212 When this variable is nil, formula calculation is only available through
218 "Non-nil means, interpret constants in formulas in tables.
219 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
220 by the value given in `org-table-formula-constants', or by a value obtained
221 from the `constants.el' package."
226 "Alist with constant names and values, for use in table formulas.
227 The car of each element is a name of a constant, without the `$' before it.
228 The cdr is the value as a string. For example, if you'd like to use the
229 speed of light in a formula, you would configure
233 and then use it in an equation like `$1*$c'.
235 Constants can also be defined on a per-file basis using a line like
237 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
244 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
245 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
250 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
255 "Non-nil means, reltive formula references may cross hlines.
256 Here are the allowed values:
258 nil Relative references may not cross hlines. They will reference the
259 field next to the hline instead. Coming from below, the reference
260 will be to the field below the hline. Coming from above, it will be
261 to the field above.
262 t Relative references may cros hlines.
263 error An attempt to cross a hline will throw an error.
265 It is probably good to never set this variable to nil, for the sake of
266 portability of tables."
274 "Options concerning table import and export in Org-mode."
279 "Default export parameters for org-table-export. These can be
280 overridden on for a specific table by setting the TABLE_EXPORT_FORMAT
281 property. See the manual section on orgtbl radio tables for the different
282 export transformations and available parameters."
293 "Searching from within a table (any type) this finds the first line
319 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
320 ;; 1 2 3 4 5
335 "Use the table.el package to insert a new table.
336 If there is already a table at point, convert between Org-mode tables
337 and table.el tables."
350 "Convert region to table, or create an empty table.
351 If there is an active region, convert it to a table, using the function
352 `org-table-convert-region'. See the documentation of that function
353 to learn how the prefix argument is interpreted to determine the field
354 separator.
355 If there is no such region, create an empty table with `org-table-create'."
362 "Query for a size and insert a table skeleton.
382 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
386 ;; Insert a hline after the first row.
394 "Convert region to a table.
395 The region goes from BEG0 to END0, but these borders will be moved
396 slightly, to make sure a beginning of line in the first line is included.
398 SEPARATOR specifies the field separator in the lines. It can have the
399 following values:
401 '(4) Use the comma as a field separator
402 '(16) Use a TAB as field separator
403 integer When a number, use that many spaces as field separator
404 nil When nil, the command tries to be smart and figure out the
405 separator in the following way:
406 - when each line contains a TAB, assume TAB-separated material
407 - when each line contains a comma, assume CSV material
408 - else, assume one or more SPACE characters as separator."
412 re)
419 ;; Get the right field separator
441 "Import FILE as a table.
442 The file is assumed to be tab-separated. Such files can be produced by most
443 spreadsheet and database applications. If no tabs (at least one per line)
444 are found, lines will be split on whitespace into fields."
456 "Export table to a file, with configurable format.
457 Such a file can be imported into a spreadsheet program like Excel.
458 FILE can be the output file name. If not given, it will be taken from
459 a TABLE_EXPORT_FILE property in the current entry or higher up in the
460 hierarchy, or the user will be prompted for a file name.
461 FORMAT can be an export format, of the same kind as it used when
462 orgtbl-mode sends a table in a different format. The default format can
463 be found in the variable `org-table-export-default-format', but the function
464 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
465 property, locally or anywhere up in the hierarchy."
482 buf deffmt-readable)
501 "Format: "
506 deffmt-readable)))
519 'hline
522 skipcols i0)))
523 lines))
527 skipcols i0))
530 skipcols i0)))
547 "Marker at the beginning of the table last aligned.
550 "Marker at the end of the table last aligned.
553 "List of flags for flushright alignment, from the last re-alignment.
556 "List of max width of fields in each column.
559 "Non-nil means, debug table formulas.
571 "Align the table at point by aligning all vertical bars."
574 ;; Limits of table
577 ;; Current cursor position
583 column
585 rfmt hfmt
593 emptystrings links dates emph narrow falign falign1 fmax f1 len c e)
596 ;; Check if we have links or dates
605 ;; Make sure the link properties are right
607 ;; Make sure the date properties are right
611 ;; Check if we are narrowing any columns
617 ;; Get the rows
620 ;; Store the indentation of the first line
623 ;; Mark the hlines by setting the corresponding element to nil
624 ;; At the same time, we remove trailing space.
627 nil
630 l)))
631 lines))
632 ;; Get the data fields by splitting the lines.
637 ;; How many fields in the longest line?
644 ;; A list of empty strings to fill any short rows on output
646 ;; Check for special formatting.
650 ;; Check if there is an explicit width specified
659 ;; Find fields that are wider than fmax, and shorten them
665 'help-echo
666 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
674 xx)))))
675 ;; Get the maximum width for each column
677 ;; Get the fraction of numbers, to decide about alignment of the column
683 nil
690 ;; Store the alignment of this table, for later editing of single fields
692 org-table-last-column-widths lengths)
694 ;; With invisible characters, `format' does not get the field width right
695 ;; So we need to make these fields wide by hand.
703 ; (string-match org-bracket-link-regexp (car c))
707 ;; Compute the formats needed for output of the table
720 hfmt))
723 ;; This hack is for org-indent, to force redisplay of the
724 ;; line prefix of the first line. Apparently the redisplay
725 ;; is tied to the newline, which is, I think, a bug.
726 ;; To force this redisplay, we remove and re-insert the
727 ;; newline, so that the redisplay engine thinks it belongs
728 ;; to the changed text.
734 ;; Replace the old one
741 ;; Try to move to the old location
749 ))
760 "Find the beginning of the table and return its position.
761 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
765 org-table-border-regexp)
766 nil t))
773 "Find the end of the table and return its position.
774 With argument TABLE-TYPE, go to the end of a table.el-type table."
778 org-table-border-regexp)
779 nil t))
785 "Justify the current field, text to left, number to right.
786 Optional argument NEW may specify text to replace the current field content."
795 ;; This is not the same table, force a full re-align
801 l f n o e)
824 "Go to the next field in the current table, creating new lines as needed.
825 Before doing so, re-align the table if necessary."
830 org-table-may-need-update)
841 org-table-tab-jumps-over-hlines
853 "Go to the previous field in the table.
854 Before doing so, re-align the table if necessary."
859 org-table-may-need-update)
874 "Move to the end of the current table field.
875 If already at or after the end, move to the end of the next table field.
876 With numeric argument N, move N-1 fields forward first."
889 "Move to the beginning of the current table field.
890 If already at or before the beginning, move to the beginning of the
891 previous field.
892 With numeric argument N, move N-1 fields backward first."
906 "Go to the next row (same column) in the current table.
907 Before doing so, re-align the table if necessary."
915 org-table-may-need-update)
929 "Copy a field down in the current column.
930 If the field at the cursor is empty, copy into it the content of the nearest
931 non-empty field above. With argument N, use the Nth non-empty field.
932 If the current field is not empty, it is copied down to the next row, and
933 the cursor is moved with it. Therefore, repeating this command causes the
934 column to be filled row-by-row.
935 If the variable `org-table-copy-increment' is non-nil and the field is an
936 integer or a timestamp, it will be incremented while copying. In the case of
937 a timestamp, if the cursor is on the year, change the year. If it is on the
938 month or the day, change that. Point will stay on the current date field
939 in order to easily repeat the interval."
947 txt)
959 beg t))
982 "Is point inside a table data field?
983 I.e. not on a hline or before the first or after the last column?
984 This actually throws an error, so it aborts the current command."
995 "Blank the current table field or active region."
1012 "Return the value of the field in column N of current row.
1013 N defaults to current field.
1014 If REPLACE is a string, replace field with this value. The return value
1015 is always the old value."
1025 val)
1029 "Show info about the current field, and highlight any reference at point."
1037 org-table-named-field-locations)))
1050 dline col
1052 dline col ref1
1054 ;; FIXME: formula info not correct if special table line
1064 "Find out which column we are in."
1070 cnt)))
1073 "Find out what table data line we are in.
1074 Only datalines count for this."
1084 cnt)))
1087 "Move the cursor to the Nth column in the current table line.
1088 With optional argument ON-DELIM, stop with point before the left delimiter
1089 of the field.
1090 If there are less than N fields, just go to after the last delimiter.
1091 However, when FORCE is non-nil, create new columns if necessary."
1102 ; (backward-char 2) t)))))
1111 "Insert a new column into the table."
1119 ;; Current cursor position
1125 nil
1137 "Find a dataline in the current table, which is needed for column commands."
1140 t
1151 t
1156 "Delete a column from the table."
1165 ;; Current cursor position
1171 nil
1186 "Move column to the right."
1190 "Move column to the left."
1195 "Move the current column to the right. With arg LEFT, move to the left."
1205 ;; Current cursor position
1215 nil
1232 "Move table row down."
1236 "Move table row up."
1241 "Move the current table line down. With arg UP, move it up."
1250 txt hline2p)
1271 "Insert a new row above the current line into the table.
1272 With prefix ARG, insert below the current line."
1278 ;; Fix the first field if necessary
1290 "Insert a horizontal-line below the current line into the table.
1291 With prefix ABOVE, insert above the current line."
1313 "Insert a hline and move to the row below that line."
1327 In particular, this does handle wide and invisible characters."
1329 ;; It's a hline, just map the characters
1335 t t s)))
1336 s))
1339 "Delete the current row or horizontal line from the table."
1352 "Sort table lines according to the column at point.
1354 The position of point indicates the column to be used for
1355 sorting, and the range of lines is the range between the nearest
1356 horizontal separator lines, or the entire table of no such lines
1357 exist. If point is before the first column, you will be prompted
1358 for the sorting column. If there is an active region, the mark
1359 specifies the first line and the sorting column, while point
1360 should be in the last line to be included into the sorting.
1362 The command then prompts for the sorting type which can be
1363 alphabetically, numerically, or by time (as given in a time stamp
1364 in the field). Sorting in reverse order is also possible.
1366 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1368 If SORTING-TYPE is specified when this function is called from a Lisp
1369 program, no prompting will take place. SORTING-TYPE must be a character,
1370 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1371 should be done in reverse order."
1375 beg end bcol ecol tend tbeg column lns pos)
1420 x))
1433 "Copy region in table to the clipboard and blank all relevant fields.
1434 If there is no active region, use just the field at point."
1441 "Copy rectangular region in table to clipboard.
1442 A special clipboard is used which can only be accessed
1443 with `org-table-paste-rectangle'."
1447 current-prefix-arg))
1449 region cols
1475 org-table-clip))
1478 "Paste a rectangular region into a table.
1479 The upper right corner ends up in the current field. All involved fields
1480 will be overwritten. If the rectangle does not fit into the present table,
1481 the table is enlarged as needed. The process ignores horizontal separator
1482 lines."
1492 c cols field)
1508 "Convert from `org-mode' table to table.el and back.
1509 Obviously, this only works within limits. When an Org-mode table is
1510 converted to table.el, all horizontal separator lines get lost, because
1511 table.el uses these as cell boundaries and has no notion of horizontal lines.
1512 A table.el table can be converted to an Org-mode table only if it does not
1513 do row or column spanning. Multiline cells will become multiple cells.
1514 Beware, Org-mode does not test if the table can be successfully converted - it
1515 blindly applies a recipe that works for simple tables."
1519 ;; convert to Org-mode table
1528 ;; convert to table.el table
1531 ;; first, get rid of all horizontal lines
1535 ;; insert a hline before first
1539 ;; insert a hline after each line
1544 ;; replace "+" at beginning and ending of hlines
1553 "Wrap several fields in a column like a paragraph.
1554 This is useful if you'd like to spread the contents of a field over several
1555 lines, in order to keep the table compact.
1557 If there is an active region, and both point and mark are in the same column,
1558 the text in the column is wrapped to minimum width for the given number of
1559 lines. Generally, this makes the table more compact. A prefix ARG may be
1561 formats the selected text to two lines. If the region was longer than two
1562 lines, the remaining lines remain empty. A negative prefix argument reduces
1563 the current number of lines by that amount. The wrapped text is pasted back
1564 into the table. If you formatted it to more lines than it was before, fields
1565 further down in the table get overwritten - so you might need to make space in
1566 the table first.
1568 If there is no region, the current field is split at the cursor position and
1569 the text fragment to the right of the cursor is prepended to the field one
1570 line down.
1572 If there is no region, but you specify a prefix ARG, the current field gets
1573 blank, and the content is appended to the field above."
1577 ;; There is a region: fill as a paragraph
1581 nlines)
1588 arg)
1592 nil nlines)))
1596 ;; No region, split the current field at point
1600 ;; combine with field above
1610 ;; split field
1623 "Edit table field in a different window.
1624 This is mainly useful for fields that contain hidden parts.
1626 it can be edited in place."
1632 display t intangible t))
1638 p)
1647 intangible t))
1655 "Finish editing a table data field.
1656 Remove all newline characters, insert the result into the table, realign
1657 the table and kill the editing buffer."
1661 text)
1697 "Sum numbers in region of current table column.
1698 The result will be displayed in the echo area, and will be available
1701 If there is an active region, it is interpreted as a rectangle and all
1702 numbers in that rectangle will be summed. If there is no active
1703 region and point is located in a table column, sum all numbers in that
1704 column.
1706 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1707 numbers are assumed to be times as well (in decimal hours) and the
1708 numbers are added as such.
1710 If NLAST is a number, only the NLAST fields will actually be summed."
1737 items1)))
1744 s diff)
1752 sres))))
1775 "Return the formula active for the current field.
1776 Assumes that specials are in place.
1777 If KEY is given, return the key to this formula.
1781 org-table-named-field-locations)))
1795 "Read a formula from the minibuffer, offer stored formula as default.
1796 When NAMED is non-nil, look for a named equation."
1800 org-table-named-field-locations)))
1807 name
1808 ref)
1818 stored)
1820 equation)
1827 scol))
1829 'org-table-formula-history
1830 )))))
1831 mustsave)
1833 ;; remove formula
1840 ;; We set the column equation, delete the named one.
1842 mustsave t))
1848 eq))
1851 "Store the list of formulas below the current table."
1857 ;; don't overwrite TBLFM, we might use text properties to store stuff
1878 "Compare two formulas for sorting."
1884 "Return an alist with the stored formulas directly after current table."
1892 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1909 "Modify the equations after the table structure has been edited.
1911 For all numbers larger than LIMIT, shift them by DELTA."
1922 s n a)
1935 t t)))))))))
1938 "Get the column names and local parameters for this table."
1941 names name fields fields1 field cnt
1942 c v l line col types dlines hlines last-dline)
1944 org-table-local-parameters nil
1945 org-table-named-field-locations nil
1946 org-table-current-begin-line nil
1947 org-table-current-begin-pos nil
1948 org-table-current-line-types nil)
1966 org-table-local-parameters))))
1982 ;; Analyse the line types
1986 l org-table-current-begin-line)
2003 al al2)
2015 If yes, store the formula and apply it."
2016 ;; We already know we are in a table. Get field will only return a formula
2017 ;; when appropriate. It might return a separator line, but no problem.
2020 named eq)
2031 "List of commands triggering the recalculation of a line.
2044 "Rotate the recalculation mark in the first column.
2045 If in any row, the first field is not consistent with a mark,
2046 insert a new column for the markers.
2047 When there is an active region, change all the lines in the region,
2048 after prompting for the marking character.
2049 After each change, a message will be displayed indicating the meaning
2050 of the new mark."
2065 epos new)
2072 newchar))
2104 "Recompute the current line if marked for it, and if we haven't just done it."
2124 modes)
2127 suppress-align suppress-const
2128 suppress-store suppress-analysis)
2129 "Replace the table field value at the cursor by the result of a calculation.
2131 This function makes use of Dave Gillespie's Calc package, in my view the
2132 most exciting program ever written for GNU Emacs. So you need to have Calc
2133 installed in order to use this function.
2135 In a table, this command replaces the value in the current field with the
2137 formula, by storing it in a special line below the table. When called
2138 with a `C-u' prefix, the current field must ba a named field, and the
2139 formula is installed as valid in only this specific field.
2141 When called with two `C-u' prefixes, insert the active equation
2142 for the field back into the current field, so that it can be
2144 to check the referenced fields.
2146 When called, the command first prompts for a formula, which is read in
2147 the minibuffer. Previously entered formulas are available through the
2148 history list, and the last used formula is offered as a default.
2149 These stored formulas are adapted correctly when moving, inserting, or
2150 deleting columns with the corresponding commands.
2152 The formula can be any algebraic expression understood by the Calc package.
2153 For details, see the Org-mode manual.
2155 This function can also be called from Lisp programs and offers
2156 additional arguments: EQUATION can be the formula to apply. If this
2157 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2158 used to speed-up recursive calls by by-passing unnecessary aligns.
2159 SUPPRESS-CONST suppresses the interpretation of constants in the
2160 formula, assuming that this has been done already outside the function.
2161 SUPPRESS-STORE means the formula should not be stored, either because
2162 it is already stored, or because it is a modified equation that should
2163 not overwrite the stored one."
2179 equation
2185 n form form0 bw fmt x ev orig c lispp literal)
2186 ;; Parse the format string. Since we have a lot of modes, this is
2187 ;; a lot of work. However, I think calc still uses most of the time.
2199 'calc-float-format
2202 n))))
2229 fields)))
2234 ;; Check for old vertical references
2236 ;; Insert remote references
2244 keep-empty numbers lispp))
2245 t t form)))
2246 ;; Insert complex ranges
2254 keep-empty numbers lispp))
2255 t t form)))
2256 ;; Insert simple ranges
2265 keep-empty numbers lispp))
2266 t t form)))
2268 ;; Insert the references to fields in same row
2277 t t form)))
2292 Orig: %s
2293 $xyz-> %s
2294 @r$c-> %s
2325 prop value)))
2328 "Get a calc vector from a column, according to descriptor DESC.
2329 Optional arguments TBEG and COL can give the beginning of the table and
2330 the current column, to avoid unnecessary parsing.
2331 HIGHLIGHT means, just highlight the range."
2338 beg end c1 c2 r1 r2 rangep tmp)
2355 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2361 ;; just one field
2368 ;; A range, return a vector
2369 ;; First sort the numbers to get a regular ractangle
2385 ;; return string representation of calc vector
2390 "Analyze descriptor DESC and retrieve the corresponding line number.
2391 The cursor is currently in line CLINE, the table begins in line BLINE,
2392 and TABLE is a vector with line types."
2400 ;; 1 2 3 4 5 6
2420 nil hn cline desc)))
2423 rel on cline desc)))
2427 "FIXME: Needs more documentation."
2440 nil))
2441 t)))
2445 desc cline)
2446 i)))
2451 s))
2454 "Convert list ELEMENTS to something appropriate to insert into formula.
2455 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2456 NUMBERS indicates that everything should be converted to numbers.
2457 LISPP means to return something appropriate for a Lisp list."
2461 elements
2470 elements))))
2476 x
2482 elements
2486 "Recalculate the current table line by applying all stored formulas.
2487 With prefix arg ALL, do this for all lines in the table.
2488 With the prefix argument ALL is `(16)' (a double `C-c C-u' prefix), or if
2489 it is the symbol `iterate', recompute the table until it no longer changes.
2490 If NOALIGN is not nil, do not re-align the table after the computations
2491 are done. This is typically used internally to save time, if it is
2492 known that the table will be realigned a little later anyway."
2507 ;; Insert constants in all formulas
2511 x)
2512 eqlist))
2513 ;; Split the equation list
2524 ;; This is a table with marked lines, compute selected lines
2526 ;; Move forward to the first non-header line
2537 ;; First find the named fields, and mark them untouchable
2549 name)))
2558 ;; Now evauluate the column formulas, but skip fields covered by
2559 ;; field formulas
2563 ;; Unprotected line, recalculate
2575 ;; Now evaluate the field formulas
2589 ;; back to initial position
2597 "Recalculate the table until it does not change anymore."
2602 thistbl)
2617 "Replace $const with values in string F."
2619 ;; First, check for column names
2624 ;; Parameters and constants
2626 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2636 f))
2639 "Find the value for a parameter or constant in a formula.
2640 Parameters get priority."
2670 map))
2677 "--"
2680 "--"
2681 "Shift Reference at Point"
2686 "-"
2687 "Change Test Row for Column Formulas"
2690 "--"
2695 org-table-overlay-coordinates)]
2696 "--"
2703 "Edit the formulas of the current table in a separate buffer."
2718 entry s type title)
2721 ;; Keep global-font-lock-mode from turning on font-lock-mode
2760 "Convert a formula from internal to user representation."
2763 s))
2766 "Convert a formula from user to internal representation."
2769 s))
2772 "Convert spreadsheet references from AB7 to @7$28.
2773 Works for single references, but also for entire formulas and even the
2774 full TBLFM line."
2776 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2779 ;; format match, just advance
2784 ;; 3.e5 or something like this.
2794 t t s)))))
2795 s))
2798 "Convert spreadsheet references from to @7$28 to AB7.
2799 Works for single references, but also for entire formulas and even the
2800 full TBLFM line."
2807 t t s)))
2812 t nil s)))
2813 s)
2816 "Convert a base 26 number represented by letters into an integer.
2817 For example: AB -> 28."
2823 n))
2826 "Convert an integer into a base 26 number represented by letters.
2827 For example: 28 -> AB."
2832 s))
2835 "Convert all references in this buffer, using FUNCTION."
2845 "Convert all references in the buffer from B3 to @3$2 and back."
2855 "Shift the reference at point one row/hline up."
2859 "Shift the reference at point one row/hline down."
2863 "Shift the reference at point one field to the left."
2867 "Shift the reference at point one field to the right."
2878 ;; A B3-like reference
2884 ;; An internal reference
2890 "Re-match the group N, and replace it with the shifted refrence."
2895 t t)))
2898 "Shift a refrence part REF.
2899 If DECR is set, decrease the references row/column, else increase.
2900 If HLINE is set, this may be a hline reference, it certainly is not
2901 a translation reference."
2930 "Toggle the display of coordinates in the referenced table."
2939 "Parse the buffer for formula definitions and install them.
2940 With prefix ARG, apply the new formulas to the table."
2951 nil t)
2975 "Abort editing formulas, without installing the changes."
2986 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3027 "Show the location/value of the $ expression at point."
3036 var name e what match dest)
3118 ;; column number
3146 org-table-fedit-scroll-down))))
3157 "Make sure the cursor is in a dataline in a table."
3166 p1 p2)))
3171 "Move cursor one line up in the window showing the table."
3176 "Move cursor one line down in the window showing the table."
3181 "Move the cursor in the window showing the table.
3182 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3207 "Add a new overlay."
3213 "Highlight rectangular region in a table."
3217 l1 c1 l2 c2 tmp)
3241 "Remove the rectangle overlays."
3252 "Add overlays to the table at point, to show row/column coordinates."
3281 "Toggle the display of Row/Column numbers in tables."
3293 "Toggle the formula debugger in tables."
3299 ;;; The orgtbl minor mode
3301 ;; Define a minor mode which can be used in other modes in order to
3302 ;; integrate the org-mode table editor.
3304 ;; This is really a hack, because the org-mode table editor uses several
3305 ;; keys which normally belong to the major mode, for example the TAB and
3306 ;; RET keys. Here is how it works: The minor mode defines all the keys
3307 ;; necessary to operate the table editor, but wraps the commands into a
3308 ;; function which tests if the cursor is currently inside a table. If that
3309 ;; is the case, the table editor command is executed. However, when any of
3310 ;; those keys is used outside a table, the function uses `key-binding' to
3311 ;; look up if the key has an associated command in another currently active
3312 ;; keymap (minor modes, major mode, global), and executes that command.
3313 ;; There might be problems if any of the keys used by the table editor is
3314 ;; otherwise used as a prefix key.
3316 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3317 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3318 ;; addresses this by checking explicitly for both bindings.
3320 ;; The optimized version (see variable `orgtbl-optimized') takes over
3321 ;; all keys which are bound to `self-insert-command' in the *global map*.
3322 ;; Some modes bind other commands to simple characters, for example
3323 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3324 ;; active, this binding is ignored inside tables and replaced with a
3325 ;; modified self-insert.
3328 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
3335 ;;;###autoload
3337 "Unconditionally turn on `orgtbl-mode'."
3351 ;;;###autoload
3353 "The `org-mode' table editor as a minor mode for use in other modes."
3357 ;; Exit without error, in case some hook functions calls this
3358 ;; by accident in org-mode.
3365 ;; Make sure we are first in minor-mode-map-alist
3373 auto-fill-inhibit-regexp)
3377 auto-fill-inhibit-regexp)
3378 orgtbl-line-start-regexp))
3396 "Remove all properties related to narrow-column invisibility."
3408 ;; Install it as a minor mode.
3414 "Create a function for binding in the table minor mode.
3415 FUN is the command to call inside a table. N is used to create a unique
3416 command name. KEYS are keys that should be checked in for a command
3417 to execute outside of tables."
3423 "Outside of tables, run the binding of `"
3435 keys)
3439 "Error when there is no default binding for a table key."
3444 "Setup orgtbl keymaps."
3475 elt key fun cmd)
3483 ;; Special treatment needed for TAB and RET
3501 [(tab)] "\C-i"))
3503 (org-defkey orgtbl-mode-map [backtab]
3505 [backtab] [S-iso-lefttab] [(shift tab)]
3506 [(tab)] "\C-i"))
3508 (org-defkey orgtbl-mode-map "\M-\C-m"
3509 (orgtbl-make-binding 'org-table-wrap-region 105
3510 "\M-\C-m" [(meta return)]))
3511 (org-defkey orgtbl-mode-map [(meta return)]
3512 (orgtbl-make-binding 'org-table-wrap-region 106
3513 [(meta return)] "\M-\C-m"))
3515 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3516 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3518 (when orgtbl-optimized
3519 ;; If the user wants maximum table support, we need to hijack
3520 ;; some standard editing functions
3521 (org-remap orgtbl-mode-map
3522 'self-insert-command 'orgtbl-self-insert-command
3523 'delete-char 'org-delete-char
3524 'delete-backward-char 'org-delete-backward-char)
3525 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3526 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3527 '("OrgTbl"
3528 ["Create or convert" org-table-create-or-convert-from-region
3529 :active (not (org-at-table-p)) :keys "C-c |" ]
3530 "--"
3531 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3532 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3533 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3534 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3535 "--"
3536 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3537 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3538 ["Copy Field from Above"
3539 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3540 "--"
3541 ("Column"
3542 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3543 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3544 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3545 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3546 ("Row"
3547 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3548 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3549 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3550 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3551 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3552 "--"
3553 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3554 ("Rectangle"
3555 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3556 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3557 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3558 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3559 "--"
3560 ("Radio tables"
3561 ["Insert table template" orgtbl-insert-radio-table
3562 (assq major-mode orgtbl-radio-table-templates)]
3563 ["Comment/uncomment table" orgtbl-toggle-comment t])
3564 "--"
3565 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3566 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3567 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3568 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3569 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3570 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3571 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3572 ["Sum Column/Rectangle" org-table-sum
3573 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3574 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3575 ["Debug Formulas"
3576 org-table-toggle-formula-debugger :active (org-at-table-p)
3577 :keys "C-c {"
3578 :style toggle :selected org-table-formula-debug]
3579 ["Show Col/Row Numbers"
3580 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3581 :keys "C-c }"
3582 :style toggle :selected org-table-overlay-coordinates]
3583 ))
3584 t))
3586 (defun orgtbl-ctrl-c-ctrl-c (arg)
3587 "If the cursor is inside a table, realign the table.
3588 If it is a table to be sent away to a receiver, do it.
3589 With prefix arg, also recompute table."
3590 (interactive "P")
3591 (let ((pos (point)) action)
3592 (save-excursion
3593 (beginning-of-line 1)
3597 (cond
3598 ((integerp action)
3599 (goto-char action)
3600 (org-table-maybe-eval-formula)
3601 (if arg
3602 (call-interactively 'org-table-recalculate)
3603 (org-table-maybe-recalculate-line))
3604 (call-interactively 'org-table-align)
3605 (orgtbl-send-table 'maybe))
3606 ((eq action 'recalc)
3607 (save-excursion
3608 (beginning-of-line 1)
3610 (if (org-at-table-p)
3611 (org-call-with-arg 'org-table-recalculate t))))
3612 (t (let (orgtbl-mode)
3613 (call-interactively (key-binding "\C-c\C-c")))))))
3615 (defun orgtbl-create-or-convert-from-region (arg)
3616 "Create table or convert region to table, if no conflicting binding.
3617 This installs the table binding `C-c |', but only if there is no
3618 conflicting binding to this key outside orgtbl-mode."
3619 (interactive "P")
3620 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3621 (if cmd
3622 (call-interactively cmd)
3623 (call-interactively 'org-table-create-or-convert-from-region))))
3625 (defun orgtbl-tab (arg)
3626 "Justification and field motion for `orgtbl-mode'."
3627 (interactive "P")
3628 (if arg (org-table-edit-field t)
3629 (org-table-justify-field-maybe)
3630 (org-table-next-field)))
3632 (defun orgtbl-ret ()
3633 "Justification and field motion for `orgtbl-mode'."
3634 (interactive)
3635 (if (bobp)
3636 (newline)
3637 (org-table-justify-field-maybe)
3638 (org-table-next-row)))
3640 (defun orgtbl-self-insert-command (N)
3641 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3642 If the cursor is in a table looking at whitespace, the whitespace is
3643 overwritten, and the table is not marked as requiring realignment."
3644 (interactive "p")
3645 (if (and (org-at-table-p)
3646 (or
3647 (and org-table-auto-blank-field
3648 (member last-command
3649 '(orgtbl-hijacker-command-100
3650 orgtbl-hijacker-command-101
3651 orgtbl-hijacker-command-102
3652 orgtbl-hijacker-command-103
3653 orgtbl-hijacker-command-104
3654 orgtbl-hijacker-command-105
3655 yas/expand))
3656 (org-table-blank-field))
3657 t)
3658 (eq N 1)
3660 (let (org-table-may-need-update)
3661 (goto-char (1- (match-end 0)))
3662 (delete-backward-char 1)
3663 (goto-char (match-beginning 0))
3664 (self-insert-command N))
3665 (setq org-table-may-need-update t)
3666 (let* (orgtbl-mode
3667 a
3668 (cmd (or (key-binding
3669 (or (and (listp function-key-map)
3670 (setq a (assoc last-input-event function-key-map))
3671 (cdr a))
3672 (vector last-input-event)))
3673 'self-insert-command)))
3674 (call-interactively cmd)
3675 (if (and org-self-insert-cluster-for-undo
3676 (eq cmd 'self-insert-command))
3677 (if (not (eq last-command 'orgtbl-self-insert-command))
3678 (setq org-self-insert-command-undo-counter 1)
3679 (if (>= org-self-insert-command-undo-counter 20)
3680 (setq org-self-insert-command-undo-counter 1)
3681 (and (> org-self-insert-command-undo-counter 0)
3682 buffer-undo-list
3683 (not (cadr buffer-undo-list)) ; remove nil entry
3684 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3685 (setq org-self-insert-command-undo-counter
3686 (1+ org-self-insert-command-undo-counter))))))))
3689 "Regular expression matching exponentials as produced by calc.")
3691 (defun orgtbl-export (table target)
3692 (require 'org-exp)
3693 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3695 org-table-last-alignment org-table-last-column-widths
3696 maxcol column)
3697 (if (not (fboundp func))
3698 (error "Cannot export orgtbl table to %s" target))
3699 (setq lines (org-table-clean-before-export lines))
3700 (setq table
3701 (mapcar
3702 (lambda (x)
3703 (if (string-match org-table-hline-regexp x)
3704 'hline
3706 lines))
3707 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3708 table)))
3709 (loop for i from (1- maxcol) downto 0 do
3710 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3711 (setq column (delq nil column))
3712 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3713 (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))
3714 (funcall func table nil)))
3716 (defun orgtbl-gather-send-defs ()
3717 "Gathers a plist of :name, :transform, :params for each destination before
3718 a radio table."
3719 (save-excursion
3720 (goto-char (org-table-begin))
3721 (let (rtn)
3722 (beginning-of-line 0)
3723 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
3724 (let ((name (org-no-properties (match-string 1)))
3725 (transform (intern (match-string 2)))
3726 (params (if (match-end 3)
3727 (read (concat "(" (match-string 3) ")")))))
3728 (push (list :name name :transform transform :params params)
3729 rtn)
3730 (beginning-of-line 0)))
3731 rtn)))
3733 (defun orgtbl-send-replace-tbl (name txt)
3734 "Find and replace table NAME with TXT."
3735 (save-excursion
3736 (goto-char (point-min))
3737 (unless (re-search-forward
3739 (error "Don't know where to insert translated table"))
3740 (goto-char (match-beginning 0))
3741 (beginning-of-line 2)
3742 (save-excursion
3743 (let ((beg (point)))
3744 (unless (re-search-forward
3745 (concat "END RECEIVE ORGTBL +" name) nil t)
3746 (error "Cannot find end of insertion region"))
3747 (beginning-of-line 1)
3748 (delete-region beg (point))))
3751 ;;;###autoload
3752 (defun org-table-to-lisp (&optional txt)
3753 "Convert the table at point to a Lisp structure.
3754 The structure will be a list. Each item is either the symbol `hline'
3755 for a horizontal separator line, or a list of field values as strings.
3756 The table is taken from the parameter TXT, or from the buffer at point."
3757 (unless txt
3758 (unless (org-at-table-p)
3759 (error "No table at point")))
3760 (let* ((txt (or txt
3761 (buffer-substring-no-properties (org-table-begin)
3762 (org-table-end))))
3765 (mapcar
3766 (lambda (x)
3767 (if (string-match org-table-hline-regexp x)
3768 'hline
3770 lines)))
3772 (defun orgtbl-send-table (&optional maybe)
3773 "Send a transformed version of this table to the receiver position.
3774 With argument MAYBE, fail quietly if no transformation is defined for
3775 this table."
3776 (interactive)
3777 (catch 'exit
3778 (unless (org-at-table-p) (error "Not at a table"))
3779 ;; when non-interactive, we assume align has just happened.
3780 (when (interactive-p) (org-table-align))
3781 (let ((dests (orgtbl-gather-send-defs))
3782 (txt (buffer-substring-no-properties (org-table-begin)
3783 (org-table-end)))
3784 (ntbl 0))
3785 (unless dests (if maybe (throw 'exit nil)
3786 (error "Don't know how to transform this table.")))
3787 (dolist (dest dests)
3788 (let* ((name (plist-get dest :name))
3789 (transform (plist-get dest :transform))
3790 (params (plist-get dest :params))
3791 (skip (plist-get params :skip))
3792 (skipcols (plist-get params :skipcols))
3793 beg
3794 (lines (org-table-clean-before-export
3795 (nthcdr (or skip 0)
3797 (i0 (if org-table-clean-did-remove-column 2 1))
3798 (table (mapcar
3799 (lambda (x)
3800 (if (string-match org-table-hline-regexp x)
3801 'hline
3802 (org-remove-by-index
3804 skipcols i0)))
3805 lines))
3806 (fun (if (= i0 2) 'cdr 'identity))
3807 (org-table-last-alignment
3808 (org-remove-by-index (funcall fun org-table-last-alignment)
3809 skipcols i0))
3810 (org-table-last-column-widths
3811 (org-remove-by-index (funcall fun org-table-last-column-widths)
3812 skipcols i0))
3813 (txt (if (fboundp transform)
3814 (funcall transform table params)
3815 (error "No such transformation function %s" transform))))
3816 (orgtbl-send-replace-tbl name txt))
3817 (setq ntbl (1+ ntbl)))
3818 (message "Table converted and installed at %d receiver location%s"
3819 ntbl (if (> ntbl 1) "s" "")))))
3821 (defun org-remove-by-index (list indices &optional i0)
3822 "Remove the elements in LIST with indices in INDICES.
3823 First element has index 0, or I0 if given."
3824 (if (not indices)
3825 list
3826 (if (integerp indices) (setq indices (list indices)))
3827 (setq i0 (1- (or i0 0)))
3828 (delq :rm (mapcar (lambda (x)
3829 (setq i0 (1+ i0))
3830 (if (memq i0 indices) :rm x))
3831 list))))
3833 (defun orgtbl-toggle-comment ()
3834 "Comment or uncomment the orgtbl at point."
3835 (interactive)
3836 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3837 (re2 (concat "^" orgtbl-line-start-regexp))
3838 (commented (save-excursion (beginning-of-line 1)
3839 (cond ((looking-at re1) t)
3840 ((looking-at re2) nil)
3841 (t (error "Not at an org table")))))
3842 (re (if commented re1 re2))
3843 beg end)
3844 (save-excursion
3845 (beginning-of-line 1)
3846 (while (looking-at re) (beginning-of-line 0))
3847 (beginning-of-line 2)
3848 (setq beg (point))
3849 (while (looking-at re) (beginning-of-line 2))
3850 (setq end (point)))
3851 (comment-region beg end (if commented '(4) nil))))
3853 (defun orgtbl-insert-radio-table ()
3854 "Insert a radio table template appropriate for this major mode."
3855 (interactive)
3856 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3857 (txt (nth 1 e))
3858 name pos)
3859 (unless e (error "No radio table setup defined for %s" major-mode))
3860 (setq name (read-string "Table name: "))
3861 (while (string-match "%n" txt)
3862 (setq txt (replace-match name t t txt)))
3864 (setq pos (point))
3865 (insert txt)
3866 (goto-char pos)))
3868 ;; Dynamically bound input and output for table formatting.
3869 (defvar *orgtbl-table* nil
3870 "Carries the current table through formatting routines.")
3871 (defvar *orgtbl-rtn* nil
3872 "Formatting routines push the output lines here.")
3873 ;; Formatting parameters for the current table section.
3874 (defvar *orgtbl-hline* nil "Text used for horizontal lines")
3875 (defvar *orgtbl-sep* nil "Text used as a column separator")
3876 (defvar *orgtbl-default-fmt* nil "Default format for each entry")
3877 (defvar *orgtbl-fmt* nil "Format for each entry")
3878 (defvar *orgtbl-efmt* nil "Format for numbers")
3879 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt")
3880 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row")
3881 (defvar *orgtbl-lstart* nil "Text starting a row")
3882 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row")
3883 (defvar *orgtbl-lend* nil "Text ending a row")
3884 (defvar *orgtbl-llend* nil "Specializes lend for the last row")
3886 (defsubst orgtbl-get-fmt (fmt i)
3887 "Retrieve the format from FMT corresponding to the Ith column."
3888 (if (and (not (functionp fmt)) (consp fmt))
3889 (plist-get fmt i)
3890 fmt))
3892 (defsubst orgtbl-apply-fmt (fmt &rest args)
3893 "Apply format FMT to the arguments. NIL FMTs return the first argument."
3894 (cond ((functionp fmt) (apply fmt args))
3895 (fmt (apply 'format fmt args))
3896 (args (car args))
3897 (t args)))
3899 (defsubst orgtbl-eval-str (str)
3900 "If STR is a function, evaluate it with no arguments."
3901 (if (functionp str)
3902 (funcall str)
3903 str))
3905 (defun orgtbl-format-line (line)
3906 "Format LINE as a table row."
3907 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
3908 (let* ((i 0)
3909 (line
3910 (mapcar
3911 (lambda (f)
3912 (setq i (1+ i))
3913 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
3914 (f (if (and efmt (string-match orgtbl-exp-regexp f))
3915 (orgtbl-apply-fmt efmt (match-string 1 f)
3916 (match-string 2 f))
3917 f)))
3918 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
3919 *orgtbl-default-fmt*)
3920 f)))
3921 line)))
3922 (push (if *orgtbl-lfmt*
3923 (orgtbl-apply-fmt *orgtbl-lfmt* line)
3924 (concat (orgtbl-eval-str *orgtbl-lstart*)
3925 (mapconcat 'identity line *orgtbl-sep*)
3926 (orgtbl-eval-str *orgtbl-lend*)))
3927 *orgtbl-rtn*))))
3929 (defun orgtbl-format-section (section-stopper)
3930 "Format lines until the first occurrence of SECTION-STOPPER."
3931 (let (prevline)
3932 (progn
3933 (while (not (eq (car *orgtbl-table*) section-stopper))
3934 (if prevline (orgtbl-format-line prevline))
3935 (setq prevline (pop *orgtbl-table*)))
3936 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
3937 (*orgtbl-lend* *orgtbl-llend*)
3938 (*orgtbl-lfmt* *orgtbl-llfmt*))
3939 (orgtbl-format-line prevline))))))
3941 (defun orgtbl-to-generic (table params)
3942 "Convert the orgtbl-mode TABLE to some other format.
3943 This generic routine can be used for many standard cases.
3944 TABLE is a list, each entry either the symbol `hline' for a horizontal
3945 separator line, or a list of fields for that line.
3946 PARAMS is a property list of parameters that can influence the conversion.
3947 For the generic converter, some parameters are obligatory: You need to
3948 specify either :lfmt, or all of (:lstart :lend :sep).
3950 Valid parameters are
3952 :splice When set to t, return only table body lines, don't wrap
3953 them into :tstart and :tend. Default is nil. When :splice
3954 is non-nil, this also means that the exporter should not look
3955 for and interpret header and footer sections.
3957 :hline String to be inserted on horizontal separation lines.
3958 May be nil to ignore hlines.
3960 :sep Separator between two fields
3961 :remove-nil-lines Do not include lines that evaluate to nil.
3964 Each in the following group may be either a string or a function
3965 of no arguments returning a string:
3966 :tstart String to start the table. Ignored when :splice is t.
3967 :tend String to end the table. Ignored when :splice is t.
3968 :lstart String to start a new table line.
3969 :llstart String to start the last table line, defaults to :lstart.
3970 :lend String to end a table line
3971 :llend String to end the last table line, defaults to :lend.
3973 Each in the following group may be a string, a function of one
3974 argument (the field or line) returning a string, or a plist
3975 mapping columns to either of the above:
3976 :lfmt Format for entire line, with enough %s to capture all fields.
3977 If this is present, :lstart, :lend, and :sep are ignored.
3978 :llfmt Format for the entire last line, defaults to :lfmt.
3979 :fmt A format to be used to wrap the field, should contain
3980 %s for the original field value. For example, to wrap
3982 This may also be a property list with column numbers and
3985 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
3986 Same as above, specific for the header lines in the table.
3987 All lines before the first hline are treated as header.
3988 If any of these is not present, the data line value is used.
3990 This may be either a string or a function of two arguments:
3991 :efmt Use this format to print numbers with exponentials.
3992 The format should have %s twice for inserting mantissa
3994 may also be a property list with column numbers and
3995 formats. :fmt will still be applied after :efmt.
3997 In addition to this, the parameters :skip and :skipcols are always handled
3998 directly by `orgtbl-send-table'. See manual."
3999 (interactive)
4001 (let* ((splicep (plist-get params :splice))
4002 (hline (plist-get params :hline))
4003 (remove-nil-linesp (plist-get params :remove-nil-lines))
4004 (*orgtbl-hline* hline)
4005 (*orgtbl-table* table)
4006 (*orgtbl-sep* (plist-get params :sep))
4007 (*orgtbl-efmt* (plist-get params :efmt))
4008 (*orgtbl-lstart* (plist-get params :lstart))
4009 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4010 (*orgtbl-lend* (plist-get params :lend))
4011 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4012 (*orgtbl-lfmt* (plist-get params :lfmt))
4013 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4014 (*orgtbl-fmt* (plist-get params :fmt))
4015 *orgtbl-rtn*)
4017 ;; Put header
4018 (unless splicep
4019 (when (plist-member params :tstart)
4020 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4021 (if tstart (push tstart *orgtbl-rtn*)))))
4023 ;; Do we have a heading section? If so, format it and handle the
4024 ;; trailing hline.
4025 (if (and (not splicep)
4026 (or (consp (car *orgtbl-table*))
4027 (consp (nth 1 *orgtbl-table*)))
4028 (memq 'hline (cdr *orgtbl-table*)))
4029 (progn
4030 (when (eq 'hline (car *orgtbl-table*))
4031 ;; there is a hline before the first data line
4032 (and hline (push hline *orgtbl-rtn*))
4033 (pop *orgtbl-table*))
4034 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4035 *orgtbl-lstart*))
4036 (*orgtbl-llstart* (or (plist-get params :hllstart)
4037 *orgtbl-llstart*))
4038 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4039 (*orgtbl-llend* (or (plist-get params :hllend)
4040 (plist-get params :hlend) *orgtbl-llend*))
4041 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4042 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4043 (plist-get params :hlfmt) *orgtbl-llfmt*))
4044 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4045 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4046 (orgtbl-format-section 'hline))
4047 (if hline (push hline *orgtbl-rtn*))
4048 (pop *orgtbl-table*)))
4050 ;; Now format the main section.
4051 (orgtbl-format-section nil)
4053 (unless splicep
4054 (when (plist-member params :tend)
4055 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4056 (if tend (push tend *orgtbl-rtn*)))))
4058 (mapconcat 'identity (nreverse (if remove-nil-linesp
4059 (remq nil *orgtbl-rtn*)
4062 (defun orgtbl-to-tsv (table params)
4063 "Convert the orgtbl-mode table to TAB separated material."
4065 (defun orgtbl-to-csv (table params)
4066 "Convert the orgtbl-mode table to CSV material.
4067 This does take care of the proper quoting of fields with comma or quotes."
4068 (orgtbl-to-generic table (org-combine-plists
4069 '(:sep "," :fmt org-quote-csv-field)
4070 params)))
4072 (defun orgtbl-to-latex (table params)
4073 "Convert the orgtbl-mode TABLE to LaTeX.
4074 TABLE is a list, each entry either the symbol `hline' for a horizontal
4075 separator line, or a list of fields for that line.
4076 PARAMS is a property list of parameters that can influence the conversion.
4077 Supports all parameters from `orgtbl-to-generic'. Most important for
4078 LaTeX are:
4080 :splice When set to t, return only table body lines, don't wrap
4081 them into a tabular environment. Default is nil.
4083 :fmt A format to be used to wrap the field, should contain %s for the
4084 original field value. For example, to wrap everything in dollars,
4087 The format may also be a function that formats its one argument.
4089 :efmt Format for transforming numbers with exponentials. The format
4090 should have %s twice for inserting mantissa and exponent, for
4092 This may also be a property list with column numbers and formats.
4093 The format may also be a function that formats its two arguments.
4095 :llend If you find too much space below the last line of a table,
4098 The general parameters :skip and :skipcols have already been applied when
4099 this function is called."
4100 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4101 org-table-last-alignment ""))
4102 (params2
4103 (list
4108 (orgtbl-to-generic table (org-combine-plists params2 params))))
4110 (defun orgtbl-to-html (table params)
4111 "Convert the orgtbl-mode TABLE to LaTeX.
4112 TABLE is a list, each entry either the symbol `hline' for a horizontal
4113 separator line, or a list of fields for that line.
4114 PARAMS is a property list of parameters that can influence the conversion.
4115 Currently this function recognizes the following parameters:
4117 :splice When set to t, return only table body lines, don't wrap
4118 them into a <table> environment. Default is nil.
4120 The general parameters :skip and :skipcols have already been applied when
4121 this function is called. The function does *not* use `orgtbl-to-generic',
4122 so you cannot specify parameters for it."
4123 (let* ((splicep (plist-get params :splice))
4124 (html-table-tag org-export-html-table-tag)
4125 html)
4126 ;; Just call the formatter we already have
4127 ;; We need to make text lines for it, so put the fields back together.
4128 (setq html (org-format-org-table-html
4129 (mapcar
4130 (lambda (x)
4131 (if (eq x 'hline)
4132 "|----+----|"
4133 (concat "| " (mapconcat 'identity x " | ") " |")))
4134 table)
4135 splicep))
4137 (setq html (replace-match "" t t html)))
4138 html))
4140 (defun orgtbl-to-texinfo (table params)
4141 "Convert the orgtbl-mode TABLE to TeXInfo.
4142 TABLE is a list, each entry either the symbol `hline' for a horizontal
4143 separator line, or a list of fields for that line.
4144 PARAMS is a property list of parameters that can influence the conversion.
4145 Supports all parameters from `orgtbl-to-generic'. Most important for
4146 TeXInfo are:
4148 :splice nil/t When set to t, return only table body lines, don't wrap
4149 them into a multitable environment. Default is nil.
4151 :fmt fmt A format to be used to wrap the field, should contain
4152 %s for the original field value. For example, to wrap
4154 This may also be a property list with column numbers and
4156 Each format also may be a function that formats its one
4157 argument.
4160 are computed automatically from the width of the columns
4161 under org-mode.
4163 The general parameters :skip and :skipcols have already been applied when
4164 this function is called."
4165 (let* ((total (float (apply '+ org-table-last-column-widths)))
4166 (colfrac (or (plist-get params :cf)
4167 (mapconcat
4168 (lambda (x) (format "%.3f" (/ (float x) total)))
4169 org-table-last-column-widths " ")))
4170 (params2
4171 (list
4172 :tstart (concat "@multitable @columnfractions " colfrac)
4173 :tend "@end multitable"
4174 :lstart "@item " :lend "" :sep " @tab "
4175 :hlstart "@headitem ")))
4176 (orgtbl-to-generic table (org-combine-plists params2 params))))
4178 (defun orgtbl-to-orgtbl (table params)
4179 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4180 Useful when slicing one table into many. The :hline, :sep,
4181 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4182 and :tend suppress strings without splicing; they can be set to
4183 provide ORGTBL directives for the generated table."
4184 (let* ((params2
4185 (list
4186 :tstart nil :tend nil
4187 :hline "|---"
4188 :sep " | "
4189 :lstart "| "
4190 :lend " |"))
4191 (params (org-combine-plists params2 params)))
4192 (orgtbl-to-generic table params)))
4194 (defun org-table-get-remote-range (name-or-id form)
4195 "Get a field value or a list of values in a range from table at ID.
4197 NAME-OR-ID may be the name of a table in the current file as set by
4199 will then be used. Alternatively, it may be an ID referring to
4200 any entry, also in a different file. In this case, the first table
4201 in that netry will be referenced.
4205 The return value is either a single string for a single field, or a
4206 list of the fields in the rectangle ."
4207 (save-match-data
4208 (let ((id-loc nil)
4209 org-table-column-names org-table-column-name-regexp
4210 org-table-local-parameters org-table-named-field-locations
4211 org-table-current-line-types org-table-current-begin-line
4212 org-table-current-begin-pos org-table-dlines
4213 org-table-hlines org-table-last-alignment
4214 org-table-last-column-widths org-table-last-alignment
4215 org-table-last-column-widths tbeg
4216 buffer loc)
4217 (setq form (org-table-convert-refs-to-rc form))
4218 (save-excursion
4219 (save-restriction
4220 (widen)
4221 (save-excursion
4222 (goto-char (point-min))
4223 (if (re-search-forward
4225 nil t)
4226 (setq buffer (current-buffer) loc (match-beginning 0))
4227 (setq id-loc (org-id-find name-or-id 'marker))
4228 (unless (and id-loc (markerp id-loc))
4230 (setq buffer (marker-buffer id-loc)
4231 loc (marker-position id-loc))
4232 (move-marker id-loc nil)))
4233 (switch-to-buffer buffer)
4234 (save-excursion
4235 (save-restriction
4236 (widen)
4237 (goto-char loc)
4238 (forward-char 1)
4240 (not (match-beginning 1)))
4241 (error "Cannot find a table at NAME or ID %s" name-or-id))
4242 (setq tbeg (point-at-bol))
4243 (org-table-get-specials)
4244 (setq form (org-table-formula-substitute-names form))
4245 (if (and (string-match org-table-range-regexp form)
4246 (> (length (match-string 0 form)) 1))
4247 (save-match-data
4248 (org-table-get-range (match-string 0 form) tbeg 1))
4249 form))))))))
4251 (provide 'org-table)
4253 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4255 ;;; org-table.el ends here