| blob | 8b0642f16fca9b0d4768b72b09634ed6144c0721 |
1 ;;; org-table.el --- The table editor for Org mode
3 ;; Copyright (C) 2004-2016 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:
76 "Hook for functions attaching to `C-c C-c', if the table is sent.
77 This can be used to add additional functionality after the table is sent
78 to the receiver position, otherwise, if table is not sent, the functions
84 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
85 In the optimized version, the table editor takes over all simple keys that
86 normally just insert a character. In tables, the characters are inserted
87 in a way to minimize disturbing the table structure (i.e. in overwrite mode
88 for empty fields). Outside tables, the correct binding of the keys is
89 restored.
91 The default for this option is t if the optimized version is also used in
92 Org-mode. See the variable `org-enable-table-editor' for details. Changing
93 this variable requires a restart of Emacs to become effective."
99 % END RECEIVE ORGTBL %n
101 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
102 | | |
105 @c END RECEIVE ORGTBL %n
106 @ignore
107 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
108 | | |
111 <!-- END RECEIVE ORGTBL %n -->
112 <!--
113 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
114 | | |
117 #+ END RECEIVE ORGTBL %n
119 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
120 | | |
122 "Templates for radio tables in different major modes.
123 Each template must define lines that will be treated as a comment and that
126 insertion of the template. The transformed table will later be inserted
127 between these lines.
129 The template should also contain a minimal table in a multiline comment.
130 If multiline comments are not possible in the buffer language,
131 you can pack it into a string that will not be used when the code
132 is compiled or executed. Above the table will you need a line with
134 convert the table into a data structure useful in the
135 language of the buffer. Check the manual for the section on
137 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
139 All occurrences of %n in a template will be replaced with the name of the
140 table, obtained by prompting the user."
147 "Settings for tables in Org-mode."
152 "The default size for newly created tables, Columns x Rows."
157 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
158 "Regular expression for recognizing numbers in table columns.
159 If a table column contains mostly numbers, it will be aligned to the
160 right. If not, it will be aligned to the left.
162 The default value of this option is a regular expression which allows
163 anything which looks remotely like a number as used in scientific
164 context. For example, all of the following will be considered a
165 number:
166 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
168 Other options offered by the customize interface are more restrictive."
182 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
183 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
184 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
188 "Fraction of numbers in a column required to make the column align right.
189 In a column all non-white fields are considered. If at least
190 this fraction of fields is matched by `org-table-number-regexp',
191 alignment to the right border applies."
196 "Behavior of tables during editing in Org-mode."
201 "Non-nil means automatically re-align table when pressing TAB or RETURN.
203 removal/insertion."
208 "Non-nil means automatically blank table field when starting to type into it.
209 This only happens when typing immediately after a field motion
210 command (TAB, S-TAB or RET).
211 Only relevant when `org-enable-table-editor' is equal to `optimized'."
216 "Non-nil means automatically exit the follow mode.
217 When nil, the follow mode will stay on and be active in any table
218 the cursor enters. Since the table follow filed mode messes with the
219 window configuration, it is not recommended to set this variable to nil,
220 except maybe locally in a special file that has mostly tables with long
221 fields."
227 "Whether the user should confirm when Org fixes formulas."
235 'safe-local-variable
239 "Non-nil means tab in the last column of a table with jump over a hline.
240 If a horizontal separator line is following the current line,
241 `org-table-next-field' can either create a new row before that line, or jump
242 over the line. When this option is nil, a new line will be created before
243 this line."
248 "Options concerning tables in Org-mode."
253 "Should org-mode work with table references like B3 instead of @3$2?
254 Possible values are:
255 nil never use them
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
277 calc-angle-mode deg
278 calc-prefer-frac nil
279 calc-symbolic-mode nil
281 calc-display-working-message t
282 )
283 "List with Calc mode settings for use in `calc-eval' for table formulas.
284 The list must contain alternating symbols (Calc modes variables and values).
285 Don't remove any of the default settings, just change the values. Org-mode
286 relies on the variables to be present in the list."
291 "Format for the output of calc computations like $1+$2;t.
292 The default value is `hours', and will output the results as a
293 number of hours. Other allowed values are `seconds', `minutes' and
294 `days', and the output will be a fraction of seconds, minutes or
295 days."
304 "Format for fields which contain the result of a formula.
306 characters. Beware that modifying the display can prevent the
307 field from being used in another formula."
313 "Non-nil means TAB and RET evaluate a formula in current table field.
314 If the current field starts with an equal sign, it is assumed to be a formula
315 which should be evaluated as described in the manual and in the documentation
316 string of the command `org-table-eval-formula'. This feature requires the
317 Emacs calc package.
318 When this variable is nil, formula calculation is only available through
324 "Non-nil means interpret constants in formulas in tables.
325 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
326 by the value given in `org-table-formula-constants', or by a value obtained
327 from the `constants.el' package."
332 "Alist with constant names and values, for use in table formulas.
333 The car of each element is a name of a constant, without the `$' before it.
334 The cdr is the value as a string. For example, if you'd like to use the
335 speed of light in a formula, you would configure
339 and then use it in an equation like `$1*$c'.
341 Constants can also be defined on a per-file basis using a line like
343 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
350 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
353 are pressed in the line."
358 "Non-nil means relative formula references may cross hlines.
359 Here are the allowed values:
361 nil Relative references may not cross hlines. They will reference the
362 field next to the hline instead. Coming from below, the reference
363 will be to the field below the hline. Coming from above, it will be
364 to the field above.
365 t Relative references may cross hlines.
366 error An attempt to cross a hline will throw an error.
368 It is probably good to never set this variable to nil, for the sake of
369 portability of tables."
377 "Non-nil means that evaluation of a field formula can add new
378 columns if an out-of-bounds field is being set."
385 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
389 "Options concerning table import and export in Org-mode."
394 "Default export parameters for `org-table-export'.
395 These can be overridden for a specific table by setting the
396 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
397 radio tables for the different export transformations and
398 available parameters."
403 "Max lines that `org-table-convert-region' will attempt to process.
405 The function can be slow on larger regions; this safety feature
406 prevents it from hanging emacs."
429 "Alist with column names, derived from the `!' line.
433 "Regular expression matching the current column names.
437 "Alist with parameter names, derived from the `$' line.
441 "Alist with locations of named fields.
442 Associations follow the pattern (NAME LINE COLUMN) where
443 NAME is the name of the field as a string,
444 LINE is the number of lines from the beginning of the table,
445 COLUMN is the column of the field, as an integer.
449 "Table row types in current table.
453 "Current table begin position, as a marker.
457 "Number of columns in current table.
461 "Vector of data line line numbers in the current table.
462 Line numbers are counted from the beginning of the table. This
466 "Vector of hline line numbers in the current table.
467 Line numbers are counted from the beginning of the table. This
471 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
472 ;; 1 2 3 4 5
487 "Save current field; execute BODY; restore field.
488 Field is restored even in case of abnormal exit."
499 ;;;###autoload
501 "Use the table.el package to insert a new table.
502 If there is already a table at point, convert between Org-mode tables
503 and table.el tables."
516 ;;;###autoload
518 "Convert region to table, or create an empty table.
519 If there is an active region, convert it to a table, using the function
520 `org-table-convert-region'. See the documentation of that function
521 to learn how the prefix argument is interpreted to determine the field
522 separator.
523 If there is no such region, create an empty table with `org-table-create'."
529 ;;;###autoload
531 "Query for a size and insert a table skeleton.
551 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
555 ;; Insert a hline after the first row.
562 ;;;###autoload
564 "Convert region to a table.
565 The region goes from BEG0 to END0, but these borders will be moved
566 slightly, to make sure a beginning of line in the first line is included.
568 SEPARATOR specifies the field separator in the lines. It can have the
569 following values:
571 (4) Use the comma as a field separator
572 (16) Use a TAB as field separator
573 (64) Prompt for a regular expression as field separator
574 integer When a number, use that many spaces as field separator
575 regexp When a regular expression, use it to match the separator
576 nil When nil, the command tries to be smart and figure out the
577 separator in the following way:
578 - when each line contains a TAB, assume TAB-separated material
579 - when each line contains a comma, assume CSV material
580 - else, assume one or more SPACE characters as separator."
584 re)
586 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
587 org-table-convert-region-max-lines)
596 ;; Get the right field separator
607 ;; parse the csv stuff
632 ;;;###autoload
634 "Import FILE as a table.
635 The file is assumed to be tab-separated. Such files can be produced by most
636 spreadsheet and database applications. If no tabs (at least one per line)
637 are found, lines will be split on whitespace into fields."
646 ;;;###autoload
648 "Export table to a file, with configurable format.
649 Such a file can be imported into usual spreadsheet programs.
651 FILE can be the output file name. If not given, it will be taken
652 from a TABLE_EXPORT_FILE property in the current entry or higher
653 up in the hierarchy, or the user will be prompted for a file
654 name. FORMAT can be an export format, of the same kind as it
655 used when `orgtbl-mode' sends a table in a different format.
657 The command suggests a format depending on TABLE_EXPORT_FORMAT,
658 whether it is set locally or up in the hierarchy, then on the
659 extension of the given file name, and finally on the variable
660 `org-table-export-default-format'."
693 formats)))
694 org-table-export-default-format)
720 "Marker at the beginning of the table last aligned.
723 "Marker at the end of the table last aligned.
726 "List of flags for flushright alignment, from the last re-alignment.
729 "List of max width of fields in each column.
732 "Non-nil means debug table formulas.
744 ;;;###autoload
746 "Align the table at point by aligning all vertical bars."
751 ;; Make sure invisible characters in the table are at the right
752 ;; place since column widths take them into account.
758 ;; Table's rows. Separators are replaced by nil. Trailing
759 ;; spaces are also removed.
765 l)))
767 ;; Get the data fields by splitting the lines.
770 ;; Compute number of fields in the longest line. If the
771 ;; table contains no field, create a default table.
776 ;; A list of empty strings to fill any short rows on output.
778 lengths typenums)
779 ;; Check for special formatting.
782 fmax falign)
783 ;; Look for an explicit width or alignment.
796 ;; Find fields that are wider than FMAX, and shorten them.
801 'help-echo
809 fmax)))
823 f2
825 x))))))
826 ;; Get the maximum width for each column
828 lengths)
829 ;; Get the fraction of numbers among non-empty cells to
830 ;; decide about alignment of the column.
839 1
845 ;; Store alignment of this table, for later editing of single
846 ;; fields.
849 ;; With invisible characters, `format' does not get the field
850 ;; width right So we need to make these fields wide by hand.
851 ;; Invisible characters may be introduced by fontified links,
852 ;; emphasis, macros or sub/superscripts.
870 ;; Compute the formats needed for output of the table.
879 ;; Replace modified lines only. Check not only contents, but
880 ;; also columns' width.
884 hfmt))
906 ;;;###autoload
908 "Find the beginning of the table and return its position.
909 With a non-nil optional argument TABLE-TYPE, return the beginning
910 of a table.el-type table. This function assumes point is on
911 a table."
919 ;;;###autoload
921 "Find the end of the table and return its position.
922 With a non-nil optional argument TABLE-TYPE, return the end of
923 a table.el-type table. This function assumes point is on
924 a table."
932 ;; When the line right after the table is the last line in
933 ;; the buffer with trailing spaces but no final newline
934 ;; character, be sure to catch the correct ending at its
935 ;; beginning. In any other case, ending is expected to be
936 ;; at point max.
941 ;;;###autoload
943 "Justify the current field, text to left, number to right.
944 Optional argument NEW may specify text to replace the current field content."
953 ;; This is not the same table, force a full re-align
959 l f n o e)
985 ;;;###autoload
987 "Go to the next field in the current table, creating new lines as needed.
988 Before doing so, re-align the table if necessary."
993 org-table-may-need-update)
1004 org-table-tab-jumps-over-hlines
1015 ;;;###autoload
1017 "Go to the previous field in the table.
1018 Before doing so, re-align the table if necessary."
1023 org-table-may-need-update)
1038 "Move to the beginning of the current table field.
1039 If already at or before the beginning, move to the beginning of the
1040 previous field.
1041 With numeric argument N, move N-1 fields backward first."
1054 "Move to the end of the current table field.
1055 If already at or after the end, move to the end of the next table field.
1056 With numeric argument N, move N-1 fields forward first."
1069 ;;;###autoload
1071 "Go to the next row (same column) in the current table.
1072 Before doing so, re-align the table if necessary."
1080 org-table-may-need-update)
1093 ;;;###autoload
1095 "Copy the value of the current field one row below.
1097 If the field at the cursor is empty, copy the content of the
1098 nearest non-empty field above. With argument N, use the Nth
1099 non-empty field.
1101 If the current field is not empty, it is copied down to the next
1102 row, and the cursor is moved with it. Therefore, repeating this
1103 command causes the column to be filled row-by-row.
1105 If the variable `org-table-copy-increment' is non-nil and the
1106 field is an integer or a timestamp, it will be incremented while
1107 copying. By default, increment by the difference between the
1108 value in the current field and the one in the field above. To
1109 increment using a fixed integer, set `org-table-copy-increment'
1110 to a number. In the case of a timestamp, increment by days."
1122 txt txt-up inc)
1130 beg t))
1140 beg t))
1147 ;; Above field was not empty, go down to the next row
1180 "Is point inside a table data field?
1181 I.e. not on a hline or before the first or after the last column?
1182 This actually throws an error, so it aborts the current command."
1194 "Get the field in table line LINE, column COLUMN.
1195 If LINE is larger than the number of data lines in the table, the function
1196 returns nil. However, if COLUMN is too large, we will simply return an
1197 empty string.
1198 If LINE is nil, use the current line.
1199 If COLUMN is nil, use the current column."
1206 "Put VALUE into line LINE, column COLUMN.
1207 When ALIGN is set, also realign the table."
1216 "Return the index of the current data line."
1223 cnt))
1226 "Go to the Nth data line in the current table.
1227 Return t when the line exists, nil if it does not exist."
1234 ;;;###autoload
1236 "Blank the current table field or active region."
1253 "Return the value of the field in column N of current row.
1254 N defaults to current field.
1255 If REPLACE is a string, replace field with this value. The return value
1256 is always the old value."
1265 t t))
1267 val)
1270 ;;;###autoload
1272 "Show info about the current field, and highlight any reference at point."
1282 col)
1283 org-table-named-field-locations)))
1293 ;; Prioritize field formulas over column formulas.
1302 dline col
1304 dline col ref1
1306 ;; FIXME: formula info not correct if special table line
1316 "Find out which column we are in."
1325 column)))
1327 ;;;###autoload
1329 "Find out what table data line we are in.
1330 Only data lines count for this."
1343 c)))
1345 ;;;###autoload
1347 "Move the cursor to the Nth column in the current table line.
1348 With optional argument ON-DELIM, stop with point before the left delimiter
1349 of the field.
1350 If there are less than N fields, just go to after the last delimiter.
1351 However, when FORCE is non-nil, create new columns if necessary."
1361 t)))))
1368 ;;;###autoload
1370 "Insert a new column into the table."
1392 "Find a data line in the current table, which is needed for column commands."
1395 t
1406 t
1411 "Turn a buffer line number into a data line number.
1413 If there is no data line in this line, return nil.
1415 If there is no matching dline (most likely the reference was
1416 a hline), the first dline below it is used. When ABOVE is
1417 non-nil, the one above is used."
1422 nil)
1433 ;;;###autoload
1435 "Delete a column from the table."
1447 nil
1462 ;;;###autoload
1464 "Move column to the right."
1467 ;;;###autoload
1469 "Move column to the left."
1473 ;;;###autoload
1475 "Move the current column to the right. With arg LEFT, move to the left."
1509 ;;;###autoload
1511 "Move table row down."
1514 ;;;###autoload
1516 "Move table row up."
1520 ;;;###autoload
1522 "Move the current table line down. With arg UP, move it up."
1531 txt hline2p)
1554 ;;;###autoload
1556 "Insert a new row above the current line into the table.
1557 With prefix ARG, insert below the current line."
1563 ;; Fix the first field if necessary
1576 ;;;###autoload
1578 "Insert a horizontal-line below the current line into the table.
1579 With prefix ABOVE, insert above the current line."
1600 ;;;###autoload
1602 "Insert a hline and move to the row below that line."
1616 In particular, this does handle wide and invisible characters."
1618 ;; It's a hline, just map the characters
1624 t t s)))
1625 s))
1627 ;;;###autoload
1629 "Delete the current row or horizontal line from the table."
1643 ;;;###autoload
1645 "Sort table lines according to the column at point.
1647 The position of point indicates the column to be used for
1648 sorting, and the range of lines is the range between the nearest
1649 horizontal separator lines, or the entire table of no such lines
1650 exist. If point is before the first column, you will be prompted
1651 for the sorting column. If there is an active region, the mark
1652 specifies the first line and the sorting column, while point
1653 should be in the last line to be included into the sorting.
1655 The command then prompts for the sorting type which can be
1656 alphabetically, numerically, or by time (as given in a time stamp
1657 in the field, or as a HH:MM value). Sorting in reverse order is
1658 also possible.
1660 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1662 If SORTING-TYPE is specified when this function is called from a Lisp
1663 program, no prompting will take place. SORTING-TYPE must be a character,
1664 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1665 sorting should be done in reverse order.
1667 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1668 a function to be called to extract the key. It must return either
1669 a string or a number that should serve as the sorting key for that
1670 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1671 is specified interactively, the comparison will be either a string or
1672 numeric compare based on the type of the first key in the table."
1675 ;; Point must be either within a field or before a data line.
1680 ;; Set appropriate case sensitivity and column used for sorting.
1691 ;; Narrow buffer to appropriate sorting area.
1704 start))
1707 end))))
1708 ;; Determine arguments for `sort-subr'. Also record original
1709 ;; position. `org-table-save-field' cannot help here since
1710 ;; sorting is too much destructive.
1716 ;; Function to be called on the contents of the field
1717 ;; used for sorting in the current row.
1749 #'end-of-line
1753 nil
1754 predicate)
1755 ;; Move back to initial field.
1759 ;;;###autoload
1761 "Copy region in table to the clipboard and blank all relevant fields.
1762 If there is no active region, use just the field at point."
1768 ;;;###autoload
1770 "Copy rectangular region in table to clipboard.
1771 A special clipboard is used which can only be accessed
1772 with `org-table-paste-rectangle'."
1776 current-prefix-arg))
1781 region)
1793 ;; Collect every cell between COLUMN-START and COLUMN-END.
1803 ;;;###autoload
1805 "Paste a rectangular region into a table.
1806 The upper right corner ends up in the current field. All involved fields
1807 will be overwritten. If the rectangle does not fit into the present table,
1808 the table is enlarged as needed. The process ignores horizontal separator
1809 lines."
1820 ;; If we left the table, create a new row.
1832 ;;;###autoload
1834 "Convert from `org-mode' table to table.el and back.
1835 Obviously, this only works within limits. When an Org-mode table is
1836 converted to table.el, all horizontal separator lines get lost, because
1837 table.el uses these as cell boundaries and has no notion of horizontal lines.
1838 A table.el table can be converted to an Org-mode table only if it does not
1839 do row or column spanning. Multiline cells will become multiple cells.
1840 Beware, Org-mode does not test if the table can be successfully converted - it
1841 blindly applies a recipe that works for simple tables."
1845 ;; convert to Org-mode table
1854 ;; convert to table.el table
1857 ;; first, get rid of all horizontal lines
1861 ;; insert a hline before first
1865 ;; insert a hline after each line
1870 ;; replace "+" at beginning and ending of hlines
1879 "Transpose Org table at point and eliminate hlines.
1880 So a table like
1882 | 1 | 2 | 4 | 5 |
1883 |---+---+---+---|
1884 | a | b | c | d |
1885 | e | f | g | h |
1887 will be transposed as
1889 | 1 | a | e |
1890 | 2 | b | f |
1891 | 4 | c | g |
1892 | 5 | d | h |
1894 Note that horizontal lines disappear."
1906 table)))
1920 ;;;###autoload
1922 "Wrap several fields in a column like a paragraph.
1923 This is useful if you'd like to spread the contents of a field over several
1924 lines, in order to keep the table compact.
1926 If there is an active region, and both point and mark are in the same column,
1927 the text in the column is wrapped to minimum width for the given number of
1928 lines. Generally, this makes the table more compact. A prefix ARG may be
1929 used to change the number of desired lines. For example, \
1931 formats the selected text to two lines. If the region was longer than two
1932 lines, the remaining lines remain empty. A negative prefix argument reduces
1933 the current number of lines by that amount. The wrapped text is pasted back
1934 into the table. If you formatted it to more lines than it was before, fields
1935 further down in the table get overwritten - so you might need to make space in
1936 the table first.
1938 If there is no region, the current field is split at the cursor position and
1939 the text fragment to the right of the cursor is prepended to the field one
1940 line down.
1942 If there is no region, but you specify a prefix ARG, the current field gets
1943 blank, and the content is appended to the field above."
1947 ;; There is a region: fill as a paragraph.
1958 nil
1959 nlines))))
1962 ;; No region, split the current field at point.
1987 ;;;###autoload
1989 "Edit table field in a different window.
1990 This is mainly useful for fields that contain hidden parts.
1992 it can be edited in place."
2001 display t intangible t))
2014 p)
2030 intangible t))
2038 "Finish editing a table data field.
2039 Remove all newline characters, insert the result into the table, realign
2040 the table and kill the editing buffer."
2044 text)
2061 "Minor mode to make the table field editor window follow the cursor.
2062 When this mode is active, the field editor window will always show the
2063 current field. The mode exits automatically when the cursor leaves the
2064 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2065 nil " TblFollow" nil
2081 ;; We have left the table, exit the follow mode
2091 ;;;###autoload
2093 "Sum numbers in region of current table column.
2094 The result will be displayed in the echo area, and will be available
2097 If there is an active region, it is interpreted as a rectangle and all
2098 numbers in that rectangle will be summed. If there is no active
2099 region and point is located in a table column, sum all numbers in that
2100 column.
2102 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2103 numbers are assumed to be times as well (in decimal hours) and the
2104 numbers are added as such.
2106 If NLAST is a number, only the NLAST fields will actually be summed."
2133 items1)))
2140 s diff)
2147 sres))))
2170 "Return the formula active for the current field.
2172 Assumes that table is already analyzed. If KEY is given, return
2173 the key to this formula. Otherwise return the formula preceded
2182 org-table-named-field-locations)))
2196 "Read a formula from the minibuffer, offer stored formula as default.
2197 When NAMED is non-nil, look for a named equation."
2202 org-table-named-field-locations)))
2222 stored)
2224 equation)
2230 scol))
2232 'org-table-formula-history
2233 )))))
2234 mustsave)
2236 ;; remove formula
2243 ;; We set the column equation, delete the named one.
2245 mustsave t))
2251 eq))
2254 "Store the list of formulas below the current table.
2255 If optional argument LOCATION is a buffer position, insert it at
2256 LOCATION instead."
2264 ;; Don't overwrite TBLFM, we might use text properties to
2265 ;; store stuff.
2279 ;; Fake a high number to make sure this is sorted at the end.
2286 a)
2296 "Compare two formulas for sorting."
2301 ;;;###autoload
2303 "Return an alist with the stored formulas directly after current table.
2304 By default, only return active formulas, i.e., formulas located
2305 on the first line after the table. However, if optional argument
2306 LOCATION is a buffer position, consider the formulas there."
2315 eq-alist seen)
2319 string)
2324 ;; Is it a column reference?
2326 ;; Since named columns are not possible in
2327 ;; LHS, assume this is a named field.
2335 "Double definition `%s=' in TBLFM line, please fix by hand"
2336 lhs)
2341 "Double definition `%s=' in TBLFM line, please fix by hand"
2342 lhs)))))))))))
2345 "Modify the equations after the table structure has been edited.
2347 For all numbers larger than LIMIT, shift them by DELTA."
2359 s n a)
2365 "Change makes TBLFM term %s invalid, use undo to recover"
2380 ;;;###autoload
2383 If yes, store the formula and apply it."
2384 ;; We already know we are in a table. Get field will only return a formula
2385 ;; when appropriate. It might return a separator line, but no problem.
2388 named eq)
2399 "List of commands triggering the recalculation of a line.
2411 ;;;###autoload
2413 "Rotate the recalculation mark in the first column.
2414 If in any row, the first field is not consistent with a mark,
2415 insert a new column for the markers.
2416 When there is an active region, change all the lines in the region,
2417 after prompting for the marking character.
2418 After each change, a message will be displayed indicating the meaning
2419 of the new mark."
2435 newchar))
2443 newchar))
2461 ;; Rotate mark in first row.
2463 ;; Rotate marks in additional rows if a region is active.
2471 ;; Only align if rotation actually changed lines' length.
2481 ;;;###autoload
2483 "Analyze table at point and store results.
2485 This function sets up the following dynamically scoped variables:
2487 `org-table-column-name-regexp',
2488 `org-table-column-names',
2489 `org-table-current-begin-pos',
2490 `org-table-current-line-types',
2491 `org-table-current-ncol',
2492 `org-table-dlines',
2493 `org-table-hlines',
2494 `org-table-local-parameters',
2495 `org-table-named-field-locations'."
2500 ;; Extract column names.
2513 ;; Extract local parameters.
2521 org-table-local-parameters)))))
2522 ;; Update named fields locations. We minimize `count-lines'
2523 ;; processing by storing last known number of lines in LAST.
2545 field))
2548 org-table-named-field-locations))))))))))
2549 ;; Re-use existing markers when possible.
2553 ;; Analyze the line types.
2564 ;; Get the number of columns from the first data line in table.
2572 al al2)
2586 "Move point to a specific field in the current table.
2588 REF is either the name of a field its absolute reference, as
2589 a string. No column is created unless CREATE-COLUMN-P is
2590 non-nil. If it is a function, it is called with the column
2591 number as its argument as is used as a predicate to know if the
2592 column can be created.
2594 This function assumes the table is already analyzed (i.e., using
2595 `org-table-analyze')."
2610 create-column-p)))
2616 ;;;###autoload
2618 "Recompute the current line if marked for it, and if we haven't just done it."
2638 org-tbl-calc-modes)
2640 ;;;###autoload
2642 suppress-align suppress-const
2643 suppress-store suppress-analysis)
2644 "Replace the table field value at the cursor by the result of a calculation.
2646 In a table, this command replaces the value in the current field with the
2648 formula, by storing it in a special line below the table. When called
2650 field formula.
2653 insert the active equation for the field
2654 back into the current field, so that it can be edited there. This is \
2655 useful
2657 check the referenced fields.
2659 When called, the command first prompts for a formula, which is read in
2660 the minibuffer. Previously entered formulas are available through the
2661 history list, and the last used formula is offered as a default.
2662 These stored formulas are adapted correctly when moving, inserting, or
2663 deleting columns with the corresponding commands.
2665 The formula can be any algebraic expression understood by the Calc package.
2666 For details, see the Org mode manual.
2668 This function can also be called from Lisp programs and offers
2669 additional arguments: EQUATION can be the formula to apply. If this
2670 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2671 used to speed-up recursive calls by by-passing unnecessary aligns.
2672 SUPPRESS-CONST suppresses the interpretation of constants in the
2673 formula, assuming that this has been done already outside the function.
2674 SUPPRESS-STORE means the formula should not be stored, either because
2675 it is already stored, or because it is a modified equation that should
2676 not overwrite the stored one. SUPPRESS-ANALYSIS prevents any call to
2677 `org-table-analyze'."
2692 equation
2698 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2699 duration duration-output-format)
2700 ;; Parse the format string. Since we have a lot of modes, this is
2701 ;; a lot of work. However, I think calc still uses most of the time.
2714 'calc-float-format
2717 n))))
2721 duration-output-format nil
2725 duration-output-format org-table-duration-custom-format
2726 numbers t
2752 ;; replace fields with duration values if relevant
2756 fields)))
2762 x))
2763 fields)))
2769 ;; Insert row and column number of formula result field
2780 t t form)))
2782 ;; Check for old vertical references
2784 ;; Insert remote references
2797 rmtrng))
2798 keep-empty numbers lispp))
2799 t t form)))
2800 ;; Insert complex ranges
2810 ;; possibly handle durations
2815 formrg)
2816 keep-empty numbers lispp)))
2821 ;; Insert simple ranges, i.e. included in the current row.
2824 form)
2834 keep-empty numbers lispp))
2835 t t form)))
2837 ;; Insert the references to fields in same row
2844 x keep-empty numbers lispp)))
2862 ;; Use <...> time-stamps so that Calc can handle them
2865 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2876 form
2883 duration-output-format)
2884 ev)))
2889 Orig: %s
2890 $xyz-> %s
2891 @r$c-> %s
2923 prop value)))
2926 "Get a calc vector from a column, according to descriptor DESC.
2928 Optional arguments TBEG and COL can give the beginning of the table and
2929 the current column, to avoid unnecessary parsing.
2931 HIGHLIGHT means just highlight the range.
2933 When CORNERS-ONLY is set, only return the corners of the range as
2934 a list (line1 column1 line2 column2) where line1 and line2 are
2935 line numbers relative to beginning of table, or TBEG, and column1
2936 and column2 are table column numbers."
2939 desc))
2950 thisline)))
2955 thisline)))
2967 ;; Just one field.
2974 ;; A range, return a vector. First sort the numbers to get
2975 ;; a regular rectangle.
2981 ;; Copy the range values into a list.
2996 ;; Return string representation of calc vector.
3002 "Return relative line number corresponding to descriptor DESC.
3003 The cursor is currently in relative line number CLINE."
3008 ;; 1 2 3 4 5 6
3009 desc))
3031 cline)))
3034 "Return relative line of Nth row with type TYPE.
3035 Search starts from relative line I. When BACKWARDS in non-nil,
3036 look before I. When RELATIVE is non-nil, the reference is
3037 relative. DESC is the original descriptor that started the
3038 search, as a string."
3046 ;; We are going to cross a hline. Check if this is
3047 ;; an authorized move.
3058 ;; The last hline doesn't exist. Instead, point to last row
3059 ;; in table.
3068 "Convert list ELEMENTS to something appropriate to insert into formula.
3069 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3070 NUMBERS indicates that everything should be converted to numbers.
3071 LISPP non-nil means to return something appropriate for a Lisp
3072 list, `literal' is for the format specifier L."
3073 ;; Calc nan (not a number) is used for the conversion of the empty
3074 ;; field to a reference for several reasons: (i) It is accepted in a
3075 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3076 ;; (ii) In a single field (not in range) it can be distinguished
3077 ;; from "(nan)" which is the reference made from a single field
3078 ;; containing "nan".
3080 ;; field reference
3083 elements
3085 ""
3094 ;; range reference
3099 elements))))
3105 x
3113 x)
3115 elements
3119 "If there has been more than one second since T1, display message.
3120 ARGS are passed as arguments to the `message' function. Returns
3121 current time if a message is printed, otherwise returns T1. If
3122 T1 is nil, always messages."
3126 curtime)
3127 t1)))
3129 ;;;###autoload
3131 "Recalculate the current table line by applying all stored formulas.
3133 With prefix arg ALL, do this for all lines in the table.
3136 if ALL is the symbol `iterate',
3137 recompute the table until it no longer changes.
3139 If NOALIGN is not nil, do not re-align the table after the computations
3140 are done. This is typically used internally to save time, if it is
3141 known that the table will be realigned a little later anyway."
3156 beg end eqlcol eqlfield)
3157 ;; Insert constants in all formulas.
3160 ;; Expand equations, then split the equation list between
3161 ;; column formulas and field formulas.
3173 old-lhs)))
3176 existing formula for column %s"
3177 old-lhs
3178 new))
3179 new))
3185 ;; Expand ranges in lhs of formulas
3187 ;; Get the correct line range to process.
3194 ;; This is a table with marked lines, compute selected
3195 ;; lines.
3197 ;; Move forward to the first non-header line.
3202 ;; Just leave BEG where it is.
3207 ;; Mark named fields untouchable. Also check if several
3208 ;; field/range formulas try to set the same field.
3212 seen-fields)
3223 ;; Turn field coordinates associated to NAME
3224 ;; into an absolute reference.
3228 name)))
3231 reference))
3236 ;; Evaluate the column formulas, but skip fields covered by
3237 ;; field formulas.
3241 ;; Unprotected line, recalculate.
3246 log-last-time
3259 ;; Evaluate the field formulas.
3268 reference
3269 ;; Possibly create a new column, as long as
3270 ;; `org-table-formula-create-columns' allows it.
3282 t))
3287 ;; Clean up markers and internal text property.
3298 ;;;###autoload
3300 "Recalculate the table until it does not change anymore.
3301 The maximum number of iterations is 10, but you can choose a different value
3302 with the prefix ARG."
3307 thistbl)
3321 ;;;###autoload
3323 "Recalculate all tables in the current buffer."
3330 ;;;###autoload
3332 "Iterate all tables in the buffer, to converge inter-table dependencies."
3337 c1)
3353 "Apply the #+TBLFM in the line at point to the table."
3360 ;; Insert a temporary formula at right after the table
3365 ;; Recalculate the table.
3370 ;; Delete the formula inserted temporarily.
3376 "Find the beginning of the TBLFM lines and return its position.
3377 Return nil when the beginning of TBLFM line was not found."
3384 "Expand list of formulas.
3385 If some of the RHS in the formulas are ranges or a row reference,
3386 expand them to individual field equations for each field. This
3387 function assumes the table is already analyzed (i.e., using
3388 `org-table-analyze')."
3395 ;; This just refers to one fixed field.
3398 ;; This just refers to one fixed named field.
3401 ;; Column formulas are treated specially and are not
3402 ;; expanded.
3407 rhs)
3408 res)))
3420 rhs)
3421 res))))))))))
3424 "Replace @<, @>, $<, $> with first/last row/column of the table.
3425 So @< and $< will always be replaced with @1 and $1, respectively.
3426 The advantage of these special markers are that structure editing of
3427 the table will not change them, while @1 and $1 will be modified
3428 when a line/row is swapped out of that privileged position. So for
3429 formulas that use a range of rows or columns, it may often be better
3431 borders of the table using the @< @> $< $> makers."
3434 s start)
3439 org-table-current-ncol)
3443 len
3450 s)
3453 "Replace $const with values in string F."
3458 org-table-column-name-regexp
3461 org-table-column-names))))
3462 f t t)))
3463 ;; Parameters and constants.
3467 new start))
3470 ;; When a duration is expected, convert value on the fly.
3476 v)))))
3483 "Find the value for a parameter or constant in a formula.
3484 Parameters get priority."
3515 map))
3522 "--"
3525 "--"
3526 "Shift Reference at Point"
3531 "-"
3532 "Change Test Row for Column Formulas"
3535 "--"
3540 org-table-overlay-coordinates)]
3541 "--"
3549 ;;;###autoload
3551 "Edit the formulas of the current table in a separate buffer."
3557 ;; Move point within the table before analyzing it.
3573 ;; Keep global-font-lock-mode from turning on font-lock-mode
3618 "Convert a formula from internal to user representation."
3621 s))
3624 "Convert a formula from user to internal representation."
3627 s))
3630 "Convert spreadsheet references from A7 to @7$28.
3631 Works for single references, but also for entire formulas and even the
3632 full TBLFM line."
3634 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3637 ;; format match, just advance
3642 ;; 3.e5 or something like this.
3645 ;; (member (match-string 1 s)
3646 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3647 )
3648 ;; function name, just advance
3658 t t s)))))
3659 s))
3662 "Convert spreadsheet references from to @7$28 to AB7.
3663 Works for single references, but also for entire formulas and even the
3664 full TBLFM line."
3671 t t s)))
3676 t nil s)))
3677 s)
3680 "Convert a base 26 number represented by letters into an integer.
3681 For example: AB -> 28."
3687 n))
3690 "Convert an integer into a base 26 number represented by letters.
3691 For example: 28 -> AB."
3696 s))
3699 "Convert a time string into numerical duration in seconds.
3700 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3701 If S is a string representing a number, keep this number."
3703 s
3726 "Convert a number of seconds to a time string.
3727 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3728 minutes or seconds."
3743 "Convert all references in this buffer, using FUNCTION."
3754 "Convert all references in the buffer from B3 to @3$2 and back."
3764 "Shift the reference at point one row/hline up."
3768 "Shift the reference at point one row/hline down."
3772 "Shift the reference at point one field to the left."
3776 "Shift the reference at point one field to the right."
3787 ;; A B3-like reference
3793 ;; An internal reference
3799 "Re-match the group N, and replace it with the shifted reference."
3804 t t)))
3807 "Shift a reference part REF.
3808 If DECR is set, decrease the references row/column, else increase.
3809 If HLINE is set, this may be a hline reference, it certainly is not
3810 a translation reference."
3839 "Toggle the display of coordinates in the referenced table."
3848 "Parse the buffer for formula definitions and install them.
3849 With prefix ARG, apply the new formulas to the table."
3858 eql)
3861 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3862 nil t)
3883 "Abort editing formulas, without installing the changes."
3894 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3935 "Show the location/value of the $ expression at point.
3936 When LOCAL is non-nil, show references for the table at point."
3946 var name e what match dest)
3950 "$1.."
4002 dest)
4028 ;; Column number.
4054 org-table-fedit-scroll-down))))
4066 "Make sure the cursor is in a dataline in a table."
4075 p1 p2)))
4080 "Move cursor one line up in the window showing the table."
4085 "Move cursor one line down in the window showing the table."
4090 "Move the cursor in the window showing the table.
4091 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4116 "Add a new overlay."
4122 "Highlight rectangular region in a table.
4123 When buffer positions BEG and END are provided, use them to
4124 delimit the region to highlight. Otherwise, refer to point. Use
4125 FACE, when non-nil, for the highlight."
4157 "Remove the rectangle overlays."
4168 "Add overlays to the table at point, to show row/column coordinates."
4196 ;;;###autoload
4198 "Toggle the display of Row/Column numbers in tables."
4209 ;;;###autoload
4211 "Toggle the formula debugger in tables."
4217 ;;; The orgtbl minor mode
4219 ;; Define a minor mode which can be used in other modes in order to
4220 ;; integrate the org-mode table editor.
4222 ;; This is really a hack, because the org-mode table editor uses several
4223 ;; keys which normally belong to the major mode, for example the TAB and
4224 ;; RET keys. Here is how it works: The minor mode defines all the keys
4225 ;; necessary to operate the table editor, but wraps the commands into a
4226 ;; function which tests if the cursor is currently inside a table. If that
4227 ;; is the case, the table editor command is executed. However, when any of
4228 ;; those keys is used outside a table, the function uses `key-binding' to
4229 ;; look up if the key has an associated command in another currently active
4230 ;; keymap (minor modes, major mode, global), and executes that command.
4231 ;; There might be problems if any of the keys used by the table editor is
4232 ;; otherwise used as a prefix key.
4234 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4235 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4236 ;; addresses this by checking explicitly for both bindings.
4238 ;; The optimized version (see variable `orgtbl-optimized') takes over
4239 ;; all keys which are bound to `self-insert-command' in the *global map*.
4240 ;; Some modes bind other commands to simple characters, for example
4241 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4242 ;; active, this binding is ignored inside tables and replaced with a
4243 ;; modified self-insert.
4261 ;; Install it as a minor mode.
4265 ;;;###autoload
4267 "The `org-mode' table editor as a minor mode for use in other modes."
4272 ;; Exit without error, in case some hook functions calls this
4273 ;; by accident in org-mode.
4277 ;; Make sure we are first in minor-mode-map-alist
4279 ;; FIXME: maybe it should use emulation-mode-map-alists?
4286 auto-fill-inhibit-regexp)
4290 auto-fill-inhibit-regexp)
4291 orgtbl-line-start-regexp))
4309 "Remove all properties related to narrow-column invisibility."
4322 "Create a function for binding in the table minor mode.
4323 FUN is the command to call inside a table. N is used to create a unique
4324 command name. KEYS are keys that should be checked in for a command
4325 to execute outside of tables."
4331 "Outside of tables, run the binding of `"
4343 keys)
4347 "Error when there is no default binding for a table key."
4352 "Setup orgtbl keymaps."
4383 elt key fun cmd)
4391 ;; Special treatment needed for TAB and RET
4411 [(tab)] "\C-i")))
4413 (org-defkey orgtbl-mode-map [backtab]
4415 [backtab] [S-iso-lefttab] [(shift tab)]
4416 [(tab)] "\C-i"))
4418 (org-defkey orgtbl-mode-map "\M-\C-m"
4419 (orgtbl-make-binding 'org-table-wrap-region 105
4420 "\M-\C-m" [(meta return)]))
4421 (org-defkey orgtbl-mode-map [(meta return)]
4422 (orgtbl-make-binding 'org-table-wrap-region 106
4423 [(meta return)] "\M-\C-m"))
4425 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4426 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4428 (when orgtbl-optimized
4429 ;; If the user wants maximum table support, we need to hijack
4430 ;; some standard editing functions
4431 (org-remap orgtbl-mode-map
4432 'self-insert-command 'orgtbl-self-insert-command
4433 'delete-char 'org-delete-char
4434 'delete-backward-char 'org-delete-backward-char)
4435 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4436 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4437 '("OrgTbl"
4438 ["Create or convert" org-table-create-or-convert-from-region
4439 :active (not (org-at-table-p)) :keys "C-c |" ]
4440 "--"
4441 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4442 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4443 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4444 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4445 "--"
4446 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4447 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4448 ["Copy Field from Above"
4449 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4450 "--"
4451 ("Column"
4452 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4453 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4454 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4455 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4456 ("Row"
4457 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4458 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4459 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4460 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4461 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4462 "--"
4463 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4464 ("Rectangle"
4465 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4466 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4467 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4468 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4469 "--"
4470 ("Radio tables"
4471 ["Insert table template" orgtbl-insert-radio-table
4472 (assq major-mode orgtbl-radio-table-templates)]
4473 ["Comment/uncomment table" orgtbl-toggle-comment t])
4474 "--"
4475 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4476 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4477 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4478 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4479 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4480 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4481 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4482 ["Sum Column/Rectangle" org-table-sum
4483 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4484 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4485 ["Debug Formulas"
4486 org-table-toggle-formula-debugger :active (org-at-table-p)
4487 :keys "C-c {"
4488 :style toggle :selected org-table-formula-debug]
4489 ["Show Col/Row Numbers"
4490 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4491 :keys "C-c }"
4492 :style toggle :selected org-table-overlay-coordinates]
4493 "--"
4494 ("Plot"
4497 t))
4499 (defun orgtbl-ctrl-c-ctrl-c (arg)
4500 "If the cursor is inside a table, realign the table.
4501 If it is a table to be sent away to a receiver, do it.
4502 With prefix arg, also recompute table."
4503 (interactive "P")
4504 (let ((case-fold-search t) (pos (point)) action)
4505 (save-excursion
4506 (beginning-of-line 1)
4507 (setq action (cond
4511 (cond
4512 ((integerp action)
4513 (goto-char action)
4514 (org-table-maybe-eval-formula)
4515 (if arg
4516 (call-interactively 'org-table-recalculate)
4517 (org-table-maybe-recalculate-line))
4518 (call-interactively 'org-table-align)
4519 (when (orgtbl-send-table 'maybe)
4520 (run-hooks 'orgtbl-after-send-table-hook)))
4521 ((eq action 'recalc)
4522 (save-excursion
4523 (beginning-of-line 1)
4525 (if (org-at-table-p)
4526 (org-call-with-arg 'org-table-recalculate t))))
4527 (t (let (orgtbl-mode)
4528 (call-interactively (key-binding "\C-c\C-c")))))))
4530 (defun orgtbl-create-or-convert-from-region (arg)
4531 "Create table or convert region to table, if no conflicting binding.
4532 This installs the table binding `C-c |', but only if there is no
4533 conflicting binding to this key outside orgtbl-mode."
4534 (interactive "P")
4535 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4536 (if cmd
4537 (call-interactively cmd)
4538 (call-interactively 'org-table-create-or-convert-from-region))))
4540 (defun orgtbl-tab (arg)
4541 "Justification and field motion for `orgtbl-mode'."
4542 (interactive "P")
4543 (if arg (org-table-edit-field t)
4544 (org-table-justify-field-maybe)
4545 (org-table-next-field)))
4547 (defun orgtbl-ret ()
4548 "Justification and field motion for `orgtbl-mode'."
4549 (interactive)
4550 (if (bobp)
4551 (newline)
4552 (org-table-justify-field-maybe)
4553 (org-table-next-row)))
4555 (defun orgtbl-self-insert-command (N)
4556 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4557 If the cursor is in a table looking at whitespace, the whitespace is
4558 overwritten, and the table is not marked as requiring realignment."
4559 (interactive "p")
4560 (if (and (org-at-table-p)
4561 (or
4562 (and org-table-auto-blank-field
4563 (member last-command
4564 '(orgtbl-hijacker-command-100
4565 orgtbl-hijacker-command-101
4566 orgtbl-hijacker-command-102
4567 orgtbl-hijacker-command-103
4568 orgtbl-hijacker-command-104
4569 orgtbl-hijacker-command-105
4570 yas/expand))
4571 (org-table-blank-field))
4572 t)
4573 (eq N 1)
4575 (let (org-table-may-need-update)
4576 (delete-region (match-beginning 1) (match-end 1))
4577 (self-insert-command N))
4578 (setq org-table-may-need-update t)
4579 (let* (orgtbl-mode
4580 a
4581 (cmd (or (key-binding
4582 (or (and (listp function-key-map)
4583 (setq a (assoc last-input-event function-key-map))
4584 (cdr a))
4585 (vector last-input-event)))
4586 'self-insert-command)))
4587 (call-interactively cmd)
4588 (if (and org-self-insert-cluster-for-undo
4589 (eq cmd 'self-insert-command))
4590 (if (not (eq last-command 'orgtbl-self-insert-command))
4591 (setq org-self-insert-command-undo-counter 1)
4592 (if (>= org-self-insert-command-undo-counter 20)
4593 (setq org-self-insert-command-undo-counter 1)
4594 (and (> org-self-insert-command-undo-counter 0)
4595 buffer-undo-list
4596 (not (cadr buffer-undo-list)) ; remove nil entry
4597 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4598 (setq org-self-insert-command-undo-counter
4599 (1+ org-self-insert-command-undo-counter))))))))
4601 ;;;###autoload
4603 "Regular expression matching exponentials as produced by calc.")
4605 (defun orgtbl-gather-send-defs ()
4606 "Gather a plist of :name, :transform, :params for each destination before
4607 a radio table."
4608 (save-excursion
4609 (goto-char (org-table-begin))
4610 (let (rtn)
4611 (beginning-of-line 0)
4612 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4613 (let ((name (org-no-properties (match-string 1)))
4614 (transform (intern (match-string 2)))
4615 (params (if (match-end 3)
4616 (read (concat "(" (match-string 3) ")")))))
4617 (push (list :name name :transform transform :params params)
4618 rtn)
4619 (beginning-of-line 0)))
4620 rtn)))
4622 (defun orgtbl-send-replace-tbl (name txt)
4623 "Find and replace table NAME with TXT."
4624 (save-excursion
4625 (goto-char (point-min))
4626 (unless (re-search-forward
4628 (user-error "Don't know where to insert translated table"))
4629 (let ((beg (line-beginning-position 2)))
4630 (unless (re-search-forward
4631 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4632 (user-error "Cannot find end of insertion region"))
4633 (beginning-of-line)
4634 (delete-region beg (point)))
4637 ;;;###autoload
4638 (defun org-table-to-lisp (&optional txt)
4639 "Convert the table at point to a Lisp structure.
4640 The structure will be a list. Each item is either the symbol `hline'
4641 for a horizontal separator line, or a list of field values as strings.
4642 The table is taken from the parameter TXT, or from the buffer at point."
4643 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4644 (let ((txt (or txt
4645 (buffer-substring-no-properties (org-table-begin)
4646 (org-table-end)))))
4647 (mapcar (lambda (x)
4648 (if (string-match org-table-hline-regexp x) 'hline
4652 (defun orgtbl-send-table (&optional maybe)
4653 "Send a transformed version of table at point to the receiver position.
4654 With argument MAYBE, fail quietly if no transformation is defined
4655 for this table."
4656 (interactive)
4657 (catch 'exit
4658 (unless (org-at-table-p) (user-error "Not at a table"))
4659 ;; when non-interactive, we assume align has just happened.
4660 (when (org-called-interactively-p 'any) (org-table-align))
4661 (let ((dests (orgtbl-gather-send-defs))
4662 (table (org-table-to-lisp
4663 (buffer-substring-no-properties (org-table-begin)
4664 (org-table-end))))
4665 (ntbl 0))
4666 (unless dests
4667 (if maybe (throw 'exit nil)
4668 (user-error "Don't know how to transform this table")))
4669 (dolist (dest dests)
4670 (let ((name (plist-get dest :name))
4671 (transform (plist-get dest :transform))
4672 (params (plist-get dest :params)))
4673 (unless (fboundp transform)
4674 (user-error "No such transformation function %s" transform))
4675 (orgtbl-send-replace-tbl name (funcall transform table params)))
4676 (incf ntbl))
4677 (message "Table converted and installed at %d receiver location%s"
4678 ntbl (if (> ntbl 1) "s" ""))
4679 (and (> ntbl 0) ntbl))))
4681 (defun org-remove-by-index (list indices &optional i0)
4682 "Remove the elements in LIST with indices in INDICES.
4683 First element has index 0, or I0 if given."
4684 (if (not indices)
4685 list
4686 (if (integerp indices) (setq indices (list indices)))
4687 (setq i0 (1- (or i0 0)))
4688 (delq :rm (mapcar (lambda (x)
4689 (setq i0 (1+ i0))
4690 (if (memq i0 indices) :rm x))
4691 list))))
4693 (defun orgtbl-toggle-comment ()
4694 "Comment or uncomment the orgtbl at point."
4695 (interactive)
4696 (let* ((case-fold-search t)
4697 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4698 (re2 (concat "^" orgtbl-line-start-regexp))
4699 (commented (save-excursion (beginning-of-line 1)
4700 (cond ((looking-at re1) t)
4701 ((looking-at re2) nil)
4702 (t (user-error "Not at an org table")))))
4703 (re (if commented re1 re2))
4704 beg end)
4705 (save-excursion
4706 (beginning-of-line 1)
4707 (while (looking-at re) (beginning-of-line 0))
4708 (beginning-of-line 2)
4709 (setq beg (point))
4710 (while (looking-at re) (beginning-of-line 2))
4711 (setq end (point)))
4712 (comment-region beg end (if commented '(4) nil))))
4714 (defun orgtbl-insert-radio-table ()
4715 "Insert a radio table template appropriate for this major mode."
4716 (interactive)
4717 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4718 (txt (nth 1 e))
4719 name pos)
4720 (unless e (user-error "No radio table setup defined for %s" major-mode))
4721 (setq name (read-string "Table name: "))
4722 (while (string-match "%n" txt)
4723 (setq txt (replace-match name t t txt)))
4725 (setq pos (point))
4726 (insert txt)
4727 (goto-char pos)))
4729 ;;;###autoload
4730 (defun orgtbl-to-generic (table params)
4731 "Convert the orgtbl-mode TABLE to some other format.
4733 This generic routine can be used for many standard cases.
4735 TABLE is a list, each entry either the symbol `hline' for
4736 a horizontal separator line, or a list of fields for that
4737 line. PARAMS is a property list of parameters that can
4738 influence the conversion.
4740 Valid parameters are:
4742 :backend, :raw
4744 Export back-end used as a basis to transcode elements of the
4745 table, when no specific parameter applies to it. It is also
4746 used to translate cells contents. You can prevent this by
4747 setting :raw property to a non-nil value.
4749 :splice
4751 When non-nil, only convert rows, not the table itself. This is
4752 equivalent to setting to the empty string both :tstart
4753 and :tend, which see.
4755 :skip
4757 When set to an integer N, skip the first N lines of the table.
4758 Horizontal separation lines do count for this parameter!
4760 :skipcols
4762 List of columns that should be skipped. If the table has
4763 a column with calculation marks, that column is automatically
4764 discarded beforehand.
4766 :hline
4768 String to be inserted on horizontal separation lines. May be
4769 nil to ignore these lines altogether.
4771 :sep
4773 Separator between two fields, as a string.
4775 Each in the following group may be either a string or a function
4776 of no arguments returning a string:
4778 :tstart, :tend
4780 Strings to start and end the table. Ignored when :splice is t.
4782 :lstart, :lend
4784 Strings to start and end a new table line.
4786 :llstart, :llend
4788 Strings to start and end the last table line. Default,
4789 respectively, to :lstart and :lend.
4791 Each in the following group may be a string or a function of one
4792 argument (either the cells in the current row, as a list of
4793 strings, or the current cell) returning a string:
4795 :lfmt
4797 Format string for an entire row, with enough %s to capture all
4798 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4800 :llfmt
4802 Format for the entire last line, defaults to :lfmt.
4804 :fmt
4806 A format to be used to wrap the field, should contain %s for
4807 the original field value. For example, to wrap everything in
4809 a property list with column numbers and format strings, or
4810 functions, e.g.,
4814 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4816 Same as above, specific for the header lines in the table.
4817 All lines before the first hline are treated as header. If
4818 any of these is not present, the data line value is used.
4820 This may be either a string or a function of two arguments:
4822 :efmt
4824 Use this format to print numbers with exponential. The format
4825 should have %s twice for inserting mantissa and exponent, for
4827 list with column numbers and format strings or functions.
4828 :fmt will still be applied after :efmt."
4829 ;; Make sure `org-export-create-backend' is available.
4830 (require 'ox)
4831 (let* ((backend (plist-get params :backend))
4832 (custom-backend
4833 ;; Build a custom back-end according to PARAMS. Before
4834 ;; defining a translator, check if there is anything to do.
4835 ;; When there isn't, let BACKEND handle the element.
4836 (org-export-create-backend
4837 :parent (or backend 'org)
4838 :transcoders
4839 `((table . ,(org-table--to-generic-table params))
4840 (table-row . ,(org-table--to-generic-row params))
4841 (table-cell . ,(org-table--to-generic-cell params))
4842 ;; Macros are not going to be expanded. However, no
4843 ;; regular back-end has a transcoder for them. We
4844 ;; provide one so they are not ignored, but displayed
4845 ;; as-is instead.
4846 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4847 data info)
4848 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4849 ;; Initialize communication channel in INFO.
4850 (with-temp-buffer
4851 (let ((org-inhibit-startup t)) (org-mode))
4852 (let ((standard-output (current-buffer)))
4853 (dolist (e table)
4855 ((consp e)
4856 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4858 ;; Add back-end specific filters, but not user-defined ones. In
4859 ;; particular, make sure to call parse-tree filters on the
4860 ;; table.
4861 (setq info
4862 (let ((org-export-filters-alist nil))
4863 (org-export-install-filters
4864 (org-combine-plists
4865 (org-export-get-environment backend nil params)
4866 `(:back-end ,(org-export-get-backend backend))))))
4867 (setq data
4868 (org-export-filter-apply-functions
4869 (plist-get info :filter-parse-tree)
4870 (org-element-map (org-element-parse-buffer) 'table
4871 #'identity nil t)
4872 info)))
4873 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4874 (user-error "Unknown :backend value"))
4875 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4876 ;; Handle :skip parameter.
4877 (let ((skip (plist-get info :skip)))
4878 (when skip
4879 (unless (wholenump skip) (user-error "Wrong :skip value"))
4880 (let ((n 0))
4881 (org-element-map data 'table-row
4882 (lambda (row)
4883 (if (>= n skip) t
4884 (org-element-extract-element row)
4885 (incf n)
4886 nil))
4887 nil t))))
4888 ;; Handle :skipcols parameter.
4889 (let ((skipcols (plist-get info :skipcols)))
4890 (when skipcols
4891 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4892 (org-element-map data 'table
4893 (lambda (table)
4894 (let ((specialp (org-export-table-has-special-column-p table)))
4895 (dolist (row (org-element-contents table))
4896 (when (eq (org-element-property :type row) 'standard)
4897 (let ((c 1))
4898 (dolist (cell (nthcdr (if specialp 1 0)
4899 (org-element-contents row)))
4900 (when (memq c skipcols)
4901 (org-element-extract-element cell))
4902 (incf c))))))))))
4903 ;; Since we are going to export using a low-level mechanism,
4904 ;; ignore special column and special rows manually.
4905 (let ((special? (org-export-table-has-special-column-p data))
4906 ignore)
4907 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4908 (lambda (datum)
4909 (when (if (eq (org-element-type datum) 'table-row)
4910 (org-export-table-row-is-special-p datum nil)
4911 (org-export-first-sibling-p datum nil))
4912 (push datum ignore))))
4913 (setq info (plist-put info :ignore-list ignore)))
4914 ;; We use a low-level mechanism to export DATA so as to skip all
4915 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4916 ;; code evaluation, include keywords and macro expansion. Only
4917 ;; back-end specific filters are retained.
4918 (let ((output (org-export-data-with-backend data custom-backend info)))
4919 ;; Remove final newline.
4920 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4922 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4923 (cond ((null value) nil)
4924 ((functionp value) `(funcall ',value ,@args))
4925 ((stringp value)
4926 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4927 (args `(format ,value ,@args))
4928 (t value)))
4929 ((and with-cons (consp value))
4930 `(let ((val (cadr (memq column ',value))))
4931 (cond ((null val) contents)
4932 ((stringp val) (format val ,@args))
4933 ((functionp val) (funcall val ,@args))
4934 (t (user-error "Wrong %s value" ,name)))))
4935 (t (user-error "Wrong %s value" name))))
4937 (defun org-table--to-generic-table (params)
4938 "Return custom table transcoder according to PARAMS.
4939 PARAMS is a plist. See `orgtbl-to-generic' for more
4940 information."
4941 (let ((backend (plist-get params :backend))
4942 (splice (plist-get params :splice))
4943 (tstart (plist-get params :tstart))
4944 (tend (plist-get params :tend)))
4945 `(lambda (table contents info)
4946 (concat
4947 ,(and tstart (not splice)
4949 ,(if (or (not backend) tstart tend splice) 'contents
4950 `(org-export-with-backend ',backend table contents info))
4951 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4953 (defun org-table--to-generic-row (params)
4954 "Return custom table row transcoder according to PARAMS.
4955 PARAMS is a plist. See `orgtbl-to-generic' for more
4956 information."
4957 (let* ((backend (plist-get params :backend))
4958 (lstart (plist-get params :lstart))
4959 (llstart (plist-get params :llstart))
4960 (hlstart (plist-get params :hlstart))
4961 (hllstart (plist-get params :hllstart))
4962 (lend (plist-get params :lend))
4963 (llend (plist-get params :llend))
4964 (hlend (plist-get params :hlend))
4965 (hllend (plist-get params :hllend))
4966 (lfmt (plist-get params :lfmt))
4967 (llfmt (plist-get params :llfmt))
4968 (hlfmt (plist-get params :hlfmt))
4969 (hllfmt (plist-get params :hllfmt)))
4970 `(lambda (row contents info)
4971 (if (eq (org-element-property :type row) 'rule)
4972 ,(cond
4973 ((plist-member params :hline)
4974 (org-table--generic-apply (plist-get params :hline) ":hline"))
4975 (backend `(org-export-with-backend ',backend row nil info)))
4976 (let ((headerp (org-export-table-row-in-header-p row info))
4977 (lastp (not (org-export-get-next-element row info)))
4978 (last-header-p (org-export-table-row-ends-header-p row info)))
4979 (when contents
4980 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4981 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4982 ;; `:lstart', `:lend' and their relatives.
4983 ,(let ((cells
4984 '(org-element-map row 'table-cell
4985 (lambda (cell)
4986 ;; Export all cells, without separators.
4987 ;;
4988 ;; Use `org-export-data-with-backend'
4989 ;; instead of `org-export-data' to eschew
4990 ;; cached values, which
4991 ;; ignore :orgtbl-ignore-sep parameter.
4992 (org-export-data-with-backend
4993 cell
4994 (plist-get info :back-end)
4995 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4996 info)))
4997 `(cond
4998 ,(and hllfmt
4999 `(last-header-p ,(org-table--generic-apply
5000 hllfmt ":hllfmt" nil cells)))
5001 ,(and hlfmt
5002 `(headerp ,(org-table--generic-apply
5003 hlfmt ":hlfmt" nil cells)))
5004 ,(and llfmt
5005 `(lastp ,(org-table--generic-apply
5006 llfmt ":llfmt" nil cells)))
5007 (t
5008 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5009 `(concat
5010 (cond
5011 ,(and
5012 (or hllstart hllend)
5013 `(last-header-p
5014 (concat
5015 ,(org-table--generic-apply hllstart ":hllstart")
5016 contents
5017 ,(org-table--generic-apply hllend ":hllend"))))
5018 ,(and
5019 (or hlstart hlend)
5020 `(headerp
5021 (concat
5022 ,(org-table--generic-apply hlstart ":hlstart")
5023 contents
5024 ,(org-table--generic-apply hlend ":hlend"))))
5025 ,(and
5026 (or llstart llend)
5027 `(lastp
5028 (concat
5029 ,(org-table--generic-apply llstart ":llstart")
5030 contents
5031 ,(org-table--generic-apply llend ":llend"))))
5032 (t
5033 ,(cond
5034 ((or lstart lend)
5035 `(concat
5036 ,(org-table--generic-apply lstart ":lstart")
5037 contents
5038 ,(org-table--generic-apply lend ":lend")))
5039 (backend
5040 `(org-export-with-backend
5041 ',backend row contents info))
5042 (t 'contents)))))))))))))))
5044 (defun org-table--to-generic-cell (params)
5045 "Return custom table cell transcoder according to PARAMS.
5046 PARAMS is a plist. See `orgtbl-to-generic' for more
5047 information."
5048 (let* ((backend (plist-get params :backend))
5049 (efmt (plist-get params :efmt))
5050 (fmt (plist-get params :fmt))
5051 (hfmt (plist-get params :hfmt))
5052 (sep (plist-get params :sep))
5053 (hsep (plist-get params :hsep)))
5054 `(lambda (cell contents info)
5055 (let ((headerp (org-export-table-row-in-header-p
5056 (org-export-get-parent-element cell) info))
5057 (column (1+ (cdr (org-export-table-cell-address cell info)))))
5058 ;; Make sure that contents are exported as Org data when :raw
5059 ;; parameter is non-nil.
5060 ,(when (and backend (plist-get params :raw))
5061 `(setq contents
5062 ;; Since we don't know what are the pseudo object
5063 ;; types defined in backend, we cannot pass them to
5064 ;; `org-element-interpret-data'. As a consequence,
5065 ;; they will be treated as pseudo elements, and
5066 ;; will have newlines appended instead of spaces.
5067 ;; Therefore, we must make sure :post-blank value
5068 ;; is really turned into spaces.
5069 (replace-regexp-in-string
5071 (org-trim
5072 (org-element-interpret-data
5073 (org-element-contents cell))))))
5074 (when contents
5075 ;; Check if we can apply `:efmt' on CONTENTS.
5076 ,(when efmt
5077 `(when (string-match orgtbl-exp-regexp contents)
5078 (let ((mantissa (match-string 1 contents))
5079 (exponent (match-string 2 contents)))
5080 (setq contents ,(org-table--generic-apply
5081 efmt ":efmt" t 'mantissa 'exponent)))))
5082 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5083 (cond
5084 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5085 hfmt ":hfmt" t 'contents))))
5086 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5087 fmt ":fmt" t 'contents))))))
5088 ;; If a separator is provided, use it instead of BACKEND's.
5089 ;; Separators are ignored when LFMT (or equivalent) is
5090 ;; provided.
5091 ,(cond
5092 ((or hsep sep)
5093 `(if (or ,(and (not sep) '(not headerp))
5094 (plist-get info :orgtbl-ignore-sep)
5095 (not (org-export-get-next-element cell info)))
5096 ,(if (not backend) 'contents
5097 `(org-export-with-backend ',backend cell contents info))
5098 (concat contents
5099 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5100 (or hsep sep)))))
5101 (backend `(org-export-with-backend ',backend cell contents info))
5102 (t 'contents))))))
5104 ;;;###autoload
5105 (defun orgtbl-to-tsv (table params)
5106 "Convert the orgtbl-mode table to TAB separated material."
5109 ;;;###autoload
5110 (defun orgtbl-to-csv (table params)
5111 "Convert the orgtbl-mode table to CSV material.
5112 This does take care of the proper quoting of fields with comma or quotes."
5113 (orgtbl-to-generic table
5114 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5115 params)))
5117 ;;;###autoload
5118 (defun orgtbl-to-latex (table params)
5119 "Convert the orgtbl-mode TABLE to LaTeX.
5121 TABLE is a list, each entry either the symbol `hline' for
5122 a horizontal separator line, or a list of fields for that line.
5123 PARAMS is a property list of parameters that can influence the
5124 conversion. All parameters from `orgtbl-to-generic' are
5125 supported. It is also possible to use the following ones:
5127 :booktabs
5131 :environment
5133 Specify environment to use, as a string. If you use
5135 as a string, to get proper continuation strings."
5136 (require 'ox-latex)
5137 (orgtbl-to-generic
5138 table
5139 (org-combine-plists
5140 ;; Provide sane default values.
5141 (list :backend 'latex
5142 :latex-default-table-mode 'table
5143 :latex-tables-centered nil
5144 :latex-tables-booktabs (plist-get params :booktabs)
5145 :latex-table-scientific-notation nil
5146 :latex-default-table-environment
5147 (or (plist-get params :environment) "tabular"))
5148 params)))
5150 ;;;###autoload
5151 (defun orgtbl-to-html (table params)
5152 "Convert the orgtbl-mode TABLE to HTML.
5154 TABLE is a list, each entry either the symbol `hline' for
5155 a horizontal separator line, or a list of fields for that line.
5156 PARAMS is a property list of parameters that can influence the
5157 conversion. All parameters from `orgtbl-to-generic' are
5158 supported. It is also possible to use the following one:
5160 :attributes
5162 Attributes and values, as a plist, which will be used in
5163 <table> tag."
5164 (require 'ox-html)
5165 (orgtbl-to-generic
5166 table
5167 (org-combine-plists
5168 ;; Provide sane default values.
5169 (list :backend 'html
5170 :html-table-data-tags '("<td%s>" . "</td>")
5171 :html-table-use-header-tags-for-first-column nil
5172 :html-table-align-individual-fields t
5173 :html-table-row-tags '("<tr>" . "</tr>")
5174 :html-table-attributes
5175 (if (plist-member params :attributes)
5176 (plist-get params :attributes)
5177 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5178 :frame "hsides")))
5179 params)))
5181 ;;;###autoload
5182 (defun orgtbl-to-texinfo (table params)
5183 "Convert the orgtbl-mode TABLE to Texinfo.
5185 TABLE is a list, each entry either the symbol `hline' for
5186 a horizontal separator line, or a list of fields for that line.
5187 PARAMS is a property list of parameters that can influence the
5188 conversion. All parameters from `orgtbl-to-generic' are
5189 supported. It is also possible to use the following one:
5191 :columns
5193 Column widths, as a string. When providing column fractions,
5195 (require 'ox-texinfo)
5196 (let ((output
5197 (orgtbl-to-generic
5198 table
5199 (org-combine-plists
5200 (list :backend 'texinfo
5201 :texinfo-tables-verbatim nil
5202 :texinfo-table-scientific-notation nil)
5203 params)))
5204 (columns (let ((w (plist-get params :columns)))
5205 (cond ((not w) nil)
5207 (t (concat "@columnfractions " w))))))
5208 (if (not columns) output
5209 (replace-regexp-in-string
5212 ;;;###autoload
5213 (defun orgtbl-to-orgtbl (table params)
5214 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5216 TABLE is a list, each entry either the symbol `hline' for
5217 a horizontal separator line, or a list of fields for that line.
5218 PARAMS is a property list of parameters that can influence the
5219 conversion. All parameters from `orgtbl-to-generic' are
5220 supported.
5222 Useful when slicing one table into many. The :hline, :sep,
5223 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5224 be set to provide ORGTBL directives for the generated table."
5225 (require 'ox-org)
5226 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5228 (defun orgtbl-to-table.el (table params)
5229 "Convert the orgtbl-mode TABLE into a table.el table.
5230 TABLE is a list, each entry either the symbol `hline' for
5231 a horizontal separator line, or a list of fields for that line.
5232 PARAMS is a property list of parameters that can influence the
5233 conversion. All parameters from `orgtbl-to-generic' are
5234 supported."
5235 (with-temp-buffer
5236 (insert (orgtbl-to-orgtbl table params))
5237 (org-table-align)
5238 (replace-regexp-in-string
5239 "-|" "-+"
5240 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5242 (defun orgtbl-to-unicode (table params)
5243 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5245 TABLE is a list, each entry either the symbol `hline' for
5246 a horizontal separator line, or a list of fields for that line.
5247 PARAMS is a property list of parameters that can influence the
5248 conversion. All parameters from `orgtbl-to-generic' are
5249 supported. It is also possible to use the following ones:
5251 :ascii-art
5254 the table. You can download it here:
5255 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5257 :narrow
5259 When non-nil, narrow columns width than provided width cookie,
5261 (require 'ox-ascii)
5262 (orgtbl-to-generic
5263 table
5264 (org-combine-plists
5265 (list :backend 'ascii
5266 :ascii-charset 'utf-8
5267 :ascii-table-widen-columns (not (plist-get params :narrow))
5268 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5269 params)))
5271 ;; Put the cursor in a column containing numerical values
5272 ;; of an Org-Mode table,
5273 ;; type C-c " a
5274 ;; A new column is added with a bar plot.
5275 ;; When the table is refreshed (C-u C-c *),
5276 ;; the plot is updated to reflect the new values.
5278 (defun orgtbl-ascii-draw (value min max &optional width characters)
5279 "Draw an ascii bar in a table.
5280 VALUE is a the value to plot, the width of the bar to draw. A
5281 value equal to MIN will be displayed as empty (zero width bar).
5282 A value equal to MAX will draw a bar filling all the WIDTH.
5283 WIDTH is the expected width in characters of the column.
5284 CHARACTERS is a string that will compose the bar, with shades of
5285 grey from pure white to pure black. It defaults to a 10
5286 characters string of regular ascii characters."
5287 (let* ((characters (or characters " .:;c!lhVHW"))
5288 (width (or width 12))
5289 (value (if (numberp value) value (string-to-number value)))
5290 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5291 (cond
5292 ((< value 0) "too small")
5293 ((> value width) "too large")
5294 (t
5295 (let ((len (1- (length characters))))
5296 (concat
5297 (make-string (floor value) (elt characters len))
5298 (string (elt characters
5299 (floor (* (- value (floor value)) len))))))))))
5301 ;;;###autoload
5302 (defun orgtbl-ascii-plot (&optional ask)
5303 "Draw an ascii bar plot in a column.
5304 With cursor in a column containing numerical values, this
5305 function will draw a plot in a new column.
5306 ASK, if given, is a numeric prefix to override the default 12
5307 characters width of the plot. ASK may also be the
5309 (interactive "P")
5310 (let ((col (org-table-current-column))
5311 (min 1e999) ; 1e999 will be converted to infinity
5312 (max -1e999) ; which is the desired result
5313 (table (org-table-to-lisp))
5314 (length
5315 (cond ((consp ask)
5316 (read-number "Length of column " 12))
5317 ((numberp ask) ask)
5318 (t 12))))
5319 ;; Skip any hline a the top of table.
5320 (while (eq (car table) 'hline) (setq table (cdr table)))
5321 ;; Skip table header if any.
5322 (dolist (x (or (cdr (memq 'hline table)) table))
5323 (when (consp x)
5324 (setq x (nth (1- col) x))
5325 (when (string-match
5327 x)
5328 (setq x (string-to-number x))
5329 (when (> min x) (setq min x))
5330 (when (< max x) (setq max x)))))
5331 (org-table-insert-column)
5332 (org-table-move-column-right)
5333 (org-table-store-formulas
5334 (cons
5335 (cons
5336 (concat "$" (number-to-string (1+ col)))
5337 (format "'(%s $%s %s %s %s)"
5338 "orgtbl-ascii-draw" col min max length))
5339 (org-table-get-stored-formulas)))
5340 (org-table-recalculate t)))
5342 ;; Example of extension: unicode characters
5343 ;; Here are two examples of different styles.
5345 ;; Unicode block characters are used to give a smooth effect.
5346 ;; See http://en.wikipedia.org/wiki/Block_Elements
5347 ;; Use one of those drawing functions
5348 ;; - orgtbl-ascii-draw (the default ascii)
5349 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5350 ;; - orgtbl-uc-draw-cont (smooth unicode)
5352 ;; This is best viewed with the "DejaVu Sans Mono" font
5353 ;; (use M-x set-default-font).
5355 (defun orgtbl-uc-draw-grid (value min max &optional width)
5356 "Draw a bar in a table using block unicode characters.
5357 It is a variant of orgtbl-ascii-draw with Unicode block
5358 characters, for a smooth display. Bars appear as grids (to the
5359 extent the font allows)."
5360 ;; http://en.wikipedia.org/wiki/Block_Elements
5361 ;; best viewed with the "DejaVu Sans Mono" font.
5362 (orgtbl-ascii-draw value min max width
5365 (defun orgtbl-uc-draw-cont (value min max &optional width)
5366 "Draw a bar in a table using block unicode characters.
5367 It is a variant of orgtbl-ascii-draw with Unicode block
5368 characters, for a smooth display. Bars are solid (to the extent
5369 the font allows)."
5370 (orgtbl-ascii-draw value min max width
5373 (defun org-table-get-remote-range (name-or-id form)
5374 "Get a field value or a list of values in a range from table at ID.
5376 NAME-OR-ID may be the name of a table in the current file as set
5378 will then be used. Alternatively, it may be an ID referring to
5379 any entry, also in a different file. In this case, the first
5380 table in that entry will be referenced.
5384 The return value is either a single string for a single field, or a
5385 list of the fields in the rectangle."
5386 (save-match-data
5387 (let ((case-fold-search t) (id-loc nil)
5388 ;; Protect a bunch of variables from being overwritten by
5389 ;; the context of the remote table.
5390 org-table-column-names org-table-column-name-regexp
5391 org-table-local-parameters org-table-named-field-locations
5392 org-table-current-line-types
5393 org-table-current-begin-pos org-table-dlines
5394 org-table-current-ncol
5395 org-table-hlines org-table-last-alignment
5396 org-table-last-column-widths org-table-last-alignment
5397 org-table-last-column-widths
5398 buffer loc)
5399 (setq form (org-table-convert-refs-to-rc form))
5400 (org-with-wide-buffer
5401 (goto-char (point-min))
5402 (if (re-search-forward
5405 nil t)
5406 (setq buffer (current-buffer) loc (match-beginning 0))
5407 (setq id-loc (org-id-find name-or-id 'marker))
5408 (unless (and id-loc (markerp id-loc))
5410 (setq buffer (marker-buffer id-loc)
5411 loc (marker-position id-loc))
5412 (move-marker id-loc nil))
5413 (with-current-buffer buffer
5414 (org-with-wide-buffer
5415 (goto-char loc)
5416 (forward-char 1)
5418 (not (match-beginning 1)))
5419 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5420 (org-table-analyze)
5421 (setq form (org-table-formula-substitute-names
5422 (org-table-formula-handle-first/last-rc form)))
5423 (if (and (string-match org-table-range-regexp form)
5424 (> (length (match-string 0 form)) 1))
5425 (org-table-get-range
5426 (match-string 0 form) org-table-current-begin-pos 1)
5427 form)))))))
5429 (defun org-table-remote-reference-indirection (form)
5430 "Return formula with table remote references substituted by indirection.
5432 This indirection works only with the format @ROW$COLUMN. The
5434 distinguished from a plain table name or ID."
5435 (let ((regexp
5436 ;; Same as in `org-table-eval-formula'.
5438 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5441 (replace-regexp-in-string
5442 regexp
5443 (lambda (m)
5444 (save-match-data
5445 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5446 (org-table-get-range
5448 (concat "@0" eq)
5449 eq)))))
5450 form t t 1)))
5452 (defmacro org-define-lookup-function (mode)
5453 (let ((mode-str (symbol-name mode))
5454 (first-p (equal mode 'first))
5455 (all-p (equal mode 'all)))
5456 (let ((plural-str (if all-p "s" "")))
5457 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5458 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5459 If R-LIST is nil, return matching element%s of S-LIST.
5460 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5461 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5462 This function is generated by a call to the macro `org-define-lookup-function'."
5463 mode-str plural-str plural-str plural-str)
5464 (let ,(let ((lvars '((p (or predicate 'equal))
5465 (sl s-list)
5466 (rl (or r-list s-list))
5467 (ret nil))))
5468 (if first-p (add-to-list 'lvars '(match-p nil)))
5469 lvars)
5470 (while ,(if first-p '(and (not match-p) sl) 'sl)
5471 (progn
5472 (if (funcall p val (car sl))
5473 (progn
5474 ,(if first-p '(setq match-p t))
5475 (let ((rval (car rl)))
5476 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5477 (setq sl (cdr sl) rl (cdr rl))))
5478 ret)))))
5480 (org-define-lookup-function first)
5481 (org-define-lookup-function last)
5482 (org-define-lookup-function all)
5484 (provide 'org-table)
5486 ;; Local variables:
5487 ;; generated-autoload-file: "org-loaddefs.el"
5488 ;; End:
5490 ;;; org-table.el ends here