| blob | 5b4c1aaf7a26b7f794069bcd546c25a3e4d0903e |
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.28trans
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)
500 "Format: "
505 deffmt-readable)))
518 'hline
521 skipcols i0)))
522 lines))
526 skipcols i0))
529 skipcols i0)))
546 "Marker at the beginning of the table last aligned.
549 "Marker at the end of the table last aligned.
552 "List of flags for flushright alignment, from the last re-alignment.
555 "List of max width of fields in each column.
558 "Non-nil means, debug table formulas.
570 "Align the table at point by aligning all vertical bars."
573 ;; Limits of table
576 ;; Current cursor position
582 column
584 rfmt hfmt
592 emptystrings links dates emph narrow falign falign1 fmax f1 len c e)
595 ;; Check if we have links or dates
604 ;; Make sure the link properties are right
606 ;; Make sure the date properties are right
610 ;; Check if we are narrowing any columns
616 ;; Get the rows
619 ;; Store the indentation of the first line
622 ;; Mark the hlines by setting the corresponding element to nil
623 ;; At the same time, we remove trailing space.
626 nil
629 l)))
630 lines))
631 ;; Get the data fields by splitting the lines.
636 ;; How many fields in the longest line?
643 ;; A list of empty strings to fill any short rows on output
645 ;; Check for special formatting.
649 ;; Check if there is an explicit width specified
658 ;; Find fields that are wider than fmax, and shorten them
664 'help-echo
665 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
673 xx)))))
674 ;; Get the maximum width for each column
676 ;; Get the fraction of numbers, to decide about alignment of the column
682 nil
689 ;; Store the alignment of this table, for later editing of single fields
691 org-table-last-column-widths lengths)
693 ;; With invisible characters, `format' does not get the field width right
694 ;; So we need to make these fields wide by hand.
702 ; (string-match org-bracket-link-regexp (car c))
706 ;; Compute the formats needed for output of the table
719 hfmt))
721 ;; Replace the old one
730 ;; Try to move to the old location
738 ))
749 "Find the beginning of the table and return its position.
750 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
754 org-table-border-regexp)
755 nil t))
762 "Find the end of the table and return its position.
763 With argument TABLE-TYPE, go to the end of a table.el-type table."
767 org-table-border-regexp)
768 nil t))
774 "Justify the current field, text to left, number to right.
775 Optional argument NEW may specify text to replace the current field content."
784 ;; This is not the same table, force a full re-align
790 l f n o e)
813 "Go to the next field in the current table, creating new lines as needed.
814 Before doing so, re-align the table if necessary."
819 org-table-may-need-update)
830 org-table-tab-jumps-over-hlines
842 "Go to the previous field in the table.
843 Before doing so, re-align the table if necessary."
848 org-table-may-need-update)
863 "Move to the end of the current table field.
864 If already at or after the end, move to the end of the next table field.
865 With numeric argument N, move N-1 fields forward first."
878 "Move to the beginning of the current table field.
879 If already at or before the beginning, move to the beginning of the
880 previous field.
881 With numeric argument N, move N-1 fields backward first."
895 "Go to the next row (same column) in the current table.
896 Before doing so, re-align the table if necessary."
904 org-table-may-need-update)
918 "Copy a field down in the current column.
919 If the field at the cursor is empty, copy into it the content of the nearest
920 non-empty field above. With argument N, use the Nth non-empty field.
921 If the current field is not empty, it is copied down to the next row, and
922 the cursor is moved with it. Therefore, repeating this command causes the
923 column to be filled row-by-row.
924 If the variable `org-table-copy-increment' is non-nil and the field is an
925 integer or a timestamp, it will be incremented while copying. In the case of
926 a timestamp, if the cursor is on the year, change the year. If it is on the
927 month or the day, change that. Point will stay on the current date field
928 in order to easily repeat the interval."
936 txt)
948 beg t))
971 "Is point inside a table data field?
972 I.e. not on a hline or before the first or after the last column?
973 This actually throws an error, so it aborts the current command."
984 "Blank the current table field or active region."
1001 "Return the value of the field in column N of current row.
1002 N defaults to current field.
1003 If REPLACE is a string, replace field with this value. The return value
1004 is always the old value."
1014 val)
1018 "Show info about the current field, and highlight any reference at point."
1026 org-table-named-field-locations)))
1039 dline col
1041 dline col ref1
1043 ;; FIXME: formula info not correct if special table line
1053 "Find out which column we are in."
1059 cnt)))
1062 "Find out what table data line we are in.
1063 Only datalines count for this."
1073 cnt)))
1076 "Move the cursor to the Nth column in the current table line.
1077 With optional argument ON-DELIM, stop with point before the left delimiter
1078 of the field.
1079 If there are less than N fields, just go to after the last delimiter.
1080 However, when FORCE is non-nil, create new columns if necessary."
1091 ; (backward-char 2) t)))))
1100 "Insert a new column into the table."
1108 ;; Current cursor position
1114 nil
1126 "Find a dataline in the current table, which is needed for column commands."
1129 t
1140 t
1145 "Delete a column from the table."
1154 ;; Current cursor position
1160 nil
1175 "Move column to the right."
1179 "Move column to the left."
1184 "Move the current column to the right. With arg LEFT, move to the left."
1194 ;; Current cursor position
1204 nil
1221 "Move table row down."
1225 "Move table row up."
1230 "Move the current table line down. With arg UP, move it up."
1239 txt hline2p)
1260 "Insert a new row above the current line into the table.
1261 With prefix ARG, insert below the current line."
1267 ;; Fix the first field if necessary
1279 "Insert a horizontal-line below the current line into the table.
1280 With prefix ABOVE, insert above the current line."
1302 "Insert a hline and move to the row below that line."
1316 In particular, this does handle wide and invisible characters."
1318 ;; It's a hline, just map the characters
1324 t t s)))
1325 s))
1328 "Delete the current row or horizontal line from the table."
1341 "Sort table lines according to the column at point.
1343 The position of point indicates the column to be used for
1344 sorting, and the range of lines is the range between the nearest
1345 horizontal separator lines, or the entire table of no such lines
1346 exist. If point is before the first column, you will be prompted
1347 for the sorting column. If there is an active region, the mark
1348 specifies the first line and the sorting column, while point
1349 should be in the last line to be included into the sorting.
1351 The command then prompts for the sorting type which can be
1352 alphabetically, numerically, or by time (as given in a time stamp
1353 in the field). Sorting in reverse order is also possible.
1355 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1357 If SORTING-TYPE is specified when this function is called from a Lisp
1358 program, no prompting will take place. SORTING-TYPE must be a character,
1359 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1360 should be done in reverse order."
1364 beg end bcol ecol tend tbeg column lns pos)
1409 x))
1422 "Copy region in table to the clipboard and blank all relevant fields.
1423 If there is no active region, use just the field at point."
1430 "Copy rectangular region in table to clipboard.
1431 A special clipboard is used which can only be accessed
1432 with `org-table-paste-rectangle'."
1436 current-prefix-arg))
1438 region cols
1464 org-table-clip))
1467 "Paste a rectangular region into a table.
1468 The upper right corner ends up in the current field. All involved fields
1469 will be overwritten. If the rectangle does not fit into the present table,
1470 the table is enlarged as needed. The process ignores horizontal separator
1471 lines."
1481 c cols field)
1497 "Convert from `org-mode' table to table.el and back.
1498 Obviously, this only works within limits. When an Org-mode table is
1499 converted to table.el, all horizontal separator lines get lost, because
1500 table.el uses these as cell boundaries and has no notion of horizontal lines.
1501 A table.el table can be converted to an Org-mode table only if it does not
1502 do row or column spanning. Multiline cells will become multiple cells.
1503 Beware, Org-mode does not test if the table can be successfully converted - it
1504 blindly applies a recipe that works for simple tables."
1508 ;; convert to Org-mode table
1517 ;; convert to table.el table
1520 ;; first, get rid of all horizontal lines
1524 ;; insert a hline before first
1528 ;; insert a hline after each line
1533 ;; replace "+" at beginning and ending of hlines
1542 "Wrap several fields in a column like a paragraph.
1543 This is useful if you'd like to spread the contents of a field over several
1544 lines, in order to keep the table compact.
1546 If there is an active region, and both point and mark are in the same column,
1547 the text in the column is wrapped to minimum width for the given number of
1548 lines. Generally, this makes the table more compact. A prefix ARG may be
1550 formats the selected text to two lines. If the region was longer than two
1551 lines, the remaining lines remain empty. A negative prefix argument reduces
1552 the current number of lines by that amount. The wrapped text is pasted back
1553 into the table. If you formatted it to more lines than it was before, fields
1554 further down in the table get overwritten - so you might need to make space in
1555 the table first.
1557 If there is no region, the current field is split at the cursor position and
1558 the text fragment to the right of the cursor is prepended to the field one
1559 line down.
1561 If there is no region, but you specify a prefix ARG, the current field gets
1562 blank, and the content is appended to the field above."
1566 ;; There is a region: fill as a paragraph
1570 nlines)
1577 arg)
1581 nil nlines)))
1585 ;; No region, split the current field at point
1589 ;; combine with field above
1599 ;; split field
1612 "Edit table field in a different window.
1613 This is mainly useful for fields that contain hidden parts.
1615 it can be edited in place."
1621 display t intangible t))
1627 p)
1636 intangible t))
1644 "Finish editing a table data field.
1645 Remove all newline characters, insert the result into the table, realign
1646 the table and kill the editing buffer."
1650 text)
1686 "Sum numbers in region of current table column.
1687 The result will be displayed in the echo area, and will be available
1690 If there is an active region, it is interpreted as a rectangle and all
1691 numbers in that rectangle will be summed. If there is no active
1692 region and point is located in a table column, sum all numbers in that
1693 column.
1695 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1696 numbers are assumed to be times as well (in decimal hours) and the
1697 numbers are added as such.
1699 If NLAST is a number, only the NLAST fields will actually be summed."
1726 items1)))
1733 s diff)
1741 sres))))
1764 "Return the formula active for the current field.
1765 Assumes that specials are in place.
1766 If KEY is given, return the key to this formula.
1770 org-table-named-field-locations)))
1784 "Read a formula from the minibuffer, offer stored formula as default.
1785 When NAMED is non-nil, look for a named equation."
1789 org-table-named-field-locations)))
1796 name
1797 ref)
1807 stored)
1809 equation)
1816 scol))
1818 'org-table-formula-history
1819 )))))
1820 mustsave)
1822 ;; remove formula
1829 ;; We set the column equation, delete the named one.
1831 mustsave t))
1837 eq))
1840 "Store the list of formulas below the current table."
1846 ;; don't overwrite TBLFM, we might use text properties to store stuff
1867 "Compare two formulas for sorting."
1873 "Return an alist with the stored formulas directly after current table."
1881 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1898 "Modify the equations after the table structure has been edited.
1900 For all numbers larger than LIMIT, shift them by DELTA."
1911 s n a)
1924 t t)))))))))
1927 "Get the column names and local parameters for this table."
1930 names name fields fields1 field cnt
1931 c v l line col types dlines hlines last-dline)
1933 org-table-local-parameters nil
1934 org-table-named-field-locations nil
1935 org-table-current-begin-line nil
1936 org-table-current-begin-pos nil
1937 org-table-current-line-types nil)
1955 org-table-local-parameters))))
1971 ;; Analyse the line types
1975 l org-table-current-begin-line)
1992 al al2)
2004 If yes, store the formula and apply it."
2005 ;; We already know we are in a table. Get field will only return a formula
2006 ;; when appropriate. It might return a separator line, but no problem.
2009 named eq)
2020 "List of commands triggering the recalculation of a line.
2033 "Rotate the recalculation mark in the first column.
2034 If in any row, the first field is not consistent with a mark,
2035 insert a new column for the markers.
2036 When there is an active region, change all the lines in the region,
2037 after prompting for the marking character.
2038 After each change, a message will be displayed indicating the meaning
2039 of the new mark."
2054 epos new)
2061 newchar))
2093 "Recompute the current line if marked for it, and if we haven't just done it."
2113 modes)
2116 suppress-align suppress-const
2117 suppress-store suppress-analysis)
2118 "Replace the table field value at the cursor by the result of a calculation.
2120 This function makes use of Dave Gillespie's Calc package, in my view the
2121 most exciting program ever written for GNU Emacs. So you need to have Calc
2122 installed in order to use this function.
2124 In a table, this command replaces the value in the current field with the
2126 formula, by storing it in a special line below the table. When called
2127 with a `C-u' prefix, the current field must ba a named field, and the
2128 formula is installed as valid in only this specific field.
2130 When called with two `C-u' prefixes, insert the active equation
2131 for the field back into the current field, so that it can be
2133 to check the referenced fields.
2135 When called, the command first prompts for a formula, which is read in
2136 the minibuffer. Previously entered formulas are available through the
2137 history list, and the last used formula is offered as a default.
2138 These stored formulas are adapted correctly when moving, inserting, or
2139 deleting columns with the corresponding commands.
2141 The formula can be any algebraic expression understood by the Calc package.
2142 For details, see the Org-mode manual.
2144 This function can also be called from Lisp programs and offers
2145 additional arguments: EQUATION can be the formula to apply. If this
2146 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2147 used to speed-up recursive calls by by-passing unnecessary aligns.
2148 SUPPRESS-CONST suppresses the interpretation of constants in the
2149 formula, assuming that this has been done already outside the function.
2150 SUPPRESS-STORE means the formula should not be stored, either because
2151 it is already stored, or because it is a modified equation that should
2152 not overwrite the stored one."
2168 equation
2174 n form form0 bw fmt x ev orig c lispp literal)
2175 ;; Parse the format string. Since we have a lot of modes, this is
2176 ;; a lot of work. However, I think calc still uses most of the time.
2188 'calc-float-format
2191 n))))
2218 fields)))
2223 ;; Check for old vertical references
2225 ;; Insert remote references
2233 keep-empty numbers lispp))
2234 t t form)))
2235 ;; Insert complex ranges
2243 keep-empty numbers lispp))
2244 t t form)))
2245 ;; Insert simple ranges
2254 keep-empty numbers lispp))
2255 t t form)))
2257 ;; Insert the references to fields in same row
2266 t t form)))
2281 Orig: %s
2282 $xyz-> %s
2283 @r$c-> %s
2314 prop value)))
2317 "Get a calc vector from a column, according to descriptor DESC.
2318 Optional arguments TBEG and COL can give the beginning of the table and
2319 the current column, to avoid unnecessary parsing.
2320 HIGHLIGHT means, just highlight the range."
2327 beg end c1 c2 r1 r2 rangep tmp)
2344 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2350 ;; just one field
2357 ;; A range, return a vector
2358 ;; First sort the numbers to get a regular ractangle
2374 ;; return string representation of calc vector
2379 "Analyze descriptor DESC and retrieve the corresponding line number.
2380 The cursor is currently in line CLINE, the table begins in line BLINE,
2381 and TABLE is a vector with line types."
2389 ;; 1 2 3 4 5 6
2409 nil hn cline desc)))
2412 rel on cline desc)))
2416 "FIXME: Needs more documentation."
2429 nil))
2430 t)))
2434 desc cline)
2435 i)))
2440 s))
2443 "Convert list ELEMENTS to something appropriate to insert into formula.
2444 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2445 NUMBERS indicates that everything should be converted to numbers.
2446 LISPP means to return something appropriate for a Lisp list."
2450 elements
2459 elements))))
2465 x
2471 elements
2475 "Recalculate the current table line by applying all stored formulas.
2476 With prefix arg ALL, do this for all lines in the table.
2477 With the prefix argument ALL is `(16)' (a double `C-c C-u' prefix), or if
2478 it is the symbol `iterate', recompute the table until it no longer changes.
2479 If NOALIGN is not nil, do not re-align the table after the computations
2480 are done. This is typically used internally to save time, if it is
2481 known that the table will be realigned a little later anyway."
2496 ;; Insert constants in all formulas
2500 x)
2501 eqlist))
2502 ;; Split the equation list
2513 ;; This is a table with marked lines, compute selected lines
2515 ;; Move forward to the first non-header line
2526 ;; First find the named fields, and mark them untouchable
2538 name)))
2547 ;; Now evauluate the column formulas, but skip fields covered by
2548 ;; field formulas
2552 ;; Unprotected line, recalculate
2564 ;; Now evaluate the field formulas
2578 ;; back to initial position
2586 "Recalculate the table until it does not change anymore."
2591 thistbl)
2606 "Replace $const with values in string F."
2608 ;; First, check for column names
2613 ;; Parameters and constants
2615 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2625 f))
2628 "Find the value for a parameter or constant in a formula.
2629 Parameters get priority."
2659 map))
2666 "--"
2669 "--"
2670 "Shift Reference at Point"
2675 "-"
2676 "Change Test Row for Column Formulas"
2679 "--"
2684 org-table-overlay-coordinates)]
2685 "--"
2692 "Edit the formulas of the current table in a separate buffer."
2707 entry s type title)
2710 ;; Keep global-font-lock-mode from turning on font-lock-mode
2749 "Convert a formula from internal to user representation."
2752 s))
2755 "Convert a formula from user to internal representation."
2758 s))
2761 "Convert spreadsheet references from AB7 to @7$28.
2762 Works for single references, but also for entire formulas and even the
2763 full TBLFM line."
2765 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2768 ;; format match, just advance
2773 ;; 3.e5 or something like this.
2783 t t s)))))
2784 s))
2787 "Convert spreadsheet references from to @7$28 to AB7.
2788 Works for single references, but also for entire formulas and even the
2789 full TBLFM line."
2796 t t s)))
2801 t nil s)))
2802 s)
2805 "Convert a base 26 number represented by letters into an integer.
2806 For example: AB -> 28."
2812 n))
2815 "Convert an integer into a base 26 number represented by letters.
2816 For example: 28 -> AB."
2821 s))
2824 "Convert all references in this buffer, using FUNCTION."
2834 "Convert all references in the buffer from B3 to @3$2 and back."
2844 "Shift the reference at point one row/hline up."
2848 "Shift the reference at point one row/hline down."
2852 "Shift the reference at point one field to the left."
2856 "Shift the reference at point one field to the right."
2867 ;; A B3-like reference
2873 ;; An internal reference
2879 "Re-match the group N, and replace it with the shifted refrence."
2884 t t)))
2887 "Shift a refrence part REF.
2888 If DECR is set, decrease the references row/column, else increase.
2889 If HLINE is set, this may be a hline reference, it certainly is not
2890 a translation reference."
2919 "Toggle the display of coordinates in the referenced table."
2928 "Parse the buffer for formula definitions and install them.
2929 With prefix ARG, apply the new formulas to the table."
2940 nil t)
2964 "Abort editing formulas, without installing the changes."
2975 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3016 "Show the location/value of the $ expression at point."
3025 var name e what match dest)
3107 ;; column number
3135 org-table-fedit-scroll-down))))
3146 "Make sure the cursor is in a dataline in a table."
3155 p1 p2)))
3160 "Move cursor one line up in the window showing the table."
3165 "Move cursor one line down in the window showing the table."
3170 "Move the cursor in the window showing the table.
3171 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3196 "Add a new overlay."
3202 "Highlight rectangular region in a table."
3206 l1 c1 l2 c2 tmp)
3230 "Remove the rectangle overlays."
3241 "Add overlays to the table at point, to show row/column coordinates."
3270 "Toggle the display of Row/Column numbers in tables."
3282 "Toggle the formula debugger in tables."
3288 ;;; The orgtbl minor mode
3290 ;; Define a minor mode which can be used in other modes in order to
3291 ;; integrate the org-mode table editor.
3293 ;; This is really a hack, because the org-mode table editor uses several
3294 ;; keys which normally belong to the major mode, for example the TAB and
3295 ;; RET keys. Here is how it works: The minor mode defines all the keys
3296 ;; necessary to operate the table editor, but wraps the commands into a
3297 ;; function which tests if the cursor is currently inside a table. If that
3298 ;; is the case, the table editor command is executed. However, when any of
3299 ;; those keys is used outside a table, the function uses `key-binding' to
3300 ;; look up if the key has an associated command in another currently active
3301 ;; keymap (minor modes, major mode, global), and executes that command.
3302 ;; There might be problems if any of the keys used by the table editor is
3303 ;; otherwise used as a prefix key.
3305 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3306 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3307 ;; addresses this by checking explicitly for both bindings.
3309 ;; The optimized version (see variable `orgtbl-optimized') takes over
3310 ;; all keys which are bound to `self-insert-command' in the *global map*.
3311 ;; Some modes bind other commands to simple characters, for example
3312 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3313 ;; active, this binding is ignored inside tables and replaced with a
3314 ;; modified self-insert.
3317 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
3324 ;;;###autoload
3326 "Unconditionally turn on `orgtbl-mode'."
3340 ;;;###autoload
3342 "The `org-mode' table editor as a minor mode for use in other modes."
3346 ;; Exit without error, in case some hook functions calls this
3347 ;; by accident in org-mode.
3354 ;; Make sure we are first in minor-mode-map-alist
3362 auto-fill-inhibit-regexp)
3366 auto-fill-inhibit-regexp)
3367 orgtbl-line-start-regexp))
3385 "Remove all properties related to narrow-column invisibility."
3397 ;; Install it as a minor mode.
3403 "Create a function for binding in the table minor mode.
3404 FUN is the command to call inside a table. N is used to create a unique
3405 command name. KEYS are keys that should be checked in for a command
3406 to execute outside of tables."
3412 "Outside of tables, run the binding of `"
3424 keys)
3428 "Error when there is no default binding for a table key."
3433 "Setup orgtbl keymaps."
3464 elt key fun cmd)
3472 ;; Special treatment needed for TAB and RET
3490 [(tab)] "\C-i"))
3492 (org-defkey orgtbl-mode-map [backtab]
3494 [backtab] [S-iso-lefttab] [(shift tab)]
3495 [(tab)] "\C-i"))
3497 (org-defkey orgtbl-mode-map "\M-\C-m"
3498 (orgtbl-make-binding 'org-table-wrap-region 105
3499 "\M-\C-m" [(meta return)]))
3500 (org-defkey orgtbl-mode-map [(meta return)]
3501 (orgtbl-make-binding 'org-table-wrap-region 106
3502 [(meta return)] "\M-\C-m"))
3504 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3505 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3507 (when orgtbl-optimized
3508 ;; If the user wants maximum table support, we need to hijack
3509 ;; some standard editing functions
3510 (org-remap orgtbl-mode-map
3511 'self-insert-command 'orgtbl-self-insert-command
3512 'delete-char 'org-delete-char
3513 'delete-backward-char 'org-delete-backward-char)
3514 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3515 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3516 '("OrgTbl"
3517 ["Create or convert" org-table-create-or-convert-from-region
3518 :active (not (org-at-table-p)) :keys "C-c |" ]
3519 "--"
3520 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3521 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3522 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3523 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3524 "--"
3525 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3526 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3527 ["Copy Field from Above"
3528 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3529 "--"
3530 ("Column"
3531 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3532 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3533 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3534 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3535 ("Row"
3536 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3537 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3538 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3539 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3540 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3541 "--"
3542 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3543 ("Rectangle"
3544 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3545 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3546 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3547 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3548 "--"
3549 ("Radio tables"
3550 ["Insert table template" orgtbl-insert-radio-table
3551 (assq major-mode orgtbl-radio-table-templates)]
3552 ["Comment/uncomment table" orgtbl-toggle-comment t])
3553 "--"
3554 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3555 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3556 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3557 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3558 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3559 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3560 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3561 ["Sum Column/Rectangle" org-table-sum
3562 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3563 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3564 ["Debug Formulas"
3565 org-table-toggle-formula-debugger :active (org-at-table-p)
3566 :keys "C-c {"
3567 :style toggle :selected org-table-formula-debug]
3568 ["Show Col/Row Numbers"
3569 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3570 :keys "C-c }"
3571 :style toggle :selected org-table-overlay-coordinates]
3572 ))
3573 t))
3575 (defun orgtbl-ctrl-c-ctrl-c (arg)
3576 "If the cursor is inside a table, realign the table.
3577 If it is a table to be sent away to a receiver, do it.
3578 With prefix arg, also recompute table."
3579 (interactive "P")
3580 (let ((pos (point)) action)
3581 (save-excursion
3582 (beginning-of-line 1)
3586 (cond
3587 ((integerp action)
3588 (goto-char action)
3589 (org-table-maybe-eval-formula)
3590 (if arg
3591 (call-interactively 'org-table-recalculate)
3592 (org-table-maybe-recalculate-line))
3593 (call-interactively 'org-table-align)
3594 (orgtbl-send-table 'maybe))
3595 ((eq action 'recalc)
3596 (save-excursion
3597 (beginning-of-line 1)
3599 (if (org-at-table-p)
3600 (org-call-with-arg 'org-table-recalculate t))))
3601 (t (let (orgtbl-mode)
3602 (call-interactively (key-binding "\C-c\C-c")))))))
3604 (defun orgtbl-create-or-convert-from-region (arg)
3605 "Create table or convert region to table, if no conflicting binding.
3606 This installs the table binding `C-c |', but only if there is no
3607 conflicting binding to this key outside orgtbl-mode."
3608 (interactive "P")
3609 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3610 (if cmd
3611 (call-interactively cmd)
3612 (call-interactively 'org-table-create-or-convert-from-region))))
3614 (defun orgtbl-tab (arg)
3615 "Justification and field motion for `orgtbl-mode'."
3616 (interactive "P")
3617 (if arg (org-table-edit-field t)
3618 (org-table-justify-field-maybe)
3619 (org-table-next-field)))
3621 (defun orgtbl-ret ()
3622 "Justification and field motion for `orgtbl-mode'."
3623 (interactive)
3624 (if (bobp)
3625 (newline)
3626 (org-table-justify-field-maybe)
3627 (org-table-next-row)))
3629 (defun orgtbl-self-insert-command (N)
3630 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3631 If the cursor is in a table looking at whitespace, the whitespace is
3632 overwritten, and the table is not marked as requiring realignment."
3633 (interactive "p")
3634 (if (and (org-at-table-p)
3635 (or
3636 (and org-table-auto-blank-field
3637 (member last-command
3638 '(orgtbl-hijacker-command-100
3639 orgtbl-hijacker-command-101
3640 orgtbl-hijacker-command-102
3641 orgtbl-hijacker-command-103
3642 orgtbl-hijacker-command-104
3643 orgtbl-hijacker-command-105
3644 yas/expand))
3645 (org-table-blank-field))
3646 t)
3647 (eq N 1)
3649 (let (org-table-may-need-update)
3650 (goto-char (1- (match-end 0)))
3651 (delete-backward-char 1)
3652 (goto-char (match-beginning 0))
3653 (self-insert-command N))
3654 (setq org-table-may-need-update t)
3655 (let* (orgtbl-mode
3656 a
3657 (cmd (or (key-binding
3658 (or (and (listp function-key-map)
3659 (setq a (assoc last-input-event function-key-map))
3660 (cdr a))
3661 (vector last-input-event)))
3662 'self-insert-command)))
3663 (call-interactively cmd)
3664 (if (and org-self-insert-cluster-for-undo
3665 (eq cmd 'self-insert-command))
3666 (if (not (eq last-command 'orgtbl-self-insert-command))
3667 (setq org-self-insert-command-undo-counter 1)
3668 (if (>= org-self-insert-command-undo-counter 20)
3669 (setq org-self-insert-command-undo-counter 1)
3670 (and (> org-self-insert-command-undo-counter 0)
3671 buffer-undo-list
3672 (not (cadr buffer-undo-list)) ; remove nil entry
3673 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3674 (setq org-self-insert-command-undo-counter
3675 (1+ org-self-insert-command-undo-counter))))))))
3678 "Regular expression matching exponentials as produced by calc.")
3680 (defun orgtbl-export (table target)
3681 (require 'org-exp)
3682 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3684 org-table-last-alignment org-table-last-column-widths
3685 maxcol column)
3686 (if (not (fboundp func))
3687 (error "Cannot export orgtbl table to %s" target))
3688 (setq lines (org-table-clean-before-export lines))
3689 (setq table
3690 (mapcar
3691 (lambda (x)
3692 (if (string-match org-table-hline-regexp x)
3693 'hline
3695 lines))
3696 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3697 table)))
3698 (loop for i from (1- maxcol) downto 0 do
3699 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3700 (setq column (delq nil column))
3701 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3702 (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))
3703 (funcall func table nil)))
3705 (defun orgtbl-gather-send-defs ()
3706 "Gathers a plist of :name, :transform, :params for each destination before
3707 a radio table."
3708 (save-excursion
3709 (goto-char (org-table-begin))
3710 (let (rtn)
3711 (beginning-of-line 0)
3712 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
3713 (let ((name (org-no-properties (match-string 1)))
3714 (transform (intern (match-string 2)))
3715 (params (if (match-end 3)
3716 (read (concat "(" (match-string 3) ")")))))
3717 (push (list :name name :transform transform :params params)
3718 rtn)
3719 (beginning-of-line 0)))
3720 rtn)))
3722 (defun orgtbl-send-replace-tbl (name txt)
3723 "Find and replace table NAME with TXT."
3724 (save-excursion
3725 (goto-char (point-min))
3726 (unless (re-search-forward
3728 (error "Don't know where to insert translated table"))
3729 (goto-char (match-beginning 0))
3730 (beginning-of-line 2)
3731 (save-excursion
3732 (let ((beg (point)))
3733 (unless (re-search-forward
3734 (concat "END RECEIVE ORGTBL +" name) nil t)
3735 (error "Cannot find end of insertion region"))
3736 (beginning-of-line 1)
3737 (delete-region beg (point))))
3740 ;;;###autoload
3741 (defun org-table-to-lisp (&optional txt)
3742 "Convert the table at point to a Lisp structure.
3743 The structure will be a list. Each item is either the symbol `hline'
3744 for a horizontal separator line, or a list of field values as strings.
3745 The table is taken from the parameter TXT, or from the buffer at point."
3746 (unless txt
3747 (unless (org-at-table-p)
3748 (error "No table at point")))
3749 (let* ((txt (or txt
3750 (buffer-substring-no-properties (org-table-begin)
3751 (org-table-end))))
3754 (mapcar
3755 (lambda (x)
3756 (if (string-match org-table-hline-regexp x)
3757 'hline
3759 lines)))
3761 (defun orgtbl-send-table (&optional maybe)
3762 "Send a transformed version of this table to the receiver position.
3763 With argument MAYBE, fail quietly if no transformation is defined for
3764 this table."
3765 (interactive)
3766 (catch 'exit
3767 (unless (org-at-table-p) (error "Not at a table"))
3768 ;; when non-interactive, we assume align has just happened.
3769 (when (interactive-p) (org-table-align))
3770 (let ((dests (orgtbl-gather-send-defs))
3771 (txt (buffer-substring-no-properties (org-table-begin)
3772 (org-table-end)))
3773 (ntbl 0))
3774 (unless dests (if maybe (throw 'exit nil)
3775 (error "Don't know how to transform this table.")))
3776 (dolist (dest dests)
3777 (let* ((name (plist-get dest :name))
3778 (transform (plist-get dest :transform))
3779 (params (plist-get dest :params))
3780 (skip (plist-get params :skip))
3781 (skipcols (plist-get params :skipcols))
3782 beg
3783 (lines (org-table-clean-before-export
3784 (nthcdr (or skip 0)
3786 (i0 (if org-table-clean-did-remove-column 2 1))
3787 (table (mapcar
3788 (lambda (x)
3789 (if (string-match org-table-hline-regexp x)
3790 'hline
3791 (org-remove-by-index
3793 skipcols i0)))
3794 lines))
3795 (fun (if (= i0 2) 'cdr 'identity))
3796 (org-table-last-alignment
3797 (org-remove-by-index (funcall fun org-table-last-alignment)
3798 skipcols i0))
3799 (org-table-last-column-widths
3800 (org-remove-by-index (funcall fun org-table-last-column-widths)
3801 skipcols i0))
3802 (txt (if (fboundp transform)
3803 (funcall transform table params)
3804 (error "No such transformation function %s" transform))))
3805 (orgtbl-send-replace-tbl name txt))
3806 (setq ntbl (1+ ntbl)))
3807 (message "Table converted and installed at %d receiver location%s"
3808 ntbl (if (> ntbl 1) "s" "")))))
3810 (defun org-remove-by-index (list indices &optional i0)
3811 "Remove the elements in LIST with indices in INDICES.
3812 First element has index 0, or I0 if given."
3813 (if (not indices)
3814 list
3815 (if (integerp indices) (setq indices (list indices)))
3816 (setq i0 (1- (or i0 0)))
3817 (delq :rm (mapcar (lambda (x)
3818 (setq i0 (1+ i0))
3819 (if (memq i0 indices) :rm x))
3820 list))))
3822 (defun orgtbl-toggle-comment ()
3823 "Comment or uncomment the orgtbl at point."
3824 (interactive)
3825 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3826 (re2 (concat "^" orgtbl-line-start-regexp))
3827 (commented (save-excursion (beginning-of-line 1)
3828 (cond ((looking-at re1) t)
3829 ((looking-at re2) nil)
3830 (t (error "Not at an org table")))))
3831 (re (if commented re1 re2))
3832 beg end)
3833 (save-excursion
3834 (beginning-of-line 1)
3835 (while (looking-at re) (beginning-of-line 0))
3836 (beginning-of-line 2)
3837 (setq beg (point))
3838 (while (looking-at re) (beginning-of-line 2))
3839 (setq end (point)))
3840 (comment-region beg end (if commented '(4) nil))))
3842 (defun orgtbl-insert-radio-table ()
3843 "Insert a radio table template appropriate for this major mode."
3844 (interactive)
3845 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3846 (txt (nth 1 e))
3847 name pos)
3848 (unless e (error "No radio table setup defined for %s" major-mode))
3849 (setq name (read-string "Table name: "))
3850 (while (string-match "%n" txt)
3851 (setq txt (replace-match name t t txt)))
3853 (setq pos (point))
3854 (insert txt)
3855 (goto-char pos)))
3857 ;; Dynamically bound input and output for table formatting.
3858 (defvar *orgtbl-table* nil
3859 "Carries the current table through formatting routines.")
3860 (defvar *orgtbl-rtn* nil
3861 "Formatting routines push the output lines here.")
3862 ;; Formatting parameters for the current table section.
3863 (defvar *orgtbl-hline* nil "Text used for horizontal lines")
3864 (defvar *orgtbl-sep* nil "Text used as a column separator")
3865 (defvar *orgtbl-default-fmt* nil "Default format for each entry")
3866 (defvar *orgtbl-fmt* nil "Format for each entry")
3867 (defvar *orgtbl-efmt* nil "Format for numbers")
3868 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt")
3869 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row")
3870 (defvar *orgtbl-lstart* nil "Text starting a row")
3871 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row")
3872 (defvar *orgtbl-lend* nil "Text ending a row")
3873 (defvar *orgtbl-llend* nil "Specializes lend for the last row")
3875 (defsubst orgtbl-get-fmt (fmt i)
3876 "Retrieve the format from FMT corresponding to the Ith column."
3877 (if (and (not (functionp fmt)) (consp fmt))
3878 (plist-get fmt i)
3879 fmt))
3881 (defsubst orgtbl-apply-fmt (fmt &rest args)
3882 "Apply format FMT to the arguments. NIL FMTs return the first argument."
3883 (cond ((functionp fmt) (apply fmt args))
3884 (fmt (apply 'format fmt args))
3885 (args (car args))
3886 (t args)))
3888 (defsubst orgtbl-eval-str (str)
3889 "If STR is a function, evaluate it with no arguments."
3890 (if (functionp str)
3891 (funcall str)
3892 str))
3894 (defun orgtbl-format-line (line)
3895 "Format LINE as a table row."
3896 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
3897 (let* ((i 0)
3898 (line
3899 (mapcar
3900 (lambda (f)
3901 (setq i (1+ i))
3902 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
3903 (f (if (and efmt (string-match orgtbl-exp-regexp f))
3904 (orgtbl-apply-fmt efmt (match-string 1 f)
3905 (match-string 2 f))
3906 f)))
3907 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
3908 *orgtbl-default-fmt*)
3909 f)))
3910 line)))
3911 (push (if *orgtbl-lfmt*
3912 (orgtbl-apply-fmt *orgtbl-lfmt* line)
3913 (concat (orgtbl-eval-str *orgtbl-lstart*)
3914 (mapconcat 'identity line *orgtbl-sep*)
3915 (orgtbl-eval-str *orgtbl-lend*)))
3916 *orgtbl-rtn*))))
3918 (defun orgtbl-format-section (section-stopper)
3919 "Format lines until the first occurrence of SECTION-STOPPER."
3920 (let (prevline)
3921 (progn
3922 (while (not (eq (car *orgtbl-table*) section-stopper))
3923 (if prevline (orgtbl-format-line prevline))
3924 (setq prevline (pop *orgtbl-table*)))
3925 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
3926 (*orgtbl-lend* *orgtbl-llend*)
3927 (*orgtbl-lfmt* *orgtbl-llfmt*))
3928 (orgtbl-format-line prevline))))))
3930 (defun orgtbl-to-generic (table params)
3931 "Convert the orgtbl-mode TABLE to some other format.
3932 This generic routine can be used for many standard cases.
3933 TABLE is a list, each entry either the symbol `hline' for a horizontal
3934 separator line, or a list of fields for that line.
3935 PARAMS is a property list of parameters that can influence the conversion.
3936 For the generic converter, some parameters are obligatory: You need to
3937 specify either :lfmt, or all of (:lstart :lend :sep).
3939 Valid parameters are
3941 :splice When set to t, return only table body lines, don't wrap
3942 them into :tstart and :tend. Default is nil. When :splice
3943 is non-nil, this also means that the exporter should not look
3944 for and interpret header and footer sections.
3946 :hline String to be inserted on horizontal separation lines.
3947 May be nil to ignore hlines.
3949 :sep Separator between two fields
3950 :remove-nil-lines Do not include lines that evaluate to nil.
3953 Each in the following group may be either a string or a function
3954 of no arguments returning a string:
3955 :tstart String to start the table. Ignored when :splice is t.
3956 :tend String to end the table. Ignored when :splice is t.
3957 :lstart String to start a new table line.
3958 :llstart String to start the last table line, defaults to :lstart.
3959 :lend String to end a table line
3960 :llend String to end the last table line, defaults to :lend.
3962 Each in the following group may be a string, a function of one
3963 argument (the field or line) returning a string, or a plist
3964 mapping columns to either of the above:
3965 :lfmt Format for entire line, with enough %s to capture all fields.
3966 If this is present, :lstart, :lend, and :sep are ignored.
3967 :llfmt Format for the entire last line, defaults to :lfmt.
3968 :fmt A format to be used to wrap the field, should contain
3969 %s for the original field value. For example, to wrap
3971 This may also be a property list with column numbers and
3974 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
3975 Same as above, specific for the header lines in the table.
3976 All lines before the first hline are treated as header.
3977 If any of these is not present, the data line value is used.
3979 This may be either a string or a function of two arguments:
3980 :efmt Use this format to print numbers with exponentials.
3981 The format should have %s twice for inserting mantissa
3983 may also be a property list with column numbers and
3984 formats. :fmt will still be applied after :efmt.
3986 In addition to this, the parameters :skip and :skipcols are always handled
3987 directly by `orgtbl-send-table'. See manual."
3988 (interactive)
3990 (let* ((splicep (plist-get params :splice))
3991 (hline (plist-get params :hline))
3992 (remove-nil-linesp (plist-get params :remove-nil-lines))
3993 (*orgtbl-hline* hline)
3994 (*orgtbl-table* table)
3995 (*orgtbl-sep* (plist-get params :sep))
3996 (*orgtbl-efmt* (plist-get params :efmt))
3997 (*orgtbl-lstart* (plist-get params :lstart))
3998 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
3999 (*orgtbl-lend* (plist-get params :lend))
4000 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4001 (*orgtbl-lfmt* (plist-get params :lfmt))
4002 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4003 (*orgtbl-fmt* (plist-get params :fmt))
4004 *orgtbl-rtn*)
4006 ;; Put header
4007 (unless splicep
4008 (when (plist-member params :tstart)
4009 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4010 (if tstart (push tstart *orgtbl-rtn*)))))
4012 ;; Do we have a heading section? If so, format it and handle the
4013 ;; trailing hline.
4014 (if (and (not splicep)
4015 (or (consp (car *orgtbl-table*))
4016 (consp (nth 1 *orgtbl-table*)))
4017 (memq 'hline (cdr *orgtbl-table*)))
4018 (progn
4019 (when (eq 'hline (car *orgtbl-table*))
4020 ;; there is a hline before the first data line
4021 (and hline (push hline *orgtbl-rtn*))
4022 (pop *orgtbl-table*))
4023 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4024 *orgtbl-lstart*))
4025 (*orgtbl-llstart* (or (plist-get params :hllstart)
4026 *orgtbl-llstart*))
4027 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4028 (*orgtbl-llend* (or (plist-get params :hllend)
4029 (plist-get params :hlend) *orgtbl-llend*))
4030 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4031 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4032 (plist-get params :hlfmt) *orgtbl-llfmt*))
4033 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4034 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4035 (orgtbl-format-section 'hline))
4036 (if hline (push hline *orgtbl-rtn*))
4037 (pop *orgtbl-table*)))
4039 ;; Now format the main section.
4040 (orgtbl-format-section nil)
4042 (unless splicep
4043 (when (plist-member params :tend)
4044 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4045 (if tend (push tend *orgtbl-rtn*)))))
4047 (mapconcat 'identity (nreverse (if remove-nil-linesp
4048 (remq nil *orgtbl-rtn*)
4051 (defun orgtbl-to-tsv (table params)
4052 "Convert the orgtbl-mode table to TAB separated material."
4054 (defun orgtbl-to-csv (table params)
4055 "Convert the orgtbl-mode table to CSV material.
4056 This does take care of the proper quoting of fields with comma or quotes."
4057 (orgtbl-to-generic table (org-combine-plists
4058 '(:sep "," :fmt org-quote-csv-field)
4059 params)))
4061 (defun orgtbl-to-latex (table params)
4062 "Convert the orgtbl-mode TABLE to LaTeX.
4063 TABLE is a list, each entry either the symbol `hline' for a horizontal
4064 separator line, or a list of fields for that line.
4065 PARAMS is a property list of parameters that can influence the conversion.
4066 Supports all parameters from `orgtbl-to-generic'. Most important for
4067 LaTeX are:
4069 :splice When set to t, return only table body lines, don't wrap
4070 them into a tabular environment. Default is nil.
4072 :fmt A format to be used to wrap the field, should contain %s for the
4073 original field value. For example, to wrap everything in dollars,
4076 The format may also be a function that formats its one argument.
4078 :efmt Format for transforming numbers with exponentials. The format
4079 should have %s twice for inserting mantissa and exponent, for
4081 This may also be a property list with column numbers and formats.
4082 The format may also be a function that formats its two arguments.
4084 :llend If you find too much space below the last line of a table,
4087 The general parameters :skip and :skipcols have already been applied when
4088 this function is called."
4089 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4090 org-table-last-alignment ""))
4091 (params2
4092 (list
4097 (orgtbl-to-generic table (org-combine-plists params2 params))))
4099 (defun orgtbl-to-html (table params)
4100 "Convert the orgtbl-mode TABLE to LaTeX.
4101 TABLE is a list, each entry either the symbol `hline' for a horizontal
4102 separator line, or a list of fields for that line.
4103 PARAMS is a property list of parameters that can influence the conversion.
4104 Currently this function recognizes the following parameters:
4106 :splice When set to t, return only table body lines, don't wrap
4107 them into a <table> environment. Default is nil.
4109 The general parameters :skip and :skipcols have already been applied when
4110 this function is called. The function does *not* use `orgtbl-to-generic',
4111 so you cannot specify parameters for it."
4112 (let* ((splicep (plist-get params :splice))
4113 (html-table-tag org-export-html-table-tag)
4114 html)
4115 ;; Just call the formatter we already have
4116 ;; We need to make text lines for it, so put the fields back together.
4117 (setq html (org-format-org-table-html
4118 (mapcar
4119 (lambda (x)
4120 (if (eq x 'hline)
4121 "|----+----|"
4122 (concat "| " (mapconcat 'identity x " | ") " |")))
4123 table)
4124 splicep))
4126 (setq html (replace-match "" t t html)))
4127 html))
4129 (defun orgtbl-to-texinfo (table params)
4130 "Convert the orgtbl-mode TABLE to TeXInfo.
4131 TABLE is a list, each entry either the symbol `hline' for a horizontal
4132 separator line, or a list of fields for that line.
4133 PARAMS is a property list of parameters that can influence the conversion.
4134 Supports all parameters from `orgtbl-to-generic'. Most important for
4135 TeXInfo are:
4137 :splice nil/t When set to t, return only table body lines, don't wrap
4138 them into a multitable environment. Default is nil.
4140 :fmt fmt A format to be used to wrap the field, should contain
4141 %s for the original field value. For example, to wrap
4143 This may also be a property list with column numbers and
4145 Each format also may be a function that formats its one
4146 argument.
4149 are computed automatically from the width of the columns
4150 under org-mode.
4152 The general parameters :skip and :skipcols have already been applied when
4153 this function is called."
4154 (let* ((total (float (apply '+ org-table-last-column-widths)))
4155 (colfrac (or (plist-get params :cf)
4156 (mapconcat
4157 (lambda (x) (format "%.3f" (/ (float x) total)))
4158 org-table-last-column-widths " ")))
4159 (params2
4160 (list
4161 :tstart (concat "@multitable @columnfractions " colfrac)
4162 :tend "@end multitable"
4163 :lstart "@item " :lend "" :sep " @tab "
4164 :hlstart "@headitem ")))
4165 (orgtbl-to-generic table (org-combine-plists params2 params))))
4167 (defun orgtbl-to-orgtbl (table params)
4168 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4169 Useful when slicing one table into many. The :hline, :sep,
4170 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4171 and :tend suppress strings without splicing; they can be set to
4172 provide ORGTBL directives for the generated table."
4173 (let* ((params2
4174 (list
4175 :tstart nil :tend nil
4176 :hline "|---"
4177 :sep " | "
4178 :lstart "| "
4179 :lend " |"))
4180 (params (org-combine-plists params2 params)))
4181 (orgtbl-to-generic table params)))
4183 (defun org-table-get-remote-range (name-or-id form)
4184 "Get a field value or a list of values in a range from table at ID.
4186 NAME-OR-ID may be the name of a table in the current file as set by
4188 will then be used. Alternatively, it may be an ID referring to
4189 any entry, also in a different file. In this case, the first table
4190 in that netry will be referenced.
4194 The return value is either a single string for a single field, or a
4195 list of the fields in the rectangle ."
4196 (save-match-data
4197 (let ((id-loc nil)
4198 org-table-column-names org-table-column-name-regexp
4199 org-table-local-parameters org-table-named-field-locations
4200 org-table-current-line-types org-table-current-begin-line
4201 org-table-current-begin-pos org-table-dlines
4202 org-table-hlines org-table-last-alignment
4203 org-table-last-column-widths org-table-last-alignment
4204 org-table-last-column-widths tbeg
4205 buffer loc)
4206 (setq form (org-table-convert-refs-to-rc form))
4207 (save-excursion
4208 (save-restriction
4209 (widen)
4210 (save-excursion
4211 (goto-char (point-min))
4212 (if (re-search-forward
4214 nil t)
4215 (setq buffer (current-buffer) loc (match-beginning 0))
4216 (setq id-loc (org-id-find name-or-id 'marker))
4217 (unless (and id-loc (markerp id-loc))
4219 (setq buffer (marker-buffer id-loc)
4220 loc (marker-position id-loc))
4221 (move-marker id-loc nil)))
4222 (switch-to-buffer buffer)
4223 (save-excursion
4224 (save-restriction
4225 (widen)
4226 (goto-char loc)
4227 (forward-char 1)
4229 (not (match-beginning 1)))
4230 (error "Cannot find a table at NAME or ID %s" name-or-id))
4231 (setq tbeg (point-at-bol))
4232 (org-table-get-specials)
4233 (setq form (org-table-formula-substitute-names form))
4234 (if (and (string-match org-table-range-regexp form)
4235 (> (length (match-string 0 form)) 1))
4236 (save-match-data
4237 (org-table-get-range (match-string 0 form) tbeg 1))
4238 form))))))))
4240 (provide 'org-table)
4242 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4244 ;;; org-table.el ends here