| blob | addc740b475b68bd6226c41db227364b40318942 |
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.36c
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 falign falign1 fmax f1 len c e)
635 ;; Check if we have links or dates
644 ;; Make sure the link properties are right
646 ;; Make sure the date properties are right
650 ;; Check if we are narrowing any columns
653 org-format-transports-properties-p
658 ;; Get the rows
661 ;; Store the indentation of the first line
664 ;; Mark the hlines by setting the corresponding element to nil
665 ;; At the same time, we remove trailing space.
668 nil
671 l)))
672 lines))
673 ;; Get the data fields by splitting the lines.
678 ;; How many fields in the longest line?
685 ;; A list of empty strings to fill any short rows on output
687 ;; Check for special formatting.
691 ;; Check if there is an explicit width specified
701 ;; Find fields that are wider than fmax, and shorten them
707 'help-echo
708 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
716 xx)))))
717 ;; Get the maximum width for each column
719 lengths)
720 ;; Get the fraction of numbers, to decide about alignment of the column
726 nil
733 ;; Store the alignment of this table, for later editing of single fields
735 org-table-last-column-widths lengths)
737 ;; With invisible characters, `format' does not get the field width right
738 ;; So we need to make these fields wide by hand.
746 ; (string-match org-bracket-link-regexp (car c))
750 ;; Compute the formats needed for output of the table
763 hfmt))
766 ;; This hack is for org-indent, to force redisplay of the
767 ;; line prefix of the first line. Apparently the redisplay
768 ;; is tied to the newline, which is, I think, a bug.
769 ;; To force this redisplay, we remove and re-insert the
770 ;; newline, so that the redisplay engine thinks it belongs
771 ;; to the changed text.
777 ;; Replace the old one
784 ;; Try to move to the old location
792 ))
795 "Find the beginning of the table and return its position.
796 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
800 org-table-border-regexp)
801 nil t))
808 "Find the end of the table and return its position.
809 With argument TABLE-TYPE, go to the end of a table.el-type table."
813 org-table-border-regexp)
814 nil t))
820 "Justify the current field, text to left, number to right.
821 Optional argument NEW may specify text to replace the current field content."
830 ;; This is not the same table, force a full re-align
836 l f n o e)
860 "Go to the next field in the current table, creating new lines as needed.
861 Before doing so, re-align the table if necessary."
866 org-table-may-need-update)
877 org-table-tab-jumps-over-hlines
889 "Go to the previous field in the table.
890 Before doing so, re-align the table if necessary."
895 org-table-may-need-update)
910 "Move to the end of the current table field.
911 If already at or after the end, move to the end of the next table field.
912 With numeric argument N, move N-1 fields forward first."
925 "Move to the beginning of the current table field.
926 If already at or before the beginning, move to the beginning of the
927 previous field.
928 With numeric argument N, move N-1 fields backward first."
942 "Go to the next row (same column) in the current table.
943 Before doing so, re-align the table if necessary."
951 org-table-may-need-update)
965 "Copy a field down in the current column.
966 If the field at the cursor is empty, copy into it the content of the nearest
967 non-empty field above. With argument N, use the Nth non-empty field.
968 If the current field is not empty, it is copied down to the next row, and
969 the cursor is moved with it. Therefore, repeating this command causes the
970 column to be filled row-by-row.
971 If the variable `org-table-copy-increment' is non-nil and the field is an
972 integer or a timestamp, it will be incremented while copying. In the case of
973 a timestamp, if the cursor is on the year, change the year. If it is on the
974 month or the day, change that. Point will stay on the current date field
975 in order to easily repeat the interval."
983 txt)
995 beg t))
1018 "Is point inside a table data field?
1019 I.e. not on a hline or before the first or after the last column?
1020 This actually throws an error, so it aborts the current command."
1031 "Get the field in table line LINE, column COLUMN.
1032 If LINE is larger than the number of data lines in the table, the function
1033 returns nil. However, if COLUMN is too large, we will simply return an
1034 empty string.
1035 If LINE is nil, use the current line.
1036 If column is nil, use the current column."
1043 "Put VALUE into line LINE, column COLUMN.
1044 When ALIGN is set, als realign the table."
1053 "Return the index of the current data line."
1060 cnt))
1063 "Go to the Nth data line in the current table.
1064 Return t when the line exists, nil if it does not exist."
1072 "Blank the current table field or active region."
1089 "Return the value of the field in column N of current row.
1090 N defaults to current field.
1091 If REPLACE is a string, replace field with this value. The return value
1092 is always the old value."
1102 val)
1106 "Show info about the current field, and highlight any reference at point."
1114 org-table-named-field-locations)))
1127 dline col
1129 dline col ref1
1131 ;; FIXME: formula info not correct if special table line
1141 "Find out which column we are in."
1147 cnt)))
1150 "Find out what table data line we are in.
1151 Only datalines count for this."
1161 cnt)))
1164 "Move the cursor to the Nth column in the current table line.
1165 With optional argument ON-DELIM, stop with point before the left delimiter
1166 of the field.
1167 If there are less than N fields, just go to after the last delimiter.
1168 However, when FORCE is non-nil, create new columns if necessary."
1178 t)))))
1186 "Insert a new column into the table."
1194 ;; Current cursor position
1200 nil
1212 "Find a dataline in the current table, which is needed for column commands."
1215 t
1226 t
1231 "Delete a column from the table."
1240 ;; Current cursor position
1246 nil
1261 "Move column to the right."
1265 "Move column to the left."
1270 "Move the current column to the right. With arg LEFT, move to the left."
1280 ;; Current cursor position
1290 nil
1307 "Move table row down."
1311 "Move table row up."
1316 "Move the current table line down. With arg UP, move it up."
1325 txt hline2p)
1346 "Insert a new row above the current line into the table.
1347 With prefix ARG, insert below the current line."
1353 ;; Fix the first field if necessary
1365 "Insert a horizontal-line below the current line into the table.
1366 With prefix ABOVE, insert above the current line."
1388 "Insert a hline and move to the row below that line."
1402 In particular, this does handle wide and invisible characters."
1404 ;; It's a hline, just map the characters
1410 t t s)))
1411 s))
1414 "Delete the current row or horizontal line from the table."
1427 "Sort table lines according to the column at point.
1429 The position of point indicates the column to be used for
1430 sorting, and the range of lines is the range between the nearest
1431 horizontal separator lines, or the entire table of no such lines
1432 exist. If point is before the first column, you will be prompted
1433 for the sorting column. If there is an active region, the mark
1434 specifies the first line and the sorting column, while point
1435 should be in the last line to be included into the sorting.
1437 The command then prompts for the sorting type which can be
1438 alphabetically, numerically, or by time (as given in a time stamp
1439 in the field). Sorting in reverse order is also possible.
1441 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1443 If SORTING-TYPE is specified when this function is called from a Lisp
1444 program, no prompting will take place. SORTING-TYPE must be a character,
1445 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1446 should be done in reverse order."
1450 beg end bcol ecol tend tbeg column lns pos)
1495 x))
1508 "Copy region in table to the clipboard and blank all relevant fields.
1509 If there is no active region, use just the field at point."
1516 "Copy rectangular region in table to clipboard.
1517 A special clipboard is used which can only be accessed
1518 with `org-table-paste-rectangle'."
1522 current-prefix-arg))
1524 region cols
1550 org-table-clip))
1553 "Paste a rectangular region into a table.
1554 The upper right corner ends up in the current field. All involved fields
1555 will be overwritten. If the rectangle does not fit into the present table,
1556 the table is enlarged as needed. The process ignores horizontal separator
1557 lines."
1567 c cols field)
1583 "Convert from `org-mode' table to table.el and back.
1584 Obviously, this only works within limits. When an Org-mode table is
1585 converted to table.el, all horizontal separator lines get lost, because
1586 table.el uses these as cell boundaries and has no notion of horizontal lines.
1587 A table.el table can be converted to an Org-mode table only if it does not
1588 do row or column spanning. Multiline cells will become multiple cells.
1589 Beware, Org-mode does not test if the table can be successfully converted - it
1590 blindly applies a recipe that works for simple tables."
1594 ;; convert to Org-mode table
1603 ;; convert to table.el table
1606 ;; first, get rid of all horizontal lines
1610 ;; insert a hline before first
1614 ;; insert a hline after each line
1619 ;; replace "+" at beginning and ending of hlines
1628 "Wrap several fields in a column like a paragraph.
1629 This is useful if you'd like to spread the contents of a field over several
1630 lines, in order to keep the table compact.
1632 If there is an active region, and both point and mark are in the same column,
1633 the text in the column is wrapped to minimum width for the given number of
1634 lines. Generally, this makes the table more compact. A prefix ARG may be
1636 formats the selected text to two lines. If the region was longer than two
1637 lines, the remaining lines remain empty. A negative prefix argument reduces
1638 the current number of lines by that amount. The wrapped text is pasted back
1639 into the table. If you formatted it to more lines than it was before, fields
1640 further down in the table get overwritten - so you might need to make space in
1641 the table first.
1643 If there is no region, the current field is split at the cursor position and
1644 the text fragment to the right of the cursor is prepended to the field one
1645 line down.
1647 If there is no region, but you specify a prefix ARG, the current field gets
1648 blank, and the content is appended to the field above."
1652 ;; There is a region: fill as a paragraph
1656 nlines)
1663 arg)
1667 nil nlines)))
1671 ;; No region, split the current field at point
1675 ;; combine with field above
1685 ;; split field
1698 "Edit table field in a different window.
1699 This is mainly useful for fields that contain hidden parts.
1701 it can be edited in place."
1707 display t intangible t))
1713 p)
1722 intangible t))
1730 "Finish editing a table data field.
1731 Remove all newline characters, insert the result into the table, realign
1732 the table and kill the editing buffer."
1736 text)
1755 "Sum numbers in region of current table column.
1756 The result will be displayed in the echo area, and will be available
1759 If there is an active region, it is interpreted as a rectangle and all
1760 numbers in that rectangle will be summed. If there is no active
1761 region and point is located in a table column, sum all numbers in that
1762 column.
1764 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1765 numbers are assumed to be times as well (in decimal hours) and the
1766 numbers are added as such.
1768 If NLAST is a number, only the NLAST fields will actually be summed."
1795 items1)))
1802 s diff)
1810 sres))))
1833 "Return the formula active for the current field.
1834 Assumes that specials are in place.
1835 If KEY is given, return the key to this formula.
1839 org-table-named-field-locations)))
1853 "Read a formula from the minibuffer, offer stored formula as default.
1854 When NAMED is non-nil, look for a named equation."
1858 org-table-named-field-locations)))
1865 name
1866 ref)
1876 stored)
1878 equation)
1885 scol))
1887 'org-table-formula-history
1888 )))))
1889 mustsave)
1891 ;; remove formula
1898 ;; We set the column equation, delete the named one.
1900 mustsave t))
1906 eq))
1909 "Store the list of formulas below the current table."
1915 ;; don't overwrite TBLFM, we might use text properties to store stuff
1936 "Compare two formulas for sorting."
1942 "Return an alist with the stored formulas directly after current table."
1950 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1967 "Modify the equations after the table structure has been edited.
1969 For all numbers larger than LIMIT, shift them by DELTA."
1980 s n a)
1993 t t)))))))))
1996 "Get the column names and local parameters for this table."
1999 names name fields fields1 field cnt
2000 c v l line col types dlines hlines last-dline)
2002 org-table-local-parameters nil
2003 org-table-named-field-locations nil
2004 org-table-current-begin-line nil
2005 org-table-current-begin-pos nil
2006 org-table-current-line-types nil)
2024 org-table-local-parameters))))
2040 ;; Analyse the line types
2044 l org-table-current-begin-line)
2061 al al2)
2073 If yes, store the formula and apply it."
2074 ;; We already know we are in a table. Get field will only return a formula
2075 ;; when appropriate. It might return a separator line, but no problem.
2078 named eq)
2089 "List of commands triggering the recalculation of a line.
2102 "Rotate the recalculation mark in the first column.
2103 If in any row, the first field is not consistent with a mark,
2104 insert a new column for the markers.
2105 When there is an active region, change all the lines in the region,
2106 after prompting for the marking character.
2107 After each change, a message will be displayed indicating the meaning
2108 of the new mark."
2123 epos new)
2130 newchar))
2162 "Recompute the current line if marked for it, and if we haven't just done it."
2182 modes)
2185 suppress-align suppress-const
2186 suppress-store suppress-analysis)
2187 "Replace the table field value at the cursor by the result of a calculation.
2189 This function makes use of Dave Gillespie's Calc package, in my view the
2190 most exciting program ever written for GNU Emacs. So you need to have Calc
2191 installed in order to use this function.
2193 In a table, this command replaces the value in the current field with the
2195 formula, by storing it in a special line below the table. When called
2196 with a `C-u' prefix, the current field must be a named field, and the
2197 formula is installed as valid in only this specific field.
2199 When called with two `C-u' prefixes, insert the active equation
2200 for the field back into the current field, so that it can be
2202 to check the referenced fields.
2204 When called, the command first prompts for a formula, which is read in
2205 the minibuffer. Previously entered formulas are available through the
2206 history list, and the last used formula is offered as a default.
2207 These stored formulas are adapted correctly when moving, inserting, or
2208 deleting columns with the corresponding commands.
2210 The formula can be any algebraic expression understood by the Calc package.
2211 For details, see the Org-mode manual.
2213 This function can also be called from Lisp programs and offers
2214 additional arguments: EQUATION can be the formula to apply. If this
2215 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2216 used to speed-up recursive calls by by-passing unnecessary aligns.
2217 SUPPRESS-CONST suppresses the interpretation of constants in the
2218 formula, assuming that this has been done already outside the function.
2219 SUPPRESS-STORE means the formula should not be stored, either because
2220 it is already stored, or because it is a modified equation that should
2221 not overwrite the stored one."
2237 equation
2243 n form form0 bw fmt x ev orig c lispp literal)
2244 ;; Parse the format string. Since we have a lot of modes, this is
2245 ;; a lot of work. However, I think calc still uses most of the time.
2257 'calc-float-format
2260 n))))
2287 fields)))
2293 ;; Insert row and column number of formula result field
2304 t t form)))
2306 ;; Check for old vertical references
2308 ;; Insert remote references
2316 keep-empty numbers lispp))
2317 t t form)))
2318 ;; Insert complex ranges
2326 keep-empty numbers lispp))
2327 t t form)))
2328 ;; Insert simple ranges
2337 keep-empty numbers lispp))
2338 t t form)))
2340 ;; Insert the references to fields in same row
2349 t t form)))
2364 Orig: %s
2365 $xyz-> %s
2366 @r$c-> %s
2397 prop value)))
2400 "Get a calc vector from a column, according to descriptor DESC.
2401 Optional arguments TBEG and COL can give the beginning of the table and
2402 the current column, to avoid unnecessary parsing.
2403 HIGHLIGHT means just highlight the range."
2410 beg end c1 c2 r1 r2 rangep tmp)
2427 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2433 ;; just one field
2440 ;; A range, return a vector
2441 ;; First sort the numbers to get a regular ractangle
2457 ;; return string representation of calc vector
2462 "Analyze descriptor DESC and retrieve the corresponding line number.
2463 The cursor is currently in line CLINE, the table begins in line BLINE,
2464 and TABLE is a vector with line types."
2472 ;; 1 2 3 4 5 6
2492 nil hn cline desc)))
2495 rel on cline desc)))
2499 "FIXME: Needs more documentation."
2512 nil))
2513 t)))
2517 desc cline)
2518 i)))
2523 s))
2526 "Convert list ELEMENTS to something appropriate to insert into formula.
2527 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2528 NUMBERS indicates that everything should be converted to numbers.
2529 LISPP means to return something appropriate for a Lisp list."
2533 elements
2542 elements))))
2548 x
2554 elements
2558 "Recalculate the current table line by applying all stored formulas.
2559 With prefix arg ALL, do this for all lines in the table.
2560 With the prefix argument ALL is `(16)' (a double `C-c C-u' prefix), or if
2561 it is the symbol `iterate', recompute the table until it no longer changes.
2562 If NOALIGN is not nil, do not re-align the table after the computations
2563 are done. This is typically used internally to save time, if it is
2564 known that the table will be realigned a little later anyway."
2579 ;; Insert constants in all formulas
2583 x)
2584 eqlist))
2585 ;; Split the equation list
2596 ;; This is a table with marked lines, compute selected lines
2598 ;; Move forward to the first non-header line
2609 ;; First find the named fields, and mark them untouchable
2621 name)))
2630 ;; Now evaluate the column formulas, but skip fields covered by
2631 ;; field formulas
2635 ;; Unprotected line, recalculate
2647 ;; Now evaluate the field formulas
2661 ;; back to initial position
2669 "Recalculate the table until it does not change anymore."
2674 thistbl)
2689 "Recalculate all tables in the current buffer."
2697 "Iterate all tables in the buffer, to converge inter-table dependencies."
2702 c1
2719 "Replace $const with values in string F."
2721 ;; First, check for column names
2726 ;; Parameters and constants
2728 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2738 f))
2741 "Find the value for a parameter or constant in a formula.
2742 Parameters get priority."
2772 map))
2779 "--"
2782 "--"
2783 "Shift Reference at Point"
2788 "-"
2789 "Change Test Row for Column Formulas"
2792 "--"
2797 org-table-overlay-coordinates)]
2798 "--"
2805 "Edit the formulas of the current table in a separate buffer."
2821 entry s type title)
2824 ;; Keep global-font-lock-mode from turning on font-lock-mode
2864 "Convert a formula from internal to user representation."
2867 s))
2870 "Convert a formula from user to internal representation."
2873 s))
2876 "Convert spreadsheet references from AB7 to @7$28.
2877 Works for single references, but also for entire formulas and even the
2878 full TBLFM line."
2880 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2883 ;; format match, just advance
2888 ;; 3.e5 or something like this.
2891 ;; (member (match-string 1 s)
2892 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2893 )
2894 ;; function name, just advance
2904 t t s)))))
2905 s))
2908 "Convert spreadsheet references from to @7$28 to AB7.
2909 Works for single references, but also for entire formulas and even the
2910 full TBLFM line."
2917 t t s)))
2922 t nil s)))
2923 s)
2926 "Convert a base 26 number represented by letters into an integer.
2927 For example: AB -> 28."
2933 n))
2936 "Convert an integer into a base 26 number represented by letters.
2937 For example: 28 -> AB."
2942 s))
2945 "Convert all references in this buffer, using FUNCTION."
2955 "Convert all references in the buffer from B3 to @3$2 and back."
2965 "Shift the reference at point one row/hline up."
2969 "Shift the reference at point one row/hline down."
2973 "Shift the reference at point one field to the left."
2977 "Shift the reference at point one field to the right."
2988 ;; A B3-like reference
2994 ;; An internal reference
3000 "Re-match the group N, and replace it with the shifted refrence."
3005 t t)))
3008 "Shift a refrence part REF.
3009 If DECR is set, decrease the references row/column, else increase.
3010 If HLINE is set, this may be a hline reference, it certainly is not
3011 a translation reference."
3040 "Toggle the display of coordinates in the referenced table."
3049 "Parse the buffer for formula definitions and install them.
3050 With prefix ARG, apply the new formulas to the table."
3061 nil t)
3085 "Abort editing formulas, without installing the changes."
3096 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3137 "Show the location/value of the $ expression at point."
3146 var name e what match dest)
3228 ;; column number
3256 org-table-fedit-scroll-down))))
3267 "Make sure the cursor is in a dataline in a table."
3276 p1 p2)))
3281 "Move cursor one line up in the window showing the table."
3286 "Move cursor one line down in the window showing the table."
3291 "Move the cursor in the window showing the table.
3292 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3317 "Add a new overlay."
3323 "Highlight rectangular region in a table."
3327 l1 c1 l2 c2 tmp)
3351 "Remove the rectangle overlays."
3362 "Add overlays to the table at point, to show row/column coordinates."
3391 "Toggle the display of Row/Column numbers in tables."
3403 "Toggle the formula debugger in tables."
3409 ;;; The orgtbl minor mode
3411 ;; Define a minor mode which can be used in other modes in order to
3412 ;; integrate the org-mode table editor.
3414 ;; This is really a hack, because the org-mode table editor uses several
3415 ;; keys which normally belong to the major mode, for example the TAB and
3416 ;; RET keys. Here is how it works: The minor mode defines all the keys
3417 ;; necessary to operate the table editor, but wraps the commands into a
3418 ;; function which tests if the cursor is currently inside a table. If that
3419 ;; is the case, the table editor command is executed. However, when any of
3420 ;; those keys is used outside a table, the function uses `key-binding' to
3421 ;; look up if the key has an associated command in another currently active
3422 ;; keymap (minor modes, major mode, global), and executes that command.
3423 ;; There might be problems if any of the keys used by the table editor is
3424 ;; otherwise used as a prefix key.
3426 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3427 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3428 ;; addresses this by checking explicitly for both bindings.
3430 ;; The optimized version (see variable `orgtbl-optimized') takes over
3431 ;; all keys which are bound to `self-insert-command' in the *global map*.
3432 ;; Some modes bind other commands to simple characters, for example
3433 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3434 ;; active, this binding is ignored inside tables and replaced with a
3435 ;; modified self-insert.
3438 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
3445 ;;;###autoload
3447 "Unconditionally turn on `orgtbl-mode'."
3462 ;;;###autoload
3464 "The `org-mode' table editor as a minor mode for use in other modes."
3468 ;; Exit without error, in case some hook functions calls this
3469 ;; by accident in org-mode.
3476 ;; Make sure we are first in minor-mode-map-alist
3484 auto-fill-inhibit-regexp)
3488 auto-fill-inhibit-regexp)
3489 orgtbl-line-start-regexp))
3507 "Remove all properties related to narrow-column invisibility."
3519 ;; Install it as a minor mode.
3525 "Create a function for binding in the table minor mode.
3526 FUN is the command to call inside a table. N is used to create a unique
3527 command name. KEYS are keys that should be checked in for a command
3528 to execute outside of tables."
3534 "Outside of tables, run the binding of `"
3546 keys)
3550 "Error when there is no default binding for a table key."
3555 "Setup orgtbl keymaps."
3586 elt key fun cmd)
3594 ;; Special treatment needed for TAB and RET
3614 [(tab)] "\C-i")))
3616 (org-defkey orgtbl-mode-map [backtab]
3618 [backtab] [S-iso-lefttab] [(shift tab)]
3619 [(tab)] "\C-i"))
3621 (org-defkey orgtbl-mode-map "\M-\C-m"
3622 (orgtbl-make-binding 'org-table-wrap-region 105
3623 "\M-\C-m" [(meta return)]))
3624 (org-defkey orgtbl-mode-map [(meta return)]
3625 (orgtbl-make-binding 'org-table-wrap-region 106
3626 [(meta return)] "\M-\C-m"))
3628 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3629 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3631 (when orgtbl-optimized
3632 ;; If the user wants maximum table support, we need to hijack
3633 ;; some standard editing functions
3634 (org-remap orgtbl-mode-map
3635 'self-insert-command 'orgtbl-self-insert-command
3636 'delete-char 'org-delete-char
3637 'delete-backward-char 'org-delete-backward-char)
3638 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3639 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3640 '("OrgTbl"
3641 ["Create or convert" org-table-create-or-convert-from-region
3642 :active (not (org-at-table-p)) :keys "C-c |" ]
3643 "--"
3644 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3645 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3646 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3647 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3648 "--"
3649 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3650 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3651 ["Copy Field from Above"
3652 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3653 "--"
3654 ("Column"
3655 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3656 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3657 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3658 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3659 ("Row"
3660 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3661 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3662 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3663 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3664 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3665 "--"
3666 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3667 ("Rectangle"
3668 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3669 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3670 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3671 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3672 "--"
3673 ("Radio tables"
3674 ["Insert table template" orgtbl-insert-radio-table
3675 (assq major-mode orgtbl-radio-table-templates)]
3676 ["Comment/uncomment table" orgtbl-toggle-comment t])
3677 "--"
3678 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3679 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3680 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3681 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3682 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3683 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3684 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3685 ["Sum Column/Rectangle" org-table-sum
3686 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3687 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3688 ["Debug Formulas"
3689 org-table-toggle-formula-debugger :active (org-at-table-p)
3690 :keys "C-c {"
3691 :style toggle :selected org-table-formula-debug]
3692 ["Show Col/Row Numbers"
3693 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3694 :keys "C-c }"
3695 :style toggle :selected org-table-overlay-coordinates]
3696 ))
3697 t))
3699 (defun orgtbl-ctrl-c-ctrl-c (arg)
3700 "If the cursor is inside a table, realign the table.
3701 If it is a table to be sent away to a receiver, do it.
3702 With prefix arg, also recompute table."
3703 (interactive "P")
3704 (let ((pos (point)) action)
3705 (save-excursion
3706 (beginning-of-line 1)
3710 (cond
3711 ((integerp action)
3712 (goto-char action)
3713 (org-table-maybe-eval-formula)
3714 (if arg
3715 (call-interactively 'org-table-recalculate)
3716 (org-table-maybe-recalculate-line))
3717 (call-interactively 'org-table-align)
3718 (orgtbl-send-table 'maybe))
3719 ((eq action 'recalc)
3720 (save-excursion
3721 (beginning-of-line 1)
3723 (if (org-at-table-p)
3724 (org-call-with-arg 'org-table-recalculate t))))
3725 (t (let (orgtbl-mode)
3726 (call-interactively (key-binding "\C-c\C-c")))))))
3728 (defun orgtbl-create-or-convert-from-region (arg)
3729 "Create table or convert region to table, if no conflicting binding.
3730 This installs the table binding `C-c |', but only if there is no
3731 conflicting binding to this key outside orgtbl-mode."
3732 (interactive "P")
3733 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3734 (if cmd
3735 (call-interactively cmd)
3736 (call-interactively 'org-table-create-or-convert-from-region))))
3738 (defun orgtbl-tab (arg)
3739 "Justification and field motion for `orgtbl-mode'."
3740 (interactive "P")
3741 (if arg (org-table-edit-field t)
3742 (org-table-justify-field-maybe)
3743 (org-table-next-field)))
3745 (defun orgtbl-ret ()
3746 "Justification and field motion for `orgtbl-mode'."
3747 (interactive)
3748 (if (bobp)
3749 (newline)
3750 (org-table-justify-field-maybe)
3751 (org-table-next-row)))
3753 (defun orgtbl-self-insert-command (N)
3754 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3755 If the cursor is in a table looking at whitespace, the whitespace is
3756 overwritten, and the table is not marked as requiring realignment."
3757 (interactive "p")
3758 (if (and (org-at-table-p)
3759 (or
3760 (and org-table-auto-blank-field
3761 (member last-command
3762 '(orgtbl-hijacker-command-100
3763 orgtbl-hijacker-command-101
3764 orgtbl-hijacker-command-102
3765 orgtbl-hijacker-command-103
3766 orgtbl-hijacker-command-104
3767 orgtbl-hijacker-command-105
3768 yas/expand))
3769 (org-table-blank-field))
3770 t)
3771 (eq N 1)
3773 (let (org-table-may-need-update)
3774 (goto-char (1- (match-end 0)))
3775 (delete-backward-char 1)
3776 (goto-char (match-beginning 0))
3777 (self-insert-command N))
3778 (setq org-table-may-need-update t)
3779 (let* (orgtbl-mode
3780 a
3781 (cmd (or (key-binding
3782 (or (and (listp function-key-map)
3783 (setq a (assoc last-input-event function-key-map))
3784 (cdr a))
3785 (vector last-input-event)))
3786 'self-insert-command)))
3787 (call-interactively cmd)
3788 (if (and org-self-insert-cluster-for-undo
3789 (eq cmd 'self-insert-command))
3790 (if (not (eq last-command 'orgtbl-self-insert-command))
3791 (setq org-self-insert-command-undo-counter 1)
3792 (if (>= org-self-insert-command-undo-counter 20)
3793 (setq org-self-insert-command-undo-counter 1)
3794 (and (> org-self-insert-command-undo-counter 0)
3795 buffer-undo-list
3796 (not (cadr buffer-undo-list)) ; remove nil entry
3797 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3798 (setq org-self-insert-command-undo-counter
3799 (1+ org-self-insert-command-undo-counter))))))))
3802 "Regular expression matching exponentials as produced by calc.")
3804 (defun orgtbl-export (table target)
3805 (require 'org-exp)
3806 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3808 org-table-last-alignment org-table-last-column-widths
3809 maxcol column)
3810 (if (not (fboundp func))
3811 (error "Cannot export orgtbl table to %s" target))
3812 (setq lines (org-table-clean-before-export lines))
3813 (setq table
3814 (mapcar
3815 (lambda (x)
3816 (if (string-match org-table-hline-regexp x)
3817 'hline
3819 lines))
3820 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3821 table)))
3822 (loop for i from (1- maxcol) downto 0 do
3823 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3824 (setq column (delq nil column))
3825 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3826 (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))
3827 (funcall func table nil)))
3829 (defun orgtbl-gather-send-defs ()
3830 "Gathers a plist of :name, :transform, :params for each destination before
3831 a radio table."
3832 (save-excursion
3833 (goto-char (org-table-begin))
3834 (let (rtn)
3835 (beginning-of-line 0)
3836 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3837 (let ((name (org-no-properties (match-string 1)))
3838 (transform (intern (match-string 2)))
3839 (params (if (match-end 3)
3840 (read (concat "(" (match-string 3) ")")))))
3841 (push (list :name name :transform transform :params params)
3842 rtn)
3843 (beginning-of-line 0)))
3844 rtn)))
3846 (defun orgtbl-send-replace-tbl (name txt)
3847 "Find and replace table NAME with TXT."
3848 (save-excursion
3849 (goto-char (point-min))
3850 (unless (re-search-forward
3852 (error "Don't know where to insert translated table"))
3853 (goto-char (match-beginning 0))
3854 (beginning-of-line 2)
3855 (save-excursion
3856 (let ((beg (point)))
3857 (unless (re-search-forward
3858 (concat "END RECEIVE ORGTBL +" name) nil t)
3859 (error "Cannot find end of insertion region"))
3860 (beginning-of-line 1)
3861 (delete-region beg (point))))
3864 ;;;###autoload
3865 (defun org-table-to-lisp (&optional txt)
3866 "Convert the table at point to a Lisp structure.
3867 The structure will be a list. Each item is either the symbol `hline'
3868 for a horizontal separator line, or a list of field values as strings.
3869 The table is taken from the parameter TXT, or from the buffer at point."
3870 (unless txt
3871 (unless (org-at-table-p)
3872 (error "No table at point")))
3873 (let* ((txt (or txt
3874 (buffer-substring-no-properties (org-table-begin)
3875 (org-table-end))))
3878 (mapcar
3879 (lambda (x)
3880 (if (string-match org-table-hline-regexp x)
3881 'hline
3883 lines)))
3885 (defun orgtbl-send-table (&optional maybe)
3886 "Send a transformed version of this table to the receiver position.
3887 With argument MAYBE, fail quietly if no transformation is defined for
3888 this table."
3889 (interactive)
3890 (catch 'exit
3891 (unless (org-at-table-p) (error "Not at a table"))
3892 ;; when non-interactive, we assume align has just happened.
3893 (when (interactive-p) (org-table-align))
3894 (let ((dests (orgtbl-gather-send-defs))
3895 (txt (buffer-substring-no-properties (org-table-begin)
3896 (org-table-end)))
3897 (ntbl 0))
3898 (unless dests (if maybe (throw 'exit nil)
3899 (error "Don't know how to transform this table")))
3900 (dolist (dest dests)
3901 (let* ((name (plist-get dest :name))
3902 (transform (plist-get dest :transform))
3903 (params (plist-get dest :params))
3904 (skip (plist-get params :skip))
3905 (skipcols (plist-get params :skipcols))
3906 beg
3907 (lines (org-table-clean-before-export
3908 (nthcdr (or skip 0)
3910 (i0 (if org-table-clean-did-remove-column 2 1))
3911 (table (mapcar
3912 (lambda (x)
3913 (if (string-match org-table-hline-regexp x)
3914 'hline
3915 (org-remove-by-index
3917 skipcols i0)))
3918 lines))
3919 (fun (if (= i0 2) 'cdr 'identity))
3920 (org-table-last-alignment
3921 (org-remove-by-index (funcall fun org-table-last-alignment)
3922 skipcols i0))
3923 (org-table-last-column-widths
3924 (org-remove-by-index (funcall fun org-table-last-column-widths)
3925 skipcols i0))
3926 (txt (if (fboundp transform)
3927 (funcall transform table params)
3928 (error "No such transformation function %s" transform))))
3929 (orgtbl-send-replace-tbl name txt))
3930 (setq ntbl (1+ ntbl)))
3931 (message "Table converted and installed at %d receiver location%s"
3932 ntbl (if (> ntbl 1) "s" "")))))
3934 (defun org-remove-by-index (list indices &optional i0)
3935 "Remove the elements in LIST with indices in INDICES.
3936 First element has index 0, or I0 if given."
3937 (if (not indices)
3938 list
3939 (if (integerp indices) (setq indices (list indices)))
3940 (setq i0 (1- (or i0 0)))
3941 (delq :rm (mapcar (lambda (x)
3942 (setq i0 (1+ i0))
3943 (if (memq i0 indices) :rm x))
3944 list))))
3946 (defun orgtbl-toggle-comment ()
3947 "Comment or uncomment the orgtbl at point."
3948 (interactive)
3949 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3950 (re2 (concat "^" orgtbl-line-start-regexp))
3951 (commented (save-excursion (beginning-of-line 1)
3952 (cond ((looking-at re1) t)
3953 ((looking-at re2) nil)
3954 (t (error "Not at an org table")))))
3955 (re (if commented re1 re2))
3956 beg end)
3957 (save-excursion
3958 (beginning-of-line 1)
3959 (while (looking-at re) (beginning-of-line 0))
3960 (beginning-of-line 2)
3961 (setq beg (point))
3962 (while (looking-at re) (beginning-of-line 2))
3963 (setq end (point)))
3964 (comment-region beg end (if commented '(4) nil))))
3966 (defun orgtbl-insert-radio-table ()
3967 "Insert a radio table template appropriate for this major mode."
3968 (interactive)
3969 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3970 (txt (nth 1 e))
3971 name pos)
3972 (unless e (error "No radio table setup defined for %s" major-mode))
3973 (setq name (read-string "Table name: "))
3974 (while (string-match "%n" txt)
3975 (setq txt (replace-match name t t txt)))
3977 (setq pos (point))
3978 (insert txt)
3979 (goto-char pos)))
3981 ;; Dynamically bound input and output for table formatting.
3982 (defvar *orgtbl-table* nil
3983 "Carries the current table through formatting routines.")
3984 (defvar *orgtbl-rtn* nil
3985 "Formatting routines push the output lines here.")
3986 ;; Formatting parameters for the current table section.
3987 (defvar *orgtbl-hline* nil "Text used for horizontal lines")
3988 (defvar *orgtbl-sep* nil "Text used as a column separator")
3989 (defvar *orgtbl-default-fmt* nil "Default format for each entry")
3990 (defvar *orgtbl-fmt* nil "Format for each entry")
3991 (defvar *orgtbl-efmt* nil "Format for numbers")
3992 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt")
3993 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row")
3994 (defvar *orgtbl-lstart* nil "Text starting a row")
3995 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row")
3996 (defvar *orgtbl-lend* nil "Text ending a row")
3997 (defvar *orgtbl-llend* nil "Specializes lend for the last row")
3999 (defsubst orgtbl-get-fmt (fmt i)
4000 "Retrieve the format from FMT corresponding to the Ith column."
4001 (if (and (not (functionp fmt)) (consp fmt))
4002 (plist-get fmt i)
4003 fmt))
4005 (defsubst orgtbl-apply-fmt (fmt &rest args)
4006 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4007 (cond ((functionp fmt) (apply fmt args))
4008 (fmt (apply 'format fmt args))
4009 (args (car args))
4010 (t args)))
4012 (defsubst orgtbl-eval-str (str)
4013 "If STR is a function, evaluate it with no arguments."
4014 (if (functionp str)
4015 (funcall str)
4016 str))
4018 (defun orgtbl-format-line (line)
4019 "Format LINE as a table row."
4020 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4021 (let* ((i 0)
4022 (line
4023 (mapcar
4024 (lambda (f)
4025 (setq i (1+ i))
4026 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4027 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4028 (orgtbl-apply-fmt efmt (match-string 1 f)
4029 (match-string 2 f))
4030 f)))
4031 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4032 *orgtbl-default-fmt*)
4033 f)))
4034 line)))
4035 (push (if *orgtbl-lfmt*
4036 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4037 (concat (orgtbl-eval-str *orgtbl-lstart*)
4038 (mapconcat 'identity line *orgtbl-sep*)
4039 (orgtbl-eval-str *orgtbl-lend*)))
4040 *orgtbl-rtn*))))
4042 (defun orgtbl-format-section (section-stopper)
4043 "Format lines until the first occurrence of SECTION-STOPPER."
4044 (let (prevline)
4045 (progn
4046 (while (not (eq (car *orgtbl-table*) section-stopper))
4047 (if prevline (orgtbl-format-line prevline))
4048 (setq prevline (pop *orgtbl-table*)))
4049 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4050 (*orgtbl-lend* *orgtbl-llend*)
4051 (*orgtbl-lfmt* *orgtbl-llfmt*))
4052 (orgtbl-format-line prevline))))))
4054 (defun orgtbl-to-generic (table params)
4055 "Convert the orgtbl-mode TABLE to some other format.
4056 This generic routine can be used for many standard cases.
4057 TABLE is a list, each entry either the symbol `hline' for a horizontal
4058 separator line, or a list of fields for that line.
4059 PARAMS is a property list of parameters that can influence the conversion.
4060 For the generic converter, some parameters are obligatory: You need to
4061 specify either :lfmt, or all of (:lstart :lend :sep).
4063 Valid parameters are
4065 :splice When set to t, return only table body lines, don't wrap
4066 them into :tstart and :tend. Default is nil. When :splice
4067 is non-nil, this also means that the exporter should not look
4068 for and interpret header and footer sections.
4070 :hline String to be inserted on horizontal separation lines.
4071 May be nil to ignore hlines.
4073 :sep Separator between two fields
4074 :remove-nil-lines Do not include lines that evaluate to nil.
4077 Each in the following group may be either a string or a function
4078 of no arguments returning a string:
4079 :tstart String to start the table. Ignored when :splice is t.
4080 :tend String to end the table. Ignored when :splice is t.
4081 :lstart String to start a new table line.
4082 :llstart String to start the last table line, defaults to :lstart.
4083 :lend String to end a table line
4084 :llend String to end the last table line, defaults to :lend.
4086 Each in the following group may be a string, a function of one
4087 argument (the field or line) returning a string, or a plist
4088 mapping columns to either of the above:
4089 :lfmt Format for entire line, with enough %s to capture all fields.
4090 If this is present, :lstart, :lend, and :sep are ignored.
4091 :llfmt Format for the entire last line, defaults to :lfmt.
4092 :fmt A format to be used to wrap the field, should contain
4093 %s for the original field value. For example, to wrap
4095 This may also be a property list with column numbers and
4098 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4099 Same as above, specific for the header lines in the table.
4100 All lines before the first hline are treated as header.
4101 If any of these is not present, the data line value is used.
4103 This may be either a string or a function of two arguments:
4104 :efmt Use this format to print numbers with exponentials.
4105 The format should have %s twice for inserting mantissa
4107 may also be a property list with column numbers and
4108 formats. :fmt will still be applied after :efmt.
4110 In addition to this, the parameters :skip and :skipcols are always handled
4111 directly by `orgtbl-send-table'. See manual."
4112 (interactive)
4114 (let* ((splicep (plist-get params :splice))
4115 (hline (plist-get params :hline))
4116 (remove-nil-linesp (plist-get params :remove-nil-lines))
4117 (*orgtbl-hline* hline)
4118 (*orgtbl-table* table)
4119 (*orgtbl-sep* (plist-get params :sep))
4120 (*orgtbl-efmt* (plist-get params :efmt))
4121 (*orgtbl-lstart* (plist-get params :lstart))
4122 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4123 (*orgtbl-lend* (plist-get params :lend))
4124 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4125 (*orgtbl-lfmt* (plist-get params :lfmt))
4126 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4127 (*orgtbl-fmt* (plist-get params :fmt))
4128 *orgtbl-rtn*)
4130 ;; Put header
4131 (unless splicep
4132 (when (plist-member params :tstart)
4133 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4134 (if tstart (push tstart *orgtbl-rtn*)))))
4136 ;; Do we have a heading section? If so, format it and handle the
4137 ;; trailing hline.
4138 (if (and (not splicep)
4139 (or (consp (car *orgtbl-table*))
4140 (consp (nth 1 *orgtbl-table*)))
4141 (memq 'hline (cdr *orgtbl-table*)))
4142 (progn
4143 (when (eq 'hline (car *orgtbl-table*))
4144 ;; there is a hline before the first data line
4145 (and hline (push hline *orgtbl-rtn*))
4146 (pop *orgtbl-table*))
4147 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4148 *orgtbl-lstart*))
4149 (*orgtbl-llstart* (or (plist-get params :hllstart)
4150 *orgtbl-llstart*))
4151 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4152 (*orgtbl-llend* (or (plist-get params :hllend)
4153 (plist-get params :hlend) *orgtbl-llend*))
4154 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4155 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4156 (plist-get params :hlfmt) *orgtbl-llfmt*))
4157 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4158 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4159 (orgtbl-format-section 'hline))
4160 (if hline (push hline *orgtbl-rtn*))
4161 (pop *orgtbl-table*)))
4163 ;; Now format the main section.
4164 (orgtbl-format-section nil)
4166 (unless splicep
4167 (when (plist-member params :tend)
4168 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4169 (if tend (push tend *orgtbl-rtn*)))))
4171 (mapconcat 'identity (nreverse (if remove-nil-linesp
4172 (remq nil *orgtbl-rtn*)
4175 (defun orgtbl-to-tsv (table params)
4176 "Convert the orgtbl-mode table to TAB separated material."
4178 (defun orgtbl-to-csv (table params)
4179 "Convert the orgtbl-mode table to CSV material.
4180 This does take care of the proper quoting of fields with comma or quotes."
4181 (orgtbl-to-generic table (org-combine-plists
4182 '(:sep "," :fmt org-quote-csv-field)
4183 params)))
4185 (defun orgtbl-to-latex (table params)
4186 "Convert the orgtbl-mode TABLE to LaTeX.
4187 TABLE is a list, each entry either the symbol `hline' for a horizontal
4188 separator line, or a list of fields for that line.
4189 PARAMS is a property list of parameters that can influence the conversion.
4190 Supports all parameters from `orgtbl-to-generic'. Most important for
4191 LaTeX are:
4193 :splice When set to t, return only table body lines, don't wrap
4194 them into a tabular environment. Default is nil.
4196 :fmt A format to be used to wrap the field, should contain %s for the
4197 original field value. For example, to wrap everything in dollars,
4200 The format may also be a function that formats its one argument.
4202 :efmt Format for transforming numbers with exponentials. The format
4203 should have %s twice for inserting mantissa and exponent, for
4205 This may also be a property list with column numbers and formats.
4206 The format may also be a function that formats its two arguments.
4208 :llend If you find too much space below the last line of a table,
4211 The general parameters :skip and :skipcols have already been applied when
4212 this function is called."
4213 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4214 org-table-last-alignment ""))
4215 (params2
4216 (list
4221 (orgtbl-to-generic table (org-combine-plists params2 params))))
4223 (defun orgtbl-to-html (table params)
4224 "Convert the orgtbl-mode TABLE to LaTeX.
4225 TABLE is a list, each entry either the symbol `hline' for a horizontal
4226 separator line, or a list of fields for that line.
4227 PARAMS is a property list of parameters that can influence the conversion.
4228 Currently this function recognizes the following parameters:
4230 :splice When set to t, return only table body lines, don't wrap
4231 them into a <table> environment. Default is nil.
4233 The general parameters :skip and :skipcols have already been applied when
4234 this function is called. The function does *not* use `orgtbl-to-generic',
4235 so you cannot specify parameters for it."
4236 (let* ((splicep (plist-get params :splice))
4237 (html-table-tag org-export-html-table-tag)
4238 html)
4239 ;; Just call the formatter we already have
4240 ;; We need to make text lines for it, so put the fields back together.
4241 (setq html (org-format-org-table-html
4242 (mapcar
4243 (lambda (x)
4244 (if (eq x 'hline)
4245 "|----+----|"
4246 (concat "| " (mapconcat 'identity x " | ") " |")))
4247 table)
4248 splicep))
4250 (setq html (replace-match "" t t html)))
4251 html))
4253 (defun orgtbl-to-texinfo (table params)
4254 "Convert the orgtbl-mode TABLE to TeXInfo.
4255 TABLE is a list, each entry either the symbol `hline' for a horizontal
4256 separator line, or a list of fields for that line.
4257 PARAMS is a property list of parameters that can influence the conversion.
4258 Supports all parameters from `orgtbl-to-generic'. Most important for
4259 TeXInfo are:
4261 :splice nil/t When set to t, return only table body lines, don't wrap
4262 them into a multitable environment. Default is nil.
4264 :fmt fmt A format to be used to wrap the field, should contain
4265 %s for the original field value. For example, to wrap
4267 This may also be a property list with column numbers and
4269 Each format also may be a function that formats its one
4270 argument.
4273 are computed automatically from the width of the columns
4274 under org-mode.
4276 The general parameters :skip and :skipcols have already been applied when
4277 this function is called."
4278 (let* ((total (float (apply '+ org-table-last-column-widths)))
4279 (colfrac (or (plist-get params :cf)
4280 (mapconcat
4281 (lambda (x) (format "%.3f" (/ (float x) total)))
4282 org-table-last-column-widths " ")))
4283 (params2
4284 (list
4285 :tstart (concat "@multitable @columnfractions " colfrac)
4286 :tend "@end multitable"
4287 :lstart "@item " :lend "" :sep " @tab "
4288 :hlstart "@headitem ")))
4289 (orgtbl-to-generic table (org-combine-plists params2 params))))
4291 (defun orgtbl-to-orgtbl (table params)
4292 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4293 Useful when slicing one table into many. The :hline, :sep,
4294 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4295 and :tend suppress strings without splicing; they can be set to
4296 provide ORGTBL directives for the generated table."
4297 (let* ((params2
4298 (list
4299 :tstart nil :tend nil
4300 :hline "|---"
4301 :sep " | "
4302 :lstart "| "
4303 :lend " |"))
4304 (params (org-combine-plists params2 params)))
4305 (orgtbl-to-generic table params)))
4307 (defun org-table-get-remote-range (name-or-id form)
4308 "Get a field value or a list of values in a range from table at ID.
4310 NAME-OR-ID may be the name of a table in the current file as set by
4312 will then be used. Alternatively, it may be an ID referring to
4313 any entry, also in a different file. In this case, the first table
4314 in that entry will be referenced.
4318 The return value is either a single string for a single field, or a
4319 list of the fields in the rectangle ."
4320 (save-match-data
4321 (let ((id-loc nil)
4322 org-table-column-names org-table-column-name-regexp
4323 org-table-local-parameters org-table-named-field-locations
4324 org-table-current-line-types org-table-current-begin-line
4325 org-table-current-begin-pos org-table-dlines
4326 org-table-hlines org-table-last-alignment
4327 org-table-last-column-widths org-table-last-alignment
4328 org-table-last-column-widths tbeg
4329 buffer loc)
4330 (setq form (org-table-convert-refs-to-rc form))
4331 (save-excursion
4332 (save-restriction
4333 (widen)
4334 (save-excursion
4335 (goto-char (point-min))
4336 (if (re-search-forward
4338 nil t)
4339 (setq buffer (current-buffer) loc (match-beginning 0))
4340 (setq id-loc (org-id-find name-or-id 'marker))
4341 (unless (and id-loc (markerp id-loc))
4343 (setq buffer (marker-buffer id-loc)
4344 loc (marker-position id-loc))
4345 (move-marker id-loc nil)))
4346 (switch-to-buffer buffer)
4347 (save-excursion
4348 (save-restriction
4349 (widen)
4350 (goto-char loc)
4351 (forward-char 1)
4353 (not (match-beginning 1)))
4354 (error "Cannot find a table at NAME or ID %s" name-or-id))
4355 (setq tbeg (point-at-bol))
4356 (org-table-get-specials)
4357 (setq form (org-table-formula-substitute-names form))
4358 (if (and (string-match org-table-range-regexp form)
4359 (> (length (match-string 0 form)) 1))
4360 (save-match-data
4361 (org-table-get-range (match-string 0 form) tbeg 1))
4362 form))))))))
4364 (provide 'org-table)
4366 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4368 ;;; org-table.el ends here