| blob | 0d61a78227065d4681c16f21c9b8c6e73c44e34e |
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.3
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?"
357 s))))
366 "Use the table.el package to insert a new table.
367 If there is already a table at point, convert between Org-mode tables
368 and table.el tables."
382 "Convert region to table, or create an empty table.
383 If there is an active region, convert it to a table, using the function
384 `org-table-convert-region'. See the documentation of that function
385 to learn how the prefix argument is interpreted to determine the field
386 separator.
387 If there is no such region, create an empty table with `org-table-create'."
394 "Query for a size and insert a table skeleton.
414 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
418 ;; Insert a hline after the first row.
426 "Convert region to a table.
427 The region goes from BEG0 to END0, but these borders will be moved
428 slightly, to make sure a beginning of line in the first line is included.
430 SEPARATOR specifies the field separator in the lines. It can have the
431 following values:
433 '(4) Use the comma as a field separator
434 '(16) Use a TAB as field separator
435 integer When a number, use that many spaces as field separator
436 nil When nil, the command tries to be smart and figure out the
437 separator in the following way:
438 - when each line contains a TAB, assume TAB-separated material
439 - when each line contains a comma, assume CSV material
440 - else, assume one or more SPACE characters as separator."
444 re)
451 ;; Get the right field separator
462 ;; parse the csv stuff
484 "Import FILE as a table.
485 The file is assumed to be tab-separated. Such files can be produced by most
486 spreadsheet and database applications. If no tabs (at least one per line)
487 are found, lines will be split on whitespace into fields."
499 "Export table to a file, with configurable format.
500 Such a file can be imported into a spreadsheet program like Excel.
501 FILE can be the output file name. If not given, it will be taken from
502 a TABLE_EXPORT_FILE property in the current entry or higher up in the
503 hierarchy, or the user will be prompted for a file name.
504 FORMAT can be an export format, of the same kind as it used when
505 `orgtbl-mode' sends a table in a different format. The default format can
506 be found in the variable `org-table-export-default-format', but the function
507 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
508 property, locally or anywhere up in the hierarchy."
525 buf deffmt-readable)
544 "Format: "
549 deffmt-readable)))
562 'hline
565 skipcols i0)))
566 lines))
570 skipcols i0))
573 skipcols i0)))
590 "Marker at the beginning of the table last aligned.
593 "Marker at the end of the table last aligned.
596 "List of flags for flushright alignment, from the last re-alignment.
599 "List of max width of fields in each column.
602 "Non-nil means debug table formulas.
615 "Align the table at point by aligning all vertical bars."
618 ;; Limits of table
621 ;; Current cursor position
627 column
629 rfmt hfmt
637 emptystrings links dates emph raise narrow
638 falign falign1 fmax f1 len c e space)
641 ;; Check if we have links or dates
653 ;; Make sure the link properties are right
655 ;; Make sure the date properties are right
660 ;; Check if we are narrowing any columns
663 org-format-transports-properties-p
668 ;; Get the rows
671 ;; Store the indentation of the first line
674 ;; Mark the hlines by setting the corresponding element to nil
675 ;; At the same time, we remove trailing space.
678 nil
681 l)))
682 lines))
683 ;; Get the data fields by splitting the lines.
688 ;; How many fields in the longest line?
695 ;; A list of empty strings to fill any short rows on output
697 ;; Check for special formatting.
701 ;; Check if there is an explicit width specified
711 ;; Find fields that are wider than fmax, and shorten them
717 'help-echo
718 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
726 xx)))))
727 ;; Get the maximum width for each column
729 lengths)
730 ;; Get the fraction of numbers, to decide about alignment of the column
736 nil
743 ;; Store the alignment of this table, for later editing of single fields
745 org-table-last-column-widths lengths)
747 ;; With invisible characters, `format' does not get the field width right
748 ;; So we need to make these fields wide by hand.
766 ;; Compute the formats needed for output of the table
779 hfmt))
782 ;; This hack is for org-indent, to force redisplay of the
783 ;; line prefix of the first line. Apparently the redisplay
784 ;; is tied to the newline, which is, I think, a bug.
785 ;; To force this redisplay, we remove and re-insert the
786 ;; newline, so that the redisplay engine thinks it belongs
787 ;; to the changed text.
793 ;; Replace the old one
800 ;; Try to move to the old location
808 ))
811 "Find the beginning of the table and return its position.
812 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
816 org-table-border-regexp)
817 nil t))
824 "Find the end of the table and return its position.
825 With argument TABLE-TYPE, go to the end of a table.el-type table."
829 org-table-border-regexp)
830 nil t))
836 "Justify the current field, text to left, number to right.
837 Optional argument NEW may specify text to replace the current field content."
846 ;; This is not the same table, force a full re-align
852 l f n o e)
876 "Go to the next field in the current table, creating new lines as needed.
877 Before doing so, re-align the table if necessary."
882 org-table-may-need-update)
893 org-table-tab-jumps-over-hlines
905 "Go to the previous field in the table.
906 Before doing so, re-align the table if necessary."
911 org-table-may-need-update)
926 "Move to the end of the current table field.
927 If already at or after the end, move to the end of the next table field.
928 With numeric argument N, move N-1 fields forward first."
941 "Move to the beginning of the current table field.
942 If already at or before the beginning, move to the beginning of the
943 previous field.
944 With numeric argument N, move N-1 fields backward first."
958 "Go to the next row (same column) in the current table.
959 Before doing so, re-align the table if necessary."
967 org-table-may-need-update)
981 "Copy a field down in the current column.
982 If the field at the cursor is empty, copy into it the content of the nearest
983 non-empty field above. With argument N, use the Nth non-empty field.
984 If the current field is not empty, it is copied down to the next row, and
985 the cursor is moved with it. Therefore, repeating this command causes the
986 column to be filled row-by-row.
987 If the variable `org-table-copy-increment' is non-nil and the field is an
988 integer or a timestamp, it will be incremented while copying. In the case of
989 a timestamp, if the cursor is on the year, change the year. If it is on the
990 month or the day, change that. Point will stay on the current date field
991 in order to easily repeat the interval."
999 txt)
1011 beg t))
1034 "Is point inside a table data field?
1035 I.e. not on a hline or before the first or after the last column?
1036 This actually throws an error, so it aborts the current command."
1047 "Get the field in table line LINE, column COLUMN.
1048 If LINE is larger than the number of data lines in the table, the function
1049 returns nil. However, if COLUMN is too large, we will simply return an
1050 empty string.
1051 If LINE is nil, use the current line.
1052 If column is nil, use the current column."
1059 "Put VALUE into line LINE, column COLUMN.
1060 When ALIGN is set, also realign the table."
1069 "Return the index of the current data line."
1076 cnt))
1079 "Go to the Nth data line in the current table.
1080 Return t when the line exists, nil if it does not exist."
1088 "Blank the current table field or active region."
1105 "Return the value of the field in column N of current row.
1106 N defaults to current field.
1107 If REPLACE is a string, replace field with this value. The return value
1108 is always the old value."
1118 val)
1122 "Show info about the current field, and highlight any reference at point."
1130 org-table-named-field-locations)))
1143 dline col
1145 dline col ref1
1147 ;; FIXME: formula info not correct if special table line
1157 "Find out which column we are in."
1166 cnt)))
1169 "Find out what table data line we are in.
1170 Only data lines count for this."
1180 cnt)))
1183 "Move the cursor to the Nth column in the current table line.
1184 With optional argument ON-DELIM, stop with point before the left delimiter
1185 of the field.
1186 If there are less than N fields, just go to after the last delimiter.
1187 However, when FORCE is non-nil, create new columns if necessary."
1197 t)))))
1205 "Insert a new column into the table."
1213 ;; Current cursor position
1219 nil
1231 "Find a data line in the current table, which is needed for column commands."
1234 t
1245 t
1250 "Delete a column from the table."
1259 ;; Current cursor position
1265 nil
1280 "Move column to the right."
1284 "Move column to the left."
1289 "Move the current column to the right. With arg LEFT, move to the left."
1299 ;; Current cursor position
1309 nil
1326 "Move table row down."
1330 "Move table row up."
1335 "Move the current table line down. With arg UP, move it up."
1344 txt hline2p)
1365 "Insert a new row above the current line into the table.
1366 With prefix ARG, insert below the current line."
1372 ;; Fix the first field if necessary
1384 "Insert a horizontal-line below the current line into the table.
1385 With prefix ABOVE, insert above the current line."
1407 "Insert a hline and move to the row below that line."
1421 In particular, this does handle wide and invisible characters."
1423 ;; It's a hline, just map the characters
1429 t t s)))
1430 s))
1433 "Delete the current row or horizontal line from the table."
1446 "Sort table lines according to the column at point.
1448 The position of point indicates the column to be used for
1449 sorting, and the range of lines is the range between the nearest
1450 horizontal separator lines, or the entire table of no such lines
1451 exist. If point is before the first column, you will be prompted
1452 for the sorting column. If there is an active region, the mark
1453 specifies the first line and the sorting column, while point
1454 should be in the last line to be included into the sorting.
1456 The command then prompts for the sorting type which can be
1457 alphabetically, numerically, or by time (as given in a time stamp
1458 in the field). Sorting in reverse order is also possible.
1460 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1462 If SORTING-TYPE is specified when this function is called from a Lisp
1463 program, no prompting will take place. SORTING-TYPE must be a character,
1464 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1465 should be done in reverse order."
1469 beg end bcol ecol tend tbeg column lns pos)
1514 x))
1527 "Copy region in table to the clipboard and blank all relevant fields.
1528 If there is no active region, use just the field at point."
1535 "Copy rectangular region in table to clipboard.
1536 A special clipboard is used which can only be accessed
1537 with `org-table-paste-rectangle'."
1541 current-prefix-arg))
1543 region cols
1569 org-table-clip))
1572 "Paste a rectangular region into a table.
1573 The upper right corner ends up in the current field. All involved fields
1574 will be overwritten. If the rectangle does not fit into the present table,
1575 the table is enlarged as needed. The process ignores horizontal separator
1576 lines."
1586 c cols field)
1602 "Convert from `org-mode' table to table.el and back.
1603 Obviously, this only works within limits. When an Org-mode table is
1604 converted to table.el, all horizontal separator lines get lost, because
1605 table.el uses these as cell boundaries and has no notion of horizontal lines.
1606 A table.el table can be converted to an Org-mode table only if it does not
1607 do row or column spanning. Multiline cells will become multiple cells.
1608 Beware, Org-mode does not test if the table can be successfully converted - it
1609 blindly applies a recipe that works for simple tables."
1613 ;; convert to Org-mode table
1622 ;; convert to table.el table
1625 ;; first, get rid of all horizontal lines
1629 ;; insert a hline before first
1633 ;; insert a hline after each line
1638 ;; replace "+" at beginning and ending of hlines
1647 "Wrap several fields in a column like a paragraph.
1648 This is useful if you'd like to spread the contents of a field over several
1649 lines, in order to keep the table compact.
1651 If there is an active region, and both point and mark are in the same column,
1652 the text in the column is wrapped to minimum width for the given number of
1653 lines. Generally, this makes the table more compact. A prefix ARG may be
1655 formats the selected text to two lines. If the region was longer than two
1656 lines, the remaining lines remain empty. A negative prefix argument reduces
1657 the current number of lines by that amount. The wrapped text is pasted back
1658 into the table. If you formatted it to more lines than it was before, fields
1659 further down in the table get overwritten - so you might need to make space in
1660 the table first.
1662 If there is no region, the current field is split at the cursor position and
1663 the text fragment to the right of the cursor is prepended to the field one
1664 line down.
1666 If there is no region, but you specify a prefix ARG, the current field gets
1667 blank, and the content is appended to the field above."
1671 ;; There is a region: fill as a paragraph
1675 nlines)
1682 arg)
1686 nil nlines)))
1690 ;; No region, split the current field at point
1694 ;; combine with field above
1704 ;; split field
1717 "Edit table field in a different window.
1718 This is mainly useful for fields that contain hidden parts.
1720 it can be edited in place."
1726 display t intangible t))
1732 p)
1741 intangible t))
1749 "Finish editing a table data field.
1750 Remove all newline characters, insert the result into the table, realign
1751 the table and kill the editing buffer."
1755 text)
1774 "Sum numbers in region of current table column.
1775 The result will be displayed in the echo area, and will be available
1778 If there is an active region, it is interpreted as a rectangle and all
1779 numbers in that rectangle will be summed. If there is no active
1780 region and point is located in a table column, sum all numbers in that
1781 column.
1783 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1784 numbers are assumed to be times as well (in decimal hours) and the
1785 numbers are added as such.
1787 If NLAST is a number, only the NLAST fields will actually be summed."
1814 items1)))
1821 s diff)
1829 sres))))
1852 "Return the formula active for the current field.
1853 Assumes that specials are in place.
1854 If KEY is given, return the key to this formula.
1858 org-table-named-field-locations)))
1872 "Read a formula from the minibuffer, offer stored formula as default.
1873 When NAMED is non-nil, look for a named equation."
1877 org-table-named-field-locations)))
1884 name
1885 ref)
1895 stored)
1897 equation)
1904 scol))
1906 'org-table-formula-history
1907 )))))
1908 mustsave)
1910 ;; remove formula
1917 ;; We set the column equation, delete the named one.
1919 mustsave t))
1925 eq))
1928 "Store the list of formulas below the current table."
1934 ;; don't overwrite TBLFM, we might use text properties to store stuff
1955 "Compare two formulas for sorting."
1961 "Return an alist with the stored formulas directly after current table."
1969 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1986 "Modify the equations after the table structure has been edited.
1988 For all numbers larger than LIMIT, shift them by DELTA."
1999 s n a)
2012 t t)))))))))
2015 "Get the column names and local parameters for this table."
2018 names name fields fields1 field cnt
2019 c v l line col types dlines hlines last-dline)
2021 org-table-local-parameters nil
2022 org-table-named-field-locations nil
2023 org-table-current-begin-line nil
2024 org-table-current-begin-pos nil
2025 org-table-current-line-types nil)
2043 org-table-local-parameters))))
2059 ;; Analyse the line types
2063 l org-table-current-begin-line)
2080 al al2)
2092 If yes, store the formula and apply it."
2093 ;; We already know we are in a table. Get field will only return a formula
2094 ;; when appropriate. It might return a separator line, but no problem.
2097 named eq)
2108 "List of commands triggering the recalculation of a line.
2121 "Rotate the recalculation mark in the first column.
2122 If in any row, the first field is not consistent with a mark,
2123 insert a new column for the markers.
2124 When there is an active region, change all the lines in the region,
2125 after prompting for the marking character.
2126 After each change, a message will be displayed indicating the meaning
2127 of the new mark."
2142 epos new)
2149 newchar))
2181 "Recompute the current line if marked for it, and if we haven't just done it."
2201 modes)
2204 suppress-align suppress-const
2205 suppress-store suppress-analysis)
2206 "Replace the table field value at the cursor by the result of a calculation.
2208 This function makes use of Dave Gillespie's Calc package, in my view the
2209 most exciting program ever written for GNU Emacs. So you need to have Calc
2210 installed in order to use this function.
2212 In a table, this command replaces the value in the current field with the
2214 formula, by storing it in a special line below the table. When called
2215 with a `C-u' prefix, the current field must be a named field, and the
2216 formula is installed as valid in only this specific field.
2218 When called with two `C-u' prefixes, insert the active equation
2219 for the field back into the current field, so that it can be
2221 to check the referenced fields.
2223 When called, the command first prompts for a formula, which is read in
2224 the minibuffer. Previously entered formulas are available through the
2225 history list, and the last used formula is offered as a default.
2226 These stored formulas are adapted correctly when moving, inserting, or
2227 deleting columns with the corresponding commands.
2229 The formula can be any algebraic expression understood by the Calc package.
2230 For details, see the Org-mode manual.
2232 This function can also be called from Lisp programs and offers
2233 additional arguments: EQUATION can be the formula to apply. If this
2234 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2235 used to speed-up recursive calls by by-passing unnecessary aligns.
2236 SUPPRESS-CONST suppresses the interpretation of constants in the
2237 formula, assuming that this has been done already outside the function.
2238 SUPPRESS-STORE means the formula should not be stored, either because
2239 it is already stored, or because it is a modified equation that should
2240 not overwrite the stored one."
2256 equation
2262 n form form0 bw fmt x ev orig c lispp literal)
2263 ;; Parse the format string. Since we have a lot of modes, this is
2264 ;; a lot of work. However, I think calc still uses most of the time.
2276 'calc-float-format
2279 n))))
2306 fields)))
2312 ;; Insert row and column number of formula result field
2323 t t form)))
2325 ;; Check for old vertical references
2327 ;; Insert remote references
2335 keep-empty numbers lispp))
2336 t t form)))
2337 ;; Insert complex ranges
2345 keep-empty numbers lispp))
2346 t t form)))
2347 ;; Insert simple ranges
2356 keep-empty numbers lispp))
2357 t t form)))
2359 ;; Insert the references to fields in same row
2368 t t form)))
2383 Orig: %s
2384 $xyz-> %s
2385 @r$c-> %s
2416 prop value)))
2419 "Get a calc vector from a column, according to descriptor DESC.
2420 Optional arguments TBEG and COL can give the beginning of the table and
2421 the current column, to avoid unnecessary parsing.
2422 HIGHLIGHT means just highlight the range."
2429 beg end c1 c2 r1 r2 rangep tmp)
2446 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2452 ;; just one field
2459 ;; A range, return a vector
2460 ;; First sort the numbers to get a regular ractangle
2476 ;; return string representation of calc vector
2481 "Analyze descriptor DESC and retrieve the corresponding line number.
2482 The cursor is currently in line CLINE, the table begins in line BLINE,
2483 and TABLE is a vector with line types."
2491 ;; 1 2 3 4 5 6
2511 nil hn cline desc)))
2514 rel on cline desc)))
2518 "FIXME: Needs more documentation."
2531 nil))
2532 t)))
2536 desc cline)
2537 i)))
2542 s))
2545 "Convert list ELEMENTS to something appropriate to insert into formula.
2546 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2547 NUMBERS indicates that everything should be converted to numbers.
2548 LISPP means to return something appropriate for a Lisp list."
2552 elements
2561 elements))))
2567 x
2573 elements
2577 "Recalculate the current table line by applying all stored formulas.
2578 With prefix arg ALL, do this for all lines in the table.
2579 With the prefix argument ALL is `(16)' \
2581 it is the symbol `iterate', recompute the table until it no longer changes.
2582 If NOALIGN is not nil, do not re-align the table after the computations
2583 are done. This is typically used internally to save time, if it is
2584 known that the table will be realigned a little later anyway."
2599 ;; Insert constants in all formulas
2603 x)
2604 eqlist))
2605 ;; Split the equation list
2616 ;; This is a table with marked lines, compute selected lines
2618 ;; Move forward to the first non-header line
2629 ;; First find the named fields, and mark them untouchable
2641 name)))
2650 ;; Now evaluate the column formulas, but skip fields covered by
2651 ;; field formulas
2655 ;; Unprotected line, recalculate
2667 ;; Now evaluate the field formulas
2681 ;; back to initial position
2689 "Recalculate the table until it does not change anymore."
2694 thistbl)
2709 "Recalculate all tables in the current buffer."
2717 "Iterate all tables in the buffer, to converge inter-table dependencies."
2722 c1
2739 "Replace $const with values in string F."
2741 ;; First, check for column names
2746 ;; Parameters and constants
2748 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2758 f))
2761 "Find the value for a parameter or constant in a formula.
2762 Parameters get priority."
2793 map))
2800 "--"
2803 "--"
2804 "Shift Reference at Point"
2809 "-"
2810 "Change Test Row for Column Formulas"
2813 "--"
2818 org-table-overlay-coordinates)]
2819 "--"
2826 "Edit the formulas of the current table in a separate buffer."
2842 entry s type title)
2845 ;; Keep global-font-lock-mode from turning on font-lock-mode
2885 "Convert a formula from internal to user representation."
2888 s))
2891 "Convert a formula from user to internal representation."
2894 s))
2897 "Convert spreadsheet references from AB7 to @7$28.
2898 Works for single references, but also for entire formulas and even the
2899 full TBLFM line."
2901 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2904 ;; format match, just advance
2909 ;; 3.e5 or something like this.
2912 ;; (member (match-string 1 s)
2913 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
2914 )
2915 ;; function name, just advance
2925 t t s)))))
2926 s))
2929 "Convert spreadsheet references from to @7$28 to AB7.
2930 Works for single references, but also for entire formulas and even the
2931 full TBLFM line."
2938 t t s)))
2943 t nil s)))
2944 s)
2947 "Convert a base 26 number represented by letters into an integer.
2948 For example: AB -> 28."
2954 n))
2957 "Convert an integer into a base 26 number represented by letters.
2958 For example: 28 -> AB."
2963 s))
2966 "Convert all references in this buffer, using FUNCTION."
2976 "Convert all references in the buffer from B3 to @3$2 and back."
2986 "Shift the reference at point one row/hline up."
2990 "Shift the reference at point one row/hline down."
2994 "Shift the reference at point one field to the left."
2998 "Shift the reference at point one field to the right."
3009 ;; A B3-like reference
3015 ;; An internal reference
3021 "Re-match the group N, and replace it with the shifted reference."
3026 t t)))
3029 "Shift a reference part REF.
3030 If DECR is set, decrease the references row/column, else increase.
3031 If HLINE is set, this may be a hline reference, it certainly is not
3032 a translation reference."
3061 "Toggle the display of coordinates in the referenced table."
3070 "Parse the buffer for formula definitions and install them.
3071 With prefix ARG, apply the new formulas to the table."
3082 nil t)
3106 "Abort editing formulas, without installing the changes."
3117 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3158 "Show the location/value of the $ expression at point."
3167 var name e what match dest)
3249 ;; column number
3277 org-table-fedit-scroll-down))))
3288 "Make sure the cursor is in a dataline in a table."
3297 p1 p2)))
3302 "Move cursor one line up in the window showing the table."
3307 "Move cursor one line down in the window showing the table."
3312 "Move the cursor in the window showing the table.
3313 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3338 "Add a new overlay."
3344 "Highlight rectangular region in a table."
3348 l1 c1 l2 c2 tmp)
3372 "Remove the rectangle overlays."
3383 "Add overlays to the table at point, to show row/column coordinates."
3412 "Toggle the display of Row/Column numbers in tables."
3424 "Toggle the formula debugger in tables."
3430 ;;; The orgtbl minor mode
3432 ;; Define a minor mode which can be used in other modes in order to
3433 ;; integrate the org-mode table editor.
3435 ;; This is really a hack, because the org-mode table editor uses several
3436 ;; keys which normally belong to the major mode, for example the TAB and
3437 ;; RET keys. Here is how it works: The minor mode defines all the keys
3438 ;; necessary to operate the table editor, but wraps the commands into a
3439 ;; function which tests if the cursor is currently inside a table. If that
3440 ;; is the case, the table editor command is executed. However, when any of
3441 ;; those keys is used outside a table, the function uses `key-binding' to
3442 ;; look up if the key has an associated command in another currently active
3443 ;; keymap (minor modes, major mode, global), and executes that command.
3444 ;; There might be problems if any of the keys used by the table editor is
3445 ;; otherwise used as a prefix key.
3447 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3448 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3449 ;; addresses this by checking explicitly for both bindings.
3451 ;; The optimized version (see variable `orgtbl-optimized') takes over
3452 ;; all keys which are bound to `self-insert-command' in the *global map*.
3453 ;; Some modes bind other commands to simple characters, for example
3454 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3455 ;; active, this binding is ignored inside tables and replaced with a
3456 ;; modified self-insert.
3462 ;;;###autoload
3464 "Unconditionally turn on `orgtbl-mode'."
3479 ;; Install it as a minor mode.
3483 ;;;###autoload
3485 "The `org-mode' table editor as a minor mode for use in other modes."
3490 ;; Exit without error, in case some hook functions calls this
3491 ;; by accident in org-mode.
3495 ;; Make sure we are first in minor-mode-map-alist
3497 ;; FIXME: maybe it should use emulation-mode-map-alists?
3504 auto-fill-inhibit-regexp)
3508 auto-fill-inhibit-regexp)
3509 orgtbl-line-start-regexp))
3527 "Remove all properties related to narrow-column invisibility."
3540 "Create a function for binding in the table minor mode.
3541 FUN is the command to call inside a table. N is used to create a unique
3542 command name. KEYS are keys that should be checked in for a command
3543 to execute outside of tables."
3549 "Outside of tables, run the binding of `"
3561 keys)
3565 "Error when there is no default binding for a table key."
3570 "Setup orgtbl keymaps."
3600 elt key fun cmd)
3608 ;; Special treatment needed for TAB and RET
3628 [(tab)] "\C-i")))
3630 (org-defkey orgtbl-mode-map [backtab]
3632 [backtab] [S-iso-lefttab] [(shift tab)]
3633 [(tab)] "\C-i"))
3635 (org-defkey orgtbl-mode-map "\M-\C-m"
3636 (orgtbl-make-binding 'org-table-wrap-region 105
3637 "\M-\C-m" [(meta return)]))
3638 (org-defkey orgtbl-mode-map [(meta return)]
3639 (orgtbl-make-binding 'org-table-wrap-region 106
3640 [(meta return)] "\M-\C-m"))
3642 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3643 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3645 (when orgtbl-optimized
3646 ;; If the user wants maximum table support, we need to hijack
3647 ;; some standard editing functions
3648 (org-remap orgtbl-mode-map
3649 'self-insert-command 'orgtbl-self-insert-command
3650 'delete-char 'org-delete-char
3651 'delete-backward-char 'org-delete-backward-char)
3652 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3653 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3654 '("OrgTbl"
3655 ["Create or convert" org-table-create-or-convert-from-region
3656 :active (not (org-at-table-p)) :keys "C-c |" ]
3657 "--"
3658 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3659 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3660 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3661 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3662 "--"
3663 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3664 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3665 ["Copy Field from Above"
3666 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3667 "--"
3668 ("Column"
3669 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3670 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3671 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3672 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3673 ("Row"
3674 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3675 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3676 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3677 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3678 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3679 "--"
3680 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3681 ("Rectangle"
3682 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3683 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3684 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3685 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3686 "--"
3687 ("Radio tables"
3688 ["Insert table template" orgtbl-insert-radio-table
3689 (assq major-mode orgtbl-radio-table-templates)]
3690 ["Comment/uncomment table" orgtbl-toggle-comment t])
3691 "--"
3692 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3693 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3694 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3695 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3696 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3697 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3698 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3699 ["Sum Column/Rectangle" org-table-sum
3700 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3701 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3702 ["Debug Formulas"
3703 org-table-toggle-formula-debugger :active (org-at-table-p)
3704 :keys "C-c {"
3705 :style toggle :selected org-table-formula-debug]
3706 ["Show Col/Row Numbers"
3707 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3708 :keys "C-c }"
3709 :style toggle :selected org-table-overlay-coordinates]
3710 ))
3711 t))
3713 (defun orgtbl-ctrl-c-ctrl-c (arg)
3714 "If the cursor is inside a table, realign the table.
3715 If it is a table to be sent away to a receiver, do it.
3716 With prefix arg, also recompute table."
3717 (interactive "P")
3718 (let ((pos (point)) action)
3719 (save-excursion
3720 (beginning-of-line 1)
3724 (cond
3725 ((integerp action)
3726 (goto-char action)
3727 (org-table-maybe-eval-formula)
3728 (if arg
3729 (call-interactively 'org-table-recalculate)
3730 (org-table-maybe-recalculate-line))
3731 (call-interactively 'org-table-align)
3732 (orgtbl-send-table 'maybe))
3733 ((eq action 'recalc)
3734 (save-excursion
3735 (beginning-of-line 1)
3737 (if (org-at-table-p)
3738 (org-call-with-arg 'org-table-recalculate t))))
3739 (t (let (orgtbl-mode)
3740 (call-interactively (key-binding "\C-c\C-c")))))))
3742 (defun orgtbl-create-or-convert-from-region (arg)
3743 "Create table or convert region to table, if no conflicting binding.
3744 This installs the table binding `C-c |', but only if there is no
3745 conflicting binding to this key outside orgtbl-mode."
3746 (interactive "P")
3747 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3748 (if cmd
3749 (call-interactively cmd)
3750 (call-interactively 'org-table-create-or-convert-from-region))))
3752 (defun orgtbl-tab (arg)
3753 "Justification and field motion for `orgtbl-mode'."
3754 (interactive "P")
3755 (if arg (org-table-edit-field t)
3756 (org-table-justify-field-maybe)
3757 (org-table-next-field)))
3759 (defun orgtbl-ret ()
3760 "Justification and field motion for `orgtbl-mode'."
3761 (interactive)
3762 (if (bobp)
3763 (newline)
3764 (org-table-justify-field-maybe)
3765 (org-table-next-row)))
3767 (defun orgtbl-self-insert-command (N)
3768 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3769 If the cursor is in a table looking at whitespace, the whitespace is
3770 overwritten, and the table is not marked as requiring realignment."
3771 (interactive "p")
3772 (if (and (org-at-table-p)
3773 (or
3774 (and org-table-auto-blank-field
3775 (member last-command
3776 '(orgtbl-hijacker-command-100
3777 orgtbl-hijacker-command-101
3778 orgtbl-hijacker-command-102
3779 orgtbl-hijacker-command-103
3780 orgtbl-hijacker-command-104
3781 orgtbl-hijacker-command-105
3782 yas/expand))
3783 (org-table-blank-field))
3784 t)
3785 (eq N 1)
3787 (let (org-table-may-need-update)
3788 (goto-char (1- (match-end 0)))
3789 (delete-backward-char 1)
3790 (goto-char (match-beginning 0))
3791 (self-insert-command N))
3792 (setq org-table-may-need-update t)
3793 (let* (orgtbl-mode
3794 a
3795 (cmd (or (key-binding
3796 (or (and (listp function-key-map)
3797 (setq a (assoc last-input-event function-key-map))
3798 (cdr a))
3799 (vector last-input-event)))
3800 'self-insert-command)))
3801 (call-interactively cmd)
3802 (if (and org-self-insert-cluster-for-undo
3803 (eq cmd 'self-insert-command))
3804 (if (not (eq last-command 'orgtbl-self-insert-command))
3805 (setq org-self-insert-command-undo-counter 1)
3806 (if (>= org-self-insert-command-undo-counter 20)
3807 (setq org-self-insert-command-undo-counter 1)
3808 (and (> org-self-insert-command-undo-counter 0)
3809 buffer-undo-list
3810 (not (cadr buffer-undo-list)) ; remove nil entry
3811 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3812 (setq org-self-insert-command-undo-counter
3813 (1+ org-self-insert-command-undo-counter))))))))
3816 "Regular expression matching exponentials as produced by calc.")
3818 (defun orgtbl-export (table target)
3819 (require 'org-exp)
3820 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3822 org-table-last-alignment org-table-last-column-widths
3823 maxcol column)
3824 (if (not (fboundp func))
3825 (error "Cannot export orgtbl table to %s" target))
3826 (setq lines (org-table-clean-before-export lines))
3827 (setq table
3828 (mapcar
3829 (lambda (x)
3830 (if (string-match org-table-hline-regexp x)
3831 'hline
3833 lines))
3834 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3835 table)))
3836 (loop for i from (1- maxcol) downto 0 do
3837 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3838 (setq column (delq nil column))
3839 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3840 (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))
3841 (funcall func table nil)))
3843 (defun orgtbl-gather-send-defs ()
3844 "Gather a plist of :name, :transform, :params for each destination before
3845 a radio table."
3846 (save-excursion
3847 (goto-char (org-table-begin))
3848 (let (rtn)
3849 (beginning-of-line 0)
3850 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
3851 (let ((name (org-no-properties (match-string 1)))
3852 (transform (intern (match-string 2)))
3853 (params (if (match-end 3)
3854 (read (concat "(" (match-string 3) ")")))))
3855 (push (list :name name :transform transform :params params)
3856 rtn)
3857 (beginning-of-line 0)))
3858 rtn)))
3860 (defun orgtbl-send-replace-tbl (name txt)
3861 "Find and replace table NAME with TXT."
3862 (save-excursion
3863 (goto-char (point-min))
3864 (unless (re-search-forward
3866 (error "Don't know where to insert translated table"))
3867 (goto-char (match-beginning 0))
3868 (beginning-of-line 2)
3869 (save-excursion
3870 (let ((beg (point)))
3871 (unless (re-search-forward
3872 (concat "END RECEIVE ORGTBL +" name) nil t)
3873 (error "Cannot find end of insertion region"))
3874 (beginning-of-line 1)
3875 (delete-region beg (point))))
3878 ;;;###autoload
3879 (defun org-table-to-lisp (&optional txt)
3880 "Convert the table at point to a Lisp structure.
3881 The structure will be a list. Each item is either the symbol `hline'
3882 for a horizontal separator line, or a list of field values as strings.
3883 The table is taken from the parameter TXT, or from the buffer at point."
3884 (unless txt
3885 (unless (org-at-table-p)
3886 (error "No table at point")))
3887 (let* ((txt (or txt
3888 (buffer-substring-no-properties (org-table-begin)
3889 (org-table-end))))
3892 (mapcar
3893 (lambda (x)
3894 (if (string-match org-table-hline-regexp x)
3895 'hline
3897 lines)))
3899 (defun orgtbl-send-table (&optional maybe)
3900 "Send a transformed version of this table to the receiver position.
3901 With argument MAYBE, fail quietly if no transformation is defined for
3902 this table."
3903 (interactive)
3904 (catch 'exit
3905 (unless (org-at-table-p) (error "Not at a table"))
3906 ;; when non-interactive, we assume align has just happened.
3907 (when (interactive-p) (org-table-align))
3908 (let ((dests (orgtbl-gather-send-defs))
3909 (txt (buffer-substring-no-properties (org-table-begin)
3910 (org-table-end)))
3911 (ntbl 0))
3912 (unless dests (if maybe (throw 'exit nil)
3913 (error "Don't know how to transform this table")))
3914 (dolist (dest dests)
3915 (let* ((name (plist-get dest :name))
3916 (transform (plist-get dest :transform))
3917 (params (plist-get dest :params))
3918 (skip (plist-get params :skip))
3919 (skipcols (plist-get params :skipcols))
3920 beg
3921 (lines (org-table-clean-before-export
3922 (nthcdr (or skip 0)
3924 (i0 (if org-table-clean-did-remove-column 2 1))
3925 (table (mapcar
3926 (lambda (x)
3927 (if (string-match org-table-hline-regexp x)
3928 'hline
3929 (org-remove-by-index
3931 skipcols i0)))
3932 lines))
3933 (fun (if (= i0 2) 'cdr 'identity))
3934 (org-table-last-alignment
3935 (org-remove-by-index (funcall fun org-table-last-alignment)
3936 skipcols i0))
3937 (org-table-last-column-widths
3938 (org-remove-by-index (funcall fun org-table-last-column-widths)
3939 skipcols i0))
3940 (txt (if (fboundp transform)
3941 (funcall transform table params)
3942 (error "No such transformation function %s" transform))))
3943 (orgtbl-send-replace-tbl name txt))
3944 (setq ntbl (1+ ntbl)))
3945 (message "Table converted and installed at %d receiver location%s"
3946 ntbl (if (> ntbl 1) "s" "")))))
3948 (defun org-remove-by-index (list indices &optional i0)
3949 "Remove the elements in LIST with indices in INDICES.
3950 First element has index 0, or I0 if given."
3951 (if (not indices)
3952 list
3953 (if (integerp indices) (setq indices (list indices)))
3954 (setq i0 (1- (or i0 0)))
3955 (delq :rm (mapcar (lambda (x)
3956 (setq i0 (1+ i0))
3957 (if (memq i0 indices) :rm x))
3958 list))))
3960 (defun orgtbl-toggle-comment ()
3961 "Comment or uncomment the orgtbl at point."
3962 (interactive)
3963 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3964 (re2 (concat "^" orgtbl-line-start-regexp))
3965 (commented (save-excursion (beginning-of-line 1)
3966 (cond ((looking-at re1) t)
3967 ((looking-at re2) nil)
3968 (t (error "Not at an org table")))))
3969 (re (if commented re1 re2))
3970 beg end)
3971 (save-excursion
3972 (beginning-of-line 1)
3973 (while (looking-at re) (beginning-of-line 0))
3974 (beginning-of-line 2)
3975 (setq beg (point))
3976 (while (looking-at re) (beginning-of-line 2))
3977 (setq end (point)))
3978 (comment-region beg end (if commented '(4) nil))))
3980 (defun orgtbl-insert-radio-table ()
3981 "Insert a radio table template appropriate for this major mode."
3982 (interactive)
3983 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3984 (txt (nth 1 e))
3985 name pos)
3986 (unless e (error "No radio table setup defined for %s" major-mode))
3987 (setq name (read-string "Table name: "))
3988 (while (string-match "%n" txt)
3989 (setq txt (replace-match name t t txt)))
3991 (setq pos (point))
3992 (insert txt)
3993 (goto-char pos)))
3995 ;; Dynamically bound input and output for table formatting.
3996 (defvar *orgtbl-table* nil
3997 "Carries the current table through formatting routines.")
3998 (defvar *orgtbl-rtn* nil
3999 "Formatting routines push the output lines here.")
4000 ;; Formatting parameters for the current table section.
4001 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4002 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4003 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4004 (defvar *orgtbl-fmt* nil "Format for each entry.")
4005 (defvar *orgtbl-efmt* nil "Format for numbers.")
4006 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4007 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4008 (defvar *orgtbl-lstart* nil "Text starting a row.")
4009 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4010 (defvar *orgtbl-lend* nil "Text ending a row.")
4011 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4013 (defsubst orgtbl-get-fmt (fmt i)
4014 "Retrieve the format from FMT corresponding to the Ith column."
4015 (if (and (not (functionp fmt)) (consp fmt))
4016 (plist-get fmt i)
4017 fmt))
4019 (defsubst orgtbl-apply-fmt (fmt &rest args)
4020 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4021 (cond ((functionp fmt) (apply fmt args))
4022 (fmt (apply 'format fmt args))
4023 (args (car args))
4024 (t args)))
4026 (defsubst orgtbl-eval-str (str)
4027 "If STR is a function, evaluate it with no arguments."
4028 (if (functionp str)
4029 (funcall str)
4030 str))
4032 (defun orgtbl-format-line (line)
4033 "Format LINE as a table row."
4034 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4035 (let* ((i 0)
4036 (line
4037 (mapcar
4038 (lambda (f)
4039 (setq i (1+ i))
4040 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4041 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4042 (orgtbl-apply-fmt efmt (match-string 1 f)
4043 (match-string 2 f))
4044 f)))
4045 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4046 *orgtbl-default-fmt*)
4047 f)))
4048 line)))
4049 (push (if *orgtbl-lfmt*
4050 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4051 (concat (orgtbl-eval-str *orgtbl-lstart*)
4052 (mapconcat 'identity line *orgtbl-sep*)
4053 (orgtbl-eval-str *orgtbl-lend*)))
4054 *orgtbl-rtn*))))
4056 (defun orgtbl-format-section (section-stopper)
4057 "Format lines until the first occurrence of SECTION-STOPPER."
4058 (let (prevline)
4059 (progn
4060 (while (not (eq (car *orgtbl-table*) section-stopper))
4061 (if prevline (orgtbl-format-line prevline))
4062 (setq prevline (pop *orgtbl-table*)))
4063 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4064 (*orgtbl-lend* *orgtbl-llend*)
4065 (*orgtbl-lfmt* *orgtbl-llfmt*))
4066 (orgtbl-format-line prevline))))))
4068 (defun orgtbl-to-generic (table params)
4069 "Convert the orgtbl-mode TABLE to some other format.
4070 This generic routine can be used for many standard cases.
4071 TABLE is a list, each entry either the symbol `hline' for a horizontal
4072 separator line, or a list of fields for that line.
4073 PARAMS is a property list of parameters that can influence the conversion.
4074 For the generic converter, some parameters are obligatory: You need to
4075 specify either :lfmt, or all of (:lstart :lend :sep).
4077 Valid parameters are
4079 :splice When set to t, return only table body lines, don't wrap
4080 them into :tstart and :tend. Default is nil. When :splice
4081 is non-nil, this also means that the exporter should not look
4082 for and interpret header and footer sections.
4084 :hline String to be inserted on horizontal separation lines.
4085 May be nil to ignore hlines.
4087 :sep Separator between two fields
4088 :remove-nil-lines Do not include lines that evaluate to nil.
4091 Each in the following group may be either a string or a function
4092 of no arguments returning a string:
4093 :tstart String to start the table. Ignored when :splice is t.
4094 :tend String to end the table. Ignored when :splice is t.
4095 :lstart String to start a new table line.
4096 :llstart String to start the last table line, defaults to :lstart.
4097 :lend String to end a table line
4098 :llend String to end the last table line, defaults to :lend.
4100 Each in the following group may be a string, a function of one
4101 argument (the field or line) returning a string, or a plist
4102 mapping columns to either of the above:
4103 :lfmt Format for entire line, with enough %s to capture all fields.
4104 If this is present, :lstart, :lend, and :sep are ignored.
4105 :llfmt Format for the entire last line, defaults to :lfmt.
4106 :fmt A format to be used to wrap the field, should contain
4107 %s for the original field value. For example, to wrap
4109 This may also be a property list with column numbers and
4112 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4113 Same as above, specific for the header lines in the table.
4114 All lines before the first hline are treated as header.
4115 If any of these is not present, the data line value is used.
4117 This may be either a string or a function of two arguments:
4118 :efmt Use this format to print numbers with exponentials.
4119 The format should have %s twice for inserting mantissa
4121 may also be a property list with column numbers and
4122 formats. :fmt will still be applied after :efmt.
4124 In addition to this, the parameters :skip and :skipcols are always handled
4125 directly by `orgtbl-send-table'. See manual."
4126 (interactive)
4128 (let* ((splicep (plist-get params :splice))
4129 (hline (plist-get params :hline))
4130 (remove-nil-linesp (plist-get params :remove-nil-lines))
4131 (remove-newlines (plist-get params :remove-newlines))
4132 (*orgtbl-hline* hline)
4133 (*orgtbl-table* table)
4134 (*orgtbl-sep* (plist-get params :sep))
4135 (*orgtbl-efmt* (plist-get params :efmt))
4136 (*orgtbl-lstart* (plist-get params :lstart))
4137 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4138 (*orgtbl-lend* (plist-get params :lend))
4139 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4140 (*orgtbl-lfmt* (plist-get params :lfmt))
4141 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4142 (*orgtbl-fmt* (plist-get params :fmt))
4143 *orgtbl-rtn*)
4145 ;; Put header
4146 (unless splicep
4147 (when (plist-member params :tstart)
4148 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4149 (if tstart (push tstart *orgtbl-rtn*)))))
4151 ;; Do we have a heading section? If so, format it and handle the
4152 ;; trailing hline.
4153 (if (and (not splicep)
4154 (or (consp (car *orgtbl-table*))
4155 (consp (nth 1 *orgtbl-table*)))
4156 (memq 'hline (cdr *orgtbl-table*)))
4157 (progn
4158 (when (eq 'hline (car *orgtbl-table*))
4159 ;; there is a hline before the first data line
4160 (and hline (push hline *orgtbl-rtn*))
4161 (pop *orgtbl-table*))
4162 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4163 *orgtbl-lstart*))
4164 (*orgtbl-llstart* (or (plist-get params :hllstart)
4165 *orgtbl-llstart*))
4166 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4167 (*orgtbl-llend* (or (plist-get params :hllend)
4168 (plist-get params :hlend) *orgtbl-llend*))
4169 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4170 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4171 (plist-get params :hlfmt) *orgtbl-llfmt*))
4172 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4173 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4174 (orgtbl-format-section 'hline))
4175 (if hline (push hline *orgtbl-rtn*))
4176 (pop *orgtbl-table*)))
4178 ;; Now format the main section.
4179 (orgtbl-format-section nil)
4181 (unless splicep
4182 (when (plist-member params :tend)
4183 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4184 (if tend (push tend *orgtbl-rtn*)))))
4186 (mapconcat (if remove-newlines
4187 (lambda (tend)
4189 'identity)
4190 (nreverse (if remove-nil-linesp
4191 (remq nil *orgtbl-rtn*)
4194 (defun orgtbl-to-tsv (table params)
4195 "Convert the orgtbl-mode table to TAB separated material."
4197 (defun orgtbl-to-csv (table params)
4198 "Convert the orgtbl-mode table to CSV material.
4199 This does take care of the proper quoting of fields with comma or quotes."
4200 (orgtbl-to-generic table (org-combine-plists
4201 '(:sep "," :fmt org-quote-csv-field)
4202 params)))
4204 (defun orgtbl-to-latex (table params)
4205 "Convert the orgtbl-mode TABLE to LaTeX.
4206 TABLE is a list, each entry either the symbol `hline' for a horizontal
4207 separator line, or a list of fields for that line.
4208 PARAMS is a property list of parameters that can influence the conversion.
4209 Supports all parameters from `orgtbl-to-generic'. Most important for
4210 LaTeX are:
4212 :splice When set to t, return only table body lines, don't wrap
4213 them into a tabular environment. Default is nil.
4215 :fmt A format to be used to wrap the field, should contain %s for the
4216 original field value. For example, to wrap everything in dollars,
4219 The format may also be a function that formats its one argument.
4221 :efmt Format for transforming numbers with exponentials. The format
4222 should have %s twice for inserting mantissa and exponent, for
4224 This may also be a property list with column numbers and formats.
4225 The format may also be a function that formats its two arguments.
4227 :llend If you find too much space below the last line of a table,
4230 The general parameters :skip and :skipcols have already been applied when
4231 this function is called."
4232 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4233 org-table-last-alignment ""))
4234 (params2
4235 (list
4240 (orgtbl-to-generic table (org-combine-plists params2 params))))
4242 (defun orgtbl-to-html (table params)
4243 "Convert the orgtbl-mode TABLE to HTML.
4244 TABLE is a list, each entry either the symbol `hline' for a horizontal
4245 separator line, or a list of fields for that line.
4246 PARAMS is a property list of parameters that can influence the conversion.
4247 Currently this function recognizes the following parameters:
4249 :splice When set to t, return only table body lines, don't wrap
4250 them into a <table> environment. Default is nil.
4252 The general parameters :skip and :skipcols have already been applied when
4253 this function is called. The function does *not* use `orgtbl-to-generic',
4254 so you cannot specify parameters for it."
4255 (let* ((splicep (plist-get params :splice))
4256 (html-table-tag org-export-html-table-tag)
4257 html)
4258 ;; Just call the formatter we already have
4259 ;; We need to make text lines for it, so put the fields back together.
4260 (setq html (org-format-org-table-html
4261 (mapcar
4262 (lambda (x)
4263 (if (eq x 'hline)
4264 "|----+----|"
4265 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4266 table)
4267 splicep))
4269 (setq html (replace-match "" t t html)))
4270 html))
4272 (defun orgtbl-to-texinfo (table params)
4273 "Convert the orgtbl-mode TABLE to TeXInfo.
4274 TABLE is a list, each entry either the symbol `hline' for a horizontal
4275 separator line, or a list of fields for that line.
4276 PARAMS is a property list of parameters that can influence the conversion.
4277 Supports all parameters from `orgtbl-to-generic'. Most important for
4278 TeXInfo are:
4280 :splice nil/t When set to t, return only table body lines, don't wrap
4281 them into a multitable environment. Default is nil.
4283 :fmt fmt A format to be used to wrap the field, should contain
4284 %s for the original field value. For example, to wrap
4286 This may also be a property list with column numbers and
4288 Each format also may be a function that formats its one
4289 argument.
4292 are computed automatically from the width of the columns
4293 under org-mode.
4295 The general parameters :skip and :skipcols have already been applied when
4296 this function is called."
4297 (let* ((total (float (apply '+ org-table-last-column-widths)))
4298 (colfrac (or (plist-get params :cf)
4299 (mapconcat
4300 (lambda (x) (format "%.3f" (/ (float x) total)))
4301 org-table-last-column-widths " ")))
4302 (params2
4303 (list
4304 :tstart (concat "@multitable @columnfractions " colfrac)
4305 :tend "@end multitable"
4306 :lstart "@item " :lend "" :sep " @tab "
4307 :hlstart "@headitem ")))
4308 (orgtbl-to-generic table (org-combine-plists params2 params))))
4310 (defun orgtbl-to-orgtbl (table params)
4311 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4312 Useful when slicing one table into many. The :hline, :sep,
4313 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4314 and :tend suppress strings without splicing; they can be set to
4315 provide ORGTBL directives for the generated table."
4316 (let* ((params2
4317 (list
4318 :remove-newlines t
4319 :tstart nil :tend nil
4320 :hline "|---"
4321 :sep " | "
4322 :lstart "| "
4323 :lend " |"))
4324 (params (org-combine-plists params2 params)))
4325 (orgtbl-to-generic table params)))
4327 (defun org-table-get-remote-range (name-or-id form)
4328 "Get a field value or a list of values in a range from table at ID.
4330 NAME-OR-ID may be the name of a table in the current file as set by
4332 will then be used. Alternatively, it may be an ID referring to
4333 any entry, also in a different file. In this case, the first table
4334 in that entry will be referenced.
4338 The return value is either a single string for a single field, or a
4339 list of the fields in the rectangle ."
4340 (save-match-data
4341 (let ((id-loc nil)
4342 org-table-column-names org-table-column-name-regexp
4343 org-table-local-parameters org-table-named-field-locations
4344 org-table-current-line-types org-table-current-begin-line
4345 org-table-current-begin-pos org-table-dlines
4346 org-table-hlines org-table-last-alignment
4347 org-table-last-column-widths org-table-last-alignment
4348 org-table-last-column-widths tbeg
4349 buffer loc)
4350 (setq form (org-table-convert-refs-to-rc form))
4351 (save-excursion
4352 (save-restriction
4353 (widen)
4354 (save-excursion
4355 (goto-char (point-min))
4356 (if (re-search-forward
4358 nil t)
4359 (setq buffer (current-buffer) loc (match-beginning 0))
4360 (setq id-loc (org-id-find name-or-id 'marker))
4361 (unless (and id-loc (markerp id-loc))
4363 (setq buffer (marker-buffer id-loc)
4364 loc (marker-position id-loc))
4365 (move-marker id-loc nil)))
4366 (with-current-buffer buffer
4367 (save-excursion
4368 (save-restriction
4369 (widen)
4370 (goto-char loc)
4371 (forward-char 1)
4373 (not (match-beginning 1)))
4374 (error "Cannot find a table at NAME or ID %s" name-or-id))
4375 (setq tbeg (point-at-bol))
4376 (org-table-get-specials)
4377 (setq form (org-table-formula-substitute-names form))
4378 (if (and (string-match org-table-range-regexp form)
4379 (> (length (match-string 0 form)) 1))
4380 (save-match-data
4381 (org-table-get-range (match-string 0 form) tbeg 1))
4382 form)))))))))
4384 (provide 'org-table)
4386 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4388 ;;; org-table.el ends here