| blob | 7f96cca5b86776a8d045696b89befba2a980012f |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the table editor and spreadsheet for Org-mode.
31 ;; Watch out: Here we are talking about two different kind of tables.
32 ;; Most of the code is for the tables created with the Org-mode table editor.
33 ;; Sometimes, we talk about tables created and edited with the table.el
34 ;; Emacs package. We call the former org-type tables, and the latter
35 ;; table.el-type tables.
37 ;;; Code:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, othewise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
90 "Templates for radio tables in different major modes.
91 All occurrences of %n in a template will be replaced with the name of the
92 table, obtained by prompting the user."
99 "Settings for tables in Org-mode."
104 "The default size for newly created tables, Columns x Rows."
110 "Regular expression for recognizing numbers in table columns.
111 If a table column contains mostly numbers, it will be aligned to the
112 right. If not, it will be aligned to the left.
114 The default value of this option is a regular expression which allows
115 anything which looks remotely like a number as used in scientific
116 context. For example, all of the following will be considered a
117 number:
118 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
120 Other options offered by the customize interface are more restrictive."
138 "Fraction of numbers in a column required to make the column align right.
139 In a column all non-white fields are considered. If at least this
140 fraction of fields is matched by `org-table-number-fraction',
141 alignment to the right border applies."
146 "Behavior of tables during editing in Org-mode."
151 "Non-nil means automatically re-align table when pressing TAB or RETURN.
153 removal/insertion."
158 "Non-nil means automatically blank table field when starting to type into it.
159 This only happens when typing immediately after a field motion
160 command (TAB, S-TAB or RET).
161 Only relevant when `org-enable-table-editor' is equal to `optimized'."
166 "Non-nil means tab in the last column of a table with jump over a hline.
167 If a horizontal separator line is following the current line,
168 `org-table-next-field' can either create a new row before that line, or jump
169 over the line. When this option is nil, a new line will be created before
170 this line."
175 "Options concerning tables in Org-mode."
180 "Should org-mode work with table references like B3 instead of @3$2?
181 Possible values are:
182 nil never use them
183 from accept as input, do not present for editing
184 t accept as input and present for editing"
199 calc-angle-mode deg
200 calc-prefer-frac nil
201 calc-symbolic-mode nil
203 calc-display-working-message t
204 )
205 "List with Calc mode settings for use in `calc-eval' for table formulas.
206 The list must contain alternating symbols (Calc modes variables and values).
207 Don't remove any of the default settings, just change the values. Org-mode
208 relies on the variables to be present in the list."
213 "Non-nil means TAB and RET evaluate a formula in current table field.
214 If the current field starts with an equal sign, it is assumed to be a formula
215 which should be evaluated as described in the manual and in the documentation
216 string of the command `org-table-eval-formula'. This feature requires the
217 Emacs calc package.
218 When this variable is nil, formula calculation is only available through
224 "Non-nil means interpret constants in formulas in tables.
225 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
226 by the value given in `org-table-formula-constants', or by a value obtained
227 from the `constants.el' package."
232 "Alist with constant names and values, for use in table formulas.
233 The car of each element is a name of a constant, without the `$' before it.
234 The cdr is the value as a string. For example, if you'd like to use the
235 speed of light in a formula, you would configure
239 and then use it in an equation like `$1*$c'.
241 Constants can also be defined on a per-file basis using a line like
243 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
250 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
251 Automatically means when TAB or RET or C-c C-c are pressed in the line."
256 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
261 "Non-nil means relative formula references may cross hlines.
262 Here are the allowed values:
264 nil Relative references may not cross hlines. They will reference the
265 field next to the hline instead. Coming from below, the reference
266 will be to the field below the hline. Coming from above, it will be
267 to the field above.
268 t Relative references may cross hlines.
269 error An attempt to cross a hline will throw an error.
271 It is probably good to never set this variable to nil, for the sake of
272 portability of tables."
280 "Options concerning table import and export in Org-mode."
285 "Default export parameters for `org-table-export'.
286 These can be overridden for a specific table by setting the
287 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
288 radio tables for the different export transformations and
289 available parameters."
327 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
328 ;; 1 2 3 4 5
339 "Is this a table line colgroup information?"
343 line)
345 nil
352 "Is this a table line with only alignment/width cookies?"
365 s))))
374 "Use the table.el package to insert a new table.
375 If there is already a table at point, convert between Org-mode tables
376 and table.el tables."
390 "Convert region to table, or create an empty table.
391 If there is an active region, convert it to a table, using the function
392 `org-table-convert-region'. See the documentation of that function
393 to learn how the prefix argument is interpreted to determine the field
394 separator.
395 If there is no such region, create an empty table with `org-table-create'."
402 "Query for a size and insert a table skeleton.
422 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
426 ;; Insert a hline after the first row.
434 "Convert region to a table.
435 The region goes from BEG0 to END0, but these borders will be moved
436 slightly, to make sure a beginning of line in the first line is included.
438 SEPARATOR specifies the field separator in the lines. It can have the
439 following values:
441 '(4) Use the comma as a field separator
442 '(16) Use a TAB as field separator
443 integer When a number, use that many spaces as field separator
444 nil When nil, the command tries to be smart and figure out the
445 separator in the following way:
446 - when each line contains a TAB, assume TAB-separated material
447 - when each line contains a comma, assume CSV material
448 - else, assume one or more SPACE characters as separator."
452 re)
459 ;; Get the right field separator
470 ;; parse the csv stuff
492 "Import FILE as a table.
493 The file is assumed to be tab-separated. Such files can be produced by most
494 spreadsheet and database applications. If no tabs (at least one per line)
495 are found, lines will be split on whitespace into fields."
507 "Export table to a file, with configurable format.
508 Such a file can be imported into a spreadsheet program like Excel.
509 FILE can be the output file name. If not given, it will be taken from
510 a TABLE_EXPORT_FILE property in the current entry or higher up in the
511 hierarchy, or the user will be prompted for a file name.
512 FORMAT can be an export format, of the same kind as it used when
513 `orgtbl-mode' sends a table in a different format. The default format can
514 be found in the variable `org-table-export-default-format', but the function
515 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
516 property, locally or anywhere up in the hierarchy."
528 buf deffmt-readable)
547 "Format: "
552 deffmt-readable)))
565 'hline
568 skipcols i0)))
569 lines))
573 skipcols i0))
576 skipcols i0)))
593 "Marker at the beginning of the table last aligned.
596 "Marker at the end of the table last aligned.
599 "List of flags for flushright alignment, from the last re-alignment.
602 "List of max width of fields in each column.
605 "Non-nil means debug table formulas.
618 "Align the table at point by aligning all vertical bars."
621 ;; Limits of table
624 ;; Current cursor position
630 column
632 rfmt hfmt
640 emptystrings links dates emph raise narrow
641 falign falign1 fmax f1 len c e space)
644 ;; Check if we have links or dates
656 ;; Make sure the link properties are right
658 ;; Make sure the date properties are right
663 ;; Check if we are narrowing any columns
666 org-format-transports-properties-p
671 ;; Get the rows
674 ;; Store the indentation of the first line
677 ;; Mark the hlines by setting the corresponding element to nil
678 ;; At the same time, we remove trailing space.
681 nil
684 l)))
685 lines))
686 ;; Get the data fields by splitting the lines.
691 ;; How many fields in the longest line?
698 ;; A list of empty strings to fill any short rows on output
700 ;; Check for special formatting.
704 ;; Check if there is an explicit width specified
714 ;; Find fields that are wider than fmax, and shorten them
720 'help-echo
721 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
729 xx)))))
730 ;; Get the maximum width for each column
732 lengths)
733 ;; Get the fraction of numbers, to decide about alignment of the column
739 nil
746 ;; Store the alignment of this table, for later editing of single fields
748 org-table-last-column-widths lengths)
750 ;; With invisible characters, `format' does not get the field width right
751 ;; So we need to make these fields wide by hand.
769 ;; Compute the formats needed for output of the table
782 hfmt))
785 ;; This hack is for org-indent, to force redisplay of the
786 ;; line prefix of the first line. Apparently the redisplay
787 ;; is tied to the newline, which is, I think, a bug.
788 ;; To force this redisplay, we remove and re-insert the
789 ;; newline, so that the redisplay engine thinks it belongs
790 ;; to the changed text.
796 ;; Replace the old one
803 ;; Try to move to the old location
811 ))
814 "Find the beginning of the table and return its position.
815 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
819 org-table-border-regexp)
820 nil t))
827 "Find the end of the table and return its position.
828 With argument TABLE-TYPE, go to the end of a table.el-type table."
832 org-table-border-regexp)
833 nil t))
839 "Justify the current field, text to left, number to right.
840 Optional argument NEW may specify text to replace the current field content."
849 ;; This is not the same table, force a full re-align
855 l f n o e)
879 "Go to the next field in the current table, creating new lines as needed.
880 Before doing so, re-align the table if necessary."
885 org-table-may-need-update)
896 org-table-tab-jumps-over-hlines
908 "Go to the previous field in the table.
909 Before doing so, re-align the table if necessary."
914 org-table-may-need-update)
929 "Move to the end of the current table field.
930 If already at or after the end, move to the end of the next table field.
931 With numeric argument N, move N-1 fields forward first."
944 "Move to the beginning of the current table field.
945 If already at or before the beginning, move to the beginning of the
946 previous field.
947 With numeric argument N, move N-1 fields backward first."
961 "Go to the next row (same column) in the current table.
962 Before doing so, re-align the table if necessary."
970 org-table-may-need-update)
984 "Copy a field down in the current column.
985 If the field at the cursor is empty, copy into it the content of
986 the nearest non-empty field above. With argument N, use the Nth
987 non-empty field. If the current field is not empty, it is copied
988 down to the next row, and the cursor is moved with it.
989 Therefore, repeating this command causes the column to be filled
990 row-by-row.
991 If the variable `org-table-copy-increment' is non-nil and the
992 field is an integer or a timestamp, it will be incremented while
993 copying. In the case of a timestamp, increment by one day."
1001 txt)
1013 beg t))
1036 "Is point inside a table data field?
1037 I.e. not on a hline or before the first or after the last column?
1038 This actually throws an error, so it aborts the current command."
1049 "Get the field in table line LINE, column COLUMN.
1050 If LINE is larger than the number of data lines in the table, the function
1051 returns nil. However, if COLUMN is too large, we will simply return an
1052 empty string.
1053 If LINE is nil, use the current line.
1054 If column is nil, use the current column."
1061 "Put VALUE into line LINE, column COLUMN.
1062 When ALIGN is set, also realign the table."
1071 "Return the index of the current data line."
1078 cnt))
1081 "Go to the Nth data line in the current table.
1082 Return t when the line exists, nil if it does not exist."
1090 "Blank the current table field or active region."
1107 "Return the value of the field in column N of current row.
1108 N defaults to current field.
1109 If REPLACE is a string, replace field with this value. The return value
1110 is always the old value."
1120 val)
1124 "Show info about the current field, and highlight any reference at point."
1132 org-table-named-field-locations)))
1151 dline col
1153 dline col ref1
1155 ;; FIXME: formula info not correct if special table line
1165 "Find out which column we are in."
1174 cnt)))
1177 "Find out what table data line we are in.
1178 Only data lines count for this."
1188 cnt)))
1191 "Move the cursor to the Nth column in the current table line.
1192 With optional argument ON-DELIM, stop with point before the left delimiter
1193 of the field.
1194 If there are less than N fields, just go to after the last delimiter.
1195 However, when FORCE is non-nil, create new columns if necessary."
1205 t)))))
1213 "Insert a new column into the table."
1221 ;; Current cursor position
1227 nil
1239 "Find a data line in the current table, which is needed for column commands."
1242 t
1253 t
1258 "Turn a buffer line number into a data line number.
1259 If there is no data line in this line, return nil.
1260 If there is no matchin dline (most likely te refrence was a hline), the
1261 first dline below it is used. When ABOVE is non-nil, the one above is used."
1264 i)
1277 nil))
1280 "Delete a column from the table."
1289 ;; Current cursor position
1295 nil
1310 "Move column to the right."
1314 "Move column to the left."
1319 "Move the current column to the right. With arg LEFT, move to the left."
1329 ;; Current cursor position
1339 nil
1356 "Move table row down."
1360 "Move table row up."
1365 "Move the current table line down. With arg UP, move it up."
1374 txt hline2p)
1395 "Insert a new row above the current line into the table.
1396 With prefix ARG, insert below the current line."
1402 ;; Fix the first field if necessary
1414 "Insert a horizontal-line below the current line into the table.
1415 With prefix ABOVE, insert above the current line."
1437 "Insert a hline and move to the row below that line."
1451 In particular, this does handle wide and invisible characters."
1453 ;; It's a hline, just map the characters
1459 t t s)))
1460 s))
1463 "Delete the current row or horizontal line from the table."
1476 "Sort table lines according to the column at point.
1478 The position of point indicates the column to be used for
1479 sorting, and the range of lines is the range between the nearest
1480 horizontal separator lines, or the entire table of no such lines
1481 exist. If point is before the first column, you will be prompted
1482 for the sorting column. If there is an active region, the mark
1483 specifies the first line and the sorting column, while point
1484 should be in the last line to be included into the sorting.
1486 The command then prompts for the sorting type which can be
1487 alphabetically, numerically, or by time (as given in a time stamp
1488 in the field). Sorting in reverse order is also possible.
1490 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1492 If SORTING-TYPE is specified when this function is called from a Lisp
1493 program, no prompting will take place. SORTING-TYPE must be a character,
1494 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1495 should be done in reverse order."
1499 beg end bcol ecol tend tbeg column lns pos)
1544 x))
1557 "Copy region in table to the clipboard and blank all relevant fields.
1558 If there is no active region, use just the field at point."
1565 "Copy rectangular region in table to clipboard.
1566 A special clipboard is used which can only be accessed
1567 with `org-table-paste-rectangle'."
1571 current-prefix-arg))
1573 region cols
1599 org-table-clip))
1602 "Paste a rectangular region into a table.
1603 The upper right corner ends up in the current field. All involved fields
1604 will be overwritten. If the rectangle does not fit into the present table,
1605 the table is enlarged as needed. The process ignores horizontal separator
1606 lines."
1616 c cols field)
1632 "Convert from `org-mode' table to table.el and back.
1633 Obviously, this only works within limits. When an Org-mode table is
1634 converted to table.el, all horizontal separator lines get lost, because
1635 table.el uses these as cell boundaries and has no notion of horizontal lines.
1636 A table.el table can be converted to an Org-mode table only if it does not
1637 do row or column spanning. Multiline cells will become multiple cells.
1638 Beware, Org-mode does not test if the table can be successfully converted - it
1639 blindly applies a recipe that works for simple tables."
1643 ;; convert to Org-mode table
1652 ;; convert to table.el table
1655 ;; first, get rid of all horizontal lines
1659 ;; insert a hline before first
1663 ;; insert a hline after each line
1668 ;; replace "+" at beginning and ending of hlines
1677 "Wrap several fields in a column like a paragraph.
1678 This is useful if you'd like to spread the contents of a field over several
1679 lines, in order to keep the table compact.
1681 If there is an active region, and both point and mark are in the same column,
1682 the text in the column is wrapped to minimum width for the given number of
1683 lines. Generally, this makes the table more compact. A prefix ARG may be
1685 formats the selected text to two lines. If the region was longer than two
1686 lines, the remaining lines remain empty. A negative prefix argument reduces
1687 the current number of lines by that amount. The wrapped text is pasted back
1688 into the table. If you formatted it to more lines than it was before, fields
1689 further down in the table get overwritten - so you might need to make space in
1690 the table first.
1692 If there is no region, the current field is split at the cursor position and
1693 the text fragment to the right of the cursor is prepended to the field one
1694 line down.
1696 If there is no region, but you specify a prefix ARG, the current field gets
1697 blank, and the content is appended to the field above."
1701 ;; There is a region: fill as a paragraph
1705 nlines)
1712 arg)
1716 nil nlines)))
1720 ;; No region, split the current field at point
1724 ;; combine with field above
1734 ;; split field
1747 "Edit table field in a different window.
1748 This is mainly useful for fields that contain hidden parts.
1750 it can be edited in place."
1756 display t intangible t))
1762 p)
1771 intangible t))
1779 "Finish editing a table data field.
1780 Remove all newline characters, insert the result into the table, realign
1781 the table and kill the editing buffer."
1785 text)
1804 "Sum numbers in region of current table column.
1805 The result will be displayed in the echo area, and will be available
1808 If there is an active region, it is interpreted as a rectangle and all
1809 numbers in that rectangle will be summed. If there is no active
1810 region and point is located in a table column, sum all numbers in that
1811 column.
1813 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1814 numbers are assumed to be times as well (in decimal hours) and the
1815 numbers are added as such.
1817 If NLAST is a number, only the NLAST fields will actually be summed."
1844 items1)))
1851 s diff)
1859 sres))))
1882 "Return the formula active for the current field.
1883 Assumes that specials are in place.
1884 If KEY is given, return the key to this formula.
1888 org-table-named-field-locations)))
1902 "Read a formula from the minibuffer, offer stored formula as default.
1903 When NAMED is non-nil, look for a named equation."
1907 org-table-named-field-locations)))
1914 name
1915 ref)
1925 stored)
1927 equation)
1934 scol))
1936 'org-table-formula-history
1937 )))))
1938 mustsave)
1940 ;; remove formula
1947 ;; We set the column equation, delete the named one.
1949 mustsave t))
1955 eq))
1958 "Store the list of formulas below the current table."
1964 ;; don't overwrite TBLFM, we might use text properties to store stuff
1979 ;; Fake a high number to make sure this is sorted at the end.
1989 "Compare two formulas for sorting."
1995 "Return an alist with the stored formulas directly after current table."
2004 (when (string-match "\\`\\(@[-+I>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|>\\(?:[-+][0-9]+\\)?\\)\\) *= *\\(.*[^ \t]\\)" string)
2022 "Modify the equations after the table structure has been edited.
2024 For all numbers larger than LIMIT, shift them by DELTA."
2035 s n a)
2048 t t)))))))))
2051 "Get the column names and local parameters for this table."
2054 names name fields fields1 field cnt
2055 c v l line col types dlines hlines last-dline)
2057 org-table-local-parameters nil
2058 org-table-named-field-locations nil
2059 org-table-current-begin-line nil
2060 org-table-current-begin-pos nil
2061 org-table-current-line-types nil
2080 org-table-local-parameters))))
2096 ;; Analyse the line types
2100 l org-table-current-begin-line)
2117 al al2)
2129 If yes, store the formula and apply it."
2130 ;; We already know we are in a table. Get field will only return a formula
2131 ;; when appropriate. It might return a separator line, but no problem.
2134 named eq)
2145 "List of commands triggering the recalculation of a line.
2158 "Rotate the recalculation mark in the first column.
2159 If in any row, the first field is not consistent with a mark,
2160 insert a new column for the markers.
2161 When there is an active region, change all the lines in the region,
2162 after prompting for the marking character.
2163 After each change, a message will be displayed indicating the meaning
2164 of the new mark."
2179 epos new)
2186 newchar))
2218 "Recompute the current line if marked for it, and if we haven't just done it."
2238 modes)
2241 suppress-align suppress-const
2242 suppress-store suppress-analysis)
2243 "Replace the table field value at the cursor by the result of a calculation.
2245 This function makes use of Dave Gillespie's Calc package, in my view the
2246 most exciting program ever written for GNU Emacs. So you need to have Calc
2247 installed in order to use this function.
2249 In a table, this command replaces the value in the current field with the
2251 formula, by storing it in a special line below the table. When called
2252 with a `C-u' prefix, the current field must be a named field, and the
2253 formula is installed as valid in only this specific field.
2255 When called with two `C-u' prefixes, insert the active equation
2256 for the field back into the current field, so that it can be
2258 to check the referenced fields.
2260 When called, the command first prompts for a formula, which is read in
2261 the minibuffer. Previously entered formulas are available through the
2262 history list, and the last used formula is offered as a default.
2263 These stored formulas are adapted correctly when moving, inserting, or
2264 deleting columns with the corresponding commands.
2266 The formula can be any algebraic expression understood by the Calc package.
2267 For details, see the Org-mode manual.
2269 This function can also be called from Lisp programs and offers
2270 additional arguments: EQUATION can be the formula to apply. If this
2271 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2272 used to speed-up recursive calls by by-passing unnecessary aligns.
2273 SUPPRESS-CONST suppresses the interpretation of constants in the
2274 formula, assuming that this has been done already outside the function.
2275 SUPPRESS-STORE means the formula should not be stored, either because
2276 it is already stored, or because it is a modified equation that should
2277 not overwrite the stored one."
2293 equation
2299 n form form0 bw fmt x ev orig c lispp literal)
2300 ;; Parse the format string. Since we have a lot of modes, this is
2301 ;; a lot of work. However, I think calc still uses most of the time.
2313 'calc-float-format
2316 n))))
2343 fields)))
2349 ;; Insert row and column number of formula result field
2360 t t form)))
2362 ;; Check for old vertical references
2364 ;; Insert remote references
2372 keep-empty numbers lispp))
2373 t t form)))
2374 ;; Insert complex ranges
2382 keep-empty numbers lispp))
2383 t t form)))
2384 ;; Insert simple ranges
2393 keep-empty numbers lispp))
2394 t t form)))
2396 ;; Insert the references to fields in same row
2406 t t form)))
2421 Orig: %s
2422 $xyz-> %s
2423 @r$c-> %s
2454 prop value)))
2457 "Get a calc vector from a column, according to descriptor DESC.
2458 Optional arguments TBEG and COL can give the beginning of the table and
2459 the current column, to avoid unnecessary parsing.
2461 HIGHLIGHT means just highlight the range.
2463 When CORNERS-ONLY is set, only return the corners of the range as
2464 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2465 in the buffer and column1 and column2 are table column numbers."
2472 beg end c1 c2 r1 r2 rangep tmp)
2489 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2496 ;; just one field
2503 ;; A range, return a vector
2504 ;; First sort the numbers to get a regular ractangle
2508 ;; Only return the corners of the range
2510 ;; Copy the range values into a list
2524 ;; return string representation of calc vector
2529 "Analyze descriptor DESC and retrieve the corresponding line number.
2530 The cursor is currently in line CLINE, the table begins in line BLINE,
2531 and TABLE is a vector with line types."
2539 ;; 1 2 3 4 5 6
2559 nil hn cline desc)))
2562 rel on cline desc)))
2566 "FIXME: Needs more documentation."
2579 nil))
2580 t)))
2584 desc cline)
2585 i)))
2590 s))
2593 "Convert list ELEMENTS to something appropriate to insert into formula.
2594 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2595 NUMBERS indicates that everything should be converted to numbers.
2596 LISPP means to return something appropriate for a Lisp list."
2600 elements
2609 elements))))
2615 x
2621 elements
2625 "Recalculate the current table line by applying all stored formulas.
2626 With prefix arg ALL, do this for all lines in the table.
2627 With the prefix argument ALL is `(16)' \
2629 it is the symbol `iterate', recompute the table until it no longer changes.
2630 If NOALIGN is not nil, do not re-align the table after the computations
2631 are done. This is typically used internally to save time, if it is
2632 known that the table will be realigned a little later anyway."
2647 seen-fields lhs1
2649 ;; Insert constants in all formulas
2665 eqlist))
2666 ;; Split the equation list
2672 ;; Expand ranges in lhs of formulas
2675 ;; Get the correct line range to process
2681 ;; This is a table with marked lines, compute selected lines
2683 ;; Move forward to the first non-header line
2694 ;; First find the named fields, and mark them untouchable.
2695 ;; Also check if several field/range formulas try to set the same field.
2714 name)))
2724 ;; Now evaluate the column formulas, but skip fields covered by
2725 ;; field formulas
2729 ;; Unprotected line, recalculate
2741 ;; Now evaluate the field formulas
2755 ;; back to initial position
2763 "Recalculate the table until it does not change anymore.
2764 The maximun number of iterations is 10, but you can chose a different value
2765 with the prefix ARG."
2770 thistbl)
2785 "Recalculate all tables in the current buffer."
2793 "Iterate all tables in the buffer, to converge inter-table dependencies."
2798 c1
2815 "Expand list of formulas.
2816 If some of the RHS in the formulas are ranges or a row reference, expand
2817 them to individual field equations for each field."
2823 ;; This just refers to one fixed field
2826 ;; This just refers to one fixed named field
2848 "Replace @> / $> with the last row/column of the table."
2855 org-table-current-ncol)
2859 t t s)))
2860 s)
2863 "Replace $const with values in string F."
2865 ;; First, check for column names
2870 ;; Parameters and constants
2872 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2882 f))
2885 "Find the value for a parameter or constant in a formula.
2886 Parameters get priority."
2917 map))
2924 "--"
2927 "--"
2928 "Shift Reference at Point"
2933 "-"
2934 "Change Test Row for Column Formulas"
2937 "--"
2942 org-table-overlay-coordinates)]
2943 "--"
2950 "Edit the formulas of the current table in a separate buffer."
2966 entry s type title)
2969 ;; Keep global-font-lock-mode from turning on font-lock-mode
3010 "Convert a formula from internal to user representation."
3013 s))
3016 "Convert a formula from user to internal representation."
3019 s))
3022 "Convert spreadsheet references from A7 to @7$28.
3023 Works for single references, but also for entire formulas and even the
3024 full TBLFM line."
3026 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3029 ;; format match, just advance
3034 ;; 3.e5 or something like this.
3037 ;; (member (match-string 1 s)
3038 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3039 )
3040 ;; function name, just advance
3050 t t s)))))
3051 s))
3054 "Convert spreadsheet references from to @7$28 to AB7.
3055 Works for single references, but also for entire formulas and even the
3056 full TBLFM line."
3063 t t s)))
3068 t nil s)))
3069 s)
3072 "Convert a base 26 number represented by letters into an integer.
3073 For example: AB -> 28."
3079 n))
3082 "Convert an integer into a base 26 number represented by letters.
3083 For example: 28 -> AB."
3088 s))
3091 "Convert all references in this buffer, using FUNCTION."
3101 "Convert all references in the buffer from B3 to @3$2 and back."
3111 "Shift the reference at point one row/hline up."
3115 "Shift the reference at point one row/hline down."
3119 "Shift the reference at point one field to the left."
3123 "Shift the reference at point one field to the right."
3134 ;; A B3-like reference
3140 ;; An internal reference
3146 "Re-match the group N, and replace it with the shifted reference."
3151 t t)))
3154 "Shift a reference part REF.
3155 If DECR is set, decrease the references row/column, else increase.
3156 If HLINE is set, this may be a hline reference, it certainly is not
3157 a translation reference."
3186 "Toggle the display of coordinates in the referenced table."
3195 "Parse the buffer for formula definitions and install them.
3196 With prefix ARG, apply the new formulas to the table."
3206 "^\\(@[-+I>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|>[-+0-9]*\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3207 nil t)
3231 "Abort editing formulas, without installing the changes."
3242 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3283 "Show the location/value of the $ expression at point."
3292 var name e what match dest)
3297 "$1.."
3380 ;; column number
3408 org-table-fedit-scroll-down))))
3419 "Make sure the cursor is in a dataline in a table."
3428 p1 p2)))
3433 "Move cursor one line up in the window showing the table."
3438 "Move cursor one line down in the window showing the table."
3443 "Move the cursor in the window showing the table.
3444 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3469 "Add a new overlay."
3475 "Highlight rectangular region in a table."
3479 l1 c1 l2 c2 tmp)
3503 "Remove the rectangle overlays."
3514 "Add overlays to the table at point, to show row/column coordinates."
3543 "Toggle the display of Row/Column numbers in tables."
3555 "Toggle the formula debugger in tables."
3561 ;;; The orgtbl minor mode
3563 ;; Define a minor mode which can be used in other modes in order to
3564 ;; integrate the org-mode table editor.
3566 ;; This is really a hack, because the org-mode table editor uses several
3567 ;; keys which normally belong to the major mode, for example the TAB and
3568 ;; RET keys. Here is how it works: The minor mode defines all the keys
3569 ;; necessary to operate the table editor, but wraps the commands into a
3570 ;; function which tests if the cursor is currently inside a table. If that
3571 ;; is the case, the table editor command is executed. However, when any of
3572 ;; those keys is used outside a table, the function uses `key-binding' to
3573 ;; look up if the key has an associated command in another currently active
3574 ;; keymap (minor modes, major mode, global), and executes that command.
3575 ;; There might be problems if any of the keys used by the table editor is
3576 ;; otherwise used as a prefix key.
3578 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3579 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3580 ;; addresses this by checking explicitly for both bindings.
3582 ;; The optimized version (see variable `orgtbl-optimized') takes over
3583 ;; all keys which are bound to `self-insert-command' in the *global map*.
3584 ;; Some modes bind other commands to simple characters, for example
3585 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3586 ;; active, this binding is ignored inside tables and replaced with a
3587 ;; modified self-insert.
3593 ;;;###autoload
3595 "Unconditionally turn on `orgtbl-mode'."
3610 ;; Install it as a minor mode.
3614 ;;;###autoload
3616 "The `org-mode' table editor as a minor mode for use in other modes."
3621 ;; Exit without error, in case some hook functions calls this
3622 ;; by accident in org-mode.
3626 ;; Make sure we are first in minor-mode-map-alist
3628 ;; FIXME: maybe it should use emulation-mode-map-alists?
3635 auto-fill-inhibit-regexp)
3639 auto-fill-inhibit-regexp)
3640 orgtbl-line-start-regexp))
3658 "Remove all properties related to narrow-column invisibility."
3671 "Create a function for binding in the table minor mode.
3672 FUN is the command to call inside a table. N is used to create a unique
3673 command name. KEYS are keys that should be checked in for a command
3674 to execute outside of tables."
3680 "Outside of tables, run the binding of `"
3692 keys)
3696 "Error when there is no default binding for a table key."
3701 "Setup orgtbl keymaps."
3731 elt key fun cmd)
3739 ;; Special treatment needed for TAB and RET
3759 [(tab)] "\C-i")))
3761 (org-defkey orgtbl-mode-map [backtab]
3763 [backtab] [S-iso-lefttab] [(shift tab)]
3764 [(tab)] "\C-i"))
3766 (org-defkey orgtbl-mode-map "\M-\C-m"
3767 (orgtbl-make-binding 'org-table-wrap-region 105
3768 "\M-\C-m" [(meta return)]))
3769 (org-defkey orgtbl-mode-map [(meta return)]
3770 (orgtbl-make-binding 'org-table-wrap-region 106
3771 [(meta return)] "\M-\C-m"))
3773 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3774 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3776 (when orgtbl-optimized
3777 ;; If the user wants maximum table support, we need to hijack
3778 ;; some standard editing functions
3779 (org-remap orgtbl-mode-map
3780 'self-insert-command 'orgtbl-self-insert-command
3781 'delete-char 'org-delete-char
3782 'delete-backward-char 'org-delete-backward-char)
3783 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3784 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3785 '("OrgTbl"
3786 ["Create or convert" org-table-create-or-convert-from-region
3787 :active (not (org-at-table-p)) :keys "C-c |" ]
3788 "--"
3789 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3790 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3791 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3792 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3793 "--"
3794 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3795 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3796 ["Copy Field from Above"
3797 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3798 "--"
3799 ("Column"
3800 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3801 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3802 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3803 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3804 ("Row"
3805 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3806 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3807 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3808 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3809 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3810 "--"
3811 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3812 ("Rectangle"
3813 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3814 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3815 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3816 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3817 "--"
3818 ("Radio tables"
3819 ["Insert table template" orgtbl-insert-radio-table
3820 (assq major-mode orgtbl-radio-table-templates)]
3821 ["Comment/uncomment table" orgtbl-toggle-comment t])
3822 "--"
3823 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3824 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3825 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3826 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3827 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3828 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3829 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3830 ["Sum Column/Rectangle" org-table-sum
3831 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3832 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3833 ["Debug Formulas"
3834 org-table-toggle-formula-debugger :active (org-at-table-p)
3835 :keys "C-c {"
3836 :style toggle :selected org-table-formula-debug]
3837 ["Show Col/Row Numbers"
3838 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3839 :keys "C-c }"
3840 :style toggle :selected org-table-overlay-coordinates]
3841 ))
3842 t))
3844 (defun orgtbl-ctrl-c-ctrl-c (arg)
3845 "If the cursor is inside a table, realign the table.
3846 If it is a table to be sent away to a receiver, do it.
3847 With prefix arg, also recompute table."
3848 (interactive "P")
3849 (let ((pos (point)) action consts-str consts cst const-str)
3850 (save-excursion
3851 (beginning-of-line 1)
3852 (setq action (cond
3856 (cond
3857 ((integerp action)
3858 (goto-char action)
3859 (org-table-maybe-eval-formula)
3860 (if arg
3861 (call-interactively 'org-table-recalculate)
3862 (org-table-maybe-recalculate-line))
3863 (call-interactively 'org-table-align)
3864 (when (orgtbl-send-table 'maybe)
3865 (run-hooks 'orgtbl-after-send-table-hook)))
3866 ((eq action 'recalc)
3867 (save-excursion
3868 (goto-char (point-min))
3870 (setq const-str (substring-no-properties (match-string 1)))
3872 (when consts
3873 (let (e)
3874 (while (setq e (pop consts))
3876 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
3877 (setq org-table-formula-constants-local cst)))))
3878 (save-excursion
3879 (beginning-of-line 1)
3881 (if (org-at-table-p)
3882 (org-call-with-arg 'org-table-recalculate t))))
3883 (t (let (orgtbl-mode)
3884 (call-interactively (key-binding "\C-c\C-c")))))))
3886 (defun orgtbl-create-or-convert-from-region (arg)
3887 "Create table or convert region to table, if no conflicting binding.
3888 This installs the table binding `C-c |', but only if there is no
3889 conflicting binding to this key outside orgtbl-mode."
3890 (interactive "P")
3891 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3892 (if cmd
3893 (call-interactively cmd)
3894 (call-interactively 'org-table-create-or-convert-from-region))))
3896 (defun orgtbl-tab (arg)
3897 "Justification and field motion for `orgtbl-mode'."
3898 (interactive "P")
3899 (if arg (org-table-edit-field t)
3900 (org-table-justify-field-maybe)
3901 (org-table-next-field)))
3903 (defun orgtbl-ret ()
3904 "Justification and field motion for `orgtbl-mode'."
3905 (interactive)
3906 (if (bobp)
3907 (newline)
3908 (org-table-justify-field-maybe)
3909 (org-table-next-row)))
3911 (defun orgtbl-self-insert-command (N)
3912 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3913 If the cursor is in a table looking at whitespace, the whitespace is
3914 overwritten, and the table is not marked as requiring realignment."
3915 (interactive "p")
3916 (if (and (org-at-table-p)
3917 (or
3918 (and org-table-auto-blank-field
3919 (member last-command
3920 '(orgtbl-hijacker-command-100
3921 orgtbl-hijacker-command-101
3922 orgtbl-hijacker-command-102
3923 orgtbl-hijacker-command-103
3924 orgtbl-hijacker-command-104
3925 orgtbl-hijacker-command-105
3926 yas/expand))
3927 (org-table-blank-field))
3928 t)
3929 (eq N 1)
3931 (let (org-table-may-need-update)
3932 (goto-char (1- (match-end 0)))
3933 (delete-backward-char 1)
3934 (goto-char (match-beginning 0))
3935 (self-insert-command N))
3936 (setq org-table-may-need-update t)
3937 (let* (orgtbl-mode
3938 a
3939 (cmd (or (key-binding
3940 (or (and (listp function-key-map)
3941 (setq a (assoc last-input-event function-key-map))
3942 (cdr a))
3943 (vector last-input-event)))
3944 'self-insert-command)))
3945 (call-interactively cmd)
3946 (if (and org-self-insert-cluster-for-undo
3947 (eq cmd 'self-insert-command))
3948 (if (not (eq last-command 'orgtbl-self-insert-command))
3949 (setq org-self-insert-command-undo-counter 1)
3950 (if (>= org-self-insert-command-undo-counter 20)
3951 (setq org-self-insert-command-undo-counter 1)
3952 (and (> org-self-insert-command-undo-counter 0)
3953 buffer-undo-list
3954 (not (cadr buffer-undo-list)) ; remove nil entry
3955 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3956 (setq org-self-insert-command-undo-counter
3957 (1+ org-self-insert-command-undo-counter))))))))
3960 "Regular expression matching exponentials as produced by calc.")
3962 (defun orgtbl-export (table target)
3963 (require 'org-exp)
3964 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3966 org-table-last-alignment org-table-last-column-widths
3967 maxcol column)
3968 (if (not (fboundp func))
3969 (error "Cannot export orgtbl table to %s" target))
3970 (setq lines (org-table-clean-before-export lines))
3971 (setq table
3972 (mapcar
3973 (lambda (x)
3974 (if (string-match org-table-hline-regexp x)
3975 'hline
3977 lines))
3978 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3979 table)))
3980 (loop for i from (1- maxcol) downto 0 do
3981 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3982 (setq column (delq nil column))
3983 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3984 (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))
3985 (funcall func table nil)))
3987 (defun orgtbl-gather-send-defs ()
3988 "Gather a plist of :name, :transform, :params for each destination before
3989 a radio table."
3990 (save-excursion
3991 (goto-char (org-table-begin))
3992 (let (rtn)
3993 (beginning-of-line 0)
3994 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3995 (let ((name (org-no-properties (match-string 1)))
3996 (transform (intern (match-string 2)))
3997 (params (if (match-end 3)
3998 (read (concat "(" (match-string 3) ")")))))
3999 (push (list :name name :transform transform :params params)
4000 rtn)
4001 (beginning-of-line 0)))
4002 rtn)))
4004 (defun orgtbl-send-replace-tbl (name txt)
4005 "Find and replace table NAME with TXT."
4006 (save-excursion
4007 (goto-char (point-min))
4008 (unless (re-search-forward
4010 (error "Don't know where to insert translated table"))
4011 (goto-char (match-beginning 0))
4012 (beginning-of-line 2)
4013 (save-excursion
4014 (let ((beg (point)))
4015 (unless (re-search-forward
4016 (concat "END RECEIVE ORGTBL +" name) nil t)
4017 (error "Cannot find end of insertion region"))
4018 (beginning-of-line 1)
4019 (delete-region beg (point))))
4022 ;;;###autoload
4023 (defun org-table-to-lisp (&optional txt)
4024 "Convert the table at point to a Lisp structure.
4025 The structure will be a list. Each item is either the symbol `hline'
4026 for a horizontal separator line, or a list of field values as strings.
4027 The table is taken from the parameter TXT, or from the buffer at point."
4028 (unless txt
4029 (unless (org-at-table-p)
4030 (error "No table at point")))
4031 (let* ((txt (or txt
4032 (buffer-substring-no-properties (org-table-begin)
4033 (org-table-end))))
4036 (mapcar
4037 (lambda (x)
4038 (if (string-match org-table-hline-regexp x)
4039 'hline
4041 lines)))
4043 (defun orgtbl-send-table (&optional maybe)
4044 "Send a transformed version of this table to the receiver position.
4045 With argument MAYBE, fail quietly if no transformation is defined for
4046 this table."
4047 (interactive)
4048 (catch 'exit
4049 (unless (org-at-table-p) (error "Not at a table"))
4050 ;; when non-interactive, we assume align has just happened.
4051 (when (interactive-p) (org-table-align))
4052 (let ((dests (orgtbl-gather-send-defs))
4053 (txt (buffer-substring-no-properties (org-table-begin)
4054 (org-table-end)))
4055 (ntbl 0))
4056 (unless dests (if maybe (throw 'exit nil)
4057 (error "Don't know how to transform this table")))
4058 (dolist (dest dests)
4059 (let* ((name (plist-get dest :name))
4060 (transform (plist-get dest :transform))
4061 (params (plist-get dest :params))
4062 (skip (plist-get params :skip))
4063 (skipcols (plist-get params :skipcols))
4064 beg
4065 (lines (org-table-clean-before-export
4066 (nthcdr (or skip 0)
4068 (i0 (if org-table-clean-did-remove-column 2 1))
4069 (table (mapcar
4070 (lambda (x)
4071 (if (string-match org-table-hline-regexp x)
4072 'hline
4073 (org-remove-by-index
4075 skipcols i0)))
4076 lines))
4077 (fun (if (= i0 2) 'cdr 'identity))
4078 (org-table-last-alignment
4079 (org-remove-by-index (funcall fun org-table-last-alignment)
4080 skipcols i0))
4081 (org-table-last-column-widths
4082 (org-remove-by-index (funcall fun org-table-last-column-widths)
4083 skipcols i0))
4084 (txt (if (fboundp transform)
4085 (funcall transform table params)
4086 (error "No such transformation function %s" transform))))
4087 (orgtbl-send-replace-tbl name txt))
4088 (setq ntbl (1+ ntbl)))
4089 (message "Table converted and installed at %d receiver location%s"
4090 ntbl (if (> ntbl 1) "s" ""))
4091 (if (> ntbl 0)
4092 ntbl
4093 nil))))
4095 (defun org-remove-by-index (list indices &optional i0)
4096 "Remove the elements in LIST with indices in INDICES.
4097 First element has index 0, or I0 if given."
4098 (if (not indices)
4099 list
4100 (if (integerp indices) (setq indices (list indices)))
4101 (setq i0 (1- (or i0 0)))
4102 (delq :rm (mapcar (lambda (x)
4103 (setq i0 (1+ i0))
4104 (if (memq i0 indices) :rm x))
4105 list))))
4107 (defun orgtbl-toggle-comment ()
4108 "Comment or uncomment the orgtbl at point."
4109 (interactive)
4110 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4111 (re2 (concat "^" orgtbl-line-start-regexp))
4112 (commented (save-excursion (beginning-of-line 1)
4113 (cond ((looking-at re1) t)
4114 ((looking-at re2) nil)
4115 (t (error "Not at an org table")))))
4116 (re (if commented re1 re2))
4117 beg end)
4118 (save-excursion
4119 (beginning-of-line 1)
4120 (while (looking-at re) (beginning-of-line 0))
4121 (beginning-of-line 2)
4122 (setq beg (point))
4123 (while (looking-at re) (beginning-of-line 2))
4124 (setq end (point)))
4125 (comment-region beg end (if commented '(4) nil))))
4127 (defun orgtbl-insert-radio-table ()
4128 "Insert a radio table template appropriate for this major mode."
4129 (interactive)
4130 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4131 (txt (nth 1 e))
4132 name pos)
4133 (unless e (error "No radio table setup defined for %s" major-mode))
4134 (setq name (read-string "Table name: "))
4135 (while (string-match "%n" txt)
4136 (setq txt (replace-match name t t txt)))
4138 (setq pos (point))
4139 (insert txt)
4140 (goto-char pos)))
4142 ;; Dynamically bound input and output for table formatting.
4143 (defvar *orgtbl-table* nil
4144 "Carries the current table through formatting routines.")
4145 (defvar *orgtbl-rtn* nil
4146 "Formatting routines push the output lines here.")
4147 ;; Formatting parameters for the current table section.
4148 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4149 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4150 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4151 (defvar *orgtbl-fmt* nil "Format for each entry.")
4152 (defvar *orgtbl-efmt* nil "Format for numbers.")
4153 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4154 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4155 (defvar *orgtbl-lstart* nil "Text starting a row.")
4156 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4157 (defvar *orgtbl-lend* nil "Text ending a row.")
4158 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4160 (defsubst orgtbl-get-fmt (fmt i)
4161 "Retrieve the format from FMT corresponding to the Ith column."
4162 (if (and (not (functionp fmt)) (consp fmt))
4163 (plist-get fmt i)
4164 fmt))
4166 (defsubst orgtbl-apply-fmt (fmt &rest args)
4167 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4168 (cond ((functionp fmt) (apply fmt args))
4169 (fmt (apply 'format fmt args))
4170 (args (car args))
4171 (t args)))
4173 (defsubst orgtbl-eval-str (str)
4174 "If STR is a function, evaluate it with no arguments."
4175 (if (functionp str)
4176 (funcall str)
4177 str))
4179 (defun orgtbl-format-line (line)
4180 "Format LINE as a table row."
4181 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4182 (let* ((i 0)
4183 (line
4184 (mapcar
4185 (lambda (f)
4186 (setq i (1+ i))
4187 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4188 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4189 (orgtbl-apply-fmt efmt (match-string 1 f)
4190 (match-string 2 f))
4191 f)))
4192 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4193 *orgtbl-default-fmt*)
4194 f)))
4195 line)))
4196 (push (if *orgtbl-lfmt*
4197 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4198 (concat (orgtbl-eval-str *orgtbl-lstart*)
4199 (mapconcat 'identity line *orgtbl-sep*)
4200 (orgtbl-eval-str *orgtbl-lend*)))
4201 *orgtbl-rtn*))))
4203 (defun orgtbl-format-section (section-stopper)
4204 "Format lines until the first occurrence of SECTION-STOPPER."
4205 (let (prevline)
4206 (progn
4207 (while (not (eq (car *orgtbl-table*) section-stopper))
4208 (if prevline (orgtbl-format-line prevline))
4209 (setq prevline (pop *orgtbl-table*)))
4210 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4211 (*orgtbl-lend* *orgtbl-llend*)
4212 (*orgtbl-lfmt* *orgtbl-llfmt*))
4213 (orgtbl-format-line prevline))))))
4215 (defun orgtbl-to-generic (table params)
4216 "Convert the orgtbl-mode TABLE to some other format.
4217 This generic routine can be used for many standard cases.
4218 TABLE is a list, each entry either the symbol `hline' for a horizontal
4219 separator line, or a list of fields for that line.
4220 PARAMS is a property list of parameters that can influence the conversion.
4221 For the generic converter, some parameters are obligatory: You need to
4222 specify either :lfmt, or all of (:lstart :lend :sep).
4224 Valid parameters are
4226 :splice When set to t, return only table body lines, don't wrap
4227 them into :tstart and :tend. Default is nil. When :splice
4228 is non-nil, this also means that the exporter should not look
4229 for and interpret header and footer sections.
4231 :hline String to be inserted on horizontal separation lines.
4232 May be nil to ignore hlines.
4234 :sep Separator between two fields
4235 :remove-nil-lines Do not include lines that evaluate to nil.
4238 Each in the following group may be either a string or a function
4239 of no arguments returning a string:
4240 :tstart String to start the table. Ignored when :splice is t.
4241 :tend String to end the table. Ignored when :splice is t.
4242 :lstart String to start a new table line.
4243 :llstart String to start the last table line, defaults to :lstart.
4244 :lend String to end a table line
4245 :llend String to end the last table line, defaults to :lend.
4247 Each in the following group may be a string, a function of one
4248 argument (the field or line) returning a string, or a plist
4249 mapping columns to either of the above:
4250 :lfmt Format for entire line, with enough %s to capture all fields.
4251 If this is present, :lstart, :lend, and :sep are ignored.
4252 :llfmt Format for the entire last line, defaults to :lfmt.
4253 :fmt A format to be used to wrap the field, should contain
4254 %s for the original field value. For example, to wrap
4256 This may also be a property list with column numbers and
4259 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4260 Same as above, specific for the header lines in the table.
4261 All lines before the first hline are treated as header.
4262 If any of these is not present, the data line value is used.
4264 This may be either a string or a function of two arguments:
4265 :efmt Use this format to print numbers with exponentials.
4266 The format should have %s twice for inserting mantissa
4268 may also be a property list with column numbers and
4269 formats. :fmt will still be applied after :efmt.
4271 In addition to this, the parameters :skip and :skipcols are always handled
4272 directly by `orgtbl-send-table'. See manual."
4273 (interactive)
4275 (let* ((splicep (plist-get params :splice))
4276 (hline (plist-get params :hline))
4277 (remove-nil-linesp (plist-get params :remove-nil-lines))
4278 (remove-newlines (plist-get params :remove-newlines))
4279 (*orgtbl-hline* hline)
4280 (*orgtbl-table* table)
4281 (*orgtbl-sep* (plist-get params :sep))
4282 (*orgtbl-efmt* (plist-get params :efmt))
4283 (*orgtbl-lstart* (plist-get params :lstart))
4284 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4285 (*orgtbl-lend* (plist-get params :lend))
4286 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4287 (*orgtbl-lfmt* (plist-get params :lfmt))
4288 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4289 (*orgtbl-fmt* (plist-get params :fmt))
4290 *orgtbl-rtn*)
4292 ;; Put header
4293 (unless splicep
4294 (when (plist-member params :tstart)
4295 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4296 (if tstart (push tstart *orgtbl-rtn*)))))
4298 ;; Do we have a heading section? If so, format it and handle the
4299 ;; trailing hline.
4300 (if (and (not splicep)
4301 (or (consp (car *orgtbl-table*))
4302 (consp (nth 1 *orgtbl-table*)))
4303 (memq 'hline (cdr *orgtbl-table*)))
4304 (progn
4305 (when (eq 'hline (car *orgtbl-table*))
4306 ;; there is a hline before the first data line
4307 (and hline (push hline *orgtbl-rtn*))
4308 (pop *orgtbl-table*))
4309 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4310 *orgtbl-lstart*))
4311 (*orgtbl-llstart* (or (plist-get params :hllstart)
4312 *orgtbl-llstart*))
4313 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4314 (*orgtbl-llend* (or (plist-get params :hllend)
4315 (plist-get params :hlend) *orgtbl-llend*))
4316 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4317 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4318 (plist-get params :hlfmt) *orgtbl-llfmt*))
4319 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4320 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4321 (orgtbl-format-section 'hline))
4322 (if hline (push hline *orgtbl-rtn*))
4323 (pop *orgtbl-table*)))
4325 ;; Now format the main section.
4326 (orgtbl-format-section nil)
4328 (unless splicep
4329 (when (plist-member params :tend)
4330 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4331 (if tend (push tend *orgtbl-rtn*)))))
4333 (mapconcat (if remove-newlines
4334 (lambda (tend)
4336 'identity)
4337 (nreverse (if remove-nil-linesp
4338 (remq nil *orgtbl-rtn*)
4341 (defun orgtbl-to-tsv (table params)
4342 "Convert the orgtbl-mode table to TAB separated material."
4344 (defun orgtbl-to-csv (table params)
4345 "Convert the orgtbl-mode table to CSV material.
4346 This does take care of the proper quoting of fields with comma or quotes."
4347 (orgtbl-to-generic table (org-combine-plists
4348 '(:sep "," :fmt org-quote-csv-field)
4349 params)))
4351 (defun orgtbl-to-latex (table params)
4352 "Convert the orgtbl-mode TABLE to LaTeX.
4353 TABLE is a list, each entry either the symbol `hline' for a horizontal
4354 separator line, or a list of fields for that line.
4355 PARAMS is a property list of parameters that can influence the conversion.
4356 Supports all parameters from `orgtbl-to-generic'. Most important for
4357 LaTeX are:
4359 :splice When set to t, return only table body lines, don't wrap
4360 them into a tabular environment. Default is nil.
4362 :fmt A format to be used to wrap the field, should contain %s for the
4363 original field value. For example, to wrap everything in dollars,
4366 The format may also be a function that formats its one argument.
4368 :efmt Format for transforming numbers with exponentials. The format
4369 should have %s twice for inserting mantissa and exponent, for
4371 This may also be a property list with column numbers and formats.
4372 The format may also be a function that formats its two arguments.
4374 :llend If you find too much space below the last line of a table,
4377 The general parameters :skip and :skipcols have already been applied when
4378 this function is called."
4379 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4380 org-table-last-alignment ""))
4381 (params2
4382 (list
4387 (orgtbl-to-generic table (org-combine-plists params2 params))))
4389 (defun orgtbl-to-html (table params)
4390 "Convert the orgtbl-mode TABLE to HTML.
4391 TABLE is a list, each entry either the symbol `hline' for a horizontal
4392 separator line, or a list of fields for that line.
4393 PARAMS is a property list of parameters that can influence the conversion.
4394 Currently this function recognizes the following parameters:
4396 :splice When set to t, return only table body lines, don't wrap
4397 them into a <table> environment. Default is nil.
4399 The general parameters :skip and :skipcols have already been applied when
4400 this function is called. The function does *not* use `orgtbl-to-generic',
4401 so you cannot specify parameters for it."
4402 (let* ((splicep (plist-get params :splice))
4403 (html-table-tag org-export-html-table-tag)
4404 html)
4405 ;; Just call the formatter we already have
4406 ;; We need to make text lines for it, so put the fields back together.
4407 (setq html (org-format-org-table-html
4408 (mapcar
4409 (lambda (x)
4410 (if (eq x 'hline)
4411 "|----+----|"
4412 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4413 table)
4414 splicep))
4416 (setq html (replace-match "" t t html)))
4417 html))
4419 (defun orgtbl-to-texinfo (table params)
4420 "Convert the orgtbl-mode TABLE to TeXInfo.
4421 TABLE is a list, each entry either the symbol `hline' for a horizontal
4422 separator line, or a list of fields for that line.
4423 PARAMS is a property list of parameters that can influence the conversion.
4424 Supports all parameters from `orgtbl-to-generic'. Most important for
4425 TeXInfo are:
4427 :splice nil/t When set to t, return only table body lines, don't wrap
4428 them into a multitable environment. Default is nil.
4430 :fmt fmt A format to be used to wrap the field, should contain
4431 %s for the original field value. For example, to wrap
4433 This may also be a property list with column numbers and
4435 Each format also may be a function that formats its one
4436 argument.
4439 are computed automatically from the width of the columns
4440 under org-mode.
4442 The general parameters :skip and :skipcols have already been applied when
4443 this function is called."
4444 (let* ((total (float (apply '+ org-table-last-column-widths)))
4445 (colfrac (or (plist-get params :cf)
4446 (mapconcat
4447 (lambda (x) (format "%.3f" (/ (float x) total)))
4448 org-table-last-column-widths " ")))
4449 (params2
4450 (list
4451 :tstart (concat "@multitable @columnfractions " colfrac)
4452 :tend "@end multitable"
4453 :lstart "@item " :lend "" :sep " @tab "
4454 :hlstart "@headitem ")))
4455 (orgtbl-to-generic table (org-combine-plists params2 params))))
4457 (defun orgtbl-to-orgtbl (table params)
4458 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4459 Useful when slicing one table into many. The :hline, :sep,
4460 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4461 and :tend suppress strings without splicing; they can be set to
4462 provide ORGTBL directives for the generated table."
4463 (let* ((params2
4464 (list
4465 :remove-newlines t
4466 :tstart nil :tend nil
4467 :hline "|---"
4468 :sep " | "
4469 :lstart "| "
4470 :lend " |"))
4471 (params (org-combine-plists params2 params)))
4472 (orgtbl-to-generic table params)))
4474 (defun org-table-get-remote-range (name-or-id form)
4475 "Get a field value or a list of values in a range from table at ID.
4477 NAME-OR-ID may be the name of a table in the current file as set by
4479 will then be used. Alternatively, it may be an ID referring to
4480 any entry, also in a different file. In this case, the first table
4481 in that entry will be referenced.
4485 The return value is either a single string for a single field, or a
4486 list of the fields in the rectangle ."
4487 (save-match-data
4488 (let ((id-loc nil)
4489 org-table-column-names org-table-column-name-regexp
4490 org-table-local-parameters org-table-named-field-locations
4491 org-table-current-line-types org-table-current-begin-line
4492 org-table-current-begin-pos org-table-dlines
4493 org-table-current-ncol
4494 org-table-hlines org-table-last-alignment
4495 org-table-last-column-widths org-table-last-alignment
4496 org-table-last-column-widths tbeg
4497 buffer loc)
4498 (setq form (org-table-convert-refs-to-rc form))
4499 (save-excursion
4500 (save-restriction
4501 (widen)
4502 (save-excursion
4503 (goto-char (point-min))
4504 (if (re-search-forward
4506 nil t)
4507 (setq buffer (current-buffer) loc (match-beginning 0))
4508 (setq id-loc (org-id-find name-or-id 'marker))
4509 (unless (and id-loc (markerp id-loc))
4511 (setq buffer (marker-buffer id-loc)
4512 loc (marker-position id-loc))
4513 (move-marker id-loc nil)))
4514 (with-current-buffer buffer
4515 (save-excursion
4516 (save-restriction
4517 (widen)
4518 (goto-char loc)
4519 (forward-char 1)
4521 (not (match-beginning 1)))
4522 (error "Cannot find a table at NAME or ID %s" name-or-id))
4523 (setq tbeg (point-at-bol))
4524 (org-table-get-specials)
4525 (setq form (org-table-formula-substitute-names form))
4526 (if (and (string-match org-table-range-regexp form)
4527 (> (length (match-string 0 form)) 1))
4528 (save-match-data
4529 (org-table-get-range (match-string 0 form) tbeg 1))
4530 form)))))))))
4532 (provide 'org-table)
4534 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4536 ;;; org-table.el ends here