| blob | 5f0c9dab23773e92c54300a00c92c42ca883db33 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org-mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
65 "Hook for functions attaching to `C-c C-c', if the table is sent.
66 This can be used to add additional functionality after the table is sent
67 to the receiver position, otherwise, if table is not sent, the functions
73 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
74 In the optimized version, the table editor takes over all simple keys that
75 normally just insert a character. In tables, the characters are inserted
76 in a way to minimize disturbing the table structure (i.e. in overwrite mode
77 for empty fields). Outside tables, the correct binding of the keys is
78 restored.
80 The default for this option is t if the optimized version is also used in
81 Org-mode. See the variable `org-enable-table-editor' for details. Changing
82 this variable requires a restart of Emacs to become effective."
88 % END RECEIVE ORGTBL %n
90 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
91 | | |
94 @c END RECEIVE ORGTBL %n
95 @ignore
96 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
97 | | |
100 <!-- END RECEIVE ORGTBL %n -->
101 <!--
102 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
103 | | |
106 #+ END RECEIVE ORGTBL %n
108 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
109 | | |
111 "Templates for radio tables in different major modes.
112 Each template must define lines that will be treated as a comment and that
115 insertion of the template. The transformed table will later be inserted
116 between these lines.
118 The template should also contain a minimal table in a multiline comment.
119 If multiline comments are not possible in the buffer language,
120 you can pack it into a string that will not be used when the code
121 is compiled or executed. Above the table will you need a line with
123 convert the table into a data structure useful in the
124 language of the buffer. Check the manual for the section on
126 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
128 All occurrences of %n in a template will be replaced with the name of the
129 table, obtained by prompting the user."
136 "Settings for tables in Org-mode."
141 "The default size for newly created tables, Columns x Rows."
146 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
147 "Regular expression for recognizing numbers in table columns.
148 If a table column contains mostly numbers, it will be aligned to the
149 right. If not, it will be aligned to the left.
151 The default value of this option is a regular expression which allows
152 anything which looks remotely like a number as used in scientific
153 context. For example, all of the following will be considered a
154 number:
155 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
157 Other options offered by the customize interface are more restrictive."
171 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
172 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
173 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
177 "Fraction of numbers in a column required to make the column align right.
178 In a column all non-white fields are considered. If at least
179 this fraction of fields is matched by `org-table-number-regexp',
180 alignment to the right border applies."
185 "Behavior of tables during editing in Org-mode."
190 "Non-nil means automatically re-align table when pressing TAB or RETURN.
192 removal/insertion."
197 "Non-nil means automatically blank table field when starting to type into it.
198 This only happens when typing immediately after a field motion
199 command (TAB, S-TAB or RET).
200 Only relevant when `org-enable-table-editor' is equal to `optimized'."
205 "Non-nil means automatically exit the follow mode.
206 When nil, the follow mode will stay on and be active in any table
207 the cursor enters. Since the table follow filed mode messes with the
208 window configuration, it is not recommended to set this variable to nil,
209 except maybe locally in a special file that has mostly tables with long
210 fields."
216 "Whether the user should confirm when Org fixes formulas."
224 'safe-local-variable
228 "Non-nil means tab in the last column of a table with jump over a hline.
229 If a horizontal separator line is following the current line,
230 `org-table-next-field' can either create a new row before that line, or jump
231 over the line. When this option is nil, a new line will be created before
232 this line."
237 "Options concerning tables in Org-mode."
242 "Should org-mode work with table references like B3 instead of @3$2?
243 Possible values are:
244 nil never use them
245 from accept as input, do not present for editing
246 t accept as input and present for editing"
266 calc-angle-mode deg
267 calc-prefer-frac nil
268 calc-symbolic-mode nil
270 calc-display-working-message t
271 )
272 "List with Calc mode settings for use in `calc-eval' for table formulas.
273 The list must contain alternating symbols (Calc modes variables and values).
274 Don't remove any of the default settings, just change the values. Org-mode
275 relies on the variables to be present in the list."
280 "Format for the output of calc computations like $1+$2;t.
281 The default value is 'hours, and will output the results as a
282 number of hours. Other allowed values are 'seconds, 'minutes and
283 'days, and the output will be a fraction of seconds, minutes or
284 days."
293 "Format for fields which contain the result of a formula.
295 characters. Beware that modifying the display can prevent the
296 field from being used in another formula."
302 "Non-nil means TAB and RET evaluate a formula in current table field.
303 If the current field starts with an equal sign, it is assumed to be a formula
304 which should be evaluated as described in the manual and in the documentation
305 string of the command `org-table-eval-formula'. This feature requires the
306 Emacs calc package.
307 When this variable is nil, formula calculation is only available through
313 "Non-nil means interpret constants in formulas in tables.
314 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
315 by the value given in `org-table-formula-constants', or by a value obtained
316 from the `constants.el' package."
321 "Alist with constant names and values, for use in table formulas.
322 The car of each element is a name of a constant, without the `$' before it.
323 The cdr is the value as a string. For example, if you'd like to use the
324 speed of light in a formula, you would configure
328 and then use it in an equation like `$1*$c'.
330 Constants can also be defined on a per-file basis using a line like
332 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
339 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
340 Automatically means when TAB or RET or C-c C-c are pressed in the line."
345 "Non-nil means relative formula references may cross hlines.
346 Here are the allowed values:
348 nil Relative references may not cross hlines. They will reference the
349 field next to the hline instead. Coming from below, the reference
350 will be to the field below the hline. Coming from above, it will be
351 to the field above.
352 t Relative references may cross hlines.
353 error An attempt to cross a hline will throw an error.
355 It is probably good to never set this variable to nil, for the sake of
356 portability of tables."
364 "Non-nil means that evaluation of a field formula can add new
365 columns if an out-of-bounds field is being set."
372 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
376 "Options concerning table import and export in Org-mode."
381 "Default export parameters for `org-table-export'.
382 These can be overridden for a specific table by setting the
383 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
384 radio tables for the different export transformations and
385 available parameters."
390 "Max lines that `org-table-convert-region' will attempt to process.
392 The function can be slow on larger regions; this safety feature
393 prevents it from hanging emacs."
433 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
434 ;; 1 2 3 4 5
445 "Is this a table line colgroup information?"
449 line)
451 nil
458 "Is this a table line with only alignment/width cookies?"
471 s))))
479 ;;;###autoload
481 "Use the table.el package to insert a new table.
482 If there is already a table at point, convert between Org-mode tables
483 and table.el tables."
496 ;;;###autoload
498 "Convert region to table, or create an empty table.
499 If there is an active region, convert it to a table, using the function
500 `org-table-convert-region'. See the documentation of that function
501 to learn how the prefix argument is interpreted to determine the field
502 separator.
503 If there is no such region, create an empty table with `org-table-create'."
509 ;;;###autoload
511 "Query for a size and insert a table skeleton.
531 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
535 ;; Insert a hline after the first row.
542 ;;;###autoload
544 "Convert region to a table.
545 The region goes from BEG0 to END0, but these borders will be moved
546 slightly, to make sure a beginning of line in the first line is included.
548 SEPARATOR specifies the field separator in the lines. It can have the
549 following values:
551 '(4) Use the comma as a field separator
552 '(16) Use a TAB as field separator
553 '(64) Prompt for a regular expression as field separator
554 integer When a number, use that many spaces as field separator
555 regexp When a regular expression, use it to match the separator
556 nil When nil, the command tries to be smart and figure out the
557 separator in the following way:
558 - when each line contains a TAB, assume TAB-separated material
559 - when each line contains a comma, assume CSV material
560 - else, assume one or more SPACE characters as separator."
564 re)
566 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
567 org-table-convert-region-max-lines)
576 ;; Get the right field separator
587 ;; parse the csv stuff
612 ;;;###autoload
614 "Import FILE as a table.
615 The file is assumed to be tab-separated. Such files can be produced by most
616 spreadsheet and database applications. If no tabs (at least one per line)
617 are found, lines will be split on whitespace into fields."
626 ;;;###autoload
628 "Export table to a file, with configurable format.
629 Such a file can be imported into usual spreadsheet programs.
631 FILE can be the output file name. If not given, it will be taken
632 from a TABLE_EXPORT_FILE property in the current entry or higher
633 up in the hierarchy, or the user will be prompted for a file
634 name. FORMAT can be an export format, of the same kind as it
635 used when `orgtbl-mode' sends a table in a different format.
637 The command suggests a format depending on TABLE_EXPORT_FORMAT,
638 whether it is set locally or up in the hierarchy, then on the
639 extension of the given file name, and finally on the variable
640 `org-table-export-default-format'."
673 formats)))
674 org-table-export-default-format)
700 "Marker at the beginning of the table last aligned.
703 "Marker at the end of the table last aligned.
706 "List of flags for flushright alignment, from the last re-alignment.
709 "List of max width of fields in each column.
712 "Non-nil means debug table formulas.
724 ;;;###autoload
726 "Align the table at point by aligning all vertical bars."
729 ;; Limits of table
732 ;; Current cursor position
737 lines lengths l typenums ty fields maxfields i
738 column
740 rfmt hfmt
748 emptystrings links dates emph raise narrow
749 falign falign1 fmax f1 f2 len c e space)
752 ;; Check if we have links or dates
764 ;; Make sure the link properties are right
766 ;; Make sure the date properties are right
771 ;; Check if we are narrowing any columns
774 org-format-transports-properties-p
779 ;; Get the rows
782 ;; Store the indentation of the first line
785 ;; Mark the hlines by setting the corresponding element to nil
786 ;; At the same time, we remove trailing space.
789 nil
792 l)))
793 lines))
794 ;; Get the data fields by splitting the lines.
799 ;; How many fields in the longest line?
806 ;; A list of empty strings to fill any short rows on output
808 ;; Check for special formatting.
812 ;; Check if there is an explicit width specified
822 ;; Find fields that are wider than fmax, and shorten them
828 'help-echo
837 f2)
841 f1)
847 xx)))))
848 ;; Get the maximum width for each column
850 lengths)
851 ;; Get the fraction of numbers, to decide about alignment of the column
857 nil
864 ;; Store the alignment of this table, for later editing of single fields
866 org-table-last-column-widths lengths)
868 ;; With invisible characters, `format' does not get the field width right
869 ;; So we need to make these fields wide by hand.
887 ;; Compute the formats needed for output of the table
897 ;; Replace modified lines only.
900 hfmt)))
910 ;; Try to move to the old location
919 ))
921 ;;;###autoload
923 "Find the beginning of the table and return its position.
924 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
928 ;;;###autoload
930 "Find the end of the table and return its position.
931 With argument TABLE-TYPE, go to the end of a table.el-type table."
941 ;;;###autoload
943 "Justify the current field, text to left, number to right.
944 Optional argument NEW may specify text to replace the current field content."
953 ;; This is not the same table, force a full re-align
959 l f n o e)
985 ;;;###autoload
987 "Go to the next field in the current table, creating new lines as needed.
988 Before doing so, re-align the table if necessary."
993 org-table-may-need-update)
1004 org-table-tab-jumps-over-hlines
1015 ;;;###autoload
1017 "Go to the previous field in the table.
1018 Before doing so, re-align the table if necessary."
1023 org-table-may-need-update)
1038 "Move to the beginning of the current table field.
1039 If already at or before the beginning, move to the beginning of the
1040 previous field.
1041 With numeric argument N, move N-1 fields backward first."
1054 "Move to the end of the current table field.
1055 If already at or after the end, move to the end of the next table field.
1056 With numeric argument N, move N-1 fields forward first."
1069 ;;;###autoload
1071 "Go to the next row (same column) in the current table.
1072 Before doing so, re-align the table if necessary."
1080 org-table-may-need-update)
1093 ;;;###autoload
1095 "Copy the value of the current field one row below.
1097 If the field at the cursor is empty, copy the content of the
1098 nearest non-empty field above. With argument N, use the Nth
1099 non-empty field.
1101 If the current field is not empty, it is copied down to the next
1102 row, and the cursor is moved with it. Therefore, repeating this
1103 command causes the column to be filled row-by-row.
1105 If the variable `org-table-copy-increment' is non-nil and the
1106 field is an integer or a timestamp, it will be incremented while
1107 copying. By default, increment by the difference between the
1108 value in the current field and the one in the field above. To
1109 increment using a fixed integer, set `org-table-copy-increment'
1110 to a number. In the case of a timestamp, increment by days."
1122 txt txt-up inc)
1130 beg t))
1140 beg t))
1147 ;; Above field was not empty, go down to the next row
1180 "Is point inside a table data field?
1181 I.e. not on a hline or before the first or after the last column?
1182 This actually throws an error, so it aborts the current command."
1188 nil
1190 t))
1196 "Get the field in table line LINE, column COLUMN.
1197 If LINE is larger than the number of data lines in the table, the function
1198 returns nil. However, if COLUMN is too large, we will simply return an
1199 empty string.
1200 If LINE is nil, use the current line.
1201 If COLUMN is nil, use the current column."
1208 "Put VALUE into line LINE, column COLUMN.
1209 When ALIGN is set, also realign the table."
1218 "Return the index of the current data line."
1225 cnt))
1228 "Go to the Nth data line in the current table.
1229 Return t when the line exists, nil if it does not exist."
1236 ;;;###autoload
1238 "Blank the current table field or active region."
1255 "Return the value of the field in column N of current row.
1256 N defaults to current field.
1257 If REPLACE is a string, replace field with this value. The return value
1258 is always the old value."
1267 t t))
1269 val)
1272 ;;;###autoload
1274 "Show info about the current field, and highlight any reference at point."
1283 org-table-named-field-locations)))
1303 dline col
1305 dline col ref1
1307 ;; FIXME: formula info not correct if special table line
1317 "Find out which column we are in."
1327 cnt)))
1329 ;;;###autoload
1331 "Find out what table data line we are in.
1332 Only data lines count for this."
1344 cnt)))
1346 ;;;###autoload
1348 "Move the cursor to the Nth column in the current table line.
1349 With optional argument ON-DELIM, stop with point before the left delimiter
1350 of the field.
1351 If there are less than N fields, just go to after the last delimiter.
1352 However, when FORCE is non-nil, create new columns if necessary."
1362 t)))))
1369 ;;;###autoload
1371 "Insert a new column into the table."
1379 ;; Current cursor position
1385 nil
1399 "Find a data line in the current table, which is needed for column commands."
1402 t
1413 t
1418 "Turn a buffer line number into a data line number.
1419 If there is no data line in this line, return nil.
1420 If there is no matching dline (most likely te reference was a hline), the
1421 first dline below it is used. When ABOVE is non-nil, the one above is used."
1424 i)
1437 nil))
1439 ;;;###autoload
1441 "Delete a column from the table."
1450 ;; Current cursor position
1456 nil
1472 ;;;###autoload
1474 "Move column to the right."
1477 ;;;###autoload
1479 "Move column to the left."
1483 ;;;###autoload
1485 "Move the current column to the right. With arg LEFT, move to the left."
1495 ;; Current cursor position
1505 nil
1523 ;;;###autoload
1525 "Move table row down."
1528 ;;;###autoload
1530 "Move table row up."
1534 ;;;###autoload
1536 "Move the current table line down. With arg UP, move it up."
1545 txt hline2p)
1568 ;;;###autoload
1570 "Insert a new row above the current line into the table.
1571 With prefix ARG, insert below the current line."
1577 ;; Fix the first field if necessary
1590 ;;;###autoload
1592 "Insert a horizontal-line below the current line into the table.
1593 With prefix ABOVE, insert above the current line."
1614 ;;;###autoload
1616 "Insert a hline and move to the row below that line."
1630 In particular, this does handle wide and invisible characters."
1632 ;; It's a hline, just map the characters
1638 t t s)))
1639 s))
1641 ;;;###autoload
1643 "Delete the current row or horizontal line from the table."
1657 ;;;###autoload
1659 "Sort table lines according to the column at point.
1661 The position of point indicates the column to be used for
1662 sorting, and the range of lines is the range between the nearest
1663 horizontal separator lines, or the entire table of no such lines
1664 exist. If point is before the first column, you will be prompted
1665 for the sorting column. If there is an active region, the mark
1666 specifies the first line and the sorting column, while point
1667 should be in the last line to be included into the sorting.
1669 The command then prompts for the sorting type which can be
1670 alphabetically, numerically, or by time (as given in a time stamp
1671 in the field, or as a HH:MM value). Sorting in reverse order is
1672 also possible.
1674 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1676 If SORTING-TYPE is specified when this function is called from a Lisp
1677 program, no prompting will take place. SORTING-TYPE must be a character,
1678 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1679 sorting should be done in reverse order.
1681 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1682 a function to be called to extract the key. It must return either
1683 a string or a number that should serve as the sorting key for that
1684 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1685 is specified interactively, the comparison will be either a string or
1686 numeric compare based on the type of the first key in the table."
1691 beg end bcol ecol tend tbeg column lns pos)
1736 x))
1751 (defun org-table--do-sort (table what &optional with-case sorting-type getkey-func compare-func)
1752 "Sort TABLE of WHAT according to SORTING-TYPE.
1753 The user will be prompted for the SORTING-TYPE if the call to this
1754 function does not specify it.
1755 WHAT is only for the prompt, to indicate what is being sorted.
1756 The sorting key will be extracted from the car of the elements of
1757 the table. If WITH-CASE is non-nil, the sorting will be case-sensitive.
1759 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1760 a function to be called to extract the key. It must return either
1761 a string or a number that should serve as the sorting key for that
1762 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1763 is specified interactively, the comparison will be either a string or
1764 numeric compare based on the type of the first key in the table."
1767 "Sort %s: [a]lphabetic, [n]umeric, [t]ime, [f]unc. A/N/T/F means reversed:"
1768 what)
1771 ;; Define the appropriate functions
1794 "Sort using function: "
1799 tempfun))
1810 table)
1813 ;;;###autoload
1815 "Copy region in table to the clipboard and blank all relevant fields.
1816 If there is no active region, use just the field at point."
1822 ;;;###autoload
1824 "Copy rectangular region in table to clipboard.
1825 A special clipboard is used which can only be accessed
1826 with `org-table-paste-rectangle'."
1830 current-prefix-arg))
1832 region cols
1858 org-table-clip))
1860 ;;;###autoload
1862 "Paste a rectangular region into a table.
1863 The upper right corner ends up in the current field. All involved fields
1864 will be overwritten. If the rectangle does not fit into the present table,
1865 the table is enlarged as needed. The process ignores horizontal separator
1866 lines."
1876 c cols field)
1891 ;;;###autoload
1893 "Convert from `org-mode' table to table.el and back.
1894 Obviously, this only works within limits. When an Org-mode table is
1895 converted to table.el, all horizontal separator lines get lost, because
1896 table.el uses these as cell boundaries and has no notion of horizontal lines.
1897 A table.el table can be converted to an Org-mode table only if it does not
1898 do row or column spanning. Multiline cells will become multiple cells.
1899 Beware, Org-mode does not test if the table can be successfully converted - it
1900 blindly applies a recipe that works for simple tables."
1904 ;; convert to Org-mode table
1913 ;; convert to table.el table
1916 ;; first, get rid of all horizontal lines
1920 ;; insert a hline before first
1924 ;; insert a hline after each line
1929 ;; replace "+" at beginning and ending of hlines
1938 "Transpose Org table at point and eliminate hlines.
1939 So a table like
1941 | 1 | 2 | 4 | 5 |
1942 |---+---+---+---|
1943 | a | b | c | d |
1944 | e | f | g | h |
1946 will be transposed as
1948 | 1 | a | e |
1949 | 2 | b | f |
1950 | 4 | c | g |
1951 | 5 | d | h |
1953 Note that horizontal lines disappear."
1965 table)))
1979 ;;;###autoload
1981 "Wrap several fields in a column like a paragraph.
1982 This is useful if you'd like to spread the contents of a field over several
1983 lines, in order to keep the table compact.
1985 If there is an active region, and both point and mark are in the same column,
1986 the text in the column is wrapped to minimum width for the given number of
1987 lines. Generally, this makes the table more compact. A prefix ARG may be
1989 formats the selected text to two lines. If the region was longer than two
1990 lines, the remaining lines remain empty. A negative prefix argument reduces
1991 the current number of lines by that amount. The wrapped text is pasted back
1992 into the table. If you formatted it to more lines than it was before, fields
1993 further down in the table get overwritten - so you might need to make space in
1994 the table first.
1996 If there is no region, the current field is split at the cursor position and
1997 the text fragment to the right of the cursor is prepended to the field one
1998 line down.
2000 If there is no region, but you specify a prefix ARG, the current field gets
2001 blank, and the content is appended to the field above."
2005 ;; There is a region: fill as a paragraph
2009 nlines)
2016 arg)
2020 nil nlines)))
2024 ;; No region, split the current field at point
2028 ;; combine with field above
2038 ;; split field
2050 ;;;###autoload
2052 "Edit table field in a different window.
2053 This is mainly useful for fields that contain hidden parts.
2055 it can be edited in place."
2064 display t intangible t))
2077 p)
2093 intangible t))
2101 "Finish editing a table data field.
2102 Remove all newline characters, insert the result into the table, realign
2103 the table and kill the editing buffer."
2107 text)
2124 "Minor mode to make the table field editor window follow the cursor.
2125 When this mode is active, the field editor window will always show the
2126 current field. The mode exits automatically when the cursor leaves the
2127 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2128 nil " TblFollow" nil
2144 ;; We have left the table, exit the follow mode
2154 ;;;###autoload
2156 "Sum numbers in region of current table column.
2157 The result will be displayed in the echo area, and will be available
2160 If there is an active region, it is interpreted as a rectangle and all
2161 numbers in that rectangle will be summed. If there is no active
2162 region and point is located in a table column, sum all numbers in that
2163 column.
2165 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2166 numbers are assumed to be times as well (in decimal hours) and the
2167 numbers are added as such.
2169 If NLAST is a number, only the NLAST fields will actually be summed."
2196 items1)))
2203 s diff)
2211 sres))))
2234 "Return the formula active for the current field.
2235 Assumes that specials are in place.
2236 If KEY is given, return the key to this formula.
2240 org-table-named-field-locations)))
2254 "Read a formula from the minibuffer, offer stored formula as default.
2255 When NAMED is non-nil, look for a named equation."
2259 org-table-named-field-locations)))
2266 name
2267 ref)
2277 stored)
2279 equation)
2286 scol))
2288 'org-table-formula-history
2289 )))))
2290 mustsave)
2292 ;; remove formula
2299 ;; We set the column equation, delete the named one.
2301 mustsave t))
2307 eq))
2310 "Store the list of formulas below the current table."
2317 ;; don't overwrite TBLFM, we might use text properties to store stuff
2333 ;; Fake a high number to make sure this is sorted at the end.
2340 a)
2350 "Compare two formulas for sorting."
2355 ;;;###autoload
2357 "Return an alist with the stored formulas directly after current table."
2366 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2385 "Modify the equations after the table structure has been edited.
2387 For all numbers larger than LIMIT, shift them by DELTA."
2399 s n a)
2405 "Change makes TBLFM term %s invalid, use undo to recover"
2421 "Get the column names and local parameters for this table."
2424 names name fields fields1 field cnt
2425 c v l line col types dlines hlines last-dline)
2427 org-table-local-parameters nil
2428 org-table-named-field-locations nil
2429 org-table-current-begin-line nil
2430 org-table-current-begin-pos nil
2431 org-table-current-line-types nil
2450 org-table-local-parameters))))
2466 ;; Analyse the line types
2470 l org-table-current-begin-line)
2487 al al2)
2497 ;;;###autoload
2500 If yes, store the formula and apply it."
2501 ;; We already know we are in a table. Get field will only return a formula
2502 ;; when appropriate. It might return a separator line, but no problem.
2505 named eq)
2516 "List of commands triggering the recalculation of a line.
2528 ;;;###autoload
2530 "Rotate the recalculation mark in the first column.
2531 If in any row, the first field is not consistent with a mark,
2532 insert a new column for the markers.
2533 When there is an active region, change all the lines in the region,
2534 after prompting for the marking character.
2535 After each change, a message will be displayed indicating the meaning
2536 of the new mark."
2551 epos new)
2558 newchar))
2590 ;;;###autoload
2592 "Recompute the current line if marked for it, and if we haven't just done it."
2612 org-tbl-calc-modes)
2614 ;;;###autoload
2616 suppress-align suppress-const
2617 suppress-store suppress-analysis)
2618 "Replace the table field value at the cursor by the result of a calculation.
2620 This function makes use of Dave Gillespie's Calc package, in my view the
2621 most exciting program ever written for GNU Emacs. So you need to have Calc
2622 installed in order to use this function.
2624 In a table, this command replaces the value in the current field with the
2626 formula, by storing it in a special line below the table. When called
2627 with a `C-u' prefix, the current field must be a named field, and the
2628 formula is installed as valid in only this specific field.
2630 When called with two `C-u' prefixes, insert the active equation
2631 for the field back into the current field, so that it can be
2633 to check the referenced fields.
2635 When called, the command first prompts for a formula, which is read in
2636 the minibuffer. Previously entered formulas are available through the
2637 history list, and the last used formula is offered as a default.
2638 These stored formulas are adapted correctly when moving, inserting, or
2639 deleting columns with the corresponding commands.
2641 The formula can be any algebraic expression understood by the Calc package.
2642 For details, see the Org-mode manual.
2644 This function can also be called from Lisp programs and offers
2645 additional arguments: EQUATION can be the formula to apply. If this
2646 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2647 used to speed-up recursive calls by by-passing unnecessary aligns.
2648 SUPPRESS-CONST suppresses the interpretation of constants in the
2649 formula, assuming that this has been done already outside the function.
2650 SUPPRESS-STORE means the formula should not be stored, either because
2651 it is already stored, or because it is a modified equation that should
2652 not overwrite the stored one."
2668 equation
2674 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2675 duration duration-output-format)
2676 ;; Parse the format string. Since we have a lot of modes, this is
2677 ;; a lot of work. However, I think calc still uses most of the time.
2690 'calc-float-format
2693 n))))
2697 duration-output-format nil
2701 duration-output-format org-table-duration-custom-format
2702 numbers t
2725 ;; replace fields with duration values if relevant
2729 fields)))
2735 x))
2736 fields)))
2742 ;; Insert row and column number of formula result field
2753 t t form)))
2755 ;; Check for old vertical references
2757 ;; Insert remote references
2770 rmtrng))
2771 keep-empty numbers lispp))
2772 t t form)))
2773 ;; Insert complex ranges
2781 ;; possibly handle durations
2786 formrg)
2787 keep-empty numbers lispp)))
2792 ;; Insert simple ranges, i.e. included in the current row.
2795 form)
2805 keep-empty numbers lispp))
2806 t t form)))
2808 ;; Insert the references to fields in same row
2815 x keep-empty numbers lispp)))
2833 ;; Use <...> time-stamps so that Calc can handle them
2836 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2847 form
2854 duration-output-format)
2855 ev)))
2860 Orig: %s
2861 $xyz-> %s
2862 @r$c-> %s
2894 prop value)))
2897 "Get a calc vector from a column, according to descriptor DESC.
2898 Optional arguments TBEG and COL can give the beginning of the table and
2899 the current column, to avoid unnecessary parsing.
2901 HIGHLIGHT means just highlight the range.
2903 When CORNERS-ONLY is set, only return the corners of the range as
2904 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2905 in the buffer and column1 and column2 are table column numbers."
2912 beg end c1 c2 r1 r2 rangep tmp)
2929 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2936 ;; just one field
2943 ;; A range, return a vector
2944 ;; First sort the numbers to get a regular rectangle
2948 ;; Only return the corners of the range
2950 ;; Copy the range values into a list
2964 ;; return string representation of calc vector
2969 "Analyze descriptor DESC and retrieve the corresponding line number.
2970 The cursor is currently in line CLINE, the table begins in line BLINE,
2971 and TABLE is a vector with line types."
2979 ;; 1 2 3 4 5 6
2999 nil hn cline desc)))
3002 rel on cline desc)))
3006 "FIXME: Needs more documentation."
3019 nil))
3020 t)))
3024 desc cline))
3025 ;; The last hline doesn't exist. Instead, point to last row
3026 ;; in table.
3035 "Convert list ELEMENTS to something appropriate to insert into formula.
3036 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3037 NUMBERS indicates that everything should be converted to numbers.
3038 LISPP non-nil means to return something appropriate for a Lisp
3039 list, 'literal is for the format specifier L."
3040 ;; Calc nan (not a number) is used for the conversion of the empty
3041 ;; field to a reference for several reasons: (i) It is accepted in a
3042 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3043 ;; (ii) In a single field (not in range) it can be distinguished
3044 ;; from "(nan)" which is the reference made from a single field
3045 ;; containing "nan".
3047 ;; field reference
3050 elements
3052 ""
3061 ;; range reference
3066 elements))))
3072 x
3080 x)
3082 elements
3086 "If there has been more than one second since T1, display message.
3087 ARGS are passed as arguments to the `message' function. Returns
3088 current time if a message is printed, otherwise returns T1. If
3089 T1 is nil, always messages."
3093 curtime)
3094 t1)))
3096 ;;;###autoload
3098 "Recalculate the current table line by applying all stored formulas.
3099 With prefix arg ALL, do this for all lines in the table.
3100 With the prefix argument ALL is `(16)' \
3102 it is the symbol `iterate', recompute the table until it no longer changes.
3103 If NOALIGN is not nil, do not re-align the table after the computations
3104 are done. This is typically used internally to save time, if it is
3105 known that the table will be realigned a little later anyway."
3122 seen-fields lhs1
3124 ;; Insert constants in all formulas
3144 eqlist))
3145 ;; Split the equation list
3151 ;; Expand ranges in lhs of formulas
3154 ;; Get the correct line range to process
3160 ;; This is a table with marked lines, compute selected lines
3162 ;; Move forward to the first non-header line
3172 ;; First find the named fields, and mark them untouchable.
3173 ;; Also check if several field/range formulas try to set the same field.
3192 name)))
3205 ;; Now evaluate the column formulas, but skip fields covered
3206 ;; by field formulas
3210 ;; Unprotected line, recalculate
3214 log-last-time
3226 ;; Now evaluate the field formulas
3246 t))
3261 log-first-time
3265 ;; back to initial position
3274 ;;;###autoload
3276 "Recalculate the table until it does not change anymore.
3277 The maximum number of iterations is 10, but you can choose a different value
3278 with the prefix ARG."
3283 thistbl)
3297 ;;;###autoload
3299 "Recalculate all tables in the current buffer."
3306 ;;;###autoload
3308 "Iterate all tables in the buffer, to converge inter-table dependencies."
3313 c1)
3329 "Apply the #+TBLFM in the line at point to the table."
3336 ;; Insert a temporary formula at right after the table
3341 ;; Recalculate the table.
3346 ;; Delete the formula inserted temporarily.
3352 "Find the beginning of the TBLFM lines and return its position.
3353 Return nil when the beginning of TBLFM line was not found."
3360 "Expand list of formulas.
3361 If some of the RHS in the formulas are ranges or a row reference, expand
3362 them to individual field equations for each field."
3368 ;; This just refers to one fixed field
3371 ;; This just refers to one fixed named field
3393 "Replace @<, @>, $<, $> with first/last row/column of the table.
3394 So @< and $< will always be replaced with @1 and $1, respectively.
3395 The advantage of these special markers are that structure editing of
3396 the table will not change them, while @1 and $1 will be modified
3397 when a line/row is swapped out of that privileged position. So for
3398 formulas that use a range of rows or columns, it may often be better
3400 borders of the table using the @< @> $< $> makers."
3403 s start)
3408 org-table-current-ncol)
3412 len
3419 s)
3422 "Replace $const with values in string F."
3427 org-table-column-name-regexp
3430 org-table-column-names))))
3431 f t t)))
3432 ;; Parameters and constants.
3436 new start))
3439 ;; When a duration is expected, convert value on the fly.
3445 v)))))
3452 "Find the value for a parameter or constant in a formula.
3453 Parameters get priority."
3484 map))
3491 "--"
3494 "--"
3495 "Shift Reference at Point"
3500 "-"
3501 "Change Test Row for Column Formulas"
3504 "--"
3509 org-table-overlay-coordinates)]
3510 "--"
3516 ;;;###autoload
3518 "Edit the formulas of the current table in a separate buffer."
3520 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3534 entry s type title)
3537 ;; Keep global-font-lock-mode from turning on font-lock-mode
3578 "Convert a formula from internal to user representation."
3581 s))
3584 "Convert a formula from user to internal representation."
3587 s))
3590 "Convert spreadsheet references from A7 to @7$28.
3591 Works for single references, but also for entire formulas and even the
3592 full TBLFM line."
3594 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3597 ;; format match, just advance
3602 ;; 3.e5 or something like this.
3605 ;; (member (match-string 1 s)
3606 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3607 )
3608 ;; function name, just advance
3618 t t s)))))
3619 s))
3622 "Convert spreadsheet references from to @7$28 to AB7.
3623 Works for single references, but also for entire formulas and even the
3624 full TBLFM line."
3631 t t s)))
3636 t nil s)))
3637 s)
3640 "Convert a base 26 number represented by letters into an integer.
3641 For example: AB -> 28."
3647 n))
3650 "Convert an integer into a base 26 number represented by letters.
3651 For example: 28 -> AB."
3656 s))
3659 "Convert a time string into numerical duration in seconds.
3660 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3661 If S is a string representing a number, keep this number."
3663 s
3686 "Convert a number of seconds to a time string.
3687 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3688 minutes or seconds."
3703 "Convert all references in this buffer, using FUNCTION."
3713 "Convert all references in the buffer from B3 to @3$2 and back."
3723 "Shift the reference at point one row/hline up."
3727 "Shift the reference at point one row/hline down."
3731 "Shift the reference at point one field to the left."
3735 "Shift the reference at point one field to the right."
3746 ;; A B3-like reference
3752 ;; An internal reference
3758 "Re-match the group N, and replace it with the shifted reference."
3763 t t)))
3766 "Shift a reference part REF.
3767 If DECR is set, decrease the references row/column, else increase.
3768 If HLINE is set, this may be a hline reference, it certainly is not
3769 a translation reference."
3798 "Toggle the display of coordinates in the referenced table."
3807 "Parse the buffer for formula definitions and install them.
3808 With prefix ARG, apply the new formulas to the table."
3818 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3819 nil t)
3843 "Abort editing formulas, without installing the changes."
3854 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3895 "Show the location/value of the $ expression at point."
3904 var name e what match dest)
3909 "$1.."
3992 ;; column number
4020 org-table-fedit-scroll-down))))
4032 "Make sure the cursor is in a dataline in a table."
4041 p1 p2)))
4046 "Move cursor one line up in the window showing the table."
4051 "Move cursor one line down in the window showing the table."
4056 "Move the cursor in the window showing the table.
4057 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4082 "Add a new overlay."
4088 "Highlight rectangular region in a table."
4092 l1 c1 l2 c2 tmp)
4116 "Remove the rectangle overlays."
4127 "Add overlays to the table at point, to show row/column coordinates."
4155 ;;;###autoload
4157 "Toggle the display of Row/Column numbers in tables."
4168 ;;;###autoload
4170 "Toggle the formula debugger in tables."
4176 ;;; The orgtbl minor mode
4178 ;; Define a minor mode which can be used in other modes in order to
4179 ;; integrate the org-mode table editor.
4181 ;; This is really a hack, because the org-mode table editor uses several
4182 ;; keys which normally belong to the major mode, for example the TAB and
4183 ;; RET keys. Here is how it works: The minor mode defines all the keys
4184 ;; necessary to operate the table editor, but wraps the commands into a
4185 ;; function which tests if the cursor is currently inside a table. If that
4186 ;; is the case, the table editor command is executed. However, when any of
4187 ;; those keys is used outside a table, the function uses `key-binding' to
4188 ;; look up if the key has an associated command in another currently active
4189 ;; keymap (minor modes, major mode, global), and executes that command.
4190 ;; There might be problems if any of the keys used by the table editor is
4191 ;; otherwise used as a prefix key.
4193 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4194 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4195 ;; addresses this by checking explicitly for both bindings.
4197 ;; The optimized version (see variable `orgtbl-optimized') takes over
4198 ;; all keys which are bound to `self-insert-command' in the *global map*.
4199 ;; Some modes bind other commands to simple characters, for example
4200 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4201 ;; active, this binding is ignored inside tables and replaced with a
4202 ;; modified self-insert.
4220 ;; Install it as a minor mode.
4224 ;;;###autoload
4226 "The `org-mode' table editor as a minor mode for use in other modes."
4231 ;; Exit without error, in case some hook functions calls this
4232 ;; by accident in org-mode.
4236 ;; Make sure we are first in minor-mode-map-alist
4238 ;; FIXME: maybe it should use emulation-mode-map-alists?
4245 auto-fill-inhibit-regexp)
4249 auto-fill-inhibit-regexp)
4250 orgtbl-line-start-regexp))
4268 "Remove all properties related to narrow-column invisibility."
4281 "Create a function for binding in the table minor mode.
4282 FUN is the command to call inside a table. N is used to create a unique
4283 command name. KEYS are keys that should be checked in for a command
4284 to execute outside of tables."
4290 "Outside of tables, run the binding of `"
4302 keys)
4306 "Error when there is no default binding for a table key."
4311 "Setup orgtbl keymaps."
4342 elt key fun cmd)
4350 ;; Special treatment needed for TAB and RET
4370 [(tab)] "\C-i")))
4372 (org-defkey orgtbl-mode-map [backtab]
4374 [backtab] [S-iso-lefttab] [(shift tab)]
4375 [(tab)] "\C-i"))
4377 (org-defkey orgtbl-mode-map "\M-\C-m"
4378 (orgtbl-make-binding 'org-table-wrap-region 105
4379 "\M-\C-m" [(meta return)]))
4380 (org-defkey orgtbl-mode-map [(meta return)]
4381 (orgtbl-make-binding 'org-table-wrap-region 106
4382 [(meta return)] "\M-\C-m"))
4384 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4385 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4387 (when orgtbl-optimized
4388 ;; If the user wants maximum table support, we need to hijack
4389 ;; some standard editing functions
4390 (org-remap orgtbl-mode-map
4391 'self-insert-command 'orgtbl-self-insert-command
4392 'delete-char 'org-delete-char
4393 'delete-backward-char 'org-delete-backward-char)
4394 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4395 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4396 '("OrgTbl"
4397 ["Create or convert" org-table-create-or-convert-from-region
4398 :active (not (org-at-table-p)) :keys "C-c |" ]
4399 "--"
4400 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4401 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4402 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4403 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4404 "--"
4405 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4406 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4407 ["Copy Field from Above"
4408 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4409 "--"
4410 ("Column"
4411 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4412 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4413 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4414 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4415 ("Row"
4416 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4417 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4418 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4419 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4420 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4421 "--"
4422 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4423 ("Rectangle"
4424 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4425 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4426 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4427 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4428 "--"
4429 ("Radio tables"
4430 ["Insert table template" orgtbl-insert-radio-table
4431 (assq major-mode orgtbl-radio-table-templates)]
4432 ["Comment/uncomment table" orgtbl-toggle-comment t])
4433 "--"
4434 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4435 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4436 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4437 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4438 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4439 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4440 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4441 ["Sum Column/Rectangle" org-table-sum
4442 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4443 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4444 ["Debug Formulas"
4445 org-table-toggle-formula-debugger :active (org-at-table-p)
4446 :keys "C-c {"
4447 :style toggle :selected org-table-formula-debug]
4448 ["Show Col/Row Numbers"
4449 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4450 :keys "C-c }"
4451 :style toggle :selected org-table-overlay-coordinates]
4452 "--"
4453 ("Plot"
4456 t))
4458 (defun orgtbl-ctrl-c-ctrl-c (arg)
4459 "If the cursor is inside a table, realign the table.
4460 If it is a table to be sent away to a receiver, do it.
4461 With prefix arg, also recompute table."
4462 (interactive "P")
4463 (let ((case-fold-search t) (pos (point)) action)
4464 (save-excursion
4465 (beginning-of-line 1)
4466 (setq action (cond
4470 (cond
4471 ((integerp action)
4472 (goto-char action)
4473 (org-table-maybe-eval-formula)
4474 (if arg
4475 (call-interactively 'org-table-recalculate)
4476 (org-table-maybe-recalculate-line))
4477 (call-interactively 'org-table-align)
4478 (when (orgtbl-send-table 'maybe)
4479 (run-hooks 'orgtbl-after-send-table-hook)))
4480 ((eq action 'recalc)
4481 (save-excursion
4482 (beginning-of-line 1)
4484 (if (org-at-table-p)
4485 (org-call-with-arg 'org-table-recalculate t))))
4486 (t (let (orgtbl-mode)
4487 (call-interactively (key-binding "\C-c\C-c")))))))
4489 (defun orgtbl-create-or-convert-from-region (arg)
4490 "Create table or convert region to table, if no conflicting binding.
4491 This installs the table binding `C-c |', but only if there is no
4492 conflicting binding to this key outside orgtbl-mode."
4493 (interactive "P")
4494 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4495 (if cmd
4496 (call-interactively cmd)
4497 (call-interactively 'org-table-create-or-convert-from-region))))
4499 (defun orgtbl-tab (arg)
4500 "Justification and field motion for `orgtbl-mode'."
4501 (interactive "P")
4502 (if arg (org-table-edit-field t)
4503 (org-table-justify-field-maybe)
4504 (org-table-next-field)))
4506 (defun orgtbl-ret ()
4507 "Justification and field motion for `orgtbl-mode'."
4508 (interactive)
4509 (if (bobp)
4510 (newline)
4511 (org-table-justify-field-maybe)
4512 (org-table-next-row)))
4514 (defun orgtbl-self-insert-command (N)
4515 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4516 If the cursor is in a table looking at whitespace, the whitespace is
4517 overwritten, and the table is not marked as requiring realignment."
4518 (interactive "p")
4519 (if (and (org-at-table-p)
4520 (or
4521 (and org-table-auto-blank-field
4522 (member last-command
4523 '(orgtbl-hijacker-command-100
4524 orgtbl-hijacker-command-101
4525 orgtbl-hijacker-command-102
4526 orgtbl-hijacker-command-103
4527 orgtbl-hijacker-command-104
4528 orgtbl-hijacker-command-105
4529 yas/expand))
4530 (org-table-blank-field))
4531 t)
4532 (eq N 1)
4534 (let (org-table-may-need-update)
4535 (goto-char (1- (match-end 0)))
4536 (org-delete-backward-char 1)
4537 (goto-char (match-beginning 0))
4538 (self-insert-command N))
4539 (setq org-table-may-need-update t)
4540 (let* (orgtbl-mode
4541 a
4542 (cmd (or (key-binding
4543 (or (and (listp function-key-map)
4544 (setq a (assoc last-input-event function-key-map))
4545 (cdr a))
4546 (vector last-input-event)))
4547 'self-insert-command)))
4548 (call-interactively cmd)
4549 (if (and org-self-insert-cluster-for-undo
4550 (eq cmd 'self-insert-command))
4551 (if (not (eq last-command 'orgtbl-self-insert-command))
4552 (setq org-self-insert-command-undo-counter 1)
4553 (if (>= org-self-insert-command-undo-counter 20)
4554 (setq org-self-insert-command-undo-counter 1)
4555 (and (> org-self-insert-command-undo-counter 0)
4556 buffer-undo-list
4557 (not (cadr buffer-undo-list)) ; remove nil entry
4558 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4559 (setq org-self-insert-command-undo-counter
4560 (1+ org-self-insert-command-undo-counter))))))))
4563 "Regular expression matching exponentials as produced by calc.")
4565 (defun orgtbl-gather-send-defs ()
4566 "Gather a plist of :name, :transform, :params for each destination before
4567 a radio table."
4568 (save-excursion
4569 (goto-char (org-table-begin))
4570 (let (rtn)
4571 (beginning-of-line 0)
4572 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4573 (let ((name (org-no-properties (match-string 1)))
4574 (transform (intern (match-string 2)))
4575 (params (if (match-end 3)
4576 (read (concat "(" (match-string 3) ")")))))
4577 (push (list :name name :transform transform :params params)
4578 rtn)
4579 (beginning-of-line 0)))
4580 rtn)))
4582 (defun orgtbl-send-replace-tbl (name txt)
4583 "Find and replace table NAME with TXT."
4584 (save-excursion
4585 (goto-char (point-min))
4586 (unless (re-search-forward
4588 (user-error "Don't know where to insert translated table"))
4589 (let ((beg (line-beginning-position 2)))
4590 (unless (re-search-forward
4591 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4592 (user-error "Cannot find end of insertion region"))
4593 (beginning-of-line)
4594 (delete-region beg (point)))
4597 ;;;###autoload
4598 (defun org-table-to-lisp (&optional txt)
4599 "Convert the table at point to a Lisp structure.
4600 The structure will be a list. Each item is either the symbol `hline'
4601 for a horizontal separator line, or a list of field values as strings.
4602 The table is taken from the parameter TXT, or from the buffer at point."
4603 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4604 (let ((txt (or txt
4605 (buffer-substring-no-properties (org-table-begin)
4606 (org-table-end)))))
4607 (mapcar (lambda (x)
4608 (if (string-match org-table-hline-regexp x) 'hline
4612 (defun orgtbl-send-table (&optional maybe)
4613 "Send a transformed version of table at point to the receiver position.
4614 With argument MAYBE, fail quietly if no transformation is defined
4615 for this table."
4616 (interactive)
4617 (catch 'exit
4618 (unless (org-at-table-p) (user-error "Not at a table"))
4619 ;; when non-interactive, we assume align has just happened.
4620 (when (org-called-interactively-p 'any) (org-table-align))
4621 (let ((dests (orgtbl-gather-send-defs))
4622 (table (org-table-to-lisp
4623 (buffer-substring-no-properties (org-table-begin)
4624 (org-table-end))))
4625 (ntbl 0))
4626 (unless dests
4627 (if maybe (throw 'exit nil)
4628 (user-error "Don't know how to transform this table")))
4629 (dolist (dest dests)
4630 (let ((name (plist-get dest :name))
4631 (transform (plist-get dest :transform))
4632 (params (plist-get dest :params)))
4633 (unless (fboundp transform)
4634 (user-error "No such transformation function %s" transform))
4635 (orgtbl-send-replace-tbl name (funcall transform table params)))
4636 (incf ntbl))
4637 (message "Table converted and installed at %d receiver location%s"
4638 ntbl (if (> ntbl 1) "s" ""))
4639 (and (> ntbl 0) ntbl))))
4641 (defun org-remove-by-index (list indices &optional i0)
4642 "Remove the elements in LIST with indices in INDICES.
4643 First element has index 0, or I0 if given."
4644 (if (not indices)
4645 list
4646 (if (integerp indices) (setq indices (list indices)))
4647 (setq i0 (1- (or i0 0)))
4648 (delq :rm (mapcar (lambda (x)
4649 (setq i0 (1+ i0))
4650 (if (memq i0 indices) :rm x))
4651 list))))
4653 (defun orgtbl-toggle-comment ()
4654 "Comment or uncomment the orgtbl at point."
4655 (interactive)
4656 (let* ((case-fold-search t)
4657 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4658 (re2 (concat "^" orgtbl-line-start-regexp))
4659 (commented (save-excursion (beginning-of-line 1)
4660 (cond ((looking-at re1) t)
4661 ((looking-at re2) nil)
4662 (t (user-error "Not at an org table")))))
4663 (re (if commented re1 re2))
4664 beg end)
4665 (save-excursion
4666 (beginning-of-line 1)
4667 (while (looking-at re) (beginning-of-line 0))
4668 (beginning-of-line 2)
4669 (setq beg (point))
4670 (while (looking-at re) (beginning-of-line 2))
4671 (setq end (point)))
4672 (comment-region beg end (if commented '(4) nil))))
4674 (defun orgtbl-insert-radio-table ()
4675 "Insert a radio table template appropriate for this major mode."
4676 (interactive)
4677 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4678 (txt (nth 1 e))
4679 name pos)
4680 (unless e (user-error "No radio table setup defined for %s" major-mode))
4681 (setq name (read-string "Table name: "))
4682 (while (string-match "%n" txt)
4683 (setq txt (replace-match name t t txt)))
4685 (setq pos (point))
4686 (insert txt)
4687 (goto-char pos)))
4689 ;;;###autoload
4690 (defun orgtbl-to-generic (table params)
4691 "Convert the orgtbl-mode TABLE to some other format.
4693 This generic routine can be used for many standard cases.
4695 TABLE is a list, each entry either the symbol `hline' for
4696 a horizontal separator line, or a list of fields for that
4697 line. PARAMS is a property list of parameters that can
4698 influence the conversion.
4700 Valid parameters are:
4702 :backend, :raw
4704 Export back-end used as a basis to transcode elements of the
4705 table, when no specific parameter applies to it. It is also
4706 used to translate cells contents. You can prevent this by
4707 setting :raw property to a non-nil value.
4709 :splice
4711 When non-nil, only convert rows, not the table itself. This is
4712 equivalent to setting to the empty string both :tstart
4713 and :tend, which see.
4715 :skip
4717 When set to an integer N, skip the first N lines of the table.
4718 Horizontal separation lines do count for this parameter!
4720 :skipcols
4722 List of columns that should be skipped. If the table has
4723 a column with calculation marks, that column is automatically
4724 discarded beforehand.
4726 :hline
4728 String to be inserted on horizontal separation lines. May be
4729 nil to ignore these lines altogether.
4731 :sep
4733 Separator between two fields, as a string.
4735 Each in the following group may be either a string or a function
4736 of no arguments returning a string:
4738 :tstart, :tend
4740 Strings to start and end the table. Ignored when :splice is t.
4742 :lstart, :lend
4744 Strings to start and end a new table line.
4746 :llstart, :llend
4748 Strings to start and end the last table line. Default,
4749 respectively, to :lstart and :lend.
4751 Each in the following group may be a string or a function of one
4752 argument (either the cells in the current row, as a list of
4753 strings, or the current cell) returning a string:
4755 :lfmt
4757 Format string for an entire row, with enough %s to capture all
4758 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4760 :llfmt
4762 Format for the entire last line, defaults to :lfmt.
4764 :fmt
4766 A format to be used to wrap the field, should contain %s for
4767 the original field value. For example, to wrap everything in
4769 a property list with column numbers and format strings, or
4770 functions, e.g.,
4774 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4776 Same as above, specific for the header lines in the table.
4777 All lines before the first hline are treated as header. If
4778 any of these is not present, the data line value is used.
4780 This may be either a string or a function of two arguments:
4782 :efmt
4784 Use this format to print numbers with exponential. The format
4785 should have %s twice for inserting mantissa and exponent, for
4787 list with column numbers and format strings or functions.
4788 :fmt will still be applied after :efmt."
4789 (let ((backend (plist-get params :backend))
4790 ;; Disable user-defined export filters and hooks.
4791 (org-export-filters-alist nil)
4792 (org-export-before-parsing-hook nil)
4793 (org-export-before-processing-hook nil))
4794 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4795 (user-error "Unknown :backend value"))
4796 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4797 (org-trim
4798 (org-export-string-as
4799 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4800 (with-output-to-string
4801 (dolist (e table)
4803 ((consp e)
4804 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4806 ;; Build a custom back-end according to PARAMS. Before defining
4807 ;; a translator, check if there is anything to do. When there
4808 ;; isn't, let BACKEND handle the element.
4809 (org-export-create-backend
4810 :parent (or backend 'org)
4811 :filters
4812 '((:filter-parse-tree
4813 ;; Handle :skip parameter.
4814 (lambda (tree backend info)
4815 (let ((skip (plist-get info :skip)))
4816 (when skip
4817 (unless (wholenump skip) (user-error "Wrong :skip value"))
4818 (let ((n 0))
4819 (org-element-map tree 'table-row
4820 (lambda (row)
4821 (if (>= n skip) t
4822 (org-element-extract-element row)
4823 (incf n)
4824 nil))
4825 info t))
4826 tree)))
4827 ;; Handle :skipcols parameter.
4828 (lambda (tree backend info)
4829 (let ((skipcols (plist-get info :skipcols)))
4830 (when skipcols
4831 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4832 (org-element-map tree 'table
4833 (lambda (table)
4834 (let ((specialp
4835 (org-export-table-has-special-column-p table)))
4836 (dolist (row (org-element-contents table))
4837 (when (eq (org-element-property :type row) 'standard)
4838 (let ((c 1))
4839 (dolist (cell (nthcdr (if specialp 1 0)
4840 (org-element-contents row)))
4841 (when (memq c skipcols)
4842 (org-element-extract-element cell))
4843 (incf c)))))))
4844 info)
4845 tree)))))
4846 :transcoders
4847 `((table . ,(org-table--to-generic-table params))
4848 (table-row . ,(org-table--to-generic-row params))
4849 (table-cell . ,(org-table--to-generic-cell params))
4850 ;; Section. Return contents to avoid garbage around table.
4851 (section . (lambda (s c i) c))))
4852 'body-only (org-combine-plists params '(:with-tables t))))))
4854 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4855 (cond ((null value) nil)
4856 ((functionp value) `(funcall ',value ,@args))
4857 ((stringp value)
4858 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4859 (args `(format ,value ,@args))
4860 (t value)))
4861 ((and with-cons (consp value))
4862 `(let ((val (cadr (memq column ',value))))
4863 (cond ((null val) contents)
4864 ((stringp val) (format val ,@args))
4865 ((functionp val) (funcall val ,@args))
4866 (t (user-error "Wrong %s value" ,name)))))
4867 (t (user-error "Wrong %s value" name))))
4869 (defun org-table--to-generic-table (params)
4870 "Return custom table transcoder according to PARAMS.
4871 PARAMS is a plist. See `orgtbl-to-generic' for more
4872 information."
4873 (let ((backend (plist-get params :backend))
4874 (splice (plist-get params :splice))
4875 (tstart (plist-get params :tstart))
4876 (tend (plist-get params :tend)))
4877 `(lambda (table contents info)
4878 (concat
4879 ,(and tstart (not splice)
4881 ,(if (or (not backend) tstart tend splice) 'contents
4882 `(org-export-with-backend ',backend table contents info))
4883 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4885 (defun org-table--to-generic-row (params)
4886 "Return custom table row transcoder according to PARAMS.
4887 PARAMS is a plist. See `orgtbl-to-generic' for more
4888 information."
4889 (let* ((backend (plist-get params :backend))
4890 (lstart (plist-get params :lstart))
4891 (llstart (plist-get params :llstart))
4892 (hlstart (plist-get params :hlstart))
4893 (hllstart (plist-get params :hllstart))
4894 (lend (plist-get params :lend))
4895 (llend (plist-get params :llend))
4896 (hlend (plist-get params :hlend))
4897 (hllend (plist-get params :hllend))
4898 (lfmt (plist-get params :lfmt))
4899 (llfmt (plist-get params :llfmt))
4900 (hlfmt (plist-get params :hlfmt))
4901 (hllfmt (plist-get params :hllfmt)))
4902 `(lambda (row contents info)
4903 (if (eq (org-element-property :type row) 'rule)
4904 ,(cond
4905 ((plist-member params :hline)
4906 (org-table--generic-apply (plist-get params :hline) ":hline"))
4907 (backend `(org-export-with-backend ',backend row nil info)))
4908 (let ((headerp (org-export-table-row-in-header-p row info))
4909 (lastp (not (org-export-get-next-element row info)))
4910 (last-header-p (org-export-table-row-ends-header-p row info)))
4911 (when contents
4912 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4913 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4914 ;; `:lstart', `:lend' and their relatives.
4915 ,(let ((cells
4916 '(org-element-map row 'table-cell
4917 (lambda (cell)
4918 ;; Export all cells, without separators.
4919 ;;
4920 ;; Use `org-export-data-with-backend'
4921 ;; instead of `org-export-data' to eschew
4922 ;; cached values, which
4923 ;; ignore :orgtbl-ignore-sep parameter.
4924 (org-export-data-with-backend
4925 cell
4926 (plist-get info :back-end)
4927 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4928 info)))
4929 `(cond
4930 ,(and hllfmt
4931 `(last-header-p ,(org-table--generic-apply
4932 hllfmt ":hllfmt" nil cells)))
4933 ,(and hlfmt
4934 `(headerp ,(org-table--generic-apply
4935 hlfmt ":hlfmt" nil cells)))
4936 ,(and llfmt
4937 `(lastp ,(org-table--generic-apply
4938 llfmt ":llfmt" nil cells)))
4939 (t
4940 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4941 `(concat
4942 (cond
4943 ,(and
4944 (or hllstart hllend)
4945 `(last-header-p
4946 (concat
4947 ,(org-table--generic-apply hllstart ":hllstart")
4948 contents
4949 ,(org-table--generic-apply hllend ":hllend"))))
4950 ,(and
4951 (or hlstart hlend)
4952 `(headerp
4953 (concat
4954 ,(org-table--generic-apply hlstart ":hlstart")
4955 contents
4956 ,(org-table--generic-apply hlend ":hlend"))))
4957 ,(and
4958 (or llstart llend)
4959 `(lastp
4960 (concat
4961 ,(org-table--generic-apply llstart ":llstart")
4962 contents
4963 ,(org-table--generic-apply llend ":llend"))))
4964 (t
4965 ,(cond
4966 ((or lstart lend)
4967 `(concat
4968 ,(org-table--generic-apply lstart ":lstart")
4969 contents
4970 ,(org-table--generic-apply lend ":lend")))
4971 (backend
4972 `(org-export-with-backend
4973 ',backend row contents info))
4974 (t 'contents)))))))))))))))
4976 (defun org-table--to-generic-cell (params)
4977 "Return custom table cell transcoder according to PARAMS.
4978 PARAMS is a plist. See `orgtbl-to-generic' for more
4979 information."
4980 (let* ((backend (plist-get params :backend))
4981 (efmt (plist-get params :efmt))
4982 (fmt (plist-get params :fmt))
4983 (hfmt (plist-get params :hfmt))
4984 (sep (plist-get params :sep))
4985 (hsep (plist-get params :hsep)))
4986 `(lambda (cell contents info)
4987 (let ((headerp (org-export-table-row-in-header-p
4988 (org-export-get-parent-element cell) info))
4989 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4990 ;; Make sure that contents are exported as Org data when :raw
4991 ;; parameter is non-nil.
4992 ,(when (and backend (plist-get params :raw))
4993 `(setq contents
4994 ;; Since we don't know what are the pseudo object
4995 ;; types defined in backend, we cannot pass them to
4996 ;; `org-element-interpret-data'. As a consequence,
4997 ;; they will be treated as pseudo elements, and
4998 ;; will have newlines appended instead of spaces.
4999 ;; Therefore, we must make sure :post-blank value
5000 ;; is really turned into spaces.
5001 (replace-regexp-in-string
5003 (org-trim
5004 (org-element-interpret-data
5005 (org-element-contents cell))))))
5006 (when contents
5007 ;; Check if we can apply `:efmt' on CONTENTS.
5008 ,(when efmt
5009 `(when (string-match orgtbl-exp-regexp contents)
5010 (let ((mantissa (match-string 1 contents))
5011 (exponent (match-string 2 contents)))
5012 (setq contents ,(org-table--generic-apply
5013 efmt ":efmt" t 'mantissa 'exponent)))))
5014 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5015 (cond
5016 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5017 hfmt ":hfmt" t 'contents))))
5018 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5019 fmt ":fmt" t 'contents))))))
5020 ;; If a separator is provided, use it instead of BACKEND's.
5021 ;; Separators are ignored when LFMT (or equivalent) is
5022 ;; provided.
5023 ,(cond
5024 ((or hsep sep)
5025 `(if (or ,(and (not sep) '(not headerp))
5026 (plist-get info :orgtbl-ignore-sep)
5027 (not (org-export-get-next-element cell info)))
5028 ,(if (not backend) 'contents
5029 `(org-export-with-backend ',backend cell contents info))
5030 (concat contents
5031 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5032 (or hsep sep)))))
5033 (backend `(org-export-with-backend ',backend cell contents info))
5034 (t 'contents))))))
5036 ;;;###autoload
5037 (defun orgtbl-to-tsv (table params)
5038 "Convert the orgtbl-mode table to TAB separated material."
5041 ;;;###autoload
5042 (defun orgtbl-to-csv (table params)
5043 "Convert the orgtbl-mode table to CSV material.
5044 This does take care of the proper quoting of fields with comma or quotes."
5045 (orgtbl-to-generic table
5046 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5047 params)))
5049 ;;;###autoload
5050 (defun orgtbl-to-latex (table params)
5051 "Convert the orgtbl-mode TABLE to LaTeX.
5053 TABLE is a list, each entry either the symbol `hline' for
5054 a horizontal separator line, or a list of fields for that line.
5055 PARAMS is a property list of parameters that can influence the
5056 conversion. All parameters from `orgtbl-to-generic' are
5057 supported. It is also possible to use the following ones:
5059 :booktabs
5063 :environment
5065 Specify environment to use, as a string. If you use
5067 as a string, to get proper continuation strings."
5068 (require 'ox-latex)
5069 (orgtbl-to-generic
5070 table
5071 (org-combine-plists
5072 ;; Provide sane default values.
5073 (list :backend 'latex
5074 :latex-default-table-mode 'table
5075 :latex-tables-centered nil
5076 :latex-tables-booktabs (plist-get params :booktabs)
5077 :latex-table-scientific-notation nil
5078 :latex-default-table-environment
5079 (or (plist-get params :environment) "tabular"))
5080 params)))
5082 ;;;###autoload
5083 (defun orgtbl-to-html (table params)
5084 "Convert the orgtbl-mode TABLE to HTML.
5086 TABLE is a list, each entry either the symbol `hline' for
5087 a horizontal separator line, or a list of fields for that line.
5088 PARAMS is a property list of parameters that can influence the
5089 conversion. All parameters from `orgtbl-to-generic' are
5090 supported. It is also possible to use the following one:
5092 :attributes
5094 Attributes and values, as a plist, which will be used in
5095 <table> tag."
5096 (require 'ox-html)
5097 (orgtbl-to-generic
5098 table
5099 (org-combine-plists
5100 ;; Provide sane default values.
5101 (list :backend 'html
5102 :html-table-data-tags '("<td%s>" . "</td>")
5103 :html-table-use-header-tags-for-first-column nil
5104 :html-table-align-individual-fields t
5105 :html-table-row-tags '("<tr>" . "</tr>")
5106 :html-table-attributes
5107 (if (plist-member params :attributes)
5108 (plist-get params :attributes)
5109 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5110 :frame "hsides")))
5111 params)))
5113 ;;;###autoload
5114 (defun orgtbl-to-texinfo (table params)
5115 "Convert the orgtbl-mode TABLE to Texinfo.
5117 TABLE is a list, each entry either the symbol `hline' for
5118 a horizontal separator line, or a list of fields for that line.
5119 PARAMS is a property list of parameters that can influence the
5120 conversion. All parameters from `orgtbl-to-generic' are
5121 supported. It is also possible to use the following one:
5123 :columns
5125 Column widths, as a string. When providing column fractions,
5127 (require 'ox-texinfo)
5128 (let ((output
5129 (orgtbl-to-generic
5130 table
5131 (org-combine-plists
5132 (list :backend 'texinfo
5133 :texinfo-tables-verbatim nil
5134 :texinfo-table-scientific-notation nil)
5135 params)))
5136 (columns (let ((w (plist-get params :columns)))
5137 (cond ((not w) nil)
5139 (t (concat "@columnfractions " w))))))
5140 (if (not columns) output
5141 (replace-regexp-in-string
5144 ;;;###autoload
5145 (defun orgtbl-to-orgtbl (table params)
5146 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5148 TABLE is a list, each entry either the symbol `hline' for
5149 a horizontal separator line, or a list of fields for that line.
5150 PARAMS is a property list of parameters that can influence the
5151 conversion. All parameters from `orgtbl-to-generic' are
5152 supported.
5154 Useful when slicing one table into many. The :hline, :sep,
5155 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5156 be set to provide ORGTBL directives for the generated table."
5157 (require 'ox-org)
5158 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5160 (defun orgtbl-to-table.el (table params)
5161 "Convert the orgtbl-mode TABLE into a table.el table.
5162 TABLE is a list, each entry either the symbol `hline' for
5163 a horizontal separator line, or a list of fields for that line.
5164 PARAMS is a property list of parameters that can influence the
5165 conversion. All parameters from `orgtbl-to-generic' are
5166 supported."
5167 (with-temp-buffer
5168 (insert (orgtbl-to-orgtbl table params))
5169 (org-table-align)
5170 (replace-regexp-in-string
5171 "-|" "-+"
5172 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5174 (defun orgtbl-to-unicode (table params)
5175 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5177 TABLE is a list, each entry either the symbol `hline' for
5178 a horizontal separator line, or a list of fields for that line.
5179 PARAMS is a property list of parameters that can influence the
5180 conversion. All parameters from `orgtbl-to-generic' are
5181 supported. It is also possible to use the following ones:
5183 :ascii-art
5186 the table. You can download it here:
5187 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5189 :narrow
5191 When non-nil, narrow columns width than provided width cookie,
5193 (require 'ox-ascii)
5194 (orgtbl-to-generic
5195 table
5196 (org-combine-plists
5197 (list :backend 'ascii
5198 :ascii-charset 'utf-8
5199 :ascii-table-widen-columns (not (plist-get params :narrow))
5200 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5201 params)))
5203 ;; Put the cursor in a column containing numerical values
5204 ;; of an Org-Mode table,
5205 ;; type C-c " a
5206 ;; A new column is added with a bar plot.
5207 ;; When the table is refreshed (C-u C-c *),
5208 ;; the plot is updated to reflect the new values.
5210 (defun orgtbl-ascii-draw (value min max &optional width characters)
5211 "Draw an ascii bar in a table.
5212 VALUE is a the value to plot, the width of the bar to draw. A
5213 value equal to MIN will be displayed as empty (zero width bar).
5214 A value equal to MAX will draw a bar filling all the WIDTH.
5215 WIDTH is the expected width in characters of the column.
5216 CHARACTERS is a string that will compose the bar, with shades of
5217 grey from pure white to pure black. It defaults to a 10
5218 characters string of regular ascii characters."
5219 (let* ((characters (or characters " .:;c!lhVHW"))
5220 (width (or width 12))
5221 (value (if (numberp value) value (string-to-number value)))
5222 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5223 (cond
5224 ((< value 0) "too small")
5225 ((> value width) "too large")
5226 (t
5227 (let ((len (1- (length characters))))
5228 (concat
5229 (make-string (floor value) (elt characters len))
5230 (string (elt characters
5231 (floor (* (- value (floor value)) len))))))))))
5233 ;;;###autoload
5234 (defun orgtbl-ascii-plot (&optional ask)
5235 "Draw an ascii bar plot in a column.
5236 With cursor in a column containing numerical values, this
5237 function will draw a plot in a new column.
5238 ASK, if given, is a numeric prefix to override the default 12
5239 characters width of the plot. ASK may also be the
5241 (interactive "P")
5242 (let ((col (org-table-current-column))
5243 (min 1e999) ; 1e999 will be converted to infinity
5244 (max -1e999) ; which is the desired result
5245 (table (org-table-to-lisp))
5246 (length
5247 (cond ((consp ask)
5248 (read-number "Length of column " 12))
5249 ((numberp ask) ask)
5250 (t 12))))
5251 ;; Skip any hline a the top of table.
5252 (while (eq (car table) 'hline) (setq table (cdr table)))
5253 ;; Skip table header if any.
5254 (dolist (x (or (cdr (memq 'hline table)) table))
5255 (when (consp x)
5256 (setq x (nth (1- col) x))
5257 (when (string-match
5259 x)
5260 (setq x (string-to-number x))
5261 (when (> min x) (setq min x))
5262 (when (< max x) (setq max x)))))
5263 (org-table-insert-column)
5264 (org-table-move-column-right)
5265 (org-table-store-formulas
5266 (cons
5267 (cons
5268 (number-to-string (1+ col))
5269 (format "'(%s $%s %s %s %s)"
5270 "orgtbl-ascii-draw" col min max length))
5271 (org-table-get-stored-formulas)))
5272 (org-table-recalculate t)))
5274 ;; Example of extension: unicode characters
5275 ;; Here are two examples of different styles.
5277 ;; Unicode block characters are used to give a smooth effect.
5278 ;; See http://en.wikipedia.org/wiki/Block_Elements
5279 ;; Use one of those drawing functions
5280 ;; - orgtbl-ascii-draw (the default ascii)
5281 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5282 ;; - orgtbl-uc-draw-cont (smooth unicode)
5284 ;; This is best viewed with the "DejaVu Sans Mono" font
5285 ;; (use M-x set-default-font).
5287 (defun orgtbl-uc-draw-grid (value min max &optional width)
5288 "Draw a bar in a table using block unicode characters.
5289 It is a variant of orgtbl-ascii-draw with Unicode block
5290 characters, for a smooth display. Bars appear as grids (to the
5291 extent the font allows)."
5292 ;; http://en.wikipedia.org/wiki/Block_Elements
5293 ;; best viewed with the "DejaVu Sans Mono" font.
5294 (orgtbl-ascii-draw value min max width
5297 (defun orgtbl-uc-draw-cont (value min max &optional width)
5298 "Draw a bar in a table using block unicode characters.
5299 It is a variant of orgtbl-ascii-draw with Unicode block
5300 characters, for a smooth display. Bars are solid (to the extent
5301 the font allows)."
5302 (orgtbl-ascii-draw value min max width
5305 (defun org-table-get-remote-range (name-or-id form)
5306 "Get a field value or a list of values in a range from table at ID.
5308 NAME-OR-ID may be the name of a table in the current file as set
5310 will then be used. Alternatively, it may be an ID referring to
5311 any entry, also in a different file. In this case, the first
5312 table in that entry will be referenced.
5316 The return value is either a single string for a single field, or a
5317 list of the fields in the rectangle."
5318 (save-match-data
5319 (let ((case-fold-search t) (id-loc nil)
5320 ;; Protect a bunch of variables from being overwritten
5321 ;; by the context of the remote table
5322 org-table-column-names org-table-column-name-regexp
5323 org-table-local-parameters org-table-named-field-locations
5324 org-table-current-line-types org-table-current-begin-line
5325 org-table-current-begin-pos org-table-dlines
5326 org-table-current-ncol
5327 org-table-hlines org-table-last-alignment
5328 org-table-last-column-widths org-table-last-alignment
5329 org-table-last-column-widths tbeg
5330 buffer loc)
5331 (setq form (org-table-convert-refs-to-rc form))
5332 (save-excursion
5333 (save-restriction
5334 (widen)
5335 (save-excursion
5336 (goto-char (point-min))
5337 (if (re-search-forward
5340 nil t)
5341 (setq buffer (current-buffer) loc (match-beginning 0))
5342 (setq id-loc (org-id-find name-or-id 'marker))
5343 (unless (and id-loc (markerp id-loc))
5345 (setq buffer (marker-buffer id-loc)
5346 loc (marker-position id-loc))
5347 (move-marker id-loc nil)))
5348 (with-current-buffer buffer
5349 (save-excursion
5350 (save-restriction
5351 (widen)
5352 (goto-char loc)
5353 (forward-char 1)
5355 (not (match-beginning 1)))
5356 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5357 (setq tbeg (point-at-bol))
5358 (org-table-get-specials)
5359 (setq form (org-table-formula-substitute-names
5360 (org-table-formula-handle-first/last-rc form)))
5361 (if (and (string-match org-table-range-regexp form)
5362 (> (length (match-string 0 form)) 1))
5363 (save-match-data
5364 (org-table-get-range (match-string 0 form) tbeg 1))
5365 form)))))))))
5367 (defun org-table-remote-reference-indirection (form)
5368 "Return formula with table remote references substituted by indirection.
5370 This indirection works only with the format @ROW$COLUMN. The
5372 distinguished from a plain table name or ID."
5373 (let ((start 0))
5374 (while (string-match (concat
5375 ;; Same as in `org-table-eval-formula'.
5377 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5379 ;; Same as in `org-table-eval-formula'.
5381 form
5382 start)
5383 ;; The position of the character as far as possible to the right
5384 ;; that will not be replaced and particularly not be shifted by
5385 ;; `replace-match'.
5386 (setq start (match-beginning 1))
5387 ;; Substitute the remote reference with the value found in the
5388 ;; field.
5389 (setq form
5390 (replace-match
5391 (save-match-data
5392 (org-table-get-range (org-table-formula-handle-first/last-rc
5393 (match-string 1 form))))
5394 t t form 1))))
5395 form)
5397 (defmacro org-define-lookup-function (mode)
5398 (let ((mode-str (symbol-name mode))
5399 (first-p (equal mode 'first))
5400 (all-p (equal mode 'all)))
5401 (let ((plural-str (if all-p "s" "")))
5402 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5403 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5404 If R-LIST is nil, return matching element%s of S-LIST.
5405 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5406 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5407 This function is generated by a call to the macro `org-define-lookup-function'."
5408 mode-str plural-str plural-str plural-str)
5409 (let ,(let ((lvars '((p (or predicate 'equal))
5410 (sl s-list)
5411 (rl (or r-list s-list))
5412 (ret nil))))
5413 (if first-p (add-to-list 'lvars '(match-p nil)))
5414 lvars)
5415 (while ,(if first-p '(and (not match-p) sl) 'sl)
5416 (progn
5417 (if (funcall p val (car sl))
5418 (progn
5419 ,(if first-p '(setq match-p t))
5420 (let ((rval (car rl)))
5421 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5422 (setq sl (cdr sl) rl (cdr rl))))
5423 ret)))))
5425 (org-define-lookup-function first)
5426 (org-define-lookup-function last)
5427 (org-define-lookup-function all)
5429 (provide 'org-table)
5431 ;; Local variables:
5432 ;; generated-autoload-file: "org-loaddefs.el"
5433 ;; End:
5435 ;;; org-table.el ends here