| blob | 951bff706aa969e502f045547b5be4a3c7cf655d |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
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 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, othewise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
90 "Templates for radio tables in different major modes.
91 All occurrences of %n in a template will be replaced with the name of the
92 table, obtained by prompting the user."
99 "Settings for tables in Org-mode."
104 "The default size for newly created tables, Columns x Rows."
110 "Regular expression for recognizing numbers in table columns.
111 If a table column contains mostly numbers, it will be aligned to the
112 right. If not, it will be aligned to the left.
114 The default value of this option is a regular expression which allows
115 anything which looks remotely like a number as used in scientific
116 context. For example, all of the following will be considered a
117 number:
118 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
120 Other options offered by the customize interface are more restrictive."
138 "Fraction of numbers in a column required to make the column align right.
139 In a column all non-white fields are considered. If at least this
140 fraction of fields is matched by `org-table-number-fraction',
141 alignment to the right border applies."
146 "Behavior of tables during editing in Org-mode."
151 "Non-nil means automatically re-align table when pressing TAB or RETURN.
153 removal/insertion."
158 "Non-nil means automatically blank table field when starting to type into it.
159 This only happens when typing immediately after a field motion
160 command (TAB, S-TAB or RET).
161 Only relevant when `org-enable-table-editor' is equal to `optimized'."
166 "Non-nil means tab in the last column of a table with jump over a hline.
167 If a horizontal separator line is following the current line,
168 `org-table-next-field' can either create a new row before that line, or jump
169 over the line. When this option is nil, a new line will be created before
170 this line."
175 "Options concerning tables in Org-mode."
180 "Should org-mode work with table references like B3 instead of @3$2?
181 Possible values are:
182 nil never use them
183 from accept as input, do not present for editing
184 t: accept as input and present for editing"
199 calc-angle-mode deg
200 calc-prefer-frac nil
201 calc-symbolic-mode nil
203 calc-display-working-message t
204 )
205 "List with Calc mode settings for use in `calc-eval' for table formulas.
206 The list must contain alternating symbols (Calc modes variables and values).
207 Don't remove any of the default settings, just change the values. Org-mode
208 relies on the variables to be present in the list."
213 "Non-nil means TAB and RET evaluate a formula in current table field.
214 If the current field starts with an equal sign, it is assumed to be a formula
215 which should be evaluated as described in the manual and in the documentation
216 string of the command `org-table-eval-formula'. This feature requires the
217 Emacs calc package.
218 When this variable is nil, formula calculation is only available through
224 "Non-nil means interpret constants in formulas in tables.
225 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
226 by the value given in `org-table-formula-constants', or by a value obtained
227 from the `constants.el' package."
232 "Alist with constant names and values, for use in table formulas.
233 The car of each element is a name of a constant, without the `$' before it.
234 The cdr is the value as a string. For example, if you'd like to use the
235 speed of light in a formula, you would configure
239 and then use it in an equation like `$1*$c'.
241 Constants can also be defined on a per-file basis using a line like
243 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
250 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
251 Automatically means when TAB or RET or C-c C-c are pressed in the line."
256 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
261 "Non-nil means relative formula references may cross hlines.
262 Here are the allowed values:
264 nil Relative references may not cross hlines. They will reference the
265 field next to the hline instead. Coming from below, the reference
266 will be to the field below the hline. Coming from above, it will be
267 to the field above.
268 t Relative references may cross hlines.
269 error An attempt to cross a hline will throw an error.
271 It is probably good to never set this variable to nil, for the sake of
272 portability of tables."
280 "Options concerning table import and export in Org-mode."
285 "Default export parameters for `org-table-export'.
286 These can be overridden for a specific table by setting the
287 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
288 radio tables for the different export transformations and
289 available parameters."
325 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
326 ;; 1 2 3 4 5
337 "Is this a table line colgroup information?"
341 line)
343 nil
350 "Is this a table line with only alignment/width cookies?"
363 s))))
372 "Use the table.el package to insert a new table.
373 If there is already a table at point, convert between Org-mode tables
374 and table.el tables."
388 "Convert region to table, or create an empty table.
389 If there is an active region, convert it to a table, using the function
390 `org-table-convert-region'. See the documentation of that function
391 to learn how the prefix argument is interpreted to determine the field
392 separator.
393 If there is no such region, create an empty table with `org-table-create'."
400 "Query for a size and insert a table skeleton.
420 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
424 ;; Insert a hline after the first row.
432 "Convert region to a table.
433 The region goes from BEG0 to END0, but these borders will be moved
434 slightly, to make sure a beginning of line in the first line is included.
436 SEPARATOR specifies the field separator in the lines. It can have the
437 following values:
439 '(4) Use the comma as a field separator
440 '(16) Use a TAB as field separator
441 integer When a number, use that many spaces as field separator
442 nil When nil, the command tries to be smart and figure out the
443 separator in the following way:
444 - when each line contains a TAB, assume TAB-separated material
445 - when each line contains a comma, assume CSV material
446 - else, assume one or more SPACE characters as separator."
450 re)
457 ;; Get the right field separator
468 ;; parse the csv stuff
490 "Import FILE as a table.
491 The file is assumed to be tab-separated. Such files can be produced by most
492 spreadsheet and database applications. If no tabs (at least one per line)
493 are found, lines will be split on whitespace into fields."
505 "Export table to a file, with configurable format.
506 Such a file can be imported into a spreadsheet program like Excel.
507 FILE can be the output file name. If not given, it will be taken from
508 a TABLE_EXPORT_FILE property in the current entry or higher up in the
509 hierarchy, or the user will be prompted for a file name.
510 FORMAT can be an export format, of the same kind as it used when
511 `orgtbl-mode' sends a table in a different format. The default format can
512 be found in the variable `org-table-export-default-format', but the function
513 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
514 property, locally or anywhere up in the hierarchy."
531 buf deffmt-readable)
550 "Format: "
555 deffmt-readable)))
568 'hline
571 skipcols i0)))
572 lines))
576 skipcols i0))
579 skipcols i0)))
596 "Marker at the beginning of the table last aligned.
599 "Marker at the end of the table last aligned.
602 "List of flags for flushright alignment, from the last re-alignment.
605 "List of max width of fields in each column.
608 "Non-nil means debug table formulas.
621 "Align the table at point by aligning all vertical bars."
624 ;; Limits of table
627 ;; Current cursor position
633 column
635 rfmt hfmt
643 emptystrings links dates emph raise narrow
644 falign falign1 fmax f1 len c e space)
647 ;; Check if we have links or dates
659 ;; Make sure the link properties are right
661 ;; Make sure the date properties are right
666 ;; Check if we are narrowing any columns
669 org-format-transports-properties-p
674 ;; Get the rows
677 ;; Store the indentation of the first line
680 ;; Mark the hlines by setting the corresponding element to nil
681 ;; At the same time, we remove trailing space.
684 nil
687 l)))
688 lines))
689 ;; Get the data fields by splitting the lines.
694 ;; How many fields in the longest line?
701 ;; A list of empty strings to fill any short rows on output
703 ;; Check for special formatting.
707 ;; Check if there is an explicit width specified
717 ;; Find fields that are wider than fmax, and shorten them
723 'help-echo
724 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
732 xx)))))
733 ;; Get the maximum width for each column
735 lengths)
736 ;; Get the fraction of numbers, to decide about alignment of the column
742 nil
749 ;; Store the alignment of this table, for later editing of single fields
751 org-table-last-column-widths lengths)
753 ;; With invisible characters, `format' does not get the field width right
754 ;; So we need to make these fields wide by hand.
772 ;; Compute the formats needed for output of the table
785 hfmt))
788 ;; This hack is for org-indent, to force redisplay of the
789 ;; line prefix of the first line. Apparently the redisplay
790 ;; is tied to the newline, which is, I think, a bug.
791 ;; To force this redisplay, we remove and re-insert the
792 ;; newline, so that the redisplay engine thinks it belongs
793 ;; to the changed text.
799 ;; Replace the old one
806 ;; Try to move to the old location
814 ))
817 "Find the beginning of the table and return its position.
818 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
822 org-table-border-regexp)
823 nil t))
830 "Find the end of the table and return its position.
831 With argument TABLE-TYPE, go to the end of a table.el-type table."
835 org-table-border-regexp)
836 nil t))
842 "Justify the current field, text to left, number to right.
843 Optional argument NEW may specify text to replace the current field content."
852 ;; This is not the same table, force a full re-align
858 l f n o e)
882 "Go to the next field in the current table, creating new lines as needed.
883 Before doing so, re-align the table if necessary."
888 org-table-may-need-update)
899 org-table-tab-jumps-over-hlines
911 "Go to the previous field in the table.
912 Before doing so, re-align the table if necessary."
917 org-table-may-need-update)
932 "Move to the end of the current table field.
933 If already at or after the end, move to the end of the next table field.
934 With numeric argument N, move N-1 fields forward first."
947 "Move to the beginning of the current table field.
948 If already at or before the beginning, move to the beginning of the
949 previous field.
950 With numeric argument N, move N-1 fields backward first."
964 "Go to the next row (same column) in the current table.
965 Before doing so, re-align the table if necessary."
973 org-table-may-need-update)
987 "Copy a field down in the current column.
988 If the field at the cursor is empty, copy into it the content of the nearest
989 non-empty field above. With argument N, use the Nth non-empty field.
990 If the current field is not empty, it is copied down to the next row, and
991 the cursor is moved with it. Therefore, repeating this command causes the
992 column to be filled row-by-row.
993 If the variable `org-table-copy-increment' is non-nil and the field is an
994 integer or a timestamp, it will be incremented while copying. In the case of
995 a timestamp, if the cursor is on the year, change the year. If it is on the
996 month or the day, change that. Point will stay on the current date field
997 in order to easily repeat the interval."
1005 txt)
1017 beg t))
1040 "Is point inside a table data field?
1041 I.e. not on a hline or before the first or after the last column?
1042 This actually throws an error, so it aborts the current command."
1053 "Get the field in table line LINE, column COLUMN.
1054 If LINE is larger than the number of data lines in the table, the function
1055 returns nil. However, if COLUMN is too large, we will simply return an
1056 empty string.
1057 If LINE is nil, use the current line.
1058 If column is nil, use the current column."
1065 "Put VALUE into line LINE, column COLUMN.
1066 When ALIGN is set, also realign the table."
1075 "Return the index of the current data line."
1082 cnt))
1085 "Go to the Nth data line in the current table.
1086 Return t when the line exists, nil if it does not exist."
1094 "Blank the current table field or active region."
1111 "Return the value of the field in column N of current row.
1112 N defaults to current field.
1113 If REPLACE is a string, replace field with this value. The return value
1114 is always the old value."
1124 val)
1128 "Show info about the current field, and highlight any reference at point."
1136 org-table-named-field-locations)))
1149 dline col
1151 dline col ref1
1153 ;; FIXME: formula info not correct if special table line
1163 "Find out which column we are in."
1172 cnt)))
1175 "Find out what table data line we are in.
1176 Only data lines count for this."
1186 cnt)))
1189 "Move the cursor to the Nth column in the current table line.
1190 With optional argument ON-DELIM, stop with point before the left delimiter
1191 of the field.
1192 If there are less than N fields, just go to after the last delimiter.
1193 However, when FORCE is non-nil, create new columns if necessary."
1203 t)))))
1211 "Insert a new column into the table."
1219 ;; Current cursor position
1225 nil
1237 "Find a data line in the current table, which is needed for column commands."
1240 t
1251 t
1256 "Delete a column from the table."
1265 ;; Current cursor position
1271 nil
1286 "Move column to the right."
1290 "Move column to the left."
1295 "Move the current column to the right. With arg LEFT, move to the left."
1305 ;; Current cursor position
1315 nil
1332 "Move table row down."
1336 "Move table row up."
1341 "Move the current table line down. With arg UP, move it up."
1350 txt hline2p)
1371 "Insert a new row above the current line into the table.
1372 With prefix ARG, insert below the current line."
1378 ;; Fix the first field if necessary
1390 "Insert a horizontal-line below the current line into the table.
1391 With prefix ABOVE, insert above the current line."
1413 "Insert a hline and move to the row below that line."
1427 In particular, this does handle wide and invisible characters."
1429 ;; It's a hline, just map the characters
1435 t t s)))
1436 s))
1439 "Delete the current row or horizontal line from the table."
1452 "Sort table lines according to the column at point.
1454 The position of point indicates the column to be used for
1455 sorting, and the range of lines is the range between the nearest
1456 horizontal separator lines, or the entire table of no such lines
1457 exist. If point is before the first column, you will be prompted
1458 for the sorting column. If there is an active region, the mark
1459 specifies the first line and the sorting column, while point
1460 should be in the last line to be included into the sorting.
1462 The command then prompts for the sorting type which can be
1463 alphabetically, numerically, or by time (as given in a time stamp
1464 in the field). Sorting in reverse order is also possible.
1466 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1468 If SORTING-TYPE is specified when this function is called from a Lisp
1469 program, no prompting will take place. SORTING-TYPE must be a character,
1470 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1471 should be done in reverse order."
1475 beg end bcol ecol tend tbeg column lns pos)
1520 x))
1533 "Copy region in table to the clipboard and blank all relevant fields.
1534 If there is no active region, use just the field at point."
1541 "Copy rectangular region in table to clipboard.
1542 A special clipboard is used which can only be accessed
1543 with `org-table-paste-rectangle'."
1547 current-prefix-arg))
1549 region cols
1575 org-table-clip))
1578 "Paste a rectangular region into a table.
1579 The upper right corner ends up in the current field. All involved fields
1580 will be overwritten. If the rectangle does not fit into the present table,
1581 the table is enlarged as needed. The process ignores horizontal separator
1582 lines."
1592 c cols field)
1608 "Convert from `org-mode' table to table.el and back.
1609 Obviously, this only works within limits. When an Org-mode table is
1610 converted to table.el, all horizontal separator lines get lost, because
1611 table.el uses these as cell boundaries and has no notion of horizontal lines.
1612 A table.el table can be converted to an Org-mode table only if it does not
1613 do row or column spanning. Multiline cells will become multiple cells.
1614 Beware, Org-mode does not test if the table can be successfully converted - it
1615 blindly applies a recipe that works for simple tables."
1619 ;; convert to Org-mode table
1628 ;; convert to table.el table
1631 ;; first, get rid of all horizontal lines
1635 ;; insert a hline before first
1639 ;; insert a hline after each line
1644 ;; replace "+" at beginning and ending of hlines
1653 "Wrap several fields in a column like a paragraph.
1654 This is useful if you'd like to spread the contents of a field over several
1655 lines, in order to keep the table compact.
1657 If there is an active region, and both point and mark are in the same column,
1658 the text in the column is wrapped to minimum width for the given number of
1659 lines. Generally, this makes the table more compact. A prefix ARG may be
1661 formats the selected text to two lines. If the region was longer than two
1662 lines, the remaining lines remain empty. A negative prefix argument reduces
1663 the current number of lines by that amount. The wrapped text is pasted back
1664 into the table. If you formatted it to more lines than it was before, fields
1665 further down in the table get overwritten - so you might need to make space in
1666 the table first.
1668 If there is no region, the current field is split at the cursor position and
1669 the text fragment to the right of the cursor is prepended to the field one
1670 line down.
1672 If there is no region, but you specify a prefix ARG, the current field gets
1673 blank, and the content is appended to the field above."
1677 ;; There is a region: fill as a paragraph
1681 nlines)
1688 arg)
1692 nil nlines)))
1696 ;; No region, split the current field at point
1700 ;; combine with field above
1710 ;; split field
1723 "Edit table field in a different window.
1724 This is mainly useful for fields that contain hidden parts.
1726 it can be edited in place."
1732 display t intangible t))
1738 p)
1747 intangible t))
1755 "Finish editing a table data field.
1756 Remove all newline characters, insert the result into the table, realign
1757 the table and kill the editing buffer."
1761 text)
1780 "Sum numbers in region of current table column.
1781 The result will be displayed in the echo area, and will be available
1784 If there is an active region, it is interpreted as a rectangle and all
1785 numbers in that rectangle will be summed. If there is no active
1786 region and point is located in a table column, sum all numbers in that
1787 column.
1789 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1790 numbers are assumed to be times as well (in decimal hours) and the
1791 numbers are added as such.
1793 If NLAST is a number, only the NLAST fields will actually be summed."
1820 items1)))
1827 s diff)
1835 sres))))
1858 "Return the formula active for the current field.
1859 Assumes that specials are in place.
1860 If KEY is given, return the key to this formula.
1864 org-table-named-field-locations)))
1878 "Read a formula from the minibuffer, offer stored formula as default.
1879 When NAMED is non-nil, look for a named equation."
1883 org-table-named-field-locations)))
1890 name
1891 ref)
1901 stored)
1903 equation)
1910 scol))
1912 'org-table-formula-history
1913 )))))
1914 mustsave)
1916 ;; remove formula
1923 ;; We set the column equation, delete the named one.
1925 mustsave t))
1931 eq))
1934 "Store the list of formulas below the current table."
1940 ;; don't overwrite TBLFM, we might use text properties to store stuff
1961 "Compare two formulas for sorting."
1967 "Return an alist with the stored formulas directly after current table."
1975 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1992 "Modify the equations after the table structure has been edited.
1994 For all numbers larger than LIMIT, shift them by DELTA."
2005 s n a)
2018 t t)))))))))
2021 "Get the column names and local parameters for this table."
2024 names name fields fields1 field cnt
2025 c v l line col types dlines hlines last-dline)
2027 org-table-local-parameters nil
2028 org-table-named-field-locations nil
2029 org-table-current-begin-line nil
2030 org-table-current-begin-pos nil
2031 org-table-current-line-types nil)
2049 org-table-local-parameters))))
2065 ;; Analyse the line types
2069 l org-table-current-begin-line)
2086 al al2)
2098 If yes, store the formula and apply it."
2099 ;; We already know we are in a table. Get field will only return a formula
2100 ;; when appropriate. It might return a separator line, but no problem.
2103 named eq)
2114 "List of commands triggering the recalculation of a line.
2127 "Rotate the recalculation mark in the first column.
2128 If in any row, the first field is not consistent with a mark,
2129 insert a new column for the markers.
2130 When there is an active region, change all the lines in the region,
2131 after prompting for the marking character.
2132 After each change, a message will be displayed indicating the meaning
2133 of the new mark."
2148 epos new)
2155 newchar))
2187 "Recompute the current line if marked for it, and if we haven't just done it."
2207 modes)
2210 suppress-align suppress-const
2211 suppress-store suppress-analysis)
2212 "Replace the table field value at the cursor by the result of a calculation.
2214 This function makes use of Dave Gillespie's Calc package, in my view the
2215 most exciting program ever written for GNU Emacs. So you need to have Calc
2216 installed in order to use this function.
2218 In a table, this command replaces the value in the current field with the
2220 formula, by storing it in a special line below the table. When called
2221 with a `C-u' prefix, the current field must be a named field, and the
2222 formula is installed as valid in only this specific field.
2224 When called with two `C-u' prefixes, insert the active equation
2225 for the field back into the current field, so that it can be
2227 to check the referenced fields.
2229 When called, the command first prompts for a formula, which is read in
2230 the minibuffer. Previously entered formulas are available through the
2231 history list, and the last used formula is offered as a default.
2232 These stored formulas are adapted correctly when moving, inserting, or
2233 deleting columns with the corresponding commands.
2235 The formula can be any algebraic expression understood by the Calc package.
2236 For details, see the Org-mode manual.
2238 This function can also be called from Lisp programs and offers
2239 additional arguments: EQUATION can be the formula to apply. If this
2240 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2241 used to speed-up recursive calls by by-passing unnecessary aligns.
2242 SUPPRESS-CONST suppresses the interpretation of constants in the
2243 formula, assuming that this has been done already outside the function.
2244 SUPPRESS-STORE means the formula should not be stored, either because
2245 it is already stored, or because it is a modified equation that should
2246 not overwrite the stored one."
2262 equation
2268 n form form0 bw fmt x ev orig c lispp literal)
2269 ;; Parse the format string. Since we have a lot of modes, this is
2270 ;; a lot of work. However, I think calc still uses most of the time.
2282 'calc-float-format
2285 n))))
2312 fields)))
2318 ;; Insert row and column number of formula result field
2329 t t form)))
2331 ;; Check for old vertical references
2333 ;; Insert remote references
2341 keep-empty numbers lispp))
2342 t t form)))
2343 ;; Insert complex ranges
2351 keep-empty numbers lispp))
2352 t t form)))
2353 ;; Insert simple ranges
2362 keep-empty numbers lispp))
2363 t t form)))
2365 ;; Insert the references to fields in same row
2374 t t form)))
2389 Orig: %s
2390 $xyz-> %s
2391 @r$c-> %s
2422 prop value)))
2425 "Get a calc vector from a column, according to descriptor DESC.
2426 Optional arguments TBEG and COL can give the beginning of the table and
2427 the current column, to avoid unnecessary parsing.
2428 HIGHLIGHT means just highlight the range."
2435 beg end c1 c2 r1 r2 rangep tmp)
2452 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2458 ;; just one field
2465 ;; A range, return a vector
2466 ;; First sort the numbers to get a regular ractangle
2482 ;; return string representation of calc vector
2487 "Analyze descriptor DESC and retrieve the corresponding line number.
2488 The cursor is currently in line CLINE, the table begins in line BLINE,
2489 and TABLE is a vector with line types."
2497 ;; 1 2 3 4 5 6
2517 nil hn cline desc)))
2520 rel on cline desc)))
2524 "FIXME: Needs more documentation."
2537 nil))
2538 t)))
2542 desc cline)
2543 i)))
2548 s))
2551 "Convert list ELEMENTS to something appropriate to insert into formula.
2552 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2553 NUMBERS indicates that everything should be converted to numbers.
2554 LISPP means to return something appropriate for a Lisp list."
2558 elements
2567 elements))))
2573 x
2579 elements
2583 "Recalculate the current table line by applying all stored formulas.
2584 With prefix arg ALL, do this for all lines in the table.
2585 With the prefix argument ALL is `(16)' \
2587 it is the symbol `iterate', recompute the table until it no longer changes.
2588 If NOALIGN is not nil, do not re-align the table after the computations
2589 are done. This is typically used internally to save time, if it is
2590 known that the table will be realigned a little later anyway."
2605 ;; Insert constants in all formulas
2609 x)
2610 eqlist))
2611 ;; Split the equation list
2622 ;; This is a table with marked lines, compute selected lines
2624 ;; Move forward to the first non-header line
2635 ;; First find the named fields, and mark them untouchable
2647 name)))
2656 ;; Now evaluate the column formulas, but skip fields covered by
2657 ;; field formulas
2661 ;; Unprotected line, recalculate
2673 ;; Now evaluate the field formulas
2687 ;; back to initial position
2695 "Recalculate the table until it does not change anymore."
2700 thistbl)
2715 "Recalculate all tables in the current buffer."
2723 "Iterate all tables in the buffer, to converge inter-table dependencies."
2728 c1
2745 "Replace $const with values in string F."
2747 ;; First, check for column names
2752 ;; Parameters and constants
2754 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2764 f))
2767 "Find the value for a parameter or constant in a formula.
2768 Parameters get priority."
2799 map))
2806 "--"
2809 "--"
2810 "Shift Reference at Point"
2815 "-"
2816 "Change Test Row for Column Formulas"
2819 "--"
2824 org-table-overlay-coordinates)]
2825 "--"
2832 "Edit the formulas of the current table in a separate buffer."
2848 entry s type title)
2851 ;; Keep global-font-lock-mode from turning on font-lock-mode
2891 "Convert a formula from internal to user representation."
2894 s))
2897 "Convert a formula from user to internal representation."
2900 s))
2903 "Convert spreadsheet references from AB7 to @7$28.
2904 Works for single references, but also for entire formulas and even the
2905 full TBLFM line."
2907 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2910 ;; format match, just advance
2915 ;; 3.e5 or something like this.
2918 ;; (member (match-string 1 s)
2919 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2920 )
2921 ;; function name, just advance
2931 t t s)))))
2932 s))
2935 "Convert spreadsheet references from to @7$28 to AB7.
2936 Works for single references, but also for entire formulas and even the
2937 full TBLFM line."
2944 t t s)))
2949 t nil s)))
2950 s)
2953 "Convert a base 26 number represented by letters into an integer.
2954 For example: AB -> 28."
2960 n))
2963 "Convert an integer into a base 26 number represented by letters.
2964 For example: 28 -> AB."
2969 s))
2972 "Convert all references in this buffer, using FUNCTION."
2982 "Convert all references in the buffer from B3 to @3$2 and back."
2992 "Shift the reference at point one row/hline up."
2996 "Shift the reference at point one row/hline down."
3000 "Shift the reference at point one field to the left."
3004 "Shift the reference at point one field to the right."
3015 ;; A B3-like reference
3021 ;; An internal reference
3027 "Re-match the group N, and replace it with the shifted reference."
3032 t t)))
3035 "Shift a reference part REF.
3036 If DECR is set, decrease the references row/column, else increase.
3037 If HLINE is set, this may be a hline reference, it certainly is not
3038 a translation reference."
3067 "Toggle the display of coordinates in the referenced table."
3076 "Parse the buffer for formula definitions and install them.
3077 With prefix ARG, apply the new formulas to the table."
3088 nil t)
3112 "Abort editing formulas, without installing the changes."
3123 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3164 "Show the location/value of the $ expression at point."
3173 var name e what match dest)
3255 ;; column number
3283 org-table-fedit-scroll-down))))
3294 "Make sure the cursor is in a dataline in a table."
3303 p1 p2)))
3308 "Move cursor one line up in the window showing the table."
3313 "Move cursor one line down in the window showing the table."
3318 "Move the cursor in the window showing the table.
3319 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3344 "Add a new overlay."
3350 "Highlight rectangular region in a table."
3354 l1 c1 l2 c2 tmp)
3378 "Remove the rectangle overlays."
3389 "Add overlays to the table at point, to show row/column coordinates."
3418 "Toggle the display of Row/Column numbers in tables."
3430 "Toggle the formula debugger in tables."
3436 ;;; The orgtbl minor mode
3438 ;; Define a minor mode which can be used in other modes in order to
3439 ;; integrate the org-mode table editor.
3441 ;; This is really a hack, because the org-mode table editor uses several
3442 ;; keys which normally belong to the major mode, for example the TAB and
3443 ;; RET keys. Here is how it works: The minor mode defines all the keys
3444 ;; necessary to operate the table editor, but wraps the commands into a
3445 ;; function which tests if the cursor is currently inside a table. If that
3446 ;; is the case, the table editor command is executed. However, when any of
3447 ;; those keys is used outside a table, the function uses `key-binding' to
3448 ;; look up if the key has an associated command in another currently active
3449 ;; keymap (minor modes, major mode, global), and executes that command.
3450 ;; There might be problems if any of the keys used by the table editor is
3451 ;; otherwise used as a prefix key.
3453 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3454 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3455 ;; addresses this by checking explicitly for both bindings.
3457 ;; The optimized version (see variable `orgtbl-optimized') takes over
3458 ;; all keys which are bound to `self-insert-command' in the *global map*.
3459 ;; Some modes bind other commands to simple characters, for example
3460 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3461 ;; active, this binding is ignored inside tables and replaced with a
3462 ;; modified self-insert.
3468 ;;;###autoload
3470 "Unconditionally turn on `orgtbl-mode'."
3485 ;; Install it as a minor mode.
3489 ;;;###autoload
3491 "The `org-mode' table editor as a minor mode for use in other modes."
3496 ;; Exit without error, in case some hook functions calls this
3497 ;; by accident in org-mode.
3501 ;; Make sure we are first in minor-mode-map-alist
3503 ;; FIXME: maybe it should use emulation-mode-map-alists?
3510 auto-fill-inhibit-regexp)
3514 auto-fill-inhibit-regexp)
3515 orgtbl-line-start-regexp))
3533 "Remove all properties related to narrow-column invisibility."
3546 "Create a function for binding in the table minor mode.
3547 FUN is the command to call inside a table. N is used to create a unique
3548 command name. KEYS are keys that should be checked in for a command
3549 to execute outside of tables."
3555 "Outside of tables, run the binding of `"
3567 keys)
3571 "Error when there is no default binding for a table key."
3576 "Setup orgtbl keymaps."
3606 elt key fun cmd)
3614 ;; Special treatment needed for TAB and RET
3634 [(tab)] "\C-i")))
3636 (org-defkey orgtbl-mode-map [backtab]
3638 [backtab] [S-iso-lefttab] [(shift tab)]
3639 [(tab)] "\C-i"))
3641 (org-defkey orgtbl-mode-map "\M-\C-m"
3642 (orgtbl-make-binding 'org-table-wrap-region 105
3643 "\M-\C-m" [(meta return)]))
3644 (org-defkey orgtbl-mode-map [(meta return)]
3645 (orgtbl-make-binding 'org-table-wrap-region 106
3646 [(meta return)] "\M-\C-m"))
3648 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3649 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3651 (when orgtbl-optimized
3652 ;; If the user wants maximum table support, we need to hijack
3653 ;; some standard editing functions
3654 (org-remap orgtbl-mode-map
3655 'self-insert-command 'orgtbl-self-insert-command
3656 'delete-char 'org-delete-char
3657 'delete-backward-char 'org-delete-backward-char)
3658 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3659 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3660 '("OrgTbl"
3661 ["Create or convert" org-table-create-or-convert-from-region
3662 :active (not (org-at-table-p)) :keys "C-c |" ]
3663 "--"
3664 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3665 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3666 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3667 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3668 "--"
3669 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3670 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3671 ["Copy Field from Above"
3672 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3673 "--"
3674 ("Column"
3675 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3676 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3677 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3678 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3679 ("Row"
3680 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3681 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3682 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3683 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3684 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3685 "--"
3686 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3687 ("Rectangle"
3688 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3689 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3690 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3691 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3692 "--"
3693 ("Radio tables"
3694 ["Insert table template" orgtbl-insert-radio-table
3695 (assq major-mode orgtbl-radio-table-templates)]
3696 ["Comment/uncomment table" orgtbl-toggle-comment t])
3697 "--"
3698 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3699 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3700 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3701 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3702 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3703 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3704 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3705 ["Sum Column/Rectangle" org-table-sum
3706 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3707 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3708 ["Debug Formulas"
3709 org-table-toggle-formula-debugger :active (org-at-table-p)
3710 :keys "C-c {"
3711 :style toggle :selected org-table-formula-debug]
3712 ["Show Col/Row Numbers"
3713 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3714 :keys "C-c }"
3715 :style toggle :selected org-table-overlay-coordinates]
3716 ))
3717 t))
3719 (defun orgtbl-ctrl-c-ctrl-c (arg)
3720 "If the cursor is inside a table, realign the table.
3721 If it is a table to be sent away to a receiver, do it.
3722 With prefix arg, also recompute table."
3723 (interactive "P")
3724 (let ((pos (point)) action consts-str consts cst)
3725 (save-excursion
3726 (beginning-of-line 1)
3727 (setq action (cond
3731 (cond
3732 ((integerp action)
3733 (goto-char action)
3734 (org-table-maybe-eval-formula)
3735 (if arg
3736 (call-interactively 'org-table-recalculate)
3737 (org-table-maybe-recalculate-line))
3738 (call-interactively 'org-table-align)
3739 (when (orgtbl-send-table 'maybe)
3740 (run-hooks 'orgtbl-after-send-table-hook)))
3741 ((eq action 'recalc)
3742 (save-excursion
3743 (goto-char (point-min))
3745 (setq const-str (substring-no-properties (match-string 1)))
3747 (when consts
3748 (let (e)
3749 (while (setq e (pop consts))
3751 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
3752 (setq org-table-formula-constants-local cst)))))
3753 (save-excursion
3754 (beginning-of-line 1)
3756 (if (org-at-table-p)
3757 (org-call-with-arg 'org-table-recalculate t))))
3758 (t (let (orgtbl-mode)
3759 (call-interactively (key-binding "\C-c\C-c")))))))
3761 (defun orgtbl-create-or-convert-from-region (arg)
3762 "Create table or convert region to table, if no conflicting binding.
3763 This installs the table binding `C-c |', but only if there is no
3764 conflicting binding to this key outside orgtbl-mode."
3765 (interactive "P")
3766 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3767 (if cmd
3768 (call-interactively cmd)
3769 (call-interactively 'org-table-create-or-convert-from-region))))
3771 (defun orgtbl-tab (arg)
3772 "Justification and field motion for `orgtbl-mode'."
3773 (interactive "P")
3774 (if arg (org-table-edit-field t)
3775 (org-table-justify-field-maybe)
3776 (org-table-next-field)))
3778 (defun orgtbl-ret ()
3779 "Justification and field motion for `orgtbl-mode'."
3780 (interactive)
3781 (if (bobp)
3782 (newline)
3783 (org-table-justify-field-maybe)
3784 (org-table-next-row)))
3786 (defun orgtbl-self-insert-command (N)
3787 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3788 If the cursor is in a table looking at whitespace, the whitespace is
3789 overwritten, and the table is not marked as requiring realignment."
3790 (interactive "p")
3791 (if (and (org-at-table-p)
3792 (or
3793 (and org-table-auto-blank-field
3794 (member last-command
3795 '(orgtbl-hijacker-command-100
3796 orgtbl-hijacker-command-101
3797 orgtbl-hijacker-command-102
3798 orgtbl-hijacker-command-103
3799 orgtbl-hijacker-command-104
3800 orgtbl-hijacker-command-105
3801 yas/expand))
3802 (org-table-blank-field))
3803 t)
3804 (eq N 1)
3806 (let (org-table-may-need-update)
3807 (goto-char (1- (match-end 0)))
3808 (delete-backward-char 1)
3809 (goto-char (match-beginning 0))
3810 (self-insert-command N))
3811 (setq org-table-may-need-update t)
3812 (let* (orgtbl-mode
3813 a
3814 (cmd (or (key-binding
3815 (or (and (listp function-key-map)
3816 (setq a (assoc last-input-event function-key-map))
3817 (cdr a))
3818 (vector last-input-event)))
3819 'self-insert-command)))
3820 (call-interactively cmd)
3821 (if (and org-self-insert-cluster-for-undo
3822 (eq cmd 'self-insert-command))
3823 (if (not (eq last-command 'orgtbl-self-insert-command))
3824 (setq org-self-insert-command-undo-counter 1)
3825 (if (>= org-self-insert-command-undo-counter 20)
3826 (setq org-self-insert-command-undo-counter 1)
3827 (and (> org-self-insert-command-undo-counter 0)
3828 buffer-undo-list
3829 (not (cadr buffer-undo-list)) ; remove nil entry
3830 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3831 (setq org-self-insert-command-undo-counter
3832 (1+ org-self-insert-command-undo-counter))))))))
3835 "Regular expression matching exponentials as produced by calc.")
3837 (defun orgtbl-export (table target)
3838 (require 'org-exp)
3839 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3841 org-table-last-alignment org-table-last-column-widths
3842 maxcol column)
3843 (if (not (fboundp func))
3844 (error "Cannot export orgtbl table to %s" target))
3845 (setq lines (org-table-clean-before-export lines))
3846 (setq table
3847 (mapcar
3848 (lambda (x)
3849 (if (string-match org-table-hline-regexp x)
3850 'hline
3852 lines))
3853 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3854 table)))
3855 (loop for i from (1- maxcol) downto 0 do
3856 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3857 (setq column (delq nil column))
3858 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3859 (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))
3860 (funcall func table nil)))
3862 (defun orgtbl-gather-send-defs ()
3863 "Gather a plist of :name, :transform, :params for each destination before
3864 a radio table."
3865 (save-excursion
3866 (goto-char (org-table-begin))
3867 (let (rtn)
3868 (beginning-of-line 0)
3869 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3870 (let ((name (org-no-properties (match-string 1)))
3871 (transform (intern (match-string 2)))
3872 (params (if (match-end 3)
3873 (read (concat "(" (match-string 3) ")")))))
3874 (push (list :name name :transform transform :params params)
3875 rtn)
3876 (beginning-of-line 0)))
3877 rtn)))
3879 (defun orgtbl-send-replace-tbl (name txt)
3880 "Find and replace table NAME with TXT."
3881 (save-excursion
3882 (goto-char (point-min))
3883 (unless (re-search-forward
3885 (error "Don't know where to insert translated table"))
3886 (goto-char (match-beginning 0))
3887 (beginning-of-line 2)
3888 (save-excursion
3889 (let ((beg (point)))
3890 (unless (re-search-forward
3891 (concat "END RECEIVE ORGTBL +" name) nil t)
3892 (error "Cannot find end of insertion region"))
3893 (beginning-of-line 1)
3894 (delete-region beg (point))))
3897 ;;;###autoload
3898 (defun org-table-to-lisp (&optional txt)
3899 "Convert the table at point to a Lisp structure.
3900 The structure will be a list. Each item is either the symbol `hline'
3901 for a horizontal separator line, or a list of field values as strings.
3902 The table is taken from the parameter TXT, or from the buffer at point."
3903 (unless txt
3904 (unless (org-at-table-p)
3905 (error "No table at point")))
3906 (let* ((txt (or txt
3907 (buffer-substring-no-properties (org-table-begin)
3908 (org-table-end))))
3911 (mapcar
3912 (lambda (x)
3913 (if (string-match org-table-hline-regexp x)
3914 'hline
3916 lines)))
3918 (defun orgtbl-send-table (&optional maybe)
3919 "Send a transformed version of this table to the receiver position.
3920 With argument MAYBE, fail quietly if no transformation is defined for
3921 this table."
3922 (interactive)
3923 (catch 'exit
3924 (unless (org-at-table-p) (error "Not at a table"))
3925 ;; when non-interactive, we assume align has just happened.
3926 (when (interactive-p) (org-table-align))
3927 (let ((dests (orgtbl-gather-send-defs))
3928 (txt (buffer-substring-no-properties (org-table-begin)
3929 (org-table-end)))
3930 (ntbl 0))
3931 (unless dests (if maybe (throw 'exit nil)
3932 (error "Don't know how to transform this table")))
3933 (dolist (dest dests)
3934 (let* ((name (plist-get dest :name))
3935 (transform (plist-get dest :transform))
3936 (params (plist-get dest :params))
3937 (skip (plist-get params :skip))
3938 (skipcols (plist-get params :skipcols))
3939 beg
3940 (lines (org-table-clean-before-export
3941 (nthcdr (or skip 0)
3943 (i0 (if org-table-clean-did-remove-column 2 1))
3944 (table (mapcar
3945 (lambda (x)
3946 (if (string-match org-table-hline-regexp x)
3947 'hline
3948 (org-remove-by-index
3950 skipcols i0)))
3951 lines))
3952 (fun (if (= i0 2) 'cdr 'identity))
3953 (org-table-last-alignment
3954 (org-remove-by-index (funcall fun org-table-last-alignment)
3955 skipcols i0))
3956 (org-table-last-column-widths
3957 (org-remove-by-index (funcall fun org-table-last-column-widths)
3958 skipcols i0))
3959 (txt (if (fboundp transform)
3960 (funcall transform table params)
3961 (error "No such transformation function %s" transform))))
3962 (orgtbl-send-replace-tbl name txt))
3963 (setq ntbl (1+ ntbl)))
3964 (message "Table converted and installed at %d receiver location%s"
3965 ntbl (if (> ntbl 1) "s" ""))
3966 (if (> ntbl 0)
3967 ntbl
3968 nil))))
3970 (defun org-remove-by-index (list indices &optional i0)
3971 "Remove the elements in LIST with indices in INDICES.
3972 First element has index 0, or I0 if given."
3973 (if (not indices)
3974 list
3975 (if (integerp indices) (setq indices (list indices)))
3976 (setq i0 (1- (or i0 0)))
3977 (delq :rm (mapcar (lambda (x)
3978 (setq i0 (1+ i0))
3979 (if (memq i0 indices) :rm x))
3980 list))))
3982 (defun orgtbl-toggle-comment ()
3983 "Comment or uncomment the orgtbl at point."
3984 (interactive)
3985 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3986 (re2 (concat "^" orgtbl-line-start-regexp))
3987 (commented (save-excursion (beginning-of-line 1)
3988 (cond ((looking-at re1) t)
3989 ((looking-at re2) nil)
3990 (t (error "Not at an org table")))))
3991 (re (if commented re1 re2))
3992 beg end)
3993 (save-excursion
3994 (beginning-of-line 1)
3995 (while (looking-at re) (beginning-of-line 0))
3996 (beginning-of-line 2)
3997 (setq beg (point))
3998 (while (looking-at re) (beginning-of-line 2))
3999 (setq end (point)))
4000 (comment-region beg end (if commented '(4) nil))))
4002 (defun orgtbl-insert-radio-table ()
4003 "Insert a radio table template appropriate for this major mode."
4004 (interactive)
4005 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4006 (txt (nth 1 e))
4007 name pos)
4008 (unless e (error "No radio table setup defined for %s" major-mode))
4009 (setq name (read-string "Table name: "))
4010 (while (string-match "%n" txt)
4011 (setq txt (replace-match name t t txt)))
4013 (setq pos (point))
4014 (insert txt)
4015 (goto-char pos)))
4017 ;; Dynamically bound input and output for table formatting.
4018 (defvar *orgtbl-table* nil
4019 "Carries the current table through formatting routines.")
4020 (defvar *orgtbl-rtn* nil
4021 "Formatting routines push the output lines here.")
4022 ;; Formatting parameters for the current table section.
4023 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4024 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4025 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4026 (defvar *orgtbl-fmt* nil "Format for each entry.")
4027 (defvar *orgtbl-efmt* nil "Format for numbers.")
4028 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4029 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4030 (defvar *orgtbl-lstart* nil "Text starting a row.")
4031 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4032 (defvar *orgtbl-lend* nil "Text ending a row.")
4033 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4035 (defsubst orgtbl-get-fmt (fmt i)
4036 "Retrieve the format from FMT corresponding to the Ith column."
4037 (if (and (not (functionp fmt)) (consp fmt))
4038 (plist-get fmt i)
4039 fmt))
4041 (defsubst orgtbl-apply-fmt (fmt &rest args)
4042 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4043 (cond ((functionp fmt) (apply fmt args))
4044 (fmt (apply 'format fmt args))
4045 (args (car args))
4046 (t args)))
4048 (defsubst orgtbl-eval-str (str)
4049 "If STR is a function, evaluate it with no arguments."
4050 (if (functionp str)
4051 (funcall str)
4052 str))
4054 (defun orgtbl-format-line (line)
4055 "Format LINE as a table row."
4056 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4057 (let* ((i 0)
4058 (line
4059 (mapcar
4060 (lambda (f)
4061 (setq i (1+ i))
4062 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4063 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4064 (orgtbl-apply-fmt efmt (match-string 1 f)
4065 (match-string 2 f))
4066 f)))
4067 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4068 *orgtbl-default-fmt*)
4069 f)))
4070 line)))
4071 (push (if *orgtbl-lfmt*
4072 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4073 (concat (orgtbl-eval-str *orgtbl-lstart*)
4074 (mapconcat 'identity line *orgtbl-sep*)
4075 (orgtbl-eval-str *orgtbl-lend*)))
4076 *orgtbl-rtn*))))
4078 (defun orgtbl-format-section (section-stopper)
4079 "Format lines until the first occurrence of SECTION-STOPPER."
4080 (let (prevline)
4081 (progn
4082 (while (not (eq (car *orgtbl-table*) section-stopper))
4083 (if prevline (orgtbl-format-line prevline))
4084 (setq prevline (pop *orgtbl-table*)))
4085 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4086 (*orgtbl-lend* *orgtbl-llend*)
4087 (*orgtbl-lfmt* *orgtbl-llfmt*))
4088 (orgtbl-format-line prevline))))))
4090 (defun orgtbl-to-generic (table params)
4091 "Convert the orgtbl-mode TABLE to some other format.
4092 This generic routine can be used for many standard cases.
4093 TABLE is a list, each entry either the symbol `hline' for a horizontal
4094 separator line, or a list of fields for that line.
4095 PARAMS is a property list of parameters that can influence the conversion.
4096 For the generic converter, some parameters are obligatory: You need to
4097 specify either :lfmt, or all of (:lstart :lend :sep).
4099 Valid parameters are
4101 :splice When set to t, return only table body lines, don't wrap
4102 them into :tstart and :tend. Default is nil. When :splice
4103 is non-nil, this also means that the exporter should not look
4104 for and interpret header and footer sections.
4106 :hline String to be inserted on horizontal separation lines.
4107 May be nil to ignore hlines.
4109 :sep Separator between two fields
4110 :remove-nil-lines Do not include lines that evaluate to nil.
4113 Each in the following group may be either a string or a function
4114 of no arguments returning a string:
4115 :tstart String to start the table. Ignored when :splice is t.
4116 :tend String to end the table. Ignored when :splice is t.
4117 :lstart String to start a new table line.
4118 :llstart String to start the last table line, defaults to :lstart.
4119 :lend String to end a table line
4120 :llend String to end the last table line, defaults to :lend.
4122 Each in the following group may be a string, a function of one
4123 argument (the field or line) returning a string, or a plist
4124 mapping columns to either of the above:
4125 :lfmt Format for entire line, with enough %s to capture all fields.
4126 If this is present, :lstart, :lend, and :sep are ignored.
4127 :llfmt Format for the entire last line, defaults to :lfmt.
4128 :fmt A format to be used to wrap the field, should contain
4129 %s for the original field value. For example, to wrap
4131 This may also be a property list with column numbers and
4134 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4135 Same as above, specific for the header lines in the table.
4136 All lines before the first hline are treated as header.
4137 If any of these is not present, the data line value is used.
4139 This may be either a string or a function of two arguments:
4140 :efmt Use this format to print numbers with exponentials.
4141 The format should have %s twice for inserting mantissa
4143 may also be a property list with column numbers and
4144 formats. :fmt will still be applied after :efmt.
4146 In addition to this, the parameters :skip and :skipcols are always handled
4147 directly by `orgtbl-send-table'. See manual."
4148 (interactive)
4150 (let* ((splicep (plist-get params :splice))
4151 (hline (plist-get params :hline))
4152 (remove-nil-linesp (plist-get params :remove-nil-lines))
4153 (remove-newlines (plist-get params :remove-newlines))
4154 (*orgtbl-hline* hline)
4155 (*orgtbl-table* table)
4156 (*orgtbl-sep* (plist-get params :sep))
4157 (*orgtbl-efmt* (plist-get params :efmt))
4158 (*orgtbl-lstart* (plist-get params :lstart))
4159 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4160 (*orgtbl-lend* (plist-get params :lend))
4161 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4162 (*orgtbl-lfmt* (plist-get params :lfmt))
4163 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4164 (*orgtbl-fmt* (plist-get params :fmt))
4165 *orgtbl-rtn*)
4167 ;; Put header
4168 (unless splicep
4169 (when (plist-member params :tstart)
4170 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4171 (if tstart (push tstart *orgtbl-rtn*)))))
4173 ;; Do we have a heading section? If so, format it and handle the
4174 ;; trailing hline.
4175 (if (and (not splicep)
4176 (or (consp (car *orgtbl-table*))
4177 (consp (nth 1 *orgtbl-table*)))
4178 (memq 'hline (cdr *orgtbl-table*)))
4179 (progn
4180 (when (eq 'hline (car *orgtbl-table*))
4181 ;; there is a hline before the first data line
4182 (and hline (push hline *orgtbl-rtn*))
4183 (pop *orgtbl-table*))
4184 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4185 *orgtbl-lstart*))
4186 (*orgtbl-llstart* (or (plist-get params :hllstart)
4187 *orgtbl-llstart*))
4188 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4189 (*orgtbl-llend* (or (plist-get params :hllend)
4190 (plist-get params :hlend) *orgtbl-llend*))
4191 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4192 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4193 (plist-get params :hlfmt) *orgtbl-llfmt*))
4194 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4195 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4196 (orgtbl-format-section 'hline))
4197 (if hline (push hline *orgtbl-rtn*))
4198 (pop *orgtbl-table*)))
4200 ;; Now format the main section.
4201 (orgtbl-format-section nil)
4203 (unless splicep
4204 (when (plist-member params :tend)
4205 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4206 (if tend (push tend *orgtbl-rtn*)))))
4208 (mapconcat (if remove-newlines
4209 (lambda (tend)
4211 'identity)
4212 (nreverse (if remove-nil-linesp
4213 (remq nil *orgtbl-rtn*)
4216 (defun orgtbl-to-tsv (table params)
4217 "Convert the orgtbl-mode table to TAB separated material."
4219 (defun orgtbl-to-csv (table params)
4220 "Convert the orgtbl-mode table to CSV material.
4221 This does take care of the proper quoting of fields with comma or quotes."
4222 (orgtbl-to-generic table (org-combine-plists
4223 '(:sep "," :fmt org-quote-csv-field)
4224 params)))
4226 (defun orgtbl-to-latex (table params)
4227 "Convert the orgtbl-mode TABLE to LaTeX.
4228 TABLE is a list, each entry either the symbol `hline' for a horizontal
4229 separator line, or a list of fields for that line.
4230 PARAMS is a property list of parameters that can influence the conversion.
4231 Supports all parameters from `orgtbl-to-generic'. Most important for
4232 LaTeX are:
4234 :splice When set to t, return only table body lines, don't wrap
4235 them into a tabular environment. Default is nil.
4237 :fmt A format to be used to wrap the field, should contain %s for the
4238 original field value. For example, to wrap everything in dollars,
4241 The format may also be a function that formats its one argument.
4243 :efmt Format for transforming numbers with exponentials. The format
4244 should have %s twice for inserting mantissa and exponent, for
4246 This may also be a property list with column numbers and formats.
4247 The format may also be a function that formats its two arguments.
4249 :llend If you find too much space below the last line of a table,
4252 The general parameters :skip and :skipcols have already been applied when
4253 this function is called."
4254 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4255 org-table-last-alignment ""))
4256 (params2
4257 (list
4262 (orgtbl-to-generic table (org-combine-plists params2 params))))
4264 (defun orgtbl-to-html (table params)
4265 "Convert the orgtbl-mode TABLE to HTML.
4266 TABLE is a list, each entry either the symbol `hline' for a horizontal
4267 separator line, or a list of fields for that line.
4268 PARAMS is a property list of parameters that can influence the conversion.
4269 Currently this function recognizes the following parameters:
4271 :splice When set to t, return only table body lines, don't wrap
4272 them into a <table> environment. Default is nil.
4274 The general parameters :skip and :skipcols have already been applied when
4275 this function is called. The function does *not* use `orgtbl-to-generic',
4276 so you cannot specify parameters for it."
4277 (let* ((splicep (plist-get params :splice))
4278 (html-table-tag org-export-html-table-tag)
4279 html)
4280 ;; Just call the formatter we already have
4281 ;; We need to make text lines for it, so put the fields back together.
4282 (setq html (org-format-org-table-html
4283 (mapcar
4284 (lambda (x)
4285 (if (eq x 'hline)
4286 "|----+----|"
4287 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4288 table)
4289 splicep))
4291 (setq html (replace-match "" t t html)))
4292 html))
4294 (defun orgtbl-to-texinfo (table params)
4295 "Convert the orgtbl-mode TABLE to TeXInfo.
4296 TABLE is a list, each entry either the symbol `hline' for a horizontal
4297 separator line, or a list of fields for that line.
4298 PARAMS is a property list of parameters that can influence the conversion.
4299 Supports all parameters from `orgtbl-to-generic'. Most important for
4300 TeXInfo are:
4302 :splice nil/t When set to t, return only table body lines, don't wrap
4303 them into a multitable environment. Default is nil.
4305 :fmt fmt A format to be used to wrap the field, should contain
4306 %s for the original field value. For example, to wrap
4308 This may also be a property list with column numbers and
4310 Each format also may be a function that formats its one
4311 argument.
4314 are computed automatically from the width of the columns
4315 under org-mode.
4317 The general parameters :skip and :skipcols have already been applied when
4318 this function is called."
4319 (let* ((total (float (apply '+ org-table-last-column-widths)))
4320 (colfrac (or (plist-get params :cf)
4321 (mapconcat
4322 (lambda (x) (format "%.3f" (/ (float x) total)))
4323 org-table-last-column-widths " ")))
4324 (params2
4325 (list
4326 :tstart (concat "@multitable @columnfractions " colfrac)
4327 :tend "@end multitable"
4328 :lstart "@item " :lend "" :sep " @tab "
4329 :hlstart "@headitem ")))
4330 (orgtbl-to-generic table (org-combine-plists params2 params))))
4332 (defun orgtbl-to-orgtbl (table params)
4333 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4334 Useful when slicing one table into many. The :hline, :sep,
4335 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4336 and :tend suppress strings without splicing; they can be set to
4337 provide ORGTBL directives for the generated table."
4338 (let* ((params2
4339 (list
4340 :remove-newlines t
4341 :tstart nil :tend nil
4342 :hline "|---"
4343 :sep " | "
4344 :lstart "| "
4345 :lend " |"))
4346 (params (org-combine-plists params2 params)))
4347 (orgtbl-to-generic table params)))
4349 (defun org-table-get-remote-range (name-or-id form)
4350 "Get a field value or a list of values in a range from table at ID.
4352 NAME-OR-ID may be the name of a table in the current file as set by
4354 will then be used. Alternatively, it may be an ID referring to
4355 any entry, also in a different file. In this case, the first table
4356 in that entry will be referenced.
4360 The return value is either a single string for a single field, or a
4361 list of the fields in the rectangle ."
4362 (save-match-data
4363 (let ((id-loc nil)
4364 org-table-column-names org-table-column-name-regexp
4365 org-table-local-parameters org-table-named-field-locations
4366 org-table-current-line-types org-table-current-begin-line
4367 org-table-current-begin-pos org-table-dlines
4368 org-table-hlines org-table-last-alignment
4369 org-table-last-column-widths org-table-last-alignment
4370 org-table-last-column-widths tbeg
4371 buffer loc)
4372 (setq form (org-table-convert-refs-to-rc form))
4373 (save-excursion
4374 (save-restriction
4375 (widen)
4376 (save-excursion
4377 (goto-char (point-min))
4378 (if (re-search-forward
4380 nil t)
4381 (setq buffer (current-buffer) loc (match-beginning 0))
4382 (setq id-loc (org-id-find name-or-id 'marker))
4383 (unless (and id-loc (markerp id-loc))
4385 (setq buffer (marker-buffer id-loc)
4386 loc (marker-position id-loc))
4387 (move-marker id-loc nil)))
4388 (with-current-buffer buffer
4389 (save-excursion
4390 (save-restriction
4391 (widen)
4392 (goto-char loc)
4393 (forward-char 1)
4395 (not (match-beginning 1)))
4396 (error "Cannot find a table at NAME or ID %s" name-or-id))
4397 (setq tbeg (point-at-bol))
4398 (org-table-get-specials)
4399 (setq form (org-table-formula-substitute-names form))
4400 (if (and (string-match org-table-range-regexp form)
4401 (> (length (match-string 0 form)) 1))
4402 (save-match-data
4403 (org-table-get-range (match-string 0 form) tbeg 1))
4404 form)))))))))
4406 (provide 'org-table)
4408 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4410 ;;; org-table.el ends here