| blob | 54bc3aef99ec03390037368acfa87ba8a2d60a24 |
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.5
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 "Whether the user should confirm when Org fixes formulas."
173 'safe-local-variable
177 "Non-nil means tab in the last column of a table with jump over a hline.
178 If a horizontal separator line is following the current line,
179 `org-table-next-field' can either create a new row before that line, or jump
180 over the line. When this option is nil, a new line will be created before
181 this line."
186 "Options concerning tables in Org-mode."
191 "Should org-mode work with table references like B3 instead of @3$2?
192 Possible values are:
193 nil never use them
194 from accept as input, do not present for editing
195 t accept as input and present for editing"
210 calc-angle-mode deg
211 calc-prefer-frac nil
212 calc-symbolic-mode nil
214 calc-display-working-message t
215 )
216 "List with Calc mode settings for use in `calc-eval' for table formulas.
217 The list must contain alternating symbols (Calc modes variables and values).
218 Don't remove any of the default settings, just change the values. Org-mode
219 relies on the variables to be present in the list."
224 "Non-nil means TAB and RET evaluate a formula in current table field.
225 If the current field starts with an equal sign, it is assumed to be a formula
226 which should be evaluated as described in the manual and in the documentation
227 string of the command `org-table-eval-formula'. This feature requires the
228 Emacs calc package.
229 When this variable is nil, formula calculation is only available through
235 "Non-nil means interpret constants in formulas in tables.
236 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
237 by the value given in `org-table-formula-constants', or by a value obtained
238 from the `constants.el' package."
243 "Alist with constant names and values, for use in table formulas.
244 The car of each element is a name of a constant, without the `$' before it.
245 The cdr is the value as a string. For example, if you'd like to use the
246 speed of light in a formula, you would configure
250 and then use it in an equation like `$1*$c'.
252 Constants can also be defined on a per-file basis using a line like
254 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
261 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
262 Automatically means when TAB or RET or C-c C-c are pressed in the line."
267 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
272 "Non-nil means relative formula references may cross hlines.
273 Here are the allowed values:
275 nil Relative references may not cross hlines. They will reference the
276 field next to the hline instead. Coming from below, the reference
277 will be to the field below the hline. Coming from above, it will be
278 to the field above.
279 t Relative references may cross hlines.
280 error An attempt to cross a hline will throw an error.
282 It is probably good to never set this variable to nil, for the sake of
283 portability of tables."
291 "Options concerning table import and export in Org-mode."
296 "Default export parameters for `org-table-export'.
297 These can be overridden for a specific table by setting the
298 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
299 radio tables for the different export transformations and
300 available parameters."
338 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
339 ;; 1 2 3 4 5
350 "Is this a table line colgroup information?"
354 line)
356 nil
363 "Is this a table line with only alignment/width cookies?"
376 s))))
385 "Use the table.el package to insert a new table.
386 If there is already a table at point, convert between Org-mode tables
387 and table.el tables."
401 "Convert region to table, or create an empty table.
402 If there is an active region, convert it to a table, using the function
403 `org-table-convert-region'. See the documentation of that function
404 to learn how the prefix argument is interpreted to determine the field
405 separator.
406 If there is no such region, create an empty table with `org-table-create'."
413 "Query for a size and insert a table skeleton.
433 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
437 ;; Insert a hline after the first row.
445 "Convert region to a table.
446 The region goes from BEG0 to END0, but these borders will be moved
447 slightly, to make sure a beginning of line in the first line is included.
449 SEPARATOR specifies the field separator in the lines. It can have the
450 following values:
452 '(4) Use the comma as a field separator
453 '(16) Use a TAB as field separator
454 integer When a number, use that many spaces as field separator
455 nil When nil, the command tries to be smart and figure out the
456 separator in the following way:
457 - when each line contains a TAB, assume TAB-separated material
458 - when each line contains a comma, assume CSV material
459 - else, assume one or more SPACE characters as separator."
463 re)
470 ;; Get the right field separator
481 ;; parse the csv stuff
503 "Import FILE as a table.
504 The file is assumed to be tab-separated. Such files can be produced by most
505 spreadsheet and database applications. If no tabs (at least one per line)
506 are found, lines will be split on whitespace into fields."
518 "Export table to a file, with configurable format.
519 Such a file can be imported into a spreadsheet program like Excel.
520 FILE can be the output file name. If not given, it will be taken from
521 a TABLE_EXPORT_FILE property in the current entry or higher up in the
522 hierarchy, or the user will be prompted for a file name.
523 FORMAT can be an export format, of the same kind as it used when
524 `orgtbl-mode' sends a table in a different format. The default format can
525 be found in the variable `org-table-export-default-format', but the function
526 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
527 property, locally or anywhere up in the hierarchy."
539 buf deffmt-readable)
558 "Format: "
563 deffmt-readable)))
576 'hline
579 skipcols i0)))
580 lines))
584 skipcols i0))
587 skipcols i0)))
604 "Marker at the beginning of the table last aligned.
607 "Marker at the end of the table last aligned.
610 "List of flags for flushright alignment, from the last re-alignment.
613 "List of max width of fields in each column.
616 "Non-nil means debug table formulas.
629 "Align the table at point by aligning all vertical bars."
632 ;; Limits of table
635 ;; Current cursor position
641 column
643 rfmt hfmt
651 emptystrings links dates emph raise narrow
652 falign falign1 fmax f1 len c e space)
655 ;; Check if we have links or dates
667 ;; Make sure the link properties are right
669 ;; Make sure the date properties are right
674 ;; Check if we are narrowing any columns
677 org-format-transports-properties-p
682 ;; Get the rows
685 ;; Store the indentation of the first line
688 ;; Mark the hlines by setting the corresponding element to nil
689 ;; At the same time, we remove trailing space.
692 nil
695 l)))
696 lines))
697 ;; Get the data fields by splitting the lines.
702 ;; How many fields in the longest line?
709 ;; A list of empty strings to fill any short rows on output
711 ;; Check for special formatting.
715 ;; Check if there is an explicit width specified
725 ;; Find fields that are wider than fmax, and shorten them
731 'help-echo
732 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
740 xx)))))
741 ;; Get the maximum width for each column
743 lengths)
744 ;; Get the fraction of numbers, to decide about alignment of the column
750 nil
757 ;; Store the alignment of this table, for later editing of single fields
759 org-table-last-column-widths lengths)
761 ;; With invisible characters, `format' does not get the field width right
762 ;; So we need to make these fields wide by hand.
780 ;; Compute the formats needed for output of the table
793 hfmt))
796 ;; This hack is for org-indent, to force redisplay of the
797 ;; line prefix of the first line. Apparently the redisplay
798 ;; is tied to the newline, which is, I think, a bug.
799 ;; To force this redisplay, we remove and re-insert the
800 ;; newline, so that the redisplay engine thinks it belongs
801 ;; to the changed text.
807 ;; Replace the old one
814 ;; Try to move to the old location
822 ))
825 "Find the beginning of the table and return its position.
826 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
830 org-table-border-regexp)
831 nil t))
838 "Find the end of the table and return its position.
839 With argument TABLE-TYPE, go to the end of a table.el-type table."
843 org-table-border-regexp)
844 nil t))
850 "Justify the current field, text to left, number to right.
851 Optional argument NEW may specify text to replace the current field content."
860 ;; This is not the same table, force a full re-align
866 l f n o e)
890 "Go to the next field in the current table, creating new lines as needed.
891 Before doing so, re-align the table if necessary."
896 org-table-may-need-update)
907 org-table-tab-jumps-over-hlines
919 "Go to the previous field in the table.
920 Before doing so, re-align the table if necessary."
925 org-table-may-need-update)
940 "Move to the end of the current table field.
941 If already at or after the end, move to the end of the next table field.
942 With numeric argument N, move N-1 fields forward first."
955 "Move to the beginning of the current table field.
956 If already at or before the beginning, move to the beginning of the
957 previous field.
958 With numeric argument N, move N-1 fields backward first."
972 "Go to the next row (same column) in the current table.
973 Before doing so, re-align the table if necessary."
981 org-table-may-need-update)
995 "Copy a field down in the current column.
996 If the field at the cursor is empty, copy into it the content of
997 the nearest non-empty field above. With argument N, use the Nth
998 non-empty field. If the current field is not empty, it is copied
999 down to the next row, and the cursor is moved with it.
1000 Therefore, repeating this command causes the column to be filled
1001 row-by-row.
1002 If the variable `org-table-copy-increment' is non-nil and the
1003 field is an integer or a timestamp, it will be incremented while
1004 copying. In the case of a timestamp, increment by one day."
1012 txt)
1024 beg t))
1047 "Is point inside a table data field?
1048 I.e. not on a hline or before the first or after the last column?
1049 This actually throws an error, so it aborts the current command."
1060 "Get the field in table line LINE, column COLUMN.
1061 If LINE is larger than the number of data lines in the table, the function
1062 returns nil. However, if COLUMN is too large, we will simply return an
1063 empty string.
1064 If LINE is nil, use the current line.
1065 If column is nil, use the current column."
1072 "Put VALUE into line LINE, column COLUMN.
1073 When ALIGN is set, also realign the table."
1082 "Return the index of the current data line."
1089 cnt))
1092 "Go to the Nth data line in the current table.
1093 Return t when the line exists, nil if it does not exist."
1101 "Blank the current table field or active region."
1118 "Return the value of the field in column N of current row.
1119 N defaults to current field.
1120 If REPLACE is a string, replace field with this value. The return value
1121 is always the old value."
1131 val)
1135 "Show info about the current field, and highlight any reference at point."
1143 org-table-named-field-locations)))
1162 dline col
1164 dline col ref1
1166 ;; FIXME: formula info not correct if special table line
1176 "Find out which column we are in."
1185 cnt)))
1188 "Find out what table data line we are in.
1189 Only data lines count for this."
1199 cnt)))
1202 "Move the cursor to the Nth column in the current table line.
1203 With optional argument ON-DELIM, stop with point before the left delimiter
1204 of the field.
1205 If there are less than N fields, just go to after the last delimiter.
1206 However, when FORCE is non-nil, create new columns if necessary."
1216 t)))))
1224 "Insert a new column into the table."
1232 ;; Current cursor position
1238 nil
1252 "Find a data line in the current table, which is needed for column commands."
1255 t
1266 t
1271 "Turn a buffer line number into a data line number.
1272 If there is no data line in this line, return nil.
1273 If there is no matchin dline (most likely te refrence was a hline), the
1274 first dline below it is used. When ABOVE is non-nil, the one above is used."
1277 i)
1290 nil))
1293 "Delete a column from the table."
1302 ;; Current cursor position
1308 nil
1325 "Move column to the right."
1329 "Move column to the left."
1334 "Move the current column to the right. With arg LEFT, move to the left."
1344 ;; Current cursor position
1354 nil
1373 "Move table row down."
1377 "Move table row up."
1382 "Move the current table line down. With arg UP, move it up."
1391 txt hline2p)
1415 "Insert a new row above the current line into the table.
1416 With prefix ARG, insert below the current line."
1422 ;; Fix the first field if necessary
1436 "Insert a horizontal-line below the current line into the table.
1437 With prefix ABOVE, insert above the current line."
1459 "Insert a hline and move to the row below that line."
1473 In particular, this does handle wide and invisible characters."
1475 ;; It's a hline, just map the characters
1481 t t s)))
1482 s))
1485 "Delete the current row or horizontal line from the table."
1500 "Sort table lines according to the column at point.
1502 The position of point indicates the column to be used for
1503 sorting, and the range of lines is the range between the nearest
1504 horizontal separator lines, or the entire table of no such lines
1505 exist. If point is before the first column, you will be prompted
1506 for the sorting column. If there is an active region, the mark
1507 specifies the first line and the sorting column, while point
1508 should be in the last line to be included into the sorting.
1510 The command then prompts for the sorting type which can be
1511 alphabetically, numerically, or by time (as given in a time stamp
1512 in the field). Sorting in reverse order is also possible.
1514 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1516 If SORTING-TYPE is specified when this function is called from a Lisp
1517 program, no prompting will take place. SORTING-TYPE must be a character,
1518 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1519 should be done in reverse order."
1523 beg end bcol ecol tend tbeg column lns pos)
1568 x))
1581 "Copy region in table to the clipboard and blank all relevant fields.
1582 If there is no active region, use just the field at point."
1589 "Copy rectangular region in table to clipboard.
1590 A special clipboard is used which can only be accessed
1591 with `org-table-paste-rectangle'."
1595 current-prefix-arg))
1597 region cols
1623 org-table-clip))
1626 "Paste a rectangular region into a table.
1627 The upper right corner ends up in the current field. All involved fields
1628 will be overwritten. If the rectangle does not fit into the present table,
1629 the table is enlarged as needed. The process ignores horizontal separator
1630 lines."
1640 c cols field)
1656 "Convert from `org-mode' table to table.el and back.
1657 Obviously, this only works within limits. When an Org-mode table is
1658 converted to table.el, all horizontal separator lines get lost, because
1659 table.el uses these as cell boundaries and has no notion of horizontal lines.
1660 A table.el table can be converted to an Org-mode table only if it does not
1661 do row or column spanning. Multiline cells will become multiple cells.
1662 Beware, Org-mode does not test if the table can be successfully converted - it
1663 blindly applies a recipe that works for simple tables."
1667 ;; convert to Org-mode table
1676 ;; convert to table.el table
1679 ;; first, get rid of all horizontal lines
1683 ;; insert a hline before first
1687 ;; insert a hline after each line
1692 ;; replace "+" at beginning and ending of hlines
1701 "Wrap several fields in a column like a paragraph.
1702 This is useful if you'd like to spread the contents of a field over several
1703 lines, in order to keep the table compact.
1705 If there is an active region, and both point and mark are in the same column,
1706 the text in the column is wrapped to minimum width for the given number of
1707 lines. Generally, this makes the table more compact. A prefix ARG may be
1709 formats the selected text to two lines. If the region was longer than two
1710 lines, the remaining lines remain empty. A negative prefix argument reduces
1711 the current number of lines by that amount. The wrapped text is pasted back
1712 into the table. If you formatted it to more lines than it was before, fields
1713 further down in the table get overwritten - so you might need to make space in
1714 the table first.
1716 If there is no region, the current field is split at the cursor position and
1717 the text fragment to the right of the cursor is prepended to the field one
1718 line down.
1720 If there is no region, but you specify a prefix ARG, the current field gets
1721 blank, and the content is appended to the field above."
1725 ;; There is a region: fill as a paragraph
1729 nlines)
1736 arg)
1740 nil nlines)))
1744 ;; No region, split the current field at point
1748 ;; combine with field above
1758 ;; split field
1771 "Edit table field in a different window.
1772 This is mainly useful for fields that contain hidden parts.
1774 it can be edited in place."
1780 display t intangible t))
1786 p)
1795 intangible t))
1803 "Finish editing a table data field.
1804 Remove all newline characters, insert the result into the table, realign
1805 the table and kill the editing buffer."
1809 text)
1828 "Sum numbers in region of current table column.
1829 The result will be displayed in the echo area, and will be available
1832 If there is an active region, it is interpreted as a rectangle and all
1833 numbers in that rectangle will be summed. If there is no active
1834 region and point is located in a table column, sum all numbers in that
1835 column.
1837 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1838 numbers are assumed to be times as well (in decimal hours) and the
1839 numbers are added as such.
1841 If NLAST is a number, only the NLAST fields will actually be summed."
1868 items1)))
1875 s diff)
1883 sres))))
1906 "Return the formula active for the current field.
1907 Assumes that specials are in place.
1908 If KEY is given, return the key to this formula.
1912 org-table-named-field-locations)))
1926 "Read a formula from the minibuffer, offer stored formula as default.
1927 When NAMED is non-nil, look for a named equation."
1931 org-table-named-field-locations)))
1938 name
1939 ref)
1949 stored)
1951 equation)
1958 scol))
1960 'org-table-formula-history
1961 )))))
1962 mustsave)
1964 ;; remove formula
1971 ;; We set the column equation, delete the named one.
1973 mustsave t))
1979 eq))
1982 "Store the list of formulas below the current table."
1988 ;; don't overwrite TBLFM, we might use text properties to store stuff
2003 ;; Fake a high number to make sure this is sorted at the end.
2013 "Compare two formulas for sorting."
2019 "Return an alist with the stored formulas directly after current table."
2028 (when (string-match "\\`\\(@[-+I>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|>\\(?:[-+][0-9]+\\)?\\)\\) *= *\\(.*[^ \t]\\)" string)
2046 "Modify the equations after the table structure has been edited.
2048 For all numbers larger than LIMIT, shift them by DELTA."
2059 s n a)
2072 t t)))))))))
2075 "Get the column names and local parameters for this table."
2078 names name fields fields1 field cnt
2079 c v l line col types dlines hlines last-dline)
2081 org-table-local-parameters nil
2082 org-table-named-field-locations nil
2083 org-table-current-begin-line nil
2084 org-table-current-begin-pos nil
2085 org-table-current-line-types nil
2104 org-table-local-parameters))))
2120 ;; Analyse the line types
2124 l org-table-current-begin-line)
2141 al al2)
2153 If yes, store the formula and apply it."
2154 ;; We already know we are in a table. Get field will only return a formula
2155 ;; when appropriate. It might return a separator line, but no problem.
2158 named eq)
2169 "List of commands triggering the recalculation of a line.
2182 "Rotate the recalculation mark in the first column.
2183 If in any row, the first field is not consistent with a mark,
2184 insert a new column for the markers.
2185 When there is an active region, change all the lines in the region,
2186 after prompting for the marking character.
2187 After each change, a message will be displayed indicating the meaning
2188 of the new mark."
2203 epos new)
2210 newchar))
2242 "Recompute the current line if marked for it, and if we haven't just done it."
2262 modes)
2265 suppress-align suppress-const
2266 suppress-store suppress-analysis)
2267 "Replace the table field value at the cursor by the result of a calculation.
2269 This function makes use of Dave Gillespie's Calc package, in my view the
2270 most exciting program ever written for GNU Emacs. So you need to have Calc
2271 installed in order to use this function.
2273 In a table, this command replaces the value in the current field with the
2275 formula, by storing it in a special line below the table. When called
2276 with a `C-u' prefix, the current field must be a named field, and the
2277 formula is installed as valid in only this specific field.
2279 When called with two `C-u' prefixes, insert the active equation
2280 for the field back into the current field, so that it can be
2282 to check the referenced fields.
2284 When called, the command first prompts for a formula, which is read in
2285 the minibuffer. Previously entered formulas are available through the
2286 history list, and the last used formula is offered as a default.
2287 These stored formulas are adapted correctly when moving, inserting, or
2288 deleting columns with the corresponding commands.
2290 The formula can be any algebraic expression understood by the Calc package.
2291 For details, see the Org-mode manual.
2293 This function can also be called from Lisp programs and offers
2294 additional arguments: EQUATION can be the formula to apply. If this
2295 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2296 used to speed-up recursive calls by by-passing unnecessary aligns.
2297 SUPPRESS-CONST suppresses the interpretation of constants in the
2298 formula, assuming that this has been done already outside the function.
2299 SUPPRESS-STORE means the formula should not be stored, either because
2300 it is already stored, or because it is a modified equation that should
2301 not overwrite the stored one."
2317 equation
2323 n form form0 bw fmt x ev orig c lispp literal)
2324 ;; Parse the format string. Since we have a lot of modes, this is
2325 ;; a lot of work. However, I think calc still uses most of the time.
2337 'calc-float-format
2340 n))))
2367 fields)))
2373 ;; Insert row and column number of formula result field
2384 t t form)))
2386 ;; Check for old vertical references
2388 ;; Insert remote references
2396 keep-empty numbers lispp))
2397 t t form)))
2398 ;; Insert complex ranges
2406 keep-empty numbers lispp))
2407 t t form)))
2408 ;; Insert simple ranges
2417 keep-empty numbers lispp))
2418 t t form)))
2420 ;; Insert the references to fields in same row
2430 t t form)))
2445 Orig: %s
2446 $xyz-> %s
2447 @r$c-> %s
2478 prop value)))
2481 "Get a calc vector from a column, according to descriptor DESC.
2482 Optional arguments TBEG and COL can give the beginning of the table and
2483 the current column, to avoid unnecessary parsing.
2485 HIGHLIGHT means just highlight the range.
2487 When CORNERS-ONLY is set, only return the corners of the range as
2488 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2489 in the buffer and column1 and column2 are table column numbers."
2496 beg end c1 c2 r1 r2 rangep tmp)
2513 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2520 ;; just one field
2527 ;; A range, return a vector
2528 ;; First sort the numbers to get a regular ractangle
2532 ;; Only return the corners of the range
2534 ;; Copy the range values into a list
2548 ;; return string representation of calc vector
2553 "Analyze descriptor DESC and retrieve the corresponding line number.
2554 The cursor is currently in line CLINE, the table begins in line BLINE,
2555 and TABLE is a vector with line types."
2563 ;; 1 2 3 4 5 6
2583 nil hn cline desc)))
2586 rel on cline desc)))
2590 "FIXME: Needs more documentation."
2603 nil))
2604 t)))
2608 desc cline)
2609 i)))
2614 s))
2617 "Convert list ELEMENTS to something appropriate to insert into formula.
2618 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2619 NUMBERS indicates that everything should be converted to numbers.
2620 LISPP means to return something appropriate for a Lisp list."
2624 elements
2633 elements))))
2639 x
2645 elements
2649 "Recalculate the current table line by applying all stored formulas.
2650 With prefix arg ALL, do this for all lines in the table.
2651 With the prefix argument ALL is `(16)' \
2653 it is the symbol `iterate', recompute the table until it no longer changes.
2654 If NOALIGN is not nil, do not re-align the table after the computations
2655 are done. This is typically used internally to save time, if it is
2656 known that the table will be realigned a little later anyway."
2671 seen-fields lhs1
2673 ;; Insert constants in all formulas
2689 eqlist))
2690 ;; Split the equation list
2696 ;; Expand ranges in lhs of formulas
2699 ;; Get the correct line range to process
2705 ;; This is a table with marked lines, compute selected lines
2707 ;; Move forward to the first non-header line
2718 ;; First find the named fields, and mark them untouchable.
2719 ;; Also check if several field/range formulas try to set the same field.
2738 name)))
2748 ;; Now evaluate the column formulas, but skip fields covered by
2749 ;; field formulas
2753 ;; Unprotected line, recalculate
2765 ;; Now evaluate the field formulas
2779 ;; back to initial position
2787 "Recalculate the table until it does not change anymore.
2788 The maximun number of iterations is 10, but you can chose a different value
2789 with the prefix ARG."
2794 thistbl)
2809 "Recalculate all tables in the current buffer."
2817 "Iterate all tables in the buffer, to converge inter-table dependencies."
2822 c1
2839 "Expand list of formulas.
2840 If some of the RHS in the formulas are ranges or a row reference, expand
2841 them to individual field equations for each field."
2847 ;; This just refers to one fixed field
2850 ;; This just refers to one fixed named field
2872 "Replace @> / $> with the last row/column of the table."
2879 org-table-current-ncol)
2883 t t s)))
2884 s)
2887 "Replace $const with values in string F."
2889 ;; First, check for column names
2894 ;; Parameters and constants
2896 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2906 f))
2909 "Find the value for a parameter or constant in a formula.
2910 Parameters get priority."
2941 map))
2948 "--"
2951 "--"
2952 "Shift Reference at Point"
2957 "-"
2958 "Change Test Row for Column Formulas"
2961 "--"
2966 org-table-overlay-coordinates)]
2967 "--"
2974 "Edit the formulas of the current table in a separate buffer."
2990 entry s type title)
2993 ;; Keep global-font-lock-mode from turning on font-lock-mode
3034 "Convert a formula from internal to user representation."
3037 s))
3040 "Convert a formula from user to internal representation."
3043 s))
3046 "Convert spreadsheet references from A7 to @7$28.
3047 Works for single references, but also for entire formulas and even the
3048 full TBLFM line."
3050 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3053 ;; format match, just advance
3058 ;; 3.e5 or something like this.
3061 ;; (member (match-string 1 s)
3062 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3063 )
3064 ;; function name, just advance
3074 t t s)))))
3075 s))
3078 "Convert spreadsheet references from to @7$28 to AB7.
3079 Works for single references, but also for entire formulas and even the
3080 full TBLFM line."
3087 t t s)))
3092 t nil s)))
3093 s)
3096 "Convert a base 26 number represented by letters into an integer.
3097 For example: AB -> 28."
3103 n))
3106 "Convert an integer into a base 26 number represented by letters.
3107 For example: 28 -> AB."
3112 s))
3115 "Convert all references in this buffer, using FUNCTION."
3125 "Convert all references in the buffer from B3 to @3$2 and back."
3135 "Shift the reference at point one row/hline up."
3139 "Shift the reference at point one row/hline down."
3143 "Shift the reference at point one field to the left."
3147 "Shift the reference at point one field to the right."
3158 ;; A B3-like reference
3164 ;; An internal reference
3170 "Re-match the group N, and replace it with the shifted reference."
3175 t t)))
3178 "Shift a reference part REF.
3179 If DECR is set, decrease the references row/column, else increase.
3180 If HLINE is set, this may be a hline reference, it certainly is not
3181 a translation reference."
3210 "Toggle the display of coordinates in the referenced table."
3219 "Parse the buffer for formula definitions and install them.
3220 With prefix ARG, apply the new formulas to the table."
3230 "^\\(@[-+I>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|>[-+0-9]*\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3231 nil t)
3255 "Abort editing formulas, without installing the changes."
3266 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3307 "Show the location/value of the $ expression at point."
3316 var name e what match dest)
3321 "$1.."
3404 ;; column number
3432 org-table-fedit-scroll-down))))
3443 "Make sure the cursor is in a dataline in a table."
3452 p1 p2)))
3457 "Move cursor one line up in the window showing the table."
3462 "Move cursor one line down in the window showing the table."
3467 "Move the cursor in the window showing the table.
3468 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3493 "Add a new overlay."
3499 "Highlight rectangular region in a table."
3503 l1 c1 l2 c2 tmp)
3527 "Remove the rectangle overlays."
3538 "Add overlays to the table at point, to show row/column coordinates."
3567 "Toggle the display of Row/Column numbers in tables."
3579 "Toggle the formula debugger in tables."
3585 ;;; The orgtbl minor mode
3587 ;; Define a minor mode which can be used in other modes in order to
3588 ;; integrate the org-mode table editor.
3590 ;; This is really a hack, because the org-mode table editor uses several
3591 ;; keys which normally belong to the major mode, for example the TAB and
3592 ;; RET keys. Here is how it works: The minor mode defines all the keys
3593 ;; necessary to operate the table editor, but wraps the commands into a
3594 ;; function which tests if the cursor is currently inside a table. If that
3595 ;; is the case, the table editor command is executed. However, when any of
3596 ;; those keys is used outside a table, the function uses `key-binding' to
3597 ;; look up if the key has an associated command in another currently active
3598 ;; keymap (minor modes, major mode, global), and executes that command.
3599 ;; There might be problems if any of the keys used by the table editor is
3600 ;; otherwise used as a prefix key.
3602 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3603 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3604 ;; addresses this by checking explicitly for both bindings.
3606 ;; The optimized version (see variable `orgtbl-optimized') takes over
3607 ;; all keys which are bound to `self-insert-command' in the *global map*.
3608 ;; Some modes bind other commands to simple characters, for example
3609 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3610 ;; active, this binding is ignored inside tables and replaced with a
3611 ;; modified self-insert.
3617 ;;;###autoload
3619 "Unconditionally turn on `orgtbl-mode'."
3634 ;; Install it as a minor mode.
3638 ;;;###autoload
3640 "The `org-mode' table editor as a minor mode for use in other modes."
3645 ;; Exit without error, in case some hook functions calls this
3646 ;; by accident in org-mode.
3650 ;; Make sure we are first in minor-mode-map-alist
3652 ;; FIXME: maybe it should use emulation-mode-map-alists?
3659 auto-fill-inhibit-regexp)
3663 auto-fill-inhibit-regexp)
3664 orgtbl-line-start-regexp))
3682 "Remove all properties related to narrow-column invisibility."
3695 "Create a function for binding in the table minor mode.
3696 FUN is the command to call inside a table. N is used to create a unique
3697 command name. KEYS are keys that should be checked in for a command
3698 to execute outside of tables."
3704 "Outside of tables, run the binding of `"
3716 keys)
3720 "Error when there is no default binding for a table key."
3725 "Setup orgtbl keymaps."
3755 elt key fun cmd)
3763 ;; Special treatment needed for TAB and RET
3783 [(tab)] "\C-i")))
3785 (org-defkey orgtbl-mode-map [backtab]
3787 [backtab] [S-iso-lefttab] [(shift tab)]
3788 [(tab)] "\C-i"))
3790 (org-defkey orgtbl-mode-map "\M-\C-m"
3791 (orgtbl-make-binding 'org-table-wrap-region 105
3792 "\M-\C-m" [(meta return)]))
3793 (org-defkey orgtbl-mode-map [(meta return)]
3794 (orgtbl-make-binding 'org-table-wrap-region 106
3795 [(meta return)] "\M-\C-m"))
3797 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3798 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3800 (when orgtbl-optimized
3801 ;; If the user wants maximum table support, we need to hijack
3802 ;; some standard editing functions
3803 (org-remap orgtbl-mode-map
3804 'self-insert-command 'orgtbl-self-insert-command
3805 'delete-char 'org-delete-char
3806 'delete-backward-char 'org-delete-backward-char)
3807 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3808 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3809 '("OrgTbl"
3810 ["Create or convert" org-table-create-or-convert-from-region
3811 :active (not (org-at-table-p)) :keys "C-c |" ]
3812 "--"
3813 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3814 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3815 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3816 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3817 "--"
3818 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3819 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3820 ["Copy Field from Above"
3821 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3822 "--"
3823 ("Column"
3824 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3825 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3826 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3827 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3828 ("Row"
3829 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3830 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3831 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3832 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3833 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3834 "--"
3835 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3836 ("Rectangle"
3837 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3838 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3839 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3840 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3841 "--"
3842 ("Radio tables"
3843 ["Insert table template" orgtbl-insert-radio-table
3844 (assq major-mode orgtbl-radio-table-templates)]
3845 ["Comment/uncomment table" orgtbl-toggle-comment t])
3846 "--"
3847 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3848 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3849 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3850 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3851 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3852 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3853 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3854 ["Sum Column/Rectangle" org-table-sum
3855 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3856 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3857 ["Debug Formulas"
3858 org-table-toggle-formula-debugger :active (org-at-table-p)
3859 :keys "C-c {"
3860 :style toggle :selected org-table-formula-debug]
3861 ["Show Col/Row Numbers"
3862 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3863 :keys "C-c }"
3864 :style toggle :selected org-table-overlay-coordinates]
3865 ))
3866 t))
3868 (defun orgtbl-ctrl-c-ctrl-c (arg)
3869 "If the cursor is inside a table, realign the table.
3870 If it is a table to be sent away to a receiver, do it.
3871 With prefix arg, also recompute table."
3872 (interactive "P")
3873 (let ((pos (point)) action consts-str consts cst const-str)
3874 (save-excursion
3875 (beginning-of-line 1)
3876 (setq action (cond
3880 (cond
3881 ((integerp action)
3882 (goto-char action)
3883 (org-table-maybe-eval-formula)
3884 (if arg
3885 (call-interactively 'org-table-recalculate)
3886 (org-table-maybe-recalculate-line))
3887 (call-interactively 'org-table-align)
3888 (when (orgtbl-send-table 'maybe)
3889 (run-hooks 'orgtbl-after-send-table-hook)))
3890 ((eq action 'recalc)
3891 (save-excursion
3892 (goto-char (point-min))
3894 (setq const-str (substring-no-properties (match-string 1)))
3896 (when consts
3897 (let (e)
3898 (while (setq e (pop consts))
3900 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
3901 (setq org-table-formula-constants-local cst)))))
3902 (save-excursion
3903 (beginning-of-line 1)
3905 (if (org-at-table-p)
3906 (org-call-with-arg 'org-table-recalculate t))))
3907 (t (let (orgtbl-mode)
3908 (call-interactively (key-binding "\C-c\C-c")))))))
3910 (defun orgtbl-create-or-convert-from-region (arg)
3911 "Create table or convert region to table, if no conflicting binding.
3912 This installs the table binding `C-c |', but only if there is no
3913 conflicting binding to this key outside orgtbl-mode."
3914 (interactive "P")
3915 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3916 (if cmd
3917 (call-interactively cmd)
3918 (call-interactively 'org-table-create-or-convert-from-region))))
3920 (defun orgtbl-tab (arg)
3921 "Justification and field motion for `orgtbl-mode'."
3922 (interactive "P")
3923 (if arg (org-table-edit-field t)
3924 (org-table-justify-field-maybe)
3925 (org-table-next-field)))
3927 (defun orgtbl-ret ()
3928 "Justification and field motion for `orgtbl-mode'."
3929 (interactive)
3930 (if (bobp)
3931 (newline)
3932 (org-table-justify-field-maybe)
3933 (org-table-next-row)))
3935 (defun orgtbl-self-insert-command (N)
3936 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3937 If the cursor is in a table looking at whitespace, the whitespace is
3938 overwritten, and the table is not marked as requiring realignment."
3939 (interactive "p")
3940 (if (and (org-at-table-p)
3941 (or
3942 (and org-table-auto-blank-field
3943 (member last-command
3944 '(orgtbl-hijacker-command-100
3945 orgtbl-hijacker-command-101
3946 orgtbl-hijacker-command-102
3947 orgtbl-hijacker-command-103
3948 orgtbl-hijacker-command-104
3949 orgtbl-hijacker-command-105
3950 yas/expand))
3951 (org-table-blank-field))
3952 t)
3953 (eq N 1)
3955 (let (org-table-may-need-update)
3956 (goto-char (1- (match-end 0)))
3957 (delete-backward-char 1)
3958 (goto-char (match-beginning 0))
3959 (self-insert-command N))
3960 (setq org-table-may-need-update t)
3961 (let* (orgtbl-mode
3962 a
3963 (cmd (or (key-binding
3964 (or (and (listp function-key-map)
3965 (setq a (assoc last-input-event function-key-map))
3966 (cdr a))
3967 (vector last-input-event)))
3968 'self-insert-command)))
3969 (call-interactively cmd)
3970 (if (and org-self-insert-cluster-for-undo
3971 (eq cmd 'self-insert-command))
3972 (if (not (eq last-command 'orgtbl-self-insert-command))
3973 (setq org-self-insert-command-undo-counter 1)
3974 (if (>= org-self-insert-command-undo-counter 20)
3975 (setq org-self-insert-command-undo-counter 1)
3976 (and (> org-self-insert-command-undo-counter 0)
3977 buffer-undo-list
3978 (not (cadr buffer-undo-list)) ; remove nil entry
3979 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3980 (setq org-self-insert-command-undo-counter
3981 (1+ org-self-insert-command-undo-counter))))))))
3984 "Regular expression matching exponentials as produced by calc.")
3986 (defun orgtbl-export (table target)
3987 (require 'org-exp)
3988 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3990 org-table-last-alignment org-table-last-column-widths
3991 maxcol column)
3992 (if (not (fboundp func))
3993 (error "Cannot export orgtbl table to %s" target))
3994 (setq lines (org-table-clean-before-export lines))
3995 (setq table
3996 (mapcar
3997 (lambda (x)
3998 (if (string-match org-table-hline-regexp x)
3999 'hline
4001 lines))
4002 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4003 table)))
4004 (loop for i from (1- maxcol) downto 0 do
4005 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4006 (setq column (delq nil column))
4007 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4008 (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))
4009 (funcall func table nil)))
4011 (defun orgtbl-gather-send-defs ()
4012 "Gather a plist of :name, :transform, :params for each destination before
4013 a radio table."
4014 (save-excursion
4015 (goto-char (org-table-begin))
4016 (let (rtn)
4017 (beginning-of-line 0)
4018 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4019 (let ((name (org-no-properties (match-string 1)))
4020 (transform (intern (match-string 2)))
4021 (params (if (match-end 3)
4022 (read (concat "(" (match-string 3) ")")))))
4023 (push (list :name name :transform transform :params params)
4024 rtn)
4025 (beginning-of-line 0)))
4026 rtn)))
4028 (defun orgtbl-send-replace-tbl (name txt)
4029 "Find and replace table NAME with TXT."
4030 (save-excursion
4031 (goto-char (point-min))
4032 (unless (re-search-forward
4034 (error "Don't know where to insert translated table"))
4035 (goto-char (match-beginning 0))
4036 (beginning-of-line 2)
4037 (save-excursion
4038 (let ((beg (point)))
4039 (unless (re-search-forward
4040 (concat "END RECEIVE ORGTBL +" name) nil t)
4041 (error "Cannot find end of insertion region"))
4042 (beginning-of-line 1)
4043 (delete-region beg (point))))
4046 ;;;###autoload
4047 (defun org-table-to-lisp (&optional txt)
4048 "Convert the table at point to a Lisp structure.
4049 The structure will be a list. Each item is either the symbol `hline'
4050 for a horizontal separator line, or a list of field values as strings.
4051 The table is taken from the parameter TXT, or from the buffer at point."
4052 (unless txt
4053 (unless (org-at-table-p)
4054 (error "No table at point")))
4055 (let* ((txt (or txt
4056 (buffer-substring-no-properties (org-table-begin)
4057 (org-table-end))))
4060 (mapcar
4061 (lambda (x)
4062 (if (string-match org-table-hline-regexp x)
4063 'hline
4065 lines)))
4067 (defun orgtbl-send-table (&optional maybe)
4068 "Send a transformed version of this table to the receiver position.
4069 With argument MAYBE, fail quietly if no transformation is defined for
4070 this table."
4071 (interactive)
4072 (catch 'exit
4073 (unless (org-at-table-p) (error "Not at a table"))
4074 ;; when non-interactive, we assume align has just happened.
4075 (when (interactive-p) (org-table-align))
4076 (let ((dests (orgtbl-gather-send-defs))
4077 (txt (buffer-substring-no-properties (org-table-begin)
4078 (org-table-end)))
4079 (ntbl 0))
4080 (unless dests (if maybe (throw 'exit nil)
4081 (error "Don't know how to transform this table")))
4082 (dolist (dest dests)
4083 (let* ((name (plist-get dest :name))
4084 (transform (plist-get dest :transform))
4085 (params (plist-get dest :params))
4086 (skip (plist-get params :skip))
4087 (skipcols (plist-get params :skipcols))
4088 beg
4089 (lines (org-table-clean-before-export
4090 (nthcdr (or skip 0)
4092 (i0 (if org-table-clean-did-remove-column 2 1))
4093 (table (mapcar
4094 (lambda (x)
4095 (if (string-match org-table-hline-regexp x)
4096 'hline
4097 (org-remove-by-index
4099 skipcols i0)))
4100 lines))
4101 (fun (if (= i0 2) 'cdr 'identity))
4102 (org-table-last-alignment
4103 (org-remove-by-index (funcall fun org-table-last-alignment)
4104 skipcols i0))
4105 (org-table-last-column-widths
4106 (org-remove-by-index (funcall fun org-table-last-column-widths)
4107 skipcols i0))
4108 (txt (if (fboundp transform)
4109 (funcall transform table params)
4110 (error "No such transformation function %s" transform))))
4111 (orgtbl-send-replace-tbl name txt))
4112 (setq ntbl (1+ ntbl)))
4113 (message "Table converted and installed at %d receiver location%s"
4114 ntbl (if (> ntbl 1) "s" ""))
4115 (if (> ntbl 0)
4116 ntbl
4117 nil))))
4119 (defun org-remove-by-index (list indices &optional i0)
4120 "Remove the elements in LIST with indices in INDICES.
4121 First element has index 0, or I0 if given."
4122 (if (not indices)
4123 list
4124 (if (integerp indices) (setq indices (list indices)))
4125 (setq i0 (1- (or i0 0)))
4126 (delq :rm (mapcar (lambda (x)
4127 (setq i0 (1+ i0))
4128 (if (memq i0 indices) :rm x))
4129 list))))
4131 (defun orgtbl-toggle-comment ()
4132 "Comment or uncomment the orgtbl at point."
4133 (interactive)
4134 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4135 (re2 (concat "^" orgtbl-line-start-regexp))
4136 (commented (save-excursion (beginning-of-line 1)
4137 (cond ((looking-at re1) t)
4138 ((looking-at re2) nil)
4139 (t (error "Not at an org table")))))
4140 (re (if commented re1 re2))
4141 beg end)
4142 (save-excursion
4143 (beginning-of-line 1)
4144 (while (looking-at re) (beginning-of-line 0))
4145 (beginning-of-line 2)
4146 (setq beg (point))
4147 (while (looking-at re) (beginning-of-line 2))
4148 (setq end (point)))
4149 (comment-region beg end (if commented '(4) nil))))
4151 (defun orgtbl-insert-radio-table ()
4152 "Insert a radio table template appropriate for this major mode."
4153 (interactive)
4154 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4155 (txt (nth 1 e))
4156 name pos)
4157 (unless e (error "No radio table setup defined for %s" major-mode))
4158 (setq name (read-string "Table name: "))
4159 (while (string-match "%n" txt)
4160 (setq txt (replace-match name t t txt)))
4162 (setq pos (point))
4163 (insert txt)
4164 (goto-char pos)))
4166 ;; Dynamically bound input and output for table formatting.
4167 (defvar *orgtbl-table* nil
4168 "Carries the current table through formatting routines.")
4169 (defvar *orgtbl-rtn* nil
4170 "Formatting routines push the output lines here.")
4171 ;; Formatting parameters for the current table section.
4172 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4173 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4174 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4175 (defvar *orgtbl-fmt* nil "Format for each entry.")
4176 (defvar *orgtbl-efmt* nil "Format for numbers.")
4177 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4178 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4179 (defvar *orgtbl-lstart* nil "Text starting a row.")
4180 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4181 (defvar *orgtbl-lend* nil "Text ending a row.")
4182 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4184 (defsubst orgtbl-get-fmt (fmt i)
4185 "Retrieve the format from FMT corresponding to the Ith column."
4186 (if (and (not (functionp fmt)) (consp fmt))
4187 (plist-get fmt i)
4188 fmt))
4190 (defsubst orgtbl-apply-fmt (fmt &rest args)
4191 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4192 (cond ((functionp fmt) (apply fmt args))
4193 (fmt (apply 'format fmt args))
4194 (args (car args))
4195 (t args)))
4197 (defsubst orgtbl-eval-str (str)
4198 "If STR is a function, evaluate it with no arguments."
4199 (if (functionp str)
4200 (funcall str)
4201 str))
4203 (defun orgtbl-format-line (line)
4204 "Format LINE as a table row."
4205 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4206 (let* ((i 0)
4207 (line
4208 (mapcar
4209 (lambda (f)
4210 (setq i (1+ i))
4211 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4212 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4213 (orgtbl-apply-fmt efmt (match-string 1 f)
4214 (match-string 2 f))
4215 f)))
4216 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4217 *orgtbl-default-fmt*)
4218 f)))
4219 line)))
4220 (push (if *orgtbl-lfmt*
4221 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4222 (concat (orgtbl-eval-str *orgtbl-lstart*)
4223 (mapconcat 'identity line *orgtbl-sep*)
4224 (orgtbl-eval-str *orgtbl-lend*)))
4225 *orgtbl-rtn*))))
4227 (defun orgtbl-format-section (section-stopper)
4228 "Format lines until the first occurrence of SECTION-STOPPER."
4229 (let (prevline)
4230 (progn
4231 (while (not (eq (car *orgtbl-table*) section-stopper))
4232 (if prevline (orgtbl-format-line prevline))
4233 (setq prevline (pop *orgtbl-table*)))
4234 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4235 (*orgtbl-lend* *orgtbl-llend*)
4236 (*orgtbl-lfmt* *orgtbl-llfmt*))
4237 (orgtbl-format-line prevline))))))
4239 (defun orgtbl-to-generic (table params)
4240 "Convert the orgtbl-mode TABLE to some other format.
4241 This generic routine can be used for many standard cases.
4242 TABLE is a list, each entry either the symbol `hline' for a horizontal
4243 separator line, or a list of fields for that line.
4244 PARAMS is a property list of parameters that can influence the conversion.
4245 For the generic converter, some parameters are obligatory: you need to
4246 specify either :lfmt, or all of (:lstart :lend :sep).
4248 Valid parameters are
4250 :splice When set to t, return only table body lines, don't wrap
4251 them into :tstart and :tend. Default is nil. When :splice
4252 is non-nil, this also means that the exporter should not look
4253 for and interpret header and footer sections.
4255 :hline String to be inserted on horizontal separation lines.
4256 May be nil to ignore hlines.
4258 :sep Separator between two fields
4259 :remove-nil-lines Do not include lines that evaluate to nil.
4262 Each in the following group may be either a string or a function
4263 of no arguments returning a string:
4264 :tstart String to start the table. Ignored when :splice is t.
4265 :tend String to end the table. Ignored when :splice is t.
4266 :lstart String to start a new table line.
4267 :llstart String to start the last table line, defaults to :lstart.
4268 :lend String to end a table line
4269 :llend String to end the last table line, defaults to :lend.
4271 Each in the following group may be a string, a function of one
4272 argument (the field or line) returning a string, or a plist
4273 mapping columns to either of the above:
4274 :lfmt Format for entire line, with enough %s to capture all fields.
4275 If this is present, :lstart, :lend, and :sep are ignored.
4276 :llfmt Format for the entire last line, defaults to :lfmt.
4277 :fmt A format to be used to wrap the field, should contain
4278 %s for the original field value. For example, to wrap
4280 This may also be a property list with column numbers and
4283 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4284 Same as above, specific for the header lines in the table.
4285 All lines before the first hline are treated as header.
4286 If any of these is not present, the data line value is used.
4288 This may be either a string or a function of two arguments:
4289 :efmt Use this format to print numbers with exponentials.
4290 The format should have %s twice for inserting mantissa
4292 may also be a property list with column numbers and
4293 formats. :fmt will still be applied after :efmt.
4295 In addition to this, the parameters :skip and :skipcols are always handled
4296 directly by `orgtbl-send-table'. See manual."
4297 (interactive)
4299 (let* ((splicep (plist-get params :splice))
4300 (hline (plist-get params :hline))
4301 (remove-nil-linesp (plist-get params :remove-nil-lines))
4302 (remove-newlines (plist-get params :remove-newlines))
4303 (*orgtbl-hline* hline)
4304 (*orgtbl-table* table)
4305 (*orgtbl-sep* (plist-get params :sep))
4306 (*orgtbl-efmt* (plist-get params :efmt))
4307 (*orgtbl-lstart* (plist-get params :lstart))
4308 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4309 (*orgtbl-lend* (plist-get params :lend))
4310 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4311 (*orgtbl-lfmt* (plist-get params :lfmt))
4312 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4313 (*orgtbl-fmt* (plist-get params :fmt))
4314 *orgtbl-rtn*)
4316 ;; Put header
4317 (unless splicep
4318 (when (plist-member params :tstart)
4319 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4320 (if tstart (push tstart *orgtbl-rtn*)))))
4322 ;; Do we have a heading section? If so, format it and handle the
4323 ;; trailing hline.
4324 (if (and (not splicep)
4325 (or (consp (car *orgtbl-table*))
4326 (consp (nth 1 *orgtbl-table*)))
4327 (memq 'hline (cdr *orgtbl-table*)))
4328 (progn
4329 (when (eq 'hline (car *orgtbl-table*))
4330 ;; there is a hline before the first data line
4331 (and hline (push hline *orgtbl-rtn*))
4332 (pop *orgtbl-table*))
4333 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4334 *orgtbl-lstart*))
4335 (*orgtbl-llstart* (or (plist-get params :hllstart)
4336 *orgtbl-llstart*))
4337 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4338 (*orgtbl-llend* (or (plist-get params :hllend)
4339 (plist-get params :hlend) *orgtbl-llend*))
4340 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4341 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4342 (plist-get params :hlfmt) *orgtbl-llfmt*))
4343 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4344 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4345 (orgtbl-format-section 'hline))
4346 (if hline (push hline *orgtbl-rtn*))
4347 (pop *orgtbl-table*)))
4349 ;; Now format the main section.
4350 (orgtbl-format-section nil)
4352 (unless splicep
4353 (when (plist-member params :tend)
4354 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4355 (if tend (push tend *orgtbl-rtn*)))))
4357 (mapconcat (if remove-newlines
4358 (lambda (tend)
4360 'identity)
4361 (nreverse (if remove-nil-linesp
4362 (remq nil *orgtbl-rtn*)
4365 (defun orgtbl-to-tsv (table params)
4366 "Convert the orgtbl-mode table to TAB separated material."
4368 (defun orgtbl-to-csv (table params)
4369 "Convert the orgtbl-mode table to CSV material.
4370 This does take care of the proper quoting of fields with comma or quotes."
4371 (orgtbl-to-generic table (org-combine-plists
4372 '(:sep "," :fmt org-quote-csv-field)
4373 params)))
4375 (defun orgtbl-to-latex (table params)
4376 "Convert the orgtbl-mode TABLE to LaTeX.
4377 TABLE is a list, each entry either the symbol `hline' for a horizontal
4378 separator line, or a list of fields for that line.
4379 PARAMS is a property list of parameters that can influence the conversion.
4380 Supports all parameters from `orgtbl-to-generic'. Most important for
4381 LaTeX are:
4383 :splice When set to t, return only table body lines, don't wrap
4384 them into a tabular environment. Default is nil.
4386 :fmt A format to be used to wrap the field, should contain %s for the
4387 original field value. For example, to wrap everything in dollars,
4390 The format may also be a function that formats its one argument.
4392 :efmt Format for transforming numbers with exponentials. The format
4393 should have %s twice for inserting mantissa and exponent, for
4395 This may also be a property list with column numbers and formats.
4396 The format may also be a function that formats its two arguments.
4398 :llend If you find too much space below the last line of a table,
4401 The general parameters :skip and :skipcols have already been applied when
4402 this function is called."
4403 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4404 org-table-last-alignment ""))
4405 (params2
4406 (list
4411 (orgtbl-to-generic table (org-combine-plists params2 params))))
4413 (defun orgtbl-to-html (table params)
4414 "Convert the orgtbl-mode TABLE to HTML.
4415 TABLE is a list, each entry either the symbol `hline' for a horizontal
4416 separator line, or a list of fields for that line.
4417 PARAMS is a property list of parameters that can influence the conversion.
4418 Currently this function recognizes the following parameters:
4420 :splice When set to t, return only table body lines, don't wrap
4421 them into a <table> environment. Default is nil.
4423 The general parameters :skip and :skipcols have already been applied when
4424 this function is called. The function does *not* use `orgtbl-to-generic',
4425 so you cannot specify parameters for it."
4426 (let* ((splicep (plist-get params :splice))
4427 (html-table-tag org-export-html-table-tag)
4428 html)
4429 ;; Just call the formatter we already have
4430 ;; We need to make text lines for it, so put the fields back together.
4431 (setq html (org-format-org-table-html
4432 (mapcar
4433 (lambda (x)
4434 (if (eq x 'hline)
4435 "|----+----|"
4436 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4437 table)
4438 splicep))
4440 (setq html (replace-match "" t t html)))
4441 html))
4443 (defun orgtbl-to-texinfo (table params)
4444 "Convert the orgtbl-mode TABLE to TeXInfo.
4445 TABLE is a list, each entry either the symbol `hline' for a horizontal
4446 separator line, or a list of fields for that line.
4447 PARAMS is a property list of parameters that can influence the conversion.
4448 Supports all parameters from `orgtbl-to-generic'. Most important for
4449 TeXInfo are:
4451 :splice nil/t When set to t, return only table body lines, don't wrap
4452 them into a multitable environment. Default is nil.
4454 :fmt fmt A format to be used to wrap the field, should contain
4455 %s for the original field value. For example, to wrap
4457 This may also be a property list with column numbers and
4459 Each format also may be a function that formats its one
4460 argument.
4463 are computed automatically from the width of the columns
4464 under org-mode.
4466 The general parameters :skip and :skipcols have already been applied when
4467 this function is called."
4468 (let* ((total (float (apply '+ org-table-last-column-widths)))
4469 (colfrac (or (plist-get params :cf)
4470 (mapconcat
4471 (lambda (x) (format "%.3f" (/ (float x) total)))
4472 org-table-last-column-widths " ")))
4473 (params2
4474 (list
4475 :tstart (concat "@multitable @columnfractions " colfrac)
4476 :tend "@end multitable"
4477 :lstart "@item " :lend "" :sep " @tab "
4478 :hlstart "@headitem ")))
4479 (orgtbl-to-generic table (org-combine-plists params2 params))))
4481 (defun orgtbl-to-orgtbl (table params)
4482 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4483 Useful when slicing one table into many. The :hline, :sep,
4484 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4485 and :tend suppress strings without splicing; they can be set to
4486 provide ORGTBL directives for the generated table."
4487 (let* ((params2
4488 (list
4489 :remove-newlines t
4490 :tstart nil :tend nil
4491 :hline "|---"
4492 :sep " | "
4493 :lstart "| "
4494 :lend " |"))
4495 (params (org-combine-plists params2 params)))
4496 (orgtbl-to-generic table params)))
4498 (defun org-table-get-remote-range (name-or-id form)
4499 "Get a field value or a list of values in a range from table at ID.
4501 NAME-OR-ID may be the name of a table in the current file as set by
4503 will then be used. Alternatively, it may be an ID referring to
4504 any entry, also in a different file. In this case, the first table
4505 in that entry will be referenced.
4509 The return value is either a single string for a single field, or a
4510 list of the fields in the rectangle ."
4511 (save-match-data
4512 (let ((id-loc nil)
4513 org-table-column-names org-table-column-name-regexp
4514 org-table-local-parameters org-table-named-field-locations
4515 org-table-current-line-types org-table-current-begin-line
4516 org-table-current-begin-pos org-table-dlines
4517 org-table-current-ncol
4518 org-table-hlines org-table-last-alignment
4519 org-table-last-column-widths org-table-last-alignment
4520 org-table-last-column-widths tbeg
4521 buffer loc)
4522 (setq form (org-table-convert-refs-to-rc form))
4523 (save-excursion
4524 (save-restriction
4525 (widen)
4526 (save-excursion
4527 (goto-char (point-min))
4528 (if (re-search-forward
4530 nil t)
4531 (setq buffer (current-buffer) loc (match-beginning 0))
4532 (setq id-loc (org-id-find name-or-id 'marker))
4533 (unless (and id-loc (markerp id-loc))
4535 (setq buffer (marker-buffer id-loc)
4536 loc (marker-position id-loc))
4537 (move-marker id-loc nil)))
4538 (with-current-buffer buffer
4539 (save-excursion
4540 (save-restriction
4541 (widen)
4542 (goto-char loc)
4543 (forward-char 1)
4545 (not (match-beginning 1)))
4546 (error "Cannot find a table at NAME or ID %s" name-or-id))
4547 (setq tbeg (point-at-bol))
4548 (org-table-get-specials)
4549 (setq form (org-table-formula-substitute-names form))
4550 (if (and (string-match org-table-range-regexp form)
4551 (> (length (match-string 0 form)) 1))
4552 (save-match-data
4553 (org-table-get-range (match-string 0 form) tbeg 1))
4554 form)))))))))
4556 (provide 'org-table)
4558 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4560 ;;; org-table.el ends here