| blob | cbb9eeeb1eb5265ef9407ec3a7a6eba67014bbc1 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
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: 6.33f
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. These can be
280 overridden on for a specific table by setting the TABLE_EXPORT_FORMAT
281 property. See the manual section on orgtbl radio tables for the different
282 export transformations and available parameters."
293 "Searching from within a table (any type) this finds the first line
319 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
320 ;; 1 2 3 4 5
335 "Use the table.el package to insert a new table.
336 If there is already a table at point, convert between Org-mode tables
337 and table.el tables."
350 "Convert region to table, or create an empty table.
351 If there is an active region, convert it to a table, using the function
352 `org-table-convert-region'. See the documentation of that function
353 to learn how the prefix argument is interpreted to determine the field
354 separator.
355 If there is no such region, create an empty table with `org-table-create'."
362 "Query for a size and insert a table skeleton.
382 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
386 ;; Insert a hline after the first row.
394 "Convert region to a table.
395 The region goes from BEG0 to END0, but these borders will be moved
396 slightly, to make sure a beginning of line in the first line is included.
398 SEPARATOR specifies the field separator in the lines. It can have the
399 following values:
401 '(4) Use the comma as a field separator
402 '(16) Use a TAB as field separator
403 integer When a number, use that many spaces as field separator
404 nil When nil, the command tries to be smart and figure out the
405 separator in the following way:
406 - when each line contains a TAB, assume TAB-separated material
407 - when each line contains a comma, assume CSV material
408 - else, assume one or more SPACE characters as separator."
412 re)
419 ;; Get the right field separator
430 ;; parse the csv stuff
452 "Import FILE as a table.
453 The file is assumed to be tab-separated. Such files can be produced by most
454 spreadsheet and database applications. If no tabs (at least one per line)
455 are found, lines will be split on whitespace into fields."
467 "Export table to a file, with configurable format.
468 Such a file can be imported into a spreadsheet program like Excel.
469 FILE can be the output file name. If not given, it will be taken from
470 a TABLE_EXPORT_FILE property in the current entry or higher up in the
471 hierarchy, or the user will be prompted for a file name.
472 FORMAT can be an export format, of the same kind as it used when
473 orgtbl-mode sends a table in a different format. The default format can
474 be found in the variable `org-table-export-default-format', but the function
475 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
476 property, locally or anywhere up in the hierarchy."
493 buf deffmt-readable)
512 "Format: "
517 deffmt-readable)))
530 'hline
533 skipcols i0)))
534 lines))
538 skipcols i0))
541 skipcols i0)))
558 "Marker at the beginning of the table last aligned.
561 "Marker at the end of the table last aligned.
564 "List of flags for flushright alignment, from the last re-alignment.
567 "List of max width of fields in each column.
570 "Non-nil means, debug table formulas.
582 "Align the table at point by aligning all vertical bars."
585 ;; Limits of table
588 ;; Current cursor position
594 column
596 rfmt hfmt
604 emptystrings links dates emph narrow falign falign1 fmax f1 len c e)
607 ;; Check if we have links or dates
616 ;; Make sure the link properties are right
618 ;; Make sure the date properties are right
622 ;; Check if we are narrowing any columns
629 ;; Get the rows
632 ;; Store the indentation of the first line
635 ;; Mark the hlines by setting the corresponding element to nil
636 ;; At the same time, we remove trailing space.
639 nil
642 l)))
643 lines))
644 ;; Get the data fields by splitting the lines.
649 ;; How many fields in the longest line?
656 ;; A list of empty strings to fill any short rows on output
658 ;; Check for special formatting.
662 ;; Check if there is an explicit width specified
671 ;; Find fields that are wider than fmax, and shorten them
677 'help-echo
678 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
686 xx)))))
687 ;; Get the maximum width for each column
689 ;; Get the fraction of numbers, to decide about alignment of the column
695 nil
702 ;; Store the alignment of this table, for later editing of single fields
704 org-table-last-column-widths lengths)
706 ;; With invisible characters, `format' does not get the field width right
707 ;; So we need to make these fields wide by hand.
715 ; (string-match org-bracket-link-regexp (car c))
719 ;; Compute the formats needed for output of the table
732 hfmt))
735 ;; This hack is for org-indent, to force redisplay of the
736 ;; line prefix of the first line. Apparently the redisplay
737 ;; is tied to the newline, which is, I think, a bug.
738 ;; To force this redisplay, we remove and re-insert the
739 ;; newline, so that the redisplay engine thinks it belongs
740 ;; to the changed text.
746 ;; Replace the old one
753 ;; Try to move to the old location
761 ))
772 "Find the beginning of the table and return its position.
773 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
777 org-table-border-regexp)
778 nil t))
785 "Find the end of the table and return its position.
786 With argument TABLE-TYPE, go to the end of a table.el-type table."
790 org-table-border-regexp)
791 nil t))
797 "Justify the current field, text to left, number to right.
798 Optional argument NEW may specify text to replace the current field content."
807 ;; This is not the same table, force a full re-align
813 l f n o e)
836 "Go to the next field in the current table, creating new lines as needed.
837 Before doing so, re-align the table if necessary."
842 org-table-may-need-update)
853 org-table-tab-jumps-over-hlines
865 "Go to the previous field in the table.
866 Before doing so, re-align the table if necessary."
871 org-table-may-need-update)
886 "Move to the end of the current table field.
887 If already at or after the end, move to the end of the next table field.
888 With numeric argument N, move N-1 fields forward first."
901 "Move to the beginning of the current table field.
902 If already at or before the beginning, move to the beginning of the
903 previous field.
904 With numeric argument N, move N-1 fields backward first."
918 "Go to the next row (same column) in the current table.
919 Before doing so, re-align the table if necessary."
927 org-table-may-need-update)
941 "Copy a field down in the current column.
942 If the field at the cursor is empty, copy into it the content of the nearest
943 non-empty field above. With argument N, use the Nth non-empty field.
944 If the current field is not empty, it is copied down to the next row, and
945 the cursor is moved with it. Therefore, repeating this command causes the
946 column to be filled row-by-row.
947 If the variable `org-table-copy-increment' is non-nil and the field is an
948 integer or a timestamp, it will be incremented while copying. In the case of
949 a timestamp, if the cursor is on the year, change the year. If it is on the
950 month or the day, change that. Point will stay on the current date field
951 in order to easily repeat the interval."
959 txt)
971 beg t))
994 "Is point inside a table data field?
995 I.e. not on a hline or before the first or after the last column?
996 This actually throws an error, so it aborts the current command."
1007 "Blank the current table field or active region."
1024 "Return the value of the field in column N of current row.
1025 N defaults to current field.
1026 If REPLACE is a string, replace field with this value. The return value
1027 is always the old value."
1037 val)
1041 "Show info about the current field, and highlight any reference at point."
1049 org-table-named-field-locations)))
1062 dline col
1064 dline col ref1
1066 ;; FIXME: formula info not correct if special table line
1076 "Find out which column we are in."
1082 cnt)))
1085 "Find out what table data line we are in.
1086 Only datalines count for this."
1096 cnt)))
1099 "Move the cursor to the Nth column in the current table line.
1100 With optional argument ON-DELIM, stop with point before the left delimiter
1101 of the field.
1102 If there are less than N fields, just go to after the last delimiter.
1103 However, when FORCE is non-nil, create new columns if necessary."
1114 ; (backward-char 2) t)))))
1123 "Insert a new column into the table."
1131 ;; Current cursor position
1137 nil
1149 "Find a dataline in the current table, which is needed for column commands."
1152 t
1163 t
1168 "Delete a column from the table."
1177 ;; Current cursor position
1183 nil
1198 "Move column to the right."
1202 "Move column to the left."
1207 "Move the current column to the right. With arg LEFT, move to the left."
1217 ;; Current cursor position
1227 nil
1244 "Move table row down."
1248 "Move table row up."
1253 "Move the current table line down. With arg UP, move it up."
1262 txt hline2p)
1283 "Insert a new row above the current line into the table.
1284 With prefix ARG, insert below the current line."
1290 ;; Fix the first field if necessary
1302 "Insert a horizontal-line below the current line into the table.
1303 With prefix ABOVE, insert above the current line."
1325 "Insert a hline and move to the row below that line."
1339 In particular, this does handle wide and invisible characters."
1341 ;; It's a hline, just map the characters
1347 t t s)))
1348 s))
1351 "Delete the current row or horizontal line from the table."
1364 "Sort table lines according to the column at point.
1366 The position of point indicates the column to be used for
1367 sorting, and the range of lines is the range between the nearest
1368 horizontal separator lines, or the entire table of no such lines
1369 exist. If point is before the first column, you will be prompted
1370 for the sorting column. If there is an active region, the mark
1371 specifies the first line and the sorting column, while point
1372 should be in the last line to be included into the sorting.
1374 The command then prompts for the sorting type which can be
1375 alphabetically, numerically, or by time (as given in a time stamp
1376 in the field). Sorting in reverse order is also possible.
1378 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1380 If SORTING-TYPE is specified when this function is called from a Lisp
1381 program, no prompting will take place. SORTING-TYPE must be a character,
1382 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1383 should be done in reverse order."
1387 beg end bcol ecol tend tbeg column lns pos)
1432 x))
1445 "Copy region in table to the clipboard and blank all relevant fields.
1446 If there is no active region, use just the field at point."
1453 "Copy rectangular region in table to clipboard.
1454 A special clipboard is used which can only be accessed
1455 with `org-table-paste-rectangle'."
1459 current-prefix-arg))
1461 region cols
1487 org-table-clip))
1490 "Paste a rectangular region into a table.
1491 The upper right corner ends up in the current field. All involved fields
1492 will be overwritten. If the rectangle does not fit into the present table,
1493 the table is enlarged as needed. The process ignores horizontal separator
1494 lines."
1504 c cols field)
1520 "Convert from `org-mode' table to table.el and back.
1521 Obviously, this only works within limits. When an Org-mode table is
1522 converted to table.el, all horizontal separator lines get lost, because
1523 table.el uses these as cell boundaries and has no notion of horizontal lines.
1524 A table.el table can be converted to an Org-mode table only if it does not
1525 do row or column spanning. Multiline cells will become multiple cells.
1526 Beware, Org-mode does not test if the table can be successfully converted - it
1527 blindly applies a recipe that works for simple tables."
1531 ;; convert to Org-mode table
1540 ;; convert to table.el table
1543 ;; first, get rid of all horizontal lines
1547 ;; insert a hline before first
1551 ;; insert a hline after each line
1556 ;; replace "+" at beginning and ending of hlines
1565 "Wrap several fields in a column like a paragraph.
1566 This is useful if you'd like to spread the contents of a field over several
1567 lines, in order to keep the table compact.
1569 If there is an active region, and both point and mark are in the same column,
1570 the text in the column is wrapped to minimum width for the given number of
1571 lines. Generally, this makes the table more compact. A prefix ARG may be
1573 formats the selected text to two lines. If the region was longer than two
1574 lines, the remaining lines remain empty. A negative prefix argument reduces
1575 the current number of lines by that amount. The wrapped text is pasted back
1576 into the table. If you formatted it to more lines than it was before, fields
1577 further down in the table get overwritten - so you might need to make space in
1578 the table first.
1580 If there is no region, the current field is split at the cursor position and
1581 the text fragment to the right of the cursor is prepended to the field one
1582 line down.
1584 If there is no region, but you specify a prefix ARG, the current field gets
1585 blank, and the content is appended to the field above."
1589 ;; There is a region: fill as a paragraph
1593 nlines)
1600 arg)
1604 nil nlines)))
1608 ;; No region, split the current field at point
1612 ;; combine with field above
1622 ;; split field
1635 "Edit table field in a different window.
1636 This is mainly useful for fields that contain hidden parts.
1638 it can be edited in place."
1644 display t intangible t))
1650 p)
1659 intangible t))
1667 "Finish editing a table data field.
1668 Remove all newline characters, insert the result into the table, realign
1669 the table and kill the editing buffer."
1673 text)
1709 "Sum numbers in region of current table column.
1710 The result will be displayed in the echo area, and will be available
1713 If there is an active region, it is interpreted as a rectangle and all
1714 numbers in that rectangle will be summed. If there is no active
1715 region and point is located in a table column, sum all numbers in that
1716 column.
1718 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1719 numbers are assumed to be times as well (in decimal hours) and the
1720 numbers are added as such.
1722 If NLAST is a number, only the NLAST fields will actually be summed."
1749 items1)))
1756 s diff)
1764 sres))))
1787 "Return the formula active for the current field.
1788 Assumes that specials are in place.
1789 If KEY is given, return the key to this formula.
1793 org-table-named-field-locations)))
1807 "Read a formula from the minibuffer, offer stored formula as default.
1808 When NAMED is non-nil, look for a named equation."
1812 org-table-named-field-locations)))
1819 name
1820 ref)
1830 stored)
1832 equation)
1839 scol))
1841 'org-table-formula-history
1842 )))))
1843 mustsave)
1845 ;; remove formula
1852 ;; We set the column equation, delete the named one.
1854 mustsave t))
1860 eq))
1863 "Store the list of formulas below the current table."
1869 ;; don't overwrite TBLFM, we might use text properties to store stuff
1890 "Compare two formulas for sorting."
1896 "Return an alist with the stored formulas directly after current table."
1904 (when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
1921 "Modify the equations after the table structure has been edited.
1923 For all numbers larger than LIMIT, shift them by DELTA."
1934 s n a)
1947 t t)))))))))
1950 "Get the column names and local parameters for this table."
1953 names name fields fields1 field cnt
1954 c v l line col types dlines hlines last-dline)
1956 org-table-local-parameters nil
1957 org-table-named-field-locations nil
1958 org-table-current-begin-line nil
1959 org-table-current-begin-pos nil
1960 org-table-current-line-types nil)
1978 org-table-local-parameters))))
1994 ;; Analyse the line types
1998 l org-table-current-begin-line)
2015 al al2)
2027 If yes, store the formula and apply it."
2028 ;; We already know we are in a table. Get field will only return a formula
2029 ;; when appropriate. It might return a separator line, but no problem.
2032 named eq)
2043 "List of commands triggering the recalculation of a line.
2056 "Rotate the recalculation mark in the first column.
2057 If in any row, the first field is not consistent with a mark,
2058 insert a new column for the markers.
2059 When there is an active region, change all the lines in the region,
2060 after prompting for the marking character.
2061 After each change, a message will be displayed indicating the meaning
2062 of the new mark."
2077 epos new)
2084 newchar))
2116 "Recompute the current line if marked for it, and if we haven't just done it."
2136 modes)
2139 suppress-align suppress-const
2140 suppress-store suppress-analysis)
2141 "Replace the table field value at the cursor by the result of a calculation.
2143 This function makes use of Dave Gillespie's Calc package, in my view the
2144 most exciting program ever written for GNU Emacs. So you need to have Calc
2145 installed in order to use this function.
2147 In a table, this command replaces the value in the current field with the
2149 formula, by storing it in a special line below the table. When called
2150 with a `C-u' prefix, the current field must be a named field, and the
2151 formula is installed as valid in only this specific field.
2153 When called with two `C-u' prefixes, insert the active equation
2154 for the field back into the current field, so that it can be
2156 to check the referenced fields.
2158 When called, the command first prompts for a formula, which is read in
2159 the minibuffer. Previously entered formulas are available through the
2160 history list, and the last used formula is offered as a default.
2161 These stored formulas are adapted correctly when moving, inserting, or
2162 deleting columns with the corresponding commands.
2164 The formula can be any algebraic expression understood by the Calc package.
2165 For details, see the Org-mode manual.
2167 This function can also be called from Lisp programs and offers
2168 additional arguments: EQUATION can be the formula to apply. If this
2169 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2170 used to speed-up recursive calls by by-passing unnecessary aligns.
2171 SUPPRESS-CONST suppresses the interpretation of constants in the
2172 formula, assuming that this has been done already outside the function.
2173 SUPPRESS-STORE means the formula should not be stored, either because
2174 it is already stored, or because it is a modified equation that should
2175 not overwrite the stored one."
2191 equation
2197 n form form0 bw fmt x ev orig c lispp literal)
2198 ;; Parse the format string. Since we have a lot of modes, this is
2199 ;; a lot of work. However, I think calc still uses most of the time.
2211 'calc-float-format
2214 n))))
2241 fields)))
2246 ;; Check for old vertical references
2248 ;; Insert remote references
2256 keep-empty numbers lispp))
2257 t t form)))
2258 ;; Insert complex ranges
2266 keep-empty numbers lispp))
2267 t t form)))
2268 ;; Insert simple ranges
2277 keep-empty numbers lispp))
2278 t t form)))
2280 ;; Insert the references to fields in same row
2289 t t form)))
2304 Orig: %s
2305 $xyz-> %s
2306 @r$c-> %s
2337 prop value)))
2340 "Get a calc vector from a column, according to descriptor DESC.
2341 Optional arguments TBEG and COL can give the beginning of the table and
2342 the current column, to avoid unnecessary parsing.
2343 HIGHLIGHT means, just highlight the range."
2350 beg end c1 c2 r1 r2 rangep tmp)
2367 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2373 ;; just one field
2380 ;; A range, return a vector
2381 ;; First sort the numbers to get a regular ractangle
2397 ;; return string representation of calc vector
2402 "Analyze descriptor DESC and retrieve the corresponding line number.
2403 The cursor is currently in line CLINE, the table begins in line BLINE,
2404 and TABLE is a vector with line types."
2412 ;; 1 2 3 4 5 6
2432 nil hn cline desc)))
2435 rel on cline desc)))
2439 "FIXME: Needs more documentation."
2452 nil))
2453 t)))
2457 desc cline)
2458 i)))
2463 s))
2466 "Convert list ELEMENTS to something appropriate to insert into formula.
2467 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2468 NUMBERS indicates that everything should be converted to numbers.
2469 LISPP means to return something appropriate for a Lisp list."
2473 elements
2482 elements))))
2488 x
2494 elements
2498 "Recalculate the current table line by applying all stored formulas.
2499 With prefix arg ALL, do this for all lines in the table.
2500 With the prefix argument ALL is `(16)' (a double `C-c C-u' prefix), or if
2501 it is the symbol `iterate', recompute the table until it no longer changes.
2502 If NOALIGN is not nil, do not re-align the table after the computations
2503 are done. This is typically used internally to save time, if it is
2504 known that the table will be realigned a little later anyway."
2519 ;; Insert constants in all formulas
2523 x)
2524 eqlist))
2525 ;; Split the equation list
2536 ;; This is a table with marked lines, compute selected lines
2538 ;; Move forward to the first non-header line
2549 ;; First find the named fields, and mark them untouchable
2561 name)))
2570 ;; Now evaluate the column formulas, but skip fields covered by
2571 ;; field formulas
2575 ;; Unprotected line, recalculate
2587 ;; Now evaluate the field formulas
2601 ;; back to initial position
2609 "Recalculate the table until it does not change anymore."
2614 thistbl)
2629 "Replace $const with values in string F."
2631 ;; First, check for column names
2636 ;; Parameters and constants
2638 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2648 f))
2651 "Find the value for a parameter or constant in a formula.
2652 Parameters get priority."
2682 map))
2689 "--"
2692 "--"
2693 "Shift Reference at Point"
2698 "-"
2699 "Change Test Row for Column Formulas"
2702 "--"
2707 org-table-overlay-coordinates)]
2708 "--"
2715 "Edit the formulas of the current table in a separate buffer."
2731 entry s type title)
2734 ;; Keep global-font-lock-mode from turning on font-lock-mode
2774 "Convert a formula from internal to user representation."
2777 s))
2780 "Convert a formula from user to internal representation."
2783 s))
2786 "Convert spreadsheet references from AB7 to @7$28.
2787 Works for single references, but also for entire formulas and even the
2788 full TBLFM line."
2790 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
2793 ;; format match, just advance
2798 ;; 3.e5 or something like this.
2808 t t s)))))
2809 s))
2812 "Convert spreadsheet references from to @7$28 to AB7.
2813 Works for single references, but also for entire formulas and even the
2814 full TBLFM line."
2821 t t s)))
2826 t nil s)))
2827 s)
2830 "Convert a base 26 number represented by letters into an integer.
2831 For example: AB -> 28."
2837 n))
2840 "Convert an integer into a base 26 number represented by letters.
2841 For example: 28 -> AB."
2846 s))
2849 "Convert all references in this buffer, using FUNCTION."
2859 "Convert all references in the buffer from B3 to @3$2 and back."
2869 "Shift the reference at point one row/hline up."
2873 "Shift the reference at point one row/hline down."
2877 "Shift the reference at point one field to the left."
2881 "Shift the reference at point one field to the right."
2892 ;; A B3-like reference
2898 ;; An internal reference
2904 "Re-match the group N, and replace it with the shifted refrence."
2909 t t)))
2912 "Shift a refrence part REF.
2913 If DECR is set, decrease the references row/column, else increase.
2914 If HLINE is set, this may be a hline reference, it certainly is not
2915 a translation reference."
2944 "Toggle the display of coordinates in the referenced table."
2953 "Parse the buffer for formula definitions and install them.
2954 With prefix ARG, apply the new formulas to the table."
2965 nil t)
2989 "Abort editing formulas, without installing the changes."
3000 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3041 "Show the location/value of the $ expression at point."
3050 var name e what match dest)
3132 ;; column number
3160 org-table-fedit-scroll-down))))
3171 "Make sure the cursor is in a dataline in a table."
3180 p1 p2)))
3185 "Move cursor one line up in the window showing the table."
3190 "Move cursor one line down in the window showing the table."
3195 "Move the cursor in the window showing the table.
3196 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3221 "Add a new overlay."
3227 "Highlight rectangular region in a table."
3231 l1 c1 l2 c2 tmp)
3255 "Remove the rectangle overlays."
3266 "Add overlays to the table at point, to show row/column coordinates."
3295 "Toggle the display of Row/Column numbers in tables."
3307 "Toggle the formula debugger in tables."
3313 ;;; The orgtbl minor mode
3315 ;; Define a minor mode which can be used in other modes in order to
3316 ;; integrate the org-mode table editor.
3318 ;; This is really a hack, because the org-mode table editor uses several
3319 ;; keys which normally belong to the major mode, for example the TAB and
3320 ;; RET keys. Here is how it works: The minor mode defines all the keys
3321 ;; necessary to operate the table editor, but wraps the commands into a
3322 ;; function which tests if the cursor is currently inside a table. If that
3323 ;; is the case, the table editor command is executed. However, when any of
3324 ;; those keys is used outside a table, the function uses `key-binding' to
3325 ;; look up if the key has an associated command in another currently active
3326 ;; keymap (minor modes, major mode, global), and executes that command.
3327 ;; There might be problems if any of the keys used by the table editor is
3328 ;; otherwise used as a prefix key.
3330 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3331 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3332 ;; addresses this by checking explicitly for both bindings.
3334 ;; The optimized version (see variable `orgtbl-optimized') takes over
3335 ;; all keys which are bound to `self-insert-command' in the *global map*.
3336 ;; Some modes bind other commands to simple characters, for example
3337 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3338 ;; active, this binding is ignored inside tables and replaced with a
3339 ;; modified self-insert.
3342 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
3349 ;;;###autoload
3351 "Unconditionally turn on `orgtbl-mode'."
3366 ;;;###autoload
3368 "The `org-mode' table editor as a minor mode for use in other modes."
3372 ;; Exit without error, in case some hook functions calls this
3373 ;; by accident in org-mode.
3380 ;; Make sure we are first in minor-mode-map-alist
3388 auto-fill-inhibit-regexp)
3392 auto-fill-inhibit-regexp)
3393 orgtbl-line-start-regexp))
3411 "Remove all properties related to narrow-column invisibility."
3423 ;; Install it as a minor mode.
3429 "Create a function for binding in the table minor mode.
3430 FUN is the command to call inside a table. N is used to create a unique
3431 command name. KEYS are keys that should be checked in for a command
3432 to execute outside of tables."
3438 "Outside of tables, run the binding of `"
3450 keys)
3454 "Error when there is no default binding for a table key."
3459 "Setup orgtbl keymaps."
3490 elt key fun cmd)
3498 ;; Special treatment needed for TAB and RET
3518 [(tab)] "\C-i")))
3520 (org-defkey orgtbl-mode-map [backtab]
3522 [backtab] [S-iso-lefttab] [(shift tab)]
3523 [(tab)] "\C-i"))
3525 (org-defkey orgtbl-mode-map "\M-\C-m"
3526 (orgtbl-make-binding 'org-table-wrap-region 105
3527 "\M-\C-m" [(meta return)]))
3528 (org-defkey orgtbl-mode-map [(meta return)]
3529 (orgtbl-make-binding 'org-table-wrap-region 106
3530 [(meta return)] "\M-\C-m"))
3532 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3533 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3535 (when orgtbl-optimized
3536 ;; If the user wants maximum table support, we need to hijack
3537 ;; some standard editing functions
3538 (org-remap orgtbl-mode-map
3539 'self-insert-command 'orgtbl-self-insert-command
3540 'delete-char 'org-delete-char
3541 'delete-backward-char 'org-delete-backward-char)
3542 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3543 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3544 '("OrgTbl"
3545 ["Create or convert" org-table-create-or-convert-from-region
3546 :active (not (org-at-table-p)) :keys "C-c |" ]
3547 "--"
3548 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3549 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3550 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3551 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3552 "--"
3553 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3554 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3555 ["Copy Field from Above"
3556 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3557 "--"
3558 ("Column"
3559 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3560 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3561 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3562 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3563 ("Row"
3564 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3565 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3566 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3567 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3568 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3569 "--"
3570 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3571 ("Rectangle"
3572 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3573 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3574 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3575 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3576 "--"
3577 ("Radio tables"
3578 ["Insert table template" orgtbl-insert-radio-table
3579 (assq major-mode orgtbl-radio-table-templates)]
3580 ["Comment/uncomment table" orgtbl-toggle-comment t])
3581 "--"
3582 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3583 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3584 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3585 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3586 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3587 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3588 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3589 ["Sum Column/Rectangle" org-table-sum
3590 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3591 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3592 ["Debug Formulas"
3593 org-table-toggle-formula-debugger :active (org-at-table-p)
3594 :keys "C-c {"
3595 :style toggle :selected org-table-formula-debug]
3596 ["Show Col/Row Numbers"
3597 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3598 :keys "C-c }"
3599 :style toggle :selected org-table-overlay-coordinates]
3600 ))
3601 t))
3603 (defun orgtbl-ctrl-c-ctrl-c (arg)
3604 "If the cursor is inside a table, realign the table.
3605 If it is a table to be sent away to a receiver, do it.
3606 With prefix arg, also recompute table."
3607 (interactive "P")
3608 (let ((pos (point)) action)
3609 (save-excursion
3610 (beginning-of-line 1)
3614 (cond
3615 ((integerp action)
3616 (goto-char action)
3617 (org-table-maybe-eval-formula)
3618 (if arg
3619 (call-interactively 'org-table-recalculate)
3620 (org-table-maybe-recalculate-line))
3621 (call-interactively 'org-table-align)
3622 (orgtbl-send-table 'maybe))
3623 ((eq action 'recalc)
3624 (save-excursion
3625 (beginning-of-line 1)
3627 (if (org-at-table-p)
3628 (org-call-with-arg 'org-table-recalculate t))))
3629 (t (let (orgtbl-mode)
3630 (call-interactively (key-binding "\C-c\C-c")))))))
3632 (defun orgtbl-create-or-convert-from-region (arg)
3633 "Create table or convert region to table, if no conflicting binding.
3634 This installs the table binding `C-c |', but only if there is no
3635 conflicting binding to this key outside orgtbl-mode."
3636 (interactive "P")
3637 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3638 (if cmd
3639 (call-interactively cmd)
3640 (call-interactively 'org-table-create-or-convert-from-region))))
3642 (defun orgtbl-tab (arg)
3643 "Justification and field motion for `orgtbl-mode'."
3644 (interactive "P")
3645 (if arg (org-table-edit-field t)
3646 (org-table-justify-field-maybe)
3647 (org-table-next-field)))
3649 (defun orgtbl-ret ()
3650 "Justification and field motion for `orgtbl-mode'."
3651 (interactive)
3652 (if (bobp)
3653 (newline)
3654 (org-table-justify-field-maybe)
3655 (org-table-next-row)))
3657 (defun orgtbl-self-insert-command (N)
3658 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3659 If the cursor is in a table looking at whitespace, the whitespace is
3660 overwritten, and the table is not marked as requiring realignment."
3661 (interactive "p")
3662 (if (and (org-at-table-p)
3663 (or
3664 (and org-table-auto-blank-field
3665 (member last-command
3666 '(orgtbl-hijacker-command-100
3667 orgtbl-hijacker-command-101
3668 orgtbl-hijacker-command-102
3669 orgtbl-hijacker-command-103
3670 orgtbl-hijacker-command-104
3671 orgtbl-hijacker-command-105
3672 yas/expand))
3673 (org-table-blank-field))
3674 t)
3675 (eq N 1)
3677 (let (org-table-may-need-update)
3678 (goto-char (1- (match-end 0)))
3679 (delete-backward-char 1)
3680 (goto-char (match-beginning 0))
3681 (self-insert-command N))
3682 (setq org-table-may-need-update t)
3683 (let* (orgtbl-mode
3684 a
3685 (cmd (or (key-binding
3686 (or (and (listp function-key-map)
3687 (setq a (assoc last-input-event function-key-map))
3688 (cdr a))
3689 (vector last-input-event)))
3690 'self-insert-command)))
3691 (call-interactively cmd)
3692 (if (and org-self-insert-cluster-for-undo
3693 (eq cmd 'self-insert-command))
3694 (if (not (eq last-command 'orgtbl-self-insert-command))
3695 (setq org-self-insert-command-undo-counter 1)
3696 (if (>= org-self-insert-command-undo-counter 20)
3697 (setq org-self-insert-command-undo-counter 1)
3698 (and (> org-self-insert-command-undo-counter 0)
3699 buffer-undo-list
3700 (not (cadr buffer-undo-list)) ; remove nil entry
3701 (setcdr buffer-undo-list (cddr buffer-undo-list)))
3702 (setq org-self-insert-command-undo-counter
3703 (1+ org-self-insert-command-undo-counter))))))))
3706 "Regular expression matching exponentials as produced by calc.")
3708 (defun orgtbl-export (table target)
3709 (require 'org-exp)
3710 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
3712 org-table-last-alignment org-table-last-column-widths
3713 maxcol column)
3714 (if (not (fboundp func))
3715 (error "Cannot export orgtbl table to %s" target))
3716 (setq lines (org-table-clean-before-export lines))
3717 (setq table
3718 (mapcar
3719 (lambda (x)
3720 (if (string-match org-table-hline-regexp x)
3721 'hline
3723 lines))
3724 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
3725 table)))
3726 (loop for i from (1- maxcol) downto 0 do
3727 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
3728 (setq column (delq nil column))
3729 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
3730 (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))
3731 (funcall func table nil)))
3733 (defun orgtbl-gather-send-defs ()
3734 "Gathers a plist of :name, :transform, :params for each destination before
3735 a radio table."
3736 (save-excursion
3737 (goto-char (org-table-begin))
3738 (let (rtn)
3739 (beginning-of-line 0)
3740 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
3741 (let ((name (org-no-properties (match-string 1)))
3742 (transform (intern (match-string 2)))
3743 (params (if (match-end 3)
3744 (read (concat "(" (match-string 3) ")")))))
3745 (push (list :name name :transform transform :params params)
3746 rtn)
3747 (beginning-of-line 0)))
3748 rtn)))
3750 (defun orgtbl-send-replace-tbl (name txt)
3751 "Find and replace table NAME with TXT."
3752 (save-excursion
3753 (goto-char (point-min))
3754 (unless (re-search-forward
3756 (error "Don't know where to insert translated table"))
3757 (goto-char (match-beginning 0))
3758 (beginning-of-line 2)
3759 (save-excursion
3760 (let ((beg (point)))
3761 (unless (re-search-forward
3762 (concat "END RECEIVE ORGTBL +" name) nil t)
3763 (error "Cannot find end of insertion region"))
3764 (beginning-of-line 1)
3765 (delete-region beg (point))))
3768 ;;;###autoload
3769 (defun org-table-to-lisp (&optional txt)
3770 "Convert the table at point to a Lisp structure.
3771 The structure will be a list. Each item is either the symbol `hline'
3772 for a horizontal separator line, or a list of field values as strings.
3773 The table is taken from the parameter TXT, or from the buffer at point."
3774 (unless txt
3775 (unless (org-at-table-p)
3776 (error "No table at point")))
3777 (let* ((txt (or txt
3778 (buffer-substring-no-properties (org-table-begin)
3779 (org-table-end))))
3782 (mapcar
3783 (lambda (x)
3784 (if (string-match org-table-hline-regexp x)
3785 'hline
3787 lines)))
3789 (defun orgtbl-send-table (&optional maybe)
3790 "Send a transformed version of this table to the receiver position.
3791 With argument MAYBE, fail quietly if no transformation is defined for
3792 this table."
3793 (interactive)
3794 (catch 'exit
3795 (unless (org-at-table-p) (error "Not at a table"))
3796 ;; when non-interactive, we assume align has just happened.
3797 (when (interactive-p) (org-table-align))
3798 (let ((dests (orgtbl-gather-send-defs))
3799 (txt (buffer-substring-no-properties (org-table-begin)
3800 (org-table-end)))
3801 (ntbl 0))
3802 (unless dests (if maybe (throw 'exit nil)
3803 (error "Don't know how to transform this table")))
3804 (dolist (dest dests)
3805 (let* ((name (plist-get dest :name))
3806 (transform (plist-get dest :transform))
3807 (params (plist-get dest :params))
3808 (skip (plist-get params :skip))
3809 (skipcols (plist-get params :skipcols))
3810 beg
3811 (lines (org-table-clean-before-export
3812 (nthcdr (or skip 0)
3814 (i0 (if org-table-clean-did-remove-column 2 1))
3815 (table (mapcar
3816 (lambda (x)
3817 (if (string-match org-table-hline-regexp x)
3818 'hline
3819 (org-remove-by-index
3821 skipcols i0)))
3822 lines))
3823 (fun (if (= i0 2) 'cdr 'identity))
3824 (org-table-last-alignment
3825 (org-remove-by-index (funcall fun org-table-last-alignment)
3826 skipcols i0))
3827 (org-table-last-column-widths
3828 (org-remove-by-index (funcall fun org-table-last-column-widths)
3829 skipcols i0))
3830 (txt (if (fboundp transform)
3831 (funcall transform table params)
3832 (error "No such transformation function %s" transform))))
3833 (orgtbl-send-replace-tbl name txt))
3834 (setq ntbl (1+ ntbl)))
3835 (message "Table converted and installed at %d receiver location%s"
3836 ntbl (if (> ntbl 1) "s" "")))))
3838 (defun org-remove-by-index (list indices &optional i0)
3839 "Remove the elements in LIST with indices in INDICES.
3840 First element has index 0, or I0 if given."
3841 (if (not indices)
3842 list
3843 (if (integerp indices) (setq indices (list indices)))
3844 (setq i0 (1- (or i0 0)))
3845 (delq :rm (mapcar (lambda (x)
3846 (setq i0 (1+ i0))
3847 (if (memq i0 indices) :rm x))
3848 list))))
3850 (defun orgtbl-toggle-comment ()
3851 "Comment or uncomment the orgtbl at point."
3852 (interactive)
3853 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
3854 (re2 (concat "^" orgtbl-line-start-regexp))
3855 (commented (save-excursion (beginning-of-line 1)
3856 (cond ((looking-at re1) t)
3857 ((looking-at re2) nil)
3858 (t (error "Not at an org table")))))
3859 (re (if commented re1 re2))
3860 beg end)
3861 (save-excursion
3862 (beginning-of-line 1)
3863 (while (looking-at re) (beginning-of-line 0))
3864 (beginning-of-line 2)
3865 (setq beg (point))
3866 (while (looking-at re) (beginning-of-line 2))
3867 (setq end (point)))
3868 (comment-region beg end (if commented '(4) nil))))
3870 (defun orgtbl-insert-radio-table ()
3871 "Insert a radio table template appropriate for this major mode."
3872 (interactive)
3873 (let* ((e (assq major-mode orgtbl-radio-table-templates))
3874 (txt (nth 1 e))
3875 name pos)
3876 (unless e (error "No radio table setup defined for %s" major-mode))
3877 (setq name (read-string "Table name: "))
3878 (while (string-match "%n" txt)
3879 (setq txt (replace-match name t t txt)))
3881 (setq pos (point))
3882 (insert txt)
3883 (goto-char pos)))
3885 ;; Dynamically bound input and output for table formatting.
3886 (defvar *orgtbl-table* nil
3887 "Carries the current table through formatting routines.")
3888 (defvar *orgtbl-rtn* nil
3889 "Formatting routines push the output lines here.")
3890 ;; Formatting parameters for the current table section.
3891 (defvar *orgtbl-hline* nil "Text used for horizontal lines")
3892 (defvar *orgtbl-sep* nil "Text used as a column separator")
3893 (defvar *orgtbl-default-fmt* nil "Default format for each entry")
3894 (defvar *orgtbl-fmt* nil "Format for each entry")
3895 (defvar *orgtbl-efmt* nil "Format for numbers")
3896 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt")
3897 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row")
3898 (defvar *orgtbl-lstart* nil "Text starting a row")
3899 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row")
3900 (defvar *orgtbl-lend* nil "Text ending a row")
3901 (defvar *orgtbl-llend* nil "Specializes lend for the last row")
3903 (defsubst orgtbl-get-fmt (fmt i)
3904 "Retrieve the format from FMT corresponding to the Ith column."
3905 (if (and (not (functionp fmt)) (consp fmt))
3906 (plist-get fmt i)
3907 fmt))
3909 (defsubst orgtbl-apply-fmt (fmt &rest args)
3910 "Apply format FMT to the arguments. NIL FMTs return the first argument."
3911 (cond ((functionp fmt) (apply fmt args))
3912 (fmt (apply 'format fmt args))
3913 (args (car args))
3914 (t args)))
3916 (defsubst orgtbl-eval-str (str)
3917 "If STR is a function, evaluate it with no arguments."
3918 (if (functionp str)
3919 (funcall str)
3920 str))
3922 (defun orgtbl-format-line (line)
3923 "Format LINE as a table row."
3924 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
3925 (let* ((i 0)
3926 (line
3927 (mapcar
3928 (lambda (f)
3929 (setq i (1+ i))
3930 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
3931 (f (if (and efmt (string-match orgtbl-exp-regexp f))
3932 (orgtbl-apply-fmt efmt (match-string 1 f)
3933 (match-string 2 f))
3934 f)))
3935 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
3936 *orgtbl-default-fmt*)
3937 f)))
3938 line)))
3939 (push (if *orgtbl-lfmt*
3940 (orgtbl-apply-fmt *orgtbl-lfmt* line)
3941 (concat (orgtbl-eval-str *orgtbl-lstart*)
3942 (mapconcat 'identity line *orgtbl-sep*)
3943 (orgtbl-eval-str *orgtbl-lend*)))
3944 *orgtbl-rtn*))))
3946 (defun orgtbl-format-section (section-stopper)
3947 "Format lines until the first occurrence of SECTION-STOPPER."
3948 (let (prevline)
3949 (progn
3950 (while (not (eq (car *orgtbl-table*) section-stopper))
3951 (if prevline (orgtbl-format-line prevline))
3952 (setq prevline (pop *orgtbl-table*)))
3953 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
3954 (*orgtbl-lend* *orgtbl-llend*)
3955 (*orgtbl-lfmt* *orgtbl-llfmt*))
3956 (orgtbl-format-line prevline))))))
3958 (defun orgtbl-to-generic (table params)
3959 "Convert the orgtbl-mode TABLE to some other format.
3960 This generic routine can be used for many standard cases.
3961 TABLE is a list, each entry either the symbol `hline' for a horizontal
3962 separator line, or a list of fields for that line.
3963 PARAMS is a property list of parameters that can influence the conversion.
3964 For the generic converter, some parameters are obligatory: You need to
3965 specify either :lfmt, or all of (:lstart :lend :sep).
3967 Valid parameters are
3969 :splice When set to t, return only table body lines, don't wrap
3970 them into :tstart and :tend. Default is nil. When :splice
3971 is non-nil, this also means that the exporter should not look
3972 for and interpret header and footer sections.
3974 :hline String to be inserted on horizontal separation lines.
3975 May be nil to ignore hlines.
3977 :sep Separator between two fields
3978 :remove-nil-lines Do not include lines that evaluate to nil.
3981 Each in the following group may be either a string or a function
3982 of no arguments returning a string:
3983 :tstart String to start the table. Ignored when :splice is t.
3984 :tend String to end the table. Ignored when :splice is t.
3985 :lstart String to start a new table line.
3986 :llstart String to start the last table line, defaults to :lstart.
3987 :lend String to end a table line
3988 :llend String to end the last table line, defaults to :lend.
3990 Each in the following group may be a string, a function of one
3991 argument (the field or line) returning a string, or a plist
3992 mapping columns to either of the above:
3993 :lfmt Format for entire line, with enough %s to capture all fields.
3994 If this is present, :lstart, :lend, and :sep are ignored.
3995 :llfmt Format for the entire last line, defaults to :lfmt.
3996 :fmt A format to be used to wrap the field, should contain
3997 %s for the original field value. For example, to wrap
3999 This may also be a property list with column numbers and
4002 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4003 Same as above, specific for the header lines in the table.
4004 All lines before the first hline are treated as header.
4005 If any of these is not present, the data line value is used.
4007 This may be either a string or a function of two arguments:
4008 :efmt Use this format to print numbers with exponentials.
4009 The format should have %s twice for inserting mantissa
4011 may also be a property list with column numbers and
4012 formats. :fmt will still be applied after :efmt.
4014 In addition to this, the parameters :skip and :skipcols are always handled
4015 directly by `orgtbl-send-table'. See manual."
4016 (interactive)
4018 (let* ((splicep (plist-get params :splice))
4019 (hline (plist-get params :hline))
4020 (remove-nil-linesp (plist-get params :remove-nil-lines))
4021 (*orgtbl-hline* hline)
4022 (*orgtbl-table* table)
4023 (*orgtbl-sep* (plist-get params :sep))
4024 (*orgtbl-efmt* (plist-get params :efmt))
4025 (*orgtbl-lstart* (plist-get params :lstart))
4026 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4027 (*orgtbl-lend* (plist-get params :lend))
4028 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4029 (*orgtbl-lfmt* (plist-get params :lfmt))
4030 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4031 (*orgtbl-fmt* (plist-get params :fmt))
4032 *orgtbl-rtn*)
4034 ;; Put header
4035 (unless splicep
4036 (when (plist-member params :tstart)
4037 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4038 (if tstart (push tstart *orgtbl-rtn*)))))
4040 ;; Do we have a heading section? If so, format it and handle the
4041 ;; trailing hline.
4042 (if (and (not splicep)
4043 (or (consp (car *orgtbl-table*))
4044 (consp (nth 1 *orgtbl-table*)))
4045 (memq 'hline (cdr *orgtbl-table*)))
4046 (progn
4047 (when (eq 'hline (car *orgtbl-table*))
4048 ;; there is a hline before the first data line
4049 (and hline (push hline *orgtbl-rtn*))
4050 (pop *orgtbl-table*))
4051 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4052 *orgtbl-lstart*))
4053 (*orgtbl-llstart* (or (plist-get params :hllstart)
4054 *orgtbl-llstart*))
4055 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4056 (*orgtbl-llend* (or (plist-get params :hllend)
4057 (plist-get params :hlend) *orgtbl-llend*))
4058 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4059 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4060 (plist-get params :hlfmt) *orgtbl-llfmt*))
4061 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4062 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4063 (orgtbl-format-section 'hline))
4064 (if hline (push hline *orgtbl-rtn*))
4065 (pop *orgtbl-table*)))
4067 ;; Now format the main section.
4068 (orgtbl-format-section nil)
4070 (unless splicep
4071 (when (plist-member params :tend)
4072 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4073 (if tend (push tend *orgtbl-rtn*)))))
4075 (mapconcat 'identity (nreverse (if remove-nil-linesp
4076 (remq nil *orgtbl-rtn*)
4079 (defun orgtbl-to-tsv (table params)
4080 "Convert the orgtbl-mode table to TAB separated material."
4082 (defun orgtbl-to-csv (table params)
4083 "Convert the orgtbl-mode table to CSV material.
4084 This does take care of the proper quoting of fields with comma or quotes."
4085 (orgtbl-to-generic table (org-combine-plists
4086 '(:sep "," :fmt org-quote-csv-field)
4087 params)))
4089 (defun orgtbl-to-latex (table params)
4090 "Convert the orgtbl-mode TABLE to LaTeX.
4091 TABLE is a list, each entry either the symbol `hline' for a horizontal
4092 separator line, or a list of fields for that line.
4093 PARAMS is a property list of parameters that can influence the conversion.
4094 Supports all parameters from `orgtbl-to-generic'. Most important for
4095 LaTeX are:
4097 :splice When set to t, return only table body lines, don't wrap
4098 them into a tabular environment. Default is nil.
4100 :fmt A format to be used to wrap the field, should contain %s for the
4101 original field value. For example, to wrap everything in dollars,
4104 The format may also be a function that formats its one argument.
4106 :efmt Format for transforming numbers with exponentials. The format
4107 should have %s twice for inserting mantissa and exponent, for
4109 This may also be a property list with column numbers and formats.
4110 The format may also be a function that formats its two arguments.
4112 :llend If you find too much space below the last line of a table,
4115 The general parameters :skip and :skipcols have already been applied when
4116 this function is called."
4117 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4118 org-table-last-alignment ""))
4119 (params2
4120 (list
4125 (orgtbl-to-generic table (org-combine-plists params2 params))))
4127 (defun orgtbl-to-html (table params)
4128 "Convert the orgtbl-mode TABLE to LaTeX.
4129 TABLE is a list, each entry either the symbol `hline' for a horizontal
4130 separator line, or a list of fields for that line.
4131 PARAMS is a property list of parameters that can influence the conversion.
4132 Currently this function recognizes the following parameters:
4134 :splice When set to t, return only table body lines, don't wrap
4135 them into a <table> environment. Default is nil.
4137 The general parameters :skip and :skipcols have already been applied when
4138 this function is called. The function does *not* use `orgtbl-to-generic',
4139 so you cannot specify parameters for it."
4140 (let* ((splicep (plist-get params :splice))
4141 (html-table-tag org-export-html-table-tag)
4142 html)
4143 ;; Just call the formatter we already have
4144 ;; We need to make text lines for it, so put the fields back together.
4145 (setq html (org-format-org-table-html
4146 (mapcar
4147 (lambda (x)
4148 (if (eq x 'hline)
4149 "|----+----|"
4150 (concat "| " (mapconcat 'identity x " | ") " |")))
4151 table)
4152 splicep))
4154 (setq html (replace-match "" t t html)))
4155 html))
4157 (defun orgtbl-to-texinfo (table params)
4158 "Convert the orgtbl-mode TABLE to TeXInfo.
4159 TABLE is a list, each entry either the symbol `hline' for a horizontal
4160 separator line, or a list of fields for that line.
4161 PARAMS is a property list of parameters that can influence the conversion.
4162 Supports all parameters from `orgtbl-to-generic'. Most important for
4163 TeXInfo are:
4165 :splice nil/t When set to t, return only table body lines, don't wrap
4166 them into a multitable environment. Default is nil.
4168 :fmt fmt A format to be used to wrap the field, should contain
4169 %s for the original field value. For example, to wrap
4171 This may also be a property list with column numbers and
4173 Each format also may be a function that formats its one
4174 argument.
4177 are computed automatically from the width of the columns
4178 under org-mode.
4180 The general parameters :skip and :skipcols have already been applied when
4181 this function is called."
4182 (let* ((total (float (apply '+ org-table-last-column-widths)))
4183 (colfrac (or (plist-get params :cf)
4184 (mapconcat
4185 (lambda (x) (format "%.3f" (/ (float x) total)))
4186 org-table-last-column-widths " ")))
4187 (params2
4188 (list
4189 :tstart (concat "@multitable @columnfractions " colfrac)
4190 :tend "@end multitable"
4191 :lstart "@item " :lend "" :sep " @tab "
4192 :hlstart "@headitem ")))
4193 (orgtbl-to-generic table (org-combine-plists params2 params))))
4195 (defun orgtbl-to-orgtbl (table params)
4196 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4197 Useful when slicing one table into many. The :hline, :sep,
4198 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4199 and :tend suppress strings without splicing; they can be set to
4200 provide ORGTBL directives for the generated table."
4201 (let* ((params2
4202 (list
4203 :tstart nil :tend nil
4204 :hline "|---"
4205 :sep " | "
4206 :lstart "| "
4207 :lend " |"))
4208 (params (org-combine-plists params2 params)))
4209 (orgtbl-to-generic table params)))
4211 (defun org-table-get-remote-range (name-or-id form)
4212 "Get a field value or a list of values in a range from table at ID.
4214 NAME-OR-ID may be the name of a table in the current file as set by
4216 will then be used. Alternatively, it may be an ID referring to
4217 any entry, also in a different file. In this case, the first table
4218 in that entry will be referenced.
4222 The return value is either a single string for a single field, or a
4223 list of the fields in the rectangle ."
4224 (save-match-data
4225 (let ((id-loc nil)
4226 org-table-column-names org-table-column-name-regexp
4227 org-table-local-parameters org-table-named-field-locations
4228 org-table-current-line-types org-table-current-begin-line
4229 org-table-current-begin-pos org-table-dlines
4230 org-table-hlines org-table-last-alignment
4231 org-table-last-column-widths org-table-last-alignment
4232 org-table-last-column-widths tbeg
4233 buffer loc)
4234 (setq form (org-table-convert-refs-to-rc form))
4235 (save-excursion
4236 (save-restriction
4237 (widen)
4238 (save-excursion
4239 (goto-char (point-min))
4240 (if (re-search-forward
4242 nil t)
4243 (setq buffer (current-buffer) loc (match-beginning 0))
4244 (setq id-loc (org-id-find name-or-id 'marker))
4245 (unless (and id-loc (markerp id-loc))
4247 (setq buffer (marker-buffer id-loc)
4248 loc (marker-position id-loc))
4249 (move-marker id-loc nil)))
4250 (switch-to-buffer buffer)
4251 (save-excursion
4252 (save-restriction
4253 (widen)
4254 (goto-char loc)
4255 (forward-char 1)
4257 (not (match-beginning 1)))
4258 (error "Cannot find a table at NAME or ID %s" name-or-id))
4259 (setq tbeg (point-at-bol))
4260 (org-table-get-specials)
4261 (setq form (org-table-formula-substitute-names form))
4262 (if (and (string-match org-table-range-regexp form)
4263 (> (length (match-string 0 form)) 1))
4264 (save-match-data
4265 (org-table-get-range (match-string 0 form) tbeg 1))
4266 form))))))))
4268 (provide 'org-table)
4270 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4272 ;;; org-table.el ends here