| blob | 3cbdb207bfc2dcead9cbe5da0ab4bfee172032b2 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.01a
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 relative 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 cross 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'.
280 These can be overridden for a specific table by setting the
281 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
282 radio tables for the different export transformations and
283 available parameters."
319 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
320 ;; 1 2 3 4 5
331 "Is this a table line colgroup information?"
335 line)
337 nil
344 "Is this a table line with only alignment/width cookies?"
362 "Use the table.el package to insert a new table.
363 If there is already a table at point, convert between Org-mode tables
364 and table.el tables."
377 "Convert region to table, or create an empty table.
378 If there is an active region, convert it to a table, using the function
379 `org-table-convert-region'. See the documentation of that function
380 to learn how the prefix argument is interpreted to determine the field
381 separator.
382 If there is no such region, create an empty table with `org-table-create'."
389 "Query for a size and insert a table skeleton.
409 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
413 ;; Insert a hline after the first row.
421 "Convert region to a table.
422 The region goes from BEG0 to END0, but these borders will be moved
423 slightly, to make sure a beginning of line in the first line is included.
425 SEPARATOR specifies the field separator in the lines. It can have the
426 following values:
428 '(4) Use the comma as a field separator
429 '(16) Use a TAB as field separator
430 integer When a number, use that many spaces as field separator
431 nil When nil, the command tries to be smart and figure out the
432 separator in the following way:
433 - when each line contains a TAB, assume TAB-separated material
434 - when each line contains a comma, assume CSV material
435 - else, assume one or more SPACE characters as separator."
439 re)
446 ;; Get the right field separator
457 ;; parse the csv stuff
479 "Import FILE as a table.
480 The file is assumed to be tab-separated. Such files can be produced by most
481 spreadsheet and database applications. If no tabs (at least one per line)
482 are found, lines will be split on whitespace into fields."
494 "Export table to a file, with configurable format.
495 Such a file can be imported into a spreadsheet program like Excel.
496 FILE can be the output file name. If not given, it will be taken from
497 a TABLE_EXPORT_FILE property in the current entry or higher up in the
498 hierarchy, or the user will be prompted for a file name.
499 FORMAT can be an export format, of the same kind as it used when
500 `orgtbl-mode' sends a table in a different format. The default format can
501 be found in the variable `org-table-export-default-format', but the function
502 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
503 property, locally or anywhere up in the hierarchy."
520 buf deffmt-readable)
539 "Format: "
544 deffmt-readable)))
557 'hline
560 skipcols i0)))
561 lines))
565 skipcols i0))
568 skipcols i0)))
585 "Marker at the beginning of the table last aligned.
588 "Marker at the end of the table last aligned.
591 "List of flags for flushright alignment, from the last re-alignment.
594 "List of max width of fields in each column.
597 "Non-nil means debug table formulas.
610 "Align the table at point by aligning all vertical bars."
613 ;; Limits of table
616 ;; Current cursor position
622 column
624 rfmt hfmt
632 emptystrings links dates emph raise narrow
633 falign falign1 fmax f1 len c e space)
636 ;; Check if we have links or dates
648 ;; Make sure the link properties are right
650 ;; Make sure the date properties are right
655 ;; Check if we are narrowing any columns
658 org-format-transports-properties-p
663 ;; Get the rows
666 ;; Store the indentation of the first line
669 ;; Mark the hlines by setting the corresponding element to nil
670 ;; At the same time, we remove trailing space.
673 nil
676 l)))
677 lines))
678 ;; Get the data fields by splitting the lines.
683 ;; How many fields in the longest line?
690 ;; A list of empty strings to fill any short rows on output
692 ;; Check for special formatting.
696 ;; Check if there is an explicit width specified
706 ;; Find fields that are wider than fmax, and shorten them
712 'help-echo
713 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
721 xx)))))
722 ;; Get the maximum width for each column
724 lengths)
725 ;; Get the fraction of numbers, to decide about alignment of the column
731 nil
738 ;; Store the alignment of this table, for later editing of single fields
740 org-table-last-column-widths lengths)
742 ;; With invisible characters, `format' does not get the field width right
743 ;; So we need to make these fields wide by hand.
761 ;; Compute the formats needed for output of the table
774 hfmt))
777 ;; This hack is for org-indent, to force redisplay of the
778 ;; line prefix of the first line. Apparently the redisplay
779 ;; is tied to the newline, which is, I think, a bug.
780 ;; To force this redisplay, we remove and re-insert the
781 ;; newline, so that the redisplay engine thinks it belongs
782 ;; to the changed text.
788 ;; Replace the old one
795 ;; Try to move to the old location
803 ))
806 "Find the beginning of the table and return its position.
807 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
811 org-table-border-regexp)
812 nil t))
819 "Find the end of the table and return its position.
820 With argument TABLE-TYPE, go to the end of a table.el-type table."
824 org-table-border-regexp)
825 nil t))
831 "Justify the current field, text to left, number to right.
832 Optional argument NEW may specify text to replace the current field content."
841 ;; This is not the same table, force a full re-align
847 l f n o e)
871 "Go to the next field in the current table, creating new lines as needed.
872 Before doing so, re-align the table if necessary."
877 org-table-may-need-update)
888 org-table-tab-jumps-over-hlines
900 "Go to the previous field in the table.
901 Before doing so, re-align the table if necessary."
906 org-table-may-need-update)
921 "Move to the end of the current table field.
922 If already at or after the end, move to the end of the next table field.
923 With numeric argument N, move N-1 fields forward first."
936 "Move to the beginning of the current table field.
937 If already at or before the beginning, move to the beginning of the
938 previous field.
939 With numeric argument N, move N-1 fields backward first."
953 "Go to the next row (same column) in the current table.
954 Before doing so, re-align the table if necessary."
962 org-table-may-need-update)
976 "Copy a field down in the current column.
977 If the field at the cursor is empty, copy into it the content of the nearest
978 non-empty field above. With argument N, use the Nth non-empty field.
979 If the current field is not empty, it is copied down to the next row, and
980 the cursor is moved with it. Therefore, repeating this command causes the
981 column to be filled row-by-row.
982 If the variable `org-table-copy-increment' is non-nil and the field is an
983 integer or a timestamp, it will be incremented while copying. In the case of
984 a timestamp, if the cursor is on the year, change the year. If it is on the
985 month or the day, change that. Point will stay on the current date field
986 in order to easily repeat the interval."
994 txt)
1006 beg t))
1029 "Is point inside a table data field?
1030 I.e. not on a hline or before the first or after the last column?
1031 This actually throws an error, so it aborts the current command."
1042 "Get the field in table line LINE, column COLUMN.
1043 If LINE is larger than the number of data lines in the table, the function
1044 returns nil. However, if COLUMN is too large, we will simply return an
1045 empty string.
1046 If LINE is nil, use the current line.
1047 If column is nil, use the current column."
1054 "Put VALUE into line LINE, column COLUMN.
1055 When ALIGN is set, also realign the table."
1064 "Return the index of the current data line."
1071 cnt))
1074 "Go to the Nth data line in the current table.
1075 Return t when the line exists, nil if it does not exist."
1083 "Blank the current table field or active region."
1100 "Return the value of the field in column N of current row.
1101 N defaults to current field.
1102 If REPLACE is a string, replace field with this value. The return value
1103 is always the old value."
1113 val)
1117 "Show info about the current field, and highlight any reference at point."
1125 org-table-named-field-locations)))
1138 dline col
1140 dline col ref1
1142 ;; FIXME: formula info not correct if special table line
1152 "Find out which column we are in."
1158 cnt)))
1161 "Find out what table data line we are in.
1162 Only data lines count for this."
1172 cnt)))
1175 "Move the cursor to the Nth column in the current table line.
1176 With optional argument ON-DELIM, stop with point before the left delimiter
1177 of the field.
1178 If there are less than N fields, just go to after the last delimiter.
1179 However, when FORCE is non-nil, create new columns if necessary."
1189 t)))))
1197 "Insert a new column into the table."
1205 ;; Current cursor position
1211 nil
1223 "Find a data line in the current table, which is needed for column commands."
1226 t
1237 t
1242 "Delete a column from the table."
1251 ;; Current cursor position
1257 nil
1272 "Move column to the right."
1276 "Move column to the left."
1281 "Move the current column to the right. With arg LEFT, move to the left."
1291 ;; Current cursor position
1301 nil
1318 "Move table row down."
1322 "Move table row up."
1327 "Move the current table line down. With arg UP, move it up."
1336 txt hline2p)
1357 "Insert a new row above the current line into the table.
1358 With prefix ARG, insert below the current line."
1364 ;; Fix the first field if necessary
1376 "Insert a horizontal-line below the current line into the table.
1377 With prefix ABOVE, insert above the current line."
1399 "Insert a hline and move to the row below that line."
1413 In particular, this does handle wide and invisible characters."
1415 ;; It's a hline, just map the characters
1421 t t s)))
1422 s))
1425 "Delete the current row or horizontal line from the table."
1438 "Sort table lines according to the column at point.
1440 The position of point indicates the column to be used for
1441 sorting, and the range of lines is the range between the nearest
1442 horizontal separator lines, or the entire table of no such lines
1443 exist. If point is before the first column, you will be prompted
1444 for the sorting column. If there is an active region, the mark
1445 specifies the first line and the sorting column, while point
1446 should be in the last line to be included into the sorting.
1448 The command then prompts for the sorting type which can be
1449 alphabetically, numerically, or by time (as given in a time stamp
1450 in the field). Sorting in reverse order is also possible.
1452 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1454 If SORTING-TYPE is specified when this function is called from a Lisp
1455 program, no prompting will take place. SORTING-TYPE must be a character,
1456 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1457 should be done in reverse order."
1461 beg end bcol ecol tend tbeg column lns pos)
1506 x))
1519 "Copy region in table to the clipboard and blank all relevant fields.
1520 If there is no active region, use just the field at point."
1527 "Copy rectangular region in table to clipboard.
1528 A special clipboard is used which can only be accessed
1529 with `org-table-paste-rectangle'."
1533 current-prefix-arg))
1535 region cols
1561 org-table-clip))
1564 "Paste a rectangular region into a table.
1565 The upper right corner ends up in the current field. All involved fields
1566 will be overwritten. If the rectangle does not fit into the present table,
1567 the table is enlarged as needed. The process ignores horizontal separator
1568 lines."
1578 c cols field)
1594 "Convert from `org-mode' table to table.el and back.
1595 Obviously, this only works within limits. When an Org-mode table is
1596 converted to table.el, all horizontal separator lines get lost, because
1597 table.el uses these as cell boundaries and has no notion of horizontal lines.
1598 A table.el table can be converted to an Org-mode table only if it does not
1599 do row or column spanning. Multiline cells will become multiple cells.
1600 Beware, Org-mode does not test if the table can be successfully converted - it
1601 blindly applies a recipe that works for simple tables."
1605 ;; convert to Org-mode table
1614 ;; convert to table.el table
1617 ;; first, get rid of all horizontal lines
1621 ;; insert a hline before first
1625 ;; insert a hline after each line
1630 ;; replace "+" at beginning and ending of hlines
1639 "Wrap several fields in a column like a paragraph.
1640 This is useful if you'd like to spread the contents of a field over several
1641 lines, in order to keep the table compact.
1643 If there is an active region, and both point and mark are in the same column,
1644 the text in the column is wrapped to minimum width for the given number of
1645 lines. Generally, this makes the table more compact. A prefix ARG may be
1647 formats the selected text to two lines. If the region was longer than two
1648 lines, the remaining lines remain empty. A negative prefix argument reduces
1649 the current number of lines by that amount. The wrapped text is pasted back
1650 into the table. If you formatted it to more lines than it was before, fields
1651 further down in the table get overwritten - so you might need to make space in
1652 the table first.
1654 If there is no region, the current field is split at the cursor position and
1655 the text fragment to the right of the cursor is prepended to the field one
1656 line down.
1658 If there is no region, but you specify a prefix ARG, the current field gets
1659 blank, and the content is appended to the field above."
1663 ;; There is a region: fill as a paragraph
1667 nlines)
1674 arg)
1678 nil nlines)))
1682 ;; No region, split the current field at point
1686 ;; combine with field above
1696 ;; split field
1709 "Edit table field in a different window.
1710 This is mainly useful for fields that contain hidden parts.
1712 it can be edited in place."
1718 display t intangible t))
1724 p)
1733 intangible t))
1741 "Finish editing a table data field.
1742 Remove all newline characters, insert the result into the table, realign
1743 the table and kill the editing buffer."
1747 text)
1766 "Sum numbers in region of current table column.
1767 The result will be displayed in the echo area, and will be available
1770 If there is an active region, it is interpreted as a rectangle and all
1771 numbers in that rectangle will be summed. If there is no active
1772 region and point is located in a table column, sum all numbers in that
1773 column.
1775 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1776 numbers are assumed to be times as well (in decimal hours) and the
1777 numbers are added as such.
1779 If NLAST is a number, only the NLAST fields will actually be summed."
1806 items1)))
1813 s diff)
1821 sres))))
1844 "Return the formula active for the current field.
1845 Assumes that specials are in place.
1846 If KEY is given, return the key to this formula.
1850 org-table-named-field-locations)))
1864 "Read a formula from the minibuffer, offer stored formula as default.
1865 When NAMED is non-nil, look for a named equation."
1869 org-table-named-field-locations)))
1876 name
1877 ref)
1887 stored)
1889 equation)
1896 scol))
1898 'org-table-formula-history
1899 )))))
1900 mustsave)
1902 ;; remove formula
1909 ;; We set the column equation, delete the named one.
1911 mustsave t))
1917 eq))
1920 "Store the list of formulas below the current table."
1926 ;; don't overwrite TBLFM, we might use text properties to store stuff
1947 "Compare two formulas for sorting."
1953 "Return an alist with the stored formulas directly after current table."
1961 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1978 "Modify the equations after the table structure has been edited.
1980 For all numbers larger than LIMIT, shift them by DELTA."
1991 s n a)
2004 t t)))))))))
2007 "Get the column names and local parameters for this table."
2010 names name fields fields1 field cnt
2011 c v l line col types dlines hlines last-dline)
2013 org-table-local-parameters nil
2014 org-table-named-field-locations nil
2015 org-table-current-begin-line nil
2016 org-table-current-begin-pos nil
2017 org-table-current-line-types nil)
2035 org-table-local-parameters))))
2051 ;; Analyse the line types
2055 l org-table-current-begin-line)
2072 al al2)
2084 If yes, store the formula and apply it."
2085 ;; We already know we are in a table. Get field will only return a formula
2086 ;; when appropriate. It might return a separator line, but no problem.
2089 named eq)
2100 "List of commands triggering the recalculation of a line.
2113 "Rotate the recalculation mark in the first column.
2114 If in any row, the first field is not consistent with a mark,
2115 insert a new column for the markers.
2116 When there is an active region, change all the lines in the region,
2117 after prompting for the marking character.
2118 After each change, a message will be displayed indicating the meaning
2119 of the new mark."
2134 epos new)
2141 newchar))
2173 "Recompute the current line if marked for it, and if we haven't just done it."
2193 modes)
2196 suppress-align suppress-const
2197 suppress-store suppress-analysis)
2198 "Replace the table field value at the cursor by the result of a calculation.
2200 This function makes use of Dave Gillespie's Calc package, in my view the
2201 most exciting program ever written for GNU Emacs. So you need to have Calc
2202 installed in order to use this function.
2204 In a table, this command replaces the value in the current field with the
2206 formula, by storing it in a special line below the table. When called
2207 with a `C-u' prefix, the current field must be a named field, and the
2208 formula is installed as valid in only this specific field.
2210 When called with two `C-u' prefixes, insert the active equation
2211 for the field back into the current field, so that it can be
2213 to check the referenced fields.
2215 When called, the command first prompts for a formula, which is read in
2216 the minibuffer. Previously entered formulas are available through the
2217 history list, and the last used formula is offered as a default.
2218 These stored formulas are adapted correctly when moving, inserting, or
2219 deleting columns with the corresponding commands.
2221 The formula can be any algebraic expression understood by the Calc package.
2222 For details, see the Org-mode manual.
2224 This function can also be called from Lisp programs and offers
2225 additional arguments: EQUATION can be the formula to apply. If this
2226 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2227 used to speed-up recursive calls by by-passing unnecessary aligns.
2228 SUPPRESS-CONST suppresses the interpretation of constants in the
2229 formula, assuming that this has been done already outside the function.
2230 SUPPRESS-STORE means the formula should not be stored, either because
2231 it is already stored, or because it is a modified equation that should
2232 not overwrite the stored one."
2248 equation
2254 n form form0 bw fmt x ev orig c lispp literal)
2255 ;; Parse the format string. Since we have a lot of modes, this is
2256 ;; a lot of work. However, I think calc still uses most of the time.
2268 'calc-float-format
2271 n))))
2298 fields)))
2304 ;; Insert row and column number of formula result field
2315 t t form)))
2317 ;; Check for old vertical references
2319 ;; Insert remote references
2327 keep-empty numbers lispp))
2328 t t form)))
2329 ;; Insert complex ranges
2337 keep-empty numbers lispp))
2338 t t form)))
2339 ;; Insert simple ranges
2348 keep-empty numbers lispp))
2349 t t form)))
2351 ;; Insert the references to fields in same row
2360 t t form)))
2375 Orig: %s
2376 $xyz-> %s
2377 @r$c-> %s
2408 prop value)))
2411 "Get a calc vector from a column, according to descriptor DESC.
2412 Optional arguments TBEG and COL can give the beginning of the table and
2413 the current column, to avoid unnecessary parsing.
2414 HIGHLIGHT means just highlight the range."
2421 beg end c1 c2 r1 r2 rangep tmp)
2438 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2444 ;; just one field
2451 ;; A range, return a vector
2452 ;; First sort the numbers to get a regular ractangle
2468 ;; return string representation of calc vector
2473 "Analyze descriptor DESC and retrieve the corresponding line number.
2474 The cursor is currently in line CLINE, the table begins in line BLINE,
2475 and TABLE is a vector with line types."
2483 ;; 1 2 3 4 5 6
2503 nil hn cline desc)))
2506 rel on cline desc)))
2510 "FIXME: Needs more documentation."
2523 nil))
2524 t)))
2528 desc cline)
2529 i)))
2534 s))
2537 "Convert list ELEMENTS to something appropriate to insert into formula.
2538 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2539 NUMBERS indicates that everything should be converted to numbers.
2540 LISPP means to return something appropriate for a Lisp list."
2544 elements
2553 elements))))
2559 x
2565 elements
2569 "Recalculate the current table line by applying all stored formulas.
2570 With prefix arg ALL, do this for all lines in the table.
2571 With the prefix argument ALL is `(16)' \
2573 it is the symbol `iterate', recompute the table until it no longer changes.
2574 If NOALIGN is not nil, do not re-align the table after the computations
2575 are done. This is typically used internally to save time, if it is
2576 known that the table will be realigned a little later anyway."
2591 ;; Insert constants in all formulas
2595 x)
2596 eqlist))
2597 ;; Split the equation list
2608 ;; This is a table with marked lines, compute selected lines
2610 ;; Move forward to the first non-header line
2621 ;; First find the named fields, and mark them untouchable
2633 name)))
2642 ;; Now evaluate the column formulas, but skip fields covered by
2643 ;; field formulas
2647 ;; Unprotected line, recalculate
2659 ;; Now evaluate the field formulas
2673 ;; back to initial position
2681 "Recalculate the table until it does not change anymore."
2686 thistbl)
2701 "Recalculate all tables in the current buffer."
2709 "Iterate all tables in the buffer, to converge inter-table dependencies."
2714 c1
2731 "Replace $const with values in string F."
2733 ;; First, check for column names
2738 ;; Parameters and constants
2740 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2750 f))
2753 "Find the value for a parameter or constant in a formula.
2754 Parameters get priority."
2785 map))
2792 "--"
2795 "--"
2796 "Shift Reference at Point"
2801 "-"
2802 "Change Test Row for Column Formulas"
2805 "--"
2810 org-table-overlay-coordinates)]
2811 "--"
2818 "Edit the formulas of the current table in a separate buffer."
2834 entry s type title)
2837 ;; Keep global-font-lock-mode from turning on font-lock-mode
2877 "Convert a formula from internal to user representation."
2880 s))
2883 "Convert a formula from user to internal representation."
2886 s))
2889 "Convert spreadsheet references from AB7 to @7$28.
2890 Works for single references, but also for entire formulas and even the
2891 full TBLFM line."
2893 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2896 ;; format match, just advance
2901 ;; 3.e5 or something like this.
2904 ;; (member (match-string 1 s)
2905 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2906 )
2907 ;; function name, just advance
2917 t t s)))))
2918 s))
2921 "Convert spreadsheet references from to @7$28 to AB7.
2922 Works for single references, but also for entire formulas and even the
2923 full TBLFM line."
2930 t t s)))
2935 t nil s)))
2936 s)
2939 "Convert a base 26 number represented by letters into an integer.
2940 For example: AB -> 28."
2946 n))
2949 "Convert an integer into a base 26 number represented by letters.
2950 For example: 28 -> AB."
2955 s))
2958 "Convert all references in this buffer, using FUNCTION."
2968 "Convert all references in the buffer from B3 to @3$2 and back."
2978 "Shift the reference at point one row/hline up."
2982 "Shift the reference at point one row/hline down."
2986 "Shift the reference at point one field to the left."
2990 "Shift the reference at point one field to the right."
3001 ;; A B3-like reference
3007 ;; An internal reference
3013 "Re-match the group N, and replace it with the shifted reference."
3018 t t)))
3021 "Shift a reference part REF.
3022 If DECR is set, decrease the references row/column, else increase.
3023 If HLINE is set, this may be a hline reference, it certainly is not
3024 a translation reference."
3053 "Toggle the display of coordinates in the referenced table."
3062 "Parse the buffer for formula definitions and install them.
3063 With prefix ARG, apply the new formulas to the table."
3074 nil t)
3098 "Abort editing formulas, without installing the changes."
3109 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3150 "Show the location/value of the $ expression at point."
3159 var name e what match dest)
3241 ;; column number
3269 org-table-fedit-scroll-down))))
3280 "Make sure the cursor is in a dataline in a table."
3289 p1 p2)))
3294 "Move cursor one line up in the window showing the table."
3299 "Move cursor one line down in the window showing the table."
3304 "Move the cursor in the window showing the table.
3305 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3330 "Add a new overlay."
3336 "Highlight rectangular region in a table."
3340 l1 c1 l2 c2 tmp)
3364 "Remove the rectangle overlays."
3375 "Add overlays to the table at point, to show row/column coordinates."
3404 "Toggle the display of Row/Column numbers in tables."
3416 "Toggle the formula debugger in tables."
3422 ;;; The orgtbl minor mode
3424 ;; Define a minor mode which can be used in other modes in order to
3425 ;; integrate the org-mode table editor.
3427 ;; This is really a hack, because the org-mode table editor uses several
3428 ;; keys which normally belong to the major mode, for example the TAB and
3429 ;; RET keys. Here is how it works: The minor mode defines all the keys
3430 ;; necessary to operate the table editor, but wraps the commands into a
3431 ;; function which tests if the cursor is currently inside a table. If that
3432 ;; is the case, the table editor command is executed. However, when any of
3433 ;; those keys is used outside a table, the function uses `key-binding' to
3434 ;; look up if the key has an associated command in another currently active
3435 ;; keymap (minor modes, major mode, global), and executes that command.
3436 ;; There might be problems if any of the keys used by the table editor is
3437 ;; otherwise used as a prefix key.
3439 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3440 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3441 ;; addresses this by checking explicitly for both bindings.
3443 ;; The optimized version (see variable `orgtbl-optimized') takes over
3444 ;; all keys which are bound to `self-insert-command' in the *global map*.
3445 ;; Some modes bind other commands to simple characters, for example
3446 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3447 ;; active, this binding is ignored inside tables and replaced with a
3448 ;; modified self-insert.
3454 ;;;###autoload
3456 "Unconditionally turn on `orgtbl-mode'."
3471 ;; Install it as a minor mode.
3475 ;;;###autoload
3477 "The `org-mode' table editor as a minor mode for use in other modes."
3482 ;; Exit without error, in case some hook functions calls this
3483 ;; by accident in org-mode.
3487 ;; Make sure we are first in minor-mode-map-alist
3489 ;; FIXME: maybe it should use emulation-mode-map-alists?
3496 auto-fill-inhibit-regexp)
3500 auto-fill-inhibit-regexp)
3501 orgtbl-line-start-regexp))
3519 "Remove all properties related to narrow-column invisibility."
3532 "Create a function for binding in the table minor mode.
3533 FUN is the command to call inside a table. N is used to create a unique
3534 command name. KEYS are keys that should be checked in for a command
3535 to execute outside of tables."
3541 "Outside of tables, run the binding of `"
3553 keys)
3557 "Error when there is no default binding for a table key."
3562 "Setup orgtbl keymaps."
3592 elt key fun cmd)
3600 ;; Special treatment needed for TAB and RET
3620 [(tab)] "\C-i")))
3622 (org-defkey orgtbl-mode-map [backtab]
3624 [backtab] [S-iso-lefttab] [(shift tab)]
3625 [(tab)] "\C-i"))
3627 (org-defkey orgtbl-mode-map "\M-\C-m"
3628 (orgtbl-make-binding 'org-table-wrap-region 105
3629 "\M-\C-m" [(meta return)]))
3630 (org-defkey orgtbl-mode-map [(meta return)]
3631 (orgtbl-make-binding 'org-table-wrap-region 106
3632 [(meta return)] "\M-\C-m"))
3634 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3635 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3637 (when orgtbl-optimized
3638 ;; If the user wants maximum table support, we need to hijack
3639 ;; some standard editing functions
3640 (org-remap orgtbl-mode-map
3641 'self-insert-command 'orgtbl-self-insert-command
3642 'delete-char 'org-delete-char
3643 'delete-backward-char 'org-delete-backward-char)
3644 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3645 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3646 '("OrgTbl"
3647 ["Create or convert" org-table-create-or-convert-from-region
3648 :active (not (org-at-table-p)) :keys "C-c |" ]
3649 "--"
3650 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3651 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3652 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3653 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3654 "--"
3655 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3656 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3657 ["Copy Field from Above"
3658 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3659 "--"
3660 ("Column"
3661 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3662 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3663 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3664 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3665 ("Row"
3666 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3667 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3668 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3669 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3670 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3671 "--"
3672 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3673 ("Rectangle"
3674 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3675 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3676 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3677 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3678 "--"
3679 ("Radio tables"
3680 ["Insert table template" orgtbl-insert-radio-table
3681 (assq major-mode orgtbl-radio-table-templates)]
3682 ["Comment/uncomment table" orgtbl-toggle-comment t])
3683 "--"
3684 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3685 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3686 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3687 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3688 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3689 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3690 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3691 ["Sum Column/Rectangle" org-table-sum
3692 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3693 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3694 ["Debug Formulas"
3695 org-table-toggle-formula-debugger :active (org-at-table-p)
3696 :keys "C-c {"
3697 :style toggle :selected org-table-formula-debug]
3698 ["Show Col/Row Numbers"
3699 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3700 :keys "C-c }"
3701 :style toggle :selected org-table-overlay-coordinates]
3702 ))
3703 t))
3705 (defun orgtbl-ctrl-c-ctrl-c (arg)
3706 "If the cursor is inside a table, realign the table.
3707 If it is a table to be sent away to a receiver, do it.
3708 With prefix arg, also recompute table."
3709 (interactive "P")
3710 (let ((pos (point)) action)
3711 (save-excursion
3712 (beginning-of-line 1)
3716 (cond
3717 ((integerp action)
3718 (goto-char action)
3719 (org-table-maybe-eval-formula)
3720 (if arg
3721 (call-interactively 'org-table-recalculate)
3722 (org-table-maybe-recalculate-line))
3723 (call-interactively 'org-table-align)
3724 (orgtbl-send-table 'maybe))
3725 ((eq action 'recalc)
3726 (save-excursion
3727 (beginning-of-line 1)
3729 (if (org-at-table-p)
3730 (org-call-with-arg 'org-table-recalculate t))))
3731 (t (let (orgtbl-mode)
3732 (call-interactively (key-binding "\C-c\C-c")))))))
3734 (defun orgtbl-create-or-convert-from-region (arg)
3735 "Create table or convert region to table, if no conflicting binding.
3736 This installs the table binding `C-c |', but only if there is no
3737 conflicting binding to this key outside orgtbl-mode."
3738 (interactive "P")
3739 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3740 (if cmd
3741 (call-interactively cmd)
3742 (call-interactively 'org-table-create-or-convert-from-region))))
3744 (defun orgtbl-tab (arg)
3745 "Justification and field motion for `orgtbl-mode'."
3746 (interactive "P")
3747 (if arg (org-table-edit-field t)
3748 (org-table-justify-field-maybe)
3749 (org-table-next-field)))
3751 (defun orgtbl-ret ()
3752 "Justification and field motion for `orgtbl-mode'."
3753 (interactive)
3754 (if (bobp)
3755 (newline)
3756 (org-table-justify-field-maybe)
3757 (org-table-next-row)))
3759 (defun orgtbl-self-insert-command (N)
3760 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3761 If the cursor is in a table looking at whitespace, the whitespace is
3762 overwritten, and the table is not marked as requiring realignment."
3763 (interactive "p")
3764 (if (and (org-at-table-p)
3765 (or
3766 (and org-table-auto-blank-field
3767 (member last-command
3768 '(orgtbl-hijacker-command-100
3769 orgtbl-hijacker-command-101
3770 orgtbl-hijacker-command-102
3771 orgtbl-hijacker-command-103
3772 orgtbl-hijacker-command-104
3773 orgtbl-hijacker-command-105
3774 yas/expand))
3775 (org-table-blank-field))
3776 t)
3777 (eq N 1)
3779 (let (org-table-may-need-update)
3780 (goto-char (1- (match-end 0)))
3781 (delete-backward-char 1)
3782 (goto-char (match-beginning 0))
3783 (self-insert-command N))
3784 (setq org-table-may-need-update t)
3785 (let* (orgtbl-mode
3786 a
3787 (cmd (or (key-binding
3788 (or (and (listp function-key-map)
3789 (setq a (assoc last-input-event function-key-map))
3790 (cdr a))
3791 (vector last-input-event)))
3792 'self-insert-command)))
3793 (call-interactively cmd)
3794 (if (and org-self-insert-cluster-for-undo
3795 (eq cmd 'self-insert-command))
3796 (if (not (eq last-command 'orgtbl-self-insert-command))
3797 (setq org-self-insert-command-undo-counter 1)
3798 (if (>= org-self-insert-command-undo-counter 20)
3799 (setq org-self-insert-command-undo-counter 1)
3800 (and (> org-self-insert-command-undo-counter 0)
3801 buffer-undo-list
3802 (not (cadr buffer-undo-list)) ; remove nil entry
3803 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3804 (setq org-self-insert-command-undo-counter
3805 (1+ org-self-insert-command-undo-counter))))))))
3808 "Regular expression matching exponentials as produced by calc.")
3810 (defun orgtbl-export (table target)
3811 (require 'org-exp)
3812 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3814 org-table-last-alignment org-table-last-column-widths
3815 maxcol column)
3816 (if (not (fboundp func))
3817 (error "Cannot export orgtbl table to %s" target))
3818 (setq lines (org-table-clean-before-export lines))
3819 (setq table
3820 (mapcar
3821 (lambda (x)
3822 (if (string-match org-table-hline-regexp x)
3823 'hline
3825 lines))
3826 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3827 table)))
3828 (loop for i from (1- maxcol) downto 0 do
3829 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3830 (setq column (delq nil column))
3831 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3832 (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))
3833 (funcall func table nil)))
3835 (defun orgtbl-gather-send-defs ()
3836 "Gather a plist of :name, :transform, :params for each destination before
3837 a radio table."
3838 (save-excursion
3839 (goto-char (org-table-begin))
3840 (let (rtn)
3841 (beginning-of-line 0)
3842 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3843 (let ((name (org-no-properties (match-string 1)))
3844 (transform (intern (match-string 2)))
3845 (params (if (match-end 3)
3846 (read (concat "(" (match-string 3) ")")))))
3847 (push (list :name name :transform transform :params params)
3848 rtn)
3849 (beginning-of-line 0)))
3850 rtn)))
3852 (defun orgtbl-send-replace-tbl (name txt)
3853 "Find and replace table NAME with TXT."
3854 (save-excursion
3855 (goto-char (point-min))
3856 (unless (re-search-forward
3858 (error "Don't know where to insert translated table"))
3859 (goto-char (match-beginning 0))
3860 (beginning-of-line 2)
3861 (save-excursion
3862 (let ((beg (point)))
3863 (unless (re-search-forward
3864 (concat "END RECEIVE ORGTBL +" name) nil t)
3865 (error "Cannot find end of insertion region"))
3866 (beginning-of-line 1)
3867 (delete-region beg (point))))
3870 ;;;###autoload
3871 (defun org-table-to-lisp (&optional txt)
3872 "Convert the table at point to a Lisp structure.
3873 The structure will be a list. Each item is either the symbol `hline'
3874 for a horizontal separator line, or a list of field values as strings.
3875 The table is taken from the parameter TXT, or from the buffer at point."
3876 (unless txt
3877 (unless (org-at-table-p)
3878 (error "No table at point")))
3879 (let* ((txt (or txt
3880 (buffer-substring-no-properties (org-table-begin)
3881 (org-table-end))))
3884 (mapcar
3885 (lambda (x)
3886 (if (string-match org-table-hline-regexp x)
3887 'hline
3889 lines)))
3891 (defun orgtbl-send-table (&optional maybe)
3892 "Send a transformed version of this table to the receiver position.
3893 With argument MAYBE, fail quietly if no transformation is defined for
3894 this table."
3895 (interactive)
3896 (catch 'exit
3897 (unless (org-at-table-p) (error "Not at a table"))
3898 ;; when non-interactive, we assume align has just happened.
3899 (when (interactive-p) (org-table-align))
3900 (let ((dests (orgtbl-gather-send-defs))
3901 (txt (buffer-substring-no-properties (org-table-begin)
3902 (org-table-end)))
3903 (ntbl 0))
3904 (unless dests (if maybe (throw 'exit nil)
3905 (error "Don't know how to transform this table")))
3906 (dolist (dest dests)
3907 (let* ((name (plist-get dest :name))
3908 (transform (plist-get dest :transform))
3909 (params (plist-get dest :params))
3910 (skip (plist-get params :skip))
3911 (skipcols (plist-get params :skipcols))
3912 beg
3913 (lines (org-table-clean-before-export
3914 (nthcdr (or skip 0)
3916 (i0 (if org-table-clean-did-remove-column 2 1))
3917 (table (mapcar
3918 (lambda (x)
3919 (if (string-match org-table-hline-regexp x)
3920 'hline
3921 (org-remove-by-index
3923 skipcols i0)))
3924 lines))
3925 (fun (if (= i0 2) 'cdr 'identity))
3926 (org-table-last-alignment
3927 (org-remove-by-index (funcall fun org-table-last-alignment)
3928 skipcols i0))
3929 (org-table-last-column-widths
3930 (org-remove-by-index (funcall fun org-table-last-column-widths)
3931 skipcols i0))
3932 (txt (if (fboundp transform)
3933 (funcall transform table params)
3934 (error "No such transformation function %s" transform))))
3935 (orgtbl-send-replace-tbl name txt))
3936 (setq ntbl (1+ ntbl)))
3937 (message "Table converted and installed at %d receiver location%s"
3938 ntbl (if (> ntbl 1) "s" "")))))
3940 (defun org-remove-by-index (list indices &optional i0)
3941 "Remove the elements in LIST with indices in INDICES.
3942 First element has index 0, or I0 if given."
3943 (if (not indices)
3944 list
3945 (if (integerp indices) (setq indices (list indices)))
3946 (setq i0 (1- (or i0 0)))
3947 (delq :rm (mapcar (lambda (x)
3948 (setq i0 (1+ i0))
3949 (if (memq i0 indices) :rm x))
3950 list))))
3952 (defun orgtbl-toggle-comment ()
3953 "Comment or uncomment the orgtbl at point."
3954 (interactive)
3955 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3956 (re2 (concat "^" orgtbl-line-start-regexp))
3957 (commented (save-excursion (beginning-of-line 1)
3958 (cond ((looking-at re1) t)
3959 ((looking-at re2) nil)
3960 (t (error "Not at an org table")))))
3961 (re (if commented re1 re2))
3962 beg end)
3963 (save-excursion
3964 (beginning-of-line 1)
3965 (while (looking-at re) (beginning-of-line 0))
3966 (beginning-of-line 2)
3967 (setq beg (point))
3968 (while (looking-at re) (beginning-of-line 2))
3969 (setq end (point)))
3970 (comment-region beg end (if commented '(4) nil))))
3972 (defun orgtbl-insert-radio-table ()
3973 "Insert a radio table template appropriate for this major mode."
3974 (interactive)
3975 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3976 (txt (nth 1 e))
3977 name pos)
3978 (unless e (error "No radio table setup defined for %s" major-mode))
3979 (setq name (read-string "Table name: "))
3980 (while (string-match "%n" txt)
3981 (setq txt (replace-match name t t txt)))
3983 (setq pos (point))
3984 (insert txt)
3985 (goto-char pos)))
3987 ;; Dynamically bound input and output for table formatting.
3988 (defvar *orgtbl-table* nil
3989 "Carries the current table through formatting routines.")
3990 (defvar *orgtbl-rtn* nil
3991 "Formatting routines push the output lines here.")
3992 ;; Formatting parameters for the current table section.
3993 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
3994 (defvar *orgtbl-sep* nil "Text used as a column separator.")
3995 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
3996 (defvar *orgtbl-fmt* nil "Format for each entry.")
3997 (defvar *orgtbl-efmt* nil "Format for numbers.")
3998 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
3999 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4000 (defvar *orgtbl-lstart* nil "Text starting a row.")
4001 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4002 (defvar *orgtbl-lend* nil "Text ending a row.")
4003 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4005 (defsubst orgtbl-get-fmt (fmt i)
4006 "Retrieve the format from FMT corresponding to the Ith column."
4007 (if (and (not (functionp fmt)) (consp fmt))
4008 (plist-get fmt i)
4009 fmt))
4011 (defsubst orgtbl-apply-fmt (fmt &rest args)
4012 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4013 (cond ((functionp fmt) (apply fmt args))
4014 (fmt (apply 'format fmt args))
4015 (args (car args))
4016 (t args)))
4018 (defsubst orgtbl-eval-str (str)
4019 "If STR is a function, evaluate it with no arguments."
4020 (if (functionp str)
4021 (funcall str)
4022 str))
4024 (defun orgtbl-format-line (line)
4025 "Format LINE as a table row."
4026 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4027 (let* ((i 0)
4028 (line
4029 (mapcar
4030 (lambda (f)
4031 (setq i (1+ i))
4032 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4033 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4034 (orgtbl-apply-fmt efmt (match-string 1 f)
4035 (match-string 2 f))
4036 f)))
4037 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4038 *orgtbl-default-fmt*)
4039 f)))
4040 line)))
4041 (push (if *orgtbl-lfmt*
4042 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4043 (concat (orgtbl-eval-str *orgtbl-lstart*)
4044 (mapconcat 'identity line *orgtbl-sep*)
4045 (orgtbl-eval-str *orgtbl-lend*)))
4046 *orgtbl-rtn*))))
4048 (defun orgtbl-format-section (section-stopper)
4049 "Format lines until the first occurrence of SECTION-STOPPER."
4050 (let (prevline)
4051 (progn
4052 (while (not (eq (car *orgtbl-table*) section-stopper))
4053 (if prevline (orgtbl-format-line prevline))
4054 (setq prevline (pop *orgtbl-table*)))
4055 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4056 (*orgtbl-lend* *orgtbl-llend*)
4057 (*orgtbl-lfmt* *orgtbl-llfmt*))
4058 (orgtbl-format-line prevline))))))
4060 (defun orgtbl-to-generic (table params)
4061 "Convert the orgtbl-mode TABLE to some other format.
4062 This generic routine can be used for many standard cases.
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 For the generic converter, some parameters are obligatory: You need to
4067 specify either :lfmt, or all of (:lstart :lend :sep).
4069 Valid parameters are
4071 :splice When set to t, return only table body lines, don't wrap
4072 them into :tstart and :tend. Default is nil. When :splice
4073 is non-nil, this also means that the exporter should not look
4074 for and interpret header and footer sections.
4076 :hline String to be inserted on horizontal separation lines.
4077 May be nil to ignore hlines.
4079 :sep Separator between two fields
4080 :remove-nil-lines Do not include lines that evaluate to nil.
4083 Each in the following group may be either a string or a function
4084 of no arguments returning a string:
4085 :tstart String to start the table. Ignored when :splice is t.
4086 :tend String to end the table. Ignored when :splice is t.
4087 :lstart String to start a new table line.
4088 :llstart String to start the last table line, defaults to :lstart.
4089 :lend String to end a table line
4090 :llend String to end the last table line, defaults to :lend.
4092 Each in the following group may be a string, a function of one
4093 argument (the field or line) returning a string, or a plist
4094 mapping columns to either of the above:
4095 :lfmt Format for entire line, with enough %s to capture all fields.
4096 If this is present, :lstart, :lend, and :sep are ignored.
4097 :llfmt Format for the entire last line, defaults to :lfmt.
4098 :fmt A format to be used to wrap the field, should contain
4099 %s for the original field value. For example, to wrap
4101 This may also be a property list with column numbers and
4104 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4105 Same as above, specific for the header lines in the table.
4106 All lines before the first hline are treated as header.
4107 If any of these is not present, the data line value is used.
4109 This may be either a string or a function of two arguments:
4110 :efmt Use this format to print numbers with exponentials.
4111 The format should have %s twice for inserting mantissa
4113 may also be a property list with column numbers and
4114 formats. :fmt will still be applied after :efmt.
4116 In addition to this, the parameters :skip and :skipcols are always handled
4117 directly by `orgtbl-send-table'. See manual."
4118 (interactive)
4120 (let* ((splicep (plist-get params :splice))
4121 (hline (plist-get params :hline))
4122 (remove-nil-linesp (plist-get params :remove-nil-lines))
4123 (remove-newlines (plist-get params :remove-newlines))
4124 (*orgtbl-hline* hline)
4125 (*orgtbl-table* table)
4126 (*orgtbl-sep* (plist-get params :sep))
4127 (*orgtbl-efmt* (plist-get params :efmt))
4128 (*orgtbl-lstart* (plist-get params :lstart))
4129 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4130 (*orgtbl-lend* (plist-get params :lend))
4131 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4132 (*orgtbl-lfmt* (plist-get params :lfmt))
4133 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4134 (*orgtbl-fmt* (plist-get params :fmt))
4135 *orgtbl-rtn*)
4137 ;; Put header
4138 (unless splicep
4139 (when (plist-member params :tstart)
4140 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4141 (if tstart (push tstart *orgtbl-rtn*)))))
4143 ;; Do we have a heading section? If so, format it and handle the
4144 ;; trailing hline.
4145 (if (and (not splicep)
4146 (or (consp (car *orgtbl-table*))
4147 (consp (nth 1 *orgtbl-table*)))
4148 (memq 'hline (cdr *orgtbl-table*)))
4149 (progn
4150 (when (eq 'hline (car *orgtbl-table*))
4151 ;; there is a hline before the first data line
4152 (and hline (push hline *orgtbl-rtn*))
4153 (pop *orgtbl-table*))
4154 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4155 *orgtbl-lstart*))
4156 (*orgtbl-llstart* (or (plist-get params :hllstart)
4157 *orgtbl-llstart*))
4158 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4159 (*orgtbl-llend* (or (plist-get params :hllend)
4160 (plist-get params :hlend) *orgtbl-llend*))
4161 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4162 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4163 (plist-get params :hlfmt) *orgtbl-llfmt*))
4164 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4165 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4166 (orgtbl-format-section 'hline))
4167 (if hline (push hline *orgtbl-rtn*))
4168 (pop *orgtbl-table*)))
4170 ;; Now format the main section.
4171 (orgtbl-format-section nil)
4173 (unless splicep
4174 (when (plist-member params :tend)
4175 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4176 (if tend (push tend *orgtbl-rtn*)))))
4178 (mapconcat (if remove-newlines
4179 (lambda (tend)
4181 'identity)
4182 (nreverse (if remove-nil-linesp
4183 (remq nil *orgtbl-rtn*)
4186 (defun orgtbl-to-tsv (table params)
4187 "Convert the orgtbl-mode table to TAB separated material."
4189 (defun orgtbl-to-csv (table params)
4190 "Convert the orgtbl-mode table to CSV material.
4191 This does take care of the proper quoting of fields with comma or quotes."
4192 (orgtbl-to-generic table (org-combine-plists
4193 '(:sep "," :fmt org-quote-csv-field)
4194 params)))
4196 (defun orgtbl-to-latex (table params)
4197 "Convert the orgtbl-mode TABLE to LaTeX.
4198 TABLE is a list, each entry either the symbol `hline' for a horizontal
4199 separator line, or a list of fields for that line.
4200 PARAMS is a property list of parameters that can influence the conversion.
4201 Supports all parameters from `orgtbl-to-generic'. Most important for
4202 LaTeX are:
4204 :splice When set to t, return only table body lines, don't wrap
4205 them into a tabular environment. Default is nil.
4207 :fmt A format to be used to wrap the field, should contain %s for the
4208 original field value. For example, to wrap everything in dollars,
4211 The format may also be a function that formats its one argument.
4213 :efmt Format for transforming numbers with exponentials. The format
4214 should have %s twice for inserting mantissa and exponent, for
4216 This may also be a property list with column numbers and formats.
4217 The format may also be a function that formats its two arguments.
4219 :llend If you find too much space below the last line of a table,
4222 The general parameters :skip and :skipcols have already been applied when
4223 this function is called."
4224 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4225 org-table-last-alignment ""))
4226 (params2
4227 (list
4232 (orgtbl-to-generic table (org-combine-plists params2 params))))
4234 (defun orgtbl-to-html (table params)
4235 "Convert the orgtbl-mode TABLE to HTML.
4236 TABLE is a list, each entry either the symbol `hline' for a horizontal
4237 separator line, or a list of fields for that line.
4238 PARAMS is a property list of parameters that can influence the conversion.
4239 Currently this function recognizes the following parameters:
4241 :splice When set to t, return only table body lines, don't wrap
4242 them into a <table> environment. Default is nil.
4244 The general parameters :skip and :skipcols have already been applied when
4245 this function is called. The function does *not* use `orgtbl-to-generic',
4246 so you cannot specify parameters for it."
4247 (let* ((splicep (plist-get params :splice))
4248 (html-table-tag org-export-html-table-tag)
4249 html)
4250 ;; Just call the formatter we already have
4251 ;; We need to make text lines for it, so put the fields back together.
4252 (setq html (org-format-org-table-html
4253 (mapcar
4254 (lambda (x)
4255 (if (eq x 'hline)
4256 "|----+----|"
4257 (concat "| " (mapconcat 'identity x " | ") " |")))
4258 table)
4259 splicep))
4261 (setq html (replace-match "" t t html)))
4262 html))
4264 (defun orgtbl-to-texinfo (table params)
4265 "Convert the orgtbl-mode TABLE to TeXInfo.
4266 TABLE is a list, each entry either the symbol `hline' for a horizontal
4267 separator line, or a list of fields for that line.
4268 PARAMS is a property list of parameters that can influence the conversion.
4269 Supports all parameters from `orgtbl-to-generic'. Most important for
4270 TeXInfo are:
4272 :splice nil/t When set to t, return only table body lines, don't wrap
4273 them into a multitable environment. Default is nil.
4275 :fmt fmt A format to be used to wrap the field, should contain
4276 %s for the original field value. For example, to wrap
4278 This may also be a property list with column numbers and
4280 Each format also may be a function that formats its one
4281 argument.
4284 are computed automatically from the width of the columns
4285 under org-mode.
4287 The general parameters :skip and :skipcols have already been applied when
4288 this function is called."
4289 (let* ((total (float (apply '+ org-table-last-column-widths)))
4290 (colfrac (or (plist-get params :cf)
4291 (mapconcat
4292 (lambda (x) (format "%.3f" (/ (float x) total)))
4293 org-table-last-column-widths " ")))
4294 (params2
4295 (list
4296 :tstart (concat "@multitable @columnfractions " colfrac)
4297 :tend "@end multitable"
4298 :lstart "@item " :lend "" :sep " @tab "
4299 :hlstart "@headitem ")))
4300 (orgtbl-to-generic table (org-combine-plists params2 params))))
4302 (defun orgtbl-to-orgtbl (table params)
4303 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4304 Useful when slicing one table into many. The :hline, :sep,
4305 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4306 and :tend suppress strings without splicing; they can be set to
4307 provide ORGTBL directives for the generated table."
4308 (let* ((params2
4309 (list
4310 :remove-newlines t
4311 :tstart nil :tend nil
4312 :hline "|---"
4313 :sep " | "
4314 :lstart "| "
4315 :lend " |"))
4316 (params (org-combine-plists params2 params)))
4317 (orgtbl-to-generic table params)))
4319 (defun org-table-get-remote-range (name-or-id form)
4320 "Get a field value or a list of values in a range from table at ID.
4322 NAME-OR-ID may be the name of a table in the current file as set by
4324 will then be used. Alternatively, it may be an ID referring to
4325 any entry, also in a different file. In this case, the first table
4326 in that entry will be referenced.
4330 The return value is either a single string for a single field, or a
4331 list of the fields in the rectangle ."
4332 (save-match-data
4333 (let ((id-loc nil)
4334 org-table-column-names org-table-column-name-regexp
4335 org-table-local-parameters org-table-named-field-locations
4336 org-table-current-line-types org-table-current-begin-line
4337 org-table-current-begin-pos org-table-dlines
4338 org-table-hlines org-table-last-alignment
4339 org-table-last-column-widths org-table-last-alignment
4340 org-table-last-column-widths tbeg
4341 buffer loc)
4342 (setq form (org-table-convert-refs-to-rc form))
4343 (save-excursion
4344 (save-restriction
4345 (widen)
4346 (save-excursion
4347 (goto-char (point-min))
4348 (if (re-search-forward
4350 nil t)
4351 (setq buffer (current-buffer) loc (match-beginning 0))
4352 (setq id-loc (org-id-find name-or-id 'marker))
4353 (unless (and id-loc (markerp id-loc))
4355 (setq buffer (marker-buffer id-loc)
4356 loc (marker-position id-loc))
4357 (move-marker id-loc nil)))
4358 (with-current-buffer buffer
4359 (save-excursion
4360 (save-restriction
4361 (widen)
4362 (goto-char loc)
4363 (forward-char 1)
4365 (not (match-beginning 1)))
4366 (error "Cannot find a table at NAME or ID %s" name-or-id))
4367 (setq tbeg (point-at-bol))
4368 (org-table-get-specials)
4369 (setq form (org-table-formula-substitute-names form))
4370 (if (and (string-match org-table-range-regexp form)
4371 (> (length (match-string 0 form)) 1))
4372 (save-match-data
4373 (org-table-get-range (match-string 0 form) tbeg 1))
4374 form)))))))))
4376 (provide 'org-table)
4378 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4380 ;;; org-table.el ends here