| blob | 67636ca66db343c63353e22b009e5d0c7d1e432f |
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.28e
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 "Non-nil means, a relative row reference that tries to cross a hline errors.
251 When nil, the reference will silently be to the field just next to the hline.
252 Coming from below, it will be the field below the hline, coming from
253 above, it will be the field above the hline."
258 "Options concerning table import and export in Org-mode."
263 "Default export parameters for org-table-export. These can be
264 overridden on for a specific table by setting the TABLE_EXPORT_FORMAT
265 property. See the manual section on orgtbl radio tables for the different
266 export transformations and available parameters."
277 "Searching from within a table (any type) this finds the first line
303 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
304 ;; 1 2 3 4 5
319 "Use the table.el package to insert a new table.
320 If there is already a table at point, convert between Org-mode tables
321 and table.el tables."
334 "Convert region to table, or create an empty table.
335 If there is an active region, convert it to a table, using the function
336 `org-table-convert-region'. See the documentation of that function
337 to learn how the prefix argument is interpreted to determine the field
338 separator.
339 If there is no such region, create an empty table with `org-table-create'."
346 "Query for a size and insert a table skeleton.
366 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
370 ;; Insert a hline after the first row.
378 "Convert region to a table.
379 The region goes from BEG0 to END0, but these borders will be moved
380 slightly, to make sure a beginning of line in the first line is included.
382 SEPARATOR specifies the field separator in the lines. It can have the
383 following values:
385 '(4) Use the comma as a field separator
386 '(16) Use a TAB as field separator
387 integer When a number, use that many spaces as field separator
388 nil When nil, the command tries to be smart and figure out the
389 separator in the following way:
390 - when each line contains a TAB, assume TAB-separated material
391 - when each line contains a comma, assume CSV material
392 - else, assume one or more SPACE characters as separator."
396 re)
403 ;; Get the right field separator
425 "Import FILE as a table.
426 The file is assumed to be tab-separated. Such files can be produced by most
427 spreadsheet and database applications. If no tabs (at least one per line)
428 are found, lines will be split on whitespace into fields."
440 "Export table to a file, with configurable format.
441 Such a file can be imported into a spreadsheet program like Excel.
442 FILE can be the output file name. If not given, it will be taken from
443 a TABLE_EXPORT_FILE property in the current entry or higher up in the
444 hierarchy, or the user will be prompted for a file name.
445 FORMAT can be an export format, of the same kind as it used when
446 orgtbl-mode sends a table in a different format. The default format can
447 be found in the variable `org-table-export-default-format', but the function
448 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
449 property, locally or anywhere up in the hierarchy."
466 buf deffmt-readable)
484 "Format: "
489 deffmt-readable)))
502 'hline
505 skipcols i0)))
506 lines))
510 skipcols i0))
513 skipcols i0)))
530 "Marker at the beginning of the table last aligned.
533 "Marker at the end of the table last aligned.
536 "List of flags for flushright alignment, from the last re-alignment.
539 "List of max width of fields in each column.
542 "Non-nil means, debug table formulas.
554 "Align the table at point by aligning all vertical bars."
557 ;; Limits of table
560 ;; Current cursor position
566 column
568 rfmt hfmt
576 emptystrings links dates emph narrow falign falign1 fmax f1 len c e)
579 ;; Check if we have links or dates
588 ;; Make sure the link properties are right
590 ;; Make sure the date properties are right
594 ;; Check if we are narrowing any columns
600 ;; Get the rows
603 ;; Store the indentation of the first line
606 ;; Mark the hlines by setting the corresponding element to nil
607 ;; At the same time, we remove trailing space.
610 nil
613 l)))
614 lines))
615 ;; Get the data fields by splitting the lines.
620 ;; How many fields in the longest line?
627 ;; A list of empty strings to fill any short rows on output
629 ;; Check for special formatting.
633 ;; Check if there is an explicit width specified
642 ;; Find fields that are wider than fmax, and shorten them
648 'help-echo
649 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
657 xx)))))
658 ;; Get the maximum width for each column
660 ;; Get the fraction of numbers, to decide about alignment of the column
666 nil
673 ;; Store the alignment of this table, for later editing of single fields
675 org-table-last-column-widths lengths)
677 ;; With invisible characters, `format' does not get the field width right
678 ;; So we need to make these fields wide by hand.
686 ; (string-match org-bracket-link-regexp (car c))
690 ;; Compute the formats needed for output of the table
703 hfmt))
705 ;; Replace the old one
714 ;; Try to move to the old location
722 ))
733 "Find the beginning of the table and return its position.
734 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
738 org-table-border-regexp)
739 nil t))
746 "Find the end of the table and return its position.
747 With argument TABLE-TYPE, go to the end of a table.el-type table."
751 org-table-border-regexp)
752 nil t))
758 "Justify the current field, text to left, number to right.
759 Optional argument NEW may specify text to replace the current field content."
768 ;; This is not the same table, force a full re-align
774 l f n o e)
797 "Go to the next field in the current table, creating new lines as needed.
798 Before doing so, re-align the table if necessary."
803 org-table-may-need-update)
814 org-table-tab-jumps-over-hlines
826 "Go to the previous field in the table.
827 Before doing so, re-align the table if necessary."
832 org-table-may-need-update)
847 "Move to the end of the current table field.
848 If already at or after the end, move to the end of the next table field.
849 With numeric argument N, move N-1 fields forward first."
862 "Move to the beginning of the current table field.
863 If already at or before the beginning, move to the beginning of the
864 previous field.
865 With numeric argument N, move N-1 fields backward first."
879 "Go to the next row (same column) in the current table.
880 Before doing so, re-align the table if necessary."
888 org-table-may-need-update)
902 "Copy a field down in the current column.
903 If the field at the cursor is empty, copy into it the content of the nearest
904 non-empty field above. With argument N, use the Nth non-empty field.
905 If the current field is not empty, it is copied down to the next row, and
906 the cursor is moved with it. Therefore, repeating this command causes the
907 column to be filled row-by-row.
908 If the variable `org-table-copy-increment' is non-nil and the field is an
909 integer or a timestamp, it will be incremented while copying. In the case of
910 a timestamp, if the cursor is on the year, change the year. If it is on the
911 month or the day, change that. Point will stay on the current date field
912 in order to easily repeat the interval."
920 txt)
932 beg t))
955 "Is point inside a table data field?
956 I.e. not on a hline or before the first or after the last column?
957 This actually throws an error, so it aborts the current command."
968 "Blank the current table field or active region."
985 "Return the value of the field in column N of current row.
986 N defaults to current field.
987 If REPLACE is a string, replace field with this value. The return value
988 is always the old value."
998 val)
1002 "Show info about the current field, and highlight any reference at point."
1010 org-table-named-field-locations)))
1023 dline col
1025 dline col ref1
1027 ;; FIXME: formula info not correct if special table line
1037 "Find out which column we are in."
1043 cnt)))
1046 "Find out what table data line we are in.
1047 Only datalines count for this."
1057 cnt)))
1060 "Move the cursor to the Nth column in the current table line.
1061 With optional argument ON-DELIM, stop with point before the left delimiter
1062 of the field.
1063 If there are less than N fields, just go to after the last delimiter.
1064 However, when FORCE is non-nil, create new columns if necessary."
1075 ; (backward-char 2) t)))))
1084 "Insert a new column into the table."
1092 ;; Current cursor position
1098 nil
1110 "Find a dataline in the current table, which is needed for column commands."
1113 t
1124 t
1129 "Delete a column from the table."
1138 ;; Current cursor position
1144 nil
1159 "Move column to the right."
1163 "Move column to the left."
1168 "Move the current column to the right. With arg LEFT, move to the left."
1178 ;; Current cursor position
1188 nil
1205 "Move table row down."
1209 "Move table row up."
1214 "Move the current table line down. With arg UP, move it up."
1223 txt hline2p)
1244 "Insert a new row above the current line into the table.
1245 With prefix ARG, insert below the current line."
1251 ;; Fix the first field if necessary
1263 "Insert a horizontal-line below the current line into the table.
1264 With prefix ABOVE, insert above the current line."
1286 "Insert a hline and move to the row below that line."
1300 In particular, this does handle wide and invisible characters."
1302 ;; It's a hline, just map the characters
1308 t t s)))
1309 s))
1312 "Delete the current row or horizontal line from the table."
1325 "Sort table lines according to the column at point.
1327 The position of point indicates the column to be used for
1328 sorting, and the range of lines is the range between the nearest
1329 horizontal separator lines, or the entire table of no such lines
1330 exist. If point is before the first column, you will be prompted
1331 for the sorting column. If there is an active region, the mark
1332 specifies the first line and the sorting column, while point
1333 should be in the last line to be included into the sorting.
1335 The command then prompts for the sorting type which can be
1336 alphabetically, numerically, or by time (as given in a time stamp
1337 in the field). Sorting in reverse order is also possible.
1339 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1341 If SORTING-TYPE is specified when this function is called from a Lisp
1342 program, no prompting will take place. SORTING-TYPE must be a character,
1343 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1344 should be done in reverse order."
1348 beg end bcol ecol tend tbeg column lns pos)
1393 x))
1406 "Copy region in table to the clipboard and blank all relevant fields."
1411 "Copy rectangular region in table to clipboard.
1412 A special clipboard is used which can only be accessed
1413 with `org-table-paste-rectangle'."
1416 region cols
1442 org-table-clip))
1445 "Paste a rectangular region into a table.
1446 The upper right corner ends up in the current field. All involved fields
1447 will be overwritten. If the rectangle does not fit into the present table,
1448 the table is enlarged as needed. The process ignores horizontal separator
1449 lines."
1459 c cols field)
1475 "Convert from `org-mode' table to table.el and back.
1476 Obviously, this only works within limits. When an Org-mode table is
1477 converted to table.el, all horizontal separator lines get lost, because
1478 table.el uses these as cell boundaries and has no notion of horizontal lines.
1479 A table.el table can be converted to an Org-mode table only if it does not
1480 do row or column spanning. Multiline cells will become multiple cells.
1481 Beware, Org-mode does not test if the table can be successfully converted - it
1482 blindly applies a recipe that works for simple tables."
1486 ;; convert to Org-mode table
1495 ;; convert to table.el table
1498 ;; first, get rid of all horizontal lines
1502 ;; insert a hline before first
1506 ;; insert a hline after each line
1511 ;; replace "+" at beginning and ending of hlines
1520 "Wrap several fields in a column like a paragraph.
1521 This is useful if you'd like to spread the contents of a field over several
1522 lines, in order to keep the table compact.
1524 If there is an active region, and both point and mark are in the same column,
1525 the text in the column is wrapped to minimum width for the given number of
1526 lines. Generally, this makes the table more compact. A prefix ARG may be
1528 formats the selected text to two lines. If the region was longer than two
1529 lines, the remaining lines remain empty. A negative prefix argument reduces
1530 the current number of lines by that amount. The wrapped text is pasted back
1531 into the table. If you formatted it to more lines than it was before, fields
1532 further down in the table get overwritten - so you might need to make space in
1533 the table first.
1535 If there is no region, the current field is split at the cursor position and
1536 the text fragment to the right of the cursor is prepended to the field one
1537 line down.
1539 If there is no region, but you specify a prefix ARG, the current field gets
1540 blank, and the content is appended to the field above."
1544 ;; There is a region: fill as a paragraph
1548 nlines)
1555 arg)
1559 nil nlines)))
1563 ;; No region, split the current field at point
1567 ;; combine with field above
1577 ;; split field
1590 "Edit table field in a different window.
1591 This is mainly useful for fields that contain hidden parts.
1593 it can be edited in place."
1599 display t intangible t))
1605 p)
1614 intangible t))
1622 "Finish editing a table data field.
1623 Remove all newline characters, insert the result into the table, realign
1624 the table and kill the editing buffer."
1628 text)
1664 "Sum numbers in region of current table column.
1665 The result will be displayed in the echo area, and will be available
1668 If there is an active region, it is interpreted as a rectangle and all
1669 numbers in that rectangle will be summed. If there is no active
1670 region and point is located in a table column, sum all numbers in that
1671 column.
1673 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1674 numbers are assumed to be times as well (in decimal hours) and the
1675 numbers are added as such.
1677 If NLAST is a number, only the NLAST fields will actually be summed."
1704 items1)))
1711 s diff)
1719 sres))))
1742 "Return the formula active for the current field.
1743 Assumes that specials are in place.
1744 If KEY is given, return the key to this formula.
1748 org-table-named-field-locations)))
1762 "Read a formula from the minibuffer, offer stored formula as default.
1763 When NAMED is non-nil, look for a named equation."
1767 org-table-named-field-locations)))
1774 name
1775 ref)
1785 stored)
1787 equation)
1794 scol))
1796 'org-table-formula-history
1797 )))))
1798 mustsave)
1800 ;; remove formula
1807 ;; We set the column equation, delete the named one.
1809 mustsave t))
1815 eq))
1818 "Store the list of formulas below the current table."
1824 ;; don't overwrite TBLFM, we might use text properties to store stuff
1845 "Compare two formulas for sorting."
1851 "Return an alist with the stored formulas directly after current table."
1859 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1876 "Modify the equations after the table structure has been edited.
1878 For all numbers larger than LIMIT, shift them by DELTA."
1889 s n a)
1902 t t)))))))))
1905 "Get the column names and local parameters for this table."
1908 names name fields fields1 field cnt
1909 c v l line col types dlines hlines last-dline)
1911 org-table-local-parameters nil
1912 org-table-named-field-locations nil
1913 org-table-current-begin-line nil
1914 org-table-current-begin-pos nil
1915 org-table-current-line-types nil)
1933 org-table-local-parameters))))
1949 ;; Analyse the line types
1953 l org-table-current-begin-line)
1970 al al2)
1982 If yes, store the formula and apply it."
1983 ;; We already know we are in a table. Get field will only return a formula
1984 ;; when appropriate. It might return a separator line, but no problem.
1987 named eq)
1998 "List of commands triggering the recalculation of a line.
2011 "Rotate the recalculation mark in the first column.
2012 If in any row, the first field is not consistent with a mark,
2013 insert a new column for the markers.
2014 When there is an active region, change all the lines in the region,
2015 after prompting for the marking character.
2016 After each change, a message will be displayed indicating the meaning
2017 of the new mark."
2032 epos new)
2039 newchar))
2071 "Recompute the current line if marked for it, and if we haven't just done it."
2091 modes)
2094 suppress-align suppress-const
2095 suppress-store suppress-analysis)
2096 "Replace the table field value at the cursor by the result of a calculation.
2098 This function makes use of Dave Gillespie's Calc package, in my view the
2099 most exciting program ever written for GNU Emacs. So you need to have Calc
2100 installed in order to use this function.
2102 In a table, this command replaces the value in the current field with the
2104 formula, by storing it in a special line below the table. When called
2105 with a `C-u' prefix, the current field must ba a named field, and the
2106 formula is installed as valid in only this specific field.
2108 When called with two `C-u' prefixes, insert the active equation
2109 for the field back into the current field, so that it can be
2111 to check the referenced fields.
2113 When called, the command first prompts for a formula, which is read in
2114 the minibuffer. Previously entered formulas are available through the
2115 history list, and the last used formula is offered as a default.
2116 These stored formulas are adapted correctly when moving, inserting, or
2117 deleting columns with the corresponding commands.
2119 The formula can be any algebraic expression understood by the Calc package.
2120 For details, see the Org-mode manual.
2122 This function can also be called from Lisp programs and offers
2123 additional arguments: EQUATION can be the formula to apply. If this
2124 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2125 used to speed-up recursive calls by by-passing unnecessary aligns.
2126 SUPPRESS-CONST suppresses the interpretation of constants in the
2127 formula, assuming that this has been done already outside the function.
2128 SUPPRESS-STORE means the formula should not be stored, either because
2129 it is already stored, or because it is a modified equation that should
2130 not overwrite the stored one."
2146 equation
2152 n form form0 bw fmt x ev orig c lispp literal)
2153 ;; Parse the format string. Since we have a lot of modes, this is
2154 ;; a lot of work. However, I think calc still uses most of the time.
2166 'calc-float-format
2169 n))))
2196 fields)))
2201 ;; Check for old vertical references
2203 ;; Insert remote references
2211 keep-empty numbers lispp))
2212 t t form)))
2213 ;; Insert complex ranges
2221 keep-empty numbers lispp))
2222 t t form)))
2223 ;; Insert simple ranges
2232 keep-empty numbers lispp))
2233 t t form)))
2235 ;; Insert the references to fields in same row
2244 t t form)))
2259 Orig: %s
2260 $xyz-> %s
2261 @r$c-> %s
2292 prop value)))
2295 "Get a calc vector from a column, according to descriptor DESC.
2296 Optional arguments TBEG and COL can give the beginning of the table and
2297 the current column, to avoid unnecessary parsing.
2298 HIGHLIGHT means, just highlight the range."
2305 beg end c1 c2 r1 r2 rangep tmp)
2322 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2328 ;; just one field
2335 ;; A range, return a vector
2336 ;; First sort the numbers to get a regular ractangle
2352 ;; return string representation of calc vector
2357 "Analyze descriptor DESC and retrieve the corresponding line number.
2358 The cursor is currently in line CLINE, the table begins in line BLINE,
2359 and TABLE is a vector with line types."
2367 ;; 1 2 3 4 5 6
2387 nil hn cline desc)))
2390 rel on cline desc)))
2394 "FIXME: Needs more documentation."
2404 t)))
2408 desc cline)
2409 i)))
2414 s))
2417 "Convert list ELEMENTS to something appropriate to insert into formula.
2418 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2419 NUMBERS indicates that everything should be converted to numbers.
2420 LISPP means to return something appropriate for a Lisp list."
2424 elements
2433 elements))))
2439 x
2445 elements
2449 "Recalculate the current table line by applying all stored formulas.
2450 With prefix arg ALL, do this for all lines in the table.
2451 With the prefix argument ALL is `(16)' (a double `C-c C-u' prefix), or if
2452 it is the symbol `iterate', recompute the table until it no longer changes.
2453 If NOALIGN is not nil, do not re-align the table after the computations
2454 are done. This is typically used internally to save time, if it is
2455 known that the table will be realigned a little later anyway."
2470 ;; Insert constants in all formulas
2474 x)
2475 eqlist))
2476 ;; Split the equation list
2487 ;; This is a table with marked lines, compute selected lines
2489 ;; Move forward to the first non-header line
2500 ;; First find the named fields, and mark them untouchable
2512 name)))
2521 ;; Now evauluate the column formulas, but skip fields covered by
2522 ;; field formulas
2526 ;; Unprotected line, recalculate
2538 ;; Now evaluate the field formulas
2552 ;; back to initial position
2560 "Recalculate the table until it does not change anymore."
2565 thistbl)
2580 "Replace $const with values in string F."
2582 ;; First, check for column names
2587 ;; Parameters and constants
2589 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2599 f))
2602 "Find the value for a parameter or constant in a formula.
2603 Parameters get priority."
2633 map))
2640 "--"
2643 "--"
2644 "Shift Reference at Point"
2649 "-"
2650 "Change Test Row for Column Formulas"
2653 "--"
2658 org-table-overlay-coordinates)]
2659 "--"
2666 "Edit the formulas of the current table in a separate buffer."
2681 entry s type title)
2684 ;; Keep global-font-lock-mode from turning on font-lock-mode
2723 "Convert a formula from internal to user representation."
2726 s))
2729 "Convert a formula from user to internal representation."
2732 s))
2735 "Convert spreadsheet references from AB7 to @7$28.
2736 Works for single references, but also for entire formulas and even the
2737 full TBLFM line."
2739 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2742 ;; format match, just advance
2747 ;; 3.e5 or something like this.
2757 t t s)))))
2758 s))
2761 "Convert spreadsheet references from to @7$28 to AB7.
2762 Works for single references, but also for entire formulas and even the
2763 full TBLFM line."
2770 t t s)))
2775 t nil s)))
2776 s)
2779 "Convert a base 26 number represented by letters into an integer.
2780 For example: AB -> 28."
2786 n))
2789 "Convert an integer into a base 26 number represented by letters.
2790 For example: 28 -> AB."
2795 s))
2798 "Convert all references in this buffer, using FUNCTION."
2808 "Convert all references in the buffer from B3 to @3$2 and back."
2818 "Shift the reference at point one row/hline up."
2822 "Shift the reference at point one row/hline down."
2826 "Shift the reference at point one field to the left."
2830 "Shift the reference at point one field to the right."
2841 ;; A B3-like reference
2847 ;; An internal reference
2853 "Re-match the group N, and replace it with the shifted refrence."
2858 t t)))
2861 "Shift a refrence part REF.
2862 If DECR is set, decrease the references row/column, else increase.
2863 If HLINE is set, this may be a hline reference, it certainly is not
2864 a translation reference."
2893 "Toggle the display of coordinates in the referenced table."
2902 "Parse the buffer for formula definitions and install them.
2903 With prefix ARG, apply the new formulas to the table."
2914 nil t)
2938 "Abort editing formulas, without installing the changes."
2949 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
2990 "Show the location/value of the $ expression at point."
2999 var name e what match dest)
3081 ;; column number
3109 org-table-fedit-scroll-down))))
3120 "Make sure the cursor is in a dataline in a table."
3129 p1 p2)))
3134 "Move cursor one line up in the window showing the table."
3139 "Move cursor one line down in the window showing the table."
3144 "Move the cursor in the window showing the table.
3145 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3170 "Add a new overlay."
3176 "Highlight rectangular region in a table."
3180 l1 c1 l2 c2 tmp)
3204 "Remove the rectangle overlays."
3215 "Add overlays to the table at point, to show row/column coordinates."
3244 "Toggle the display of Row/Column numbers in tables."
3256 "Toggle the formula debugger in tables."
3262 ;;; The orgtbl minor mode
3264 ;; Define a minor mode which can be used in other modes in order to
3265 ;; integrate the org-mode table editor.
3267 ;; This is really a hack, because the org-mode table editor uses several
3268 ;; keys which normally belong to the major mode, for example the TAB and
3269 ;; RET keys. Here is how it works: The minor mode defines all the keys
3270 ;; necessary to operate the table editor, but wraps the commands into a
3271 ;; function which tests if the cursor is currently inside a table. If that
3272 ;; is the case, the table editor command is executed. However, when any of
3273 ;; those keys is used outside a table, the function uses `key-binding' to
3274 ;; look up if the key has an associated command in another currently active
3275 ;; keymap (minor modes, major mode, global), and executes that command.
3276 ;; There might be problems if any of the keys used by the table editor is
3277 ;; otherwise used as a prefix key.
3279 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3280 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3281 ;; addresses this by checking explicitly for both bindings.
3283 ;; The optimized version (see variable `orgtbl-optimized') takes over
3284 ;; all keys which are bound to `self-insert-command' in the *global map*.
3285 ;; Some modes bind other commands to simple characters, for example
3286 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3287 ;; active, this binding is ignored inside tables and replaced with a
3288 ;; modified self-insert.
3291 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
3298 ;;;###autoload
3300 "Unconditionally turn on `orgtbl-mode'."
3314 ;;;###autoload
3316 "The `org-mode' table editor as a minor mode for use in other modes."
3320 ;; Exit without error, in case some hook functions calls this
3321 ;; by accident in org-mode.
3328 ;; Make sure we are first in minor-mode-map-alist
3336 auto-fill-inhibit-regexp)
3340 auto-fill-inhibit-regexp)
3341 orgtbl-line-start-regexp))
3359 "Remove all properties related to narrow-column invisibility."
3371 ;; Install it as a minor mode.
3377 "Create a function for binding in the table minor mode.
3378 FUN is the command to call inside a table. N is used to create a unique
3379 command name. KEYS are keys that should be checked in for a command
3380 to execute outside of tables."
3386 "Outside of tables, run the binding of `"
3398 keys)
3402 "Error when there is no default binding for a table key."
3407 "Setup orgtbl keymaps."
3438 elt key fun cmd)
3446 ;; Special treatment needed for TAB and RET
3464 [(tab)] "\C-i"))
3466 (org-defkey orgtbl-mode-map [backtab]
3468 [backtab] [S-iso-lefttab] [(shift tab)]
3469 [(tab)] "\C-i"))
3471 (org-defkey orgtbl-mode-map "\M-\C-m"
3472 (orgtbl-make-binding 'org-table-wrap-region 105
3473 "\M-\C-m" [(meta return)]))
3474 (org-defkey orgtbl-mode-map [(meta return)]
3475 (orgtbl-make-binding 'org-table-wrap-region 106
3476 [(meta return)] "\M-\C-m"))
3478 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3479 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3481 (when orgtbl-optimized
3482 ;; If the user wants maximum table support, we need to hijack
3483 ;; some standard editing functions
3484 (org-remap orgtbl-mode-map
3485 'self-insert-command 'orgtbl-self-insert-command
3486 'delete-char 'org-delete-char
3487 'delete-backward-char 'org-delete-backward-char)
3488 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3489 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3490 '("OrgTbl"
3491 ["Create or convert" org-table-create-or-convert-from-region
3492 :active (not (org-at-table-p)) :keys "C-c |" ]
3493 "--"
3494 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3495 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3496 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3497 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3498 "--"
3499 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3500 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3501 ["Copy Field from Above"
3502 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3503 "--"
3504 ("Column"
3505 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3506 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3507 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3508 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3509 ("Row"
3510 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3511 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3512 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3513 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3514 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3515 "--"
3516 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3517 ("Rectangle"
3518 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3519 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3520 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3521 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3522 "--"
3523 ("Radio tables"
3524 ["Insert table template" orgtbl-insert-radio-table
3525 (assq major-mode orgtbl-radio-table-templates)]
3526 ["Comment/uncomment table" orgtbl-toggle-comment t])
3527 "--"
3528 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3529 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3530 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3531 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3532 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3533 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3534 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3535 ["Sum Column/Rectangle" org-table-sum
3536 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3537 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3538 ["Debug Formulas"
3539 org-table-toggle-formula-debugger :active (org-at-table-p)
3540 :keys "C-c {"
3541 :style toggle :selected org-table-formula-debug]
3542 ["Show Col/Row Numbers"
3543 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3544 :keys "C-c }"
3545 :style toggle :selected org-table-overlay-coordinates]
3546 ))
3547 t))
3549 (defun orgtbl-ctrl-c-ctrl-c (arg)
3550 "If the cursor is inside a table, realign the table.
3551 If it is a table to be sent away to a receiver, do it.
3552 With prefix arg, also recompute table."
3553 (interactive "P")
3554 (let ((pos (point)) action)
3555 (save-excursion
3556 (beginning-of-line 1)
3560 (cond
3561 ((integerp action)
3562 (goto-char action)
3563 (org-table-maybe-eval-formula)
3564 (if arg
3565 (call-interactively 'org-table-recalculate)
3566 (org-table-maybe-recalculate-line))
3567 (call-interactively 'org-table-align)
3568 (orgtbl-send-table 'maybe))
3569 ((eq action 'recalc)
3570 (save-excursion
3571 (beginning-of-line 1)
3573 (if (org-at-table-p)
3574 (org-call-with-arg 'org-table-recalculate t))))
3575 (t (let (orgtbl-mode)
3576 (call-interactively (key-binding "\C-c\C-c")))))))
3578 (defun orgtbl-create-or-convert-from-region (arg)
3579 "Create table or convert region to table, if no conflicting binding.
3580 This installs the table binding `C-c |', but only if there is no
3581 conflicting binding to this key outside orgtbl-mode."
3582 (interactive "P")
3583 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3584 (if cmd
3585 (call-interactively cmd)
3586 (call-interactively 'org-table-create-or-convert-from-region))))
3588 (defun orgtbl-tab (arg)
3589 "Justification and field motion for `orgtbl-mode'."
3590 (interactive "P")
3591 (if arg (org-table-edit-field t)
3592 (org-table-justify-field-maybe)
3593 (org-table-next-field)))
3595 (defun orgtbl-ret ()
3596 "Justification and field motion for `orgtbl-mode'."
3597 (interactive)
3598 (if (bobp)
3599 (newline)
3600 (org-table-justify-field-maybe)
3601 (org-table-next-row)))
3603 (defun orgtbl-self-insert-command (N)
3604 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3605 If the cursor is in a table looking at whitespace, the whitespace is
3606 overwritten, and the table is not marked as requiring realignment."
3607 (interactive "p")
3608 (if (and (org-at-table-p)
3609 (or
3610 (and org-table-auto-blank-field
3611 (member last-command
3612 '(orgtbl-hijacker-command-100
3613 orgtbl-hijacker-command-101
3614 orgtbl-hijacker-command-102
3615 orgtbl-hijacker-command-103
3616 orgtbl-hijacker-command-104
3617 orgtbl-hijacker-command-105
3618 yas/expand))
3619 (org-table-blank-field))
3620 t)
3621 (eq N 1)
3623 (let (org-table-may-need-update)
3624 (goto-char (1- (match-end 0)))
3625 (delete-backward-char 1)
3626 (goto-char (match-beginning 0))
3627 (self-insert-command N))
3628 (setq org-table-may-need-update t)
3629 (let* (orgtbl-mode
3630 a
3631 (cmd (or (key-binding
3632 (or (and (listp function-key-map)
3633 (setq a (assoc last-input-event function-key-map))
3634 (cdr a))
3635 (vector last-input-event)))
3636 'self-insert-command)))
3637 (call-interactively cmd)
3638 (if (and org-self-insert-cluster-for-undo
3639 (eq cmd 'self-insert-command))
3640 (if (not (eq last-command 'orgtbl-self-insert-command))
3641 (setq org-self-insert-command-undo-counter 1)
3642 (if (>= org-self-insert-command-undo-counter 20)
3643 (setq org-self-insert-command-undo-counter 1)
3644 (and (> org-self-insert-command-undo-counter 0)
3645 buffer-undo-list
3646 (not (cadr buffer-undo-list)) ; remove nil entry
3647 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3648 (setq org-self-insert-command-undo-counter
3649 (1+ org-self-insert-command-undo-counter))))))))
3652 "Regular expression matching exponentials as produced by calc.")
3654 (defun orgtbl-export (table target)
3655 (require 'org-exp)
3656 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3658 org-table-last-alignment org-table-last-column-widths
3659 maxcol column)
3660 (if (not (fboundp func))
3661 (error "Cannot export orgtbl table to %s" target))
3662 (setq lines (org-table-clean-before-export lines))
3663 (setq table
3664 (mapcar
3665 (lambda (x)
3666 (if (string-match org-table-hline-regexp x)
3667 'hline
3669 lines))
3670 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3671 table)))
3672 (loop for i from (1- maxcol) downto 0 do
3673 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3674 (setq column (delq nil column))
3675 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3676 (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))
3677 (funcall func table nil)))
3679 (defun orgtbl-gather-send-defs ()
3680 "Gathers a plist of :name, :transform, :params for each destination before
3681 a radio table."
3682 (save-excursion
3683 (goto-char (org-table-begin))
3684 (let (rtn)
3685 (beginning-of-line 0)
3686 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
3687 (let ((name (org-no-properties (match-string 1)))
3688 (transform (intern (match-string 2)))
3689 (params (if (match-end 3)
3690 (read (concat "(" (match-string 3) ")")))))
3691 (push (list :name name :transform transform :params params)
3692 rtn)
3693 (beginning-of-line 0)))
3694 rtn)))
3696 (defun orgtbl-send-replace-tbl (name txt)
3697 "Find and replace table NAME with TXT."
3698 (save-excursion
3699 (goto-char (point-min))
3700 (unless (re-search-forward
3702 (error "Don't know where to insert translated table"))
3703 (goto-char (match-beginning 0))
3704 (beginning-of-line 2)
3705 (save-excursion
3706 (let ((beg (point)))
3707 (unless (re-search-forward
3708 (concat "END RECEIVE ORGTBL +" name) nil t)
3709 (error "Cannot find end of insertion region"))
3710 (beginning-of-line 1)
3711 (delete-region beg (point))))
3714 ;;;###autoload
3715 (defun org-table-to-lisp (&optional txt)
3716 "Convert the table at point to a Lisp structure.
3717 The structure will be a list. Each item is either the symbol `hline'
3718 for a horizontal separator line, or a list of field values as strings.
3719 The table is taken from the parameter TXT, or from the buffer at point."
3720 (unless txt
3721 (unless (org-at-table-p)
3722 (error "No table at point")))
3723 (let* ((txt (or txt
3724 (buffer-substring-no-properties (org-table-begin)
3725 (org-table-end))))
3728 (mapcar
3729 (lambda (x)
3730 (if (string-match org-table-hline-regexp x)
3731 'hline
3733 lines)))
3735 (defun orgtbl-send-table (&optional maybe)
3736 "Send a transformed version of this table to the receiver position.
3737 With argument MAYBE, fail quietly if no transformation is defined for
3738 this table."
3739 (interactive)
3740 (catch 'exit
3741 (unless (org-at-table-p) (error "Not at a table"))
3742 ;; when non-interactive, we assume align has just happened.
3743 (when (interactive-p) (org-table-align))
3744 (let ((dests (orgtbl-gather-send-defs))
3745 (txt (buffer-substring-no-properties (org-table-begin)
3746 (org-table-end)))
3747 (ntbl 0))
3748 (unless dests (if maybe (throw 'exit nil)
3749 (error "Don't know how to transform this table.")))
3750 (dolist (dest dests)
3751 (let* ((name (plist-get dest :name))
3752 (transform (plist-get dest :transform))
3753 (params (plist-get dest :params))
3754 (skip (plist-get params :skip))
3755 (skipcols (plist-get params :skipcols))
3756 beg
3757 (lines (org-table-clean-before-export
3758 (nthcdr (or skip 0)
3760 (i0 (if org-table-clean-did-remove-column 2 1))
3761 (table (mapcar
3762 (lambda (x)
3763 (if (string-match org-table-hline-regexp x)
3764 'hline
3765 (org-remove-by-index
3767 skipcols i0)))
3768 lines))
3769 (fun (if (= i0 2) 'cdr 'identity))
3770 (org-table-last-alignment
3771 (org-remove-by-index (funcall fun org-table-last-alignment)
3772 skipcols i0))
3773 (org-table-last-column-widths
3774 (org-remove-by-index (funcall fun org-table-last-column-widths)
3775 skipcols i0))
3776 (txt (if (fboundp transform)
3777 (funcall transform table params)
3778 (error "No such transformation function %s" transform))))
3779 (orgtbl-send-replace-tbl name txt))
3780 (setq ntbl (1+ ntbl)))
3781 (message "Table converted and installed at %d receiver location%s"
3782 ntbl (if (> ntbl 1) "s" "")))))
3784 (defun org-remove-by-index (list indices &optional i0)
3785 "Remove the elements in LIST with indices in INDICES.
3786 First element has index 0, or I0 if given."
3787 (if (not indices)
3788 list
3789 (if (integerp indices) (setq indices (list indices)))
3790 (setq i0 (1- (or i0 0)))
3791 (delq :rm (mapcar (lambda (x)
3792 (setq i0 (1+ i0))
3793 (if (memq i0 indices) :rm x))
3794 list))))
3796 (defun orgtbl-toggle-comment ()
3797 "Comment or uncomment the orgtbl at point."
3798 (interactive)
3799 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3800 (re2 (concat "^" orgtbl-line-start-regexp))
3801 (commented (save-excursion (beginning-of-line 1)
3802 (cond ((looking-at re1) t)
3803 ((looking-at re2) nil)
3804 (t (error "Not at an org table")))))
3805 (re (if commented re1 re2))
3806 beg end)
3807 (save-excursion
3808 (beginning-of-line 1)
3809 (while (looking-at re) (beginning-of-line 0))
3810 (beginning-of-line 2)
3811 (setq beg (point))
3812 (while (looking-at re) (beginning-of-line 2))
3813 (setq end (point)))
3814 (comment-region beg end (if commented '(4) nil))))
3816 (defun orgtbl-insert-radio-table ()
3817 "Insert a radio table template appropriate for this major mode."
3818 (interactive)
3819 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3820 (txt (nth 1 e))
3821 name pos)
3822 (unless e (error "No radio table setup defined for %s" major-mode))
3823 (setq name (read-string "Table name: "))
3824 (while (string-match "%n" txt)
3825 (setq txt (replace-match name t t txt)))
3827 (setq pos (point))
3828 (insert txt)
3829 (goto-char pos)))
3831 ;; Dynamically bound input and output for table formatting.
3832 (defvar *orgtbl-table* nil
3833 "Carries the current table through formatting routines.")
3834 (defvar *orgtbl-rtn* nil
3835 "Formatting routines push the output lines here.")
3836 ;; Formatting parameters for the current table section.
3837 (defvar *orgtbl-hline* nil "Text used for horizontal lines")
3838 (defvar *orgtbl-sep* nil "Text used as a column separator")
3839 (defvar *orgtbl-default-fmt* nil "Default format for each entry")
3840 (defvar *orgtbl-fmt* nil "Format for each entry")
3841 (defvar *orgtbl-efmt* nil "Format for numbers")
3842 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt")
3843 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row")
3844 (defvar *orgtbl-lstart* nil "Text starting a row")
3845 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row")
3846 (defvar *orgtbl-lend* nil "Text ending a row")
3847 (defvar *orgtbl-llend* nil "Specializes lend for the last row")
3849 (defsubst orgtbl-get-fmt (fmt i)
3850 "Retrieve the format from FMT corresponding to the Ith column."
3851 (if (and (not (functionp fmt)) (consp fmt))
3852 (plist-get fmt i)
3853 fmt))
3855 (defsubst orgtbl-apply-fmt (fmt &rest args)
3856 "Apply format FMT to the arguments. NIL FMTs return the first argument."
3857 (cond ((functionp fmt) (apply fmt args))
3858 (fmt (apply 'format fmt args))
3859 (args (car args))
3860 (t args)))
3862 (defsubst orgtbl-eval-str (str)
3863 "If STR is a function, evaluate it with no arguments."
3864 (if (functionp str)
3865 (funcall str)
3866 str))
3868 (defun orgtbl-format-line (line)
3869 "Format LINE as a table row."
3870 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
3871 (let* ((i 0)
3872 (line
3873 (mapcar
3874 (lambda (f)
3875 (setq i (1+ i))
3876 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
3877 (f (if (and efmt (string-match orgtbl-exp-regexp f))
3878 (orgtbl-apply-fmt efmt (match-string 1 f)
3879 (match-string 2 f))
3880 f)))
3881 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
3882 *orgtbl-default-fmt*)
3883 f)))
3884 line)))
3885 (push (if *orgtbl-lfmt*
3886 (orgtbl-apply-fmt *orgtbl-lfmt* line)
3887 (concat (orgtbl-eval-str *orgtbl-lstart*)
3888 (mapconcat 'identity line *orgtbl-sep*)
3889 (orgtbl-eval-str *orgtbl-lend*)))
3890 *orgtbl-rtn*))))
3892 (defun orgtbl-format-section (section-stopper)
3893 "Format lines until the first occurrence of SECTION-STOPPER."
3894 (let (prevline)
3895 (progn
3896 (while (not (eq (car *orgtbl-table*) section-stopper))
3897 (if prevline (orgtbl-format-line prevline))
3898 (setq prevline (pop *orgtbl-table*)))
3899 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
3900 (*orgtbl-lend* *orgtbl-llend*)
3901 (*orgtbl-lfmt* *orgtbl-llfmt*))
3902 (orgtbl-format-line prevline))))))
3904 (defun orgtbl-to-generic (table params)
3905 "Convert the orgtbl-mode TABLE to some other format.
3906 This generic routine can be used for many standard cases.
3907 TABLE is a list, each entry either the symbol `hline' for a horizontal
3908 separator line, or a list of fields for that line.
3909 PARAMS is a property list of parameters that can influence the conversion.
3910 For the generic converter, some parameters are obligatory: You need to
3911 specify either :lfmt, or all of (:lstart :lend :sep).
3913 Valid parameters are
3915 :splice When set to t, return only table body lines, don't wrap
3916 them into :tstart and :tend. Default is nil. When :splice
3917 is non-nil, this also means that the exporter should not look
3918 for and interpret header and footer sections.
3920 :hline String to be inserted on horizontal separation lines.
3921 May be nil to ignore hlines.
3923 :sep Separator between two fields
3924 :remove-nil-lines Do not include lines that evaluate to nil.
3927 Each in the following group may be either a string or a function
3928 of no arguments returning a string:
3929 :tstart String to start the table. Ignored when :splice is t.
3930 :tend String to end the table. Ignored when :splice is t.
3931 :lstart String to start a new table line.
3932 :llstart String to start the last table line, defaults to :lstart.
3933 :lend String to end a table line
3934 :llend String to end the last table line, defaults to :lend.
3936 Each in the following group may be a string, a function of one
3937 argument (the field or line) returning a string, or a plist
3938 mapping columns to either of the above:
3939 :lfmt Format for entire line, with enough %s to capture all fields.
3940 If this is present, :lstart, :lend, and :sep are ignored.
3941 :llfmt Format for the entire last line, defaults to :lfmt.
3942 :fmt A format to be used to wrap the field, should contain
3943 %s for the original field value. For example, to wrap
3945 This may also be a property list with column numbers and
3948 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
3949 Same as above, specific for the header lines in the table.
3950 All lines before the first hline are treated as header.
3951 If any of these is not present, the data line value is used.
3953 This may be either a string or a function of two arguments:
3954 :efmt Use this format to print numbers with exponentials.
3955 The format should have %s twice for inserting mantissa
3957 may also be a property list with column numbers and
3958 formats. :fmt will still be applied after :efmt.
3960 In addition to this, the parameters :skip and :skipcols are always handled
3961 directly by `orgtbl-send-table'. See manual."
3962 (interactive)
3964 (let* ((splicep (plist-get params :splice))
3965 (hline (plist-get params :hline))
3966 (remove-nil-linesp (plist-get params :remove-nil-lines))
3967 (*orgtbl-hline* hline)
3968 (*orgtbl-table* table)
3969 (*orgtbl-sep* (plist-get params :sep))
3970 (*orgtbl-efmt* (plist-get params :efmt))
3971 (*orgtbl-lstart* (plist-get params :lstart))
3972 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
3973 (*orgtbl-lend* (plist-get params :lend))
3974 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
3975 (*orgtbl-lfmt* (plist-get params :lfmt))
3976 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
3977 (*orgtbl-fmt* (plist-get params :fmt))
3978 *orgtbl-rtn*)
3980 ;; Put header
3981 (unless splicep
3982 (when (plist-member params :tstart)
3983 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
3984 (if tstart (push tstart *orgtbl-rtn*)))))
3986 ;; Do we have a heading section? If so, format it and handle the
3987 ;; trailing hline.
3988 (if (and (not splicep)
3989 (or (consp (car *orgtbl-table*))
3990 (consp (nth 1 *orgtbl-table*)))
3991 (memq 'hline (cdr *orgtbl-table*)))
3992 (progn
3993 (when (eq 'hline (car *orgtbl-table*))
3994 ;; there is a hline before the first data line
3995 (and hline (push hline *orgtbl-rtn*))
3996 (pop *orgtbl-table*))
3997 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
3998 *orgtbl-lstart*))
3999 (*orgtbl-llstart* (or (plist-get params :hllstart)
4000 *orgtbl-llstart*))
4001 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4002 (*orgtbl-llend* (or (plist-get params :hllend)
4003 (plist-get params :hlend) *orgtbl-llend*))
4004 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4005 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4006 (plist-get params :hlfmt) *orgtbl-llfmt*))
4007 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4008 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4009 (orgtbl-format-section 'hline))
4010 (if hline (push hline *orgtbl-rtn*))
4011 (pop *orgtbl-table*)))
4013 ;; Now format the main section.
4014 (orgtbl-format-section nil)
4016 (unless splicep
4017 (when (plist-member params :tend)
4018 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4019 (if tend (push tend *orgtbl-rtn*)))))
4021 (mapconcat 'identity (nreverse (if remove-nil-linesp
4022 (remq nil *orgtbl-rtn*)
4025 (defun orgtbl-to-tsv (table params)
4026 "Convert the orgtbl-mode table to TAB separated material."
4028 (defun orgtbl-to-csv (table params)
4029 "Convert the orgtbl-mode table to CSV material.
4030 This does take care of the proper quoting of fields with comma or quotes."
4031 (orgtbl-to-generic table (org-combine-plists
4032 '(:sep "," :fmt org-quote-csv-field)
4033 params)))
4035 (defun orgtbl-to-latex (table params)
4036 "Convert the orgtbl-mode TABLE to LaTeX.
4037 TABLE is a list, each entry either the symbol `hline' for a horizontal
4038 separator line, or a list of fields for that line.
4039 PARAMS is a property list of parameters that can influence the conversion.
4040 Supports all parameters from `orgtbl-to-generic'. Most important for
4041 LaTeX are:
4043 :splice When set to t, return only table body lines, don't wrap
4044 them into a tabular environment. Default is nil.
4046 :fmt A format to be used to wrap the field, should contain %s for the
4047 original field value. For example, to wrap everything in dollars,
4050 The format may also be a function that formats its one argument.
4052 :efmt Format for transforming numbers with exponentials. The format
4053 should have %s twice for inserting mantissa and exponent, for
4055 This may also be a property list with column numbers and formats.
4056 The format may also be a function that formats its two arguments.
4058 :llend If you find too much space below the last line of a table,
4061 The general parameters :skip and :skipcols have already been applied when
4062 this function is called."
4063 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4064 org-table-last-alignment ""))
4065 (params2
4066 (list
4071 (orgtbl-to-generic table (org-combine-plists params2 params))))
4073 (defun orgtbl-to-html (table params)
4074 "Convert the orgtbl-mode TABLE to LaTeX.
4075 TABLE is a list, each entry either the symbol `hline' for a horizontal
4076 separator line, or a list of fields for that line.
4077 PARAMS is a property list of parameters that can influence the conversion.
4078 Currently this function recognizes the following parameters:
4080 :splice When set to t, return only table body lines, don't wrap
4081 them into a <table> environment. Default is nil.
4083 The general parameters :skip and :skipcols have already been applied when
4084 this function is called. The function does *not* use `orgtbl-to-generic',
4085 so you cannot specify parameters for it."
4086 (let* ((splicep (plist-get params :splice))
4087 (html-table-tag org-export-html-table-tag)
4088 html)
4089 ;; Just call the formatter we already have
4090 ;; We need to make text lines for it, so put the fields back together.
4091 (setq html (org-format-org-table-html
4092 (mapcar
4093 (lambda (x)
4094 (if (eq x 'hline)
4095 "|----+----|"
4096 (concat "| " (mapconcat 'identity x " | ") " |")))
4097 table)
4098 splicep))
4100 (setq html (replace-match "" t t html)))
4101 html))
4103 (defun orgtbl-to-texinfo (table params)
4104 "Convert the orgtbl-mode TABLE to TeXInfo.
4105 TABLE is a list, each entry either the symbol `hline' for a horizontal
4106 separator line, or a list of fields for that line.
4107 PARAMS is a property list of parameters that can influence the conversion.
4108 Supports all parameters from `orgtbl-to-generic'. Most important for
4109 TeXInfo are:
4111 :splice nil/t When set to t, return only table body lines, don't wrap
4112 them into a multitable environment. Default is nil.
4114 :fmt fmt A format to be used to wrap the field, should contain
4115 %s for the original field value. For example, to wrap
4117 This may also be a property list with column numbers and
4119 Each format also may be a function that formats its one
4120 argument.
4123 are computed automatically from the width of the columns
4124 under org-mode.
4126 The general parameters :skip and :skipcols have already been applied when
4127 this function is called."
4128 (let* ((total (float (apply '+ org-table-last-column-widths)))
4129 (colfrac (or (plist-get params :cf)
4130 (mapconcat
4131 (lambda (x) (format "%.3f" (/ (float x) total)))
4132 org-table-last-column-widths " ")))
4133 (params2
4134 (list
4135 :tstart (concat "@multitable @columnfractions " colfrac)
4136 :tend "@end multitable"
4137 :lstart "@item " :lend "" :sep " @tab "
4138 :hlstart "@headitem ")))
4139 (orgtbl-to-generic table (org-combine-plists params2 params))))
4141 (defun orgtbl-to-orgtbl (table params)
4142 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4143 Useful when slicing one table into many. The :hline, :sep,
4144 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4145 and :tend suppress strings without splicing; they can be set to
4146 provide ORGTBL directives for the generated table."
4147 (let* ((params2
4148 (list
4149 :tstart nil :tend nil
4150 :hline "|---"
4151 :sep " | "
4152 :lstart "| "
4153 :lend " |"))
4154 (params (org-combine-plists params2 params)))
4155 (orgtbl-to-generic table params)))
4157 (defun org-table-get-remote-range (name-or-id form)
4158 "Get a field value or a list of values in a range from table at ID.
4160 NAME-OR-ID may be the name of a table in the current file as set by
4162 will then be used. Alternatively, it may be an ID referring to
4163 any entry, also in a different file. In this case, the first table
4164 in that netry will be referenced.
4168 The return value is either a single string for a single field, or a
4169 list of the fields in the rectangle ."
4170 (save-match-data
4171 (let ((id-loc nil)
4172 org-table-column-names org-table-column-name-regexp
4173 org-table-local-parameters org-table-named-field-locations
4174 org-table-current-line-types org-table-current-begin-line
4175 org-table-current-begin-pos org-table-dlines
4176 org-table-hlines org-table-last-alignment
4177 org-table-last-column-widths org-table-last-alignment
4178 org-table-last-column-widths tbeg
4179 buffer loc)
4180 (setq form (org-table-convert-refs-to-rc form))
4181 (save-excursion
4182 (save-restriction
4183 (widen)
4184 (save-excursion
4185 (goto-char (point-min))
4186 (if (re-search-forward
4188 nil t)
4189 (setq buffer (current-buffer) loc (match-beginning 0))
4190 (setq id-loc (org-id-find name-or-id 'marker)
4191 buffer (marker-buffer id-loc)
4192 loc (marker-position id-loc))
4193 (move-marker id-loc nil)))
4194 (switch-to-buffer buffer)
4195 (save-excursion
4196 (save-restriction
4197 (widen)
4198 (goto-char loc)
4199 (forward-char 1)
4201 (not (match-beginning 1)))
4202 (error "Cannot find a table at NAME or ID %s" name-or-id))
4203 (setq tbeg (point-at-bol))
4204 (org-table-get-specials)
4205 (setq form (org-table-formula-substitute-names form))
4206 (if (and (string-match org-table-range-regexp form)
4207 (> (length (match-string 0 form)) 1))
4208 (save-match-data
4209 (org-table-get-range (match-string 0 form) tbeg 1))
4210 form))))))))
4212 (provide 'org-table)
4214 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4216 ;;; org-table.el ends here