| blob | 6b33edaf4cdf327b90da43a7d82f57f93eb18c13 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2014 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))
943 ;;;###autoload
945 "Justify the current field, text to left, number to right.
946 Optional argument NEW may specify text to replace the current field content."
955 ;; This is not the same table, force a full re-align
961 l f n o e)
987 ;;;###autoload
989 "Go to the next field in the current table, creating new lines as needed.
990 Before doing so, re-align the table if necessary."
995 org-table-may-need-update)
1006 org-table-tab-jumps-over-hlines
1017 ;;;###autoload
1019 "Go to the previous field in the table.
1020 Before doing so, re-align the table if necessary."
1025 org-table-may-need-update)
1040 "Move to the end of the current table field.
1041 If already at or after the end, move to the end of the next table field.
1042 With numeric argument N, move N-1 fields forward first."
1055 "Move to the beginning of the current table field.
1056 If already at or before the beginning, move to the beginning of the
1057 previous field.
1058 With numeric argument N, move N-1 fields backward first."
1071 ;;;###autoload
1073 "Go to the next row (same column) in the current table.
1074 Before doing so, re-align the table if necessary."
1082 org-table-may-need-update)
1095 ;;;###autoload
1097 "Copy the value of the current field one row below.
1099 If the field at the cursor is empty, copy the content of the
1100 nearest non-empty field above. With argument N, use the Nth
1101 non-empty field.
1103 If the current field is not empty, it is copied down to the next
1104 row, and the cursor is moved with it. Therefore, repeating this
1105 command causes the column to be filled row-by-row.
1107 If the variable `org-table-copy-increment' is non-nil and the
1108 field is an integer or a timestamp, it will be incremented while
1109 copying. By default, increment by the difference between the
1110 value in the current field and the one in the field above. To
1111 increment using a fixed integer, set `org-table-copy-increment'
1112 to a number. In the case of a timestamp, increment by days."
1124 txt txt-up inc)
1132 beg t))
1142 beg t))
1149 ;; Above field was not empty, go down to the next row
1182 "Is point inside a table data field?
1183 I.e. not on a hline or before the first or after the last column?
1184 This actually throws an error, so it aborts the current command."
1190 nil
1192 t))
1198 "Get the field in table line LINE, column COLUMN.
1199 If LINE is larger than the number of data lines in the table, the function
1200 returns nil. However, if COLUMN is too large, we will simply return an
1201 empty string.
1202 If LINE is nil, use the current line.
1203 If COLUMN is nil, use the current column."
1210 "Put VALUE into line LINE, column COLUMN.
1211 When ALIGN is set, also realign the table."
1220 "Return the index of the current data line."
1227 cnt))
1230 "Go to the Nth data line in the current table.
1231 Return t when the line exists, nil if it does not exist."
1238 ;;;###autoload
1240 "Blank the current table field or active region."
1257 "Return the value of the field in column N of current row.
1258 N defaults to current field.
1259 If REPLACE is a string, replace field with this value. The return value
1260 is always the old value."
1269 t t))
1271 val)
1274 ;;;###autoload
1276 "Show info about the current field, and highlight any reference at point."
1285 org-table-named-field-locations)))
1305 dline col
1307 dline col ref1
1309 ;; FIXME: formula info not correct if special table line
1319 "Find out which column we are in."
1329 cnt)))
1331 ;;;###autoload
1333 "Find out what table data line we are in.
1334 Only data lines count for this."
1346 cnt)))
1348 ;;;###autoload
1350 "Move the cursor to the Nth column in the current table line.
1351 With optional argument ON-DELIM, stop with point before the left delimiter
1352 of the field.
1353 If there are less than N fields, just go to after the last delimiter.
1354 However, when FORCE is non-nil, create new columns if necessary."
1364 t)))))
1371 ;;;###autoload
1373 "Insert a new column into the table."
1381 ;; Current cursor position
1387 nil
1401 "Find a data line in the current table, which is needed for column commands."
1404 t
1415 t
1420 "Turn a buffer line number into a data line number.
1421 If there is no data line in this line, return nil.
1422 If there is no matching dline (most likely te reference was a hline), the
1423 first dline below it is used. When ABOVE is non-nil, the one above is used."
1426 i)
1439 nil))
1441 ;;;###autoload
1443 "Delete a column from the table."
1452 ;; Current cursor position
1458 nil
1474 ;;;###autoload
1476 "Move column to the right."
1479 ;;;###autoload
1481 "Move column to the left."
1485 ;;;###autoload
1487 "Move the current column to the right. With arg LEFT, move to the left."
1497 ;; Current cursor position
1507 nil
1525 ;;;###autoload
1527 "Move table row down."
1530 ;;;###autoload
1532 "Move table row up."
1536 ;;;###autoload
1538 "Move the current table line down. With arg UP, move it up."
1547 txt hline2p)
1570 ;;;###autoload
1572 "Insert a new row above the current line into the table.
1573 With prefix ARG, insert below the current line."
1579 ;; Fix the first field if necessary
1592 ;;;###autoload
1594 "Insert a horizontal-line below the current line into the table.
1595 With prefix ABOVE, insert above the current line."
1616 ;;;###autoload
1618 "Insert a hline and move to the row below that line."
1632 In particular, this does handle wide and invisible characters."
1634 ;; It's a hline, just map the characters
1640 t t s)))
1641 s))
1643 ;;;###autoload
1645 "Delete the current row or horizontal line from the table."
1659 ;;;###autoload
1661 "Sort table lines according to the column at point.
1663 The position of point indicates the column to be used for
1664 sorting, and the range of lines is the range between the nearest
1665 horizontal separator lines, or the entire table of no such lines
1666 exist. If point is before the first column, you will be prompted
1667 for the sorting column. If there is an active region, the mark
1668 specifies the first line and the sorting column, while point
1669 should be in the last line to be included into the sorting.
1671 The command then prompts for the sorting type which can be
1672 alphabetically, numerically, or by time (as given in a time stamp
1673 in the field, or as a HH:MM value). Sorting in reverse order is
1674 also possible.
1676 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1678 If SORTING-TYPE is specified when this function is called from a Lisp
1679 program, no prompting will take place. SORTING-TYPE must be a character,
1680 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1681 sorting should be done in reverse order.
1683 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1684 a function to be called to extract the key. It must return either
1685 a string or a number that should serve as the sorting key for that
1686 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1687 is specified interactively, the comparison will be either a string or
1688 numeric compare based on the type of the first key in the table."
1693 beg end bcol ecol tend tbeg column lns pos)
1738 x))
1753 (defun org-table--do-sort (table what &optional with-case sorting-type getkey-func compare-func)
1754 "Sort TABLE of WHAT according to SORTING-TYPE.
1755 The user will be prompted for the SORTING-TYPE if the call to this
1756 function does not specify it.
1757 WHAT is only for the prompt, to indicate what is being sorted.
1758 The sorting key will be extracted from the car of the elements of
1759 the table. If WITH-CASE is non-nil, the sorting will be case-sensitive.
1761 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1762 a function to be called to extract the key. It must return either
1763 a string or a number that should serve as the sorting key for that
1764 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1765 is specified interactively, the comparison will be either a string or
1766 numeric compare based on the type of the first key in the table."
1769 "Sort %s: [a]lphabetic, [n]umeric, [t]ime, [f]unc. A/N/T/F means reversed:"
1770 what)
1773 ;; Define the appropriate functions
1796 "Sort using function: "
1801 tempfun))
1812 table)
1815 ;;;###autoload
1817 "Copy region in table to the clipboard and blank all relevant fields.
1818 If there is no active region, use just the field at point."
1824 ;;;###autoload
1826 "Copy rectangular region in table to clipboard.
1827 A special clipboard is used which can only be accessed
1828 with `org-table-paste-rectangle'."
1832 current-prefix-arg))
1834 region cols
1860 org-table-clip))
1862 ;;;###autoload
1864 "Paste a rectangular region into a table.
1865 The upper right corner ends up in the current field. All involved fields
1866 will be overwritten. If the rectangle does not fit into the present table,
1867 the table is enlarged as needed. The process ignores horizontal separator
1868 lines."
1878 c cols field)
1893 ;;;###autoload
1895 "Convert from `org-mode' table to table.el and back.
1896 Obviously, this only works within limits. When an Org-mode table is
1897 converted to table.el, all horizontal separator lines get lost, because
1898 table.el uses these as cell boundaries and has no notion of horizontal lines.
1899 A table.el table can be converted to an Org-mode table only if it does not
1900 do row or column spanning. Multiline cells will become multiple cells.
1901 Beware, Org-mode does not test if the table can be successfully converted - it
1902 blindly applies a recipe that works for simple tables."
1906 ;; convert to Org-mode table
1915 ;; convert to table.el table
1918 ;; first, get rid of all horizontal lines
1922 ;; insert a hline before first
1926 ;; insert a hline after each line
1931 ;; replace "+" at beginning and ending of hlines
1940 "Transpose Org table at point and eliminate hlines.
1941 So a table like
1943 | 1 | 2 | 4 | 5 |
1944 |---+---+---+---|
1945 | a | b | c | d |
1946 | e | f | g | h |
1948 will be transposed as
1950 | 1 | a | e |
1951 | 2 | b | f |
1952 | 4 | c | g |
1953 | 5 | d | h |
1955 Note that horizontal lines disappear."
1967 table)))
1981 ;;;###autoload
1983 "Wrap several fields in a column like a paragraph.
1984 This is useful if you'd like to spread the contents of a field over several
1985 lines, in order to keep the table compact.
1987 If there is an active region, and both point and mark are in the same column,
1988 the text in the column is wrapped to minimum width for the given number of
1989 lines. Generally, this makes the table more compact. A prefix ARG may be
1991 formats the selected text to two lines. If the region was longer than two
1992 lines, the remaining lines remain empty. A negative prefix argument reduces
1993 the current number of lines by that amount. The wrapped text is pasted back
1994 into the table. If you formatted it to more lines than it was before, fields
1995 further down in the table get overwritten - so you might need to make space in
1996 the table first.
1998 If there is no region, the current field is split at the cursor position and
1999 the text fragment to the right of the cursor is prepended to the field one
2000 line down.
2002 If there is no region, but you specify a prefix ARG, the current field gets
2003 blank, and the content is appended to the field above."
2007 ;; There is a region: fill as a paragraph
2011 nlines)
2018 arg)
2022 nil nlines)))
2026 ;; No region, split the current field at point
2030 ;; combine with field above
2040 ;; split field
2052 ;;;###autoload
2054 "Edit table field in a different window.
2055 This is mainly useful for fields that contain hidden parts.
2057 it can be edited in place."
2066 display t intangible t))
2079 p)
2095 intangible t))
2103 "Finish editing a table data field.
2104 Remove all newline characters, insert the result into the table, realign
2105 the table and kill the editing buffer."
2109 text)
2126 "Minor mode to make the table field editor window follow the cursor.
2127 When this mode is active, the field editor window will always show the
2128 current field. The mode exits automatically when the cursor leaves the
2129 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2130 nil " TblFollow" nil
2146 ;; We have left the table, exit the follow mode
2156 ;;;###autoload
2158 "Sum numbers in region of current table column.
2159 The result will be displayed in the echo area, and will be available
2162 If there is an active region, it is interpreted as a rectangle and all
2163 numbers in that rectangle will be summed. If there is no active
2164 region and point is located in a table column, sum all numbers in that
2165 column.
2167 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2168 numbers are assumed to be times as well (in decimal hours) and the
2169 numbers are added as such.
2171 If NLAST is a number, only the NLAST fields will actually be summed."
2198 items1)))
2205 s diff)
2213 sres))))
2236 "Return the formula active for the current field.
2237 Assumes that specials are in place.
2238 If KEY is given, return the key to this formula.
2242 org-table-named-field-locations)))
2256 "Read a formula from the minibuffer, offer stored formula as default.
2257 When NAMED is non-nil, look for a named equation."
2261 org-table-named-field-locations)))
2268 name
2269 ref)
2279 stored)
2281 equation)
2288 scol))
2290 'org-table-formula-history
2291 )))))
2292 mustsave)
2294 ;; remove formula
2301 ;; We set the column equation, delete the named one.
2303 mustsave t))
2309 eq))
2312 "Store the list of formulas below the current table."
2319 ;; don't overwrite TBLFM, we might use text properties to store stuff
2335 ;; Fake a high number to make sure this is sorted at the end.
2342 a)
2352 "Compare two formulas for sorting."
2357 ;;;###autoload
2359 "Return an alist with the stored formulas directly after current table."
2368 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2387 "Modify the equations after the table structure has been edited.
2389 For all numbers larger than LIMIT, shift them by DELTA."
2401 s n a)
2407 "Change makes TBLFM term %s invalid, use undo to recover"
2423 "Get the column names and local parameters for this table."
2426 names name fields fields1 field cnt
2427 c v l line col types dlines hlines last-dline)
2429 org-table-local-parameters nil
2430 org-table-named-field-locations nil
2431 org-table-current-begin-line nil
2432 org-table-current-begin-pos nil
2433 org-table-current-line-types nil
2452 org-table-local-parameters))))
2468 ;; Analyse the line types
2472 l org-table-current-begin-line)
2489 al al2)
2499 ;;;###autoload
2502 If yes, store the formula and apply it."
2503 ;; We already know we are in a table. Get field will only return a formula
2504 ;; when appropriate. It might return a separator line, but no problem.
2507 named eq)
2518 "List of commands triggering the recalculation of a line.
2530 ;;;###autoload
2532 "Rotate the recalculation mark in the first column.
2533 If in any row, the first field is not consistent with a mark,
2534 insert a new column for the markers.
2535 When there is an active region, change all the lines in the region,
2536 after prompting for the marking character.
2537 After each change, a message will be displayed indicating the meaning
2538 of the new mark."
2553 epos new)
2560 newchar))
2592 ;;;###autoload
2594 "Recompute the current line if marked for it, and if we haven't just done it."
2614 org-tbl-calc-modes)
2616 ;;;###autoload
2618 suppress-align suppress-const
2619 suppress-store suppress-analysis)
2620 "Replace the table field value at the cursor by the result of a calculation.
2622 This function makes use of Dave Gillespie's Calc package, in my view the
2623 most exciting program ever written for GNU Emacs. So you need to have Calc
2624 installed in order to use this function.
2626 In a table, this command replaces the value in the current field with the
2628 formula, by storing it in a special line below the table. When called
2629 with a `C-u' prefix, the current field must be a named field, and the
2630 formula is installed as valid in only this specific field.
2632 When called with two `C-u' prefixes, insert the active equation
2633 for the field back into the current field, so that it can be
2635 to check the referenced fields.
2637 When called, the command first prompts for a formula, which is read in
2638 the minibuffer. Previously entered formulas are available through the
2639 history list, and the last used formula is offered as a default.
2640 These stored formulas are adapted correctly when moving, inserting, or
2641 deleting columns with the corresponding commands.
2643 The formula can be any algebraic expression understood by the Calc package.
2644 For details, see the Org-mode manual.
2646 This function can also be called from Lisp programs and offers
2647 additional arguments: EQUATION can be the formula to apply. If this
2648 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2649 used to speed-up recursive calls by by-passing unnecessary aligns.
2650 SUPPRESS-CONST suppresses the interpretation of constants in the
2651 formula, assuming that this has been done already outside the function.
2652 SUPPRESS-STORE means the formula should not be stored, either because
2653 it is already stored, or because it is a modified equation that should
2654 not overwrite the stored one."
2670 equation
2676 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2677 duration duration-output-format)
2678 ;; Parse the format string. Since we have a lot of modes, this is
2679 ;; a lot of work. However, I think calc still uses most of the time.
2692 'calc-float-format
2695 n))))
2699 duration-output-format nil
2703 duration-output-format org-table-duration-custom-format
2704 numbers t
2727 ;; replace fields with duration values if relevant
2731 fields)))
2737 x))
2738 fields)))
2744 ;; Insert row and column number of formula result field
2755 t t form)))
2757 ;; Check for old vertical references
2759 ;; Insert remote references
2772 rmtrng))
2773 keep-empty numbers lispp))
2774 t t form)))
2775 ;; Insert complex ranges
2783 ;; possibly handle durations
2788 formrg)
2789 keep-empty numbers lispp)))
2794 ;; Insert simple ranges
2803 keep-empty numbers lispp))
2804 t t form)))
2806 ;; Insert the references to fields in same row
2813 x keep-empty numbers lispp)))
2831 ;; Use <...> time-stamps so that Calc can handle them
2834 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2845 form
2852 duration-output-format)
2853 ev)))
2858 Orig: %s
2859 $xyz-> %s
2860 @r$c-> %s
2892 prop value)))
2895 "Get a calc vector from a column, according to descriptor DESC.
2896 Optional arguments TBEG and COL can give the beginning of the table and
2897 the current column, to avoid unnecessary parsing.
2899 HIGHLIGHT means just highlight the range.
2901 When CORNERS-ONLY is set, only return the corners of the range as
2902 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2903 in the buffer and column1 and column2 are table column numbers."
2910 beg end c1 c2 r1 r2 rangep tmp)
2927 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2934 ;; just one field
2941 ;; A range, return a vector
2942 ;; First sort the numbers to get a regular rectangle
2946 ;; Only return the corners of the range
2948 ;; Copy the range values into a list
2962 ;; return string representation of calc vector
2967 "Analyze descriptor DESC and retrieve the corresponding line number.
2968 The cursor is currently in line CLINE, the table begins in line BLINE,
2969 and TABLE is a vector with line types."
2977 ;; 1 2 3 4 5 6
2997 nil hn cline desc)))
3000 rel on cline desc)))
3004 "FIXME: Needs more documentation."
3017 nil))
3018 t)))
3022 desc cline)
3023 i)))
3030 "Convert list ELEMENTS to something appropriate to insert into formula.
3031 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3032 NUMBERS indicates that everything should be converted to numbers.
3033 LISPP non-nil means to return something appropriate for a Lisp
3034 list, 'literal is for the format specifier L."
3035 ;; Calc nan (not a number) is used for the conversion of the empty
3036 ;; field to a reference for several reasons: (i) It is accepted in a
3037 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3038 ;; (ii) In a single field (not in range) it can be distinguished
3039 ;; from "(nan)" which is the reference made from a single field
3040 ;; containing "nan".
3042 ;; field reference
3045 elements
3047 ""
3056 ;; range reference
3061 elements))))
3067 x
3075 x)
3077 elements
3081 "If there has been more than one second since T1, display message.
3082 ARGS are passed as arguments to the `message' function. Returns
3083 current time if a message is printed, otherwise returns T1. If
3084 T1 is nil, always messages."
3088 curtime)
3089 t1)))
3091 ;;;###autoload
3093 "Recalculate the current table line by applying all stored formulas.
3094 With prefix arg ALL, do this for all lines in the table.
3095 With the prefix argument ALL is `(16)' \
3097 it is the symbol `iterate', recompute the table until it no longer changes.
3098 If NOALIGN is not nil, do not re-align the table after the computations
3099 are done. This is typically used internally to save time, if it is
3100 known that the table will be realigned a little later anyway."
3117 seen-fields lhs1
3119 ;; Insert constants in all formulas
3139 eqlist))
3140 ;; Split the equation list
3146 ;; Expand ranges in lhs of formulas
3149 ;; Get the correct line range to process
3155 ;; This is a table with marked lines, compute selected lines
3157 ;; Move forward to the first non-header line
3167 ;; First find the named fields, and mark them untouchable.
3168 ;; Also check if several field/range formulas try to set the same field.
3187 name)))
3200 ;; Now evaluate the column formulas, but skip fields covered
3201 ;; by field formulas
3205 ;; Unprotected line, recalculate
3209 log-last-time
3221 ;; Now evaluate the field formulas
3241 t))
3256 log-first-time
3260 ;; back to initial position
3269 ;;;###autoload
3271 "Recalculate the table until it does not change anymore.
3272 The maximum number of iterations is 10, but you can choose a different value
3273 with the prefix ARG."
3278 thistbl)
3292 ;;;###autoload
3294 "Recalculate all tables in the current buffer."
3301 ;;;###autoload
3303 "Iterate all tables in the buffer, to converge inter-table dependencies."
3308 c1)
3324 "Apply the #+TBLFM in the line at point to the table."
3330 s e)
3332 ;; Insert a temporary formula at right after the table
3337 ;; Recalculate the table
3343 ;; delete the formula inserted temporarily
3347 "Find the beginning of the TBLFM lines and return its position.
3348 Return nil when the beginning of TBLFM line was not found."
3352 org-table-TBLFM-begin-regexp
3353 nil t))
3357 "Expand list of formulas.
3358 If some of the RHS in the formulas are ranges or a row reference, expand
3359 them to individual field equations for each field."
3365 ;; This just refers to one fixed field
3368 ;; This just refers to one fixed named field
3390 "Replace @<, @>, $<, $> with first/last row/column of the table.
3391 So @< and $< will always be replaced with @1 and $1, respectively.
3392 The advantage of these special markers are that structure editing of
3393 the table will not change them, while @1 and $1 will be modified
3394 when a line/row is swapped out of that privileged position. So for
3395 formulas that use a range of rows or columns, it may often be better
3397 borders of the table using the @< @> $< $> makers."
3400 s start)
3405 org-table-current-ncol)
3409 len
3416 s)
3419 "Replace $const with values in string F."
3421 ;; First, check for column names
3426 ;; Parameters and constants
3428 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3438 f))
3441 "Find the value for a parameter or constant in a formula.
3442 Parameters get priority."
3473 map))
3480 "--"
3483 "--"
3484 "Shift Reference at Point"
3489 "-"
3490 "Change Test Row for Column Formulas"
3493 "--"
3498 org-table-overlay-coordinates)]
3499 "--"
3505 ;;;###autoload
3507 "Edit the formulas of the current table in a separate buffer."
3509 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3523 entry s type title)
3526 ;; Keep global-font-lock-mode from turning on font-lock-mode
3567 "Convert a formula from internal to user representation."
3570 s))
3573 "Convert a formula from user to internal representation."
3576 s))
3579 "Convert spreadsheet references from A7 to @7$28.
3580 Works for single references, but also for entire formulas and even the
3581 full TBLFM line."
3583 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3586 ;; format match, just advance
3591 ;; 3.e5 or something like this.
3594 ;; (member (match-string 1 s)
3595 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3596 )
3597 ;; function name, just advance
3607 t t s)))))
3608 s))
3611 "Convert spreadsheet references from to @7$28 to AB7.
3612 Works for single references, but also for entire formulas and even the
3613 full TBLFM line."
3620 t t s)))
3625 t nil s)))
3626 s)
3629 "Convert a base 26 number represented by letters into an integer.
3630 For example: AB -> 28."
3636 n))
3639 "Convert an integer into a base 26 number represented by letters.
3640 For example: 28 -> AB."
3645 s))
3648 "Convert a time string into numerical duration in seconds.
3649 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3650 If S is a string representing a number, keep this number."
3652 s
3675 "Convert a number of seconds to a time string.
3676 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3677 minutes or seconds."
3692 "Convert all references in this buffer, using FUNCTION."
3702 "Convert all references in the buffer from B3 to @3$2 and back."
3712 "Shift the reference at point one row/hline up."
3716 "Shift the reference at point one row/hline down."
3720 "Shift the reference at point one field to the left."
3724 "Shift the reference at point one field to the right."
3735 ;; A B3-like reference
3741 ;; An internal reference
3747 "Re-match the group N, and replace it with the shifted reference."
3752 t t)))
3755 "Shift a reference part REF.
3756 If DECR is set, decrease the references row/column, else increase.
3757 If HLINE is set, this may be a hline reference, it certainly is not
3758 a translation reference."
3787 "Toggle the display of coordinates in the referenced table."
3796 "Parse the buffer for formula definitions and install them.
3797 With prefix ARG, apply the new formulas to the table."
3807 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3808 nil t)
3832 "Abort editing formulas, without installing the changes."
3843 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3884 "Show the location/value of the $ expression at point."
3893 var name e what match dest)
3898 "$1.."
3981 ;; column number
4009 org-table-fedit-scroll-down))))
4021 "Make sure the cursor is in a dataline in a table."
4030 p1 p2)))
4035 "Move cursor one line up in the window showing the table."
4040 "Move cursor one line down in the window showing the table."
4045 "Move the cursor in the window showing the table.
4046 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4071 "Add a new overlay."
4077 "Highlight rectangular region in a table."
4081 l1 c1 l2 c2 tmp)
4105 "Remove the rectangle overlays."
4116 "Add overlays to the table at point, to show row/column coordinates."
4144 ;;;###autoload
4146 "Toggle the display of Row/Column numbers in tables."
4157 ;;;###autoload
4159 "Toggle the formula debugger in tables."
4165 ;;; The orgtbl minor mode
4167 ;; Define a minor mode which can be used in other modes in order to
4168 ;; integrate the org-mode table editor.
4170 ;; This is really a hack, because the org-mode table editor uses several
4171 ;; keys which normally belong to the major mode, for example the TAB and
4172 ;; RET keys. Here is how it works: The minor mode defines all the keys
4173 ;; necessary to operate the table editor, but wraps the commands into a
4174 ;; function which tests if the cursor is currently inside a table. If that
4175 ;; is the case, the table editor command is executed. However, when any of
4176 ;; those keys is used outside a table, the function uses `key-binding' to
4177 ;; look up if the key has an associated command in another currently active
4178 ;; keymap (minor modes, major mode, global), and executes that command.
4179 ;; There might be problems if any of the keys used by the table editor is
4180 ;; otherwise used as a prefix key.
4182 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4183 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4184 ;; addresses this by checking explicitly for both bindings.
4186 ;; The optimized version (see variable `orgtbl-optimized') takes over
4187 ;; all keys which are bound to `self-insert-command' in the *global map*.
4188 ;; Some modes bind other commands to simple characters, for example
4189 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4190 ;; active, this binding is ignored inside tables and replaced with a
4191 ;; modified self-insert.
4209 ;; Install it as a minor mode.
4213 ;;;###autoload
4215 "The `org-mode' table editor as a minor mode for use in other modes."
4220 ;; Exit without error, in case some hook functions calls this
4221 ;; by accident in org-mode.
4225 ;; Make sure we are first in minor-mode-map-alist
4227 ;; FIXME: maybe it should use emulation-mode-map-alists?
4234 auto-fill-inhibit-regexp)
4238 auto-fill-inhibit-regexp)
4239 orgtbl-line-start-regexp))
4257 "Remove all properties related to narrow-column invisibility."
4270 "Create a function for binding in the table minor mode.
4271 FUN is the command to call inside a table. N is used to create a unique
4272 command name. KEYS are keys that should be checked in for a command
4273 to execute outside of tables."
4279 "Outside of tables, run the binding of `"
4291 keys)
4295 "Error when there is no default binding for a table key."
4300 "Setup orgtbl keymaps."
4331 elt key fun cmd)
4339 ;; Special treatment needed for TAB and RET
4359 [(tab)] "\C-i")))
4361 (org-defkey orgtbl-mode-map [backtab]
4363 [backtab] [S-iso-lefttab] [(shift tab)]
4364 [(tab)] "\C-i"))
4366 (org-defkey orgtbl-mode-map "\M-\C-m"
4367 (orgtbl-make-binding 'org-table-wrap-region 105
4368 "\M-\C-m" [(meta return)]))
4369 (org-defkey orgtbl-mode-map [(meta return)]
4370 (orgtbl-make-binding 'org-table-wrap-region 106
4371 [(meta return)] "\M-\C-m"))
4373 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4374 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4376 (when orgtbl-optimized
4377 ;; If the user wants maximum table support, we need to hijack
4378 ;; some standard editing functions
4379 (org-remap orgtbl-mode-map
4380 'self-insert-command 'orgtbl-self-insert-command
4381 'delete-char 'org-delete-char
4382 'delete-backward-char 'org-delete-backward-char)
4383 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4384 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4385 '("OrgTbl"
4386 ["Create or convert" org-table-create-or-convert-from-region
4387 :active (not (org-at-table-p)) :keys "C-c |" ]
4388 "--"
4389 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4390 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4391 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4392 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4393 "--"
4394 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4395 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4396 ["Copy Field from Above"
4397 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4398 "--"
4399 ("Column"
4400 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4401 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4402 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4403 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4404 ("Row"
4405 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4406 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4407 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4408 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4409 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4410 "--"
4411 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4412 ("Rectangle"
4413 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4414 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4415 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4416 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4417 "--"
4418 ("Radio tables"
4419 ["Insert table template" orgtbl-insert-radio-table
4420 (assq major-mode orgtbl-radio-table-templates)]
4421 ["Comment/uncomment table" orgtbl-toggle-comment t])
4422 "--"
4423 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4424 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4425 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4426 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4427 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4428 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4429 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4430 ["Sum Column/Rectangle" org-table-sum
4431 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4432 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4433 ["Debug Formulas"
4434 org-table-toggle-formula-debugger :active (org-at-table-p)
4435 :keys "C-c {"
4436 :style toggle :selected org-table-formula-debug]
4437 ["Show Col/Row Numbers"
4438 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4439 :keys "C-c }"
4440 :style toggle :selected org-table-overlay-coordinates]
4441 "--"
4442 ("Plot"
4445 t))
4447 (defun orgtbl-ctrl-c-ctrl-c (arg)
4448 "If the cursor is inside a table, realign the table.
4449 If it is a table to be sent away to a receiver, do it.
4450 With prefix arg, also recompute table."
4451 (interactive "P")
4452 (let ((case-fold-search t) (pos (point)) action)
4453 (save-excursion
4454 (beginning-of-line 1)
4455 (setq action (cond
4459 (cond
4460 ((integerp action)
4461 (goto-char action)
4462 (org-table-maybe-eval-formula)
4463 (if arg
4464 (call-interactively 'org-table-recalculate)
4465 (org-table-maybe-recalculate-line))
4466 (call-interactively 'org-table-align)
4467 (when (orgtbl-send-table 'maybe)
4468 (run-hooks 'orgtbl-after-send-table-hook)))
4469 ((eq action 'recalc)
4470 (save-excursion
4471 (beginning-of-line 1)
4473 (if (org-at-table-p)
4474 (org-call-with-arg 'org-table-recalculate t))))
4475 (t (let (orgtbl-mode)
4476 (call-interactively (key-binding "\C-c\C-c")))))))
4478 (defun orgtbl-create-or-convert-from-region (arg)
4479 "Create table or convert region to table, if no conflicting binding.
4480 This installs the table binding `C-c |', but only if there is no
4481 conflicting binding to this key outside orgtbl-mode."
4482 (interactive "P")
4483 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4484 (if cmd
4485 (call-interactively cmd)
4486 (call-interactively 'org-table-create-or-convert-from-region))))
4488 (defun orgtbl-tab (arg)
4489 "Justification and field motion for `orgtbl-mode'."
4490 (interactive "P")
4491 (if arg (org-table-edit-field t)
4492 (org-table-justify-field-maybe)
4493 (org-table-next-field)))
4495 (defun orgtbl-ret ()
4496 "Justification and field motion for `orgtbl-mode'."
4497 (interactive)
4498 (if (bobp)
4499 (newline)
4500 (org-table-justify-field-maybe)
4501 (org-table-next-row)))
4503 (defun orgtbl-self-insert-command (N)
4504 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4505 If the cursor is in a table looking at whitespace, the whitespace is
4506 overwritten, and the table is not marked as requiring realignment."
4507 (interactive "p")
4508 (if (and (org-at-table-p)
4509 (or
4510 (and org-table-auto-blank-field
4511 (member last-command
4512 '(orgtbl-hijacker-command-100
4513 orgtbl-hijacker-command-101
4514 orgtbl-hijacker-command-102
4515 orgtbl-hijacker-command-103
4516 orgtbl-hijacker-command-104
4517 orgtbl-hijacker-command-105
4518 yas/expand))
4519 (org-table-blank-field))
4520 t)
4521 (eq N 1)
4523 (let (org-table-may-need-update)
4524 (goto-char (1- (match-end 0)))
4525 (org-delete-backward-char 1)
4526 (goto-char (match-beginning 0))
4527 (self-insert-command N))
4528 (setq org-table-may-need-update t)
4529 (let* (orgtbl-mode
4530 a
4531 (cmd (or (key-binding
4532 (or (and (listp function-key-map)
4533 (setq a (assoc last-input-event function-key-map))
4534 (cdr a))
4535 (vector last-input-event)))
4536 'self-insert-command)))
4537 (call-interactively cmd)
4538 (if (and org-self-insert-cluster-for-undo
4539 (eq cmd 'self-insert-command))
4540 (if (not (eq last-command 'orgtbl-self-insert-command))
4541 (setq org-self-insert-command-undo-counter 1)
4542 (if (>= org-self-insert-command-undo-counter 20)
4543 (setq org-self-insert-command-undo-counter 1)
4544 (and (> org-self-insert-command-undo-counter 0)
4545 buffer-undo-list
4546 (not (cadr buffer-undo-list)) ; remove nil entry
4547 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4548 (setq org-self-insert-command-undo-counter
4549 (1+ org-self-insert-command-undo-counter))))))))
4552 "Regular expression matching exponentials as produced by calc.")
4554 (defun orgtbl-gather-send-defs ()
4555 "Gather a plist of :name, :transform, :params for each destination before
4556 a radio table."
4557 (save-excursion
4558 (goto-char (org-table-begin))
4559 (let (rtn)
4560 (beginning-of-line 0)
4561 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4562 (let ((name (org-no-properties (match-string 1)))
4563 (transform (intern (match-string 2)))
4564 (params (if (match-end 3)
4565 (read (concat "(" (match-string 3) ")")))))
4566 (push (list :name name :transform transform :params params)
4567 rtn)
4568 (beginning-of-line 0)))
4569 rtn)))
4571 (defun orgtbl-send-replace-tbl (name txt)
4572 "Find and replace table NAME with TXT."
4573 (save-excursion
4574 (goto-char (point-min))
4575 (unless (re-search-forward
4577 (user-error "Don't know where to insert translated table"))
4578 (let ((beg (line-beginning-position 2)))
4579 (unless (re-search-forward
4580 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4581 (user-error "Cannot find end of insertion region"))
4582 (beginning-of-line)
4583 (delete-region beg (point)))
4586 ;;;###autoload
4587 (defun org-table-to-lisp (&optional txt)
4588 "Convert the table at point to a Lisp structure.
4589 The structure will be a list. Each item is either the symbol `hline'
4590 for a horizontal separator line, or a list of field values as strings.
4591 The table is taken from the parameter TXT, or from the buffer at point."
4592 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4593 (let ((txt (or txt
4594 (buffer-substring-no-properties (org-table-begin)
4595 (org-table-end)))))
4596 (mapcar (lambda (x)
4597 (if (string-match org-table-hline-regexp x) 'hline
4601 (defun orgtbl-send-table (&optional maybe)
4602 "Send a transformed version of table at point to the receiver position.
4603 With argument MAYBE, fail quietly if no transformation is defined
4604 for this table."
4605 (interactive)
4606 (catch 'exit
4607 (unless (org-at-table-p) (user-error "Not at a table"))
4608 ;; when non-interactive, we assume align has just happened.
4609 (when (org-called-interactively-p 'any) (org-table-align))
4610 (let ((dests (orgtbl-gather-send-defs))
4611 (table (org-table-to-lisp
4612 (buffer-substring-no-properties (org-table-begin)
4613 (org-table-end))))
4614 (ntbl 0))
4615 (unless dests
4616 (if maybe (throw 'exit nil)
4617 (user-error "Don't know how to transform this table")))
4618 (dolist (dest dests)
4619 (let ((name (plist-get dest :name))
4620 (transform (plist-get dest :transform))
4621 (params (plist-get dest :params)))
4622 (unless (fboundp transform)
4623 (user-error "No such transformation function %s" transform))
4624 (orgtbl-send-replace-tbl name (funcall transform table params)))
4625 (incf ntbl))
4626 (message "Table converted and installed at %d receiver location%s"
4627 ntbl (if (> ntbl 1) "s" ""))
4628 (and (> ntbl 0) ntbl))))
4630 (defun org-remove-by-index (list indices &optional i0)
4631 "Remove the elements in LIST with indices in INDICES.
4632 First element has index 0, or I0 if given."
4633 (if (not indices)
4634 list
4635 (if (integerp indices) (setq indices (list indices)))
4636 (setq i0 (1- (or i0 0)))
4637 (delq :rm (mapcar (lambda (x)
4638 (setq i0 (1+ i0))
4639 (if (memq i0 indices) :rm x))
4640 list))))
4642 (defun orgtbl-toggle-comment ()
4643 "Comment or uncomment the orgtbl at point."
4644 (interactive)
4645 (let* ((case-fold-search t)
4646 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4647 (re2 (concat "^" orgtbl-line-start-regexp))
4648 (commented (save-excursion (beginning-of-line 1)
4649 (cond ((looking-at re1) t)
4650 ((looking-at re2) nil)
4651 (t (user-error "Not at an org table")))))
4652 (re (if commented re1 re2))
4653 beg end)
4654 (save-excursion
4655 (beginning-of-line 1)
4656 (while (looking-at re) (beginning-of-line 0))
4657 (beginning-of-line 2)
4658 (setq beg (point))
4659 (while (looking-at re) (beginning-of-line 2))
4660 (setq end (point)))
4661 (comment-region beg end (if commented '(4) nil))))
4663 (defun orgtbl-insert-radio-table ()
4664 "Insert a radio table template appropriate for this major mode."
4665 (interactive)
4666 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4667 (txt (nth 1 e))
4668 name pos)
4669 (unless e (user-error "No radio table setup defined for %s" major-mode))
4670 (setq name (read-string "Table name: "))
4671 (while (string-match "%n" txt)
4672 (setq txt (replace-match name t t txt)))
4674 (setq pos (point))
4675 (insert txt)
4676 (goto-char pos)))
4678 ;;;###autoload
4679 (defun orgtbl-to-generic (table params)
4680 "Convert the orgtbl-mode TABLE to some other format.
4682 This generic routine can be used for many standard cases.
4684 TABLE is a list, each entry either the symbol `hline' for
4685 a horizontal separator line, or a list of fields for that
4686 line. PARAMS is a property list of parameters that can
4687 influence the conversion.
4689 Valid parameters are:
4691 :backend, :raw
4693 Export back-end used as a basis to transcode elements of the
4694 table, when no specific parameter applies to it. It is also
4695 used to translate cells contents. You can prevent this by
4696 setting :raw property to a non-nil value.
4698 :splice
4700 When non-nil, only convert rows, not the table itself. This is
4701 equivalent to setting to the empty string both :tstart
4702 and :tend, which see.
4704 :skip
4706 When set to an integer N, skip the first N lines of the table.
4707 Horizontal separation lines do count for this parameter!
4709 :skipcols
4711 List of columns that should be skipped. If the table has
4712 a column with calculation marks, that column is automatically
4713 discarded beforehand.
4715 :hline
4717 String to be inserted on horizontal separation lines. May be
4718 nil to ignore these lines altogether.
4720 :sep
4722 Separator between two fields, as a string.
4724 Each in the following group may be either a string or a function
4725 of no arguments returning a string:
4727 :tstart, :tend
4729 Strings to start and end the table. Ignored when :splice is t.
4731 :lstart, :lend
4733 Strings to start and end a new table line.
4735 :llstart, :llend
4737 Strings to start and end the last table line. Default,
4738 respectively, to :lstart and :lend.
4740 Each in the following group may be a string or a function of one
4741 argument (either the cells in the current row, as a list of
4742 strings, or the current cell) returning a string:
4744 :lfmt
4746 Format string for an entire row, with enough %s to capture all
4747 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4749 :llfmt
4751 Format for the entire last line, defaults to :lfmt.
4753 :fmt
4755 A format to be used to wrap the field, should contain %s for
4756 the original field value. For example, to wrap everything in
4758 a property list with column numbers and format strings, or
4759 functions, e.g.,
4763 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4765 Same as above, specific for the header lines in the table.
4766 All lines before the first hline are treated as header. If
4767 any of these is not present, the data line value is used.
4769 This may be either a string or a function of two arguments:
4771 :efmt
4773 Use this format to print numbers with exponential. The format
4774 should have %s twice for inserting mantissa and exponent, for
4776 list with column numbers and format strings or functions.
4777 :fmt will still be applied after :efmt."
4778 (let ((backend (plist-get params :backend)))
4779 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4780 (user-error "Unknown :backend value"))
4781 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4782 (org-trim
4783 (org-export-string-as
4784 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4785 (with-output-to-string
4786 (dolist (e table)
4788 ((consp e)
4789 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4791 ;; Build a custom back-end according to PARAMS. Before defining
4792 ;; a translator, check if there is anything to do. When there
4793 ;; isn't, let BACKEND handle the element.
4794 (org-export-create-backend
4795 :parent (or backend 'org)
4796 :filters
4797 '((:filter-parse-tree
4798 ;; Handle :skip parameter.
4799 (lambda (tree backend info)
4800 (let ((skip (plist-get info :skip)))
4801 (when skip
4802 (unless (wholenump skip) (user-error "Wrong :skip value"))
4803 (let ((n 0))
4804 (org-element-map tree 'table-row
4805 (lambda (row)
4806 (if (>= n skip) t
4807 (org-element-extract-element row)
4808 (incf n)
4809 nil))
4810 info t))
4811 tree)))
4812 ;; Handle :skipcols parameter.
4813 (lambda (tree backend info)
4814 (let ((skipcols (plist-get info :skipcols)))
4815 (when skipcols
4816 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4817 (org-element-map tree 'table
4818 (lambda (table)
4819 (let ((specialp
4820 (org-export-table-has-special-column-p table)))
4821 (dolist (row (org-element-contents table))
4822 (when (eq (org-element-property :type row) 'standard)
4823 (let ((c 1))
4824 (dolist (cell (nthcdr (if specialp 1 0)
4825 (org-element-contents row)))
4826 (when (memq c skipcols)
4827 (org-element-extract-element cell))
4828 (incf c)))))))
4829 info)
4830 tree)))))
4831 :transcoders
4832 `((table . ,(org-table--to-generic-table params))
4833 (table-row . ,(org-table--to-generic-row params))
4834 (table-cell . ,(org-table--to-generic-cell params))
4835 ;; Section. Return contents to avoid garbage around table.
4836 (section . (lambda (s c i) c))))
4837 'body-only (org-combine-plists params '(:with-tables t))))))
4839 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4840 (cond ((null value) nil)
4841 ((functionp value) `(funcall ',value ,@args))
4842 ((stringp value)
4843 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4844 (args `(format ,value ,@args))
4845 (t value)))
4846 ((and with-cons (consp value))
4847 `(let ((val (cadr (memq column ',value))))
4848 (cond ((null val) contents)
4849 ((stringp val) (format val ,@args))
4850 ((functionp val) (funcall val ,@args))
4851 (t (user-error "Wrong %s value" ,name)))))
4852 (t (user-error "Wrong %s value" name))))
4854 (defun org-table--to-generic-table (params)
4855 "Return custom table transcoder according to PARAMS.
4856 PARAMS is a plist. See `orgtbl-to-generic' for more
4857 information."
4858 (let ((backend (plist-get params :backend))
4859 (splice (plist-get params :splice))
4860 (tstart (plist-get params :tstart))
4861 (tend (plist-get params :tend)))
4862 `(lambda (table contents info)
4863 (concat
4864 ,(and tstart (not splice)
4866 ,(if (or (not backend) tstart tend splice) 'contents
4867 `(org-export-with-backend ',backend table contents info))
4868 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4870 (defun org-table--to-generic-row (params)
4871 "Return custom table row 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 (lstart (plist-get params :lstart))
4876 (llstart (plist-get params :llstart))
4877 (hlstart (plist-get params :hlstart))
4878 (hllstart (plist-get params :hllstart))
4879 (lend (plist-get params :lend))
4880 (llend (plist-get params :llend))
4881 (hlend (plist-get params :hlend))
4882 (hllend (plist-get params :hllend))
4883 (lfmt (plist-get params :lfmt))
4884 (llfmt (plist-get params :llfmt))
4885 (hlfmt (plist-get params :hlfmt))
4886 (hllfmt (plist-get params :hllfmt)))
4887 `(lambda (row contents info)
4888 (if (eq (org-element-property :type row) 'rule)
4889 ,(cond
4890 ((plist-member params :hline)
4891 (org-table--generic-apply (plist-get params :hline) ":hline"))
4892 (backend `(org-export-with-backend ',backend row nil info)))
4893 (let ((headerp (org-export-table-row-in-header-p row info))
4894 (lastp (not (org-export-get-next-element row info)))
4895 (last-header-p (org-export-table-row-ends-header-p row info)))
4896 (when contents
4897 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4898 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4899 ;; `:lstart', `:lend' and their relatives.
4900 ,(let ((cells
4901 '(org-element-map row 'table-cell
4902 (lambda (cell)
4903 ;; Export all cells, without separators.
4904 ;;
4905 ;; Use `org-export-data-with-backend'
4906 ;; instead of `org-export-data' to eschew
4907 ;; cached values, which
4908 ;; ignore :orgtbl-ignore-sep parameter.
4909 (org-export-data-with-backend
4910 cell
4911 (plist-get info :back-end)
4912 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4913 info)))
4914 `(cond
4915 ,(and hllfmt
4916 `(last-header-p ,(org-table--generic-apply
4917 hllfmt ":hllfmt" nil cells)))
4918 ,(and hlfmt
4919 `(headerp ,(org-table--generic-apply
4920 hlfmt ":hlfmt" nil cells)))
4921 ,(and llfmt
4922 `(lastp ,(org-table--generic-apply
4923 llfmt ":llfmt" nil cells)))
4924 (t
4925 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4926 `(concat
4927 (cond
4928 ,(and
4929 (or hllstart hllend)
4930 `(last-header-p
4931 (concat
4932 ,(org-table--generic-apply hllstart ":hllstart")
4933 contents
4934 ,(org-table--generic-apply hllend ":hllend"))))
4935 ,(and
4936 (or hlstart hlend)
4937 `(headerp
4938 (concat
4939 ,(org-table--generic-apply hlstart ":hlstart")
4940 contents
4941 ,(org-table--generic-apply hlend ":hlend"))))
4942 ,(and
4943 (or llstart llend)
4944 `(lastp
4945 (concat
4946 ,(org-table--generic-apply llstart ":llstart")
4947 contents
4948 ,(org-table--generic-apply llend ":llend"))))
4949 (t
4950 ,(cond
4951 ((or lstart lend)
4952 `(concat
4953 ,(org-table--generic-apply lstart ":lstart")
4954 contents
4955 ,(org-table--generic-apply lend ":lend")))
4956 (backend
4957 `(org-export-with-backend
4958 ',backend row contents info))
4959 (t 'contents)))))))))))))))
4961 (defun org-table--to-generic-cell (params)
4962 "Return custom table cell transcoder according to PARAMS.
4963 PARAMS is a plist. See `orgtbl-to-generic' for more
4964 information."
4965 (let* ((backend (plist-get params :backend))
4966 (efmt (plist-get params :efmt))
4967 (fmt (plist-get params :fmt))
4968 (hfmt (plist-get params :hfmt))
4969 (sep (plist-get params :sep))
4970 (hsep (plist-get params :hsep)))
4971 `(lambda (cell contents info)
4972 (let ((headerp (org-export-table-row-in-header-p
4973 (org-export-get-parent-element cell) info))
4974 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4975 ;; Make sure that contents are exported as Org data when :raw
4976 ;; parameter is non-nil.
4977 ,(when (and backend (plist-get params :raw))
4978 `(setq contents
4979 ;; Since we don't know what are the pseudo object
4980 ;; types defined in backend, we cannot pass them to
4981 ;; `org-element-interpret-data'. As a consequence,
4982 ;; they will be treated as pseudo elements, and
4983 ;; will have newlines appended instead of spaces.
4984 ;; Therefore, we must make sure :post-blank value
4985 ;; is really turned into spaces.
4986 (replace-regexp-in-string
4988 (org-trim
4989 (org-element-interpret-data
4990 (org-element-contents cell))))))
4991 (when contents
4992 ;; Check if we can apply `:efmt' on CONTENTS.
4993 ,(when efmt
4994 `(when (string-match orgtbl-exp-regexp contents)
4995 (let ((mantissa (match-string 1 contents))
4996 (exponent (match-string 2 contents)))
4997 (setq contents ,(org-table--generic-apply
4998 efmt ":efmt" t 'mantissa 'exponent)))))
4999 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5000 (cond
5001 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5002 hfmt ":hfmt" t 'contents))))
5003 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5004 fmt ":fmt" t 'contents))))))
5005 ;; If a separator is provided, use it instead of BACKEND's.
5006 ;; Separators are ignored when LFMT (or equivalent) is
5007 ;; provided.
5008 ,(cond
5009 ((or hsep sep)
5010 `(if (or ,(and (not sep) '(not headerp))
5011 (plist-get info :orgtbl-ignore-sep)
5012 (not (org-export-get-next-element cell info)))
5013 ,(if (not backend) 'contents
5014 `(org-export-with-backend ',backend cell contents info))
5015 (concat contents
5016 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5017 (or hsep sep)))))
5018 (backend `(org-export-with-backend ',backend cell contents info))
5019 (t 'contents))))))
5021 ;;;###autoload
5022 (defun orgtbl-to-tsv (table params)
5023 "Convert the orgtbl-mode table to TAB separated material."
5026 ;;;###autoload
5027 (defun orgtbl-to-csv (table params)
5028 "Convert the orgtbl-mode table to CSV material.
5029 This does take care of the proper quoting of fields with comma or quotes."
5030 (orgtbl-to-generic table
5031 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5032 params)))
5034 ;;;###autoload
5035 (defun orgtbl-to-latex (table params)
5036 "Convert the orgtbl-mode TABLE to LaTeX.
5038 TABLE is a list, each entry either the symbol `hline' for
5039 a horizontal separator line, or a list of fields for that line.
5040 PARAMS is a property list of parameters that can influence the
5041 conversion. All parameters from `orgtbl-to-generic' are
5042 supported. It is also possible to use the following ones:
5044 :booktabs
5048 :environment
5050 Specify environment to use, as a string. If you use
5052 as a string, to get proper continuation strings."
5053 (require 'ox-latex)
5054 (orgtbl-to-generic
5055 table
5056 (org-combine-plists
5057 ;; Provide sane default values.
5058 (list :backend 'latex
5059 :latex-default-table-mode 'table
5060 :latex-tables-centered nil
5061 :latex-tables-booktabs (plist-get params :booktabs)
5062 :latex-table-scientific-notation nil
5063 :latex-default-table-environment
5064 (or (plist-get params :environment) "tabular"))
5065 params)))
5067 ;;;###autoload
5068 (defun orgtbl-to-html (table params)
5069 "Convert the orgtbl-mode TABLE to HTML.
5071 TABLE is a list, each entry either the symbol `hline' for
5072 a horizontal separator line, or a list of fields for that line.
5073 PARAMS is a property list of parameters that can influence the
5074 conversion. All parameters from `orgtbl-to-generic' are
5075 supported. It is also possible to use the following one:
5077 :attributes
5079 Attributes and values, as a plist, which will be used in
5080 <table> tag."
5081 (require 'ox-html)
5082 (orgtbl-to-generic
5083 table
5084 (org-combine-plists
5085 ;; Provide sane default values.
5086 (list :backend 'html
5087 :html-table-data-tags '("<td%s>" . "</td>")
5088 :html-table-use-header-tags-for-first-column nil
5089 :html-table-align-individual-fields t
5090 :html-table-row-tags '("<tr>" . "</tr>")
5091 :html-table-attributes
5092 (if (plist-member params :attributes)
5093 (plist-get params :attributes)
5094 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5095 :frame "hsides")))
5096 params)))
5098 ;;;###autoload
5099 (defun orgtbl-to-texinfo (table params)
5100 "Convert the orgtbl-mode TABLE to Texinfo.
5102 TABLE is a list, each entry either the symbol `hline' for
5103 a horizontal separator line, or a list of fields for that line.
5104 PARAMS is a property list of parameters that can influence the
5105 conversion. All parameters from `orgtbl-to-generic' are
5106 supported. It is also possible to use the following one:
5108 :columns
5110 Column widths, as a string. When providing column fractions,
5112 (require 'ox-texinfo)
5113 (let ((output
5114 (orgtbl-to-generic
5115 table
5116 (org-combine-plists
5117 (list :backend 'texinfo
5118 :texinfo-tables-verbatim nil
5119 :texinfo-table-scientific-notation nil)
5120 params)))
5121 (columns (let ((w (plist-get params :columns)))
5122 (cond ((not w) nil)
5124 (t (concat "@columnfractions " w))))))
5125 (if (not columns) output
5126 (replace-regexp-in-string
5129 ;;;###autoload
5130 (defun orgtbl-to-orgtbl (table params)
5131 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5133 TABLE is a list, each entry either the symbol `hline' for
5134 a horizontal separator line, or a list of fields for that line.
5135 PARAMS is a property list of parameters that can influence the
5136 conversion. All parameters from `orgtbl-to-generic' are
5137 supported.
5139 Useful when slicing one table into many. The :hline, :sep,
5140 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5141 be set to provide ORGTBL directives for the generated table."
5142 (require 'ox-org)
5143 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5145 (defun orgtbl-to-table.el (table params)
5146 "Convert the orgtbl-mode TABLE into a table.el table.
5147 TABLE is a list, each entry either the symbol `hline' for
5148 a horizontal separator line, or a list of fields for that line.
5149 PARAMS is a property list of parameters that can influence the
5150 conversion. All parameters from `orgtbl-to-generic' are
5151 supported."
5152 (with-temp-buffer
5153 (insert (orgtbl-to-orgtbl table params))
5154 (org-table-align)
5155 (replace-regexp-in-string
5156 "-|" "-+"
5157 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5159 (defun orgtbl-to-unicode (table params)
5160 "Convert the orgtbl-mode TABLE into a table with unicode characters.
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. It is also possible to use the following ones:
5168 :ascii-art
5171 the table. You can download it here:
5172 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5174 :narrow
5176 When non-nil, narrow columns width than provided width cookie,
5178 (require 'ox-ascii)
5179 (orgtbl-to-generic
5180 table
5181 (org-combine-plists
5182 (list :backend 'ascii
5183 :ascii-charset 'utf-8
5184 :ascii-table-keep-all-vertical-lines (plist-get params :)
5185 :ascii-table-widen-columns (not (plist-get params :narrow))
5186 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5187 params)))
5189 ;; Put the cursor in a column containing numerical values
5190 ;; of an Org-Mode table,
5191 ;; type C-c " a
5192 ;; A new column is added with a bar plot.
5193 ;; When the table is refreshed (C-u C-c *),
5194 ;; the plot is updated to reflect the new values.
5196 (defun orgtbl-ascii-draw (value min max &optional width characters)
5197 "Draw an ascii bar in a table.
5198 VALUE is a the value to plot, the width of the bar to draw. A
5199 value equal to MIN will be displayed as empty (zero width bar).
5200 A value equal to MAX will draw a bar filling all the WIDTH.
5201 WIDTH is the expected width in characters of the column.
5202 CHARACTERS is a string that will compose the bar, with shades of
5203 grey from pure white to pure black. It defaults to a 10
5204 characters string of regular ascii characters."
5205 (let* ((characters (or characters " .:;c!lhVHW"))
5206 (width (or width 12))
5207 (value (if (numberp value) value (string-to-number value)))
5208 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5209 (cond
5210 ((< value 0) "too small")
5211 ((> value width) "too large")
5212 (t
5213 (let ((len (1- (length characters))))
5214 (concat
5215 (make-string (floor value) (elt characters len))
5216 (string (elt characters
5217 (floor (* (- value (floor value)) len))))))))))
5219 ;;;###autoload
5220 (defun orgtbl-ascii-plot (&optional ask)
5221 "Draw an ascii bar plot in a column.
5222 With cursor in a column containing numerical values, this
5223 function will draw a plot in a new column.
5224 ASK, if given, is a numeric prefix to override the default 12
5225 characters width of the plot. ASK may also be the
5227 (interactive "P")
5228 (let ((col (org-table-current-column))
5229 (min 1e999) ; 1e999 will be converted to infinity
5230 (max -1e999) ; which is the desired result
5231 (table (org-table-to-lisp))
5232 (length
5233 (cond ((consp ask)
5234 (read-number "Length of column " 12))
5235 ((numberp ask) ask)
5236 (t 12))))
5237 ;; Skip any hline a the top of table.
5238 (while (eq (car table) 'hline) (setq table (cdr table)))
5239 ;; Skip table header if any.
5240 (dolist (x (or (cdr (memq 'hline table)) table))
5241 (when (consp x)
5242 (setq x (nth (1- col) x))
5243 (when (string-match
5245 x)
5246 (setq x (string-to-number x))
5247 (when (> min x) (setq min x))
5248 (when (< max x) (setq max x)))))
5249 (org-table-insert-column)
5250 (org-table-move-column-right)
5251 (org-table-store-formulas
5252 (cons
5253 (cons
5254 (number-to-string (1+ col))
5255 (format "'(%s $%s %s %s %s)"
5256 "orgtbl-ascii-draw" col min max length))
5257 (org-table-get-stored-formulas)))
5258 (org-table-recalculate t)))
5260 ;; Example of extension: unicode characters
5261 ;; Here are two examples of different styles.
5263 ;; Unicode block characters are used to give a smooth effect.
5264 ;; See http://en.wikipedia.org/wiki/Block_Elements
5265 ;; Use one of those drawing functions
5266 ;; - orgtbl-ascii-draw (the default ascii)
5267 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5268 ;; - orgtbl-uc-draw-cont (smooth unicode)
5270 ;; This is best viewed with the "DejaVu Sans Mono" font
5271 ;; (use M-x set-default-font).
5273 (defun orgtbl-uc-draw-grid (value min max &optional width)
5274 "Draw a bar in a table using block unicode characters.
5275 It is a variant of orgtbl-ascii-draw with Unicode block
5276 characters, for a smooth display. Bars appear as grids (to the
5277 extent the font allows)."
5278 ;; http://en.wikipedia.org/wiki/Block_Elements
5279 ;; best viewed with the "DejaVu Sans Mono" font.
5280 (orgtbl-ascii-draw value min max width
5283 (defun orgtbl-uc-draw-cont (value min max &optional width)
5284 "Draw a bar in a table using block unicode characters.
5285 It is a variant of orgtbl-ascii-draw with Unicode block
5286 characters, for a smooth display. Bars are solid (to the extent
5287 the font allows)."
5288 (orgtbl-ascii-draw value min max width
5291 (defun org-table-get-remote-range (name-or-id form)
5292 "Get a field value or a list of values in a range from table at ID.
5294 NAME-OR-ID may be the name of a table in the current file as set
5296 will then be used. Alternatively, it may be an ID referring to
5297 any entry, also in a different file. In this case, the first
5298 table in that entry will be referenced.
5302 The return value is either a single string for a single field, or a
5303 list of the fields in the rectangle."
5304 (save-match-data
5305 (let ((case-fold-search t) (id-loc nil)
5306 ;; Protect a bunch of variables from being overwritten
5307 ;; by the context of the remote table
5308 org-table-column-names org-table-column-name-regexp
5309 org-table-local-parameters org-table-named-field-locations
5310 org-table-current-line-types org-table-current-begin-line
5311 org-table-current-begin-pos org-table-dlines
5312 org-table-current-ncol
5313 org-table-hlines org-table-last-alignment
5314 org-table-last-column-widths org-table-last-alignment
5315 org-table-last-column-widths tbeg
5316 buffer loc)
5317 (setq form (org-table-convert-refs-to-rc form))
5318 (save-excursion
5319 (save-restriction
5320 (widen)
5321 (save-excursion
5322 (goto-char (point-min))
5323 (if (re-search-forward
5326 nil t)
5327 (setq buffer (current-buffer) loc (match-beginning 0))
5328 (setq id-loc (org-id-find name-or-id 'marker))
5329 (unless (and id-loc (markerp id-loc))
5331 (setq buffer (marker-buffer id-loc)
5332 loc (marker-position id-loc))
5333 (move-marker id-loc nil)))
5334 (with-current-buffer buffer
5335 (save-excursion
5336 (save-restriction
5337 (widen)
5338 (goto-char loc)
5339 (forward-char 1)
5341 (not (match-beginning 1)))
5342 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5343 (setq tbeg (point-at-bol))
5344 (org-table-get-specials)
5345 (setq form (org-table-formula-substitute-names
5346 (org-table-formula-handle-first/last-rc form)))
5347 (if (and (string-match org-table-range-regexp form)
5348 (> (length (match-string 0 form)) 1))
5349 (save-match-data
5350 (org-table-get-range (match-string 0 form) tbeg 1))
5351 form)))))))))
5353 (defun org-table-remote-reference-indirection (form)
5354 "Return formula with table remote references substituted by indirection.
5356 This indirection works only with the format @ROW$COLUMN. The
5358 distinguished from a plain table name or ID."
5359 (let ((start 0))
5360 (while (string-match (concat
5361 ;; Same as in `org-table-eval-formula'.
5363 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5365 ;; Same as in `org-table-eval-formula'.
5367 form
5368 start)
5369 ;; The position of the character as far as possible to the right
5370 ;; that will not be replaced and particularly not be shifted by
5371 ;; `replace-match'.
5372 (setq start (match-beginning 1))
5373 ;; Substitute the remote reference with the value found in the
5374 ;; field.
5375 (setq form
5376 (replace-match
5377 (save-match-data
5378 (org-table-get-range (org-table-formula-handle-first/last-rc
5379 (match-string 1 form))))
5380 t t form 1))))
5381 form)
5383 (defmacro org-define-lookup-function (mode)
5384 (let ((mode-str (symbol-name mode))
5385 (first-p (equal mode 'first))
5386 (all-p (equal mode 'all)))
5387 (let ((plural-str (if all-p "s" "")))
5388 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5389 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5390 If R-LIST is nil, return matching element%s of S-LIST.
5391 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5392 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5393 This function is generated by a call to the macro `org-define-lookup-function'."
5394 mode-str plural-str plural-str plural-str)
5395 (let ,(let ((lvars '((p (or predicate 'equal))
5396 (sl s-list)
5397 (rl (or r-list s-list))
5398 (ret nil))))
5399 (if first-p (add-to-list 'lvars '(match-p nil)))
5400 lvars)
5401 (while ,(if first-p '(and (not match-p) sl) 'sl)
5402 (progn
5403 (if (funcall p val (car sl))
5404 (progn
5405 ,(if first-p '(setq match-p t))
5406 (let ((rval (car rl)))
5407 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5408 (setq sl (cdr sl) rl (cdr rl))))
5409 ret)))))
5411 (org-define-lookup-function first)
5412 (org-define-lookup-function last)
5413 (org-define-lookup-function all)
5415 (provide 'org-table)
5417 ;; Local variables:
5418 ;; generated-autoload-file: "org-loaddefs.el"
5419 ;; End:
5421 ;;; org-table.el ends here