| blob | b56dc6b77c36aef9a6b00db2e378d301a87dae8d |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 7.4
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;
26 ;;; Commentary:
28 ;; This file contains the table editor and spreadsheet for Org-mode.
30 ;; Watch out: Here we are talking about two different kind of tables.
31 ;; Most of the code is for the tables created with the Org-mode table editor.
32 ;; Sometimes, we talk about tables created and edited with the table.el
33 ;; Emacs package. We call the former org-type tables, and the latter
34 ;; table.el-type tables.
36 ;;; Code:
51 "Hook for functions attaching to `C-c C-c', if the table is sent.
52 This can be used to add additional functionality after the table is sent
53 to the receiver position, othewise, if table is not sent, the functions
57 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
58 In the optimized version, the table editor takes over all simple keys that
59 normally just insert a character. In tables, the characters are inserted
60 in a way to minimize disturbing the table structure (i.e. in overwrite mode
61 for empty fields). Outside tables, the correct binding of the keys is
62 restored.
64 The default for this option is t if the optimized version is also used in
65 Org-mode. See the variable `org-enable-table-editor' for details. Changing
66 this variable requires a restart of Emacs to become effective."
72 % END RECEIVE ORGTBL %n
74 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
75 | | |
78 @c END RECEIVE ORGTBL %n
79 @ignore
80 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
81 | | |
84 <!-- END RECEIVE ORGTBL %n -->
85 <!--
86 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
87 | | |
89 "Templates for radio tables in different major modes.
90 All occurrences of %n in a template will be replaced with the name of the
91 table, obtained by prompting the user."
98 "Settings for tables in Org-mode."
103 "The default size for newly created tables, Columns x Rows."
109 "Regular expression for recognizing numbers in table columns.
110 If a table column contains mostly numbers, it will be aligned to the
111 right. If not, it will be aligned to the left.
113 The default value of this option is a regular expression which allows
114 anything which looks remotely like a number as used in scientific
115 context. For example, all of the following will be considered a
116 number:
117 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
119 Other options offered by the customize interface are more restrictive."
137 "Fraction of numbers in a column required to make the column align right.
138 In a column all non-white fields are considered. If at least this
139 fraction of fields is matched by `org-table-number-fraction',
140 alignment to the right border applies."
145 "Behavior of tables during editing in Org-mode."
150 "Non-nil means automatically re-align table when pressing TAB or RETURN.
152 removal/insertion."
157 "Non-nil means automatically blank table field when starting to type into it.
158 This only happens when typing immediately after a field motion
159 command (TAB, S-TAB or RET).
160 Only relevant when `org-enable-table-editor' is equal to `optimized'."
165 "Non-nil means tab in the last column of a table with jump over a hline.
166 If a horizontal separator line is following the current line,
167 `org-table-next-field' can either create a new row before that line, or jump
168 over the line. When this option is nil, a new line will be created before
169 this line."
174 "Options concerning tables in Org-mode."
179 "Should org-mode work with table references like B3 instead of @3$2?
180 Possible values are:
181 nil never use them
182 from accept as input, do not present for editing
183 t: accept as input and present for editing"
198 calc-angle-mode deg
199 calc-prefer-frac nil
200 calc-symbolic-mode nil
202 calc-display-working-message t
203 )
204 "List with Calc mode settings for use in `calc-eval' for table formulas.
205 The list must contain alternating symbols (Calc modes variables and values).
206 Don't remove any of the default settings, just change the values. Org-mode
207 relies on the variables to be present in the list."
212 "Non-nil means TAB and RET evaluate a formula in current table field.
213 If the current field starts with an equal sign, it is assumed to be a formula
214 which should be evaluated as described in the manual and in the documentation
215 string of the command `org-table-eval-formula'. This feature requires the
216 Emacs calc package.
217 When this variable is nil, formula calculation is only available through
223 "Non-nil means interpret constants in formulas in tables.
224 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
225 by the value given in `org-table-formula-constants', or by a value obtained
226 from the `constants.el' package."
231 "Alist with constant names and values, for use in table formulas.
232 The car of each element is a name of a constant, without the `$' before it.
233 The cdr is the value as a string. For example, if you'd like to use the
234 speed of light in a formula, you would configure
238 and then use it in an equation like `$1*$c'.
240 Constants can also be defined on a per-file basis using a line like
242 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
249 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
250 Automatically means when TAB or RET or C-c C-c are pressed in the line."
255 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
260 "Non-nil means relative formula references may cross hlines.
261 Here are the allowed values:
263 nil Relative references may not cross hlines. They will reference the
264 field next to the hline instead. Coming from below, the reference
265 will be to the field below the hline. Coming from above, it will be
266 to the field above.
267 t Relative references may cross hlines.
268 error An attempt to cross a hline will throw an error.
270 It is probably good to never set this variable to nil, for the sake of
271 portability of tables."
279 "Options concerning table import and export in Org-mode."
284 "Default export parameters for `org-table-export'.
285 These can be overridden for a specific table by setting the
286 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
287 radio tables for the different export transformations and
288 available parameters."
324 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
325 ;; 1 2 3 4 5
336 "Is this a table line colgroup information?"
340 line)
342 nil
349 "Is this a table line with only alignment/width cookies?"
362 s))))
371 "Use the table.el package to insert a new table.
372 If there is already a table at point, convert between Org-mode tables
373 and table.el tables."
387 "Convert region to table, or create an empty table.
388 If there is an active region, convert it to a table, using the function
389 `org-table-convert-region'. See the documentation of that function
390 to learn how the prefix argument is interpreted to determine the field
391 separator.
392 If there is no such region, create an empty table with `org-table-create'."
399 "Query for a size and insert a table skeleton.
419 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
423 ;; Insert a hline after the first row.
431 "Convert region to a table.
432 The region goes from BEG0 to END0, but these borders will be moved
433 slightly, to make sure a beginning of line in the first line is included.
435 SEPARATOR specifies the field separator in the lines. It can have the
436 following values:
438 '(4) Use the comma as a field separator
439 '(16) Use a TAB as field separator
440 integer When a number, use that many spaces as field separator
441 nil When nil, the command tries to be smart and figure out the
442 separator in the following way:
443 - when each line contains a TAB, assume TAB-separated material
444 - when each line contains a comma, assume CSV material
445 - else, assume one or more SPACE characters as separator."
449 re)
456 ;; Get the right field separator
467 ;; parse the csv stuff
489 "Import FILE as a table.
490 The file is assumed to be tab-separated. Such files can be produced by most
491 spreadsheet and database applications. If no tabs (at least one per line)
492 are found, lines will be split on whitespace into fields."
504 "Export table to a file, with configurable format.
505 Such a file can be imported into a spreadsheet program like Excel.
506 FILE can be the output file name. If not given, it will be taken from
507 a TABLE_EXPORT_FILE property in the current entry or higher up in the
508 hierarchy, or the user will be prompted for a file name.
509 FORMAT can be an export format, of the same kind as it used when
510 `orgtbl-mode' sends a table in a different format. The default format can
511 be found in the variable `org-table-export-default-format', but the function
512 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
513 property, locally or anywhere up in the hierarchy."
530 buf deffmt-readable)
549 "Format: "
554 deffmt-readable)))
567 'hline
570 skipcols i0)))
571 lines))
575 skipcols i0))
578 skipcols i0)))
595 "Marker at the beginning of the table last aligned.
598 "Marker at the end of the table last aligned.
601 "List of flags for flushright alignment, from the last re-alignment.
604 "List of max width of fields in each column.
607 "Non-nil means debug table formulas.
620 "Align the table at point by aligning all vertical bars."
623 ;; Limits of table
626 ;; Current cursor position
632 column
634 rfmt hfmt
642 emptystrings links dates emph raise narrow
643 falign falign1 fmax f1 len c e space)
646 ;; Check if we have links or dates
658 ;; Make sure the link properties are right
660 ;; Make sure the date properties are right
665 ;; Check if we are narrowing any columns
668 org-format-transports-properties-p
673 ;; Get the rows
676 ;; Store the indentation of the first line
679 ;; Mark the hlines by setting the corresponding element to nil
680 ;; At the same time, we remove trailing space.
683 nil
686 l)))
687 lines))
688 ;; Get the data fields by splitting the lines.
693 ;; How many fields in the longest line?
700 ;; A list of empty strings to fill any short rows on output
702 ;; Check for special formatting.
706 ;; Check if there is an explicit width specified
716 ;; Find fields that are wider than fmax, and shorten them
722 'help-echo
723 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
731 xx)))))
732 ;; Get the maximum width for each column
734 lengths)
735 ;; Get the fraction of numbers, to decide about alignment of the column
741 nil
748 ;; Store the alignment of this table, for later editing of single fields
750 org-table-last-column-widths lengths)
752 ;; With invisible characters, `format' does not get the field width right
753 ;; So we need to make these fields wide by hand.
771 ;; Compute the formats needed for output of the table
784 hfmt))
787 ;; This hack is for org-indent, to force redisplay of the
788 ;; line prefix of the first line. Apparently the redisplay
789 ;; is tied to the newline, which is, I think, a bug.
790 ;; To force this redisplay, we remove and re-insert the
791 ;; newline, so that the redisplay engine thinks it belongs
792 ;; to the changed text.
798 ;; Replace the old one
805 ;; Try to move to the old location
813 ))
816 "Find the beginning of the table and return its position.
817 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
821 org-table-border-regexp)
822 nil t))
829 "Find the end of the table and return its position.
830 With argument TABLE-TYPE, go to the end of a table.el-type table."
834 org-table-border-regexp)
835 nil t))
841 "Justify the current field, text to left, number to right.
842 Optional argument NEW may specify text to replace the current field content."
851 ;; This is not the same table, force a full re-align
857 l f n o e)
881 "Go to the next field in the current table, creating new lines as needed.
882 Before doing so, re-align the table if necessary."
887 org-table-may-need-update)
898 org-table-tab-jumps-over-hlines
910 "Go to the previous field in the table.
911 Before doing so, re-align the table if necessary."
916 org-table-may-need-update)
931 "Move to the end of the current table field.
932 If already at or after the end, move to the end of the next table field.
933 With numeric argument N, move N-1 fields forward first."
946 "Move to the beginning of the current table field.
947 If already at or before the beginning, move to the beginning of the
948 previous field.
949 With numeric argument N, move N-1 fields backward first."
963 "Go to the next row (same column) in the current table.
964 Before doing so, re-align the table if necessary."
972 org-table-may-need-update)
986 "Copy a field down in the current column.
987 If the field at the cursor is empty, copy into it the content of the nearest
988 non-empty field above. With argument N, use the Nth non-empty field.
989 If the current field is not empty, it is copied down to the next row, and
990 the cursor is moved with it. Therefore, repeating this command causes the
991 column to be filled row-by-row.
992 If the variable `org-table-copy-increment' is non-nil and the field is an
993 integer or a timestamp, it will be incremented while copying. In the case of
994 a timestamp, if the cursor is on the year, change the year. If it is on the
995 month or the day, change that. Point will stay on the current date field
996 in order to easily repeat the interval."
1004 txt)
1016 beg t))
1039 "Is point inside a table data field?
1040 I.e. not on a hline or before the first or after the last column?
1041 This actually throws an error, so it aborts the current command."
1052 "Get the field in table line LINE, column COLUMN.
1053 If LINE is larger than the number of data lines in the table, the function
1054 returns nil. However, if COLUMN is too large, we will simply return an
1055 empty string.
1056 If LINE is nil, use the current line.
1057 If column is nil, use the current column."
1064 "Put VALUE into line LINE, column COLUMN.
1065 When ALIGN is set, also realign the table."
1074 "Return the index of the current data line."
1081 cnt))
1084 "Go to the Nth data line in the current table.
1085 Return t when the line exists, nil if it does not exist."
1093 "Blank the current table field or active region."
1110 "Return the value of the field in column N of current row.
1111 N defaults to current field.
1112 If REPLACE is a string, replace field with this value. The return value
1113 is always the old value."
1123 val)
1127 "Show info about the current field, and highlight any reference at point."
1135 org-table-named-field-locations)))
1148 dline col
1150 dline col ref1
1152 ;; FIXME: formula info not correct if special table line
1162 "Find out which column we are in."
1171 cnt)))
1174 "Find out what table data line we are in.
1175 Only data lines count for this."
1185 cnt)))
1188 "Move the cursor to the Nth column in the current table line.
1189 With optional argument ON-DELIM, stop with point before the left delimiter
1190 of the field.
1191 If there are less than N fields, just go to after the last delimiter.
1192 However, when FORCE is non-nil, create new columns if necessary."
1202 t)))))
1210 "Insert a new column into the table."
1218 ;; Current cursor position
1224 nil
1236 "Find a data line in the current table, which is needed for column commands."
1239 t
1250 t
1255 "Delete a column from the table."
1264 ;; Current cursor position
1270 nil
1285 "Move column to the right."
1289 "Move column to the left."
1294 "Move the current column to the right. With arg LEFT, move to the left."
1304 ;; Current cursor position
1314 nil
1331 "Move table row down."
1335 "Move table row up."
1340 "Move the current table line down. With arg UP, move it up."
1349 txt hline2p)
1370 "Insert a new row above the current line into the table.
1371 With prefix ARG, insert below the current line."
1377 ;; Fix the first field if necessary
1389 "Insert a horizontal-line below the current line into the table.
1390 With prefix ABOVE, insert above the current line."
1412 "Insert a hline and move to the row below that line."
1426 In particular, this does handle wide and invisible characters."
1428 ;; It's a hline, just map the characters
1434 t t s)))
1435 s))
1438 "Delete the current row or horizontal line from the table."
1451 "Sort table lines according to the column at point.
1453 The position of point indicates the column to be used for
1454 sorting, and the range of lines is the range between the nearest
1455 horizontal separator lines, or the entire table of no such lines
1456 exist. If point is before the first column, you will be prompted
1457 for the sorting column. If there is an active region, the mark
1458 specifies the first line and the sorting column, while point
1459 should be in the last line to be included into the sorting.
1461 The command then prompts for the sorting type which can be
1462 alphabetically, numerically, or by time (as given in a time stamp
1463 in the field). Sorting in reverse order is also possible.
1465 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1467 If SORTING-TYPE is specified when this function is called from a Lisp
1468 program, no prompting will take place. SORTING-TYPE must be a character,
1469 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1470 should be done in reverse order."
1474 beg end bcol ecol tend tbeg column lns pos)
1519 x))
1532 "Copy region in table to the clipboard and blank all relevant fields.
1533 If there is no active region, use just the field at point."
1540 "Copy rectangular region in table to clipboard.
1541 A special clipboard is used which can only be accessed
1542 with `org-table-paste-rectangle'."
1546 current-prefix-arg))
1548 region cols
1574 org-table-clip))
1577 "Paste a rectangular region into a table.
1578 The upper right corner ends up in the current field. All involved fields
1579 will be overwritten. If the rectangle does not fit into the present table,
1580 the table is enlarged as needed. The process ignores horizontal separator
1581 lines."
1591 c cols field)
1607 "Convert from `org-mode' table to table.el and back.
1608 Obviously, this only works within limits. When an Org-mode table is
1609 converted to table.el, all horizontal separator lines get lost, because
1610 table.el uses these as cell boundaries and has no notion of horizontal lines.
1611 A table.el table can be converted to an Org-mode table only if it does not
1612 do row or column spanning. Multiline cells will become multiple cells.
1613 Beware, Org-mode does not test if the table can be successfully converted - it
1614 blindly applies a recipe that works for simple tables."
1618 ;; convert to Org-mode table
1627 ;; convert to table.el table
1630 ;; first, get rid of all horizontal lines
1634 ;; insert a hline before first
1638 ;; insert a hline after each line
1643 ;; replace "+" at beginning and ending of hlines
1652 "Wrap several fields in a column like a paragraph.
1653 This is useful if you'd like to spread the contents of a field over several
1654 lines, in order to keep the table compact.
1656 If there is an active region, and both point and mark are in the same column,
1657 the text in the column is wrapped to minimum width for the given number of
1658 lines. Generally, this makes the table more compact. A prefix ARG may be
1660 formats the selected text to two lines. If the region was longer than two
1661 lines, the remaining lines remain empty. A negative prefix argument reduces
1662 the current number of lines by that amount. The wrapped text is pasted back
1663 into the table. If you formatted it to more lines than it was before, fields
1664 further down in the table get overwritten - so you might need to make space in
1665 the table first.
1667 If there is no region, the current field is split at the cursor position and
1668 the text fragment to the right of the cursor is prepended to the field one
1669 line down.
1671 If there is no region, but you specify a prefix ARG, the current field gets
1672 blank, and the content is appended to the field above."
1676 ;; There is a region: fill as a paragraph
1680 nlines)
1687 arg)
1691 nil nlines)))
1695 ;; No region, split the current field at point
1699 ;; combine with field above
1709 ;; split field
1722 "Edit table field in a different window.
1723 This is mainly useful for fields that contain hidden parts.
1725 it can be edited in place."
1731 display t intangible t))
1737 p)
1746 intangible t))
1754 "Finish editing a table data field.
1755 Remove all newline characters, insert the result into the table, realign
1756 the table and kill the editing buffer."
1760 text)
1779 "Sum numbers in region of current table column.
1780 The result will be displayed in the echo area, and will be available
1783 If there is an active region, it is interpreted as a rectangle and all
1784 numbers in that rectangle will be summed. If there is no active
1785 region and point is located in a table column, sum all numbers in that
1786 column.
1788 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1789 numbers are assumed to be times as well (in decimal hours) and the
1790 numbers are added as such.
1792 If NLAST is a number, only the NLAST fields will actually be summed."
1819 items1)))
1826 s diff)
1834 sres))))
1857 "Return the formula active for the current field.
1858 Assumes that specials are in place.
1859 If KEY is given, return the key to this formula.
1863 org-table-named-field-locations)))
1877 "Read a formula from the minibuffer, offer stored formula as default.
1878 When NAMED is non-nil, look for a named equation."
1882 org-table-named-field-locations)))
1889 name
1890 ref)
1900 stored)
1902 equation)
1909 scol))
1911 'org-table-formula-history
1912 )))))
1913 mustsave)
1915 ;; remove formula
1922 ;; We set the column equation, delete the named one.
1924 mustsave t))
1930 eq))
1933 "Store the list of formulas below the current table."
1939 ;; don't overwrite TBLFM, we might use text properties to store stuff
1960 "Compare two formulas for sorting."
1966 "Return an alist with the stored formulas directly after current table."
1974 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1991 "Modify the equations after the table structure has been edited.
1993 For all numbers larger than LIMIT, shift them by DELTA."
2004 s n a)
2017 t t)))))))))
2020 "Get the column names and local parameters for this table."
2023 names name fields fields1 field cnt
2024 c v l line col types dlines hlines last-dline)
2026 org-table-local-parameters nil
2027 org-table-named-field-locations nil
2028 org-table-current-begin-line nil
2029 org-table-current-begin-pos nil
2030 org-table-current-line-types nil)
2048 org-table-local-parameters))))
2064 ;; Analyse the line types
2068 l org-table-current-begin-line)
2085 al al2)
2097 If yes, store the formula and apply it."
2098 ;; We already know we are in a table. Get field will only return a formula
2099 ;; when appropriate. It might return a separator line, but no problem.
2102 named eq)
2113 "List of commands triggering the recalculation of a line.
2126 "Rotate the recalculation mark in the first column.
2127 If in any row, the first field is not consistent with a mark,
2128 insert a new column for the markers.
2129 When there is an active region, change all the lines in the region,
2130 after prompting for the marking character.
2131 After each change, a message will be displayed indicating the meaning
2132 of the new mark."
2147 epos new)
2154 newchar))
2186 "Recompute the current line if marked for it, and if we haven't just done it."
2206 modes)
2209 suppress-align suppress-const
2210 suppress-store suppress-analysis)
2211 "Replace the table field value at the cursor by the result of a calculation.
2213 This function makes use of Dave Gillespie's Calc package, in my view the
2214 most exciting program ever written for GNU Emacs. So you need to have Calc
2215 installed in order to use this function.
2217 In a table, this command replaces the value in the current field with the
2219 formula, by storing it in a special line below the table. When called
2220 with a `C-u' prefix, the current field must be a named field, and the
2221 formula is installed as valid in only this specific field.
2223 When called with two `C-u' prefixes, insert the active equation
2224 for the field back into the current field, so that it can be
2226 to check the referenced fields.
2228 When called, the command first prompts for a formula, which is read in
2229 the minibuffer. Previously entered formulas are available through the
2230 history list, and the last used formula is offered as a default.
2231 These stored formulas are adapted correctly when moving, inserting, or
2232 deleting columns with the corresponding commands.
2234 The formula can be any algebraic expression understood by the Calc package.
2235 For details, see the Org-mode manual.
2237 This function can also be called from Lisp programs and offers
2238 additional arguments: EQUATION can be the formula to apply. If this
2239 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2240 used to speed-up recursive calls by by-passing unnecessary aligns.
2241 SUPPRESS-CONST suppresses the interpretation of constants in the
2242 formula, assuming that this has been done already outside the function.
2243 SUPPRESS-STORE means the formula should not be stored, either because
2244 it is already stored, or because it is a modified equation that should
2245 not overwrite the stored one."
2261 equation
2267 n form form0 bw fmt x ev orig c lispp literal)
2268 ;; Parse the format string. Since we have a lot of modes, this is
2269 ;; a lot of work. However, I think calc still uses most of the time.
2281 'calc-float-format
2284 n))))
2311 fields)))
2317 ;; Insert row and column number of formula result field
2328 t t form)))
2330 ;; Check for old vertical references
2332 ;; Insert remote references
2340 keep-empty numbers lispp))
2341 t t form)))
2342 ;; Insert complex ranges
2350 keep-empty numbers lispp))
2351 t t form)))
2352 ;; Insert simple ranges
2361 keep-empty numbers lispp))
2362 t t form)))
2364 ;; Insert the references to fields in same row
2373 t t form)))
2388 Orig: %s
2389 $xyz-> %s
2390 @r$c-> %s
2421 prop value)))
2424 "Get a calc vector from a column, according to descriptor DESC.
2425 Optional arguments TBEG and COL can give the beginning of the table and
2426 the current column, to avoid unnecessary parsing.
2427 HIGHLIGHT means just highlight the range."
2434 beg end c1 c2 r1 r2 rangep tmp)
2451 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2457 ;; just one field
2464 ;; A range, return a vector
2465 ;; First sort the numbers to get a regular ractangle
2481 ;; return string representation of calc vector
2486 "Analyze descriptor DESC and retrieve the corresponding line number.
2487 The cursor is currently in line CLINE, the table begins in line BLINE,
2488 and TABLE is a vector with line types."
2496 ;; 1 2 3 4 5 6
2516 nil hn cline desc)))
2519 rel on cline desc)))
2523 "FIXME: Needs more documentation."
2536 nil))
2537 t)))
2541 desc cline)
2542 i)))
2547 s))
2550 "Convert list ELEMENTS to something appropriate to insert into formula.
2551 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2552 NUMBERS indicates that everything should be converted to numbers.
2553 LISPP means to return something appropriate for a Lisp list."
2557 elements
2566 elements))))
2572 x
2578 elements
2582 "Recalculate the current table line by applying all stored formulas.
2583 With prefix arg ALL, do this for all lines in the table.
2584 With the prefix argument ALL is `(16)' \
2586 it is the symbol `iterate', recompute the table until it no longer changes.
2587 If NOALIGN is not nil, do not re-align the table after the computations
2588 are done. This is typically used internally to save time, if it is
2589 known that the table will be realigned a little later anyway."
2604 ;; Insert constants in all formulas
2608 x)
2609 eqlist))
2610 ;; Split the equation list
2621 ;; This is a table with marked lines, compute selected lines
2623 ;; Move forward to the first non-header line
2634 ;; First find the named fields, and mark them untouchable
2646 name)))
2655 ;; Now evaluate the column formulas, but skip fields covered by
2656 ;; field formulas
2660 ;; Unprotected line, recalculate
2672 ;; Now evaluate the field formulas
2686 ;; back to initial position
2694 "Recalculate the table until it does not change anymore."
2699 thistbl)
2714 "Recalculate all tables in the current buffer."
2722 "Iterate all tables in the buffer, to converge inter-table dependencies."
2727 c1
2744 "Replace $const with values in string F."
2746 ;; First, check for column names
2751 ;; Parameters and constants
2753 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2763 f))
2766 "Find the value for a parameter or constant in a formula.
2767 Parameters get priority."
2798 map))
2805 "--"
2808 "--"
2809 "Shift Reference at Point"
2814 "-"
2815 "Change Test Row for Column Formulas"
2818 "--"
2823 org-table-overlay-coordinates)]
2824 "--"
2831 "Edit the formulas of the current table in a separate buffer."
2847 entry s type title)
2850 ;; Keep global-font-lock-mode from turning on font-lock-mode
2890 "Convert a formula from internal to user representation."
2893 s))
2896 "Convert a formula from user to internal representation."
2899 s))
2902 "Convert spreadsheet references from AB7 to @7$28.
2903 Works for single references, but also for entire formulas and even the
2904 full TBLFM line."
2906 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2909 ;; format match, just advance
2914 ;; 3.e5 or something like this.
2917 ;; (member (match-string 1 s)
2918 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2919 )
2920 ;; function name, just advance
2930 t t s)))))
2931 s))
2934 "Convert spreadsheet references from to @7$28 to AB7.
2935 Works for single references, but also for entire formulas and even the
2936 full TBLFM line."
2943 t t s)))
2948 t nil s)))
2949 s)
2952 "Convert a base 26 number represented by letters into an integer.
2953 For example: AB -> 28."
2959 n))
2962 "Convert an integer into a base 26 number represented by letters.
2963 For example: 28 -> AB."
2968 s))
2971 "Convert all references in this buffer, using FUNCTION."
2981 "Convert all references in the buffer from B3 to @3$2 and back."
2991 "Shift the reference at point one row/hline up."
2995 "Shift the reference at point one row/hline down."
2999 "Shift the reference at point one field to the left."
3003 "Shift the reference at point one field to the right."
3014 ;; A B3-like reference
3020 ;; An internal reference
3026 "Re-match the group N, and replace it with the shifted reference."
3031 t t)))
3034 "Shift a reference part REF.
3035 If DECR is set, decrease the references row/column, else increase.
3036 If HLINE is set, this may be a hline reference, it certainly is not
3037 a translation reference."
3066 "Toggle the display of coordinates in the referenced table."
3075 "Parse the buffer for formula definitions and install them.
3076 With prefix ARG, apply the new formulas to the table."
3087 nil t)
3111 "Abort editing formulas, without installing the changes."
3122 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3163 "Show the location/value of the $ expression at point."
3172 var name e what match dest)
3254 ;; column number
3282 org-table-fedit-scroll-down))))
3293 "Make sure the cursor is in a dataline in a table."
3302 p1 p2)))
3307 "Move cursor one line up in the window showing the table."
3312 "Move cursor one line down in the window showing the table."
3317 "Move the cursor in the window showing the table.
3318 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3343 "Add a new overlay."
3349 "Highlight rectangular region in a table."
3353 l1 c1 l2 c2 tmp)
3377 "Remove the rectangle overlays."
3388 "Add overlays to the table at point, to show row/column coordinates."
3417 "Toggle the display of Row/Column numbers in tables."
3429 "Toggle the formula debugger in tables."
3435 ;;; The orgtbl minor mode
3437 ;; Define a minor mode which can be used in other modes in order to
3438 ;; integrate the org-mode table editor.
3440 ;; This is really a hack, because the org-mode table editor uses several
3441 ;; keys which normally belong to the major mode, for example the TAB and
3442 ;; RET keys. Here is how it works: The minor mode defines all the keys
3443 ;; necessary to operate the table editor, but wraps the commands into a
3444 ;; function which tests if the cursor is currently inside a table. If that
3445 ;; is the case, the table editor command is executed. However, when any of
3446 ;; those keys is used outside a table, the function uses `key-binding' to
3447 ;; look up if the key has an associated command in another currently active
3448 ;; keymap (minor modes, major mode, global), and executes that command.
3449 ;; There might be problems if any of the keys used by the table editor is
3450 ;; otherwise used as a prefix key.
3452 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3453 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3454 ;; addresses this by checking explicitly for both bindings.
3456 ;; The optimized version (see variable `orgtbl-optimized') takes over
3457 ;; all keys which are bound to `self-insert-command' in the *global map*.
3458 ;; Some modes bind other commands to simple characters, for example
3459 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3460 ;; active, this binding is ignored inside tables and replaced with a
3461 ;; modified self-insert.
3467 ;;;###autoload
3469 "Unconditionally turn on `orgtbl-mode'."
3484 ;; Install it as a minor mode.
3488 ;;;###autoload
3490 "The `org-mode' table editor as a minor mode for use in other modes."
3495 ;; Exit without error, in case some hook functions calls this
3496 ;; by accident in org-mode.
3500 ;; Make sure we are first in minor-mode-map-alist
3502 ;; FIXME: maybe it should use emulation-mode-map-alists?
3509 auto-fill-inhibit-regexp)
3513 auto-fill-inhibit-regexp)
3514 orgtbl-line-start-regexp))
3532 "Remove all properties related to narrow-column invisibility."
3545 "Create a function for binding in the table minor mode.
3546 FUN is the command to call inside a table. N is used to create a unique
3547 command name. KEYS are keys that should be checked in for a command
3548 to execute outside of tables."
3554 "Outside of tables, run the binding of `"
3566 keys)
3570 "Error when there is no default binding for a table key."
3575 "Setup orgtbl keymaps."
3605 elt key fun cmd)
3613 ;; Special treatment needed for TAB and RET
3633 [(tab)] "\C-i")))
3635 (org-defkey orgtbl-mode-map [backtab]
3637 [backtab] [S-iso-lefttab] [(shift tab)]
3638 [(tab)] "\C-i"))
3640 (org-defkey orgtbl-mode-map "\M-\C-m"
3641 (orgtbl-make-binding 'org-table-wrap-region 105
3642 "\M-\C-m" [(meta return)]))
3643 (org-defkey orgtbl-mode-map [(meta return)]
3644 (orgtbl-make-binding 'org-table-wrap-region 106
3645 [(meta return)] "\M-\C-m"))
3647 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3648 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3650 (when orgtbl-optimized
3651 ;; If the user wants maximum table support, we need to hijack
3652 ;; some standard editing functions
3653 (org-remap orgtbl-mode-map
3654 'self-insert-command 'orgtbl-self-insert-command
3655 'delete-char 'org-delete-char
3656 'delete-backward-char 'org-delete-backward-char)
3657 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3658 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3659 '("OrgTbl"
3660 ["Create or convert" org-table-create-or-convert-from-region
3661 :active (not (org-at-table-p)) :keys "C-c |" ]
3662 "--"
3663 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3664 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3665 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3666 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3667 "--"
3668 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3669 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3670 ["Copy Field from Above"
3671 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3672 "--"
3673 ("Column"
3674 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3675 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3676 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3677 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3678 ("Row"
3679 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3680 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3681 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3682 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3683 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3684 "--"
3685 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3686 ("Rectangle"
3687 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3688 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3689 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3690 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3691 "--"
3692 ("Radio tables"
3693 ["Insert table template" orgtbl-insert-radio-table
3694 (assq major-mode orgtbl-radio-table-templates)]
3695 ["Comment/uncomment table" orgtbl-toggle-comment t])
3696 "--"
3697 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3698 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3699 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3700 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3701 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3702 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3703 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3704 ["Sum Column/Rectangle" org-table-sum
3705 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3706 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3707 ["Debug Formulas"
3708 org-table-toggle-formula-debugger :active (org-at-table-p)
3709 :keys "C-c {"
3710 :style toggle :selected org-table-formula-debug]
3711 ["Show Col/Row Numbers"
3712 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3713 :keys "C-c }"
3714 :style toggle :selected org-table-overlay-coordinates]
3715 ))
3716 t))
3718 (defun orgtbl-ctrl-c-ctrl-c (arg)
3719 "If the cursor is inside a table, realign the table.
3720 If it is a table to be sent away to a receiver, do it.
3721 With prefix arg, also recompute table."
3722 (interactive "P")
3723 (let ((pos (point)) action)
3724 (save-excursion
3725 (beginning-of-line 1)
3729 (cond
3730 ((integerp action)
3731 (goto-char action)
3732 (org-table-maybe-eval-formula)
3733 (if arg
3734 (call-interactively 'org-table-recalculate)
3735 (org-table-maybe-recalculate-line))
3736 (call-interactively 'org-table-align)
3737 (when (orgtbl-send-table 'maybe)
3738 (run-hooks 'orgtbl-after-send-table-hook)))
3739 ((eq action 'recalc)
3740 (save-excursion
3741 (beginning-of-line 1)
3743 (if (org-at-table-p)
3744 (org-call-with-arg 'org-table-recalculate t))))
3745 (t (let (orgtbl-mode)
3746 (call-interactively (key-binding "\C-c\C-c")))))))
3748 (defun orgtbl-create-or-convert-from-region (arg)
3749 "Create table or convert region to table, if no conflicting binding.
3750 This installs the table binding `C-c |', but only if there is no
3751 conflicting binding to this key outside orgtbl-mode."
3752 (interactive "P")
3753 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3754 (if cmd
3755 (call-interactively cmd)
3756 (call-interactively 'org-table-create-or-convert-from-region))))
3758 (defun orgtbl-tab (arg)
3759 "Justification and field motion for `orgtbl-mode'."
3760 (interactive "P")
3761 (if arg (org-table-edit-field t)
3762 (org-table-justify-field-maybe)
3763 (org-table-next-field)))
3765 (defun orgtbl-ret ()
3766 "Justification and field motion for `orgtbl-mode'."
3767 (interactive)
3768 (if (bobp)
3769 (newline)
3770 (org-table-justify-field-maybe)
3771 (org-table-next-row)))
3773 (defun orgtbl-self-insert-command (N)
3774 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3775 If the cursor is in a table looking at whitespace, the whitespace is
3776 overwritten, and the table is not marked as requiring realignment."
3777 (interactive "p")
3778 (if (and (org-at-table-p)
3779 (or
3780 (and org-table-auto-blank-field
3781 (member last-command
3782 '(orgtbl-hijacker-command-100
3783 orgtbl-hijacker-command-101
3784 orgtbl-hijacker-command-102
3785 orgtbl-hijacker-command-103
3786 orgtbl-hijacker-command-104
3787 orgtbl-hijacker-command-105
3788 yas/expand))
3789 (org-table-blank-field))
3790 t)
3791 (eq N 1)
3793 (let (org-table-may-need-update)
3794 (goto-char (1- (match-end 0)))
3795 (delete-backward-char 1)
3796 (goto-char (match-beginning 0))
3797 (self-insert-command N))
3798 (setq org-table-may-need-update t)
3799 (let* (orgtbl-mode
3800 a
3801 (cmd (or (key-binding
3802 (or (and (listp function-key-map)
3803 (setq a (assoc last-input-event function-key-map))
3804 (cdr a))
3805 (vector last-input-event)))
3806 'self-insert-command)))
3807 (call-interactively cmd)
3808 (if (and org-self-insert-cluster-for-undo
3809 (eq cmd 'self-insert-command))
3810 (if (not (eq last-command 'orgtbl-self-insert-command))
3811 (setq org-self-insert-command-undo-counter 1)
3812 (if (>= org-self-insert-command-undo-counter 20)
3813 (setq org-self-insert-command-undo-counter 1)
3814 (and (> org-self-insert-command-undo-counter 0)
3815 buffer-undo-list
3816 (not (cadr buffer-undo-list)) ; remove nil entry
3817 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3818 (setq org-self-insert-command-undo-counter
3819 (1+ org-self-insert-command-undo-counter))))))))
3822 "Regular expression matching exponentials as produced by calc.")
3824 (defun orgtbl-export (table target)
3825 (require 'org-exp)
3826 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3828 org-table-last-alignment org-table-last-column-widths
3829 maxcol column)
3830 (if (not (fboundp func))
3831 (error "Cannot export orgtbl table to %s" target))
3832 (setq lines (org-table-clean-before-export lines))
3833 (setq table
3834 (mapcar
3835 (lambda (x)
3836 (if (string-match org-table-hline-regexp x)
3837 'hline
3839 lines))
3840 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3841 table)))
3842 (loop for i from (1- maxcol) downto 0 do
3843 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3844 (setq column (delq nil column))
3845 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3846 (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))
3847 (funcall func table nil)))
3849 (defun orgtbl-gather-send-defs ()
3850 "Gather a plist of :name, :transform, :params for each destination before
3851 a radio table."
3852 (save-excursion
3853 (goto-char (org-table-begin))
3854 (let (rtn)
3855 (beginning-of-line 0)
3856 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3857 (let ((name (org-no-properties (match-string 1)))
3858 (transform (intern (match-string 2)))
3859 (params (if (match-end 3)
3860 (read (concat "(" (match-string 3) ")")))))
3861 (push (list :name name :transform transform :params params)
3862 rtn)
3863 (beginning-of-line 0)))
3864 rtn)))
3866 (defun orgtbl-send-replace-tbl (name txt)
3867 "Find and replace table NAME with TXT."
3868 (save-excursion
3869 (goto-char (point-min))
3870 (unless (re-search-forward
3872 (error "Don't know where to insert translated table"))
3873 (goto-char (match-beginning 0))
3874 (beginning-of-line 2)
3875 (save-excursion
3876 (let ((beg (point)))
3877 (unless (re-search-forward
3878 (concat "END RECEIVE ORGTBL +" name) nil t)
3879 (error "Cannot find end of insertion region"))
3880 (beginning-of-line 1)
3881 (delete-region beg (point))))
3884 ;;;###autoload
3885 (defun org-table-to-lisp (&optional txt)
3886 "Convert the table at point to a Lisp structure.
3887 The structure will be a list. Each item is either the symbol `hline'
3888 for a horizontal separator line, or a list of field values as strings.
3889 The table is taken from the parameter TXT, or from the buffer at point."
3890 (unless txt
3891 (unless (org-at-table-p)
3892 (error "No table at point")))
3893 (let* ((txt (or txt
3894 (buffer-substring-no-properties (org-table-begin)
3895 (org-table-end))))
3898 (mapcar
3899 (lambda (x)
3900 (if (string-match org-table-hline-regexp x)
3901 'hline
3903 lines)))
3905 (defun orgtbl-send-table (&optional maybe)
3906 "Send a transformed version of this table to the receiver position.
3907 With argument MAYBE, fail quietly if no transformation is defined for
3908 this table."
3909 (interactive)
3910 (catch 'exit
3911 (unless (org-at-table-p) (error "Not at a table"))
3912 ;; when non-interactive, we assume align has just happened.
3913 (when (interactive-p) (org-table-align))
3914 (let ((dests (orgtbl-gather-send-defs))
3915 (txt (buffer-substring-no-properties (org-table-begin)
3916 (org-table-end)))
3917 (ntbl 0))
3918 (unless dests (if maybe (throw 'exit nil)
3919 (error "Don't know how to transform this table")))
3920 (dolist (dest dests)
3921 (let* ((name (plist-get dest :name))
3922 (transform (plist-get dest :transform))
3923 (params (plist-get dest :params))
3924 (skip (plist-get params :skip))
3925 (skipcols (plist-get params :skipcols))
3926 beg
3927 (lines (org-table-clean-before-export
3928 (nthcdr (or skip 0)
3930 (i0 (if org-table-clean-did-remove-column 2 1))
3931 (table (mapcar
3932 (lambda (x)
3933 (if (string-match org-table-hline-regexp x)
3934 'hline
3935 (org-remove-by-index
3937 skipcols i0)))
3938 lines))
3939 (fun (if (= i0 2) 'cdr 'identity))
3940 (org-table-last-alignment
3941 (org-remove-by-index (funcall fun org-table-last-alignment)
3942 skipcols i0))
3943 (org-table-last-column-widths
3944 (org-remove-by-index (funcall fun org-table-last-column-widths)
3945 skipcols i0))
3946 (txt (if (fboundp transform)
3947 (funcall transform table params)
3948 (error "No such transformation function %s" transform))))
3949 (orgtbl-send-replace-tbl name txt))
3950 (setq ntbl (1+ ntbl)))
3951 (message "Table converted and installed at %d receiver location%s"
3952 ntbl (if (> ntbl 1) "s" ""))
3953 (if (> ntbl 0)
3954 ntbl
3955 nil))))
3957 (defun org-remove-by-index (list indices &optional i0)
3958 "Remove the elements in LIST with indices in INDICES.
3959 First element has index 0, or I0 if given."
3960 (if (not indices)
3961 list
3962 (if (integerp indices) (setq indices (list indices)))
3963 (setq i0 (1- (or i0 0)))
3964 (delq :rm (mapcar (lambda (x)
3965 (setq i0 (1+ i0))
3966 (if (memq i0 indices) :rm x))
3967 list))))
3969 (defun orgtbl-toggle-comment ()
3970 "Comment or uncomment the orgtbl at point."
3971 (interactive)
3972 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3973 (re2 (concat "^" orgtbl-line-start-regexp))
3974 (commented (save-excursion (beginning-of-line 1)
3975 (cond ((looking-at re1) t)
3976 ((looking-at re2) nil)
3977 (t (error "Not at an org table")))))
3978 (re (if commented re1 re2))
3979 beg end)
3980 (save-excursion
3981 (beginning-of-line 1)
3982 (while (looking-at re) (beginning-of-line 0))
3983 (beginning-of-line 2)
3984 (setq beg (point))
3985 (while (looking-at re) (beginning-of-line 2))
3986 (setq end (point)))
3987 (comment-region beg end (if commented '(4) nil))))
3989 (defun orgtbl-insert-radio-table ()
3990 "Insert a radio table template appropriate for this major mode."
3991 (interactive)
3992 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3993 (txt (nth 1 e))
3994 name pos)
3995 (unless e (error "No radio table setup defined for %s" major-mode))
3996 (setq name (read-string "Table name: "))
3997 (while (string-match "%n" txt)
3998 (setq txt (replace-match name t t txt)))
4000 (setq pos (point))
4001 (insert txt)
4002 (goto-char pos)))
4004 ;; Dynamically bound input and output for table formatting.
4005 (defvar *orgtbl-table* nil
4006 "Carries the current table through formatting routines.")
4007 (defvar *orgtbl-rtn* nil
4008 "Formatting routines push the output lines here.")
4009 ;; Formatting parameters for the current table section.
4010 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4011 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4012 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4013 (defvar *orgtbl-fmt* nil "Format for each entry.")
4014 (defvar *orgtbl-efmt* nil "Format for numbers.")
4015 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4016 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4017 (defvar *orgtbl-lstart* nil "Text starting a row.")
4018 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4019 (defvar *orgtbl-lend* nil "Text ending a row.")
4020 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4022 (defsubst orgtbl-get-fmt (fmt i)
4023 "Retrieve the format from FMT corresponding to the Ith column."
4024 (if (and (not (functionp fmt)) (consp fmt))
4025 (plist-get fmt i)
4026 fmt))
4028 (defsubst orgtbl-apply-fmt (fmt &rest args)
4029 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4030 (cond ((functionp fmt) (apply fmt args))
4031 (fmt (apply 'format fmt args))
4032 (args (car args))
4033 (t args)))
4035 (defsubst orgtbl-eval-str (str)
4036 "If STR is a function, evaluate it with no arguments."
4037 (if (functionp str)
4038 (funcall str)
4039 str))
4041 (defun orgtbl-format-line (line)
4042 "Format LINE as a table row."
4043 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4044 (let* ((i 0)
4045 (line
4046 (mapcar
4047 (lambda (f)
4048 (setq i (1+ i))
4049 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4050 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4051 (orgtbl-apply-fmt efmt (match-string 1 f)
4052 (match-string 2 f))
4053 f)))
4054 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4055 *orgtbl-default-fmt*)
4056 f)))
4057 line)))
4058 (push (if *orgtbl-lfmt*
4059 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4060 (concat (orgtbl-eval-str *orgtbl-lstart*)
4061 (mapconcat 'identity line *orgtbl-sep*)
4062 (orgtbl-eval-str *orgtbl-lend*)))
4063 *orgtbl-rtn*))))
4065 (defun orgtbl-format-section (section-stopper)
4066 "Format lines until the first occurrence of SECTION-STOPPER."
4067 (let (prevline)
4068 (progn
4069 (while (not (eq (car *orgtbl-table*) section-stopper))
4070 (if prevline (orgtbl-format-line prevline))
4071 (setq prevline (pop *orgtbl-table*)))
4072 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4073 (*orgtbl-lend* *orgtbl-llend*)
4074 (*orgtbl-lfmt* *orgtbl-llfmt*))
4075 (orgtbl-format-line prevline))))))
4077 (defun orgtbl-to-generic (table params)
4078 "Convert the orgtbl-mode TABLE to some other format.
4079 This generic routine can be used for many standard cases.
4080 TABLE is a list, each entry either the symbol `hline' for a horizontal
4081 separator line, or a list of fields for that line.
4082 PARAMS is a property list of parameters that can influence the conversion.
4083 For the generic converter, some parameters are obligatory: You need to
4084 specify either :lfmt, or all of (:lstart :lend :sep).
4086 Valid parameters are
4088 :splice When set to t, return only table body lines, don't wrap
4089 them into :tstart and :tend. Default is nil. When :splice
4090 is non-nil, this also means that the exporter should not look
4091 for and interpret header and footer sections.
4093 :hline String to be inserted on horizontal separation lines.
4094 May be nil to ignore hlines.
4096 :sep Separator between two fields
4097 :remove-nil-lines Do not include lines that evaluate to nil.
4100 Each in the following group may be either a string or a function
4101 of no arguments returning a string:
4102 :tstart String to start the table. Ignored when :splice is t.
4103 :tend String to end the table. Ignored when :splice is t.
4104 :lstart String to start a new table line.
4105 :llstart String to start the last table line, defaults to :lstart.
4106 :lend String to end a table line
4107 :llend String to end the last table line, defaults to :lend.
4109 Each in the following group may be a string, a function of one
4110 argument (the field or line) returning a string, or a plist
4111 mapping columns to either of the above:
4112 :lfmt Format for entire line, with enough %s to capture all fields.
4113 If this is present, :lstart, :lend, and :sep are ignored.
4114 :llfmt Format for the entire last line, defaults to :lfmt.
4115 :fmt A format to be used to wrap the field, should contain
4116 %s for the original field value. For example, to wrap
4118 This may also be a property list with column numbers and
4121 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4122 Same as above, specific for the header lines in the table.
4123 All lines before the first hline are treated as header.
4124 If any of these is not present, the data line value is used.
4126 This may be either a string or a function of two arguments:
4127 :efmt Use this format to print numbers with exponentials.
4128 The format should have %s twice for inserting mantissa
4130 may also be a property list with column numbers and
4131 formats. :fmt will still be applied after :efmt.
4133 In addition to this, the parameters :skip and :skipcols are always handled
4134 directly by `orgtbl-send-table'. See manual."
4135 (interactive)
4137 (let* ((splicep (plist-get params :splice))
4138 (hline (plist-get params :hline))
4139 (remove-nil-linesp (plist-get params :remove-nil-lines))
4140 (remove-newlines (plist-get params :remove-newlines))
4141 (*orgtbl-hline* hline)
4142 (*orgtbl-table* table)
4143 (*orgtbl-sep* (plist-get params :sep))
4144 (*orgtbl-efmt* (plist-get params :efmt))
4145 (*orgtbl-lstart* (plist-get params :lstart))
4146 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4147 (*orgtbl-lend* (plist-get params :lend))
4148 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4149 (*orgtbl-lfmt* (plist-get params :lfmt))
4150 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4151 (*orgtbl-fmt* (plist-get params :fmt))
4152 *orgtbl-rtn*)
4154 ;; Put header
4155 (unless splicep
4156 (when (plist-member params :tstart)
4157 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4158 (if tstart (push tstart *orgtbl-rtn*)))))
4160 ;; Do we have a heading section? If so, format it and handle the
4161 ;; trailing hline.
4162 (if (and (not splicep)
4163 (or (consp (car *orgtbl-table*))
4164 (consp (nth 1 *orgtbl-table*)))
4165 (memq 'hline (cdr *orgtbl-table*)))
4166 (progn
4167 (when (eq 'hline (car *orgtbl-table*))
4168 ;; there is a hline before the first data line
4169 (and hline (push hline *orgtbl-rtn*))
4170 (pop *orgtbl-table*))
4171 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4172 *orgtbl-lstart*))
4173 (*orgtbl-llstart* (or (plist-get params :hllstart)
4174 *orgtbl-llstart*))
4175 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4176 (*orgtbl-llend* (or (plist-get params :hllend)
4177 (plist-get params :hlend) *orgtbl-llend*))
4178 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4179 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4180 (plist-get params :hlfmt) *orgtbl-llfmt*))
4181 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4182 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4183 (orgtbl-format-section 'hline))
4184 (if hline (push hline *orgtbl-rtn*))
4185 (pop *orgtbl-table*)))
4187 ;; Now format the main section.
4188 (orgtbl-format-section nil)
4190 (unless splicep
4191 (when (plist-member params :tend)
4192 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4193 (if tend (push tend *orgtbl-rtn*)))))
4195 (mapconcat (if remove-newlines
4196 (lambda (tend)
4198 'identity)
4199 (nreverse (if remove-nil-linesp
4200 (remq nil *orgtbl-rtn*)
4203 (defun orgtbl-to-tsv (table params)
4204 "Convert the orgtbl-mode table to TAB separated material."
4206 (defun orgtbl-to-csv (table params)
4207 "Convert the orgtbl-mode table to CSV material.
4208 This does take care of the proper quoting of fields with comma or quotes."
4209 (orgtbl-to-generic table (org-combine-plists
4210 '(:sep "," :fmt org-quote-csv-field)
4211 params)))
4213 (defun orgtbl-to-latex (table params)
4214 "Convert the orgtbl-mode TABLE to LaTeX.
4215 TABLE is a list, each entry either the symbol `hline' for a horizontal
4216 separator line, or a list of fields for that line.
4217 PARAMS is a property list of parameters that can influence the conversion.
4218 Supports all parameters from `orgtbl-to-generic'. Most important for
4219 LaTeX are:
4221 :splice When set to t, return only table body lines, don't wrap
4222 them into a tabular environment. Default is nil.
4224 :fmt A format to be used to wrap the field, should contain %s for the
4225 original field value. For example, to wrap everything in dollars,
4228 The format may also be a function that formats its one argument.
4230 :efmt Format for transforming numbers with exponentials. The format
4231 should have %s twice for inserting mantissa and exponent, for
4233 This may also be a property list with column numbers and formats.
4234 The format may also be a function that formats its two arguments.
4236 :llend If you find too much space below the last line of a table,
4239 The general parameters :skip and :skipcols have already been applied when
4240 this function is called."
4241 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4242 org-table-last-alignment ""))
4243 (params2
4244 (list
4249 (orgtbl-to-generic table (org-combine-plists params2 params))))
4251 (defun orgtbl-to-html (table params)
4252 "Convert the orgtbl-mode TABLE to HTML.
4253 TABLE is a list, each entry either the symbol `hline' for a horizontal
4254 separator line, or a list of fields for that line.
4255 PARAMS is a property list of parameters that can influence the conversion.
4256 Currently this function recognizes the following parameters:
4258 :splice When set to t, return only table body lines, don't wrap
4259 them into a <table> environment. Default is nil.
4261 The general parameters :skip and :skipcols have already been applied when
4262 this function is called. The function does *not* use `orgtbl-to-generic',
4263 so you cannot specify parameters for it."
4264 (let* ((splicep (plist-get params :splice))
4265 (html-table-tag org-export-html-table-tag)
4266 html)
4267 ;; Just call the formatter we already have
4268 ;; We need to make text lines for it, so put the fields back together.
4269 (setq html (org-format-org-table-html
4270 (mapcar
4271 (lambda (x)
4272 (if (eq x 'hline)
4273 "|----+----|"
4274 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4275 table)
4276 splicep))
4278 (setq html (replace-match "" t t html)))
4279 html))
4281 (defun orgtbl-to-texinfo (table params)
4282 "Convert the orgtbl-mode TABLE to TeXInfo.
4283 TABLE is a list, each entry either the symbol `hline' for a horizontal
4284 separator line, or a list of fields for that line.
4285 PARAMS is a property list of parameters that can influence the conversion.
4286 Supports all parameters from `orgtbl-to-generic'. Most important for
4287 TeXInfo are:
4289 :splice nil/t When set to t, return only table body lines, don't wrap
4290 them into a multitable environment. Default is nil.
4292 :fmt fmt A format to be used to wrap the field, should contain
4293 %s for the original field value. For example, to wrap
4295 This may also be a property list with column numbers and
4297 Each format also may be a function that formats its one
4298 argument.
4301 are computed automatically from the width of the columns
4302 under org-mode.
4304 The general parameters :skip and :skipcols have already been applied when
4305 this function is called."
4306 (let* ((total (float (apply '+ org-table-last-column-widths)))
4307 (colfrac (or (plist-get params :cf)
4308 (mapconcat
4309 (lambda (x) (format "%.3f" (/ (float x) total)))
4310 org-table-last-column-widths " ")))
4311 (params2
4312 (list
4313 :tstart (concat "@multitable @columnfractions " colfrac)
4314 :tend "@end multitable"
4315 :lstart "@item " :lend "" :sep " @tab "
4316 :hlstart "@headitem ")))
4317 (orgtbl-to-generic table (org-combine-plists params2 params))))
4319 (defun orgtbl-to-orgtbl (table params)
4320 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4321 Useful when slicing one table into many. The :hline, :sep,
4322 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4323 and :tend suppress strings without splicing; they can be set to
4324 provide ORGTBL directives for the generated table."
4325 (let* ((params2
4326 (list
4327 :remove-newlines t
4328 :tstart nil :tend nil
4329 :hline "|---"
4330 :sep " | "
4331 :lstart "| "
4332 :lend " |"))
4333 (params (org-combine-plists params2 params)))
4334 (orgtbl-to-generic table params)))
4336 (defun org-table-get-remote-range (name-or-id form)
4337 "Get a field value or a list of values in a range from table at ID.
4339 NAME-OR-ID may be the name of a table in the current file as set by
4341 will then be used. Alternatively, it may be an ID referring to
4342 any entry, also in a different file. In this case, the first table
4343 in that entry will be referenced.
4347 The return value is either a single string for a single field, or a
4348 list of the fields in the rectangle ."
4349 (save-match-data
4350 (let ((id-loc nil)
4351 org-table-column-names org-table-column-name-regexp
4352 org-table-local-parameters org-table-named-field-locations
4353 org-table-current-line-types org-table-current-begin-line
4354 org-table-current-begin-pos org-table-dlines
4355 org-table-hlines org-table-last-alignment
4356 org-table-last-column-widths org-table-last-alignment
4357 org-table-last-column-widths tbeg
4358 buffer loc)
4359 (setq form (org-table-convert-refs-to-rc form))
4360 (save-excursion
4361 (save-restriction
4362 (widen)
4363 (save-excursion
4364 (goto-char (point-min))
4365 (if (re-search-forward
4367 nil t)
4368 (setq buffer (current-buffer) loc (match-beginning 0))
4369 (setq id-loc (org-id-find name-or-id 'marker))
4370 (unless (and id-loc (markerp id-loc))
4372 (setq buffer (marker-buffer id-loc)
4373 loc (marker-position id-loc))
4374 (move-marker id-loc nil)))
4375 (with-current-buffer buffer
4376 (save-excursion
4377 (save-restriction
4378 (widen)
4379 (goto-char loc)
4380 (forward-char 1)
4382 (not (match-beginning 1)))
4383 (error "Cannot find a table at NAME or ID %s" name-or-id))
4384 (setq tbeg (point-at-bol))
4385 (org-table-get-specials)
4386 (setq form (org-table-formula-substitute-names form))
4387 (if (and (string-match org-table-range-regexp form)
4388 (> (length (match-string 0 form)) 1))
4389 (save-match-data
4390 (org-table-get-range (match-string 0 form) tbeg 1))
4391 form)))))))))
4393 (provide 'org-table)
4396 ;;; org-table.el ends here