| blob | a6f7ac4476587d08800b2fd3fe6a74007246b7d2 |
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.01trans
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the table editor and spreadsheet for Org-mode.
31 ;; Watch out: Here we are talking about two different kind of tables.
32 ;; Most of the code is for the tables created with the Org-mode table editor.
33 ;; Sometimes, we talk about tables created and edited with the table.el
34 ;; Emacs package. We call the former org-type tables, and the latter
35 ;; table.el-type tables.
37 ;;; Code:
52 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
53 In the optimized version, the table editor takes over all simple keys that
54 normally just insert a character. In tables, the characters are inserted
55 in a way to minimize disturbing the table structure (i.e. in overwrite mode
56 for empty fields). Outside tables, the correct binding of the keys is
57 restored.
59 The default for this option is t if the optimized version is also used in
60 Org-mode. See the variable `org-enable-table-editor' for details. Changing
61 this variable requires a restart of Emacs to become effective."
67 % END RECEIVE ORGTBL %n
69 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
70 | | |
73 @c END RECEIVE ORGTBL %n
74 @ignore
75 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
76 | | |
79 <!-- END RECEIVE ORGTBL %n -->
80 <!--
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
84 "Templates for radio tables in different major modes.
85 All occurrences of %n in a template will be replaced with the name of the
86 table, obtained by prompting the user."
93 "Settings for tables in Org-mode."
98 "The default size for newly created tables, Columns x Rows."
104 "Regular expression for recognizing numbers in table columns.
105 If a table column contains mostly numbers, it will be aligned to the
106 right. If not, it will be aligned to the left.
108 The default value of this option is a regular expression which allows
109 anything which looks remotely like a number as used in scientific
110 context. For example, all of the following will be considered a
111 number:
112 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
114 Other options offered by the customize interface are more restrictive."
132 "Fraction of numbers in a column required to make the column align right.
133 In a column all non-white fields are considered. If at least this
134 fraction of fields is matched by `org-table-number-fraction',
135 alignment to the right border applies."
140 "Behavior of tables during editing in Org-mode."
145 "Non-nil means automatically re-align table when pressing TAB or RETURN.
147 removal/insertion."
152 "Non-nil means automatically blank table field when starting to type into it.
153 This only happens when typing immediately after a field motion
154 command (TAB, S-TAB or RET).
155 Only relevant when `org-enable-table-editor' is equal to `optimized'."
160 "Non-nil means tab in the last column of a table with jump over a hline.
161 If a horizontal separator line is following the current line,
162 `org-table-next-field' can either create a new row before that line, or jump
163 over the line. When this option is nil, a new line will be created before
164 this line."
169 "Options concerning tables in Org-mode."
174 "Should org-mode work with table references like B3 instead of @3$2?
175 Possible values are:
176 nil never use them
177 from accept as input, do not present for editing
178 t: accept as input and present for editing"
193 calc-angle-mode deg
194 calc-prefer-frac nil
195 calc-symbolic-mode nil
197 calc-display-working-message t
198 )
199 "List with Calc mode settings for use in `calc-eval' for table formulas.
200 The list must contain alternating symbols (Calc modes variables and values).
201 Don't remove any of the default settings, just change the values. Org-mode
202 relies on the variables to be present in the list."
207 "Non-nil means TAB and RET evaluate a formula in current table field.
208 If the current field starts with an equal sign, it is assumed to be a formula
209 which should be evaluated as described in the manual and in the documentation
210 string of the command `org-table-eval-formula'. This feature requires the
211 Emacs calc package.
212 When this variable is nil, formula calculation is only available through
218 "Non-nil means interpret constants in formulas in tables.
219 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
220 by the value given in `org-table-formula-constants', or by a value obtained
221 from the `constants.el' package."
226 "Alist with constant names and values, for use in table formulas.
227 The car of each element is a name of a constant, without the `$' before it.
228 The cdr is the value as a string. For example, if you'd like to use the
229 speed of light in a formula, you would configure
233 and then use it in an equation like `$1*$c'.
235 Constants can also be defined on a per-file basis using a line like
237 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
244 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
245 Automatically means when TAB or RET or C-c C-c are pressed in the line."
250 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
255 "Non-nil means relative formula references may cross hlines.
256 Here are the allowed values:
258 nil Relative references may not cross hlines. They will reference the
259 field next to the hline instead. Coming from below, the reference
260 will be to the field below the hline. Coming from above, it will be
261 to the field above.
262 t Relative references may cross hlines.
263 error An attempt to cross a hline will throw an error.
265 It is probably good to never set this variable to nil, for the sake of
266 portability of tables."
274 "Options concerning table import and export in Org-mode."
279 "Default export parameters for `org-table-export'.
280 These can be overridden for a specific table by setting the
281 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
282 radio tables for the different export transformations and
283 available parameters."
319 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
320 ;; 1 2 3 4 5
331 "Is this a table line colgroup information?"
335 line)
337 nil
344 "Is this a table line with only alignment/width cookies?"
362 "Use the table.el package to insert a new table.
363 If there is already a table at point, convert between Org-mode tables
364 and table.el tables."
378 "Convert region to table, or create an empty table.
379 If there is an active region, convert it to a table, using the function
380 `org-table-convert-region'. See the documentation of that function
381 to learn how the prefix argument is interpreted to determine the field
382 separator.
383 If there is no such region, create an empty table with `org-table-create'."
390 "Query for a size and insert a table skeleton.
410 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
414 ;; Insert a hline after the first row.
422 "Convert region to a table.
423 The region goes from BEG0 to END0, but these borders will be moved
424 slightly, to make sure a beginning of line in the first line is included.
426 SEPARATOR specifies the field separator in the lines. It can have the
427 following values:
429 '(4) Use the comma as a field separator
430 '(16) Use a TAB as field separator
431 integer When a number, use that many spaces as field separator
432 nil When nil, the command tries to be smart and figure out the
433 separator in the following way:
434 - when each line contains a TAB, assume TAB-separated material
435 - when each line contains a comma, assume CSV material
436 - else, assume one or more SPACE characters as separator."
440 re)
447 ;; Get the right field separator
458 ;; parse the csv stuff
480 "Import FILE as a table.
481 The file is assumed to be tab-separated. Such files can be produced by most
482 spreadsheet and database applications. If no tabs (at least one per line)
483 are found, lines will be split on whitespace into fields."
495 "Export table to a file, with configurable format.
496 Such a file can be imported into a spreadsheet program like Excel.
497 FILE can be the output file name. If not given, it will be taken from
498 a TABLE_EXPORT_FILE property in the current entry or higher up in the
499 hierarchy, or the user will be prompted for a file name.
500 FORMAT can be an export format, of the same kind as it used when
501 `orgtbl-mode' sends a table in a different format. The default format can
502 be found in the variable `org-table-export-default-format', but the function
503 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
504 property, locally or anywhere up in the hierarchy."
521 buf deffmt-readable)
540 "Format: "
545 deffmt-readable)))
558 'hline
561 skipcols i0)))
562 lines))
566 skipcols i0))
569 skipcols i0)))
586 "Marker at the beginning of the table last aligned.
589 "Marker at the end of the table last aligned.
592 "List of flags for flushright alignment, from the last re-alignment.
595 "List of max width of fields in each column.
598 "Non-nil means debug table formulas.
611 "Align the table at point by aligning all vertical bars."
614 ;; Limits of table
617 ;; Current cursor position
623 column
625 rfmt hfmt
633 emptystrings links dates emph raise narrow
634 falign falign1 fmax f1 len c e space)
637 ;; Check if we have links or dates
649 ;; Make sure the link properties are right
651 ;; Make sure the date properties are right
656 ;; Check if we are narrowing any columns
659 org-format-transports-properties-p
664 ;; Get the rows
667 ;; Store the indentation of the first line
670 ;; Mark the hlines by setting the corresponding element to nil
671 ;; At the same time, we remove trailing space.
674 nil
677 l)))
678 lines))
679 ;; Get the data fields by splitting the lines.
684 ;; How many fields in the longest line?
691 ;; A list of empty strings to fill any short rows on output
693 ;; Check for special formatting.
697 ;; Check if there is an explicit width specified
707 ;; Find fields that are wider than fmax, and shorten them
713 'help-echo
714 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
722 xx)))))
723 ;; Get the maximum width for each column
725 lengths)
726 ;; Get the fraction of numbers, to decide about alignment of the column
732 nil
739 ;; Store the alignment of this table, for later editing of single fields
741 org-table-last-column-widths lengths)
743 ;; With invisible characters, `format' does not get the field width right
744 ;; So we need to make these fields wide by hand.
762 ;; Compute the formats needed for output of the table
775 hfmt))
778 ;; This hack is for org-indent, to force redisplay of the
779 ;; line prefix of the first line. Apparently the redisplay
780 ;; is tied to the newline, which is, I think, a bug.
781 ;; To force this redisplay, we remove and re-insert the
782 ;; newline, so that the redisplay engine thinks it belongs
783 ;; to the changed text.
789 ;; Replace the old one
796 ;; Try to move to the old location
804 ))
807 "Find the beginning of the table and return its position.
808 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
812 org-table-border-regexp)
813 nil t))
820 "Find the end of the table and return its position.
821 With argument TABLE-TYPE, go to the end of a table.el-type table."
825 org-table-border-regexp)
826 nil t))
832 "Justify the current field, text to left, number to right.
833 Optional argument NEW may specify text to replace the current field content."
842 ;; This is not the same table, force a full re-align
848 l f n o e)
872 "Go to the next field in the current table, creating new lines as needed.
873 Before doing so, re-align the table if necessary."
878 org-table-may-need-update)
889 org-table-tab-jumps-over-hlines
901 "Go to the previous field in the table.
902 Before doing so, re-align the table if necessary."
907 org-table-may-need-update)
922 "Move to the end of the current table field.
923 If already at or after the end, move to the end of the next table field.
924 With numeric argument N, move N-1 fields forward first."
937 "Move to the beginning of the current table field.
938 If already at or before the beginning, move to the beginning of the
939 previous field.
940 With numeric argument N, move N-1 fields backward first."
954 "Go to the next row (same column) in the current table.
955 Before doing so, re-align the table if necessary."
963 org-table-may-need-update)
977 "Copy a field down in the current column.
978 If the field at the cursor is empty, copy into it the content of the nearest
979 non-empty field above. With argument N, use the Nth non-empty field.
980 If the current field is not empty, it is copied down to the next row, and
981 the cursor is moved with it. Therefore, repeating this command causes the
982 column to be filled row-by-row.
983 If the variable `org-table-copy-increment' is non-nil and the field is an
984 integer or a timestamp, it will be incremented while copying. In the case of
985 a timestamp, if the cursor is on the year, change the year. If it is on the
986 month or the day, change that. Point will stay on the current date field
987 in order to easily repeat the interval."
995 txt)
1007 beg t))
1030 "Is point inside a table data field?
1031 I.e. not on a hline or before the first or after the last column?
1032 This actually throws an error, so it aborts the current command."
1043 "Get the field in table line LINE, column COLUMN.
1044 If LINE is larger than the number of data lines in the table, the function
1045 returns nil. However, if COLUMN is too large, we will simply return an
1046 empty string.
1047 If LINE is nil, use the current line.
1048 If column is nil, use the current column."
1055 "Put VALUE into line LINE, column COLUMN.
1056 When ALIGN is set, also realign the table."
1065 "Return the index of the current data line."
1072 cnt))
1075 "Go to the Nth data line in the current table.
1076 Return t when the line exists, nil if it does not exist."
1084 "Blank the current table field or active region."
1101 "Return the value of the field in column N of current row.
1102 N defaults to current field.
1103 If REPLACE is a string, replace field with this value. The return value
1104 is always the old value."
1114 val)
1118 "Show info about the current field, and highlight any reference at point."
1126 org-table-named-field-locations)))
1139 dline col
1141 dline col ref1
1143 ;; FIXME: formula info not correct if special table line
1153 "Find out which column we are in."
1159 cnt)))
1162 "Find out what table data line we are in.
1163 Only data lines count for this."
1173 cnt)))
1176 "Move the cursor to the Nth column in the current table line.
1177 With optional argument ON-DELIM, stop with point before the left delimiter
1178 of the field.
1179 If there are less than N fields, just go to after the last delimiter.
1180 However, when FORCE is non-nil, create new columns if necessary."
1190 t)))))
1198 "Insert a new column into the table."
1206 ;; Current cursor position
1212 nil
1224 "Find a data line in the current table, which is needed for column commands."
1227 t
1238 t
1243 "Delete a column from the table."
1252 ;; Current cursor position
1258 nil
1273 "Move column to the right."
1277 "Move column to the left."
1282 "Move the current column to the right. With arg LEFT, move to the left."
1292 ;; Current cursor position
1302 nil
1319 "Move table row down."
1323 "Move table row up."
1328 "Move the current table line down. With arg UP, move it up."
1337 txt hline2p)
1358 "Insert a new row above the current line into the table.
1359 With prefix ARG, insert below the current line."
1365 ;; Fix the first field if necessary
1377 "Insert a horizontal-line below the current line into the table.
1378 With prefix ABOVE, insert above the current line."
1400 "Insert a hline and move to the row below that line."
1414 In particular, this does handle wide and invisible characters."
1416 ;; It's a hline, just map the characters
1422 t t s)))
1423 s))
1426 "Delete the current row or horizontal line from the table."
1439 "Sort table lines according to the column at point.
1441 The position of point indicates the column to be used for
1442 sorting, and the range of lines is the range between the nearest
1443 horizontal separator lines, or the entire table of no such lines
1444 exist. If point is before the first column, you will be prompted
1445 for the sorting column. If there is an active region, the mark
1446 specifies the first line and the sorting column, while point
1447 should be in the last line to be included into the sorting.
1449 The command then prompts for the sorting type which can be
1450 alphabetically, numerically, or by time (as given in a time stamp
1451 in the field). Sorting in reverse order is also possible.
1453 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1455 If SORTING-TYPE is specified when this function is called from a Lisp
1456 program, no prompting will take place. SORTING-TYPE must be a character,
1457 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1458 should be done in reverse order."
1462 beg end bcol ecol tend tbeg column lns pos)
1507 x))
1520 "Copy region in table to the clipboard and blank all relevant fields.
1521 If there is no active region, use just the field at point."
1528 "Copy rectangular region in table to clipboard.
1529 A special clipboard is used which can only be accessed
1530 with `org-table-paste-rectangle'."
1534 current-prefix-arg))
1536 region cols
1562 org-table-clip))
1565 "Paste a rectangular region into a table.
1566 The upper right corner ends up in the current field. All involved fields
1567 will be overwritten. If the rectangle does not fit into the present table,
1568 the table is enlarged as needed. The process ignores horizontal separator
1569 lines."
1579 c cols field)
1595 "Convert from `org-mode' table to table.el and back.
1596 Obviously, this only works within limits. When an Org-mode table is
1597 converted to table.el, all horizontal separator lines get lost, because
1598 table.el uses these as cell boundaries and has no notion of horizontal lines.
1599 A table.el table can be converted to an Org-mode table only if it does not
1600 do row or column spanning. Multiline cells will become multiple cells.
1601 Beware, Org-mode does not test if the table can be successfully converted - it
1602 blindly applies a recipe that works for simple tables."
1606 ;; convert to Org-mode table
1615 ;; convert to table.el table
1618 ;; first, get rid of all horizontal lines
1622 ;; insert a hline before first
1626 ;; insert a hline after each line
1631 ;; replace "+" at beginning and ending of hlines
1640 "Wrap several fields in a column like a paragraph.
1641 This is useful if you'd like to spread the contents of a field over several
1642 lines, in order to keep the table compact.
1644 If there is an active region, and both point and mark are in the same column,
1645 the text in the column is wrapped to minimum width for the given number of
1646 lines. Generally, this makes the table more compact. A prefix ARG may be
1648 formats the selected text to two lines. If the region was longer than two
1649 lines, the remaining lines remain empty. A negative prefix argument reduces
1650 the current number of lines by that amount. The wrapped text is pasted back
1651 into the table. If you formatted it to more lines than it was before, fields
1652 further down in the table get overwritten - so you might need to make space in
1653 the table first.
1655 If there is no region, the current field is split at the cursor position and
1656 the text fragment to the right of the cursor is prepended to the field one
1657 line down.
1659 If there is no region, but you specify a prefix ARG, the current field gets
1660 blank, and the content is appended to the field above."
1664 ;; There is a region: fill as a paragraph
1668 nlines)
1675 arg)
1679 nil nlines)))
1683 ;; No region, split the current field at point
1687 ;; combine with field above
1697 ;; split field
1710 "Edit table field in a different window.
1711 This is mainly useful for fields that contain hidden parts.
1713 it can be edited in place."
1719 display t intangible t))
1725 p)
1734 intangible t))
1742 "Finish editing a table data field.
1743 Remove all newline characters, insert the result into the table, realign
1744 the table and kill the editing buffer."
1748 text)
1767 "Sum numbers in region of current table column.
1768 The result will be displayed in the echo area, and will be available
1771 If there is an active region, it is interpreted as a rectangle and all
1772 numbers in that rectangle will be summed. If there is no active
1773 region and point is located in a table column, sum all numbers in that
1774 column.
1776 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1777 numbers are assumed to be times as well (in decimal hours) and the
1778 numbers are added as such.
1780 If NLAST is a number, only the NLAST fields will actually be summed."
1807 items1)))
1814 s diff)
1822 sres))))
1845 "Return the formula active for the current field.
1846 Assumes that specials are in place.
1847 If KEY is given, return the key to this formula.
1851 org-table-named-field-locations)))
1865 "Read a formula from the minibuffer, offer stored formula as default.
1866 When NAMED is non-nil, look for a named equation."
1870 org-table-named-field-locations)))
1877 name
1878 ref)
1888 stored)
1890 equation)
1897 scol))
1899 'org-table-formula-history
1900 )))))
1901 mustsave)
1903 ;; remove formula
1910 ;; We set the column equation, delete the named one.
1912 mustsave t))
1918 eq))
1921 "Store the list of formulas below the current table."
1927 ;; don't overwrite TBLFM, we might use text properties to store stuff
1948 "Compare two formulas for sorting."
1954 "Return an alist with the stored formulas directly after current table."
1962 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1979 "Modify the equations after the table structure has been edited.
1981 For all numbers larger than LIMIT, shift them by DELTA."
1992 s n a)
2005 t t)))))))))
2008 "Get the column names and local parameters for this table."
2011 names name fields fields1 field cnt
2012 c v l line col types dlines hlines last-dline)
2014 org-table-local-parameters nil
2015 org-table-named-field-locations nil
2016 org-table-current-begin-line nil
2017 org-table-current-begin-pos nil
2018 org-table-current-line-types nil)
2036 org-table-local-parameters))))
2052 ;; Analyse the line types
2056 l org-table-current-begin-line)
2073 al al2)
2085 If yes, store the formula and apply it."
2086 ;; We already know we are in a table. Get field will only return a formula
2087 ;; when appropriate. It might return a separator line, but no problem.
2090 named eq)
2101 "List of commands triggering the recalculation of a line.
2114 "Rotate the recalculation mark in the first column.
2115 If in any row, the first field is not consistent with a mark,
2116 insert a new column for the markers.
2117 When there is an active region, change all the lines in the region,
2118 after prompting for the marking character.
2119 After each change, a message will be displayed indicating the meaning
2120 of the new mark."
2135 epos new)
2142 newchar))
2174 "Recompute the current line if marked for it, and if we haven't just done it."
2194 modes)
2197 suppress-align suppress-const
2198 suppress-store suppress-analysis)
2199 "Replace the table field value at the cursor by the result of a calculation.
2201 This function makes use of Dave Gillespie's Calc package, in my view the
2202 most exciting program ever written for GNU Emacs. So you need to have Calc
2203 installed in order to use this function.
2205 In a table, this command replaces the value in the current field with the
2207 formula, by storing it in a special line below the table. When called
2208 with a `C-u' prefix, the current field must be a named field, and the
2209 formula is installed as valid in only this specific field.
2211 When called with two `C-u' prefixes, insert the active equation
2212 for the field back into the current field, so that it can be
2214 to check the referenced fields.
2216 When called, the command first prompts for a formula, which is read in
2217 the minibuffer. Previously entered formulas are available through the
2218 history list, and the last used formula is offered as a default.
2219 These stored formulas are adapted correctly when moving, inserting, or
2220 deleting columns with the corresponding commands.
2222 The formula can be any algebraic expression understood by the Calc package.
2223 For details, see the Org-mode manual.
2225 This function can also be called from Lisp programs and offers
2226 additional arguments: EQUATION can be the formula to apply. If this
2227 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2228 used to speed-up recursive calls by by-passing unnecessary aligns.
2229 SUPPRESS-CONST suppresses the interpretation of constants in the
2230 formula, assuming that this has been done already outside the function.
2231 SUPPRESS-STORE means the formula should not be stored, either because
2232 it is already stored, or because it is a modified equation that should
2233 not overwrite the stored one."
2249 equation
2255 n form form0 bw fmt x ev orig c lispp literal)
2256 ;; Parse the format string. Since we have a lot of modes, this is
2257 ;; a lot of work. However, I think calc still uses most of the time.
2269 'calc-float-format
2272 n))))
2299 fields)))
2305 ;; Insert row and column number of formula result field
2316 t t form)))
2318 ;; Check for old vertical references
2320 ;; Insert remote references
2328 keep-empty numbers lispp))
2329 t t form)))
2330 ;; Insert complex ranges
2338 keep-empty numbers lispp))
2339 t t form)))
2340 ;; Insert simple ranges
2349 keep-empty numbers lispp))
2350 t t form)))
2352 ;; Insert the references to fields in same row
2361 t t form)))
2376 Orig: %s
2377 $xyz-> %s
2378 @r$c-> %s
2409 prop value)))
2412 "Get a calc vector from a column, according to descriptor DESC.
2413 Optional arguments TBEG and COL can give the beginning of the table and
2414 the current column, to avoid unnecessary parsing.
2415 HIGHLIGHT means just highlight the range."
2422 beg end c1 c2 r1 r2 rangep tmp)
2439 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2445 ;; just one field
2452 ;; A range, return a vector
2453 ;; First sort the numbers to get a regular ractangle
2469 ;; return string representation of calc vector
2474 "Analyze descriptor DESC and retrieve the corresponding line number.
2475 The cursor is currently in line CLINE, the table begins in line BLINE,
2476 and TABLE is a vector with line types."
2484 ;; 1 2 3 4 5 6
2504 nil hn cline desc)))
2507 rel on cline desc)))
2511 "FIXME: Needs more documentation."
2524 nil))
2525 t)))
2529 desc cline)
2530 i)))
2535 s))
2538 "Convert list ELEMENTS to something appropriate to insert into formula.
2539 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2540 NUMBERS indicates that everything should be converted to numbers.
2541 LISPP means to return something appropriate for a Lisp list."
2545 elements
2554 elements))))
2560 x
2566 elements
2570 "Recalculate the current table line by applying all stored formulas.
2571 With prefix arg ALL, do this for all lines in the table.
2572 With the prefix argument ALL is `(16)' \
2574 it is the symbol `iterate', recompute the table until it no longer changes.
2575 If NOALIGN is not nil, do not re-align the table after the computations
2576 are done. This is typically used internally to save time, if it is
2577 known that the table will be realigned a little later anyway."
2592 ;; Insert constants in all formulas
2596 x)
2597 eqlist))
2598 ;; Split the equation list
2609 ;; This is a table with marked lines, compute selected lines
2611 ;; Move forward to the first non-header line
2622 ;; First find the named fields, and mark them untouchable
2634 name)))
2643 ;; Now evaluate the column formulas, but skip fields covered by
2644 ;; field formulas
2648 ;; Unprotected line, recalculate
2660 ;; Now evaluate the field formulas
2674 ;; back to initial position
2682 "Recalculate the table until it does not change anymore."
2687 thistbl)
2702 "Recalculate all tables in the current buffer."
2710 "Iterate all tables in the buffer, to converge inter-table dependencies."
2715 c1
2732 "Replace $const with values in string F."
2734 ;; First, check for column names
2739 ;; Parameters and constants
2741 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2751 f))
2754 "Find the value for a parameter or constant in a formula.
2755 Parameters get priority."
2786 map))
2793 "--"
2796 "--"
2797 "Shift Reference at Point"
2802 "-"
2803 "Change Test Row for Column Formulas"
2806 "--"
2811 org-table-overlay-coordinates)]
2812 "--"
2819 "Edit the formulas of the current table in a separate buffer."
2835 entry s type title)
2838 ;; Keep global-font-lock-mode from turning on font-lock-mode
2878 "Convert a formula from internal to user representation."
2881 s))
2884 "Convert a formula from user to internal representation."
2887 s))
2890 "Convert spreadsheet references from AB7 to @7$28.
2891 Works for single references, but also for entire formulas and even the
2892 full TBLFM line."
2894 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2897 ;; format match, just advance
2902 ;; 3.e5 or something like this.
2905 ;; (member (match-string 1 s)
2906 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2907 )
2908 ;; function name, just advance
2918 t t s)))))
2919 s))
2922 "Convert spreadsheet references from to @7$28 to AB7.
2923 Works for single references, but also for entire formulas and even the
2924 full TBLFM line."
2931 t t s)))
2936 t nil s)))
2937 s)
2940 "Convert a base 26 number represented by letters into an integer.
2941 For example: AB -> 28."
2947 n))
2950 "Convert an integer into a base 26 number represented by letters.
2951 For example: 28 -> AB."
2956 s))
2959 "Convert all references in this buffer, using FUNCTION."
2969 "Convert all references in the buffer from B3 to @3$2 and back."
2979 "Shift the reference at point one row/hline up."
2983 "Shift the reference at point one row/hline down."
2987 "Shift the reference at point one field to the left."
2991 "Shift the reference at point one field to the right."
3002 ;; A B3-like reference
3008 ;; An internal reference
3014 "Re-match the group N, and replace it with the shifted reference."
3019 t t)))
3022 "Shift a reference part REF.
3023 If DECR is set, decrease the references row/column, else increase.
3024 If HLINE is set, this may be a hline reference, it certainly is not
3025 a translation reference."
3054 "Toggle the display of coordinates in the referenced table."
3063 "Parse the buffer for formula definitions and install them.
3064 With prefix ARG, apply the new formulas to the table."
3075 nil t)
3099 "Abort editing formulas, without installing the changes."
3110 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3151 "Show the location/value of the $ expression at point."
3160 var name e what match dest)
3242 ;; column number
3270 org-table-fedit-scroll-down))))
3281 "Make sure the cursor is in a dataline in a table."
3290 p1 p2)))
3295 "Move cursor one line up in the window showing the table."
3300 "Move cursor one line down in the window showing the table."
3305 "Move the cursor in the window showing the table.
3306 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3331 "Add a new overlay."
3337 "Highlight rectangular region in a table."
3341 l1 c1 l2 c2 tmp)
3365 "Remove the rectangle overlays."
3376 "Add overlays to the table at point, to show row/column coordinates."
3405 "Toggle the display of Row/Column numbers in tables."
3417 "Toggle the formula debugger in tables."
3423 ;;; The orgtbl minor mode
3425 ;; Define a minor mode which can be used in other modes in order to
3426 ;; integrate the org-mode table editor.
3428 ;; This is really a hack, because the org-mode table editor uses several
3429 ;; keys which normally belong to the major mode, for example the TAB and
3430 ;; RET keys. Here is how it works: The minor mode defines all the keys
3431 ;; necessary to operate the table editor, but wraps the commands into a
3432 ;; function which tests if the cursor is currently inside a table. If that
3433 ;; is the case, the table editor command is executed. However, when any of
3434 ;; those keys is used outside a table, the function uses `key-binding' to
3435 ;; look up if the key has an associated command in another currently active
3436 ;; keymap (minor modes, major mode, global), and executes that command.
3437 ;; There might be problems if any of the keys used by the table editor is
3438 ;; otherwise used as a prefix key.
3440 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3441 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3442 ;; addresses this by checking explicitly for both bindings.
3444 ;; The optimized version (see variable `orgtbl-optimized') takes over
3445 ;; all keys which are bound to `self-insert-command' in the *global map*.
3446 ;; Some modes bind other commands to simple characters, for example
3447 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3448 ;; active, this binding is ignored inside tables and replaced with a
3449 ;; modified self-insert.
3455 ;;;###autoload
3457 "Unconditionally turn on `orgtbl-mode'."
3472 ;; Install it as a minor mode.
3476 ;;;###autoload
3478 "The `org-mode' table editor as a minor mode for use in other modes."
3483 ;; Exit without error, in case some hook functions calls this
3484 ;; by accident in org-mode.
3488 ;; Make sure we are first in minor-mode-map-alist
3490 ;; FIXME: maybe it should use emulation-mode-map-alists?
3497 auto-fill-inhibit-regexp)
3501 auto-fill-inhibit-regexp)
3502 orgtbl-line-start-regexp))
3520 "Remove all properties related to narrow-column invisibility."
3533 "Create a function for binding in the table minor mode.
3534 FUN is the command to call inside a table. N is used to create a unique
3535 command name. KEYS are keys that should be checked in for a command
3536 to execute outside of tables."
3542 "Outside of tables, run the binding of `"
3554 keys)
3558 "Error when there is no default binding for a table key."
3563 "Setup orgtbl keymaps."
3593 elt key fun cmd)
3601 ;; Special treatment needed for TAB and RET
3621 [(tab)] "\C-i")))
3623 (org-defkey orgtbl-mode-map [backtab]
3625 [backtab] [S-iso-lefttab] [(shift tab)]
3626 [(tab)] "\C-i"))
3628 (org-defkey orgtbl-mode-map "\M-\C-m"
3629 (orgtbl-make-binding 'org-table-wrap-region 105
3630 "\M-\C-m" [(meta return)]))
3631 (org-defkey orgtbl-mode-map [(meta return)]
3632 (orgtbl-make-binding 'org-table-wrap-region 106
3633 [(meta return)] "\M-\C-m"))
3635 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3636 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3638 (when orgtbl-optimized
3639 ;; If the user wants maximum table support, we need to hijack
3640 ;; some standard editing functions
3641 (org-remap orgtbl-mode-map
3642 'self-insert-command 'orgtbl-self-insert-command
3643 'delete-char 'org-delete-char
3644 'delete-backward-char 'org-delete-backward-char)
3645 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3646 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3647 '("OrgTbl"
3648 ["Create or convert" org-table-create-or-convert-from-region
3649 :active (not (org-at-table-p)) :keys "C-c |" ]
3650 "--"
3651 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3652 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3653 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3654 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3655 "--"
3656 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3657 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3658 ["Copy Field from Above"
3659 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3660 "--"
3661 ("Column"
3662 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3663 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3664 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3665 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3666 ("Row"
3667 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3668 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3669 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3670 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3671 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3672 "--"
3673 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3674 ("Rectangle"
3675 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3676 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3677 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3678 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3679 "--"
3680 ("Radio tables"
3681 ["Insert table template" orgtbl-insert-radio-table
3682 (assq major-mode orgtbl-radio-table-templates)]
3683 ["Comment/uncomment table" orgtbl-toggle-comment t])
3684 "--"
3685 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3686 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3687 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3688 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3689 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3690 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3691 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3692 ["Sum Column/Rectangle" org-table-sum
3693 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3694 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3695 ["Debug Formulas"
3696 org-table-toggle-formula-debugger :active (org-at-table-p)
3697 :keys "C-c {"
3698 :style toggle :selected org-table-formula-debug]
3699 ["Show Col/Row Numbers"
3700 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3701 :keys "C-c }"
3702 :style toggle :selected org-table-overlay-coordinates]
3703 ))
3704 t))
3706 (defun orgtbl-ctrl-c-ctrl-c (arg)
3707 "If the cursor is inside a table, realign the table.
3708 If it is a table to be sent away to a receiver, do it.
3709 With prefix arg, also recompute table."
3710 (interactive "P")
3711 (let ((pos (point)) action)
3712 (save-excursion
3713 (beginning-of-line 1)
3717 (cond
3718 ((integerp action)
3719 (goto-char action)
3720 (org-table-maybe-eval-formula)
3721 (if arg
3722 (call-interactively 'org-table-recalculate)
3723 (org-table-maybe-recalculate-line))
3724 (call-interactively 'org-table-align)
3725 (orgtbl-send-table 'maybe))
3726 ((eq action 'recalc)
3727 (save-excursion
3728 (beginning-of-line 1)
3730 (if (org-at-table-p)
3731 (org-call-with-arg 'org-table-recalculate t))))
3732 (t (let (orgtbl-mode)
3733 (call-interactively (key-binding "\C-c\C-c")))))))
3735 (defun orgtbl-create-or-convert-from-region (arg)
3736 "Create table or convert region to table, if no conflicting binding.
3737 This installs the table binding `C-c |', but only if there is no
3738 conflicting binding to this key outside orgtbl-mode."
3739 (interactive "P")
3740 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3741 (if cmd
3742 (call-interactively cmd)
3743 (call-interactively 'org-table-create-or-convert-from-region))))
3745 (defun orgtbl-tab (arg)
3746 "Justification and field motion for `orgtbl-mode'."
3747 (interactive "P")
3748 (if arg (org-table-edit-field t)
3749 (org-table-justify-field-maybe)
3750 (org-table-next-field)))
3752 (defun orgtbl-ret ()
3753 "Justification and field motion for `orgtbl-mode'."
3754 (interactive)
3755 (if (bobp)
3756 (newline)
3757 (org-table-justify-field-maybe)
3758 (org-table-next-row)))
3760 (defun orgtbl-self-insert-command (N)
3761 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3762 If the cursor is in a table looking at whitespace, the whitespace is
3763 overwritten, and the table is not marked as requiring realignment."
3764 (interactive "p")
3765 (if (and (org-at-table-p)
3766 (or
3767 (and org-table-auto-blank-field
3768 (member last-command
3769 '(orgtbl-hijacker-command-100
3770 orgtbl-hijacker-command-101
3771 orgtbl-hijacker-command-102
3772 orgtbl-hijacker-command-103
3773 orgtbl-hijacker-command-104
3774 orgtbl-hijacker-command-105
3775 yas/expand))
3776 (org-table-blank-field))
3777 t)
3778 (eq N 1)
3780 (let (org-table-may-need-update)
3781 (goto-char (1- (match-end 0)))
3782 (delete-backward-char 1)
3783 (goto-char (match-beginning 0))
3784 (self-insert-command N))
3785 (setq org-table-may-need-update t)
3786 (let* (orgtbl-mode
3787 a
3788 (cmd (or (key-binding
3789 (or (and (listp function-key-map)
3790 (setq a (assoc last-input-event function-key-map))
3791 (cdr a))
3792 (vector last-input-event)))
3793 'self-insert-command)))
3794 (call-interactively cmd)
3795 (if (and org-self-insert-cluster-for-undo
3796 (eq cmd 'self-insert-command))
3797 (if (not (eq last-command 'orgtbl-self-insert-command))
3798 (setq org-self-insert-command-undo-counter 1)
3799 (if (>= org-self-insert-command-undo-counter 20)
3800 (setq org-self-insert-command-undo-counter 1)
3801 (and (> org-self-insert-command-undo-counter 0)
3802 buffer-undo-list
3803 (not (cadr buffer-undo-list)) ; remove nil entry
3804 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3805 (setq org-self-insert-command-undo-counter
3806 (1+ org-self-insert-command-undo-counter))))))))
3809 "Regular expression matching exponentials as produced by calc.")
3811 (defun orgtbl-export (table target)
3812 (require 'org-exp)
3813 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3815 org-table-last-alignment org-table-last-column-widths
3816 maxcol column)
3817 (if (not (fboundp func))
3818 (error "Cannot export orgtbl table to %s" target))
3819 (setq lines (org-table-clean-before-export lines))
3820 (setq table
3821 (mapcar
3822 (lambda (x)
3823 (if (string-match org-table-hline-regexp x)
3824 'hline
3826 lines))
3827 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3828 table)))
3829 (loop for i from (1- maxcol) downto 0 do
3830 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3831 (setq column (delq nil column))
3832 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3833 (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))
3834 (funcall func table nil)))
3836 (defun orgtbl-gather-send-defs ()
3837 "Gather a plist of :name, :transform, :params for each destination before
3838 a radio table."
3839 (save-excursion
3840 (goto-char (org-table-begin))
3841 (let (rtn)
3842 (beginning-of-line 0)
3843 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3844 (let ((name (org-no-properties (match-string 1)))
3845 (transform (intern (match-string 2)))
3846 (params (if (match-end 3)
3847 (read (concat "(" (match-string 3) ")")))))
3848 (push (list :name name :transform transform :params params)
3849 rtn)
3850 (beginning-of-line 0)))
3851 rtn)))
3853 (defun orgtbl-send-replace-tbl (name txt)
3854 "Find and replace table NAME with TXT."
3855 (save-excursion
3856 (goto-char (point-min))
3857 (unless (re-search-forward
3859 (error "Don't know where to insert translated table"))
3860 (goto-char (match-beginning 0))
3861 (beginning-of-line 2)
3862 (save-excursion
3863 (let ((beg (point)))
3864 (unless (re-search-forward
3865 (concat "END RECEIVE ORGTBL +" name) nil t)
3866 (error "Cannot find end of insertion region"))
3867 (beginning-of-line 1)
3868 (delete-region beg (point))))
3871 ;;;###autoload
3872 (defun org-table-to-lisp (&optional txt)
3873 "Convert the table at point to a Lisp structure.
3874 The structure will be a list. Each item is either the symbol `hline'
3875 for a horizontal separator line, or a list of field values as strings.
3876 The table is taken from the parameter TXT, or from the buffer at point."
3877 (unless txt
3878 (unless (org-at-table-p)
3879 (error "No table at point")))
3880 (let* ((txt (or txt
3881 (buffer-substring-no-properties (org-table-begin)
3882 (org-table-end))))
3885 (mapcar
3886 (lambda (x)
3887 (if (string-match org-table-hline-regexp x)
3888 'hline
3890 lines)))
3892 (defun orgtbl-send-table (&optional maybe)
3893 "Send a transformed version of this table to the receiver position.
3894 With argument MAYBE, fail quietly if no transformation is defined for
3895 this table."
3896 (interactive)
3897 (catch 'exit
3898 (unless (org-at-table-p) (error "Not at a table"))
3899 ;; when non-interactive, we assume align has just happened.
3900 (when (interactive-p) (org-table-align))
3901 (let ((dests (orgtbl-gather-send-defs))
3902 (txt (buffer-substring-no-properties (org-table-begin)
3903 (org-table-end)))
3904 (ntbl 0))
3905 (unless dests (if maybe (throw 'exit nil)
3906 (error "Don't know how to transform this table")))
3907 (dolist (dest dests)
3908 (let* ((name (plist-get dest :name))
3909 (transform (plist-get dest :transform))
3910 (params (plist-get dest :params))
3911 (skip (plist-get params :skip))
3912 (skipcols (plist-get params :skipcols))
3913 beg
3914 (lines (org-table-clean-before-export
3915 (nthcdr (or skip 0)
3917 (i0 (if org-table-clean-did-remove-column 2 1))
3918 (table (mapcar
3919 (lambda (x)
3920 (if (string-match org-table-hline-regexp x)
3921 'hline
3922 (org-remove-by-index
3924 skipcols i0)))
3925 lines))
3926 (fun (if (= i0 2) 'cdr 'identity))
3927 (org-table-last-alignment
3928 (org-remove-by-index (funcall fun org-table-last-alignment)
3929 skipcols i0))
3930 (org-table-last-column-widths
3931 (org-remove-by-index (funcall fun org-table-last-column-widths)
3932 skipcols i0))
3933 (txt (if (fboundp transform)
3934 (funcall transform table params)
3935 (error "No such transformation function %s" transform))))
3936 (orgtbl-send-replace-tbl name txt))
3937 (setq ntbl (1+ ntbl)))
3938 (message "Table converted and installed at %d receiver location%s"
3939 ntbl (if (> ntbl 1) "s" "")))))
3941 (defun org-remove-by-index (list indices &optional i0)
3942 "Remove the elements in LIST with indices in INDICES.
3943 First element has index 0, or I0 if given."
3944 (if (not indices)
3945 list
3946 (if (integerp indices) (setq indices (list indices)))
3947 (setq i0 (1- (or i0 0)))
3948 (delq :rm (mapcar (lambda (x)
3949 (setq i0 (1+ i0))
3950 (if (memq i0 indices) :rm x))
3951 list))))
3953 (defun orgtbl-toggle-comment ()
3954 "Comment or uncomment the orgtbl at point."
3955 (interactive)
3956 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3957 (re2 (concat "^" orgtbl-line-start-regexp))
3958 (commented (save-excursion (beginning-of-line 1)
3959 (cond ((looking-at re1) t)
3960 ((looking-at re2) nil)
3961 (t (error "Not at an org table")))))
3962 (re (if commented re1 re2))
3963 beg end)
3964 (save-excursion
3965 (beginning-of-line 1)
3966 (while (looking-at re) (beginning-of-line 0))
3967 (beginning-of-line 2)
3968 (setq beg (point))
3969 (while (looking-at re) (beginning-of-line 2))
3970 (setq end (point)))
3971 (comment-region beg end (if commented '(4) nil))))
3973 (defun orgtbl-insert-radio-table ()
3974 "Insert a radio table template appropriate for this major mode."
3975 (interactive)
3976 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3977 (txt (nth 1 e))
3978 name pos)
3979 (unless e (error "No radio table setup defined for %s" major-mode))
3980 (setq name (read-string "Table name: "))
3981 (while (string-match "%n" txt)
3982 (setq txt (replace-match name t t txt)))
3984 (setq pos (point))
3985 (insert txt)
3986 (goto-char pos)))
3988 ;; Dynamically bound input and output for table formatting.
3989 (defvar *orgtbl-table* nil
3990 "Carries the current table through formatting routines.")
3991 (defvar *orgtbl-rtn* nil
3992 "Formatting routines push the output lines here.")
3993 ;; Formatting parameters for the current table section.
3994 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
3995 (defvar *orgtbl-sep* nil "Text used as a column separator.")
3996 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
3997 (defvar *orgtbl-fmt* nil "Format for each entry.")
3998 (defvar *orgtbl-efmt* nil "Format for numbers.")
3999 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4000 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4001 (defvar *orgtbl-lstart* nil "Text starting a row.")
4002 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4003 (defvar *orgtbl-lend* nil "Text ending a row.")
4004 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4006 (defsubst orgtbl-get-fmt (fmt i)
4007 "Retrieve the format from FMT corresponding to the Ith column."
4008 (if (and (not (functionp fmt)) (consp fmt))
4009 (plist-get fmt i)
4010 fmt))
4012 (defsubst orgtbl-apply-fmt (fmt &rest args)
4013 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4014 (cond ((functionp fmt) (apply fmt args))
4015 (fmt (apply 'format fmt args))
4016 (args (car args))
4017 (t args)))
4019 (defsubst orgtbl-eval-str (str)
4020 "If STR is a function, evaluate it with no arguments."
4021 (if (functionp str)
4022 (funcall str)
4023 str))
4025 (defun orgtbl-format-line (line)
4026 "Format LINE as a table row."
4027 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4028 (let* ((i 0)
4029 (line
4030 (mapcar
4031 (lambda (f)
4032 (setq i (1+ i))
4033 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4034 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4035 (orgtbl-apply-fmt efmt (match-string 1 f)
4036 (match-string 2 f))
4037 f)))
4038 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4039 *orgtbl-default-fmt*)
4040 f)))
4041 line)))
4042 (push (if *orgtbl-lfmt*
4043 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4044 (concat (orgtbl-eval-str *orgtbl-lstart*)
4045 (mapconcat 'identity line *orgtbl-sep*)
4046 (orgtbl-eval-str *orgtbl-lend*)))
4047 *orgtbl-rtn*))))
4049 (defun orgtbl-format-section (section-stopper)
4050 "Format lines until the first occurrence of SECTION-STOPPER."
4051 (let (prevline)
4052 (progn
4053 (while (not (eq (car *orgtbl-table*) section-stopper))
4054 (if prevline (orgtbl-format-line prevline))
4055 (setq prevline (pop *orgtbl-table*)))
4056 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4057 (*orgtbl-lend* *orgtbl-llend*)
4058 (*orgtbl-lfmt* *orgtbl-llfmt*))
4059 (orgtbl-format-line prevline))))))
4061 (defun orgtbl-to-generic (table params)
4062 "Convert the orgtbl-mode TABLE to some other format.
4063 This generic routine can be used for many standard cases.
4064 TABLE is a list, each entry either the symbol `hline' for a horizontal
4065 separator line, or a list of fields for that line.
4066 PARAMS is a property list of parameters that can influence the conversion.
4067 For the generic converter, some parameters are obligatory: You need to
4068 specify either :lfmt, or all of (:lstart :lend :sep).
4070 Valid parameters are
4072 :splice When set to t, return only table body lines, don't wrap
4073 them into :tstart and :tend. Default is nil. When :splice
4074 is non-nil, this also means that the exporter should not look
4075 for and interpret header and footer sections.
4077 :hline String to be inserted on horizontal separation lines.
4078 May be nil to ignore hlines.
4080 :sep Separator between two fields
4081 :remove-nil-lines Do not include lines that evaluate to nil.
4084 Each in the following group may be either a string or a function
4085 of no arguments returning a string:
4086 :tstart String to start the table. Ignored when :splice is t.
4087 :tend String to end the table. Ignored when :splice is t.
4088 :lstart String to start a new table line.
4089 :llstart String to start the last table line, defaults to :lstart.
4090 :lend String to end a table line
4091 :llend String to end the last table line, defaults to :lend.
4093 Each in the following group may be a string, a function of one
4094 argument (the field or line) returning a string, or a plist
4095 mapping columns to either of the above:
4096 :lfmt Format for entire line, with enough %s to capture all fields.
4097 If this is present, :lstart, :lend, and :sep are ignored.
4098 :llfmt Format for the entire last line, defaults to :lfmt.
4099 :fmt A format to be used to wrap the field, should contain
4100 %s for the original field value. For example, to wrap
4102 This may also be a property list with column numbers and
4105 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4106 Same as above, specific for the header lines in the table.
4107 All lines before the first hline are treated as header.
4108 If any of these is not present, the data line value is used.
4110 This may be either a string or a function of two arguments:
4111 :efmt Use this format to print numbers with exponentials.
4112 The format should have %s twice for inserting mantissa
4114 may also be a property list with column numbers and
4115 formats. :fmt will still be applied after :efmt.
4117 In addition to this, the parameters :skip and :skipcols are always handled
4118 directly by `orgtbl-send-table'. See manual."
4119 (interactive)
4121 (let* ((splicep (plist-get params :splice))
4122 (hline (plist-get params :hline))
4123 (remove-nil-linesp (plist-get params :remove-nil-lines))
4124 (remove-newlines (plist-get params :remove-newlines))
4125 (*orgtbl-hline* hline)
4126 (*orgtbl-table* table)
4127 (*orgtbl-sep* (plist-get params :sep))
4128 (*orgtbl-efmt* (plist-get params :efmt))
4129 (*orgtbl-lstart* (plist-get params :lstart))
4130 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4131 (*orgtbl-lend* (plist-get params :lend))
4132 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4133 (*orgtbl-lfmt* (plist-get params :lfmt))
4134 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4135 (*orgtbl-fmt* (plist-get params :fmt))
4136 *orgtbl-rtn*)
4138 ;; Put header
4139 (unless splicep
4140 (when (plist-member params :tstart)
4141 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4142 (if tstart (push tstart *orgtbl-rtn*)))))
4144 ;; Do we have a heading section? If so, format it and handle the
4145 ;; trailing hline.
4146 (if (and (not splicep)
4147 (or (consp (car *orgtbl-table*))
4148 (consp (nth 1 *orgtbl-table*)))
4149 (memq 'hline (cdr *orgtbl-table*)))
4150 (progn
4151 (when (eq 'hline (car *orgtbl-table*))
4152 ;; there is a hline before the first data line
4153 (and hline (push hline *orgtbl-rtn*))
4154 (pop *orgtbl-table*))
4155 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4156 *orgtbl-lstart*))
4157 (*orgtbl-llstart* (or (plist-get params :hllstart)
4158 *orgtbl-llstart*))
4159 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4160 (*orgtbl-llend* (or (plist-get params :hllend)
4161 (plist-get params :hlend) *orgtbl-llend*))
4162 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4163 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4164 (plist-get params :hlfmt) *orgtbl-llfmt*))
4165 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4166 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4167 (orgtbl-format-section 'hline))
4168 (if hline (push hline *orgtbl-rtn*))
4169 (pop *orgtbl-table*)))
4171 ;; Now format the main section.
4172 (orgtbl-format-section nil)
4174 (unless splicep
4175 (when (plist-member params :tend)
4176 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4177 (if tend (push tend *orgtbl-rtn*)))))
4179 (mapconcat (if remove-newlines
4180 (lambda (tend)
4182 'identity)
4183 (nreverse (if remove-nil-linesp
4184 (remq nil *orgtbl-rtn*)
4187 (defun orgtbl-to-tsv (table params)
4188 "Convert the orgtbl-mode table to TAB separated material."
4190 (defun orgtbl-to-csv (table params)
4191 "Convert the orgtbl-mode table to CSV material.
4192 This does take care of the proper quoting of fields with comma or quotes."
4193 (orgtbl-to-generic table (org-combine-plists
4194 '(:sep "," :fmt org-quote-csv-field)
4195 params)))
4197 (defun orgtbl-to-latex (table params)
4198 "Convert the orgtbl-mode TABLE to LaTeX.
4199 TABLE is a list, each entry either the symbol `hline' for a horizontal
4200 separator line, or a list of fields for that line.
4201 PARAMS is a property list of parameters that can influence the conversion.
4202 Supports all parameters from `orgtbl-to-generic'. Most important for
4203 LaTeX are:
4205 :splice When set to t, return only table body lines, don't wrap
4206 them into a tabular environment. Default is nil.
4208 :fmt A format to be used to wrap the field, should contain %s for the
4209 original field value. For example, to wrap everything in dollars,
4212 The format may also be a function that formats its one argument.
4214 :efmt Format for transforming numbers with exponentials. The format
4215 should have %s twice for inserting mantissa and exponent, for
4217 This may also be a property list with column numbers and formats.
4218 The format may also be a function that formats its two arguments.
4220 :llend If you find too much space below the last line of a table,
4223 The general parameters :skip and :skipcols have already been applied when
4224 this function is called."
4225 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4226 org-table-last-alignment ""))
4227 (params2
4228 (list
4233 (orgtbl-to-generic table (org-combine-plists params2 params))))
4235 (defun orgtbl-to-html (table params)
4236 "Convert the orgtbl-mode TABLE to HTML.
4237 TABLE is a list, each entry either the symbol `hline' for a horizontal
4238 separator line, or a list of fields for that line.
4239 PARAMS is a property list of parameters that can influence the conversion.
4240 Currently this function recognizes the following parameters:
4242 :splice When set to t, return only table body lines, don't wrap
4243 them into a <table> environment. Default is nil.
4245 The general parameters :skip and :skipcols have already been applied when
4246 this function is called. The function does *not* use `orgtbl-to-generic',
4247 so you cannot specify parameters for it."
4248 (let* ((splicep (plist-get params :splice))
4249 (html-table-tag org-export-html-table-tag)
4250 html)
4251 ;; Just call the formatter we already have
4252 ;; We need to make text lines for it, so put the fields back together.
4253 (setq html (org-format-org-table-html
4254 (mapcar
4255 (lambda (x)
4256 (if (eq x 'hline)
4257 "|----+----|"
4258 (concat "| " (mapconcat 'identity x " | ") " |")))
4259 table)
4260 splicep))
4262 (setq html (replace-match "" t t html)))
4263 html))
4265 (defun orgtbl-to-texinfo (table params)
4266 "Convert the orgtbl-mode TABLE to TeXInfo.
4267 TABLE is a list, each entry either the symbol `hline' for a horizontal
4268 separator line, or a list of fields for that line.
4269 PARAMS is a property list of parameters that can influence the conversion.
4270 Supports all parameters from `orgtbl-to-generic'. Most important for
4271 TeXInfo are:
4273 :splice nil/t When set to t, return only table body lines, don't wrap
4274 them into a multitable environment. Default is nil.
4276 :fmt fmt A format to be used to wrap the field, should contain
4277 %s for the original field value. For example, to wrap
4279 This may also be a property list with column numbers and
4281 Each format also may be a function that formats its one
4282 argument.
4285 are computed automatically from the width of the columns
4286 under org-mode.
4288 The general parameters :skip and :skipcols have already been applied when
4289 this function is called."
4290 (let* ((total (float (apply '+ org-table-last-column-widths)))
4291 (colfrac (or (plist-get params :cf)
4292 (mapconcat
4293 (lambda (x) (format "%.3f" (/ (float x) total)))
4294 org-table-last-column-widths " ")))
4295 (params2
4296 (list
4297 :tstart (concat "@multitable @columnfractions " colfrac)
4298 :tend "@end multitable"
4299 :lstart "@item " :lend "" :sep " @tab "
4300 :hlstart "@headitem ")))
4301 (orgtbl-to-generic table (org-combine-plists params2 params))))
4303 (defun orgtbl-to-orgtbl (table params)
4304 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4305 Useful when slicing one table into many. The :hline, :sep,
4306 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4307 and :tend suppress strings without splicing; they can be set to
4308 provide ORGTBL directives for the generated table."
4309 (let* ((params2
4310 (list
4311 :remove-newlines t
4312 :tstart nil :tend nil
4313 :hline "|---"
4314 :sep " | "
4315 :lstart "| "
4316 :lend " |"))
4317 (params (org-combine-plists params2 params)))
4318 (orgtbl-to-generic table params)))
4320 (defun org-table-get-remote-range (name-or-id form)
4321 "Get a field value or a list of values in a range from table at ID.
4323 NAME-OR-ID may be the name of a table in the current file as set by
4325 will then be used. Alternatively, it may be an ID referring to
4326 any entry, also in a different file. In this case, the first table
4327 in that entry will be referenced.
4331 The return value is either a single string for a single field, or a
4332 list of the fields in the rectangle ."
4333 (save-match-data
4334 (let ((id-loc nil)
4335 org-table-column-names org-table-column-name-regexp
4336 org-table-local-parameters org-table-named-field-locations
4337 org-table-current-line-types org-table-current-begin-line
4338 org-table-current-begin-pos org-table-dlines
4339 org-table-hlines org-table-last-alignment
4340 org-table-last-column-widths org-table-last-alignment
4341 org-table-last-column-widths tbeg
4342 buffer loc)
4343 (setq form (org-table-convert-refs-to-rc form))
4344 (save-excursion
4345 (save-restriction
4346 (widen)
4347 (save-excursion
4348 (goto-char (point-min))
4349 (if (re-search-forward
4351 nil t)
4352 (setq buffer (current-buffer) loc (match-beginning 0))
4353 (setq id-loc (org-id-find name-or-id 'marker))
4354 (unless (and id-loc (markerp id-loc))
4356 (setq buffer (marker-buffer id-loc)
4357 loc (marker-position id-loc))
4358 (move-marker id-loc nil)))
4359 (with-current-buffer buffer
4360 (save-excursion
4361 (save-restriction
4362 (widen)
4363 (goto-char loc)
4364 (forward-char 1)
4366 (not (match-beginning 1)))
4367 (error "Cannot find a table at NAME or ID %s" name-or-id))
4368 (setq tbeg (point-at-bol))
4369 (org-table-get-specials)
4370 (setq form (org-table-formula-substitute-names form))
4371 (if (and (string-match org-table-range-regexp form)
4372 (> (length (match-string 0 form)) 1))
4373 (save-match-data
4374 (org-table-get-range (match-string 0 form) tbeg 1))
4375 form)))))))))
4377 (provide 'org-table)
4379 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4381 ;;; org-table.el ends here