| blob | 0350af5640ee5fd45f8fba3c4485a65ab7178853 |
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:
54 "Hook for functions attaching to `C-c C-c', if the table is sent.
55 This can be used to add additional functionality after the table is sent
56 to the receiver position, otherwise, if table is not sent, the functions
62 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
63 In the optimized version, the table editor takes over all simple keys that
64 normally just insert a character. In tables, the characters are inserted
65 in a way to minimize disturbing the table structure (i.e. in overwrite mode
66 for empty fields). Outside tables, the correct binding of the keys is
67 restored.
69 The default for this option is t if the optimized version is also used in
70 Org-mode. See the variable `org-enable-table-editor' for details. Changing
71 this variable requires a restart of Emacs to become effective."
77 % END RECEIVE ORGTBL %n
79 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
80 | | |
83 @c END RECEIVE ORGTBL %n
84 @ignore
85 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
86 | | |
89 <!-- END RECEIVE ORGTBL %n -->
90 <!--
91 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
92 | | |
95 #+ END RECEIVE ORGTBL %n
97 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
98 | | |
100 "Templates for radio tables in different major modes.
101 Each template must define lines that will be treated as a comment and that
104 insertion of the template. The transformed table will later be inserted
105 between these lines.
107 The template should also contain a minimal table in a multiline comment.
108 If multiline comments are not possible in the buffer language,
109 you can pack it into a string that will not be used when the code
110 is compiled or executed. Above the table will you need a line with
112 convert the table into a data structure useful in the
113 language of the buffer. Check the manual for the section on
115 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
117 All occurrences of %n in a template will be replaced with the name of the
118 table, obtained by prompting the user."
125 "Settings for tables in Org-mode."
130 "The default size for newly created tables, Columns x Rows."
135 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
136 "Regular expression for recognizing numbers in table columns.
137 If a table column contains mostly numbers, it will be aligned to the
138 right. If not, it will be aligned to the left.
140 The default value of this option is a regular expression which allows
141 anything which looks remotely like a number as used in scientific
142 context. For example, all of the following will be considered a
143 number:
144 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
146 Other options offered by the customize interface are more restrictive."
160 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
161 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
162 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
166 "Fraction of numbers in a column required to make the column align right.
167 In a column all non-white fields are considered. If at least
168 this fraction of fields is matched by `org-table-number-regexp',
169 alignment to the right border applies."
174 "Behavior of tables during editing in Org-mode."
179 "Non-nil means automatically re-align table when pressing TAB or RETURN.
181 removal/insertion."
186 "Non-nil means automatically blank table field when starting to type into it.
187 This only happens when typing immediately after a field motion
188 command (TAB, S-TAB or RET).
189 Only relevant when `org-enable-table-editor' is equal to `optimized'."
194 "Non-nil means automatically exit the follow mode.
195 When nil, the follow mode will stay on and be active in any table
196 the cursor enters. Since the table follow filed mode messes with the
197 window configuration, it is not recommended to set this variable to nil,
198 except maybe locally in a special file that has mostly tables with long
199 fields."
205 "Whether the user should confirm when Org fixes formulas."
213 'safe-local-variable
217 "Non-nil means tab in the last column of a table with jump over a hline.
218 If a horizontal separator line is following the current line,
219 `org-table-next-field' can either create a new row before that line, or jump
220 over the line. When this option is nil, a new line will be created before
221 this line."
226 "Options concerning tables in Org-mode."
231 "Should org-mode work with table references like B3 instead of @3$2?
232 Possible values are:
233 nil never use them
234 from accept as input, do not present for editing
235 t accept as input and present for editing"
255 calc-angle-mode deg
256 calc-prefer-frac nil
257 calc-symbolic-mode nil
259 calc-display-working-message t
260 )
261 "List with Calc mode settings for use in `calc-eval' for table formulas.
262 The list must contain alternating symbols (Calc modes variables and values).
263 Don't remove any of the default settings, just change the values. Org-mode
264 relies on the variables to be present in the list."
269 "Format for the output of calc computations like $1+$2;t.
270 The default value is 'hours, and will output the results as a
271 number of hours. Other allowed values are 'seconds, 'minutes and
272 'days, and the output will be a fraction of seconds, minutes or
273 days."
282 "Format for fields which contain the result of a formula.
284 characters. Beware that modifying the display can prevent the
285 field from being used in another formula."
291 "Non-nil means TAB and RET evaluate a formula in current table field.
292 If the current field starts with an equal sign, it is assumed to be a formula
293 which should be evaluated as described in the manual and in the documentation
294 string of the command `org-table-eval-formula'. This feature requires the
295 Emacs calc package.
296 When this variable is nil, formula calculation is only available through
302 "Non-nil means interpret constants in formulas in tables.
303 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
304 by the value given in `org-table-formula-constants', or by a value obtained
305 from the `constants.el' package."
310 "Alist with constant names and values, for use in table formulas.
311 The car of each element is a name of a constant, without the `$' before it.
312 The cdr is the value as a string. For example, if you'd like to use the
313 speed of light in a formula, you would configure
317 and then use it in an equation like `$1*$c'.
319 Constants can also be defined on a per-file basis using a line like
321 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
328 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
329 Automatically means when TAB or RET or C-c C-c are pressed in the line."
334 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
339 "Non-nil means relative formula references may cross hlines.
340 Here are the allowed values:
342 nil Relative references may not cross hlines. They will reference the
343 field next to the hline instead. Coming from below, the reference
344 will be to the field below the hline. Coming from above, it will be
345 to the field above.
346 t Relative references may cross hlines.
347 error An attempt to cross a hline will throw an error.
349 It is probably good to never set this variable to nil, for the sake of
350 portability of tables."
358 "Non-nil means that evaluation of a field formula can add new
359 columns if an out-of-bounds field is being set."
366 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
370 "Options concerning table import and export in Org-mode."
375 "Default export parameters for `org-table-export'.
376 These can be overridden for a specific table by setting the
377 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
378 radio tables for the different export transformations and
379 available parameters."
384 "Max lines that `org-table-convert-region' will attempt to process.
386 The function can be slow on larger regions; this safety feature
387 prevents it from hanging emacs."
427 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
428 ;; 1 2 3 4 5
439 "Is this a table line colgroup information?"
443 line)
445 nil
452 "Is this a table line with only alignment/width cookies?"
465 s))))
473 ;;;###autoload
475 "Use the table.el package to insert a new table.
476 If there is already a table at point, convert between Org-mode tables
477 and table.el tables."
490 ;;;###autoload
492 "Convert region to table, or create an empty table.
493 If there is an active region, convert it to a table, using the function
494 `org-table-convert-region'. See the documentation of that function
495 to learn how the prefix argument is interpreted to determine the field
496 separator.
497 If there is no such region, create an empty table with `org-table-create'."
503 ;;;###autoload
505 "Query for a size and insert a table skeleton.
525 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
529 ;; Insert a hline after the first row.
536 ;;;###autoload
538 "Convert region to a table.
539 The region goes from BEG0 to END0, but these borders will be moved
540 slightly, to make sure a beginning of line in the first line is included.
542 SEPARATOR specifies the field separator in the lines. It can have the
543 following values:
545 '(4) Use the comma as a field separator
546 '(16) Use a TAB as field separator
547 '(64) Prompt for a regular expression as field separator
548 integer When a number, use that many spaces as field separator
549 regexp When a regular expression, use it to match the separator
550 nil When nil, the command tries to be smart and figure out the
551 separator in the following way:
552 - when each line contains a TAB, assume TAB-separated material
553 - when each line contains a comma, assume CSV material
554 - else, assume one or more SPACE characters as separator."
558 re)
560 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
561 org-table-convert-region-max-lines)
570 ;; Get the right field separator
581 ;; parse the csv stuff
606 ;;;###autoload
608 "Import FILE as a table.
609 The file is assumed to be tab-separated. Such files can be produced by most
610 spreadsheet and database applications. If no tabs (at least one per line)
611 are found, lines will be split on whitespace into fields."
620 ;;;###autoload
622 "Export table to a file, with configurable format.
623 Such a file can be imported into usual spreadsheet programs.
625 FILE can be the output file name. If not given, it will be taken
626 from a TABLE_EXPORT_FILE property in the current entry or higher
627 up in the hierarchy, or the user will be prompted for a file
628 name. FORMAT can be an export format, of the same kind as it
629 used when `orgtbl-mode' sends a table in a different format.
631 The command suggests a format depending on TABLE_EXPORT_FORMAT,
632 whether it is set locally or up in the hierarchy, then on the
633 extension of the given file name, and finally on the variable
634 `org-table-export-default-format'."
667 formats)))
668 org-table-export-default-format)
694 "Marker at the beginning of the table last aligned.
697 "Marker at the end of the table last aligned.
700 "List of flags for flushright alignment, from the last re-alignment.
703 "List of max width of fields in each column.
706 "Non-nil means debug table formulas.
718 ;;;###autoload
720 "Align the table at point by aligning all vertical bars."
723 ;; Limits of table
726 ;; Current cursor position
732 column
734 rfmt hfmt
742 emptystrings links dates emph raise narrow
743 falign falign1 fmax f1 f2 len c e space)
746 ;; Check if we have links or dates
758 ;; Make sure the link properties are right
760 ;; Make sure the date properties are right
765 ;; Check if we are narrowing any columns
768 org-format-transports-properties-p
773 ;; Get the rows
776 ;; Store the indentation of the first line
779 ;; Mark the hlines by setting the corresponding element to nil
780 ;; At the same time, we remove trailing space.
783 nil
786 l)))
787 lines))
788 ;; Get the data fields by splitting the lines.
793 ;; How many fields in the longest line?
800 ;; A list of empty strings to fill any short rows on output
802 ;; Check for special formatting.
806 ;; Check if there is an explicit width specified
816 ;; Find fields that are wider than fmax, and shorten them
822 'help-echo
831 f2)
835 f1)
841 xx)))))
842 ;; Get the maximum width for each column
844 lengths)
845 ;; Get the fraction of numbers, to decide about alignment of the column
851 nil
858 ;; Store the alignment of this table, for later editing of single fields
860 org-table-last-column-widths lengths)
862 ;; With invisible characters, `format' does not get the field width right
863 ;; So we need to make these fields wide by hand.
881 ;; Compute the formats needed for output of the table
894 hfmt))
898 ;; Replace the old one
905 ;; Try to move to the old location
914 ))
916 ;;;###autoload
918 "Find the beginning of the table and return its position.
919 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
923 org-table-border-regexp)
924 nil t))
930 ;;;###autoload
932 "Find the end of the table and return its position.
933 With argument TABLE-TYPE, go to the end of a table.el-type table."
937 org-table-border-regexp)
938 nil t))
942 ;;;###autoload
944 "Justify the current field, text to left, number to right.
945 Optional argument NEW may specify text to replace the current field content."
954 ;; This is not the same table, force a full re-align
960 l f n o e)
986 ;;;###autoload
988 "Go to the next field in the current table, creating new lines as needed.
989 Before doing so, re-align the table if necessary."
994 org-table-may-need-update)
1005 org-table-tab-jumps-over-hlines
1016 ;;;###autoload
1018 "Go to the previous field in the table.
1019 Before doing so, re-align the table if necessary."
1024 org-table-may-need-update)
1039 "Move to the beginning of the current table field.
1040 If already at or before the beginning, move to the beginning of the
1041 previous field.
1042 With numeric argument N, move N-1 fields backward first."
1055 "Move to the end of the current table field.
1056 If already at or after the end, move to the end of the next table field.
1057 With numeric argument N, move N-1 fields forward first."
1070 ;;;###autoload
1072 "Go to the next row (same column) in the current table.
1073 Before doing so, re-align the table if necessary."
1081 org-table-may-need-update)
1094 ;;;###autoload
1096 "Copy the value of the current field one row below.
1098 If the field at the cursor is empty, copy the content of the
1099 nearest non-empty field above. With argument N, use the Nth
1100 non-empty field.
1102 If the current field is not empty, it is copied down to the next
1103 row, and the cursor is moved with it. Therefore, repeating this
1104 command causes the column to be filled row-by-row.
1106 If the variable `org-table-copy-increment' is non-nil and the
1107 field is an integer or a timestamp, it will be incremented while
1108 copying. By default, increment by the difference between the
1109 value in the current field and the one in the field above. To
1110 increment using a fixed integer, set `org-table-copy-increment'
1111 to a number. In the case of a timestamp, increment by days."
1123 txt txt-up inc)
1131 beg t))
1141 beg t))
1148 ;; Above field was not empty, go down to the next row
1181 "Is point inside a table data field?
1182 I.e. not on a hline or before the first or after the last column?
1183 This actually throws an error, so it aborts the current command."
1189 nil
1191 t))
1197 "Get the field in table line LINE, column COLUMN.
1198 If LINE is larger than the number of data lines in the table, the function
1199 returns nil. However, if COLUMN is too large, we will simply return an
1200 empty string.
1201 If LINE is nil, use the current line.
1202 If COLUMN is nil, use the current column."
1209 "Put VALUE into line LINE, column COLUMN.
1210 When ALIGN is set, also realign the table."
1219 "Return the index of the current data line."
1226 cnt))
1229 "Go to the Nth data line in the current table.
1230 Return t when the line exists, nil if it does not exist."
1237 ;;;###autoload
1239 "Blank the current table field or active region."
1256 "Return the value of the field in column N of current row.
1257 N defaults to current field.
1258 If REPLACE is a string, replace field with this value. The return value
1259 is always the old value."
1268 t t))
1270 val)
1273 ;;;###autoload
1275 "Show info about the current field, and highlight any reference at point."
1284 org-table-named-field-locations)))
1304 dline col
1306 dline col ref1
1308 ;; FIXME: formula info not correct if special table line
1318 "Find out which column we are in."
1328 cnt)))
1330 ;;;###autoload
1332 "Find out what table data line we are in.
1333 Only data lines count for this."
1345 cnt)))
1347 ;;;###autoload
1349 "Move the cursor to the Nth column in the current table line.
1350 With optional argument ON-DELIM, stop with point before the left delimiter
1351 of the field.
1352 If there are less than N fields, just go to after the last delimiter.
1353 However, when FORCE is non-nil, create new columns if necessary."
1363 t)))))
1370 ;;;###autoload
1372 "Insert a new column into the table."
1380 ;; Current cursor position
1386 nil
1400 "Find a data line in the current table, which is needed for column commands."
1403 t
1414 t
1419 "Turn a buffer line number into a data line number.
1420 If there is no data line in this line, return nil.
1421 If there is no matching dline (most likely te reference was a hline), the
1422 first dline below it is used. When ABOVE is non-nil, the one above is used."
1425 i)
1438 nil))
1440 ;;;###autoload
1442 "Delete a column from the table."
1451 ;; Current cursor position
1457 nil
1473 ;;;###autoload
1475 "Move column to the right."
1478 ;;;###autoload
1480 "Move column to the left."
1484 ;;;###autoload
1486 "Move the current column to the right. With arg LEFT, move to the left."
1496 ;; Current cursor position
1506 nil
1524 ;;;###autoload
1526 "Move table row down."
1529 ;;;###autoload
1531 "Move table row up."
1535 ;;;###autoload
1537 "Move the current table line down. With arg UP, move it up."
1546 txt hline2p)
1569 ;;;###autoload
1571 "Insert a new row above the current line into the table.
1572 With prefix ARG, insert below the current line."
1578 ;; Fix the first field if necessary
1591 ;;;###autoload
1593 "Insert a horizontal-line below the current line into the table.
1594 With prefix ABOVE, insert above the current line."
1615 ;;;###autoload
1617 "Insert a hline and move to the row below that line."
1631 In particular, this does handle wide and invisible characters."
1633 ;; It's a hline, just map the characters
1639 t t s)))
1640 s))
1642 ;;;###autoload
1644 "Delete the current row or horizontal line from the table."
1658 ;;;###autoload
1660 "Sort table lines according to the column at point.
1662 The position of point indicates the column to be used for
1663 sorting, and the range of lines is the range between the nearest
1664 horizontal separator lines, or the entire table of no such lines
1665 exist. If point is before the first column, you will be prompted
1666 for the sorting column. If there is an active region, the mark
1667 specifies the first line and the sorting column, while point
1668 should be in the last line to be included into the sorting.
1670 The command then prompts for the sorting type which can be
1671 alphabetically, numerically, or by time (as given in a time stamp
1672 in the field, or as a HH:MM value). Sorting in reverse order is
1673 also possible.
1675 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1677 If SORTING-TYPE is specified when this function is called from a Lisp
1678 program, no prompting will take place. SORTING-TYPE must be a character,
1679 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1680 sorting should be done in reverse order.
1682 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1683 a function to be called to extract the key. It must return either
1684 a string or a number that should serve as the sorting key for that
1685 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1686 is specified interactively, the comparison will be either a string or
1687 numeric compare based on the type of the first key in the table."
1692 beg end bcol ecol tend tbeg column lns pos)
1737 x))
1752 (defun org-table--do-sort (table what &optional with-case sorting-type getkey-func compare-func)
1753 "Sort TABLE of WHAT according to SORTING-TYPE.
1754 The user will be prompted for the SORTING-TYPE if the call to this
1755 function does not specify it.
1756 WHAT is only for the prompt, to indicate what is being sorted.
1757 The sorting key will be extracted from the car of the elements of
1758 the table. If WITH-CASE is non-nil, the sorting will be case-sensitive.
1760 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1761 a function to be called to extract the key. It must return either
1762 a string or a number that should serve as the sorting key for that
1763 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1764 is specified interactively, the comparison will be either a string or
1765 numeric compare based on the type of the first key in the table."
1768 "Sort %s: [a]lphabetic, [n]umeric, [t]ime, [f]unc. A/N/T/F means reversed:"
1769 what)
1772 ;; Define the appropriate functions
1795 "Sort using function: "
1800 tempfun))
1811 table)
1814 ;;;###autoload
1816 "Copy region in table to the clipboard and blank all relevant fields.
1817 If there is no active region, use just the field at point."
1823 ;;;###autoload
1825 "Copy rectangular region in table to clipboard.
1826 A special clipboard is used which can only be accessed
1827 with `org-table-paste-rectangle'."
1831 current-prefix-arg))
1833 region cols
1859 org-table-clip))
1861 ;;;###autoload
1863 "Paste a rectangular region into a table.
1864 The upper right corner ends up in the current field. All involved fields
1865 will be overwritten. If the rectangle does not fit into the present table,
1866 the table is enlarged as needed. The process ignores horizontal separator
1867 lines."
1877 c cols field)
1892 ;;;###autoload
1894 "Convert from `org-mode' table to table.el and back.
1895 Obviously, this only works within limits. When an Org-mode table is
1896 converted to table.el, all horizontal separator lines get lost, because
1897 table.el uses these as cell boundaries and has no notion of horizontal lines.
1898 A table.el table can be converted to an Org-mode table only if it does not
1899 do row or column spanning. Multiline cells will become multiple cells.
1900 Beware, Org-mode does not test if the table can be successfully converted - it
1901 blindly applies a recipe that works for simple tables."
1905 ;; convert to Org-mode table
1914 ;; convert to table.el table
1917 ;; first, get rid of all horizontal lines
1921 ;; insert a hline before first
1925 ;; insert a hline after each line
1930 ;; replace "+" at beginning and ending of hlines
1939 "Transpose Org table at point and eliminate hlines.
1940 So a table like
1942 | 1 | 2 | 4 | 5 |
1943 |---+---+---+---|
1944 | a | b | c | d |
1945 | e | f | g | h |
1947 will be transposed as
1949 | 1 | a | e |
1950 | 2 | b | f |
1951 | 4 | c | g |
1952 | 5 | d | h |
1954 Note that horizontal lines disappear."
1966 table)))
1980 ;;;###autoload
1982 "Wrap several fields in a column like a paragraph.
1983 This is useful if you'd like to spread the contents of a field over several
1984 lines, in order to keep the table compact.
1986 If there is an active region, and both point and mark are in the same column,
1987 the text in the column is wrapped to minimum width for the given number of
1988 lines. Generally, this makes the table more compact. A prefix ARG may be
1990 formats the selected text to two lines. If the region was longer than two
1991 lines, the remaining lines remain empty. A negative prefix argument reduces
1992 the current number of lines by that amount. The wrapped text is pasted back
1993 into the table. If you formatted it to more lines than it was before, fields
1994 further down in the table get overwritten - so you might need to make space in
1995 the table first.
1997 If there is no region, the current field is split at the cursor position and
1998 the text fragment to the right of the cursor is prepended to the field one
1999 line down.
2001 If there is no region, but you specify a prefix ARG, the current field gets
2002 blank, and the content is appended to the field above."
2006 ;; There is a region: fill as a paragraph
2010 nlines)
2017 arg)
2021 nil nlines)))
2025 ;; No region, split the current field at point
2029 ;; combine with field above
2039 ;; split field
2051 ;;;###autoload
2053 "Edit table field in a different window.
2054 This is mainly useful for fields that contain hidden parts.
2056 it can be edited in place."
2065 display t intangible t))
2078 p)
2094 intangible t))
2102 "Finish editing a table data field.
2103 Remove all newline characters, insert the result into the table, realign
2104 the table and kill the editing buffer."
2108 text)
2125 "Minor mode to make the table field editor window follow the cursor.
2126 When this mode is active, the field editor window will always show the
2127 current field. The mode exits automatically when the cursor leaves the
2128 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2129 nil " TblFollow" nil
2145 ;; We have left the table, exit the follow mode
2155 ;;;###autoload
2157 "Sum numbers in region of current table column.
2158 The result will be displayed in the echo area, and will be available
2161 If there is an active region, it is interpreted as a rectangle and all
2162 numbers in that rectangle will be summed. If there is no active
2163 region and point is located in a table column, sum all numbers in that
2164 column.
2166 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2167 numbers are assumed to be times as well (in decimal hours) and the
2168 numbers are added as such.
2170 If NLAST is a number, only the NLAST fields will actually be summed."
2197 items1)))
2204 s diff)
2212 sres))))
2235 "Return the formula active for the current field.
2236 Assumes that specials are in place.
2237 If KEY is given, return the key to this formula.
2241 org-table-named-field-locations)))
2255 "Read a formula from the minibuffer, offer stored formula as default.
2256 When NAMED is non-nil, look for a named equation."
2260 org-table-named-field-locations)))
2267 name
2268 ref)
2278 stored)
2280 equation)
2287 scol))
2289 'org-table-formula-history
2290 )))))
2291 mustsave)
2293 ;; remove formula
2300 ;; We set the column equation, delete the named one.
2302 mustsave t))
2308 eq))
2311 "Store the list of formulas below the current table."
2318 ;; don't overwrite TBLFM, we might use text properties to store stuff
2334 ;; Fake a high number to make sure this is sorted at the end.
2341 a)
2351 "Compare two formulas for sorting."
2356 ;;;###autoload
2358 "Return an alist with the stored formulas directly after current table."
2367 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2386 "Modify the equations after the table structure has been edited.
2388 For all numbers larger than LIMIT, shift them by DELTA."
2400 s n a)
2406 "Change makes TBLFM term %s invalid, use undo to recover"
2422 "Get the column names and local parameters for this table."
2425 names name fields fields1 field cnt
2426 c v l line col types dlines hlines last-dline)
2428 org-table-local-parameters nil
2429 org-table-named-field-locations nil
2430 org-table-current-begin-line nil
2431 org-table-current-begin-pos nil
2432 org-table-current-line-types nil
2451 org-table-local-parameters))))
2467 ;; Analyse the line types
2471 l org-table-current-begin-line)
2488 al al2)
2498 ;;;###autoload
2501 If yes, store the formula and apply it."
2502 ;; We already know we are in a table. Get field will only return a formula
2503 ;; when appropriate. It might return a separator line, but no problem.
2506 named eq)
2517 "List of commands triggering the recalculation of a line.
2529 ;;;###autoload
2531 "Rotate the recalculation mark in the first column.
2532 If in any row, the first field is not consistent with a mark,
2533 insert a new column for the markers.
2534 When there is an active region, change all the lines in the region,
2535 after prompting for the marking character.
2536 After each change, a message will be displayed indicating the meaning
2537 of the new mark."
2552 epos new)
2559 newchar))
2591 ;;;###autoload
2593 "Recompute the current line if marked for it, and if we haven't just done it."
2613 org-tbl-calc-modes)
2615 ;;;###autoload
2617 suppress-align suppress-const
2618 suppress-store suppress-analysis)
2619 "Replace the table field value at the cursor by the result of a calculation.
2621 This function makes use of Dave Gillespie's Calc package, in my view the
2622 most exciting program ever written for GNU Emacs. So you need to have Calc
2623 installed in order to use this function.
2625 In a table, this command replaces the value in the current field with the
2627 formula, by storing it in a special line below the table. When called
2628 with a `C-u' prefix, the current field must be a named field, and the
2629 formula is installed as valid in only this specific field.
2631 When called with two `C-u' prefixes, insert the active equation
2632 for the field back into the current field, so that it can be
2634 to check the referenced fields.
2636 When called, the command first prompts for a formula, which is read in
2637 the minibuffer. Previously entered formulas are available through the
2638 history list, and the last used formula is offered as a default.
2639 These stored formulas are adapted correctly when moving, inserting, or
2640 deleting columns with the corresponding commands.
2642 The formula can be any algebraic expression understood by the Calc package.
2643 For details, see the Org-mode manual.
2645 This function can also be called from Lisp programs and offers
2646 additional arguments: EQUATION can be the formula to apply. If this
2647 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2648 used to speed-up recursive calls by by-passing unnecessary aligns.
2649 SUPPRESS-CONST suppresses the interpretation of constants in the
2650 formula, assuming that this has been done already outside the function.
2651 SUPPRESS-STORE means the formula should not be stored, either because
2652 it is already stored, or because it is a modified equation that should
2653 not overwrite the stored one."
2669 equation
2675 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2676 duration duration-output-format)
2677 ;; Parse the format string. Since we have a lot of modes, this is
2678 ;; a lot of work. However, I think calc still uses most of the time.
2691 'calc-float-format
2694 n))))
2698 duration-output-format nil
2702 duration-output-format org-table-duration-custom-format
2703 numbers t
2726 ;; replace fields with duration values if relevant
2730 fields)))
2736 x))
2737 fields)))
2743 ;; Insert row and column number of formula result field
2754 t t form)))
2756 ;; Check for old vertical references
2758 ;; Insert remote references
2771 rmtrng))
2772 keep-empty numbers lispp))
2773 t t form)))
2774 ;; Insert complex ranges
2782 ;; possibly handle durations
2787 formrg)
2788 keep-empty numbers lispp)))
2793 ;; Insert simple ranges, i.e. included in the current row.
2796 form)
2806 keep-empty numbers lispp))
2807 t t form)))
2809 ;; Insert the references to fields in same row
2816 x keep-empty numbers lispp)))
2834 ;; Use <...> time-stamps so that Calc can handle them
2837 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2848 form
2855 duration-output-format)
2856 ev)))
2861 Orig: %s
2862 $xyz-> %s
2863 @r$c-> %s
2895 prop value)))
2898 "Get a calc vector from a column, according to descriptor DESC.
2899 Optional arguments TBEG and COL can give the beginning of the table and
2900 the current column, to avoid unnecessary parsing.
2902 HIGHLIGHT means just highlight the range.
2904 When CORNERS-ONLY is set, only return the corners of the range as
2905 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2906 in the buffer and column1 and column2 are table column numbers."
2913 beg end c1 c2 r1 r2 rangep tmp)
2930 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2937 ;; just one field
2944 ;; A range, return a vector
2945 ;; First sort the numbers to get a regular rectangle
2949 ;; Only return the corners of the range
2951 ;; Copy the range values into a list
2965 ;; return string representation of calc vector
2970 "Analyze descriptor DESC and retrieve the corresponding line number.
2971 The cursor is currently in line CLINE, the table begins in line BLINE,
2972 and TABLE is a vector with line types."
2980 ;; 1 2 3 4 5 6
3000 nil hn cline desc)))
3003 rel on cline desc)))
3007 "FIXME: Needs more documentation."
3020 nil))
3021 t)))
3025 desc cline))
3026 ;; The last hline doesn't exist. Instead, point to last row
3027 ;; in table.
3036 "Convert list ELEMENTS to something appropriate to insert into formula.
3037 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3038 NUMBERS indicates that everything should be converted to numbers.
3039 LISPP non-nil means to return something appropriate for a Lisp
3040 list, 'literal is for the format specifier L."
3041 ;; Calc nan (not a number) is used for the conversion of the empty
3042 ;; field to a reference for several reasons: (i) It is accepted in a
3043 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3044 ;; (ii) In a single field (not in range) it can be distinguished
3045 ;; from "(nan)" which is the reference made from a single field
3046 ;; containing "nan".
3048 ;; field reference
3051 elements
3053 ""
3062 ;; range reference
3067 elements))))
3073 x
3081 x)
3083 elements
3087 "If there has been more than one second since T1, display message.
3088 ARGS are passed as arguments to the `message' function. Returns
3089 current time if a message is printed, otherwise returns T1. If
3090 T1 is nil, always messages."
3094 curtime)
3095 t1)))
3097 ;;;###autoload
3099 "Recalculate the current table line by applying all stored formulas.
3100 With prefix arg ALL, do this for all lines in the table.
3101 With the prefix argument ALL is `(16)' \
3103 it is the symbol `iterate', recompute the table until it no longer changes.
3104 If NOALIGN is not nil, do not re-align the table after the computations
3105 are done. This is typically used internally to save time, if it is
3106 known that the table will be realigned a little later anyway."
3123 seen-fields lhs1
3125 ;; Insert constants in all formulas
3145 eqlist))
3146 ;; Split the equation list
3152 ;; Expand ranges in lhs of formulas
3155 ;; Get the correct line range to process
3161 ;; This is a table with marked lines, compute selected lines
3163 ;; Move forward to the first non-header line
3173 ;; First find the named fields, and mark them untouchable.
3174 ;; Also check if several field/range formulas try to set the same field.
3193 name)))
3206 ;; Now evaluate the column formulas, but skip fields covered
3207 ;; by field formulas
3211 ;; Unprotected line, recalculate
3215 log-last-time
3227 ;; Now evaluate the field formulas
3247 t))
3262 log-first-time
3266 ;; back to initial position
3275 ;;;###autoload
3277 "Recalculate the table until it does not change anymore.
3278 The maximum number of iterations is 10, but you can choose a different value
3279 with the prefix ARG."
3284 thistbl)
3298 ;;;###autoload
3300 "Recalculate all tables in the current buffer."
3307 ;;;###autoload
3309 "Iterate all tables in the buffer, to converge inter-table dependencies."
3314 c1)
3330 "Apply the #+TBLFM in the line at point to the table."
3337 ;; Insert a temporary formula at right after the table
3342 ;; Recalculate the table.
3347 ;; Delete the formula inserted temporarily.
3353 "Find the beginning of the TBLFM lines and return its position.
3354 Return nil when the beginning of TBLFM line was not found."
3361 "Expand list of formulas.
3362 If some of the RHS in the formulas are ranges or a row reference, expand
3363 them to individual field equations for each field."
3369 ;; This just refers to one fixed field
3372 ;; This just refers to one fixed named field
3394 "Replace @<, @>, $<, $> with first/last row/column of the table.
3395 So @< and $< will always be replaced with @1 and $1, respectively.
3396 The advantage of these special markers are that structure editing of
3397 the table will not change them, while @1 and $1 will be modified
3398 when a line/row is swapped out of that privileged position. So for
3399 formulas that use a range of rows or columns, it may often be better
3401 borders of the table using the @< @> $< $> makers."
3404 s start)
3409 org-table-current-ncol)
3413 len
3420 s)
3423 "Replace $const with values in string F."
3428 org-table-column-name-regexp
3431 org-table-column-names))))
3432 f t t)))
3433 ;; Parameters and constants.
3437 new start))
3440 ;; When a duration is expected, convert value on the fly.
3446 v)))))
3453 "Find the value for a parameter or constant in a formula.
3454 Parameters get priority."
3485 map))
3492 "--"
3495 "--"
3496 "Shift Reference at Point"
3501 "-"
3502 "Change Test Row for Column Formulas"
3505 "--"
3510 org-table-overlay-coordinates)]
3511 "--"
3517 ;;;###autoload
3519 "Edit the formulas of the current table in a separate buffer."
3521 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3535 entry s type title)
3538 ;; Keep global-font-lock-mode from turning on font-lock-mode
3579 "Convert a formula from internal to user representation."
3582 s))
3585 "Convert a formula from user to internal representation."
3588 s))
3591 "Convert spreadsheet references from A7 to @7$28.
3592 Works for single references, but also for entire formulas and even the
3593 full TBLFM line."
3595 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3598 ;; format match, just advance
3603 ;; 3.e5 or something like this.
3606 ;; (member (match-string 1 s)
3607 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3608 )
3609 ;; function name, just advance
3619 t t s)))))
3620 s))
3623 "Convert spreadsheet references from to @7$28 to AB7.
3624 Works for single references, but also for entire formulas and even the
3625 full TBLFM line."
3632 t t s)))
3637 t nil s)))
3638 s)
3641 "Convert a base 26 number represented by letters into an integer.
3642 For example: AB -> 28."
3648 n))
3651 "Convert an integer into a base 26 number represented by letters.
3652 For example: 28 -> AB."
3657 s))
3660 "Convert a time string into numerical duration in seconds.
3661 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3662 If S is a string representing a number, keep this number."
3664 s
3687 "Convert a number of seconds to a time string.
3688 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3689 minutes or seconds."
3704 "Convert all references in this buffer, using FUNCTION."
3714 "Convert all references in the buffer from B3 to @3$2 and back."
3724 "Shift the reference at point one row/hline up."
3728 "Shift the reference at point one row/hline down."
3732 "Shift the reference at point one field to the left."
3736 "Shift the reference at point one field to the right."
3747 ;; A B3-like reference
3753 ;; An internal reference
3759 "Re-match the group N, and replace it with the shifted reference."
3764 t t)))
3767 "Shift a reference part REF.
3768 If DECR is set, decrease the references row/column, else increase.
3769 If HLINE is set, this may be a hline reference, it certainly is not
3770 a translation reference."
3799 "Toggle the display of coordinates in the referenced table."
3808 "Parse the buffer for formula definitions and install them.
3809 With prefix ARG, apply the new formulas to the table."
3819 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3820 nil t)
3844 "Abort editing formulas, without installing the changes."
3855 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3896 "Show the location/value of the $ expression at point."
3905 var name e what match dest)
3910 "$1.."
3993 ;; column number
4021 org-table-fedit-scroll-down))))
4033 "Make sure the cursor is in a dataline in a table."
4042 p1 p2)))
4047 "Move cursor one line up in the window showing the table."
4052 "Move cursor one line down in the window showing the table."
4057 "Move the cursor in the window showing the table.
4058 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4083 "Add a new overlay."
4089 "Highlight rectangular region in a table."
4093 l1 c1 l2 c2 tmp)
4117 "Remove the rectangle overlays."
4128 "Add overlays to the table at point, to show row/column coordinates."
4156 ;;;###autoload
4158 "Toggle the display of Row/Column numbers in tables."
4169 ;;;###autoload
4171 "Toggle the formula debugger in tables."
4177 ;;; The orgtbl minor mode
4179 ;; Define a minor mode which can be used in other modes in order to
4180 ;; integrate the org-mode table editor.
4182 ;; This is really a hack, because the org-mode table editor uses several
4183 ;; keys which normally belong to the major mode, for example the TAB and
4184 ;; RET keys. Here is how it works: The minor mode defines all the keys
4185 ;; necessary to operate the table editor, but wraps the commands into a
4186 ;; function which tests if the cursor is currently inside a table. If that
4187 ;; is the case, the table editor command is executed. However, when any of
4188 ;; those keys is used outside a table, the function uses `key-binding' to
4189 ;; look up if the key has an associated command in another currently active
4190 ;; keymap (minor modes, major mode, global), and executes that command.
4191 ;; There might be problems if any of the keys used by the table editor is
4192 ;; otherwise used as a prefix key.
4194 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4195 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4196 ;; addresses this by checking explicitly for both bindings.
4198 ;; The optimized version (see variable `orgtbl-optimized') takes over
4199 ;; all keys which are bound to `self-insert-command' in the *global map*.
4200 ;; Some modes bind other commands to simple characters, for example
4201 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4202 ;; active, this binding is ignored inside tables and replaced with a
4203 ;; modified self-insert.
4221 ;; Install it as a minor mode.
4225 ;;;###autoload
4227 "The `org-mode' table editor as a minor mode for use in other modes."
4232 ;; Exit without error, in case some hook functions calls this
4233 ;; by accident in org-mode.
4237 ;; Make sure we are first in minor-mode-map-alist
4239 ;; FIXME: maybe it should use emulation-mode-map-alists?
4246 auto-fill-inhibit-regexp)
4250 auto-fill-inhibit-regexp)
4251 orgtbl-line-start-regexp))
4269 "Remove all properties related to narrow-column invisibility."
4282 "Create a function for binding in the table minor mode.
4283 FUN is the command to call inside a table. N is used to create a unique
4284 command name. KEYS are keys that should be checked in for a command
4285 to execute outside of tables."
4291 "Outside of tables, run the binding of `"
4303 keys)
4307 "Error when there is no default binding for a table key."
4312 "Setup orgtbl keymaps."
4343 elt key fun cmd)
4351 ;; Special treatment needed for TAB and RET
4371 [(tab)] "\C-i")))
4373 (org-defkey orgtbl-mode-map [backtab]
4375 [backtab] [S-iso-lefttab] [(shift tab)]
4376 [(tab)] "\C-i"))
4378 (org-defkey orgtbl-mode-map "\M-\C-m"
4379 (orgtbl-make-binding 'org-table-wrap-region 105
4380 "\M-\C-m" [(meta return)]))
4381 (org-defkey orgtbl-mode-map [(meta return)]
4382 (orgtbl-make-binding 'org-table-wrap-region 106
4383 [(meta return)] "\M-\C-m"))
4385 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4386 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4388 (when orgtbl-optimized
4389 ;; If the user wants maximum table support, we need to hijack
4390 ;; some standard editing functions
4391 (org-remap orgtbl-mode-map
4392 'self-insert-command 'orgtbl-self-insert-command
4393 'delete-char 'org-delete-char
4394 'delete-backward-char 'org-delete-backward-char)
4395 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4396 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4397 '("OrgTbl"
4398 ["Create or convert" org-table-create-or-convert-from-region
4399 :active (not (org-at-table-p)) :keys "C-c |" ]
4400 "--"
4401 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4402 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4403 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4404 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4405 "--"
4406 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4407 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4408 ["Copy Field from Above"
4409 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4410 "--"
4411 ("Column"
4412 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4413 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4414 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4415 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4416 ("Row"
4417 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4418 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4419 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4420 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4421 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4422 "--"
4423 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4424 ("Rectangle"
4425 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4426 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4427 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4428 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4429 "--"
4430 ("Radio tables"
4431 ["Insert table template" orgtbl-insert-radio-table
4432 (assq major-mode orgtbl-radio-table-templates)]
4433 ["Comment/uncomment table" orgtbl-toggle-comment t])
4434 "--"
4435 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4436 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4437 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4438 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4439 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4440 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4441 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4442 ["Sum Column/Rectangle" org-table-sum
4443 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4444 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4445 ["Debug Formulas"
4446 org-table-toggle-formula-debugger :active (org-at-table-p)
4447 :keys "C-c {"
4448 :style toggle :selected org-table-formula-debug]
4449 ["Show Col/Row Numbers"
4450 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4451 :keys "C-c }"
4452 :style toggle :selected org-table-overlay-coordinates]
4453 "--"
4454 ("Plot"
4457 t))
4459 (defun orgtbl-ctrl-c-ctrl-c (arg)
4460 "If the cursor is inside a table, realign the table.
4461 If it is a table to be sent away to a receiver, do it.
4462 With prefix arg, also recompute table."
4463 (interactive "P")
4464 (let ((case-fold-search t) (pos (point)) action)
4465 (save-excursion
4466 (beginning-of-line 1)
4467 (setq action (cond
4471 (cond
4472 ((integerp action)
4473 (goto-char action)
4474 (org-table-maybe-eval-formula)
4475 (if arg
4476 (call-interactively 'org-table-recalculate)
4477 (org-table-maybe-recalculate-line))
4478 (call-interactively 'org-table-align)
4479 (when (orgtbl-send-table 'maybe)
4480 (run-hooks 'orgtbl-after-send-table-hook)))
4481 ((eq action 'recalc)
4482 (save-excursion
4483 (beginning-of-line 1)
4485 (if (org-at-table-p)
4486 (org-call-with-arg 'org-table-recalculate t))))
4487 (t (let (orgtbl-mode)
4488 (call-interactively (key-binding "\C-c\C-c")))))))
4490 (defun orgtbl-create-or-convert-from-region (arg)
4491 "Create table or convert region to table, if no conflicting binding.
4492 This installs the table binding `C-c |', but only if there is no
4493 conflicting binding to this key outside orgtbl-mode."
4494 (interactive "P")
4495 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4496 (if cmd
4497 (call-interactively cmd)
4498 (call-interactively 'org-table-create-or-convert-from-region))))
4500 (defun orgtbl-tab (arg)
4501 "Justification and field motion for `orgtbl-mode'."
4502 (interactive "P")
4503 (if arg (org-table-edit-field t)
4504 (org-table-justify-field-maybe)
4505 (org-table-next-field)))
4507 (defun orgtbl-ret ()
4508 "Justification and field motion for `orgtbl-mode'."
4509 (interactive)
4510 (if (bobp)
4511 (newline)
4512 (org-table-justify-field-maybe)
4513 (org-table-next-row)))
4515 (defun orgtbl-self-insert-command (N)
4516 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4517 If the cursor is in a table looking at whitespace, the whitespace is
4518 overwritten, and the table is not marked as requiring realignment."
4519 (interactive "p")
4520 (if (and (org-at-table-p)
4521 (or
4522 (and org-table-auto-blank-field
4523 (member last-command
4524 '(orgtbl-hijacker-command-100
4525 orgtbl-hijacker-command-101
4526 orgtbl-hijacker-command-102
4527 orgtbl-hijacker-command-103
4528 orgtbl-hijacker-command-104
4529 orgtbl-hijacker-command-105
4530 yas/expand))
4531 (org-table-blank-field))
4532 t)
4533 (eq N 1)
4535 (let (org-table-may-need-update)
4536 (goto-char (1- (match-end 0)))
4537 (org-delete-backward-char 1)
4538 (goto-char (match-beginning 0))
4539 (self-insert-command N))
4540 (setq org-table-may-need-update t)
4541 (let* (orgtbl-mode
4542 a
4543 (cmd (or (key-binding
4544 (or (and (listp function-key-map)
4545 (setq a (assoc last-input-event function-key-map))
4546 (cdr a))
4547 (vector last-input-event)))
4548 'self-insert-command)))
4549 (call-interactively cmd)
4550 (if (and org-self-insert-cluster-for-undo
4551 (eq cmd 'self-insert-command))
4552 (if (not (eq last-command 'orgtbl-self-insert-command))
4553 (setq org-self-insert-command-undo-counter 1)
4554 (if (>= org-self-insert-command-undo-counter 20)
4555 (setq org-self-insert-command-undo-counter 1)
4556 (and (> org-self-insert-command-undo-counter 0)
4557 buffer-undo-list
4558 (not (cadr buffer-undo-list)) ; remove nil entry
4559 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4560 (setq org-self-insert-command-undo-counter
4561 (1+ org-self-insert-command-undo-counter))))))))
4564 "Regular expression matching exponentials as produced by calc.")
4566 (defun orgtbl-gather-send-defs ()
4567 "Gather a plist of :name, :transform, :params for each destination before
4568 a radio table."
4569 (save-excursion
4570 (goto-char (org-table-begin))
4571 (let (rtn)
4572 (beginning-of-line 0)
4573 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4574 (let ((name (org-no-properties (match-string 1)))
4575 (transform (intern (match-string 2)))
4576 (params (if (match-end 3)
4577 (read (concat "(" (match-string 3) ")")))))
4578 (push (list :name name :transform transform :params params)
4579 rtn)
4580 (beginning-of-line 0)))
4581 rtn)))
4583 (defun orgtbl-send-replace-tbl (name txt)
4584 "Find and replace table NAME with TXT."
4585 (save-excursion
4586 (goto-char (point-min))
4587 (unless (re-search-forward
4589 (user-error "Don't know where to insert translated table"))
4590 (let ((beg (line-beginning-position 2)))
4591 (unless (re-search-forward
4592 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4593 (user-error "Cannot find end of insertion region"))
4594 (beginning-of-line)
4595 (delete-region beg (point)))
4598 ;;;###autoload
4599 (defun org-table-to-lisp (&optional txt)
4600 "Convert the table at point to a Lisp structure.
4601 The structure will be a list. Each item is either the symbol `hline'
4602 for a horizontal separator line, or a list of field values as strings.
4603 The table is taken from the parameter TXT, or from the buffer at point."
4604 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4605 (let ((txt (or txt
4606 (buffer-substring-no-properties (org-table-begin)
4607 (org-table-end)))))
4608 (mapcar (lambda (x)
4609 (if (string-match org-table-hline-regexp x) 'hline
4613 (defun orgtbl-send-table (&optional maybe)
4614 "Send a transformed version of table at point to the receiver position.
4615 With argument MAYBE, fail quietly if no transformation is defined
4616 for this table."
4617 (interactive)
4618 (catch 'exit
4619 (unless (org-at-table-p) (user-error "Not at a table"))
4620 ;; when non-interactive, we assume align has just happened.
4621 (when (org-called-interactively-p 'any) (org-table-align))
4622 (let ((dests (orgtbl-gather-send-defs))
4623 (table (org-table-to-lisp
4624 (buffer-substring-no-properties (org-table-begin)
4625 (org-table-end))))
4626 (ntbl 0))
4627 (unless dests
4628 (if maybe (throw 'exit nil)
4629 (user-error "Don't know how to transform this table")))
4630 (dolist (dest dests)
4631 (let ((name (plist-get dest :name))
4632 (transform (plist-get dest :transform))
4633 (params (plist-get dest :params)))
4634 (unless (fboundp transform)
4635 (user-error "No such transformation function %s" transform))
4636 (orgtbl-send-replace-tbl name (funcall transform table params)))
4637 (incf ntbl))
4638 (message "Table converted and installed at %d receiver location%s"
4639 ntbl (if (> ntbl 1) "s" ""))
4640 (and (> ntbl 0) ntbl))))
4642 (defun org-remove-by-index (list indices &optional i0)
4643 "Remove the elements in LIST with indices in INDICES.
4644 First element has index 0, or I0 if given."
4645 (if (not indices)
4646 list
4647 (if (integerp indices) (setq indices (list indices)))
4648 (setq i0 (1- (or i0 0)))
4649 (delq :rm (mapcar (lambda (x)
4650 (setq i0 (1+ i0))
4651 (if (memq i0 indices) :rm x))
4652 list))))
4654 (defun orgtbl-toggle-comment ()
4655 "Comment or uncomment the orgtbl at point."
4656 (interactive)
4657 (let* ((case-fold-search t)
4658 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4659 (re2 (concat "^" orgtbl-line-start-regexp))
4660 (commented (save-excursion (beginning-of-line 1)
4661 (cond ((looking-at re1) t)
4662 ((looking-at re2) nil)
4663 (t (user-error "Not at an org table")))))
4664 (re (if commented re1 re2))
4665 beg end)
4666 (save-excursion
4667 (beginning-of-line 1)
4668 (while (looking-at re) (beginning-of-line 0))
4669 (beginning-of-line 2)
4670 (setq beg (point))
4671 (while (looking-at re) (beginning-of-line 2))
4672 (setq end (point)))
4673 (comment-region beg end (if commented '(4) nil))))
4675 (defun orgtbl-insert-radio-table ()
4676 "Insert a radio table template appropriate for this major mode."
4677 (interactive)
4678 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4679 (txt (nth 1 e))
4680 name pos)
4681 (unless e (user-error "No radio table setup defined for %s" major-mode))
4682 (setq name (read-string "Table name: "))
4683 (while (string-match "%n" txt)
4684 (setq txt (replace-match name t t txt)))
4686 (setq pos (point))
4687 (insert txt)
4688 (goto-char pos)))
4690 ;;;###autoload
4691 (defun orgtbl-to-generic (table params)
4692 "Convert the orgtbl-mode TABLE to some other format.
4694 This generic routine can be used for many standard cases.
4696 TABLE is a list, each entry either the symbol `hline' for
4697 a horizontal separator line, or a list of fields for that
4698 line. PARAMS is a property list of parameters that can
4699 influence the conversion.
4701 Valid parameters are:
4703 :backend, :raw
4705 Export back-end used as a basis to transcode elements of the
4706 table, when no specific parameter applies to it. It is also
4707 used to translate cells contents. You can prevent this by
4708 setting :raw property to a non-nil value.
4710 :splice
4712 When non-nil, only convert rows, not the table itself. This is
4713 equivalent to setting to the empty string both :tstart
4714 and :tend, which see.
4716 :skip
4718 When set to an integer N, skip the first N lines of the table.
4719 Horizontal separation lines do count for this parameter!
4721 :skipcols
4723 List of columns that should be skipped. If the table has
4724 a column with calculation marks, that column is automatically
4725 discarded beforehand.
4727 :hline
4729 String to be inserted on horizontal separation lines. May be
4730 nil to ignore these lines altogether.
4732 :sep
4734 Separator between two fields, as a string.
4736 Each in the following group may be either a string or a function
4737 of no arguments returning a string:
4739 :tstart, :tend
4741 Strings to start and end the table. Ignored when :splice is t.
4743 :lstart, :lend
4745 Strings to start and end a new table line.
4747 :llstart, :llend
4749 Strings to start and end the last table line. Default,
4750 respectively, to :lstart and :lend.
4752 Each in the following group may be a string or a function of one
4753 argument (either the cells in the current row, as a list of
4754 strings, or the current cell) returning a string:
4756 :lfmt
4758 Format string for an entire row, with enough %s to capture all
4759 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4761 :llfmt
4763 Format for the entire last line, defaults to :lfmt.
4765 :fmt
4767 A format to be used to wrap the field, should contain %s for
4768 the original field value. For example, to wrap everything in
4770 a property list with column numbers and format strings, or
4771 functions, e.g.,
4775 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4777 Same as above, specific for the header lines in the table.
4778 All lines before the first hline are treated as header. If
4779 any of these is not present, the data line value is used.
4781 This may be either a string or a function of two arguments:
4783 :efmt
4785 Use this format to print numbers with exponential. The format
4786 should have %s twice for inserting mantissa and exponent, for
4788 list with column numbers and format strings or functions.
4789 :fmt will still be applied after :efmt."
4790 (let ((backend (plist-get params :backend))
4791 ;; Disable user-defined export filters and hooks.
4792 (org-export-filters-alist nil)
4793 (org-export-before-parsing-hook nil)
4794 (org-export-before-processing-hook nil))
4795 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4796 (user-error "Unknown :backend value"))
4797 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4798 (org-trim
4799 (org-export-string-as
4800 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4801 (with-output-to-string
4802 (dolist (e table)
4804 ((consp e)
4805 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4807 ;; Build a custom back-end according to PARAMS. Before defining
4808 ;; a translator, check if there is anything to do. When there
4809 ;; isn't, let BACKEND handle the element.
4810 (org-export-create-backend
4811 :parent (or backend 'org)
4812 :filters
4813 '((:filter-parse-tree
4814 ;; Handle :skip parameter.
4815 (lambda (tree backend info)
4816 (let ((skip (plist-get info :skip)))
4817 (when skip
4818 (unless (wholenump skip) (user-error "Wrong :skip value"))
4819 (let ((n 0))
4820 (org-element-map tree 'table-row
4821 (lambda (row)
4822 (if (>= n skip) t
4823 (org-element-extract-element row)
4824 (incf n)
4825 nil))
4826 info t))
4827 tree)))
4828 ;; Handle :skipcols parameter.
4829 (lambda (tree backend info)
4830 (let ((skipcols (plist-get info :skipcols)))
4831 (when skipcols
4832 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4833 (org-element-map tree 'table
4834 (lambda (table)
4835 (let ((specialp
4836 (org-export-table-has-special-column-p table)))
4837 (dolist (row (org-element-contents table))
4838 (when (eq (org-element-property :type row) 'standard)
4839 (let ((c 1))
4840 (dolist (cell (nthcdr (if specialp 1 0)
4841 (org-element-contents row)))
4842 (when (memq c skipcols)
4843 (org-element-extract-element cell))
4844 (incf c)))))))
4845 info)
4846 tree)))))
4847 :transcoders
4848 `((table . ,(org-table--to-generic-table params))
4849 (table-row . ,(org-table--to-generic-row params))
4850 (table-cell . ,(org-table--to-generic-cell params))
4851 ;; Section. Return contents to avoid garbage around table.
4852 (section . (lambda (s c i) c))))
4853 'body-only (org-combine-plists params '(:with-tables t))))))
4855 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4856 (cond ((null value) nil)
4857 ((functionp value) `(funcall ',value ,@args))
4858 ((stringp value)
4859 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4860 (args `(format ,value ,@args))
4861 (t value)))
4862 ((and with-cons (consp value))
4863 `(let ((val (cadr (memq column ',value))))
4864 (cond ((null val) contents)
4865 ((stringp val) (format val ,@args))
4866 ((functionp val) (funcall val ,@args))
4867 (t (user-error "Wrong %s value" ,name)))))
4868 (t (user-error "Wrong %s value" name))))
4870 (defun org-table--to-generic-table (params)
4871 "Return custom table transcoder according to PARAMS.
4872 PARAMS is a plist. See `orgtbl-to-generic' for more
4873 information."
4874 (let ((backend (plist-get params :backend))
4875 (splice (plist-get params :splice))
4876 (tstart (plist-get params :tstart))
4877 (tend (plist-get params :tend)))
4878 `(lambda (table contents info)
4879 (concat
4880 ,(and tstart (not splice)
4882 ,(if (or (not backend) tstart tend splice) 'contents
4883 `(org-export-with-backend ',backend table contents info))
4884 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4886 (defun org-table--to-generic-row (params)
4887 "Return custom table row transcoder according to PARAMS.
4888 PARAMS is a plist. See `orgtbl-to-generic' for more
4889 information."
4890 (let* ((backend (plist-get params :backend))
4891 (lstart (plist-get params :lstart))
4892 (llstart (plist-get params :llstart))
4893 (hlstart (plist-get params :hlstart))
4894 (hllstart (plist-get params :hllstart))
4895 (lend (plist-get params :lend))
4896 (llend (plist-get params :llend))
4897 (hlend (plist-get params :hlend))
4898 (hllend (plist-get params :hllend))
4899 (lfmt (plist-get params :lfmt))
4900 (llfmt (plist-get params :llfmt))
4901 (hlfmt (plist-get params :hlfmt))
4902 (hllfmt (plist-get params :hllfmt)))
4903 `(lambda (row contents info)
4904 (if (eq (org-element-property :type row) 'rule)
4905 ,(cond
4906 ((plist-member params :hline)
4907 (org-table--generic-apply (plist-get params :hline) ":hline"))
4908 (backend `(org-export-with-backend ',backend row nil info)))
4909 (let ((headerp (org-export-table-row-in-header-p row info))
4910 (lastp (not (org-export-get-next-element row info)))
4911 (last-header-p (org-export-table-row-ends-header-p row info)))
4912 (when contents
4913 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4914 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4915 ;; `:lstart', `:lend' and their relatives.
4916 ,(let ((cells
4917 '(org-element-map row 'table-cell
4918 (lambda (cell)
4919 ;; Export all cells, without separators.
4920 ;;
4921 ;; Use `org-export-data-with-backend'
4922 ;; instead of `org-export-data' to eschew
4923 ;; cached values, which
4924 ;; ignore :orgtbl-ignore-sep parameter.
4925 (org-export-data-with-backend
4926 cell
4927 (plist-get info :back-end)
4928 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4929 info)))
4930 `(cond
4931 ,(and hllfmt
4932 `(last-header-p ,(org-table--generic-apply
4933 hllfmt ":hllfmt" nil cells)))
4934 ,(and hlfmt
4935 `(headerp ,(org-table--generic-apply
4936 hlfmt ":hlfmt" nil cells)))
4937 ,(and llfmt
4938 `(lastp ,(org-table--generic-apply
4939 llfmt ":llfmt" nil cells)))
4940 (t
4941 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4942 `(concat
4943 (cond
4944 ,(and
4945 (or hllstart hllend)
4946 `(last-header-p
4947 (concat
4948 ,(org-table--generic-apply hllstart ":hllstart")
4949 contents
4950 ,(org-table--generic-apply hllend ":hllend"))))
4951 ,(and
4952 (or hlstart hlend)
4953 `(headerp
4954 (concat
4955 ,(org-table--generic-apply hlstart ":hlstart")
4956 contents
4957 ,(org-table--generic-apply hlend ":hlend"))))
4958 ,(and
4959 (or llstart llend)
4960 `(lastp
4961 (concat
4962 ,(org-table--generic-apply llstart ":llstart")
4963 contents
4964 ,(org-table--generic-apply llend ":llend"))))
4965 (t
4966 ,(cond
4967 ((or lstart lend)
4968 `(concat
4969 ,(org-table--generic-apply lstart ":lstart")
4970 contents
4971 ,(org-table--generic-apply lend ":lend")))
4972 (backend
4973 `(org-export-with-backend
4974 ',backend row contents info))
4975 (t 'contents)))))))))))))))
4977 (defun org-table--to-generic-cell (params)
4978 "Return custom table cell transcoder according to PARAMS.
4979 PARAMS is a plist. See `orgtbl-to-generic' for more
4980 information."
4981 (let* ((backend (plist-get params :backend))
4982 (efmt (plist-get params :efmt))
4983 (fmt (plist-get params :fmt))
4984 (hfmt (plist-get params :hfmt))
4985 (sep (plist-get params :sep))
4986 (hsep (plist-get params :hsep)))
4987 `(lambda (cell contents info)
4988 (let ((headerp (org-export-table-row-in-header-p
4989 (org-export-get-parent-element cell) info))
4990 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4991 ;; Make sure that contents are exported as Org data when :raw
4992 ;; parameter is non-nil.
4993 ,(when (and backend (plist-get params :raw))
4994 `(setq contents
4995 ;; Since we don't know what are the pseudo object
4996 ;; types defined in backend, we cannot pass them to
4997 ;; `org-element-interpret-data'. As a consequence,
4998 ;; they will be treated as pseudo elements, and
4999 ;; will have newlines appended instead of spaces.
5000 ;; Therefore, we must make sure :post-blank value
5001 ;; is really turned into spaces.
5002 (replace-regexp-in-string
5004 (org-trim
5005 (org-element-interpret-data
5006 (org-element-contents cell))))))
5007 (when contents
5008 ;; Check if we can apply `:efmt' on CONTENTS.
5009 ,(when efmt
5010 `(when (string-match orgtbl-exp-regexp contents)
5011 (let ((mantissa (match-string 1 contents))
5012 (exponent (match-string 2 contents)))
5013 (setq contents ,(org-table--generic-apply
5014 efmt ":efmt" t 'mantissa 'exponent)))))
5015 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5016 (cond
5017 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5018 hfmt ":hfmt" t 'contents))))
5019 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5020 fmt ":fmt" t 'contents))))))
5021 ;; If a separator is provided, use it instead of BACKEND's.
5022 ;; Separators are ignored when LFMT (or equivalent) is
5023 ;; provided.
5024 ,(cond
5025 ((or hsep sep)
5026 `(if (or ,(and (not sep) '(not headerp))
5027 (plist-get info :orgtbl-ignore-sep)
5028 (not (org-export-get-next-element cell info)))
5029 ,(if (not backend) 'contents
5030 `(org-export-with-backend ',backend cell contents info))
5031 (concat contents
5032 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5033 (or hsep sep)))))
5034 (backend `(org-export-with-backend ',backend cell contents info))
5035 (t 'contents))))))
5037 ;;;###autoload
5038 (defun orgtbl-to-tsv (table params)
5039 "Convert the orgtbl-mode table to TAB separated material."
5042 ;;;###autoload
5043 (defun orgtbl-to-csv (table params)
5044 "Convert the orgtbl-mode table to CSV material.
5045 This does take care of the proper quoting of fields with comma or quotes."
5046 (orgtbl-to-generic table
5047 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5048 params)))
5050 ;;;###autoload
5051 (defun orgtbl-to-latex (table params)
5052 "Convert the orgtbl-mode TABLE to LaTeX.
5054 TABLE is a list, each entry either the symbol `hline' for
5055 a horizontal separator line, or a list of fields for that line.
5056 PARAMS is a property list of parameters that can influence the
5057 conversion. All parameters from `orgtbl-to-generic' are
5058 supported. It is also possible to use the following ones:
5060 :booktabs
5064 :environment
5066 Specify environment to use, as a string. If you use
5068 as a string, to get proper continuation strings."
5069 (require 'ox-latex)
5070 (orgtbl-to-generic
5071 table
5072 (org-combine-plists
5073 ;; Provide sane default values.
5074 (list :backend 'latex
5075 :latex-default-table-mode 'table
5076 :latex-tables-centered nil
5077 :latex-tables-booktabs (plist-get params :booktabs)
5078 :latex-table-scientific-notation nil
5079 :latex-default-table-environment
5080 (or (plist-get params :environment) "tabular"))
5081 params)))
5083 ;;;###autoload
5084 (defun orgtbl-to-html (table params)
5085 "Convert the orgtbl-mode TABLE to HTML.
5087 TABLE is a list, each entry either the symbol `hline' for
5088 a horizontal separator line, or a list of fields for that line.
5089 PARAMS is a property list of parameters that can influence the
5090 conversion. All parameters from `orgtbl-to-generic' are
5091 supported. It is also possible to use the following one:
5093 :attributes
5095 Attributes and values, as a plist, which will be used in
5096 <table> tag."
5097 (require 'ox-html)
5098 (orgtbl-to-generic
5099 table
5100 (org-combine-plists
5101 ;; Provide sane default values.
5102 (list :backend 'html
5103 :html-table-data-tags '("<td%s>" . "</td>")
5104 :html-table-use-header-tags-for-first-column nil
5105 :html-table-align-individual-fields t
5106 :html-table-row-tags '("<tr>" . "</tr>")
5107 :html-table-attributes
5108 (if (plist-member params :attributes)
5109 (plist-get params :attributes)
5110 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5111 :frame "hsides")))
5112 params)))
5114 ;;;###autoload
5115 (defun orgtbl-to-texinfo (table params)
5116 "Convert the orgtbl-mode TABLE to Texinfo.
5118 TABLE is a list, each entry either the symbol `hline' for
5119 a horizontal separator line, or a list of fields for that line.
5120 PARAMS is a property list of parameters that can influence the
5121 conversion. All parameters from `orgtbl-to-generic' are
5122 supported. It is also possible to use the following one:
5124 :columns
5126 Column widths, as a string. When providing column fractions,
5128 (require 'ox-texinfo)
5129 (let ((output
5130 (orgtbl-to-generic
5131 table
5132 (org-combine-plists
5133 (list :backend 'texinfo
5134 :texinfo-tables-verbatim nil
5135 :texinfo-table-scientific-notation nil)
5136 params)))
5137 (columns (let ((w (plist-get params :columns)))
5138 (cond ((not w) nil)
5140 (t (concat "@columnfractions " w))))))
5141 (if (not columns) output
5142 (replace-regexp-in-string
5145 ;;;###autoload
5146 (defun orgtbl-to-orgtbl (table params)
5147 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5149 TABLE is a list, each entry either the symbol `hline' for
5150 a horizontal separator line, or a list of fields for that line.
5151 PARAMS is a property list of parameters that can influence the
5152 conversion. All parameters from `orgtbl-to-generic' are
5153 supported.
5155 Useful when slicing one table into many. The :hline, :sep,
5156 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5157 be set to provide ORGTBL directives for the generated table."
5158 (require 'ox-org)
5159 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5161 (defun orgtbl-to-table.el (table params)
5162 "Convert the orgtbl-mode TABLE into a table.el table.
5163 TABLE is a list, each entry either the symbol `hline' for
5164 a horizontal separator line, or a list of fields for that line.
5165 PARAMS is a property list of parameters that can influence the
5166 conversion. All parameters from `orgtbl-to-generic' are
5167 supported."
5168 (with-temp-buffer
5169 (insert (orgtbl-to-orgtbl table params))
5170 (org-table-align)
5171 (replace-regexp-in-string
5172 "-|" "-+"
5173 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5175 (defun orgtbl-to-unicode (table params)
5176 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5178 TABLE is a list, each entry either the symbol `hline' for
5179 a horizontal separator line, or a list of fields for that line.
5180 PARAMS is a property list of parameters that can influence the
5181 conversion. All parameters from `orgtbl-to-generic' are
5182 supported. It is also possible to use the following ones:
5184 :ascii-art
5187 the table. You can download it here:
5188 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5190 :narrow
5192 When non-nil, narrow columns width than provided width cookie,
5194 (require 'ox-ascii)
5195 (orgtbl-to-generic
5196 table
5197 (org-combine-plists
5198 (list :backend 'ascii
5199 :ascii-charset 'utf-8
5200 :ascii-table-widen-columns (not (plist-get params :narrow))
5201 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5202 params)))
5204 ;; Put the cursor in a column containing numerical values
5205 ;; of an Org-Mode table,
5206 ;; type C-c " a
5207 ;; A new column is added with a bar plot.
5208 ;; When the table is refreshed (C-u C-c *),
5209 ;; the plot is updated to reflect the new values.
5211 (defun orgtbl-ascii-draw (value min max &optional width characters)
5212 "Draw an ascii bar in a table.
5213 VALUE is a the value to plot, the width of the bar to draw. A
5214 value equal to MIN will be displayed as empty (zero width bar).
5215 A value equal to MAX will draw a bar filling all the WIDTH.
5216 WIDTH is the expected width in characters of the column.
5217 CHARACTERS is a string that will compose the bar, with shades of
5218 grey from pure white to pure black. It defaults to a 10
5219 characters string of regular ascii characters."
5220 (let* ((characters (or characters " .:;c!lhVHW"))
5221 (width (or width 12))
5222 (value (if (numberp value) value (string-to-number value)))
5223 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5224 (cond
5225 ((< value 0) "too small")
5226 ((> value width) "too large")
5227 (t
5228 (let ((len (1- (length characters))))
5229 (concat
5230 (make-string (floor value) (elt characters len))
5231 (string (elt characters
5232 (floor (* (- value (floor value)) len))))))))))
5234 ;;;###autoload
5235 (defun orgtbl-ascii-plot (&optional ask)
5236 "Draw an ascii bar plot in a column.
5237 With cursor in a column containing numerical values, this
5238 function will draw a plot in a new column.
5239 ASK, if given, is a numeric prefix to override the default 12
5240 characters width of the plot. ASK may also be the
5242 (interactive "P")
5243 (let ((col (org-table-current-column))
5244 (min 1e999) ; 1e999 will be converted to infinity
5245 (max -1e999) ; which is the desired result
5246 (table (org-table-to-lisp))
5247 (length
5248 (cond ((consp ask)
5249 (read-number "Length of column " 12))
5250 ((numberp ask) ask)
5251 (t 12))))
5252 ;; Skip any hline a the top of table.
5253 (while (eq (car table) 'hline) (setq table (cdr table)))
5254 ;; Skip table header if any.
5255 (dolist (x (or (cdr (memq 'hline table)) table))
5256 (when (consp x)
5257 (setq x (nth (1- col) x))
5258 (when (string-match
5260 x)
5261 (setq x (string-to-number x))
5262 (when (> min x) (setq min x))
5263 (when (< max x) (setq max x)))))
5264 (org-table-insert-column)
5265 (org-table-move-column-right)
5266 (org-table-store-formulas
5267 (cons
5268 (cons
5269 (number-to-string (1+ col))
5270 (format "'(%s $%s %s %s %s)"
5271 "orgtbl-ascii-draw" col min max length))
5272 (org-table-get-stored-formulas)))
5273 (org-table-recalculate t)))
5275 ;; Example of extension: unicode characters
5276 ;; Here are two examples of different styles.
5278 ;; Unicode block characters are used to give a smooth effect.
5279 ;; See http://en.wikipedia.org/wiki/Block_Elements
5280 ;; Use one of those drawing functions
5281 ;; - orgtbl-ascii-draw (the default ascii)
5282 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5283 ;; - orgtbl-uc-draw-cont (smooth unicode)
5285 ;; This is best viewed with the "DejaVu Sans Mono" font
5286 ;; (use M-x set-default-font).
5288 (defun orgtbl-uc-draw-grid (value min max &optional width)
5289 "Draw a bar in a table using block unicode characters.
5290 It is a variant of orgtbl-ascii-draw with Unicode block
5291 characters, for a smooth display. Bars appear as grids (to the
5292 extent the font allows)."
5293 ;; http://en.wikipedia.org/wiki/Block_Elements
5294 ;; best viewed with the "DejaVu Sans Mono" font.
5295 (orgtbl-ascii-draw value min max width
5298 (defun orgtbl-uc-draw-cont (value min max &optional width)
5299 "Draw a bar in a table using block unicode characters.
5300 It is a variant of orgtbl-ascii-draw with Unicode block
5301 characters, for a smooth display. Bars are solid (to the extent
5302 the font allows)."
5303 (orgtbl-ascii-draw value min max width
5306 (defun org-table-get-remote-range (name-or-id form)
5307 "Get a field value or a list of values in a range from table at ID.
5309 NAME-OR-ID may be the name of a table in the current file as set
5311 will then be used. Alternatively, it may be an ID referring to
5312 any entry, also in a different file. In this case, the first
5313 table in that entry will be referenced.
5317 The return value is either a single string for a single field, or a
5318 list of the fields in the rectangle."
5319 (save-match-data
5320 (let ((case-fold-search t) (id-loc nil)
5321 ;; Protect a bunch of variables from being overwritten
5322 ;; by the context of the remote table
5323 org-table-column-names org-table-column-name-regexp
5324 org-table-local-parameters org-table-named-field-locations
5325 org-table-current-line-types org-table-current-begin-line
5326 org-table-current-begin-pos org-table-dlines
5327 org-table-current-ncol
5328 org-table-hlines org-table-last-alignment
5329 org-table-last-column-widths org-table-last-alignment
5330 org-table-last-column-widths tbeg
5331 buffer loc)
5332 (setq form (org-table-convert-refs-to-rc form))
5333 (save-excursion
5334 (save-restriction
5335 (widen)
5336 (save-excursion
5337 (goto-char (point-min))
5338 (if (re-search-forward
5341 nil t)
5342 (setq buffer (current-buffer) loc (match-beginning 0))
5343 (setq id-loc (org-id-find name-or-id 'marker))
5344 (unless (and id-loc (markerp id-loc))
5346 (setq buffer (marker-buffer id-loc)
5347 loc (marker-position id-loc))
5348 (move-marker id-loc nil)))
5349 (with-current-buffer buffer
5350 (save-excursion
5351 (save-restriction
5352 (widen)
5353 (goto-char loc)
5354 (forward-char 1)
5356 (not (match-beginning 1)))
5357 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5358 (setq tbeg (point-at-bol))
5359 (org-table-get-specials)
5360 (setq form (org-table-formula-substitute-names
5361 (org-table-formula-handle-first/last-rc form)))
5362 (if (and (string-match org-table-range-regexp form)
5363 (> (length (match-string 0 form)) 1))
5364 (save-match-data
5365 (org-table-get-range (match-string 0 form) tbeg 1))
5366 form)))))))))
5368 (defun org-table-remote-reference-indirection (form)
5369 "Return formula with table remote references substituted by indirection.
5371 This indirection works only with the format @ROW$COLUMN. The
5373 distinguished from a plain table name or ID."
5374 (let ((start 0))
5375 (while (string-match (concat
5376 ;; Same as in `org-table-eval-formula'.
5378 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5380 ;; Same as in `org-table-eval-formula'.
5382 form
5383 start)
5384 ;; The position of the character as far as possible to the right
5385 ;; that will not be replaced and particularly not be shifted by
5386 ;; `replace-match'.
5387 (setq start (match-beginning 1))
5388 ;; Substitute the remote reference with the value found in the
5389 ;; field.
5390 (setq form
5391 (replace-match
5392 (save-match-data
5393 (org-table-get-range (org-table-formula-handle-first/last-rc
5394 (match-string 1 form))))
5395 t t form 1))))
5396 form)
5398 (defmacro org-define-lookup-function (mode)
5399 (let ((mode-str (symbol-name mode))
5400 (first-p (equal mode 'first))
5401 (all-p (equal mode 'all)))
5402 (let ((plural-str (if all-p "s" "")))
5403 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5404 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5405 If R-LIST is nil, return matching element%s of S-LIST.
5406 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5407 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5408 This function is generated by a call to the macro `org-define-lookup-function'."
5409 mode-str plural-str plural-str plural-str)
5410 (let ,(let ((lvars '((p (or predicate 'equal))
5411 (sl s-list)
5412 (rl (or r-list s-list))
5413 (ret nil))))
5414 (if first-p (add-to-list 'lvars '(match-p nil)))
5415 lvars)
5416 (while ,(if first-p '(and (not match-p) sl) 'sl)
5417 (progn
5418 (if (funcall p val (car sl))
5419 (progn
5420 ,(if first-p '(setq match-p t))
5421 (let ((rval (car rl)))
5422 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5423 (setq sl (cdr sl) rl (cdr rl))))
5424 ret)))))
5426 (org-define-lookup-function first)
5427 (org-define-lookup-function last)
5428 (org-define-lookup-function all)
5430 (provide 'org-table)
5432 ;; Local variables:
5433 ;; generated-autoload-file: "org-loaddefs.el"
5434 ;; End:
5436 ;;; org-table.el ends here