| blob | 3573032d90400b0a897c0bb1a656b6c29e554ae5 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.5
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
29 ;; This file contains the table editor and spreadsheet for Org-mode.
31 ;; Watch out: Here we are talking about two different kind of tables.
32 ;; Most of the code is for the tables created with the Org-mode table editor.
33 ;; Sometimes, we talk about tables created and edited with the table.el
34 ;; Emacs package. We call the former org-type tables, and the latter
35 ;; table.el-type tables.
37 ;;; Code:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, othewise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
90 "Templates for radio tables in different major modes.
91 All occurrences of %n in a template will be replaced with the name of the
92 table, obtained by prompting the user."
99 "Settings for tables in Org-mode."
104 "The default size for newly created tables, Columns x Rows."
110 "Regular expression for recognizing numbers in table columns.
111 If a table column contains mostly numbers, it will be aligned to the
112 right. If not, it will be aligned to the left.
114 The default value of this option is a regular expression which allows
115 anything which looks remotely like a number as used in scientific
116 context. For example, all of the following will be considered a
117 number:
118 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
120 Other options offered by the customize interface are more restrictive."
138 "Fraction of numbers in a column required to make the column align right.
139 In a column all non-white fields are considered. If at least this
140 fraction of fields is matched by `org-table-number-fraction',
141 alignment to the right border applies."
146 "Behavior of tables during editing in Org-mode."
151 "Non-nil means automatically re-align table when pressing TAB or RETURN.
153 removal/insertion."
158 "Non-nil means automatically blank table field when starting to type into it.
159 This only happens when typing immediately after a field motion
160 command (TAB, S-TAB or RET).
161 Only relevant when `org-enable-table-editor' is equal to `optimized'."
166 "Whether the user should confirm when Org fixes formulas."
173 'safe-local-variable
177 "Non-nil means tab in the last column of a table with jump over a hline.
178 If a horizontal separator line is following the current line,
179 `org-table-next-field' can either create a new row before that line, or jump
180 over the line. When this option is nil, a new line will be created before
181 this line."
186 "Options concerning tables in Org-mode."
191 "Should org-mode work with table references like B3 instead of @3$2?
192 Possible values are:
193 nil never use them
194 from accept as input, do not present for editing
195 t accept as input and present for editing"
210 calc-angle-mode deg
211 calc-prefer-frac nil
212 calc-symbolic-mode nil
214 calc-display-working-message t
215 )
216 "List with Calc mode settings for use in `calc-eval' for table formulas.
217 The list must contain alternating symbols (Calc modes variables and values).
218 Don't remove any of the default settings, just change the values. Org-mode
219 relies on the variables to be present in the list."
224 "Non-nil means TAB and RET evaluate a formula in current table field.
225 If the current field starts with an equal sign, it is assumed to be a formula
226 which should be evaluated as described in the manual and in the documentation
227 string of the command `org-table-eval-formula'. This feature requires the
228 Emacs calc package.
229 When this variable is nil, formula calculation is only available through
235 "Non-nil means interpret constants in formulas in tables.
236 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
237 by the value given in `org-table-formula-constants', or by a value obtained
238 from the `constants.el' package."
243 "Alist with constant names and values, for use in table formulas.
244 The car of each element is a name of a constant, without the `$' before it.
245 The cdr is the value as a string. For example, if you'd like to use the
246 speed of light in a formula, you would configure
250 and then use it in an equation like `$1*$c'.
252 Constants can also be defined on a per-file basis using a line like
254 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
261 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
262 Automatically means when TAB or RET or C-c C-c are pressed in the line."
267 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
272 "Non-nil means relative formula references may cross hlines.
273 Here are the allowed values:
275 nil Relative references may not cross hlines. They will reference the
276 field next to the hline instead. Coming from below, the reference
277 will be to the field below the hline. Coming from above, it will be
278 to the field above.
279 t Relative references may cross hlines.
280 error An attempt to cross a hline will throw an error.
282 It is probably good to never set this variable to nil, for the sake of
283 portability of tables."
291 "Options concerning table import and export in Org-mode."
296 "Default export parameters for `org-table-export'.
297 These can be overridden for a specific table by setting the
298 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
299 radio tables for the different export transformations and
300 available parameters."
338 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
339 ;; 1 2 3 4 5
350 "Is this a table line colgroup information?"
354 line)
356 nil
363 "Is this a table line with only alignment/width cookies?"
376 s))))
385 "Use the table.el package to insert a new table.
386 If there is already a table at point, convert between Org-mode tables
387 and table.el tables."
401 "Convert region to table, or create an empty table.
402 If there is an active region, convert it to a table, using the function
403 `org-table-convert-region'. See the documentation of that function
404 to learn how the prefix argument is interpreted to determine the field
405 separator.
406 If there is no such region, create an empty table with `org-table-create'."
413 "Query for a size and insert a table skeleton.
433 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
437 ;; Insert a hline after the first row.
445 "Convert region to a table.
446 The region goes from BEG0 to END0, but these borders will be moved
447 slightly, to make sure a beginning of line in the first line is included.
449 SEPARATOR specifies the field separator in the lines. It can have the
450 following values:
452 '(4) Use the comma as a field separator
453 '(16) Use a TAB as field separator
454 integer When a number, use that many spaces as field separator
455 nil When nil, the command tries to be smart and figure out the
456 separator in the following way:
457 - when each line contains a TAB, assume TAB-separated material
458 - when each line contains a comma, assume CSV material
459 - else, assume one or more SPACE characters as separator."
463 re)
470 ;; Get the right field separator
481 ;; parse the csv stuff
505 "Import FILE as a table.
506 The file is assumed to be tab-separated. Such files can be produced by most
507 spreadsheet and database applications. If no tabs (at least one per line)
508 are found, lines will be split on whitespace into fields."
520 "Export table to a file, with configurable format.
521 Such a file can be imported into a spreadsheet program like Excel.
522 FILE can be the output file name. If not given, it will be taken from
523 a TABLE_EXPORT_FILE property in the current entry or higher up in the
524 hierarchy, or the user will be prompted for a file name.
525 FORMAT can be an export format, of the same kind as it used when
526 `orgtbl-mode' sends a table in a different format. The default format can
527 be found in the variable `org-table-export-default-format', but the function
528 first checks if there is an export format specified in a TABLE_EXPORT_FORMAT
529 property, locally or anywhere up in the hierarchy."
541 buf deffmt-readable)
560 "Format: "
565 deffmt-readable)))
578 'hline
581 skipcols i0)))
582 lines))
586 skipcols i0))
589 skipcols i0)))
606 "Marker at the beginning of the table last aligned.
609 "Marker at the end of the table last aligned.
612 "List of flags for flushright alignment, from the last re-alignment.
615 "List of max width of fields in each column.
618 "Non-nil means debug table formulas.
631 "Align the table at point by aligning all vertical bars."
634 ;; Limits of table
637 ;; Current cursor position
643 column
645 rfmt hfmt
653 emptystrings links dates emph raise narrow
654 falign falign1 fmax f1 len c e space)
657 ;; Check if we have links or dates
669 ;; Make sure the link properties are right
671 ;; Make sure the date properties are right
676 ;; Check if we are narrowing any columns
679 org-format-transports-properties-p
684 ;; Get the rows
687 ;; Store the indentation of the first line
690 ;; Mark the hlines by setting the corresponding element to nil
691 ;; At the same time, we remove trailing space.
694 nil
697 l)))
698 lines))
699 ;; Get the data fields by splitting the lines.
704 ;; How many fields in the longest line?
711 ;; A list of empty strings to fill any short rows on output
713 ;; Check for special formatting.
717 ;; Check if there is an explicit width specified
727 ;; Find fields that are wider than fmax, and shorten them
733 'help-echo
734 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
742 xx)))))
743 ;; Get the maximum width for each column
745 lengths)
746 ;; Get the fraction of numbers, to decide about alignment of the column
752 nil
759 ;; Store the alignment of this table, for later editing of single fields
761 org-table-last-column-widths lengths)
763 ;; With invisible characters, `format' does not get the field width right
764 ;; So we need to make these fields wide by hand.
782 ;; Compute the formats needed for output of the table
795 hfmt))
798 ;; This hack is for org-indent, to force redisplay of the
799 ;; line prefix of the first line. Apparently the redisplay
800 ;; is tied to the newline, which is, I think, a bug.
801 ;; To force this redisplay, we remove and re-insert the
802 ;; newline, so that the redisplay engine thinks it belongs
803 ;; to the changed text.
809 ;; Replace the old one
816 ;; Try to move to the old location
824 ))
827 "Find the beginning of the table and return its position.
828 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
832 org-table-border-regexp)
833 nil t))
840 "Find the end of the table and return its position.
841 With argument TABLE-TYPE, go to the end of a table.el-type table."
845 org-table-border-regexp)
846 nil t))
852 "Justify the current field, text to left, number to right.
853 Optional argument NEW may specify text to replace the current field content."
862 ;; This is not the same table, force a full re-align
868 l f n o e)
892 "Go to the next field in the current table, creating new lines as needed.
893 Before doing so, re-align the table if necessary."
898 org-table-may-need-update)
909 org-table-tab-jumps-over-hlines
921 "Go to the previous field in the table.
922 Before doing so, re-align the table if necessary."
927 org-table-may-need-update)
942 "Move to the end of the current table field.
943 If already at or after the end, move to the end of the next table field.
944 With numeric argument N, move N-1 fields forward first."
957 "Move to the beginning of the current table field.
958 If already at or before the beginning, move to the beginning of the
959 previous field.
960 With numeric argument N, move N-1 fields backward first."
974 "Go to the next row (same column) in the current table.
975 Before doing so, re-align the table if necessary."
983 org-table-may-need-update)
997 "Copy a field down in the current column.
998 If the field at the cursor is empty, copy into it the content of
999 the nearest non-empty field above. With argument N, use the Nth
1000 non-empty field. If the current field is not empty, it is copied
1001 down to the next row, and the cursor is moved with it.
1002 Therefore, repeating this command causes the column to be filled
1003 row-by-row.
1004 If the variable `org-table-copy-increment' is non-nil and the
1005 field is an integer or a timestamp, it will be incremented while
1006 copying. In the case of a timestamp, increment by one day."
1014 txt)
1026 beg t))
1049 "Is point inside a table data field?
1050 I.e. not on a hline or before the first or after the last column?
1051 This actually throws an error, so it aborts the current command."
1062 "Get the field in table line LINE, column COLUMN.
1063 If LINE is larger than the number of data lines in the table, the function
1064 returns nil. However, if COLUMN is too large, we will simply return an
1065 empty string.
1066 If LINE is nil, use the current line.
1067 If column is nil, use the current column."
1074 "Put VALUE into line LINE, column COLUMN.
1075 When ALIGN is set, also realign the table."
1084 "Return the index of the current data line."
1091 cnt))
1094 "Go to the Nth data line in the current table.
1095 Return t when the line exists, nil if it does not exist."
1103 "Blank the current table field or active region."
1120 "Return the value of the field in column N of current row.
1121 N defaults to current field.
1122 If REPLACE is a string, replace field with this value. The return value
1123 is always the old value."
1133 val)
1137 "Show info about the current field, and highlight any reference at point."
1145 org-table-named-field-locations)))
1165 dline col
1167 dline col ref1
1169 ;; FIXME: formula info not correct if special table line
1179 "Find out which column we are in."
1188 cnt)))
1191 "Find out what table data line we are in.
1192 Only data lines count for this."
1202 cnt)))
1205 "Move the cursor to the Nth column in the current table line.
1206 With optional argument ON-DELIM, stop with point before the left delimiter
1207 of the field.
1208 If there are less than N fields, just go to after the last delimiter.
1209 However, when FORCE is non-nil, create new columns if necessary."
1219 t)))))
1227 "Insert a new column into the table."
1235 ;; Current cursor position
1241 nil
1255 "Find a data line in the current table, which is needed for column commands."
1258 t
1269 t
1274 "Turn a buffer line number into a data line number.
1275 If there is no data line in this line, return nil.
1276 If there is no matchin dline (most likely te refrence was a hline), the
1277 first dline below it is used. When ABOVE is non-nil, the one above is used."
1280 i)
1293 nil))
1296 "Delete a column from the table."
1305 ;; Current cursor position
1311 nil
1328 "Move column to the right."
1332 "Move column to the left."
1337 "Move the current column to the right. With arg LEFT, move to the left."
1347 ;; Current cursor position
1357 nil
1376 "Move table row down."
1380 "Move table row up."
1385 "Move the current table line down. With arg UP, move it up."
1394 txt hline2p)
1418 "Insert a new row above the current line into the table.
1419 With prefix ARG, insert below the current line."
1425 ;; Fix the first field if necessary
1439 "Insert a horizontal-line below the current line into the table.
1440 With prefix ABOVE, insert above the current line."
1462 "Insert a hline and move to the row below that line."
1476 In particular, this does handle wide and invisible characters."
1478 ;; It's a hline, just map the characters
1484 t t s)))
1485 s))
1488 "Delete the current row or horizontal line from the table."
1503 "Sort table lines according to the column at point.
1505 The position of point indicates the column to be used for
1506 sorting, and the range of lines is the range between the nearest
1507 horizontal separator lines, or the entire table of no such lines
1508 exist. If point is before the first column, you will be prompted
1509 for the sorting column. If there is an active region, the mark
1510 specifies the first line and the sorting column, while point
1511 should be in the last line to be included into the sorting.
1513 The command then prompts for the sorting type which can be
1514 alphabetically, numerically, or by time (as given in a time stamp
1515 in the field). Sorting in reverse order is also possible.
1517 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1519 If SORTING-TYPE is specified when this function is called from a Lisp
1520 program, no prompting will take place. SORTING-TYPE must be a character,
1521 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1522 should be done in reverse order."
1526 beg end bcol ecol tend tbeg column lns pos)
1571 x))
1584 "Copy region in table to the clipboard and blank all relevant fields.
1585 If there is no active region, use just the field at point."
1592 "Copy rectangular region in table to clipboard.
1593 A special clipboard is used which can only be accessed
1594 with `org-table-paste-rectangle'."
1598 current-prefix-arg))
1600 region cols
1626 org-table-clip))
1629 "Paste a rectangular region into a table.
1630 The upper right corner ends up in the current field. All involved fields
1631 will be overwritten. If the rectangle does not fit into the present table,
1632 the table is enlarged as needed. The process ignores horizontal separator
1633 lines."
1643 c cols field)
1659 "Convert from `org-mode' table to table.el and back.
1660 Obviously, this only works within limits. When an Org-mode table is
1661 converted to table.el, all horizontal separator lines get lost, because
1662 table.el uses these as cell boundaries and has no notion of horizontal lines.
1663 A table.el table can be converted to an Org-mode table only if it does not
1664 do row or column spanning. Multiline cells will become multiple cells.
1665 Beware, Org-mode does not test if the table can be successfully converted - it
1666 blindly applies a recipe that works for simple tables."
1670 ;; convert to Org-mode table
1679 ;; convert to table.el table
1682 ;; first, get rid of all horizontal lines
1686 ;; insert a hline before first
1690 ;; insert a hline after each line
1695 ;; replace "+" at beginning and ending of hlines
1704 "Wrap several fields in a column like a paragraph.
1705 This is useful if you'd like to spread the contents of a field over several
1706 lines, in order to keep the table compact.
1708 If there is an active region, and both point and mark are in the same column,
1709 the text in the column is wrapped to minimum width for the given number of
1710 lines. Generally, this makes the table more compact. A prefix ARG may be
1712 formats the selected text to two lines. If the region was longer than two
1713 lines, the remaining lines remain empty. A negative prefix argument reduces
1714 the current number of lines by that amount. The wrapped text is pasted back
1715 into the table. If you formatted it to more lines than it was before, fields
1716 further down in the table get overwritten - so you might need to make space in
1717 the table first.
1719 If there is no region, the current field is split at the cursor position and
1720 the text fragment to the right of the cursor is prepended to the field one
1721 line down.
1723 If there is no region, but you specify a prefix ARG, the current field gets
1724 blank, and the content is appended to the field above."
1728 ;; There is a region: fill as a paragraph
1732 nlines)
1739 arg)
1743 nil nlines)))
1747 ;; No region, split the current field at point
1751 ;; combine with field above
1761 ;; split field
1774 "Edit table field in a different window.
1775 This is mainly useful for fields that contain hidden parts.
1777 it can be edited in place."
1783 display t intangible t))
1789 p)
1798 intangible t))
1806 "Finish editing a table data field.
1807 Remove all newline characters, insert the result into the table, realign
1808 the table and kill the editing buffer."
1812 text)
1831 "Sum numbers in region of current table column.
1832 The result will be displayed in the echo area, and will be available
1835 If there is an active region, it is interpreted as a rectangle and all
1836 numbers in that rectangle will be summed. If there is no active
1837 region and point is located in a table column, sum all numbers in that
1838 column.
1840 If at least one number looks like a time HH:MM or HH:MM:SS, all other
1841 numbers are assumed to be times as well (in decimal hours) and the
1842 numbers are added as such.
1844 If NLAST is a number, only the NLAST fields will actually be summed."
1871 items1)))
1878 s diff)
1886 sres))))
1909 "Return the formula active for the current field.
1910 Assumes that specials are in place.
1911 If KEY is given, return the key to this formula.
1915 org-table-named-field-locations)))
1929 "Read a formula from the minibuffer, offer stored formula as default.
1930 When NAMED is non-nil, look for a named equation."
1934 org-table-named-field-locations)))
1941 name
1942 ref)
1952 stored)
1954 equation)
1961 scol))
1963 'org-table-formula-history
1964 )))))
1965 mustsave)
1967 ;; remove formula
1974 ;; We set the column equation, delete the named one.
1976 mustsave t))
1982 eq))
1985 "Store the list of formulas below the current table."
1991 ;; don't overwrite TBLFM, we might use text properties to store stuff
2007 ;; Fake a high number to make sure this is sorted at the end.
2014 a)
2024 "Compare two formulas for sorting."
2030 "Return an alist with the stored formulas directly after current table."
2039 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2058 "Modify the equations after the table structure has been edited.
2060 For all numbers larger than LIMIT, shift them by DELTA."
2071 s n a)
2084 t t)))))))))
2087 "Get the column names and local parameters for this table."
2090 names name fields fields1 field cnt
2091 c v l line col types dlines hlines last-dline)
2093 org-table-local-parameters nil
2094 org-table-named-field-locations nil
2095 org-table-current-begin-line nil
2096 org-table-current-begin-pos nil
2097 org-table-current-line-types nil
2116 org-table-local-parameters))))
2132 ;; Analyse the line types
2136 l org-table-current-begin-line)
2153 al al2)
2165 If yes, store the formula and apply it."
2166 ;; We already know we are in a table. Get field will only return a formula
2167 ;; when appropriate. It might return a separator line, but no problem.
2170 named eq)
2181 "List of commands triggering the recalculation of a line.
2194 "Rotate the recalculation mark in the first column.
2195 If in any row, the first field is not consistent with a mark,
2196 insert a new column for the markers.
2197 When there is an active region, change all the lines in the region,
2198 after prompting for the marking character.
2199 After each change, a message will be displayed indicating the meaning
2200 of the new mark."
2215 epos new)
2222 newchar))
2254 "Recompute the current line if marked for it, and if we haven't just done it."
2274 modes)
2277 suppress-align suppress-const
2278 suppress-store suppress-analysis)
2279 "Replace the table field value at the cursor by the result of a calculation.
2281 This function makes use of Dave Gillespie's Calc package, in my view the
2282 most exciting program ever written for GNU Emacs. So you need to have Calc
2283 installed in order to use this function.
2285 In a table, this command replaces the value in the current field with the
2287 formula, by storing it in a special line below the table. When called
2288 with a `C-u' prefix, the current field must be a named field, and the
2289 formula is installed as valid in only this specific field.
2291 When called with two `C-u' prefixes, insert the active equation
2292 for the field back into the current field, so that it can be
2294 to check the referenced fields.
2296 When called, the command first prompts for a formula, which is read in
2297 the minibuffer. Previously entered formulas are available through the
2298 history list, and the last used formula is offered as a default.
2299 These stored formulas are adapted correctly when moving, inserting, or
2300 deleting columns with the corresponding commands.
2302 The formula can be any algebraic expression understood by the Calc package.
2303 For details, see the Org-mode manual.
2305 This function can also be called from Lisp programs and offers
2306 additional arguments: EQUATION can be the formula to apply. If this
2307 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2308 used to speed-up recursive calls by by-passing unnecessary aligns.
2309 SUPPRESS-CONST suppresses the interpretation of constants in the
2310 formula, assuming that this has been done already outside the function.
2311 SUPPRESS-STORE means the formula should not be stored, either because
2312 it is already stored, or because it is a modified equation that should
2313 not overwrite the stored one."
2329 equation
2335 n form form0 bw fmt x ev orig c lispp literal)
2336 ;; Parse the format string. Since we have a lot of modes, this is
2337 ;; a lot of work. However, I think calc still uses most of the time.
2349 'calc-float-format
2352 n))))
2379 fields)))
2385 ;; Insert row and column number of formula result field
2396 t t form)))
2398 ;; Check for old vertical references
2400 ;; Insert remote references
2408 keep-empty numbers lispp))
2409 t t form)))
2410 ;; Insert complex ranges
2418 keep-empty numbers lispp))
2419 t t form)))
2420 ;; Insert simple ranges
2429 keep-empty numbers lispp))
2430 t t form)))
2432 ;; Insert the references to fields in same row
2442 t t form)))
2457 Orig: %s
2458 $xyz-> %s
2459 @r$c-> %s
2490 prop value)))
2493 "Get a calc vector from a column, according to descriptor DESC.
2494 Optional arguments TBEG and COL can give the beginning of the table and
2495 the current column, to avoid unnecessary parsing.
2497 HIGHLIGHT means just highlight the range.
2499 When CORNERS-ONLY is set, only return the corners of the range as
2500 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2501 in the buffer and column1 and column2 are table column numbers."
2508 beg end c1 c2 r1 r2 rangep tmp)
2525 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2532 ;; just one field
2539 ;; A range, return a vector
2540 ;; First sort the numbers to get a regular ractangle
2544 ;; Only return the corners of the range
2546 ;; Copy the range values into a list
2560 ;; return string representation of calc vector
2565 "Analyze descriptor DESC and retrieve the corresponding line number.
2566 The cursor is currently in line CLINE, the table begins in line BLINE,
2567 and TABLE is a vector with line types."
2575 ;; 1 2 3 4 5 6
2595 nil hn cline desc)))
2598 rel on cline desc)))
2602 "FIXME: Needs more documentation."
2615 nil))
2616 t)))
2620 desc cline)
2621 i)))
2626 s))
2629 "Convert list ELEMENTS to something appropriate to insert into formula.
2630 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2631 NUMBERS indicates that everything should be converted to numbers.
2632 LISPP means to return something appropriate for a Lisp list."
2636 elements
2645 elements))))
2651 x
2657 elements
2661 "Recalculate the current table line by applying all stored formulas.
2662 With prefix arg ALL, do this for all lines in the table.
2663 With the prefix argument ALL is `(16)' \
2665 it is the symbol `iterate', recompute the table until it no longer changes.
2666 If NOALIGN is not nil, do not re-align the table after the computations
2667 are done. This is typically used internally to save time, if it is
2668 known that the table will be realigned a little later anyway."
2683 seen-fields lhs1
2685 ;; Insert constants in all formulas
2701 eqlist))
2702 ;; Split the equation list
2708 ;; Expand ranges in lhs of formulas
2711 ;; Get the correct line range to process
2717 ;; This is a table with marked lines, compute selected lines
2719 ;; Move forward to the first non-header line
2730 ;; First find the named fields, and mark them untouchable.
2731 ;; Also check if several field/range formulas try to set the same field.
2750 name)))
2760 ;; Now evaluate the column formulas, but skip fields covered by
2761 ;; field formulas
2765 ;; Unprotected line, recalculate
2777 ;; Now evaluate the field formulas
2791 ;; back to initial position
2799 "Recalculate the table until it does not change anymore.
2800 The maximun number of iterations is 10, but you can chose a different value
2801 with the prefix ARG."
2806 thistbl)
2821 "Recalculate all tables in the current buffer."
2829 "Iterate all tables in the buffer, to converge inter-table dependencies."
2834 c1
2851 "Expand list of formulas.
2852 If some of the RHS in the formulas are ranges or a row reference, expand
2853 them to individual field equations for each field."
2859 ;; This just refers to one fixed field
2862 ;; This just refers to one fixed named field
2884 "Replace @<, @>, $<, $> with first/last row/column of the table.
2885 So @< and $< will always be replaced with @1 and $1, respectively.
2886 The advantage of these special markers are that structure editing of
2887 the table will not change them, while @1 and $1 will be modified
2888 when a line/row is swaped out of that privileged position. So for
2889 formulas that use a range of rows or columns, it may often be better
2891 borders of the table using the @< @> $< $> makers."
2896 org-table-current-ncol)
2900 len
2906 s)
2909 "Replace $const with values in string F."
2911 ;; First, check for column names
2916 ;; Parameters and constants
2918 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
2928 f))
2931 "Find the value for a parameter or constant in a formula.
2932 Parameters get priority."
2963 map))
2970 "--"
2973 "--"
2974 "Shift Reference at Point"
2979 "-"
2980 "Change Test Row for Column Formulas"
2983 "--"
2988 org-table-overlay-coordinates)]
2989 "--"
2996 "Edit the formulas of the current table in a separate buffer."
3012 entry s type title)
3015 ;; Keep global-font-lock-mode from turning on font-lock-mode
3056 "Convert a formula from internal to user representation."
3059 s))
3062 "Convert a formula from user to internal representation."
3065 s))
3068 "Convert spreadsheet references from A7 to @7$28.
3069 Works for single references, but also for entire formulas and even the
3070 full TBLFM line."
3072 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^)]*)\\)" s start)
3075 ;; format match, just advance
3080 ;; 3.e5 or something like this.
3083 ;; (member (match-string 1 s)
3084 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3085 )
3086 ;; function name, just advance
3096 t t s)))))
3097 s))
3100 "Convert spreadsheet references from to @7$28 to AB7.
3101 Works for single references, but also for entire formulas and even the
3102 full TBLFM line."
3109 t t s)))
3114 t nil s)))
3115 s)
3118 "Convert a base 26 number represented by letters into an integer.
3119 For example: AB -> 28."
3125 n))
3128 "Convert an integer into a base 26 number represented by letters.
3129 For example: 28 -> AB."
3134 s))
3137 "Convert all references in this buffer, using FUNCTION."
3147 "Convert all references in the buffer from B3 to @3$2 and back."
3157 "Shift the reference at point one row/hline up."
3161 "Shift the reference at point one row/hline down."
3165 "Shift the reference at point one field to the left."
3169 "Shift the reference at point one field to the right."
3180 ;; A B3-like reference
3186 ;; An internal reference
3192 "Re-match the group N, and replace it with the shifted reference."
3197 t t)))
3200 "Shift a reference part REF.
3201 If DECR is set, decrease the references row/column, else increase.
3202 If HLINE is set, this may be a hline reference, it certainly is not
3203 a translation reference."
3232 "Toggle the display of coordinates in the referenced table."
3241 "Parse the buffer for formula definitions and install them.
3242 With prefix ARG, apply the new formulas to the table."
3252 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3253 nil t)
3277 "Abort editing formulas, without installing the changes."
3288 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3329 "Show the location/value of the $ expression at point."
3338 var name e what match dest)
3343 "$1.."
3426 ;; column number
3454 org-table-fedit-scroll-down))))
3465 "Make sure the cursor is in a dataline in a table."
3474 p1 p2)))
3479 "Move cursor one line up in the window showing the table."
3484 "Move cursor one line down in the window showing the table."
3489 "Move the cursor in the window showing the table.
3490 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3515 "Add a new overlay."
3521 "Highlight rectangular region in a table."
3525 l1 c1 l2 c2 tmp)
3549 "Remove the rectangle overlays."
3560 "Add overlays to the table at point, to show row/column coordinates."
3589 "Toggle the display of Row/Column numbers in tables."
3601 "Toggle the formula debugger in tables."
3607 ;;; The orgtbl minor mode
3609 ;; Define a minor mode which can be used in other modes in order to
3610 ;; integrate the org-mode table editor.
3612 ;; This is really a hack, because the org-mode table editor uses several
3613 ;; keys which normally belong to the major mode, for example the TAB and
3614 ;; RET keys. Here is how it works: The minor mode defines all the keys
3615 ;; necessary to operate the table editor, but wraps the commands into a
3616 ;; function which tests if the cursor is currently inside a table. If that
3617 ;; is the case, the table editor command is executed. However, when any of
3618 ;; those keys is used outside a table, the function uses `key-binding' to
3619 ;; look up if the key has an associated command in another currently active
3620 ;; keymap (minor modes, major mode, global), and executes that command.
3621 ;; There might be problems if any of the keys used by the table editor is
3622 ;; otherwise used as a prefix key.
3624 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3625 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3626 ;; addresses this by checking explicitly for both bindings.
3628 ;; The optimized version (see variable `orgtbl-optimized') takes over
3629 ;; all keys which are bound to `self-insert-command' in the *global map*.
3630 ;; Some modes bind other commands to simple characters, for example
3631 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3632 ;; active, this binding is ignored inside tables and replaced with a
3633 ;; modified self-insert.
3639 ;;;###autoload
3641 "Unconditionally turn on `orgtbl-mode'."
3656 ;; Install it as a minor mode.
3660 ;;;###autoload
3662 "The `org-mode' table editor as a minor mode for use in other modes."
3667 ;; Exit without error, in case some hook functions calls this
3668 ;; by accident in org-mode.
3672 ;; Make sure we are first in minor-mode-map-alist
3674 ;; FIXME: maybe it should use emulation-mode-map-alists?
3681 auto-fill-inhibit-regexp)
3685 auto-fill-inhibit-regexp)
3686 orgtbl-line-start-regexp))
3704 "Remove all properties related to narrow-column invisibility."
3717 "Create a function for binding in the table minor mode.
3718 FUN is the command to call inside a table. N is used to create a unique
3719 command name. KEYS are keys that should be checked in for a command
3720 to execute outside of tables."
3726 "Outside of tables, run the binding of `"
3738 keys)
3742 "Error when there is no default binding for a table key."
3747 "Setup orgtbl keymaps."
3777 elt key fun cmd)
3785 ;; Special treatment needed for TAB and RET
3805 [(tab)] "\C-i")))
3807 (org-defkey orgtbl-mode-map [backtab]
3809 [backtab] [S-iso-lefttab] [(shift tab)]
3810 [(tab)] "\C-i"))
3812 (org-defkey orgtbl-mode-map "\M-\C-m"
3813 (orgtbl-make-binding 'org-table-wrap-region 105
3814 "\M-\C-m" [(meta return)]))
3815 (org-defkey orgtbl-mode-map [(meta return)]
3816 (orgtbl-make-binding 'org-table-wrap-region 106
3817 [(meta return)] "\M-\C-m"))
3819 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
3820 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
3822 (when orgtbl-optimized
3823 ;; If the user wants maximum table support, we need to hijack
3824 ;; some standard editing functions
3825 (org-remap orgtbl-mode-map
3826 'self-insert-command 'orgtbl-self-insert-command
3827 'delete-char 'org-delete-char
3828 'delete-backward-char 'org-delete-backward-char)
3829 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
3830 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
3831 '("OrgTbl"
3832 ["Create or convert" org-table-create-or-convert-from-region
3833 :active (not (org-at-table-p)) :keys "C-c |" ]
3834 "--"
3835 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
3836 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
3837 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
3838 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
3839 "--"
3840 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
3841 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
3842 ["Copy Field from Above"
3843 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
3844 "--"
3845 ("Column"
3846 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
3847 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
3848 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
3849 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
3850 ("Row"
3851 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
3852 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
3853 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
3854 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
3855 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
3856 "--"
3857 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
3858 ("Rectangle"
3859 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
3860 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
3861 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
3862 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
3863 "--"
3864 ("Radio tables"
3865 ["Insert table template" orgtbl-insert-radio-table
3866 (assq major-mode orgtbl-radio-table-templates)]
3867 ["Comment/uncomment table" orgtbl-toggle-comment t])
3868 "--"
3869 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
3870 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
3871 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
3872 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
3873 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
3874 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
3875 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
3876 ["Sum Column/Rectangle" org-table-sum
3877 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
3878 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
3879 ["Debug Formulas"
3880 org-table-toggle-formula-debugger :active (org-at-table-p)
3881 :keys "C-c {"
3882 :style toggle :selected org-table-formula-debug]
3883 ["Show Col/Row Numbers"
3884 org-table-toggle-coordinate-overlays :active (org-at-table-p)
3885 :keys "C-c }"
3886 :style toggle :selected org-table-overlay-coordinates]
3887 ))
3888 t))
3890 (defun orgtbl-ctrl-c-ctrl-c (arg)
3891 "If the cursor is inside a table, realign the table.
3892 If it is a table to be sent away to a receiver, do it.
3893 With prefix arg, also recompute table."
3894 (interactive "P")
3895 (let ((pos (point)) action consts-str consts cst const-str)
3896 (save-excursion
3897 (beginning-of-line 1)
3898 (setq action (cond
3902 (cond
3903 ((integerp action)
3904 (goto-char action)
3905 (org-table-maybe-eval-formula)
3906 (if arg
3907 (call-interactively 'org-table-recalculate)
3908 (org-table-maybe-recalculate-line))
3909 (call-interactively 'org-table-align)
3910 (when (orgtbl-send-table 'maybe)
3911 (run-hooks 'orgtbl-after-send-table-hook)))
3912 ((eq action 'recalc)
3913 (save-excursion
3914 (goto-char (point-min))
3916 (setq const-str (substring-no-properties (match-string 1)))
3918 (when consts
3919 (let (e)
3920 (while (setq e (pop consts))
3922 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
3923 (setq org-table-formula-constants-local cst)))))
3924 (save-excursion
3925 (beginning-of-line 1)
3927 (if (org-at-table-p)
3928 (org-call-with-arg 'org-table-recalculate t))))
3929 (t (let (orgtbl-mode)
3930 (call-interactively (key-binding "\C-c\C-c")))))))
3932 (defun orgtbl-create-or-convert-from-region (arg)
3933 "Create table or convert region to table, if no conflicting binding.
3934 This installs the table binding `C-c |', but only if there is no
3935 conflicting binding to this key outside orgtbl-mode."
3936 (interactive "P")
3937 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
3938 (if cmd
3939 (call-interactively cmd)
3940 (call-interactively 'org-table-create-or-convert-from-region))))
3942 (defun orgtbl-tab (arg)
3943 "Justification and field motion for `orgtbl-mode'."
3944 (interactive "P")
3945 (if arg (org-table-edit-field t)
3946 (org-table-justify-field-maybe)
3947 (org-table-next-field)))
3949 (defun orgtbl-ret ()
3950 "Justification and field motion for `orgtbl-mode'."
3951 (interactive)
3952 (if (bobp)
3953 (newline)
3954 (org-table-justify-field-maybe)
3955 (org-table-next-row)))
3957 (defun orgtbl-self-insert-command (N)
3958 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
3959 If the cursor is in a table looking at whitespace, the whitespace is
3960 overwritten, and the table is not marked as requiring realignment."
3961 (interactive "p")
3962 (if (and (org-at-table-p)
3963 (or
3964 (and org-table-auto-blank-field
3965 (member last-command
3966 '(orgtbl-hijacker-command-100
3967 orgtbl-hijacker-command-101
3968 orgtbl-hijacker-command-102
3969 orgtbl-hijacker-command-103
3970 orgtbl-hijacker-command-104
3971 orgtbl-hijacker-command-105
3972 yas/expand))
3973 (org-table-blank-field))
3974 t)
3975 (eq N 1)
3977 (let (org-table-may-need-update)
3978 (goto-char (1- (match-end 0)))
3979 (delete-backward-char 1)
3980 (goto-char (match-beginning 0))
3981 (self-insert-command N))
3982 (setq org-table-may-need-update t)
3983 (let* (orgtbl-mode
3984 a
3985 (cmd (or (key-binding
3986 (or (and (listp function-key-map)
3987 (setq a (assoc last-input-event function-key-map))
3988 (cdr a))
3989 (vector last-input-event)))
3990 'self-insert-command)))
3991 (call-interactively cmd)
3992 (if (and org-self-insert-cluster-for-undo
3993 (eq cmd 'self-insert-command))
3994 (if (not (eq last-command 'orgtbl-self-insert-command))
3995 (setq org-self-insert-command-undo-counter 1)
3996 (if (>= org-self-insert-command-undo-counter 20)
3997 (setq org-self-insert-command-undo-counter 1)
3998 (and (> org-self-insert-command-undo-counter 0)
3999 buffer-undo-list
4000 (not (cadr buffer-undo-list)) ; remove nil entry
4001 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4002 (setq org-self-insert-command-undo-counter
4003 (1+ org-self-insert-command-undo-counter))))))))
4006 "Regular expression matching exponentials as produced by calc.")
4008 (defun orgtbl-export (table target)
4009 (require 'org-exp)
4010 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4012 org-table-last-alignment org-table-last-column-widths
4013 maxcol column)
4014 (if (not (fboundp func))
4015 (error "Cannot export orgtbl table to %s" target))
4016 (setq lines (org-table-clean-before-export lines))
4017 (setq table
4018 (mapcar
4019 (lambda (x)
4020 (if (string-match org-table-hline-regexp x)
4021 'hline
4023 lines))
4024 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4025 table)))
4026 (loop for i from (1- maxcol) downto 0 do
4027 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4028 (setq column (delq nil column))
4029 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4030 (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))
4031 (funcall func table nil)))
4033 (defun orgtbl-gather-send-defs ()
4034 "Gather a plist of :name, :transform, :params for each destination before
4035 a radio table."
4036 (save-excursion
4037 (goto-char (org-table-begin))
4038 (let (rtn)
4039 (beginning-of-line 0)
4040 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4041 (let ((name (org-no-properties (match-string 1)))
4042 (transform (intern (match-string 2)))
4043 (params (if (match-end 3)
4044 (read (concat "(" (match-string 3) ")")))))
4045 (push (list :name name :transform transform :params params)
4046 rtn)
4047 (beginning-of-line 0)))
4048 rtn)))
4050 (defun orgtbl-send-replace-tbl (name txt)
4051 "Find and replace table NAME with TXT."
4052 (save-excursion
4053 (goto-char (point-min))
4054 (unless (re-search-forward
4056 (error "Don't know where to insert translated table"))
4057 (goto-char (match-beginning 0))
4058 (beginning-of-line 2)
4059 (save-excursion
4060 (let ((beg (point)))
4061 (unless (re-search-forward
4062 (concat "END RECEIVE ORGTBL +" name) nil t)
4063 (error "Cannot find end of insertion region"))
4064 (beginning-of-line 1)
4065 (delete-region beg (point))))
4068 ;;;###autoload
4069 (defun org-table-to-lisp (&optional txt)
4070 "Convert the table at point to a Lisp structure.
4071 The structure will be a list. Each item is either the symbol `hline'
4072 for a horizontal separator line, or a list of field values as strings.
4073 The table is taken from the parameter TXT, or from the buffer at point."
4074 (unless txt
4075 (unless (org-at-table-p)
4076 (error "No table at point")))
4077 (let* ((txt (or txt
4078 (buffer-substring-no-properties (org-table-begin)
4079 (org-table-end))))
4082 (mapcar
4083 (lambda (x)
4084 (if (string-match org-table-hline-regexp x)
4085 'hline
4087 lines)))
4089 (defun orgtbl-send-table (&optional maybe)
4090 "Send a transformed version of this table to the receiver position.
4091 With argument MAYBE, fail quietly if no transformation is defined for
4092 this table."
4093 (interactive)
4094 (catch 'exit
4095 (unless (org-at-table-p) (error "Not at a table"))
4096 ;; when non-interactive, we assume align has just happened.
4097 (when (interactive-p) (org-table-align))
4098 (let ((dests (orgtbl-gather-send-defs))
4099 (txt (buffer-substring-no-properties (org-table-begin)
4100 (org-table-end)))
4101 (ntbl 0))
4102 (unless dests (if maybe (throw 'exit nil)
4103 (error "Don't know how to transform this table")))
4104 (dolist (dest dests)
4105 (let* ((name (plist-get dest :name))
4106 (transform (plist-get dest :transform))
4107 (params (plist-get dest :params))
4108 (skip (plist-get params :skip))
4109 (skipcols (plist-get params :skipcols))
4110 beg
4111 (lines (org-table-clean-before-export
4112 (nthcdr (or skip 0)
4114 (i0 (if org-table-clean-did-remove-column 2 1))
4115 (table (mapcar
4116 (lambda (x)
4117 (if (string-match org-table-hline-regexp x)
4118 'hline
4119 (org-remove-by-index
4121 skipcols i0)))
4122 lines))
4123 (fun (if (= i0 2) 'cdr 'identity))
4124 (org-table-last-alignment
4125 (org-remove-by-index (funcall fun org-table-last-alignment)
4126 skipcols i0))
4127 (org-table-last-column-widths
4128 (org-remove-by-index (funcall fun org-table-last-column-widths)
4129 skipcols i0))
4130 (txt (if (fboundp transform)
4131 (funcall transform table params)
4132 (error "No such transformation function %s" transform))))
4133 (orgtbl-send-replace-tbl name txt))
4134 (setq ntbl (1+ ntbl)))
4135 (message "Table converted and installed at %d receiver location%s"
4136 ntbl (if (> ntbl 1) "s" ""))
4137 (if (> ntbl 0)
4138 ntbl
4139 nil))))
4141 (defun org-remove-by-index (list indices &optional i0)
4142 "Remove the elements in LIST with indices in INDICES.
4143 First element has index 0, or I0 if given."
4144 (if (not indices)
4145 list
4146 (if (integerp indices) (setq indices (list indices)))
4147 (setq i0 (1- (or i0 0)))
4148 (delq :rm (mapcar (lambda (x)
4149 (setq i0 (1+ i0))
4150 (if (memq i0 indices) :rm x))
4151 list))))
4153 (defun orgtbl-toggle-comment ()
4154 "Comment or uncomment the orgtbl at point."
4155 (interactive)
4156 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4157 (re2 (concat "^" orgtbl-line-start-regexp))
4158 (commented (save-excursion (beginning-of-line 1)
4159 (cond ((looking-at re1) t)
4160 ((looking-at re2) nil)
4161 (t (error "Not at an org table")))))
4162 (re (if commented re1 re2))
4163 beg end)
4164 (save-excursion
4165 (beginning-of-line 1)
4166 (while (looking-at re) (beginning-of-line 0))
4167 (beginning-of-line 2)
4168 (setq beg (point))
4169 (while (looking-at re) (beginning-of-line 2))
4170 (setq end (point)))
4171 (comment-region beg end (if commented '(4) nil))))
4173 (defun orgtbl-insert-radio-table ()
4174 "Insert a radio table template appropriate for this major mode."
4175 (interactive)
4176 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4177 (txt (nth 1 e))
4178 name pos)
4179 (unless e (error "No radio table setup defined for %s" major-mode))
4180 (setq name (read-string "Table name: "))
4181 (while (string-match "%n" txt)
4182 (setq txt (replace-match name t t txt)))
4184 (setq pos (point))
4185 (insert txt)
4186 (goto-char pos)))
4188 ;; Dynamically bound input and output for table formatting.
4189 (defvar *orgtbl-table* nil
4190 "Carries the current table through formatting routines.")
4191 (defvar *orgtbl-rtn* nil
4192 "Formatting routines push the output lines here.")
4193 ;; Formatting parameters for the current table section.
4194 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4195 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4196 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4197 (defvar *orgtbl-fmt* nil "Format for each entry.")
4198 (defvar *orgtbl-efmt* nil "Format for numbers.")
4199 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4200 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4201 (defvar *orgtbl-lstart* nil "Text starting a row.")
4202 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4203 (defvar *orgtbl-lend* nil "Text ending a row.")
4204 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4206 (defsubst orgtbl-get-fmt (fmt i)
4207 "Retrieve the format from FMT corresponding to the Ith column."
4208 (if (and (not (functionp fmt)) (consp fmt))
4209 (plist-get fmt i)
4210 fmt))
4212 (defsubst orgtbl-apply-fmt (fmt &rest args)
4213 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4214 (cond ((functionp fmt) (apply fmt args))
4215 (fmt (apply 'format fmt args))
4216 (args (car args))
4217 (t args)))
4219 (defsubst orgtbl-eval-str (str)
4220 "If STR is a function, evaluate it with no arguments."
4221 (if (functionp str)
4222 (funcall str)
4223 str))
4225 (defun orgtbl-format-line (line)
4226 "Format LINE as a table row."
4227 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4228 (let* ((i 0)
4229 (line
4230 (mapcar
4231 (lambda (f)
4232 (setq i (1+ i))
4233 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4234 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4235 (orgtbl-apply-fmt efmt (match-string 1 f)
4236 (match-string 2 f))
4237 f)))
4238 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4239 *orgtbl-default-fmt*)
4240 f)))
4241 line)))
4242 (push (if *orgtbl-lfmt*
4243 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4244 (concat (orgtbl-eval-str *orgtbl-lstart*)
4245 (mapconcat 'identity line *orgtbl-sep*)
4246 (orgtbl-eval-str *orgtbl-lend*)))
4247 *orgtbl-rtn*))))
4249 (defun orgtbl-format-section (section-stopper)
4250 "Format lines until the first occurrence of SECTION-STOPPER."
4251 (let (prevline)
4252 (progn
4253 (while (not (eq (car *orgtbl-table*) section-stopper))
4254 (if prevline (orgtbl-format-line prevline))
4255 (setq prevline (pop *orgtbl-table*)))
4256 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4257 (*orgtbl-lend* *orgtbl-llend*)
4258 (*orgtbl-lfmt* *orgtbl-llfmt*))
4259 (orgtbl-format-line prevline))))))
4261 (defun orgtbl-to-generic (table params)
4262 "Convert the orgtbl-mode TABLE to some other format.
4263 This generic routine can be used for many standard cases.
4264 TABLE is a list, each entry either the symbol `hline' for a horizontal
4265 separator line, or a list of fields for that line.
4266 PARAMS is a property list of parameters that can influence the conversion.
4267 For the generic converter, some parameters are obligatory: you need to
4268 specify either :lfmt, or all of (:lstart :lend :sep).
4270 Valid parameters are
4272 :splice When set to t, return only table body lines, don't wrap
4273 them into :tstart and :tend. Default is nil. When :splice
4274 is non-nil, this also means that the exporter should not look
4275 for and interpret header and footer sections.
4277 :hline String to be inserted on horizontal separation lines.
4278 May be nil to ignore hlines.
4280 :sep Separator between two fields
4281 :remove-nil-lines Do not include lines that evaluate to nil.
4284 Each in the following group may be either a string or a function
4285 of no arguments returning a string:
4286 :tstart String to start the table. Ignored when :splice is t.
4287 :tend String to end the table. Ignored when :splice is t.
4288 :lstart String to start a new table line.
4289 :llstart String to start the last table line, defaults to :lstart.
4290 :lend String to end a table line
4291 :llend String to end the last table line, defaults to :lend.
4293 Each in the following group may be a string, a function of one
4294 argument (the field or line) returning a string, or a plist
4295 mapping columns to either of the above:
4296 :lfmt Format for entire line, with enough %s to capture all fields.
4297 If this is present, :lstart, :lend, and :sep are ignored.
4298 :llfmt Format for the entire last line, defaults to :lfmt.
4299 :fmt A format to be used to wrap the field, should contain
4300 %s for the original field value. For example, to wrap
4302 This may also be a property list with column numbers and
4305 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4306 Same as above, specific for the header lines in the table.
4307 All lines before the first hline are treated as header.
4308 If any of these is not present, the data line value is used.
4310 This may be either a string or a function of two arguments:
4311 :efmt Use this format to print numbers with exponentials.
4312 The format should have %s twice for inserting mantissa
4314 may also be a property list with column numbers and
4315 formats. :fmt will still be applied after :efmt.
4317 In addition to this, the parameters :skip and :skipcols are always handled
4318 directly by `orgtbl-send-table'. See manual."
4319 (interactive)
4321 (let* ((splicep (plist-get params :splice))
4322 (hline (plist-get params :hline))
4323 (remove-nil-linesp (plist-get params :remove-nil-lines))
4324 (remove-newlines (plist-get params :remove-newlines))
4325 (*orgtbl-hline* hline)
4326 (*orgtbl-table* table)
4327 (*orgtbl-sep* (plist-get params :sep))
4328 (*orgtbl-efmt* (plist-get params :efmt))
4329 (*orgtbl-lstart* (plist-get params :lstart))
4330 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4331 (*orgtbl-lend* (plist-get params :lend))
4332 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4333 (*orgtbl-lfmt* (plist-get params :lfmt))
4334 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4335 (*orgtbl-fmt* (plist-get params :fmt))
4336 *orgtbl-rtn*)
4338 ;; Put header
4339 (unless splicep
4340 (when (plist-member params :tstart)
4341 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4342 (if tstart (push tstart *orgtbl-rtn*)))))
4344 ;; Do we have a heading section? If so, format it and handle the
4345 ;; trailing hline.
4346 (if (and (not splicep)
4347 (or (consp (car *orgtbl-table*))
4348 (consp (nth 1 *orgtbl-table*)))
4349 (memq 'hline (cdr *orgtbl-table*)))
4350 (progn
4351 (when (eq 'hline (car *orgtbl-table*))
4352 ;; there is a hline before the first data line
4353 (and hline (push hline *orgtbl-rtn*))
4354 (pop *orgtbl-table*))
4355 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4356 *orgtbl-lstart*))
4357 (*orgtbl-llstart* (or (plist-get params :hllstart)
4358 *orgtbl-llstart*))
4359 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4360 (*orgtbl-llend* (or (plist-get params :hllend)
4361 (plist-get params :hlend) *orgtbl-llend*))
4362 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4363 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4364 (plist-get params :hlfmt) *orgtbl-llfmt*))
4365 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4366 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4367 (orgtbl-format-section 'hline))
4368 (if hline (push hline *orgtbl-rtn*))
4369 (pop *orgtbl-table*)))
4371 ;; Now format the main section.
4372 (orgtbl-format-section nil)
4374 (unless splicep
4375 (when (plist-member params :tend)
4376 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4377 (if tend (push tend *orgtbl-rtn*)))))
4379 (mapconcat (if remove-newlines
4380 (lambda (tend)
4382 'identity)
4383 (nreverse (if remove-nil-linesp
4384 (remq nil *orgtbl-rtn*)
4387 (defun orgtbl-to-tsv (table params)
4388 "Convert the orgtbl-mode table to TAB separated material."
4390 (defun orgtbl-to-csv (table params)
4391 "Convert the orgtbl-mode table to CSV material.
4392 This does take care of the proper quoting of fields with comma or quotes."
4393 (orgtbl-to-generic table (org-combine-plists
4394 '(:sep "," :fmt org-quote-csv-field)
4395 params)))
4397 (defun orgtbl-to-latex (table params)
4398 "Convert the orgtbl-mode TABLE to LaTeX.
4399 TABLE is a list, each entry either the symbol `hline' for a horizontal
4400 separator line, or a list of fields for that line.
4401 PARAMS is a property list of parameters that can influence the conversion.
4402 Supports all parameters from `orgtbl-to-generic'. Most important for
4403 LaTeX are:
4405 :splice When set to t, return only table body lines, don't wrap
4406 them into a tabular environment. Default is nil.
4408 :fmt A format to be used to wrap the field, should contain %s for the
4409 original field value. For example, to wrap everything in dollars,
4412 The format may also be a function that formats its one argument.
4414 :efmt Format for transforming numbers with exponentials. The format
4415 should have %s twice for inserting mantissa and exponent, for
4417 This may also be a property list with column numbers and formats.
4418 The format may also be a function that formats its two arguments.
4420 :llend If you find too much space below the last line of a table,
4423 The general parameters :skip and :skipcols have already been applied when
4424 this function is called."
4425 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4426 org-table-last-alignment ""))
4427 (params2
4428 (list
4433 (orgtbl-to-generic table (org-combine-plists params2 params))))
4435 (defun orgtbl-to-html (table params)
4436 "Convert the orgtbl-mode TABLE to HTML.
4437 TABLE is a list, each entry either the symbol `hline' for a horizontal
4438 separator line, or a list of fields for that line.
4439 PARAMS is a property list of parameters that can influence the conversion.
4440 Currently this function recognizes the following parameters:
4442 :splice When set to t, return only table body lines, don't wrap
4443 them into a <table> environment. Default is nil.
4445 The general parameters :skip and :skipcols have already been applied when
4446 this function is called. The function does *not* use `orgtbl-to-generic',
4447 so you cannot specify parameters for it."
4448 (let* ((splicep (plist-get params :splice))
4449 (html-table-tag org-export-html-table-tag)
4450 html)
4451 ;; Just call the formatter we already have
4452 ;; We need to make text lines for it, so put the fields back together.
4453 (setq html (org-format-org-table-html
4454 (mapcar
4455 (lambda (x)
4456 (if (eq x 'hline)
4457 "|----+----|"
4458 (concat "| " (mapconcat 'org-html-expand x " | ") " |")))
4459 table)
4460 splicep))
4462 (setq html (replace-match "" t t html)))
4463 html))
4465 (defun orgtbl-to-texinfo (table params)
4466 "Convert the orgtbl-mode TABLE to TeXInfo.
4467 TABLE is a list, each entry either the symbol `hline' for a horizontal
4468 separator line, or a list of fields for that line.
4469 PARAMS is a property list of parameters that can influence the conversion.
4470 Supports all parameters from `orgtbl-to-generic'. Most important for
4471 TeXInfo are:
4473 :splice nil/t When set to t, return only table body lines, don't wrap
4474 them into a multitable environment. Default is nil.
4476 :fmt fmt A format to be used to wrap the field, should contain
4477 %s for the original field value. For example, to wrap
4479 This may also be a property list with column numbers and
4481 Each format also may be a function that formats its one
4482 argument.
4485 are computed automatically from the width of the columns
4486 under org-mode.
4488 The general parameters :skip and :skipcols have already been applied when
4489 this function is called."
4490 (let* ((total (float (apply '+ org-table-last-column-widths)))
4491 (colfrac (or (plist-get params :cf)
4492 (mapconcat
4493 (lambda (x) (format "%.3f" (/ (float x) total)))
4494 org-table-last-column-widths " ")))
4495 (params2
4496 (list
4497 :tstart (concat "@multitable @columnfractions " colfrac)
4498 :tend "@end multitable"
4499 :lstart "@item " :lend "" :sep " @tab "
4500 :hlstart "@headitem ")))
4501 (orgtbl-to-generic table (org-combine-plists params2 params))))
4503 (defun orgtbl-to-orgtbl (table params)
4504 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4505 Useful when slicing one table into many. The :hline, :sep,
4506 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4507 and :tend suppress strings without splicing; they can be set to
4508 provide ORGTBL directives for the generated table."
4509 (let* ((params2
4510 (list
4511 :remove-newlines t
4512 :tstart nil :tend nil
4513 :hline "|---"
4514 :sep " | "
4515 :lstart "| "
4516 :lend " |"))
4517 (params (org-combine-plists params2 params)))
4518 (orgtbl-to-generic table params)))
4520 (defun org-table-get-remote-range (name-or-id form)
4521 "Get a field value or a list of values in a range from table at ID.
4523 NAME-OR-ID may be the name of a table in the current file as set by
4525 will then be used. Alternatively, it may be an ID referring to
4526 any entry, also in a different file. In this case, the first table
4527 in that entry will be referenced.
4531 The return value is either a single string for a single field, or a
4532 list of the fields in the rectangle ."
4533 (save-match-data
4534 (let ((id-loc nil)
4535 org-table-column-names org-table-column-name-regexp
4536 org-table-local-parameters org-table-named-field-locations
4537 org-table-current-line-types org-table-current-begin-line
4538 org-table-current-begin-pos org-table-dlines
4539 org-table-current-ncol
4540 org-table-hlines org-table-last-alignment
4541 org-table-last-column-widths org-table-last-alignment
4542 org-table-last-column-widths tbeg
4543 buffer loc)
4544 (setq form (org-table-convert-refs-to-rc form))
4545 (save-excursion
4546 (save-restriction
4547 (widen)
4548 (save-excursion
4549 (goto-char (point-min))
4550 (if (re-search-forward
4552 nil t)
4553 (setq buffer (current-buffer) loc (match-beginning 0))
4554 (setq id-loc (org-id-find name-or-id 'marker))
4555 (unless (and id-loc (markerp id-loc))
4557 (setq buffer (marker-buffer id-loc)
4558 loc (marker-position id-loc))
4559 (move-marker id-loc nil)))
4560 (with-current-buffer buffer
4561 (save-excursion
4562 (save-restriction
4563 (widen)
4564 (goto-char loc)
4565 (forward-char 1)
4567 (not (match-beginning 1)))
4568 (error "Cannot find a table at NAME or ID %s" name-or-id))
4569 (setq tbeg (point-at-bol))
4570 (org-table-get-specials)
4571 (setq form (org-table-formula-substitute-names form))
4572 (if (and (string-match org-table-range-regexp form)
4573 (> (length (match-string 0 form)) 1))
4574 (save-match-data
4575 (org-table-get-range (match-string 0 form) tbeg 1))
4576 form)))))))))
4578 (provide 'org-table)
4580 ;; arch-tag: 4d21cfdd-0268-440a-84b0-09237a0fe0ef
4582 ;;; org-table.el ends here