| blob | 13de670712c28efe8ff38afa56e5f365c6ac28a1 |
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: 6.36trans
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. 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
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 narrow
633 falign falign1 fmax f1 len c e space)
636 ;; Check if we have links or dates
645 ;; Make sure the link properties are right
647 ;; Make sure the date properties are right
651 ;; Check if we are narrowing any columns
654 org-format-transports-properties-p
659 ;; Get the rows
662 ;; Store the indentation of the first line
665 ;; Mark the hlines by setting the corresponding element to nil
666 ;; At the same time, we remove trailing space.
669 nil
672 l)))
673 lines))
674 ;; Get the data fields by splitting the lines.
679 ;; How many fields in the longest line?
686 ;; A list of empty strings to fill any short rows on output
688 ;; Check for special formatting.
692 ;; Check if there is an explicit width specified
702 ;; Find fields that are wider than fmax, and shorten them
708 'help-echo
709 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
717 xx)))))
718 ;; Get the maximum width for each column
720 lengths)
721 ;; Get the fraction of numbers, to decide about alignment of the column
727 nil
734 ;; Store the alignment of this table, for later editing of single fields
736 org-table-last-column-widths lengths)
738 ;; With invisible characters, `format' does not get the field width right
739 ;; So we need to make these fields wide by hand.
747 ; (string-match org-bracket-link-regexp (car c))
755 ;; Compute the formats needed for output of the table
768 hfmt))
771 ;; This hack is for org-indent, to force redisplay of the
772 ;; line prefix of the first line. Apparently the redisplay
773 ;; is tied to the newline, which is, I think, a bug.
774 ;; To force this redisplay, we remove and re-insert the
775 ;; newline, so that the redisplay engine thinks it belongs
776 ;; to the changed text.
782 ;; Replace the old one
789 ;; Try to move to the old location
797 ))
800 "Find the beginning of the table and return its position.
801 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
805 org-table-border-regexp)
806 nil t))
813 "Find the end of the table and return its position.
814 With argument TABLE-TYPE, go to the end of a table.el-type table."
818 org-table-border-regexp)
819 nil t))
825 "Justify the current field, text to left, number to right.
826 Optional argument NEW may specify text to replace the current field content."
835 ;; This is not the same table, force a full re-align
841 l f n o e)
865 "Go to the next field in the current table, creating new lines as needed.
866 Before doing so, re-align the table if necessary."
871 org-table-may-need-update)
882 org-table-tab-jumps-over-hlines
894 "Go to the previous field in the table.
895 Before doing so, re-align the table if necessary."
900 org-table-may-need-update)
915 "Move to the end of the current table field.
916 If already at or after the end, move to the end of the next table field.
917 With numeric argument N, move N-1 fields forward first."
930 "Move to the beginning of the current table field.
931 If already at or before the beginning, move to the beginning of the
932 previous field.
933 With numeric argument N, move N-1 fields backward first."
947 "Go to the next row (same column) in the current table.
948 Before doing so, re-align the table if necessary."
956 org-table-may-need-update)
970 "Copy a field down in the current column.
971 If the field at the cursor is empty, copy into it the content of the nearest
972 non-empty field above. With argument N, use the Nth non-empty field.
973 If the current field is not empty, it is copied down to the next row, and
974 the cursor is moved with it. Therefore, repeating this command causes the
975 column to be filled row-by-row.
976 If the variable `org-table-copy-increment' is non-nil and the field is an
977 integer or a timestamp, it will be incremented while copying. In the case of
978 a timestamp, if the cursor is on the year, change the year. If it is on the
979 month or the day, change that. Point will stay on the current date field
980 in order to easily repeat the interval."
988 txt)
1000 beg t))
1023 "Is point inside a table data field?
1024 I.e. not on a hline or before the first or after the last column?
1025 This actually throws an error, so it aborts the current command."
1036 "Get the field in table line LINE, column COLUMN.
1037 If LINE is larger than the number of data lines in the table, the function
1038 returns nil. However, if COLUMN is too large, we will simply return an
1039 empty string.
1040 If LINE is nil, use the current line.
1041 If column is nil, use the current column."
1048 "Put VALUE into line LINE, column COLUMN.
1049 When ALIGN is set, als realign the table."
1058 "Return the index of the current data line."
1065 cnt))
1068 "Go to the Nth data line in the current table.
1069 Return t when the line exists, nil if it does not exist."
1077 "Blank the current table field or active region."
1094 "Return the value of the field in column N of current row.
1095 N defaults to current field.
1096 If REPLACE is a string, replace field with this value. The return value
1097 is always the old value."
1107 val)
1111 "Show info about the current field, and highlight any reference at point."
1119 org-table-named-field-locations)))
1132 dline col
1134 dline col ref1
1136 ;; FIXME: formula info not correct if special table line
1146 "Find out which column we are in."
1152 cnt)))
1155 "Find out what table data line we are in.
1156 Only datalines count for this."
1166 cnt)))
1169 "Move the cursor to the Nth column in the current table line.
1170 With optional argument ON-DELIM, stop with point before the left delimiter
1171 of the field.
1172 If there are less than N fields, just go to after the last delimiter.
1173 However, when FORCE is non-nil, create new columns if necessary."
1183 t)))))
1191 "Insert a new column into the table."
1199 ;; Current cursor position
1205 nil
1217 "Find a dataline in the current table, which is needed for column commands."
1220 t
1231 t
1236 "Delete a column from the table."
1245 ;; Current cursor position
1251 nil
1266 "Move column to the right."
1270 "Move column to the left."
1275 "Move the current column to the right. With arg LEFT, move to the left."
1285 ;; Current cursor position
1295 nil
1312 "Move table row down."
1316 "Move table row up."
1321 "Move the current table line down. With arg UP, move it up."
1330 txt hline2p)
1351 "Insert a new row above the current line into the table.
1352 With prefix ARG, insert below the current line."
1358 ;; Fix the first field if necessary
1370 "Insert a horizontal-line below the current line into the table.
1371 With prefix ABOVE, insert above the current line."
1393 "Insert a hline and move to the row below that line."
1407 In particular, this does handle wide and invisible characters."
1409 ;; It's a hline, just map the characters
1415 t t s)))
1416 s))
1419 "Delete the current row or horizontal line from the table."
1432 "Sort table lines according to the column at point.
1434 The position of point indicates the column to be used for
1435 sorting, and the range of lines is the range between the nearest
1436 horizontal separator lines, or the entire table of no such lines
1437 exist. If point is before the first column, you will be prompted
1438 for the sorting column. If there is an active region, the mark
1439 specifies the first line and the sorting column, while point
1440 should be in the last line to be included into the sorting.
1442 The command then prompts for the sorting type which can be
1443 alphabetically, numerically, or by time (as given in a time stamp
1444 in the field). Sorting in reverse order is also possible.
1446 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1448 If SORTING-TYPE is specified when this function is called from a Lisp
1449 program, no prompting will take place. SORTING-TYPE must be a character,
1450 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1451 should be done in reverse order."
1455 beg end bcol ecol tend tbeg column lns pos)
1500 x))
1513 "Copy region in table to the clipboard and blank all relevant fields.
1514 If there is no active region, use just the field at point."
1521 "Copy rectangular region in table to clipboard.
1522 A special clipboard is used which can only be accessed
1523 with `org-table-paste-rectangle'."
1527 current-prefix-arg))
1529 region cols
1555 org-table-clip))
1558 "Paste a rectangular region into a table.
1559 The upper right corner ends up in the current field. All involved fields
1560 will be overwritten. If the rectangle does not fit into the present table,
1561 the table is enlarged as needed. The process ignores horizontal separator
1562 lines."
1572 c cols field)
1588 "Convert from `org-mode' table to table.el and back.
1589 Obviously, this only works within limits. When an Org-mode table is
1590 converted to table.el, all horizontal separator lines get lost, because
1591 table.el uses these as cell boundaries and has no notion of horizontal lines.
1592 A table.el table can be converted to an Org-mode table only if it does not
1593 do row or column spanning. Multiline cells will become multiple cells.
1594 Beware, Org-mode does not test if the table can be successfully converted - it
1595 blindly applies a recipe that works for simple tables."
1599 ;; convert to Org-mode table
1608 ;; convert to table.el table
1611 ;; first, get rid of all horizontal lines
1615 ;; insert a hline before first
1619 ;; insert a hline after each line
1624 ;; replace "+" at beginning and ending of hlines
1633 "Wrap several fields in a column like a paragraph.
1634 This is useful if you'd like to spread the contents of a field over several
1635 lines, in order to keep the table compact.
1637 If there is an active region, and both point and mark are in the same column,
1638 the text in the column is wrapped to minimum width for the given number of
1639 lines. Generally, this makes the table more compact. A prefix ARG may be
1641 formats the selected text to two lines. If the region was longer than two
1642 lines, the remaining lines remain empty. A negative prefix argument reduces
1643 the current number of lines by that amount. The wrapped text is pasted back
1644 into the table. If you formatted it to more lines than it was before, fields
1645 further down in the table get overwritten - so you might need to make space in
1646 the table first.
1648 If there is no region, the current field is split at the cursor position and
1649 the text fragment to the right of the cursor is prepended to the field one
1650 line down.
1652 If there is no region, but you specify a prefix ARG, the current field gets
1653 blank, and the content is appended to the field above."
1657 ;; There is a region: fill as a paragraph
1661 nlines)
1668 arg)
1672 nil nlines)))
1676 ;; No region, split the current field at point
1680 ;; combine with field above
1690 ;; split field
1703 "Edit table field in a different window.
1704 This is mainly useful for fields that contain hidden parts.
1706 it can be edited in place."
1712 display t intangible t))
1718 p)
1727 intangible t))
1735 "Finish editing a table data field.
1736 Remove all newline characters, insert the result into the table, realign
1737 the table and kill the editing buffer."
1741 text)
1760 "Sum numbers in region of current table column.
1761 The result will be displayed in the echo area, and will be available
1764 If there is an active region, it is interpreted as a rectangle and all
1765 numbers in that rectangle will be summed. If there is no active
1766 region and point is located in a table column, sum all numbers in that
1767 column.
1769 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1770 numbers are assumed to be times as well (in decimal hours) and the
1771 numbers are added as such.
1773 If NLAST is a number, only the NLAST fields will actually be summed."
1800 items1)))
1807 s diff)
1815 sres))))
1838 "Return the formula active for the current field.
1839 Assumes that specials are in place.
1840 If KEY is given, return the key to this formula.
1844 org-table-named-field-locations)))
1858 "Read a formula from the minibuffer, offer stored formula as default.
1859 When NAMED is non-nil, look for a named equation."
1863 org-table-named-field-locations)))
1870 name
1871 ref)
1881 stored)
1883 equation)
1890 scol))
1892 'org-table-formula-history
1893 )))))
1894 mustsave)
1896 ;; remove formula
1903 ;; We set the column equation, delete the named one.
1905 mustsave t))
1911 eq))
1914 "Store the list of formulas below the current table."
1920 ;; don't overwrite TBLFM, we might use text properties to store stuff
1941 "Compare two formulas for sorting."
1947 "Return an alist with the stored formulas directly after current table."
1955 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1972 "Modify the equations after the table structure has been edited.
1974 For all numbers larger than LIMIT, shift them by DELTA."
1985 s n a)
1998 t t)))))))))
2001 "Get the column names and local parameters for this table."
2004 names name fields fields1 field cnt
2005 c v l line col types dlines hlines last-dline)
2007 org-table-local-parameters nil
2008 org-table-named-field-locations nil
2009 org-table-current-begin-line nil
2010 org-table-current-begin-pos nil
2011 org-table-current-line-types nil)
2029 org-table-local-parameters))))
2045 ;; Analyse the line types
2049 l org-table-current-begin-line)
2066 al al2)
2078 If yes, store the formula and apply it."
2079 ;; We already know we are in a table. Get field will only return a formula
2080 ;; when appropriate. It might return a separator line, but no problem.
2083 named eq)
2094 "List of commands triggering the recalculation of a line.
2107 "Rotate the recalculation mark in the first column.
2108 If in any row, the first field is not consistent with a mark,
2109 insert a new column for the markers.
2110 When there is an active region, change all the lines in the region,
2111 after prompting for the marking character.
2112 After each change, a message will be displayed indicating the meaning
2113 of the new mark."
2128 epos new)
2135 newchar))
2167 "Recompute the current line if marked for it, and if we haven't just done it."
2187 modes)
2190 suppress-align suppress-const
2191 suppress-store suppress-analysis)
2192 "Replace the table field value at the cursor by the result of a calculation.
2194 This function makes use of Dave Gillespie's Calc package, in my view the
2195 most exciting program ever written for GNU Emacs. So you need to have Calc
2196 installed in order to use this function.
2198 In a table, this command replaces the value in the current field with the
2200 formula, by storing it in a special line below the table. When called
2201 with a `C-u' prefix, the current field must be a named field, and the
2202 formula is installed as valid in only this specific field.
2204 When called with two `C-u' prefixes, insert the active equation
2205 for the field back into the current field, so that it can be
2207 to check the referenced fields.
2209 When called, the command first prompts for a formula, which is read in
2210 the minibuffer. Previously entered formulas are available through the
2211 history list, and the last used formula is offered as a default.
2212 These stored formulas are adapted correctly when moving, inserting, or
2213 deleting columns with the corresponding commands.
2215 The formula can be any algebraic expression understood by the Calc package.
2216 For details, see the Org-mode manual.
2218 This function can also be called from Lisp programs and offers
2219 additional arguments: EQUATION can be the formula to apply. If this
2220 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2221 used to speed-up recursive calls by by-passing unnecessary aligns.
2222 SUPPRESS-CONST suppresses the interpretation of constants in the
2223 formula, assuming that this has been done already outside the function.
2224 SUPPRESS-STORE means the formula should not be stored, either because
2225 it is already stored, or because it is a modified equation that should
2226 not overwrite the stored one."
2242 equation
2248 n form form0 bw fmt x ev orig c lispp literal)
2249 ;; Parse the format string. Since we have a lot of modes, this is
2250 ;; a lot of work. However, I think calc still uses most of the time.
2262 'calc-float-format
2265 n))))
2292 fields)))
2298 ;; Insert row and column number of formula result field
2309 t t form)))
2311 ;; Check for old vertical references
2313 ;; Insert remote references
2321 keep-empty numbers lispp))
2322 t t form)))
2323 ;; Insert complex ranges
2331 keep-empty numbers lispp))
2332 t t form)))
2333 ;; Insert simple ranges
2342 keep-empty numbers lispp))
2343 t t form)))
2345 ;; Insert the references to fields in same row
2354 t t form)))
2369 Orig: %s
2370 $xyz-> %s
2371 @r$c-> %s
2402 prop value)))
2405 "Get a calc vector from a column, according to descriptor DESC.
2406 Optional arguments TBEG and COL can give the beginning of the table and
2407 the current column, to avoid unnecessary parsing.
2408 HIGHLIGHT means just highlight the range."
2415 beg end c1 c2 r1 r2 rangep tmp)
2432 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2438 ;; just one field
2445 ;; A range, return a vector
2446 ;; First sort the numbers to get a regular ractangle
2462 ;; return string representation of calc vector
2467 "Analyze descriptor DESC and retrieve the corresponding line number.
2468 The cursor is currently in line CLINE, the table begins in line BLINE,
2469 and TABLE is a vector with line types."
2477 ;; 1 2 3 4 5 6
2497 nil hn cline desc)))
2500 rel on cline desc)))
2504 "FIXME: Needs more documentation."
2517 nil))
2518 t)))
2522 desc cline)
2523 i)))
2528 s))
2531 "Convert list ELEMENTS to something appropriate to insert into formula.
2532 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2533 NUMBERS indicates that everything should be converted to numbers.
2534 LISPP means to return something appropriate for a Lisp list."
2538 elements
2547 elements))))
2553 x
2559 elements
2563 "Recalculate the current table line by applying all stored formulas.
2564 With prefix arg ALL, do this for all lines in the table.
2565 With the prefix argument ALL is `(16)' (a double `C-c C-u' prefix), or if
2566 it is the symbol `iterate', recompute the table until it no longer changes.
2567 If NOALIGN is not nil, do not re-align the table after the computations
2568 are done. This is typically used internally to save time, if it is
2569 known that the table will be realigned a little later anyway."
2584 ;; Insert constants in all formulas
2588 x)
2589 eqlist))
2590 ;; Split the equation list
2601 ;; This is a table with marked lines, compute selected lines
2603 ;; Move forward to the first non-header line
2614 ;; First find the named fields, and mark them untouchable
2626 name)))
2635 ;; Now evaluate the column formulas, but skip fields covered by
2636 ;; field formulas
2640 ;; Unprotected line, recalculate
2652 ;; Now evaluate the field formulas
2666 ;; back to initial position
2674 "Recalculate the table until it does not change anymore."
2679 thistbl)
2694 "Recalculate all tables in the current buffer."
2702 "Iterate all tables in the buffer, to converge inter-table dependencies."
2707 c1
2724 "Replace $const with values in string F."
2726 ;; First, check for column names
2731 ;; Parameters and constants
2733 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2743 f))
2746 "Find the value for a parameter or constant in a formula.
2747 Parameters get priority."
2777 map))
2784 "--"
2787 "--"
2788 "Shift Reference at Point"
2793 "-"
2794 "Change Test Row for Column Formulas"
2797 "--"
2802 org-table-overlay-coordinates)]
2803 "--"
2810 "Edit the formulas of the current table in a separate buffer."
2826 entry s type title)
2829 ;; Keep global-font-lock-mode from turning on font-lock-mode
2869 "Convert a formula from internal to user representation."
2872 s))
2875 "Convert a formula from user to internal representation."
2878 s))
2881 "Convert spreadsheet references from AB7 to @7$28.
2882 Works for single references, but also for entire formulas and even the
2883 full TBLFM line."
2885 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2888 ;; format match, just advance
2893 ;; 3.e5 or something like this.
2896 ;; (member (match-string 1 s)
2897 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2898 )
2899 ;; function name, just advance
2909 t t s)))))
2910 s))
2913 "Convert spreadsheet references from to @7$28 to AB7.
2914 Works for single references, but also for entire formulas and even the
2915 full TBLFM line."
2922 t t s)))
2927 t nil s)))
2928 s)
2931 "Convert a base 26 number represented by letters into an integer.
2932 For example: AB -> 28."
2938 n))
2941 "Convert an integer into a base 26 number represented by letters.
2942 For example: 28 -> AB."
2947 s))
2950 "Convert all references in this buffer, using FUNCTION."
2960 "Convert all references in the buffer from B3 to @3$2 and back."
2970 "Shift the reference at point one row/hline up."
2974 "Shift the reference at point one row/hline down."
2978 "Shift the reference at point one field to the left."
2982 "Shift the reference at point one field to the right."
2993 ;; A B3-like reference
2999 ;; An internal reference
3005 "Re-match the group N, and replace it with the shifted refrence."
3010 t t)))
3013 "Shift a refrence part REF.
3014 If DECR is set, decrease the references row/column, else increase.
3015 If HLINE is set, this may be a hline reference, it certainly is not
3016 a translation reference."
3045 "Toggle the display of coordinates in the referenced table."
3054 "Parse the buffer for formula definitions and install them.
3055 With prefix ARG, apply the new formulas to the table."
3066 nil t)
3090 "Abort editing formulas, without installing the changes."
3101 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3142 "Show the location/value of the $ expression at point."
3151 var name e what match dest)
3233 ;; column number
3261 org-table-fedit-scroll-down))))
3272 "Make sure the cursor is in a dataline in a table."
3281 p1 p2)))
3286 "Move cursor one line up in the window showing the table."
3291 "Move cursor one line down in the window showing the table."
3296 "Move the cursor in the window showing the table.
3297 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3322 "Add a new overlay."
3328 "Highlight rectangular region in a table."
3332 l1 c1 l2 c2 tmp)
3356 "Remove the rectangle overlays."
3367 "Add overlays to the table at point, to show row/column coordinates."
3396 "Toggle the display of Row/Column numbers in tables."
3408 "Toggle the formula debugger in tables."
3414 ;;; The orgtbl minor mode
3416 ;; Define a minor mode which can be used in other modes in order to
3417 ;; integrate the org-mode table editor.
3419 ;; This is really a hack, because the org-mode table editor uses several
3420 ;; keys which normally belong to the major mode, for example the TAB and
3421 ;; RET keys. Here is how it works: The minor mode defines all the keys
3422 ;; necessary to operate the table editor, but wraps the commands into a
3423 ;; function which tests if the cursor is currently inside a table. If that
3424 ;; is the case, the table editor command is executed. However, when any of
3425 ;; those keys is used outside a table, the function uses `key-binding' to
3426 ;; look up if the key has an associated command in another currently active
3427 ;; keymap (minor modes, major mode, global), and executes that command.
3428 ;; There might be problems if any of the keys used by the table editor is
3429 ;; otherwise used as a prefix key.
3431 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3432 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3433 ;; addresses this by checking explicitly for both bindings.
3435 ;; The optimized version (see variable `orgtbl-optimized') takes over
3436 ;; all keys which are bound to `self-insert-command' in the *global map*.
3437 ;; Some modes bind other commands to simple characters, for example
3438 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3439 ;; active, this binding is ignored inside tables and replaced with a
3440 ;; modified self-insert.
3446 ;;;###autoload
3448 "Unconditionally turn on `orgtbl-mode'."
3463 ;; Install it as a minor mode.
3467 ;;;###autoload
3469 "The `org-mode' table editor as a minor mode for use in other modes."
3474 ;; Exit without error, in case some hook functions calls this
3475 ;; by accident in org-mode.
3479 ;; Make sure we are first in minor-mode-map-alist
3481 ;; FIXME: maybe it should use emulation-mode-map-alists?
3488 auto-fill-inhibit-regexp)
3492 auto-fill-inhibit-regexp)
3493 orgtbl-line-start-regexp))
3511 "Remove all properties related to narrow-column invisibility."
3524 "Create a function for binding in the table minor mode.
3525 FUN is the command to call inside a table. N is used to create a unique
3526 command name. KEYS are keys that should be checked in for a command
3527 to execute outside of tables."
3533 "Outside of tables, run the binding of `"
3545 keys)
3549 "Error when there is no default binding for a table key."
3554 "Setup orgtbl keymaps."
3584 elt key fun cmd)
3592 ;; Special treatment needed for TAB and RET
3612 [(tab)] "\C-i")))
3614 (org-defkey orgtbl-mode-map [backtab]
3616 [backtab] [S-iso-lefttab] [(shift tab)]
3617 [(tab)] "\C-i"))
3619 (org-defkey orgtbl-mode-map "\M-\C-m"
3620 (orgtbl-make-binding 'org-table-wrap-region 105
3621 "\M-\C-m" [(meta return)]))
3622 (org-defkey orgtbl-mode-map [(meta return)]
3623 (orgtbl-make-binding 'org-table-wrap-region 106
3624 [(meta return)] "\M-\C-m"))
3626 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3627 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3629 (when orgtbl-optimized
3630 ;; If the user wants maximum table support, we need to hijack
3631 ;; some standard editing functions
3632 (org-remap orgtbl-mode-map
3633 'self-insert-command 'orgtbl-self-insert-command
3634 'delete-char 'org-delete-char
3635 'delete-backward-char 'org-delete-backward-char)
3636 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3637 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3638 '("OrgTbl"
3639 ["Create or convert" org-table-create-or-convert-from-region
3640 :active (not (org-at-table-p)) :keys "C-c |" ]
3641 "--"
3642 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3643 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3644 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3645 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3646 "--"
3647 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3648 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3649 ["Copy Field from Above"
3650 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3651 "--"
3652 ("Column"
3653 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3654 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3655 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3656 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3657 ("Row"
3658 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3659 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3660 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3661 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3662 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3663 "--"
3664 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3665 ("Rectangle"
3666 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3667 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3668 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3669 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3670 "--"
3671 ("Radio tables"
3672 ["Insert table template" orgtbl-insert-radio-table
3673 (assq major-mode orgtbl-radio-table-templates)]
3674 ["Comment/uncomment table" orgtbl-toggle-comment t])
3675 "--"
3676 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3677 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3678 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3679 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3680 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3681 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3682 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3683 ["Sum Column/Rectangle" org-table-sum
3684 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3685 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3686 ["Debug Formulas"
3687 org-table-toggle-formula-debugger :active (org-at-table-p)
3688 :keys "C-c {"
3689 :style toggle :selected org-table-formula-debug]
3690 ["Show Col/Row Numbers"
3691 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3692 :keys "C-c }"
3693 :style toggle :selected org-table-overlay-coordinates]
3694 ))
3695 t))
3697 (defun orgtbl-ctrl-c-ctrl-c (arg)
3698 "If the cursor is inside a table, realign the table.
3699 If it is a table to be sent away to a receiver, do it.
3700 With prefix arg, also recompute table."
3701 (interactive "P")
3702 (let ((pos (point)) action)
3703 (save-excursion
3704 (beginning-of-line 1)
3708 (cond
3709 ((integerp action)
3710 (goto-char action)
3711 (org-table-maybe-eval-formula)
3712 (if arg
3713 (call-interactively 'org-table-recalculate)
3714 (org-table-maybe-recalculate-line))
3715 (call-interactively 'org-table-align)
3716 (orgtbl-send-table 'maybe))
3717 ((eq action 'recalc)
3718 (save-excursion
3719 (beginning-of-line 1)
3721 (if (org-at-table-p)
3722 (org-call-with-arg 'org-table-recalculate t))))
3723 (t (let (orgtbl-mode)
3724 (call-interactively (key-binding "\C-c\C-c")))))))
3726 (defun orgtbl-create-or-convert-from-region (arg)
3727 "Create table or convert region to table, if no conflicting binding.
3728 This installs the table binding `C-c |', but only if there is no
3729 conflicting binding to this key outside orgtbl-mode."
3730 (interactive "P")
3731 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3732 (if cmd
3733 (call-interactively cmd)
3734 (call-interactively 'org-table-create-or-convert-from-region))))
3736 (defun orgtbl-tab (arg)
3737 "Justification and field motion for `orgtbl-mode'."
3738 (interactive "P")
3739 (if arg (org-table-edit-field t)
3740 (org-table-justify-field-maybe)
3741 (org-table-next-field)))
3743 (defun orgtbl-ret ()
3744 "Justification and field motion for `orgtbl-mode'."
3745 (interactive)
3746 (if (bobp)
3747 (newline)
3748 (org-table-justify-field-maybe)
3749 (org-table-next-row)))
3751 (defun orgtbl-self-insert-command (N)
3752 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3753 If the cursor is in a table looking at whitespace, the whitespace is
3754 overwritten, and the table is not marked as requiring realignment."
3755 (interactive "p")
3756 (if (and (org-at-table-p)
3757 (or
3758 (and org-table-auto-blank-field
3759 (member last-command
3760 '(orgtbl-hijacker-command-100
3761 orgtbl-hijacker-command-101
3762 orgtbl-hijacker-command-102
3763 orgtbl-hijacker-command-103
3764 orgtbl-hijacker-command-104
3765 orgtbl-hijacker-command-105
3766 yas/expand))
3767 (org-table-blank-field))
3768 t)
3769 (eq N 1)
3771 (let (org-table-may-need-update)
3772 (goto-char (1- (match-end 0)))
3773 (delete-backward-char 1)
3774 (goto-char (match-beginning 0))
3775 (self-insert-command N))
3776 (setq org-table-may-need-update t)
3777 (let* (orgtbl-mode
3778 a
3779 (cmd (or (key-binding
3780 (or (and (listp function-key-map)
3781 (setq a (assoc last-input-event function-key-map))
3782 (cdr a))
3783 (vector last-input-event)))
3784 'self-insert-command)))
3785 (call-interactively cmd)
3786 (if (and org-self-insert-cluster-for-undo
3787 (eq cmd 'self-insert-command))
3788 (if (not (eq last-command 'orgtbl-self-insert-command))
3789 (setq org-self-insert-command-undo-counter 1)
3790 (if (>= org-self-insert-command-undo-counter 20)
3791 (setq org-self-insert-command-undo-counter 1)
3792 (and (> org-self-insert-command-undo-counter 0)
3793 buffer-undo-list
3794 (not (cadr buffer-undo-list)) ; remove nil entry
3795 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3796 (setq org-self-insert-command-undo-counter
3797 (1+ org-self-insert-command-undo-counter))))))))
3800 "Regular expression matching exponentials as produced by calc.")
3802 (defun orgtbl-export (table target)
3803 (require 'org-exp)
3804 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3806 org-table-last-alignment org-table-last-column-widths
3807 maxcol column)
3808 (if (not (fboundp func))
3809 (error "Cannot export orgtbl table to %s" target))
3810 (setq lines (org-table-clean-before-export lines))
3811 (setq table
3812 (mapcar
3813 (lambda (x)
3814 (if (string-match org-table-hline-regexp x)
3815 'hline
3817 lines))
3818 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3819 table)))
3820 (loop for i from (1- maxcol) downto 0 do
3821 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3822 (setq column (delq nil column))
3823 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3824 (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))
3825 (funcall func table nil)))
3827 (defun orgtbl-gather-send-defs ()
3828 "Gathers a plist of :name, :transform, :params for each destination before
3829 a radio table."
3830 (save-excursion
3831 (goto-char (org-table-begin))
3832 (let (rtn)
3833 (beginning-of-line 0)
3834 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3835 (let ((name (org-no-properties (match-string 1)))
3836 (transform (intern (match-string 2)))
3837 (params (if (match-end 3)
3838 (read (concat "(" (match-string 3) ")")))))
3839 (push (list :name name :transform transform :params params)
3840 rtn)
3841 (beginning-of-line 0)))
3842 rtn)))
3844 (defun orgtbl-send-replace-tbl (name txt)
3845 "Find and replace table NAME with TXT."
3846 (save-excursion
3847 (goto-char (point-min))
3848 (unless (re-search-forward
3850 (error "Don't know where to insert translated table"))
3851 (goto-char (match-beginning 0))
3852 (beginning-of-line 2)
3853 (save-excursion
3854 (let ((beg (point)))
3855 (unless (re-search-forward
3856 (concat "END RECEIVE ORGTBL +" name) nil t)
3857 (error "Cannot find end of insertion region"))
3858 (beginning-of-line 1)
3859 (delete-region beg (point))))
3862 ;;;###autoload
3863 (defun org-table-to-lisp (&optional txt)
3864 "Convert the table at point to a Lisp structure.
3865 The structure will be a list. Each item is either the symbol `hline'
3866 for a horizontal separator line, or a list of field values as strings.
3867 The table is taken from the parameter TXT, or from the buffer at point."
3868 (unless txt
3869 (unless (org-at-table-p)
3870 (error "No table at point")))
3871 (let* ((txt (or txt
3872 (buffer-substring-no-properties (org-table-begin)
3873 (org-table-end))))
3876 (mapcar
3877 (lambda (x)
3878 (if (string-match org-table-hline-regexp x)
3879 'hline
3881 lines)))
3883 (defun orgtbl-send-table (&optional maybe)
3884 "Send a transformed version of this table to the receiver position.
3885 With argument MAYBE, fail quietly if no transformation is defined for
3886 this table."
3887 (interactive)
3888 (catch 'exit
3889 (unless (org-at-table-p) (error "Not at a table"))
3890 ;; when non-interactive, we assume align has just happened.
3891 (when (interactive-p) (org-table-align))
3892 (let ((dests (orgtbl-gather-send-defs))
3893 (txt (buffer-substring-no-properties (org-table-begin)
3894 (org-table-end)))
3895 (ntbl 0))
3896 (unless dests (if maybe (throw 'exit nil)
3897 (error "Don't know how to transform this table")))
3898 (dolist (dest dests)
3899 (let* ((name (plist-get dest :name))
3900 (transform (plist-get dest :transform))
3901 (params (plist-get dest :params))
3902 (skip (plist-get params :skip))
3903 (skipcols (plist-get params :skipcols))
3904 beg
3905 (lines (org-table-clean-before-export
3906 (nthcdr (or skip 0)
3908 (i0 (if org-table-clean-did-remove-column 2 1))
3909 (table (mapcar
3910 (lambda (x)
3911 (if (string-match org-table-hline-regexp x)
3912 'hline
3913 (org-remove-by-index
3915 skipcols i0)))
3916 lines))
3917 (fun (if (= i0 2) 'cdr 'identity))
3918 (org-table-last-alignment
3919 (org-remove-by-index (funcall fun org-table-last-alignment)
3920 skipcols i0))
3921 (org-table-last-column-widths
3922 (org-remove-by-index (funcall fun org-table-last-column-widths)
3923 skipcols i0))
3924 (txt (if (fboundp transform)
3925 (funcall transform table params)
3926 (error "No such transformation function %s" transform))))
3927 (orgtbl-send-replace-tbl name txt))
3928 (setq ntbl (1+ ntbl)))
3929 (message "Table converted and installed at %d receiver location%s"
3930 ntbl (if (> ntbl 1) "s" "")))))
3932 (defun org-remove-by-index (list indices &optional i0)
3933 "Remove the elements in LIST with indices in INDICES.
3934 First element has index 0, or I0 if given."
3935 (if (not indices)
3936 list
3937 (if (integerp indices) (setq indices (list indices)))
3938 (setq i0 (1- (or i0 0)))
3939 (delq :rm (mapcar (lambda (x)
3940 (setq i0 (1+ i0))
3941 (if (memq i0 indices) :rm x))
3942 list))))
3944 (defun orgtbl-toggle-comment ()
3945 "Comment or uncomment the orgtbl at point."
3946 (interactive)
3947 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3948 (re2 (concat "^" orgtbl-line-start-regexp))
3949 (commented (save-excursion (beginning-of-line 1)
3950 (cond ((looking-at re1) t)
3951 ((looking-at re2) nil)
3952 (t (error "Not at an org table")))))
3953 (re (if commented re1 re2))
3954 beg end)
3955 (save-excursion
3956 (beginning-of-line 1)
3957 (while (looking-at re) (beginning-of-line 0))
3958 (beginning-of-line 2)
3959 (setq beg (point))
3960 (while (looking-at re) (beginning-of-line 2))
3961 (setq end (point)))
3962 (comment-region beg end (if commented '(4) nil))))
3964 (defun orgtbl-insert-radio-table ()
3965 "Insert a radio table template appropriate for this major mode."
3966 (interactive)
3967 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3968 (txt (nth 1 e))
3969 name pos)
3970 (unless e (error "No radio table setup defined for %s" major-mode))
3971 (setq name (read-string "Table name: "))
3972 (while (string-match "%n" txt)
3973 (setq txt (replace-match name t t txt)))
3975 (setq pos (point))
3976 (insert txt)
3977 (goto-char pos)))
3979 ;; Dynamically bound input and output for table formatting.
3980 (defvar *orgtbl-table* nil
3981 "Carries the current table through formatting routines.")
3982 (defvar *orgtbl-rtn* nil
3983 "Formatting routines push the output lines here.")
3984 ;; Formatting parameters for the current table section.
3985 (defvar *orgtbl-hline* nil "Text used for horizontal lines")
3986 (defvar *orgtbl-sep* nil "Text used as a column separator")
3987 (defvar *orgtbl-default-fmt* nil "Default format for each entry")
3988 (defvar *orgtbl-fmt* nil "Format for each entry")
3989 (defvar *orgtbl-efmt* nil "Format for numbers")
3990 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt")
3991 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row")
3992 (defvar *orgtbl-lstart* nil "Text starting a row")
3993 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row")
3994 (defvar *orgtbl-lend* nil "Text ending a row")
3995 (defvar *orgtbl-llend* nil "Specializes lend for the last row")
3997 (defsubst orgtbl-get-fmt (fmt i)
3998 "Retrieve the format from FMT corresponding to the Ith column."
3999 (if (and (not (functionp fmt)) (consp fmt))
4000 (plist-get fmt i)
4001 fmt))
4003 (defsubst orgtbl-apply-fmt (fmt &rest args)
4004 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4005 (cond ((functionp fmt) (apply fmt args))
4006 (fmt (apply 'format fmt args))
4007 (args (car args))
4008 (t args)))
4010 (defsubst orgtbl-eval-str (str)
4011 "If STR is a function, evaluate it with no arguments."
4012 (if (functionp str)
4013 (funcall str)
4014 str))
4016 (defun orgtbl-format-line (line)
4017 "Format LINE as a table row."
4018 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4019 (let* ((i 0)
4020 (line
4021 (mapcar
4022 (lambda (f)
4023 (setq i (1+ i))
4024 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4025 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4026 (orgtbl-apply-fmt efmt (match-string 1 f)
4027 (match-string 2 f))
4028 f)))
4029 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4030 *orgtbl-default-fmt*)
4031 f)))
4032 line)))
4033 (push (if *orgtbl-lfmt*
4034 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4035 (concat (orgtbl-eval-str *orgtbl-lstart*)
4036 (mapconcat 'identity line *orgtbl-sep*)
4037 (orgtbl-eval-str *orgtbl-lend*)))
4038 *orgtbl-rtn*))))
4040 (defun orgtbl-format-section (section-stopper)
4041 "Format lines until the first occurrence of SECTION-STOPPER."
4042 (let (prevline)
4043 (progn
4044 (while (not (eq (car *orgtbl-table*) section-stopper))
4045 (if prevline (orgtbl-format-line prevline))
4046 (setq prevline (pop *orgtbl-table*)))
4047 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4048 (*orgtbl-lend* *orgtbl-llend*)
4049 (*orgtbl-lfmt* *orgtbl-llfmt*))
4050 (orgtbl-format-line prevline))))))
4052 (defun orgtbl-to-generic (table params)
4053 "Convert the orgtbl-mode TABLE to some other format.
4054 This generic routine can be used for many standard cases.
4055 TABLE is a list, each entry either the symbol `hline' for a horizontal
4056 separator line, or a list of fields for that line.
4057 PARAMS is a property list of parameters that can influence the conversion.
4058 For the generic converter, some parameters are obligatory: You need to
4059 specify either :lfmt, or all of (:lstart :lend :sep).
4061 Valid parameters are
4063 :splice When set to t, return only table body lines, don't wrap
4064 them into :tstart and :tend. Default is nil. When :splice
4065 is non-nil, this also means that the exporter should not look
4066 for and interpret header and footer sections.
4068 :hline String to be inserted on horizontal separation lines.
4069 May be nil to ignore hlines.
4071 :sep Separator between two fields
4072 :remove-nil-lines Do not include lines that evaluate to nil.
4075 Each in the following group may be either a string or a function
4076 of no arguments returning a string:
4077 :tstart String to start the table. Ignored when :splice is t.
4078 :tend String to end the table. Ignored when :splice is t.
4079 :lstart String to start a new table line.
4080 :llstart String to start the last table line, defaults to :lstart.
4081 :lend String to end a table line
4082 :llend String to end the last table line, defaults to :lend.
4084 Each in the following group may be a string, a function of one
4085 argument (the field or line) returning a string, or a plist
4086 mapping columns to either of the above:
4087 :lfmt Format for entire line, with enough %s to capture all fields.
4088 If this is present, :lstart, :lend, and :sep are ignored.
4089 :llfmt Format for the entire last line, defaults to :lfmt.
4090 :fmt A format to be used to wrap the field, should contain
4091 %s for the original field value. For example, to wrap
4093 This may also be a property list with column numbers and
4096 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4097 Same as above, specific for the header lines in the table.
4098 All lines before the first hline are treated as header.
4099 If any of these is not present, the data line value is used.
4101 This may be either a string or a function of two arguments:
4102 :efmt Use this format to print numbers with exponentials.
4103 The format should have %s twice for inserting mantissa
4105 may also be a property list with column numbers and
4106 formats. :fmt will still be applied after :efmt.
4108 In addition to this, the parameters :skip and :skipcols are always handled
4109 directly by `orgtbl-send-table'. See manual."
4110 (interactive)
4112 (let* ((splicep (plist-get params :splice))
4113 (hline (plist-get params :hline))
4114 (remove-nil-linesp (plist-get params :remove-nil-lines))
4115 (*orgtbl-hline* hline)
4116 (*orgtbl-table* table)
4117 (*orgtbl-sep* (plist-get params :sep))
4118 (*orgtbl-efmt* (plist-get params :efmt))
4119 (*orgtbl-lstart* (plist-get params :lstart))
4120 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4121 (*orgtbl-lend* (plist-get params :lend))
4122 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4123 (*orgtbl-lfmt* (plist-get params :lfmt))
4124 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4125 (*orgtbl-fmt* (plist-get params :fmt))
4126 *orgtbl-rtn*)
4128 ;; Put header
4129 (unless splicep
4130 (when (plist-member params :tstart)
4131 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4132 (if tstart (push tstart *orgtbl-rtn*)))))
4134 ;; Do we have a heading section? If so, format it and handle the
4135 ;; trailing hline.
4136 (if (and (not splicep)
4137 (or (consp (car *orgtbl-table*))
4138 (consp (nth 1 *orgtbl-table*)))
4139 (memq 'hline (cdr *orgtbl-table*)))
4140 (progn
4141 (when (eq 'hline (car *orgtbl-table*))
4142 ;; there is a hline before the first data line
4143 (and hline (push hline *orgtbl-rtn*))
4144 (pop *orgtbl-table*))
4145 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4146 *orgtbl-lstart*))
4147 (*orgtbl-llstart* (or (plist-get params :hllstart)
4148 *orgtbl-llstart*))
4149 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4150 (*orgtbl-llend* (or (plist-get params :hllend)
4151 (plist-get params :hlend) *orgtbl-llend*))
4152 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4153 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4154 (plist-get params :hlfmt) *orgtbl-llfmt*))
4155 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4156 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4157 (orgtbl-format-section 'hline))
4158 (if hline (push hline *orgtbl-rtn*))
4159 (pop *orgtbl-table*)))
4161 ;; Now format the main section.
4162 (orgtbl-format-section nil)
4164 (unless splicep
4165 (when (plist-member params :tend)
4166 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4167 (if tend (push tend *orgtbl-rtn*)))))
4169 (mapconcat 'identity (nreverse (if remove-nil-linesp
4170 (remq nil *orgtbl-rtn*)
4173 (defun orgtbl-to-tsv (table params)
4174 "Convert the orgtbl-mode table to TAB separated material."
4176 (defun orgtbl-to-csv (table params)
4177 "Convert the orgtbl-mode table to CSV material.
4178 This does take care of the proper quoting of fields with comma or quotes."
4179 (orgtbl-to-generic table (org-combine-plists
4180 '(:sep "," :fmt org-quote-csv-field)
4181 params)))
4183 (defun orgtbl-to-latex (table params)
4184 "Convert the orgtbl-mode TABLE to LaTeX.
4185 TABLE is a list, each entry either the symbol `hline' for a horizontal
4186 separator line, or a list of fields for that line.
4187 PARAMS is a property list of parameters that can influence the conversion.
4188 Supports all parameters from `orgtbl-to-generic'. Most important for
4189 LaTeX are:
4191 :splice When set to t, return only table body lines, don't wrap
4192 them into a tabular environment. Default is nil.
4194 :fmt A format to be used to wrap the field, should contain %s for the
4195 original field value. For example, to wrap everything in dollars,
4198 The format may also be a function that formats its one argument.
4200 :efmt Format for transforming numbers with exponentials. The format
4201 should have %s twice for inserting mantissa and exponent, for
4203 This may also be a property list with column numbers and formats.
4204 The format may also be a function that formats its two arguments.
4206 :llend If you find too much space below the last line of a table,
4209 The general parameters :skip and :skipcols have already been applied when
4210 this function is called."
4211 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4212 org-table-last-alignment ""))
4213 (params2
4214 (list
4219 (orgtbl-to-generic table (org-combine-plists params2 params))))
4221 (defun orgtbl-to-html (table params)
4222 "Convert the orgtbl-mode TABLE to LaTeX.
4223 TABLE is a list, each entry either the symbol `hline' for a horizontal
4224 separator line, or a list of fields for that line.
4225 PARAMS is a property list of parameters that can influence the conversion.
4226 Currently this function recognizes the following parameters:
4228 :splice When set to t, return only table body lines, don't wrap
4229 them into a <table> environment. Default is nil.
4231 The general parameters :skip and :skipcols have already been applied when
4232 this function is called. The function does *not* use `orgtbl-to-generic',
4233 so you cannot specify parameters for it."
4234 (let* ((splicep (plist-get params :splice))
4235 (html-table-tag org-export-html-table-tag)
4236 html)
4237 ;; Just call the formatter we already have
4238 ;; We need to make text lines for it, so put the fields back together.
4239 (setq html (org-format-org-table-html
4240 (mapcar
4241 (lambda (x)
4242 (if (eq x 'hline)
4243 "|----+----|"
4244 (concat "| " (mapconcat 'identity x " | ") " |")))
4245 table)
4246 splicep))
4248 (setq html (replace-match "" t t html)))
4249 html))
4251 (defun orgtbl-to-texinfo (table params)
4252 "Convert the orgtbl-mode TABLE to TeXInfo.
4253 TABLE is a list, each entry either the symbol `hline' for a horizontal
4254 separator line, or a list of fields for that line.
4255 PARAMS is a property list of parameters that can influence the conversion.
4256 Supports all parameters from `orgtbl-to-generic'. Most important for
4257 TeXInfo are:
4259 :splice nil/t When set to t, return only table body lines, don't wrap
4260 them into a multitable environment. Default is nil.
4262 :fmt fmt A format to be used to wrap the field, should contain
4263 %s for the original field value. For example, to wrap
4265 This may also be a property list with column numbers and
4267 Each format also may be a function that formats its one
4268 argument.
4271 are computed automatically from the width of the columns
4272 under org-mode.
4274 The general parameters :skip and :skipcols have already been applied when
4275 this function is called."
4276 (let* ((total (float (apply '+ org-table-last-column-widths)))
4277 (colfrac (or (plist-get params :cf)
4278 (mapconcat
4279 (lambda (x) (format "%.3f" (/ (float x) total)))
4280 org-table-last-column-widths " ")))
4281 (params2
4282 (list
4283 :tstart (concat "@multitable @columnfractions " colfrac)
4284 :tend "@end multitable"
4285 :lstart "@item " :lend "" :sep " @tab "
4286 :hlstart "@headitem ")))
4287 (orgtbl-to-generic table (org-combine-plists params2 params))))
4289 (defun orgtbl-to-orgtbl (table params)
4290 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4291 Useful when slicing one table into many. The :hline, :sep,
4292 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4293 and :tend suppress strings without splicing; they can be set to
4294 provide ORGTBL directives for the generated table."
4295 (let* ((params2
4296 (list
4297 :tstart nil :tend nil
4298 :hline "|---"
4299 :sep " | "
4300 :lstart "| "
4301 :lend " |"))
4302 (params (org-combine-plists params2 params)))
4303 (orgtbl-to-generic table params)))
4305 (defun org-table-get-remote-range (name-or-id form)
4306 "Get a field value or a list of values in a range from table at ID.
4308 NAME-OR-ID may be the name of a table in the current file as set by
4310 will then be used. Alternatively, it may be an ID referring to
4311 any entry, also in a different file. In this case, the first table
4312 in that entry will be referenced.
4316 The return value is either a single string for a single field, or a
4317 list of the fields in the rectangle ."
4318 (save-match-data
4319 (let ((id-loc nil)
4320 org-table-column-names org-table-column-name-regexp
4321 org-table-local-parameters org-table-named-field-locations
4322 org-table-current-line-types org-table-current-begin-line
4323 org-table-current-begin-pos org-table-dlines
4324 org-table-hlines org-table-last-alignment
4325 org-table-last-column-widths org-table-last-alignment
4326 org-table-last-column-widths tbeg
4327 buffer loc)
4328 (setq form (org-table-convert-refs-to-rc form))
4329 (save-excursion
4330 (save-restriction
4331 (widen)
4332 (save-excursion
4333 (goto-char (point-min))
4334 (if (re-search-forward
4336 nil t)
4337 (setq buffer (current-buffer) loc (match-beginning 0))
4338 (setq id-loc (org-id-find name-or-id 'marker))
4339 (unless (and id-loc (markerp id-loc))
4341 (setq buffer (marker-buffer id-loc)
4342 loc (marker-position id-loc))
4343 (move-marker id-loc nil)))
4344 (with-current-buffer buffer
4345 (save-excursion
4346 (save-restriction
4347 (widen)
4348 (goto-char loc)
4349 (forward-char 1)
4351 (not (match-beginning 1)))
4352 (error "Cannot find a table at NAME or ID %s" name-or-id))
4353 (setq tbeg (point-at-bol))
4354 (org-table-get-specials)
4355 (setq form (org-table-formula-substitute-names form))
4356 (if (and (string-match org-table-range-regexp form)
4357 (> (length (match-string 0 form)) 1))
4358 (save-match-data
4359 (org-table-get-range (match-string 0 form) tbeg 1))
4360 form)))))))))
4362 (provide 'org-table)
4364 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4366 ;;; org-table.el ends here